/usr/share/perl5/PPIx/Regexp/Element.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 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 | =head1 NAME
PPIx::Regexp::Element - Base of the PPIx::Regexp hierarchy.
=head1 SYNOPSIS
No user-serviceable parts inside.
=head1 INHERITANCE
C<PPIx::Regexp::Element> is not descended from any other class.
C<PPIx::Regexp::Element> is the parent of
L<PPIx::Regexp::Node|PPIx::Regexp::Node> and
L<PPIx::Regexp::Token|PPIx::Regexp::Token>.
=head1 DESCRIPTION
This class is the base of the L<PPIx::Regexp|PPIx::Regexp>
object hierarchy. It provides the same kind of navigational
functionality that is provided by L<PPI::Element|PPI::Element>.
=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::Element;
use strict;
use warnings;
use 5.006;
use Carp;
use List::MoreUtils qw{ firstidx };
use PPIx::Regexp::Util qw{ __instance };
use Scalar::Util qw{ refaddr weaken };
use PPIx::Regexp::Constant qw{ MINIMUM_PERL TOKEN_UNKNOWN };
our $VERSION = '0.050';
=head2 ancestor_of
This method returns true if the object is an ancestor of the argument,
and false otherwise. By the definition of this method, C<$self> is its
own ancestor.
=cut
sub ancestor_of {
my ( $self, $elem ) = @_;
__instance( $elem, __PACKAGE__ ) or return;
my $addr = refaddr( $self );
while ( $addr != refaddr( $elem ) ) {
$elem = $elem->_parent() or return;
}
return 1;
}
=head2 can_be_quantified
$token->can_be_quantified()
and print "This element can be quantified.\n";
This method returns true if the element can be quantified.
=cut
sub can_be_quantified { return 1; }
=head2 class
This method returns the class name of the element. It is the same as
C<ref $self>.
=cut
sub class {
my ( $self ) = @_;
return ref $self;
}
=head2 comment
This method returns true if the element is a comment and false
otherwise.
=cut
sub comment {
return;
}
=head2 content
This method returns the content of the element.
=cut
sub content {
return;
}
=head2 descendant_of
This method returns true if the object is a descendant of the argument,
and false otherwise. By the definition of this method, C<$self> is its
own descendant.
=cut
sub descendant_of {
my ( $self, $node ) = @_;
__instance( $node, __PACKAGE__ ) or return;
return $node->ancestor_of( $self );
}
=head2 explain
This method returns a brief explanation of what the element does. The
return will be either a string or C<undef> in scalar context, but may be
multiple values or an empty array in list context.
This method should be considered experimental. What it returns may
change without notice as my understanding of what all the pieces/parts
of a Perl regular expression evolves. The worst case is that it will
prove entirely infeasible to implement satisfactorily, in which case it
will be put through a deprecation cycle and retracted.
=cut
sub explain {
my ( $self ) = @_;
my $explanation = $self->__explanation();
my $content = $self->content();
if ( my $main = $self->main_structure() ) {
my $delim = $main->delimiters();
$delim = qr{ \\ (?= [\Q$delim\E] ) }smx;
$content =~ s/$delim//smxg;
}
if ( defined( my $splain = $explanation->{$content} ) ) {
return $splain;
}
return $self->__no_explanation();
}
# Return explanation hash
sub __explanation {
$PPIx::Regexp::NO_EXPLANATION_FATAL
and confess 'Neither explain() nor __explanation() overridden';
return {};
}
# Called if no explanation available
sub __no_explanation {
## my ( $self ) = @_; # Invocant unused
my $msg = sprintf q<No explanation>;
$PPIx::Regexp::NO_EXPLANATION_FATAL
and confess $msg;
return $msg;
}
=head2 error
say $token->error();
If an element is one of the classes that represents a parse error, this
method B<may> return a brief message saying why. Otherwise it will
return C<undef>.
=cut
sub error {
my ( $self ) = @_;
return $self->{error};
}
=head2 in_regex_set
This method returns a true value if the invocant is contained in an
extended bracketed character class (also known as a regex set), and a
false value otherwise. This method returns true if the invocant is a
L<PPIx::Regexp::Structure::RegexSet|PPIx::Regexp::Structure::RegexSet>.
=cut
sub in_regex_set {
my ( $self ) = @_;
my $ele = $self;
while ( 1 ) {
$ele->isa( 'PPIx::Regexp::Structure::RegexSet' )
and return 1;
$ele = $ele->parent()
or last;
}
return 0;
}
=head2 is_quantifier
$token->is_quantifier()
and print "This element is a quantifier.\n";
This method returns true if the element is a quantifier. You can not
tell this from the element's class, because a right curly bracket may
represent a quantifier for the purposes of figuring out whether a
greediness token is possible.
=cut
sub is_quantifier { return; }
=head2 main_structure
This method returns the
L<PPIx::Regexp::Structure::Main|PPIx::Regexp::Structure::Main> that
contains the element. In practice this will be a
L<PPIx::Regexp::Structure::Regexp|PPIx::Regexp::Structure::Regexp> or a
L<PPIx::Regexp::Structure::Replacement|PPIx::Regexp::Structure::Replacement>,
If the element is not contained in any such structure, C<undef> is
returned. This will happen if the element is a
L<PPIx::Regexp|PPIx::Regexp> or one of its immediate children.
=cut
sub main_structure {
my ( $self ) = @_;
while ( $self = $self->parent()
and not $self->isa( 'PPIx::Regexp::Structure::Main' ) ) {
}
return $self;
}
=head2 modifier_asserted
$token->modifier_asserted( 'i' )
and print "Matched without regard to case.\n";
This method returns true if the given modifier is in effect for the
element, and false otherwise.
What it does is to walk backwards from the element until it finds a
modifier object that specifies the modifier, whether asserted or
negated. and returns the specified value. If nobody specifies the
modifier, it returns C<undef>.
This method will not work reliably if called on tokenizer output.
=cut
sub modifier_asserted {
my ( $self, $modifier ) = @_;
defined $modifier
or croak 'Modifier must be defined';
my $elem = $self;
while ( $elem ) {
if ( $elem->can( '__ducktype_modifier_asserted' ) ) {
my $val;
defined( $val = $elem->__ducktype_modifier_asserted( $modifier ) )
and return $val;
}
if ( my $prev = $elem->sprevious_sibling() ) {
$elem = $prev;
} else {
$elem = $elem->parent();
}
}
return;
}
=head2 next_sibling
This method returns the element's next sibling, or nothing if there is
none.
=cut
sub next_sibling {
my ( $self ) = @_;
my ( $method, $inx ) = $self->_my_inx()
or return;
return $self->_parent()->$method( $inx + 1 );
}
=head2 parent
This method returns the parent of the element, or undef if there is
none.
=cut
sub parent {
my ( $self ) = @_;
return $self->_parent();
}
=head2 perl_version_introduced
This method returns the version of Perl in which the element was
introduced. This will be at least 5.000. Before 5.006 I am relying on
the F<perldelta>, F<perlre>, and F<perlop> documentation, since I have
been unable to build earlier Perls. Since I have found no documentation
before 5.003, I assume that anything found in 5.003 is also in 5.000.
Since this all depends on my ability to read and understand masses of
documentation, the results of this method should be viewed with caution,
if not downright skepticism.
There are also cases which are ambiguous in various ways. For those see
L<PPIx::Regexp/RESTRICTIONS>, and especially
L<PPIx::Regexp/Changes in Syntax>.
=cut
sub perl_version_introduced {
return MINIMUM_PERL;
}
=head2 perl_version_removed
This method returns the version of Perl in which the element was
removed. If the element is still valid the return is C<undef>.
All the I<caveats> to
L<perl_version_introduced()|/perl_version_introduced> apply here also,
though perhaps less severely since although many features have been
introduced since 5.0, few have been removed.
=cut
sub perl_version_removed {
return undef; ## no critic (ProhibitExplicitReturnUndef)
}
=head2 previous_sibling
This method returns the element's previous sibling, or nothing if there
is none.
=cut
sub previous_sibling {
my ( $self ) = @_;
my ( $method, $inx ) = $self->_my_inx()
or return;
$inx or return;
return $self->_parent()->$method( $inx - 1 );
}
=head2 significant
This method returns true if the element is significant and false
otherwise.
=cut
sub significant {
return 1;
}
=head2 snext_sibling
This method returns the element's next significant sibling, or nothing
if there is none.
=cut
sub snext_sibling {
my ( $self ) = @_;
my $sib = $self;
while ( defined ( $sib = $sib->next_sibling() ) ) {
$sib->significant() and return $sib;
}
return;
}
=head2 sprevious_sibling
This method returns the element's previous significant sibling, or
nothing if there is none.
=cut
sub sprevious_sibling {
my ( $self ) = @_;
my $sib = $self;
while ( defined ( $sib = $sib->previous_sibling() ) ) {
$sib->significant() and return $sib;
}
return;
}
=head2 tokens
This method returns all tokens contained in the element.
=cut
sub tokens {
my ( $self ) = @_;
return $self;
}
=head2 top
This method returns the top of the hierarchy.
=cut
sub top {
my ( $self ) = @_;
my $kid = $self;
while ( defined ( my $parent = $kid->_parent() ) ) {
$kid = $parent;
}
return $kid;
}
=head2 unescaped_content
This method returns the content of the element, unescaped.
=cut
sub unescaped_content {
return;
}
=head2 whitespace
This method returns true if the element is whitespace and false
otherwise.
=cut
sub whitespace {
return;
}
=head2 nav
This method returns navigation information from the top of the hierarchy
to this node. The return is a list of names of methods and references to
their argument lists. The idea is that given C<$elem> which is somewhere
under C<$top>,
my @nav = $elem->nav();
my $obj = $top;
while ( @nav ) {
my $method = shift @nav;
my $args = shift @nav;
$obj = $obj->$method( @{ $args } ) or die;
}
# At this point, $obj should contain the same object
# as $elem.
=cut
sub nav {
my ( $self ) = @_;
__instance( $self, __PACKAGE__ ) or return;
# We do not use $self->parent() here because PPIx::Regexp overrides
# this to return the (possibly) PPI object that initiated us.
my $parent = $self->_parent() or return;
return ( $parent->nav(), $parent->__nav( $self ) );
}
# Find our location and index among the parent's children. If not found,
# just returns.
{
my %method_map = (
children => 'child',
);
sub _my_inx {
my ( $self ) = @_;
my $parent = $self->_parent() or return;
my $addr = refaddr( $self );
foreach my $method ( qw{ children start type finish } ) {
$parent->can( $method ) or next;
my $inx = firstidx { refaddr $_ == $addr } $parent->$method();
$inx < 0 and next;
return ( $method_map{$method} || $method, $inx );
}
return;
}
}
{
my %parent;
# no-argument form returns the parent; one-argument sets it.
sub _parent {
my ( $self, @arg ) = @_;
my $addr = refaddr( $self );
if ( @arg ) {
my $parent = shift @arg;
if ( defined $parent ) {
__instance( $parent, __PACKAGE__ ) or return;
weaken(
$parent{$addr} = $parent );
} else {
delete $parent{$addr};
}
}
return $parent{$addr};
}
sub __parent_keys {
return scalar keys %parent;
}
}
# Bless into TOKEN_UNKNOWN, record error message, return 1.
sub __error {
my ( $self, $msg ) = @_;
defined $msg
or $msg = 'Was ' . ref $self;
$self->{error} = $msg;
bless $self, TOKEN_UNKNOWN;
return 1;
}
# Called by the lexer to record the capture number.
sub __PPIX_LEXER__record_capture_number {
my ( undef, $number ) = @_; # Invocant unused
return $number;
}
# Called by the lexer to rebless
sub __PPIX_ELEM__rebless {
my ( $class, $self ) = @_; # %arg unused
$self ||= {};
bless $self, $class;
delete $self->{error};
defined $self->{error}
and return 1;
delete $self->{error};
return 0;
}
sub DESTROY {
$_[0]->_parent( undef );
return;
}
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 :
|