Debian Codegraph @

upstream/mageia-cauldron/man3pm/TAP::Parser::Iterator.3pm

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man v6.0.2 (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 .\" Required to disable full justification in groff 1.23.0.
57 .if n .ds AD l
58 .\" ========================================================================
59 .\"
60 .IX Title "TAP::Parser::Iterator 3pm"
61 .TH TAP::Parser::Iterator 3pm 2025-06-24 "perl v5.42.0" "Perl Programmers Reference Guide"
62 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
63 .\" way too many mistakes in technical documents.
64 .if n .ad l
65 .nh
66 .SH NAME
67 TAP::Parser::Iterator \- Base class for TAP source iterators
68 .SH VERSION
69 .IX Header "VERSION"
70 Version 3.50
71 .SH SYNOPSIS
72 .IX Header "SYNOPSIS"
73 .Vb 6
74 \& # to subclass:
75 \& use TAP::Parser::Iterator ();
76 \& use base \*(AqTAP::Parser::Iterator\*(Aq;
77 \& sub _initialize {
78 \& # see TAP::Object...
79 \& }
80 \&
81 \& sub next_raw { ... }
82 \& sub wait { ... }
83 \& sub exit { ... }
84 .Ve
85 .SH DESCRIPTION
86 .IX Header "DESCRIPTION"
87 This is a simple iterator base class that defines TAP::Parser\*(Aqs iterator
88 API. Iterators are typically created from TAP::Parser::SourceHandlers.
89 .SH METHODS
90 .IX Header "METHODS"
91 .SS "Class Methods"
92 .IX Subsection "Class Methods"
93 \fR\f(CI\*(C`new\*(C'\fR\fI\fR
94 .IX Subsection "new"
95 .PP
96 Create an iterator. Provided by TAP::Object.
97 .SS "Instance Methods"
98 .IX Subsection "Instance Methods"
99 \fR\f(CI\*(C`next\*(C'\fR\fI\fR
100 .IX Subsection "next"
101 .PP
102 .Vb 1
103 \& while ( my $item = $iter\->next ) { ... }
104 .Ve
105 .PP
106 Iterate through it, of course.
107 .PP
108 \fR\f(CI\*(C`next_raw\*(C'\fR\fI\fR
109 .IX Subsection "next_raw"
110 .PP
111 \&\fBNote:\fR this method is abstract and should be overridden.
112 .PP
113 .Vb 1
114 \& while ( my $item = $iter\->next_raw ) { ... }
115 .Ve
116 .PP
117 Iterate raw input without applying any fixes for quirky input syntax.
118 .PP
119 \fR\f(CI\*(C`handle_unicode\*(C'\fR\fI\fR
120 .IX Subsection "handle_unicode"
121 .PP
122 If necessary switch the input stream to handle unicode. This only has
123 any effect for I/O handle based streams.
124 .PP
125 The default implementation does nothing.
126 .PP
127 \fR\f(CI\*(C`get_select_handles\*(C'\fR\fI\fR
128 .IX Subsection "get_select_handles"
129 .PP
130 Return a list of filehandles that may be used upstream in a \fBselect()\fR
131 call to signal that this Iterator is ready. Iterators that are not
132 handle\-based should return an empty list.
133 .PP
134 The default implementation does nothing.
135 .PP
136 \fR\f(CI\*(C`wait\*(C'\fR\fI\fR
137 .IX Subsection "wait"
138 .PP
139 \&\fBNote:\fR this method is abstract and should be overridden.
140 .PP
141 .Vb 1
142 \& my $wait_status = $iter\->wait;
143 .Ve
144 .PP
145 Return the \f(CW\*(C`wait\*(C'\fR status for this iterator.
146 .PP
147 \fR\f(CI\*(C`exit\*(C'\fR\fI\fR
148 .IX Subsection "exit"
149 .PP
150 \&\fBNote:\fR this method is abstract and should be overridden.
151 .PP
152 .Vb 1
153 \& my $wait_status = $iter\->exit;
154 .Ve
155 .PP
156 Return the \f(CW\*(C`exit\*(C'\fR status for this iterator.
157 .SH SUBCLASSING
158 .IX Header "SUBCLASSING"
159 Please see "SUBCLASSING" in TAP::Parser for a subclassing overview.
160 .PP
161 You must override the abstract methods as noted above.
162 .SS Example
163 .IX Subsection "Example"
164 TAP::Parser::Iterator::Array is probably the easiest example to follow.
165 There\*(Aqs not much point repeating it here.
166 .SH "SEE ALSO"
167 .IX Header "SEE ALSO"
168 TAP::Object,
169 TAP::Parser,
170 TAP::Parser::Iterator::Array,
171 TAP::Parser::Iterator::Stream,
172 TAP::Parser::Iterator::Process,