local-lib5/man/man3/TAP::Parser::IteratorFactory.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::IteratorFactory 3"
 132 .TH TAP::Parser::IteratorFactory 3 "2009-05-05" "perl v5.8.7" "User Contributed Perl Documentation"
 133 .SH "NAME"
 134 TAP::Parser::IteratorFactory \- Internal TAP::Parser Iterator
 135 .SH "VERSION"
 136 .IX Header "VERSION"
 137 Version 3.17
 138 .SH "SYNOPSIS"
 139 .IX Header "SYNOPSIS"
 140 .Vb 5
 141 \&  use TAP::Parser::IteratorFactory;
 142 \&  my $factory = TAP::Parser::IteratorFactory\->new;
 143 \&  my $iter = $factory\->make_iterator(\e*TEST);
 144 \&  my $iter = $factory\->make_iterator(\e@array);
 145 \&  my $iter = $factory\->make_iterator(\e%hash);
 146 .Ve
 147 .PP
 148 .Vb 1
 149 \&  my $line = $iter\->next;
 150 .Ve
 151 .SH "DESCRIPTION"
 152 .IX Header "DESCRIPTION"
 153 This is a factory class for simple iterator wrappers for arrays, filehandles,
 154 and hashes.  Unless you're subclassing, you probably won't need to use this
 155 module directly.
 156 .SH "METHODS"
 157 .IX Header "METHODS"
 158 .Sh "Class Methods"
 159 .IX Subsection "Class Methods"
 160 \fI\f(CI\*(C`new\*(C'\fI\fR
 161 .IX Subsection "new"
 162 .PP
 163 Creates a new factory class.
 164 \&\fINote:\fR You currently don't need to instantiate a factory in order to use it.
 165 .PP
 166 \fI\f(CI\*(C`make_iterator\*(C'\fI\fR
 167 .IX Subsection "make_iterator"
 168 .PP
 169 Create an iterator.  The type of iterator created depends on the arguments to
 170 the constructor:
 171 .PP
 172 .Vb 1
 173 \&  my $iter = TAP::Parser::Iterator\->make_iterator( $filehandle );
 174 .Ve
 175 .PP
 176 Creates a \fIstream\fR iterator (see \*(L"make_stream_iterator\*(R").
 177 .PP
 178 .Vb 1
 179 \&  my $iter = TAP::Parser::Iterator\->make_iterator( $array_reference );
 180 .Ve
 181 .PP
 182 Creates an \fIarray\fR iterator (see \*(L"make_array_iterator\*(R").
 183 .PP
 184 .Vb 1
 185 \&  my $iter = TAP::Parser::Iterator\->make_iterator( $hash_reference );
 186 .Ve
 187 .PP
 188 Creates a \fIprocess\fR iterator (see \*(L"make_process_iterator\*(R").
 189 .PP
 190 \fI\f(CI\*(C`make_stream_iterator\*(C'\fI\fR
 191 .IX Subsection "make_stream_iterator"
 192 .PP
 193 Make a new stream iterator and return it.  Passes through any arguments given.
 194 Defaults to a TAP::Parser::Iterator::Stream.
 195 .PP
 196 \fI\f(CI\*(C`make_array_iterator\*(C'\fI\fR
 197 .IX Subsection "make_array_iterator"
 198 .PP
 199 Make a new array iterator and return it.  Passes through any arguments given.
 200 Defaults to a TAP::Parser::Iterator::Array.
 201 .PP
 202 \fI\f(CI\*(C`make_process_iterator\*(C'\fI\fR
 203 .IX Subsection "make_process_iterator"
 204 .PP
 205 Make a new process iterator and return it.  Passes through any arguments given.
 206 Defaults to a TAP::Parser::Iterator::Process.
 207 .SH "SUBCLASSING"
 208 .IX Header "SUBCLASSING"
 209 Please see \*(L"\s-1SUBCLASSING\s0\*(R" in TAP::Parser for a subclassing overview.
 210 .PP
 211 There are a few things to bear in mind when creating your own
 212 \&\f(CW\*(C`ResultFactory\*(C'\fR:
 213 .IP "1" 4
 214 .IX Item "1"
 215 The factory itself is never instantiated (this \fImay\fR change in the future).
 216 This means that \f(CW\*(C`_initialize\*(C'\fR is never called.
 217 .Sh "Example"
 218 .IX Subsection "Example"
 219 .Vb 1
 220 \&  package MyIteratorFactory;
 221 .Ve
 222 .PP
 223 .Vb 2
 224 \&  use strict;
 225 \&  use vars '@ISA';
 226 .Ve
 227 .PP
 228 .Vb 2
 229 \&  use MyStreamIterator;
 230 \&  use TAP::Parser::IteratorFactory;
 231 .Ve
 232 .PP
 233 .Vb 1
 234 \&  @ISA = qw( TAP::Parser::IteratorFactory );
 235 .Ve
 236 .PP
 237 .Vb 5
 238 \&  # override stream iterator
 239 \&  sub make_stream_iterator {
 240 \&    my $proto = shift;
 241 \&    MyStreamIterator\->new(@_);
 242 \&  }
 243 .Ve
 244 .PP
 245 .Vb 1
 246 \&  1;
 247 .Ve
 248 .SH "ATTRIBUTION"
 249 .IX Header "ATTRIBUTION"
 250 Originally ripped off from Test::Harness.
 251 .SH "SEE ALSO"
 252 .IX Header "SEE ALSO"
 253 TAP::Object,
 254 TAP::Parser,
 255 TAP::Parser::Iterator,
 256 TAP::Parser::Iterator::Array,
 257 TAP::Parser::Iterator::Stream,
 258 TAP::Parser::Iterator::Process,