Pod::Simple::PullParserToken - tokens from Pod::Simple::PullParser
Given a $parser that's an object of class Pod::Simple::PullParser (or a
subclass)...
while(my $token = $parser->get_token) {
$DEBUG and print STDERR "Token: ", $token->dump, "\n";
if($token->is_start) {
...access $token->tagname, $token->attr, etc...
} elsif($token->is_text) {
...access $token->text, $token->text_r, etc...
} elsif($token->is_end) {
...access $token->tagname...
}
}
(Also see Pod::Simple::PullParser)
Perl Programmers Reference Guide
Pod::Simple::PullParserToken(3)
NAME
Pod::Simple::PullParserToken -- tokens from Pod::Simple::PullParser
SYNOPSIS
Given a $parser that's an object of class Pod::Simple::PullParser (or a
subclass)...
while(my $token = $parser->get_token) {
$DEBUG and print STDERR "Token: ", $token->dump, "\n";
if($token->is_start) {
...access $token->tagname, $token->attr, etc...
} elsif($token->is_text) {
...access $token->text, $token->text_r, etc...
} elsif($token->is_end) {
...access $token->tagname...
}
}
(Also see Pod::Simple::PullParser)
DESCRIPTION
When you do $parser->get_token on a Pod::Simple::PullParser, you should
get an object of a subclass of Pod::Simple::PullParserToken.
Subclasses will add methods, and will also inherit these methods:
$token->type
This returns the type of the token. This will be either the string
"start", the string "text", or the string "end".
Once you know what the type of an object is, you then know what
subclass it belongs to, and therefore what methods it supports.
Yes, you could probably do the same thing with code like
$token->isa('Pod::Simple::PullParserEndToken'), but that's not so
pretty as using just $token->type, or even the following shortcuts:
$token->is_start
This is a shortcut for "$token->type() eq "start""
$token->is_text
This is a shortcut for "$token->type() eq "text""
$token->is_end
This is a shortcut for "$token->type() eq "end""
$token->dump
This returns a handy stringified value of this object. This is
useful for debugging, as in:
while(my $token = $parser->get_token) {
$DEBUG and print STDERR "Token: ", $token->dump, "\n";
...
}
ATTRIBUTES
See attributes(7) for descriptions of the following attributes:
+---------------+-----------------------+
|ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+---------------+-----------------------+
|Availability | runtime/perl-532 |
+---------------+-----------------------+
|Stability | Pass-through volatile |
+---------------+-----------------------+
SEE ALSO
My subclasses: Pod::Simple::PullParserStartToken,
Pod::Simple::PullParserTextToken, and Pod::Simple::PullParserEndToken.
Pod::Simple::PullParser and Pod::Simple
SUPPORT
Questions or discussion about POD and Pod::Simple should be sent to the
pod-people@perl.org mail list. Send an empty email to
pod-people-subscribe@perl.org to subscribe.
This module is managed in an open GitHub repository,
<https://github.com/perl-pod/pod-simple/>. Feel free to fork and
contribute, or to clone <git://github.com/perl-pod/pod-simple.git> and
send patches!
Patches against Pod::Simple are welcome. Please send bug reports to
<bug-pod-simple@rt.cpan.org>.
COPYRIGHT AND DISCLAIMERS
Copyright (c) 2002 Sean M. Burke.
This library is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
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.
AUTHOR
Pod::Simple was created by Sean M. Burke <sburke@cpan.org>. But don't
bother him, he's retired.
Pod::Simple is maintained by:
o Allison Randal "allison@perl.org"
o Hans Dieter Pearcey "hdp@cpan.org"
o David E. Wheeler "dwheeler@cpan.org"
NOTES
Source code for open source software components in Oracle Solaris can
be found at https://www.oracle.com/downloads/opensource/solaris-source-
code-downloads.html.
This software was built from source available at
https://github.com/oracle/solaris-userland. The original community
source was downloaded from
http://www.cpan.org/src/5.0/perl-5.32.0.tar.gz.
Further information about this software can be found on the open source
community website at https://www.perl.org/.
perl v5.32.0 2020-06-14
Pod::Simple::PullParserToken(3)