/ 
PPIx-QuoteLike-0.005_03
River stage one • 5 direct dependents • 7 total dependents
/ PPIx::QuoteLike::Token

NAME

PPIx::QuoteLike::Token - Represent any token.

SYNOPSIS

This is an abstract class, and should not be instantiated by the user.

DESCRIPTION

This Perl module represents the base of the token hierarchy.

METHODS

This class supports the following public methods:

content

say $token->content();

This method returns the text that makes up the token.

error

say $token->error();

This method returns the error text. This will be undef unless the token actually represents an error.

parent

my $parent = $token->parent();

This method returns the token's parent, which will be the PPIx::QuoteLike object that contains it.

next_sibling

my $next = $token->next_sibling();

This method returns the token after the invocant, or nothing if there is none.

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 perldelta, perlre, and 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 "RESTRICTIONS" in PPIx::Regexp, and especially "Changes in Syntax" in PPIx::Regexp.

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 undef.

All the caveats to perl_version_introduced() apply here also, though perhaps less severely since although many features have been introduced since 5.0, few have been removed.

previous_sibling

my $prev = $token->previous_sibling();

This method returns the token before the invocant, or nothing if there is none.

significant

$token->significant()
    and say 'significant';

This Boolean method returns a true value if the token is significant, and a false one otherwise.

snext_sibling

my $next = $token->snext_sibling();

This method returns the significant token after the invocant, or nothing if there is none.

sprevious_sibling

my $prev = $token->sprevious_sibling();

This method returns the significant token before the invocant, or nothing if there is none.

SEE ALSO

PPIx::QuoteLike.

SUPPORT

Support is by the author. Please file bug reports at http://rt.cpan.org, or in electronic mail to the author.

AUTHOR

Thomas R. Wyant, III wyant at cpan dot org

COPYRIGHT AND LICENSE

Copyright (C) 2016-2018 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.