Pod::Simple::PullParserToken man page on Peanut

Man page or keyword search:  
man Server   7435 pages
apropos Keyword Search (all sections)
Output format
Peanut logo
[printable version]

Pod::Simple::PullParserPerlnProgrammers ReferenPod::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 "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 "Token: ", $token->dump, "\n";
	       ...
	     }

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

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

COPYRIGHT AND DISCLAIMERS
       Copyright (c) 2002 Sean M. Burke.  All rights reserved.

       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
       Sean M. Burke "sburke@cpan.org"

perl v5.10.0			  2007-12-18   Pod::Simple::PullParserToken(3)
[top]

List of man pages available for Peanut

Copyright (c) for man pages and the logo by the respective OS vendor.

For those who want to learn more, the polarhome community provides shell access and support.

[legal] [privacy] [GNU] [policy] [cookies] [netiquette] [sponsors] [FAQ]
Tweet
Polarhome, production since 1999.
Member of Polarhome portal.
Based on Fawad Halim's script.
....................................................................
Vote for polarhome
Free Shell Accounts :: the biggest list on the net