/usr/share/perl5/PPIx/Regexp/Node.pm is in libppix-regexp-perl 0.050-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 | =head1 NAME
PPIx::Regexp::Node - Represent a container
=head1 SYNOPSIS
use PPIx::Regexp::Dumper;
PPIx::Regexp::Dumper->new( 'qr{(foo)}' )->print();
=head1 INHERITANCE
C<PPIx::Regexp::Node> is a
L<PPIx::Regexp::Element|PPIx::Regexp::Element>.
C<PPIx::Regexp::Node> is the parent of L<PPIx::Regexp|PPIx::Regexp>,
L<PPIx::Regexp::Node::Range|PPIx::Regexp::Node::Range> and
L<PPIx::Regexp::Structure|PPIx::Regexp::Structure>.
=head1 DESCRIPTION
This class represents a structural element that contains other classes.
It is an abstract class, not instantiated by the lexer.
=head1 METHODS
This class provides the following public methods. Methods not documented
here are private, and unsupported in the sense that the author reserves
the right to change or remove them without notice.
=cut
package PPIx::Regexp::Node;
use strict;
use warnings;
use base qw{ PPIx::Regexp::Element };
use Carp;
use List::Util qw{ max };
use PPIx::Regexp::Constant qw{ MINIMUM_PERL NODE_UNKNOWN };
use PPIx::Regexp::Util qw{ __instance };
use Scalar::Util qw{ refaddr };
our $VERSION = '0.050';
use constant ELEMENT_UNKNOWN => NODE_UNKNOWN;
sub __new {
my ( $class, @children ) = @_;
ref $class and $class = ref $class;
foreach my $elem ( @children ) {
__instance( $elem, 'PPIx::Regexp::Element' ) or return;
}
my $self = {
children => \@children,
};
bless $self, $class;
foreach my $elem ( @children ) {
$elem->_parent( $self );
}
return $self;
}
=head2 child
my $kid = $node->child( 0 );
This method returns the child at the given index. The indices start from
zero, and negative indices are from the end of the list, so that
C<< $node->child( -1 ) >> returns the last child of the node.
=cut
sub child {
my ( $self, $inx ) = @_;
defined $inx or $inx = 0;
return $self->{children}[$inx];
}
=head2 children
This method returns the children of the Node. If called in scalar
context it returns the number of children.
=cut
sub children {
my ( $self ) = @_;
return @{ $self->{children} };
}
=head2 contains
print $node->contains( $elem ) ? "yes\n" : "no\n";
This method returns true if the given element is contained in the node,
or false otherwise.
=cut
sub contains {
my ( $self, $elem ) = @_;
__instance( $elem, 'PPIx::Regexp::Element' ) or return;
my $addr = refaddr( $self );
while ( $elem = $elem->parent() ) {
$addr == refaddr( $elem ) and return 1;
}
return;
}
sub content {
my ( $self ) = @_;
return join( '', map{ $_->content() } $self->elements() );
}
=head2 elements
This method returns the elements in the Node. For a
C<PPIx::Regexp::Node> proper, it is the same as C<children()>.
=cut
{
no warnings qw{ once };
*elements = \&children;
}
=head2 find
my $rslt = $node->find( 'PPIx::Regexp::Token::Literal' );
my $rslt = $node->find( 'Token::Literal' );
my $rslt = $node->find( sub {
return $_[1]->isa( 'PPIx::Regexp::Token::Literal' )
&& $_[1]->ordinal < ord(' ');
} );
This method finds things.
If given a string as argument, it is assumed to be a class name
(possibly without the leading 'PPIx::Regexp::'), and all elements of the
given class are found.
If given a code reference, that code reference is called once for each
element, and passed C<$self> and the element. The code should return
true to accept the element, false to reject it, and ( for subclasses of
C<PPIx::Regexp::Node>) C<undef> to prevent recursion into the node. If
the code throws an exception, you get nothing back from this method.
Either way, the return is a reference to the list of things found, a
false (but defined) value if nothing was found, or C<undef> if an error
occurred.
=cut
sub _find_routine {
my ( $want ) = @_;
ref $want eq 'CODE' and return $want;
ref $want and return;
$want =~ m/ \A PPIx::Regexp:: /smx
or $want = 'PPIx::Regexp::' . $want;
return sub {
return __instance( $_[1], $want ) ? 1 : 0;
};
}
sub find {
my ( $self, $want ) = @_;
$want = _find_routine( $want ) or return;
my @found;
# We use a recursion to find what we want. PPI::Node uses an
# iteration.
foreach my $elem ( $self->elements() ) {
my $rslt = eval { $want->( $self, $elem ) }
and push @found, $elem;
$@ and return;
__instance( $elem, 'PPIx::Regexp::Node' ) or next;
defined $rslt or next;
$rslt = $elem->find( $want )
and push @found, @{ $rslt };
}
return @found ? \@found : 0;
}
=head2 find_parents
my $rslt = $node->find_parents( sub {
return $_[1]->isa( 'PPIx::Regexp::Token::Operator' )
&& $_[1]->content() eq '|';
} );
This convenience method takes the same arguments as C<find>, but instead
of the found objects themselves returns their parents. No parent will
appear more than once in the output.
The return is a reference to the array of parents if any were found. If
none were found the return is false but defined. If an error occurred
the return is C<undef>.
=cut
sub find_parents {
my ( $self, $want ) = @_;
my $found;
$found = $self->find( $want ) or return $found;
my %parents;
my @rslt;
foreach my $elem ( @{ $found } ) {
my $dad = $elem->parent() or next;
$parents{ refaddr( $dad ) }++
or push @rslt, $dad;
}
return \@rslt;
}
=head2 find_first
This method has the same arguments as L</find>, but returns either a
reference to the first element found, a false (but defined) value if no
elements were found, or C<undef> if an error occurred.
=cut
sub find_first {
my ( $self, $want ) = @_;
$want = _find_routine( $want ) or return;
# We use a recursion to find what we want. PPI::Node uses an
# iteration.
foreach my $elem ( $self->elements() ) {
my $rslt = eval { $want->( $self, $elem ) }
and return $elem;
$@ and return;
__instance( $elem, 'PPIx::Regexp::Node' ) or next;
defined $rslt or next;
defined( $rslt = $elem->find_first( $want ) )
or return;
$rslt and return $rslt;
}
return 0;
}
=head2 first_element
This method returns the first element in the node.
=cut
sub first_element {
my ( $self ) = @_;
return $self->{children}[0];
}
=head2 last_element
This method returns the last element in the node.
=cut
sub last_element {
my ( $self ) = @_;
return $self->{children}[-1];
}
=head2 perl_version_introduced
This method returns the maximum value of C<perl_version_introduced>
returned by any of its elements. In other words, it returns the minimum
version of Perl under which this node is valid. If there are no
elements, 5.000 is returned, since that is the minimum value of Perl
supported by this package.
=cut
sub perl_version_introduced {
my ( $self ) = @_;
return max( grep { defined $_ } MINIMUM_PERL,
$self->{perl_version_introduced},
map { $_->perl_version_introduced() } $self->elements() );
}
=head2 perl_version_removed
This method returns the minimum defined value of C<perl_version_removed>
returned by any of the node's elements. In other words, it returns the
lowest version of Perl in which this node is C<not> valid. If there are
no elements, or if no element has a defined C<perl_version_removed>,
C<undef> is returned.
=cut
sub perl_version_removed {
my ( $self ) = @_;
my $max;
foreach my $elem ( $self->elements() ) {
if ( defined ( my $ver = $elem->perl_version_removed() ) ) {
if ( defined $max ) {
$ver < $max and $max = $ver;
} else {
$max = $ver;
}
}
}
return $max;
}
=head2 schild
This method returns the significant child at the given index; that is,
C<< $node->schild(0) >> returns the first significant child,
C<< $node->schild(1) >> returns the second significant child, and so on.
Negative indices count from the end.
=cut
sub schild {
my ( $self, $inx ) = @_;
defined $inx or $inx = 0;
my $kids = $self->{children};
if ( $inx >= 0 ) {
my $loc = 0;
while ( exists $kids->[$loc] ) {
$kids->[$loc]->significant() or next;
--$inx >= 0 and next;
return $kids->[$loc];
} continue {
$loc++;
}
} else {
my $loc = -1;
while ( exists $kids->[$loc] ) {
$kids->[$loc]->significant() or next;
$inx++ < -1 and next;
return $kids->[$loc];
} continue {
--$loc;
}
}
return;
}
=head2 schildren
This method returns the significant children of the node.
=cut
sub schildren {
my ( $self ) = @_;
if ( wantarray ) {
return ( grep { $_->significant() } @{ $self->{children} } );
} elsif ( defined wantarray ) {
my $kids = 0;
foreach ( @{ $self->{children} } ) {
$_->significant() and $kids++;
}
return $kids;
} else {
return;
}
}
sub tokens {
my ( $self ) = @_;
return ( map { $_->tokens() } $self->elements() );
}
sub unescaped_content {
my ( $self ) = @_;
return join '', map { $_->unescaped_content() } $self->elements();
}
# Help for nav();
sub __nav {
my ( $self, $child ) = @_;
refaddr( $child->parent() ) == refaddr( $self )
or return;
my ( $method, $inx ) = $child->_my_inx()
or return;
return ( $method => [ $inx ] );
}
sub __error {
my ( $self, $msg, %arg ) = @_;
defined $msg
or $msg = 'Was class ' . ref $self;
$self->{error} = $msg;
bless $self, $self->ELEMENT_UNKNOWN();
foreach my $key ( keys %arg ) {
$self->{$key} = $arg{$key};
}
return 1;
}
# Called by the lexer once it has done its worst to all the tokens.
# Called as a method with the lexer as argument. The return is the
# number of parse failures discovered when finalizing.
sub __PPIX_LEXER__finalize {
my ( $self, $lexer ) = @_;
my $rslt = 0;
foreach my $elem ( $self->elements() ) {
$rslt += $elem->__PPIX_LEXER__finalize( $lexer );
}
return $rslt;
}
# Called by the lexer to record the capture number.
sub __PPIX_LEXER__record_capture_number {
my ( $self, $number ) = @_;
foreach my $kid ( $self->children() ) {
$number = $kid->__PPIX_LEXER__record_capture_number( $number );
}
return $number;
}
1;
__END__
=head1 SUPPORT
Support is by the author. Please file bug reports at
L<http://rt.cpan.org>, or in electronic mail to the author.
=head1 AUTHOR
Thomas R. Wyant, III F<wyant at cpan dot org>
=head1 COPYRIGHT AND LICENSE
Copyright (C) 2009-2016 by Thomas R. Wyant, III
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl 5.10.0. For more details, see the full text
of the licenses in the directory LICENSES.
This program is distributed in the hope that it will be useful, but
without any warranty; without even the implied warranty of
merchantability or fitness for a particular purpose.
=cut
# ex: set textwidth=72 :
|