manpagez: man pages & more
man Pod::Simple::PullParserToken(3)
Home | html | info | man


       Pod::Simple::PullParserToken -- tokens from Pod::Simple::PullParser


       Given a $parser that's an object of class Pod::Simple::PullParser (or a

         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)


       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:

           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:

           This is a shortcut for "$token->type() eq "start""

           This is a shortcut for "$token->type() eq "text""

           This is a shortcut for "$token->type() eq "end""

           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";


       My subclasses: Pod::Simple::PullParserStartToken(3),
       Pod::Simple::PullParserTextToken(3), and 

       Pod::Simple::PullParser(3) and Pod::Simple(3)


       Questions or discussion about POD and Pod::Simple should be sent to the mail list. Send an empty email to to subscribe.

       This module is managed in an open GitHub repository,
       <>. Feel free to fork and
       contribute, or to clone <git://> and
       send patches!

       Patches against Pod::Simple are welcome. Please send bug reports to


       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.


       Pod::Simple was created by Sean M. Burke <>.  But don't
       bother him, he's retired.

       Pod::Simple is maintained by:

       o   Allison Randal ""

       o   Hans Dieter Pearcey ""

       o   David E. Wheeler ""

perl v5.24.0                      2016-03-01 Pod::Simple::PullParserToken(3pm)

perl 5.24 - Generated Sun Nov 20 18:30:22 CST 2016
© 2000-2018
Individual documents may contain additional copyright information.