Pod::Simple::PullParserToken(3p) Perl Programmers Reference Guide #

Pod::Simple::PullParserToken(3p) Perl Programmers Reference Guide

NNAAMMEE #

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

SSYYNNOOPPSSIISS #

 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)

DDEESSCCRRIIPPTTIIOONN #

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

SSEEEE AALLSSOO #

 My subclasses: Pod::Simple::PullParserStartToken,
 Pod::Simple::PullParserTextToken, and Pod::Simple::PullParserEndToken.

 Pod::Simple::PullParser and Pod::Simple

SSUUPPPPOORRTT #

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

CCOOPPYYRRIIGGHHTT AANNDD DDIISSCCLLAAIIMMEERRSS #

 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.

AAUUTTHHOORR #

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

 Pod::Simple is maintained by:

 •   Allison Randal "allison@perl.org"

 •   Hans Dieter Pearcey "hdp@cpan.org"

 •   David E. Wheeler "dwheeler@cpan.org"

perl v5.36.3 2023-02-15 Pod::Simple::PullParserToken(3p)