Debian Codegraph @

upstream/debian-unstable/man3/TAP::Parser::Iterator::Process.3perl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "TAP::Parser::Iterator::Process 3perl"
58 .TH TAP::Parser::Iterator::Process 3perl 2025-11-16 "perl v5.40.1" "Perl Programmers Reference Guide"
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 TAP::Parser::Iterator::Process \- Iterator for process\-based TAP sources
65 .SH VERSION
66 .IX Header "VERSION"
67 Version 3.48
68 .SH SYNOPSIS
69 .IX Header "SYNOPSIS"
70 .Vb 9
71 \& use TAP::Parser::Iterator::Process;
72 \& my %args = (
73 \& command => [\*(Aqpython\*(Aq, \*(Aqsetup.py\*(Aq, \*(Aqtest\*(Aq],
74 \& merge => 1,
75 \& setup => sub { ... },
76 \& teardown => sub { ... },
77 \& );
78 \& my $it = TAP::Parser::Iterator::Process\->new(\e%args);
79 \& my $line = $it\->next;
80 .Ve
81 .SH DESCRIPTION
82 .IX Header "DESCRIPTION"
83 This is a simple iterator wrapper for executing external processes, used by
84 TAP::Parser. Unless you're writing a plugin or subclassing, you probably
85 won't need to use this module directly.
86 .SH METHODS
87 .IX Header "METHODS"
88 .SS "Class Methods"
89 .IX Subsection "Class Methods"
90 \fR\f(CI\*(C`new\*(C'\fR\fI\fR
91 .IX Subsection "new"
92 .PP
93 Create an iterator. Expects one argument containing a hashref of the form:
94 .PP
95 .Vb 4
96 \& command => \e@command_to_execute
97 \& merge => $attempt_merge_stderr_and_stdout?
98 \& setup => $callback_to_setup_command
99 \& teardown => $callback_to_teardown_command
100 .Ve
101 .PP
102 Tries to uses IPC::Open3 & IO::Select to communicate with the spawned
103 process if they are available. Falls back onto \f(CWopen()\fR.
104 .SS "Instance Methods"
105 .IX Subsection "Instance Methods"
106 \fR\f(CI\*(C`next\*(C'\fR\fI\fR
107 .IX Subsection "next"
108 .PP
109 Iterate through the process output, of course.
110 .PP
111 \fR\f(CI\*(C`next_raw\*(C'\fR\fI\fR
112 .IX Subsection "next_raw"
113 .PP
114 Iterate raw input without applying any fixes for quirky input syntax.
115 .PP
116 \fR\f(CI\*(C`wait\*(C'\fR\fI\fR
117 .IX Subsection "wait"
118 .PP
119 Get the wait status for this iterator's process.
120 .PP
121 \fR\f(CI\*(C`exit\*(C'\fR\fI\fR
122 .IX Subsection "exit"
123 .PP
124 Get the exit status for this iterator's process.
125 .PP
126 \fR\f(CI\*(C`handle_unicode\*(C'\fR\fI\fR
127 .IX Subsection "handle_unicode"
128 .PP
129 Upgrade the input stream to handle UTF8.
130 .PP
131 \fR\f(CI\*(C`get_select_handles\*(C'\fR\fI\fR
132 .IX Subsection "get_select_handles"
133 .PP
134 Return a list of filehandles that may be used upstream in a \fBselect()\fR
135 call to signal that this Iterator is ready. Iterators that are not
136 handle based should return an empty list.
137 .SH ATTRIBUTION
138 .IX Header "ATTRIBUTION"
139 Originally ripped off from Test::Harness.
140 .SH "SEE ALSO"
141 .IX Header "SEE ALSO"
142 TAP::Object,
143 TAP::Parser,
144 TAP::Parser::Iterator,