« blib/lib/Catmandu/Store/Multi/Bag.pm
↑ Summary
blib/lib/Catmandu/Fix/Condition/SimpleCompareTest.pm »
| 1 | package Catmandu::Fix::Parser; | ||||||||||
| 2 | |||||||||||
| 3 | 119 | ▶ | use Catmandu::Sane; | ||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||
| 4 | |||||||||||
| 5 | 119 | our $VERSION = '1.0201_02'; | |||||||||
| 6 | |||||||||||
| 7 | 119 | ▶ | use Catmandu::Util qw(check_value is_instance is_able require_package); | ||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||
| 8 | 119 | ▶ | use Moo; | ||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||
| 9 | 119 | ▶ | use namespace::clean; | ||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||
| 10 | |||||||||||
| 11 | 119 | extends 'Parser::MGC'; | |||||||||
| 12 | |||||||||||
| 13 | sub FOREIGNBUILDARGS { | ||||||||||
| 14 | 128 | ▶ | my ($class, $opts) = @_; | ||||||||
|
Subroutine
FOREIGNBUILDARGS: called CC=1 SCAR=0.0
Pod
undocumented
| |||||||||||
| 15 | 128 | $opts->{toplevel} = 'parse_statements'; | |||||||||
| 16 | 128 | %$opts; | |||||||||
| 17 | } | ||||||||||
| 18 | |||||||||||
| 19 | sub parse { | ||||||||||
| 20 | 156 | ▶ | my ($self, $source) = @_; | ||||||||
|
Subroutine
parse: called CC=1 SCAR=0.0
Pod
documented
| |||||||||||
| 21 | |||||||||||
| 22 | 156 | check_value($source); | |||||||||
| 23 | |||||||||||
| 24 | try { | ||||||||||
| 25 | 156 | ▶ | $self->from_string($source); | ||||||||
|
Subroutine
__ANON__: called CC=1 SCAR=0.0
| |||||||||||
| 26 | } | ||||||||||
| 27 | catch { | ||||||||||
| 28 | 13 | ▶ | my $err = $_; | ||||||||
|
Subroutine
__ANON__: called CC=3 SCAR=11.0
| |||||||||||
| 29 | 13 | ▶ | if (is_instance($err, 'Catmandu::Error')) { | ||||||||
|
Branch: 1 branch
| |||||||||||
| 30 | 5 | ▶ | $err->set_source($source) if is_able($err, 'set_source'); | ||||||||
|
Branch: 1 branch
| |||||||||||
| 31 | 5 | $err->throw; | |||||||||
| 32 | } | ||||||||||
| 33 | 8 | Catmandu::FixParseError->throw(message => $err, source => $source,); | |||||||||
| 34 | 156 | }; | |||||||||
| 35 | } | ||||||||||
| 36 | |||||||||||
| 37 | sub pattern_comment { | ||||||||||
| 38 | 128 | ▶ | qr/#[^\n]*/; | ||||||||
|
Subroutine
pattern_comment: called CC=1 SCAR=0.0
Pod
undocumented
| |||||||||||
| 39 | } | ||||||||||
| 40 | |||||||||||
| 41 | sub parse_statements { | ||||||||||
| 42 | 156 | ▶ | my ($self) = @_; | ||||||||
|
Subroutine
parse_statements: called CC=1 SCAR=0.0
Pod
undocumented
| |||||||||||
| 43 | 156 | $self->sequence_of('parse_statement'); | |||||||||
| 44 | } | ||||||||||
| 45 | |||||||||||
| 46 | sub parse_statement { | ||||||||||
| 47 | 439 | ▶ | my ($self) = @_; | ||||||||
|
Subroutine
parse_statement: called CC=1 SCAR=0.0
Pod
undocumented
| |||||||||||
| 48 | 439 | my $statement | |||||||||
| 49 | = $self->any_of('parse_filter', 'parse_condition', 'parse_bind', | ||||||||||
| 50 | 'parse_fix',); | ||||||||||
| 51 | |||||||||||
| 52 | # support deprecated separator | ||||||||||
| 53 | 300 | $self->maybe_expect(';'); | |||||||||
| 54 | 300 | $statement; | |||||||||
| 55 | } | ||||||||||
| 56 | |||||||||||
| 57 | sub parse_condition { | ||||||||||
| 58 | 423 | ▶ | my ($self) = @_; | ||||||||
|
Subroutine
parse_condition: called CC=3 SCAR=11.0
Pod
undocumented
| |||||||||||
| 59 | 423 | my $type = $self->token_kw('if', 'unless'); | |||||||||
| 60 | 35 | my $name = $self->parse_name; | |||||||||
| 61 | 35 | my $args = $self->parse_arguments; | |||||||||
| 62 | 33 | my $fixes = $self->sequence_of('parse_statement'); | |||||||||
| 63 | my $else_fixes = $self->maybe( | ||||||||||
| 64 | sub { | ||||||||||
| 65 | 33 | ▶ | $self->fail if $type eq 'unless'; | ||||||||
|
Subroutine
__ANON__: called CC=2 SCAR=6.9
Branch: 1 branch
| |||||||||||
| 66 | 23 | $self->expect('else'); | |||||||||
| 67 | 1 | $self->sequence_of('parse_statement'); | |||||||||
| 68 | } | ||||||||||
| 69 | 33 | ); | |||||||||
| 70 | 33 | $self->expect('end'); | |||||||||
| 71 | 30 | my $cond = $self->_build_fix($name, 'Catmandu::Fix::Condition', $args); | |||||||||
| 72 | 30 | ▶ | if ($type eq 'if') { | ||||||||
|
Branch: 1 branch
| |||||||||||
| 73 | 21 | $cond->pass_fixes($fixes); | |||||||||
| 74 | 21 | ▶ | $cond->fail_fixes($else_fixes) if $else_fixes; | ||||||||
|
Branch: 1 branch
| |||||||||||
| 75 | } | ||||||||||
| 76 | else { | ||||||||||
| 77 | 9 | $cond->fail_fixes($fixes); | |||||||||
| 78 | } | ||||||||||
| 79 | 30 | $cond; | |||||||||
| 80 | } | ||||||||||
| 81 | |||||||||||
| 82 | sub parse_filter { | ||||||||||
| 83 | 439 | ▶ | my ($self) = @_; | ||||||||
|
Subroutine
parse_filter: called CC=2 SCAR=6.9
Pod
undocumented
| |||||||||||
| 84 | 439 | my $type = $self->token_kw('select', 'reject'); | |||||||||
| 85 | 21 | my $name = $self->parse_name; | |||||||||
| 86 | 16 | my $args = $self->parse_arguments; | |||||||||
| 87 | 16 | my $cond = $self->_build_fix($name, 'Catmandu::Fix::Condition', $args); | |||||||||
| 88 | 16 | my $fixes = [require_package('Catmandu::Fix::reject')->new]; | |||||||||
| 89 | 16 | ▶ | if ($type eq 'select') { | ||||||||
|
Branch: 1 branch
| |||||||||||
| 90 | 9 | $cond->fail_fixes($fixes); | |||||||||
| 91 | } | ||||||||||
| 92 | else { | ||||||||||
| 93 | 7 | $cond->pass_fixes($fixes); | |||||||||
| 94 | } | ||||||||||
| 95 | 16 | $cond; | |||||||||
| 96 | } | ||||||||||
| 97 | |||||||||||
| 98 | sub parse_bind { | ||||||||||
| 99 | 393 | ▶ | my ($self) = @_; | ||||||||
|
Subroutine
parse_bind: called CC=1 SCAR=0.0
Pod
undocumented
| |||||||||||
| 100 | 393 | my $type = $self->token_kw('do', 'doset'); | |||||||||
| 101 | 95 | my $name = $self->parse_name; | |||||||||
| 102 | 95 | my $args = $self->parse_arguments; | |||||||||
| 103 | 95 | my $fixes = $self->sequence_of('parse_statement'); | |||||||||
| 104 | 95 | $self->expect('end'); | |||||||||
| 105 | 95 | my $bind = $self->_build_fix($name, 'Catmandu::Fix::Bind', $args); | |||||||||
| 106 | 95 | $bind->return($type eq 'doset'); | |||||||||
| 107 | 95 | $bind->fixes($fixes); | |||||||||
| 108 | 95 | $bind; | |||||||||
| 109 | } | ||||||||||
| 110 | |||||||||||
| 111 | sub parse_fix { | ||||||||||
| 112 | 298 | ▶ | my ($self) = @_; | ||||||||
|
Subroutine
parse_fix: called CC=1 SCAR=0.0
Pod
undocumented
| |||||||||||
| 113 | 298 | my $name = $self->parse_name; | |||||||||
| 114 | 298 | my $args = $self->parse_arguments; | |||||||||
| 115 | 164 | $self->_build_fix($name, 'Catmandu::Fix', $args); | |||||||||
| 116 | } | ||||||||||
| 117 | |||||||||||
| 118 | sub parse_name { | ||||||||||
| 119 | 449 | ▶ | my ($self) = @_; | ||||||||
|
Subroutine
parse_name: called CC=1 SCAR=0.0
Pod
undocumented
| |||||||||||
| 120 | 449 | $self->generic_token(name => qr/[a-z][_\da-zA-Z]*/); | |||||||||
| 121 | } | ||||||||||
| 122 | |||||||||||
| 123 | sub parse_arguments { | ||||||||||
| 124 | 444 | ▶ | my ($self) = @_; | ||||||||
|
Subroutine
parse_arguments: called CC=1 SCAR=0.0
Pod
undocumented
| |||||||||||
| 125 | 444 | $self->expect('('); | |||||||||
| 126 | 310 | my $args = $self->list_of(qr/[,:]|=>/, 'parse_value'); | |||||||||
| 127 | 310 | $self->expect(')'); | |||||||||
| 128 | 308 | $args; | |||||||||
| 129 | } | ||||||||||
| 130 | |||||||||||
| 131 | sub parse_value { | ||||||||||
| 132 | 498 | ▶ | my ($self) = @_; | ||||||||
|
Subroutine
parse_value: called CC=1 SCAR=0.0
Pod
undocumented
| |||||||||||
| 133 | 498 | $self->any_of('parse_double_quoted_string', 'parse_single_quoted_string', | |||||||||
| 134 | 'parse_bare_string',); | ||||||||||
| 135 | } | ||||||||||
| 136 | |||||||||||
| 137 | sub parse_bare_string { | ||||||||||
| 138 | 452 | ▶ | my ($self) = @_; | ||||||||
|
Subroutine
parse_bare_string: called CC=1 SCAR=0.0
Pod
undocumented
| |||||||||||
| 139 | 452 | $self->generic_token(bare_string => qr/[^\s\\,;:=>()"']+/); | |||||||||
| 140 | } | ||||||||||
| 141 | |||||||||||
| 142 | sub parse_single_quoted_string { | ||||||||||
| 143 | 495 | ▶ | my ($self) = @_; | ||||||||
|
Subroutine
parse_single_quoted_string: called CC=1 SCAR=0.0
Pod
undocumented
| |||||||||||
| 144 | |||||||||||
| 145 | 495 | my $str = $self->generic_token(string => qr/'(?:[^']|\\')*'/); | |||||||||
| 146 | 43 | $str = substr($str, 1, length($str) - 2); | |||||||||
| 147 | |||||||||||
| 148 | 43 | $str =~ s{\\'}{'}gxms; | |||||||||
| 149 | |||||||||||
| 150 | 43 | $str; | |||||||||
| 151 | } | ||||||||||
| 152 | |||||||||||
| 153 | sub parse_double_quoted_string { | ||||||||||
| 154 | 498 | ▶ | my ($self) = @_; | ||||||||
|
Subroutine
parse_double_quoted_string: called CC=2 SCAR=6.9
Pod
undocumented
| |||||||||||
| 155 | |||||||||||
| 156 | 498 | my $str = $self->generic_token(string => qr/"(?:[^"]|\\")*"/); | |||||||||
| 157 | 3 | $str = substr($str, 1, length($str) - 2); | |||||||||
| 158 | |||||||||||
| 159 | 3 | ▶ | if (index($str, '\\') != -1) { | ||||||||
|
Branch: 1 branch
| |||||||||||
| 160 | 1 | $str =~ s/\\u([0-9A-Fa-f]{4})/chr(hex($1))/egxms; | |||||||||
| 161 | 1 | $str =~ s/\\n/\n/gxms; | |||||||||
| 162 | 1 | $str =~ s/\\r/\r/gxms; | |||||||||
| 163 | 1 | $str =~ s/\\b/\b/gxms; | |||||||||
| 164 | 1 | $str =~ s/\\f/\f/gxms; | |||||||||
| 165 | 1 | $str =~ s/\\t/\t/gxms; | |||||||||
| 166 | 1 | $str =~ s/\\\\/\\/gxms; | |||||||||
| 167 | 1 | $str =~ s{\\/}{/}gxms; | |||||||||
| 168 | 1 | $str =~ s{\\"}{"}gxms; | |||||||||
| 169 | } | ||||||||||
| 170 | |||||||||||
| 171 | 3 | $str; | |||||||||
| 172 | } | ||||||||||
| 173 | |||||||||||
| 174 | sub _build_fix { | ||||||||||
| 175 | 305 | ▶ | my ($self, $name, $ns, $args) = @_; | ||||||||
|
Subroutine
_build_fix: called CC=1 SCAR=0.0
| |||||||||||
| 176 | 305 | my $pkg; | |||||||||
| 177 | try { | ||||||||||
| 178 | 305 | ▶ | $pkg = require_package($name, $ns); | ||||||||
|
Subroutine
__ANON__: called CC=1 SCAR=0.0
| |||||||||||
| 179 | } | ||||||||||
| 180 | catch_case [ | ||||||||||
| 181 | 'Catmandu::NoSuchPackage' => sub { | ||||||||||
| 182 | 3 | ▶ | Catmandu::NoSuchFixPackage->throw( | ||||||||
|
Subroutine
__ANON__: called CC=1 SCAR=0.0
| |||||||||||
| 183 | message => "No such fix package: $name", | ||||||||||
| 184 | package_name => $_->package_name, | ||||||||||
| 185 | fix_name => $name, | ||||||||||
| 186 | ); | ||||||||||
| 187 | }, | ||||||||||
| 188 | 305 | ]; | |||||||||
| 189 | try { | ||||||||||
| 190 | 302 | ▶ | $pkg->new(@$args); | ||||||||
|
Subroutine
__ANON__: called CC=1 SCAR=0.0
| |||||||||||
| 191 | } | ||||||||||
| 192 | catch { | ||||||||||
| 193 | 2 | ▶ | $_->throw if is_instance($_, 'Catmandu::Error'); | ||||||||
|
Subroutine
__ANON__: called CC=2 SCAR=7.2
Branch: 1 branch
| |||||||||||
| 194 | 2 | Catmandu::BadFixArg->throw( | |||||||||
| 195 | message => $_, | ||||||||||
| 196 | package_name => $pkg, | ||||||||||
| 197 | fix_name => $name, | ||||||||||
| 198 | ); | ||||||||||
| 199 | 302 | }; | |||||||||
| 200 | } | ||||||||||
| 201 | |||||||||||
| 202 | 119 | 1; | |||||||||
| 203 | |||||||||||
| 204 | __END__ | ||||||||||
| 205 | |||||||||||
| 206 | =pod | ||||||||||
| 207 | |||||||||||
| 208 | =head1 NAME | ||||||||||
| 209 | |||||||||||
| 210 | Catmandu::Fix::Parser - the parser of the Catmandu::Fix language | ||||||||||
| 211 | |||||||||||
| 212 | =head1 SYNOPSIS | ||||||||||
| 213 | |||||||||||
| 214 | use Catmandu::Sane; | ||||||||||
| 215 | use Catmandu::Fix::Parser; | ||||||||||
| 216 | use Catmandu::Fix; | ||||||||||
| 217 | |||||||||||
| 218 | use Data::Dumper; | ||||||||||
| 219 | |||||||||||
| 220 | my $parser = Catmandu::Fix::Parser->new; | ||||||||||
| 221 | |||||||||||
| 222 | my $fixes; | ||||||||||
| 223 | |||||||||||
| 224 | try { | ||||||||||
| 225 | $fixes = $parser->parse(<<EOF); | ||||||||||
| 226 | add_field(test,123) | ||||||||||
| 227 | EOF | ||||||||||
| 228 | } | ||||||||||
| 229 | catch { | ||||||||||
| 230 | printf "[%s]\nscript:\n%s\nerror: %s\n" | ||||||||||
| 231 | , ref($_) | ||||||||||
| 232 | , $_->source | ||||||||||
| 233 | , $_->message; | ||||||||||
| 234 | }; | ||||||||||
| 235 | |||||||||||
| 236 | my $fixer = Catmandu::Fix->new(fixes => $fixes); | ||||||||||
| 237 | |||||||||||
| 238 | print Dumper($fixer->fix({})); | ||||||||||
| 239 | |||||||||||
| 240 | =head1 DESCRIPTION | ||||||||||
| 241 | |||||||||||
| 242 | Programmers are discouraged to use the Catmandu::Parser directly in code but | ||||||||||
| 243 | use the Catmandu package that provides the same functionality: | ||||||||||
| 244 | |||||||||||
| 245 | use Catmandu; | ||||||||||
| 246 | |||||||||||
| 247 | my $fixer = Catmandu->fixer(<<EOF); | ||||||||||
| 248 | add_field(test,123) | ||||||||||
| 249 | EOF | ||||||||||
| 250 | |||||||||||
| 251 | print Dumper($fixer->fix({})); | ||||||||||
| 252 | |||||||||||
| 253 | =head1 METHODS | ||||||||||
| 254 | |||||||||||
| 255 | =head2 new() | ||||||||||
| 256 | |||||||||||
| 257 | Create a new Catmandu::Fix parser | ||||||||||
| 258 | |||||||||||
| 259 | =head2 parse($string) | ||||||||||
| 260 | |||||||||||
| 261 | Reads a string and returns a blessed object with parsed | ||||||||||
| 262 | Catmandu::Fixes. Throws an Catmandu::ParseError on failure. | ||||||||||
| 263 | |||||||||||
| 264 | =head1 SEE ALSO | ||||||||||
| 265 | |||||||||||
| 266 | L<Catmandu::Fix> | ||||||||||
| 267 | |||||||||||
| 268 | Or consult the webpages below for more information on the Catmandu::Fix language | ||||||||||
| 269 | |||||||||||
| 270 | http://librecat.org/Catmandu/#fixes | ||||||||||
| 271 | http://librecat.org/Catmandu/#fix-language | ||||||||||
| 272 | |||||||||||
| 273 | =cut | ||||||||||