local-lib5/man/man3/TAP::Parser::Iterator::Process.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::Process 3"
 132 .TH TAP::Parser::Iterator::Process 3 "2009-05-05" "perl v5.8.7" "User Contributed Perl Documentation"
 133 .SH "NAME"
 134 TAP::Parser::Iterator::Process \- Internal TAP::Parser Iterator
 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 preferred usage
 142 .Ve
 143 .PP
 144 .Vb 10
 145 \&  # to use directly:
 146 \&  use TAP::Parser::Iterator::Process;
 147 \&  my %args = (
 148 \&   command  => ['python', 'setup.py', 'test'],
 149 \&   merge    => 1,
 150 \&   setup    => sub { ... },
 151 \&   teardown => sub { ... },
 152 \&  );
 153 \&  my $it   = TAP::Parser::Iterator::Process\->new(\e%args);
 154 \&  my $line = $it\->next;
 155 .Ve
 156 .SH "DESCRIPTION"
 157 .IX Header "DESCRIPTION"
 158 This is a simple iterator wrapper for executing external processes, used by
 159 TAP::Parser.  Unless you're subclassing, you probably won't need to use
 160 this module directly.
 161 .SH "METHODS"
 162 .IX Header "METHODS"
 163 .Sh "Class Methods"
 164 .IX Subsection "Class Methods"
 165 \fI\f(CI\*(C`new\*(C'\fI\fR
 166 .IX Subsection "new"
 167 .PP
 168 Create an iterator.  Expects one argument containing a hashref of the form:
 169 .PP
 170 .Vb 4
 171 \&   command  => \e@command_to_execute
 172 \&   merge    => $attempt_merge_stderr_and_stdout?
 173 \&   setup    => $callback_to_setup_command
 174 \&   teardown => $callback_to_teardown_command
 175 .Ve
 176 .PP
 177 Tries to uses IPC::Open3 & IO::Select to communicate with the spawned
 178 process if they are available.  Falls back onto \f(CW\*(C`open()\*(C'\fR.
 179 .Sh "Instance Methods"
 180 .IX Subsection "Instance Methods"
 181 \fI\f(CI\*(C`next\*(C'\fI\fR
 182 .IX Subsection "next"
 183 .PP
 184 Iterate through the process output, of course.
 185 .PP
 186 \fI\f(CI\*(C`next_raw\*(C'\fI\fR
 187 .IX Subsection "next_raw"
 188 .PP
 189 Iterate raw input without applying any fixes for quirky input syntax.
 190 .PP
 191 \fI\f(CI\*(C`wait\*(C'\fI\fR
 192 .IX Subsection "wait"
 193 .PP
 194 Get the wait status for this iterator's process.
 195 .PP
 196 \fI\f(CI\*(C`exit\*(C'\fI\fR
 197 .IX Subsection "exit"
 198 .PP
 199 Get the exit status for this iterator's process.
 200 .PP
 201 \fI\f(CI\*(C`handle_unicode\*(C'\fI\fR
 202 .IX Subsection "handle_unicode"
 203 .PP
 204 Upgrade the input stream to handle \s-1UTF8\s0.
 205 .PP
 206 \fI\f(CI\*(C`get_select_handles\*(C'\fI\fR
 207 .IX Subsection "get_select_handles"
 208 .PP
 209 Return a list of filehandles that may be used upstream in a \fIselect()\fR
 210 call to signal that this Iterator is ready. Iterators that are not
 211 handle based should return an empty list.
 212 .SH "ATTRIBUTION"
 213 .IX Header "ATTRIBUTION"
 214 Originally ripped off from Test::Harness.
 215 .SH "SEE ALSO"
 216 .IX Header "SEE ALSO"
 217 TAP::Object,
 218 TAP::Parser,
 219 TAP::Parser::Iterator,
 220 TAP::Parser::IteratorFactory,