Current Path : /proc/2/root/usr/share/man/man3/ |
|
Current File : //proc/2/root/usr/share/man/man3/TAP::Parser::Iterator::Process.3pm |
.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.13)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings. \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote. \*(C+ will
.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
. ds -- \(*W-
. ds PI pi
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
. ds L" ""
. ds R" ""
. ds C` ""
. ds C' ""
'br\}
.el\{\
. ds -- \|\(em\|
. ds PI \(*p
. ds L" ``
. ds R" ''
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.ie \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. nr % 0
. rr F
.\}
.el \{\
. de IX
..
.\}
.\" ========================================================================
.\"
.IX Title "TAP::Parser::Iterator::Process 3"
.TH TAP::Parser::Iterator::Process 3 "2018-03-19" "perl v5.10.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
TAP::Parser::Iterator::Process \- Iterator for process\-based TAP sources
.SH "VERSION"
.IX Header "VERSION"
Version 3.42
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 9
\& use TAP::Parser::Iterator::Process;
\& my %args = (
\& command => [\*(Aqpython\*(Aq, \*(Aqsetup.py\*(Aq, \*(Aqtest\*(Aq],
\& merge => 1,
\& setup => sub { ... },
\& teardown => sub { ... },
\& );
\& my $it = TAP::Parser::Iterator::Process\->new(\e%args);
\& my $line = $it\->next;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This is a simple iterator wrapper for executing external processes, used by
TAP::Parser. Unless you're writing a plugin or subclassing, you probably
won't need to use this module directly.
.SH "METHODS"
.IX Header "METHODS"
.SS "Class Methods"
.IX Subsection "Class Methods"
\fI\f(CI\*(C`new\*(C'\fI\fR
.IX Subsection "new"
.PP
Create an iterator. Expects one argument containing a hashref of the form:
.PP
.Vb 4
\& command => \e@command_to_execute
\& merge => $attempt_merge_stderr_and_stdout?
\& setup => $callback_to_setup_command
\& teardown => $callback_to_teardown_command
.Ve
.PP
Tries to uses IPC::Open3 & IO::Select to communicate with the spawned
process if they are available. Falls back onto \f(CW\*(C`open()\*(C'\fR.
.SS "Instance Methods"
.IX Subsection "Instance Methods"
\fI\f(CI\*(C`next\*(C'\fI\fR
.IX Subsection "next"
.PP
Iterate through the process output, of course.
.PP
\fI\f(CI\*(C`next_raw\*(C'\fI\fR
.IX Subsection "next_raw"
.PP
Iterate raw input without applying any fixes for quirky input syntax.
.PP
\fI\f(CI\*(C`wait\*(C'\fI\fR
.IX Subsection "wait"
.PP
Get the wait status for this iterator's process.
.PP
\fI\f(CI\*(C`exit\*(C'\fI\fR
.IX Subsection "exit"
.PP
Get the exit status for this iterator's process.
.PP
\fI\f(CI\*(C`handle_unicode\*(C'\fI\fR
.IX Subsection "handle_unicode"
.PP
Upgrade the input stream to handle \s-1UTF8\s0.
.PP
\fI\f(CI\*(C`get_select_handles\*(C'\fI\fR
.IX Subsection "get_select_handles"
.PP
Return a list of filehandles that may be used upstream in a \fIselect()\fR
call to signal that this Iterator is ready. Iterators that are not
handle based should return an empty list.
.SH "ATTRIBUTION"
.IX Header "ATTRIBUTION"
Originally ripped off from Test::Harness.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
TAP::Object,
TAP::Parser,
TAP::Parser::Iterator,
Copyright 2K16 - 2K18 Indonesian Hacker Rulez