local-lib5/man/man3/TAP::Parser::Iterator.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 "TAP::Parser::Iterator 3"
 132 .TH TAP::Parser::Iterator 3 "2009-05-05" "perl v5.8.7" "User Contributed Perl Documentation"
 133 .SH "NAME"
 134 TAP::Parser::Iterator \- Internal base class for TAP::Parser Iterators
 135 .SH "VERSION"
 136 .IX Header "VERSION"
 137 Version 3.17
 138 .SH "SYNOPSIS"
 139 .IX Header "SYNOPSIS"
 140 .Vb 1
 141 \&  # see TAP::Parser::IteratorFactory for general usage
 142 .Ve
 143 .PP
 144 .Vb 7
 145 \&  # to subclass:
 146 \&  use vars qw(@ISA);
 147 \&  use TAP::Parser::Iterator ();
 148 \&  @ISA = qw(TAP::Parser::Iterator);
 149 \&  sub _initialize {
 150 \&    # see TAP::Object...
 151 \&  }
 152 .Ve
 153 .SH "DESCRIPTION"
 154 .IX Header "DESCRIPTION"
 155 This is a simple iterator base class that defines TAP::Parser's iterator
 156 \&\s-1API\s0.  See \f(CW\*(C`TAP::Parser::IteratorFactory\*(C'\fR for the preferred way of creating
 157 iterators.
 158 .SH "METHODS"
 159 .IX Header "METHODS"
 160 .Sh "Class Methods"
 161 .IX Subsection "Class Methods"
 162 \fI\f(CI\*(C`new\*(C'\fI\fR
 163 .IX Subsection "new"
 164 .PP
 165 Create an iterator.  Provided by TAP::Object.
 166 .Sh "Instance Methods"
 167 .IX Subsection "Instance Methods"
 168 \fI\f(CI\*(C`next\*(C'\fI\fR
 169 .IX Subsection "next"
 170 .PP
 171 .Vb 1
 172 \& while ( my $item = $iter\->next ) { ... }
 173 .Ve
 174 .PP
 175 Iterate through it, of course.
 176 .PP
 177 \fI\f(CI\*(C`next_raw\*(C'\fI\fR
 178 .IX Subsection "next_raw"
 179 .PP
 180 \&\fBNote:\fR this method is abstract and should be overridden.
 181 .PP
 182 .Vb 1
 183 \& while ( my $item = $iter\->next_raw ) { ... }
 184 .Ve
 185 .PP
 186 Iterate raw input without applying any fixes for quirky input syntax.
 187 .PP
 188 \fI\f(CI\*(C`handle_unicode\*(C'\fI\fR
 189 .IX Subsection "handle_unicode"
 190 .PP
 191 If necessary switch the input stream to handle unicode. This only has
 192 any effect for I/O handle based streams.
 193 .PP
 194 The default implementation does nothing.
 195 .PP
 196 \fI\f(CI\*(C`get_select_handles\*(C'\fI\fR
 197 .IX Subsection "get_select_handles"
 198 .PP
 199 Return a list of filehandles that may be used upstream in a \fIselect()\fR
 200 call to signal that this Iterator is ready. Iterators that are not
 201 handle-based should return an empty list.
 202 .PP
 203 The default implementation does nothing.
 204 .PP
 205 \fI\f(CI\*(C`wait\*(C'\fI\fR
 206 .IX Subsection "wait"
 207 .PP
 208 \&\fBNote:\fR this method is abstract and should be overridden.
 209 .PP
 210 .Vb 1
 211 \& my $wait_status = $iter\->wait;
 212 .Ve
 213 .PP
 214 Return the \f(CW\*(C`wait\*(C'\fR status for this iterator.
 215 .PP
 216 \fI\f(CI\*(C`exit\*(C'\fI\fR
 217 .IX Subsection "exit"
 218 .PP
 219 \&\fBNote:\fR this method is abstract and should be overridden.
 220 .PP
 221 .Vb 1
 222 \& my $wait_status = $iter\->exit;
 223 .Ve
 224 .PP
 225 Return the \f(CW\*(C`exit\*(C'\fR status for this iterator.
 226 .SH "SUBCLASSING"
 227 .IX Header "SUBCLASSING"
 228 Please see \*(L"\s-1SUBCLASSING\s0\*(R" in TAP::Parser for a subclassing overview.
 229 .PP
 230 You must override the abstract methods as noted above.
 231 .Sh "Example"
 232 .IX Subsection "Example"
 233 TAP::Parser::Iterator::Array is probably the easiest example to follow.
 234 There's not much point repeating it here.
 235 .SH "SEE ALSO"
 236 .IX Header "SEE ALSO"
 237 TAP::Object,
 238 TAP::Parser,
 239 TAP::Parser::IteratorFactory,
 240 TAP::Parser::Iterator::Array,
 241 TAP::Parser::Iterator::Stream,
 242 TAP::Parser::Iterator::Process,