local-lib5/man/man3/Pod::Simple::PullParserToken.3pm

   1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.3
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sh \" Subsection heading
   6 .br
   7 .if t .Sp
   8 .ne 5
   9 .PP
  10 \fB\\$1\fR
  11 .PP
  12 ..
  13 .de Sp \" Vertical space (when we can't use .PP)
  14 .if t .sp .5v
  15 .if n .sp
  16 ..
  17 .de Vb \" Begin verbatim text
  18 .ft CW
  19 .nf
  20 .ne \\$1
  21 ..
  22 .de Ve \" End verbatim text
  23 .ft R
  24 .fi
  25 ..
  26 .\" Set up some character translations and predefined strings.  \*(-- will
  27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  28 .\" double quote, and \*(R" will give a right double quote.  | will give a
  29 .\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
  30 .\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
  31 .\" expand to `' in nroff, nothing in troff, for use with C<>.
  32 .tr \(*W-|\(bv\*(Tr
  33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  34 .ie n \{\
  35 .    ds -- \(*W-
  36 .    ds PI pi
  37 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  38 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  39 .    ds L" ""
  40 .    ds R" ""
  41 .    ds C` ""
  42 .    ds C' ""
  43 'br\}
  44 .el\{\
  45 .    ds -- \|\(em\|
  46 .    ds PI \(*p
  47 .    ds L" ``
  48 .    ds R" ''
  49 'br\}
  50 .\"
  51 .\" If the F register is turned on, we'll generate index entries on stderr for
  52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
  53 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  54 .\" output yourself in some meaningful fashion.
  55 .if \nF \{\
  56 .    de IX
  57 .    tm Index:\\$1\t\\n%\t"\\$2"
  58 ..
  59 .    nr % 0
  60 .    rr F
  61 .\}
  62 .\"
  63 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
  64 .\" way too many mistakes in technical documents.
  65 .hy 0
  66 .if n .na
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "Pod::Simple::PullParserToken 3"
 132 .TH Pod::Simple::PullParserToken 3 "2008-06-03" "perl v5.8.7" "User Contributed Perl Documentation"
 133 .SH "NAME"
 134 Pod::Simple::PullParserToken \-\- tokens from Pod::Simple::PullParser
 135 .SH "SYNOPSIS"
 136 .IX Header "SYNOPSIS"
 137 Given a \f(CW$parser\fR that's an object of class Pod::Simple::PullParser
 138 (or a subclass)...
 139 .PP
 140 .Vb 4
 141 \&  while(my $token = $parser\->get_token) {
 142 \&    $DEBUG and print "Token: ", $token\->dump, "\en";
 143 \&    if($token\->is_start) {
 144 \&      ...access $token\->tagname, $token\->attr, etc...
 145 .Ve
 146 .PP
 147 .Vb 2
 148 \&    } elsif($token\->is_text) {
 149 \&      ...access $token\->text, $token\->text_r, etc...
 150 .Ve
 151 .PP
 152 .Vb 2
 153 \&    } elsif($token\->is_end) {
 154 \&      ...access $token\->tagname...
 155 .Ve
 156 .PP
 157 .Vb 2
 158 \&    }
 159 \&  }
 160 .Ve
 161 .PP
 162 (Also see Pod::Simple::PullParser)
 163 .SH "DESCRIPTION"
 164 .IX Header "DESCRIPTION"
 165 When you do \f(CW$parser\fR\->get_token on a Pod::Simple::PullParser, you should
 166 get an object of a subclass of Pod::Simple::PullParserToken.
 167 .PP
 168 Subclasses will add methods, and will also inherit these methods:
 169 .IP "$token\->type" 4
 170 .IX Item "$token->type"
 171 This returns the type of the token.  This will be either the string
 172 \&\*(L"start\*(R", the string \*(L"text\*(R", or the string \*(L"end\*(R".
 173 .Sp
 174 Once you know what the type of an object is, you then know what
 175 subclass it belongs to, and therefore what methods it supports.
 176 .Sp
 177 Yes, you could probably do the same thing with code like
 178 \&\f(CW$token\fR\->isa('Pod::Simple::PullParserEndToken'), but that's not so
 179 pretty as using just \f(CW$token\fR\->type, or even the following shortcuts:
 180 .IP "$token\->is_start" 4
 181 .IX Item "$token->is_start"
 182 This is a shortcut for \f(CW\*(C`$token\->type() eq "start"\*(C'\fR
 183 .IP "$token\->is_text" 4
 184 .IX Item "$token->is_text"
 185 This is a shortcut for \f(CW\*(C`$token\->type() eq "text"\*(C'\fR
 186 .IP "$token\->is_end" 4
 187 .IX Item "$token->is_end"
 188 This is a shortcut for \f(CW\*(C`$token\->type() eq "end"\*(C'\fR
 189 .IP "$token\->dump" 4
 190 .IX Item "$token->dump"
 191 This returns a handy stringified value of this object.  This
 192 is useful for debugging, as in:
 193 .Sp
 194 .Vb 4
 195 \&  while(my $token = $parser\->get_token) {
 196 \&    $DEBUG and print "Token: ", $token\->dump, "\en";
 197 \&    ...
 198 \&  }
 199 .Ve
 200 .SH "SEE ALSO"
 201 .IX Header "SEE ALSO"
 202 My subclasses:
 203 Pod::Simple::PullParserStartToken,
 204 Pod::Simple::PullParserTextToken, and
 205 Pod::Simple::PullParserEndToken.
 206 .PP
 207 Pod::Simple::PullParser and Pod::Simple
 208 .SH "COPYRIGHT AND DISCLAIMERS"
 209 .IX Header "COPYRIGHT AND DISCLAIMERS"
 210 Copyright (c) 2002 Sean M. Burke.  All rights reserved.
 211 .PP
 212 This library is free software; you can redistribute it and/or modify it
 213 under the same terms as Perl itself.
 214 .PP
 215 This program is distributed in the hope that it will be useful, but
 216 without any warranty; without even the implied warranty of
 217 merchantability or fitness for a particular purpose.
 218 .SH "AUTHOR"
 219 .IX Header "AUTHOR"
 220 Sean M. Burke \f(CW\*(C`sburke@cpan.org\*(C'\fR