Table of Contents
NAME
Parse::Paths
AUTHOR
Francis Grizzly Smit (grizzly@smit.id.au)
VERSION
v0.1.2
TITLE
Parse::Paths
SUBTITLE
A Raku module to provide path parsing and validation for assorted programs.
COPYRIGHT
LGPL V3.0+ LICENSE
Introduction
A Raku module to provide path parsing and validation services to Raku programs.
Basically a grammar and a role for inclusion in your own code.
Top of Document
Motivations
I need to parse paths a lot in other grammars so I am centralising it.
Top of Document
BadPath
BadPath is an exception for when paths don't parse.
class BadPath is Exception is export {
has Str:D $.msg = 'Error: Highlighter Failed.';
method message( --> Str:D) {
$!msg;
}
}
Grammars
grammar BasePaths & actions BasePathsActions
A grammar action pair to act as a basis of path parsing. See GUI::Editors and Usage::Utils for other examples.
grammar BasePaths is export {
regex base-path { [ <absolute-path> || <relative-path> ] }
regex absolute-path { <lead-in> <path-segments>? }
regex lead-in { [ '/' || '~/' || '~' ] }
regex relative-path { <path-segments> }
regex path-segments { <path-segment> [ '/' <path-segment> ]* '/' }
token path-segment { [ <with-space-in-it> || <with-other-stuff> ] }
token with-space-in-it { <with-other-stuff> <trailing-sp-stuff>+ }
token trailing-sp-stuff { <spaces> <tail-other-stuff> }
token spaces { ' '+ }
token with-other-stuff { [ <start-other-stuff> <tail-other-stuff>* || <tail-other-stuff>+ ] }
token start-other-stuff { \w+ }
token tail-other-stuff { <other-stuff>+ <tails-tail>? }
token tails-tail { \w+ }
token other-stuff { [ '-' || '+' || ':' || '@' || '=' || ',' || '&' || '%' || '.' ] }
}
role BasePathsActions is export {
#token with-other-stuff { [ <start-other-stuff> <tail-other-stuff>* || <tail-other-stuff>+ ] }
method with-other-stuff($/) {
my $with-other-stuff;
my @tailotherstuff;
if $/<tail-other-stuff> {
@tailotherstuff = $/<tail-other-stuff>».made;
}
if $/<start-other-stuff> {
$with-other-stuff = $/<start-other-stuff>.made ~ @tailotherstuff.join();
} else {
$with-other-stuff = @tailotherstuff.join();
}
make $with-other-stuff;
}
#token editor-name { <with-other-stuff> }
method editor-name($/) {
my $edname = $/<with-other-stuff>.made;
make $edname;
}
method lead-in($/) {
my $leadin = ~$/;
make $leadin;
}
#token spaces { ' '+ }
method spaces($/) {
my $spaces = ~$/;
make $spaces;
}
#token trailing-sp-stuff { <spaces> <tail-other-stuff> }
method trailing-sp-stuff($/) {
my $trailing-sp-stuff = $/<spaces>.made ~ $/<tail-other-stuff>.made;
make $trailing-sp-stuff;
}
#token with-space-in-it { <with-other-stuff> <trailing-sp-stuff>+ }
method with-space-in-it($/) {
my @trailing = $/<trailing-sp-stuff>».made;
my $with-space-in-it = $/<with-other-stuff>.made ~ @trailing.join();
make $with-space-in-it;
}
#token start-other-stuff { \w+ }
method start-other-stuff($/) {
my $start-other-stuff = ~$/;
make $start-other-stuff;
}
#token tails-tail { \w+ }
method tails-tail($/) {
my $tails-tail = ~$/;
make $tails-tail;
}
#token other-stuff { [ '-' || '+' || ':' || '@' || '=' || ',' || '%' || '.' ] }
method other-stuff($/) {
my $other-stuff = ~$/;
make $other-stuff;
}
#token tail-other-stuff { <other-stuff>+ <tails-tail>? }
method tail-other-stuff($/) {
my @otherstuff = $/<other-stuff>».made;
my $tail-other-stuff = @otherstuff.join();
if $/<tails-tail> {
$tail-other-stuff ~= $<tails-tail>.made;
}
make $tail-other-stuff;
}
#token path-segment { [ <with-space-in-it> || <with-other-stuff> ] }
method path-segment($/) {
my $path-segment = ~$/;
make $path-segment;
}
method path-segments($/) {
my @path-seg = $/<path-segment>».made;
make @path-seg.join('/');
}
method base-path($/) {
my Str $abs-rel-path;
if $/<absolute-path> {
$abs-rel-path = $/<absolute-path>.made;
} elsif $/<relative-path> {
$abs-rel-path = $/<relative-path>.made;
}
make $abs-rel-path;
}
method absolute-path($/) {
my Str $abs-path = $/<lead-in>.made;
if $/<path-segments> {
$abs-path ~= $/<path-segments>.made;
}
make $abs-path;
}
method relative-path($/) {
my Str $rel-path = '';
if $/<path-segments> {
$rel-path ~= $/<path-segments>.made;
}
make $rel-path;
}
} # role BasePathsActions is export #
Top of Document
grammar Paths & actions class PathsActions
A front end that uses BasePaths & BasePathsActions to implement a path parser.
grammar Paths is BasePaths is export {
TOP { [ <base-path> <path-segment>? || <path-segment> ] }
}
class PathsActions does BasePathsActions is export {
method TOP($made) {
my $top = '';
if $made<base-path> {
$top ~= $made<base-path>.made;
}
if $made<path-segment> {
$top ~= $made<path-segment>.made;
}
$made.make: $top;
}
} # class PathsActions does BasePathsActions is export #
Top of Document
check-path(…)
Check that the path is valid.
sub check-path(Str:D $path --> Str:D) is export {
my $actions = PathsActions;
my $tmp = Paths.parse($path, :enc('UTF-8'), :$actions).made;
BadPath.new(:msg("Error: path $path did not parse.")).throw if $tmp === Any;
my Str:D $result = $tmp;
return $result;
} # sub check-path(Str:D $path --> Str:D) is export #
Top of Document