Debian Codegraph @

upstream/debian-unstable/man3/TAP::Parser::Iterator.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 3perl"
58 .TH TAP::Parser::Iterator 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 \- Base class for TAP source iterators
65 .SH VERSION
66 .IX Header "VERSION"
67 Version 3.48
68 .SH SYNOPSIS
69 .IX Header "SYNOPSIS"
70 .Vb 6
71 \& # to subclass:
72 \& use TAP::Parser::Iterator ();
73 \& use base \*(AqTAP::Parser::Iterator\*(Aq;
74 \& sub _initialize {
75 \& # see TAP::Object...
76 \& }
77 \&
78 \& sub next_raw { ... }
79 \& sub wait { ... }
80 \& sub exit { ... }
81 .Ve
82 .SH DESCRIPTION
83 .IX Header "DESCRIPTION"
84 This is a simple iterator base class that defines TAP::Parser's iterator
85 API. Iterators are typically created from TAP::Parser::SourceHandlers.
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. Provided by TAP::Object.
94 .SS "Instance Methods"
95 .IX Subsection "Instance Methods"
96 \fR\f(CI\*(C`next\*(C'\fR\fI\fR
97 .IX Subsection "next"
98 .PP
99 .Vb 1
100 \& while ( my $item = $iter\->next ) { ... }
101 .Ve
102 .PP
103 Iterate through it, of course.
104 .PP
105 \fR\f(CI\*(C`next_raw\*(C'\fR\fI\fR
106 .IX Subsection "next_raw"
107 .PP
108 \&\fBNote:\fR this method is abstract and should be overridden.
109 .PP
110 .Vb 1
111 \& while ( my $item = $iter\->next_raw ) { ... }
112 .Ve
113 .PP
114 Iterate raw input without applying any fixes for quirky input syntax.
115 .PP
116 \fR\f(CI\*(C`handle_unicode\*(C'\fR\fI\fR
117 .IX Subsection "handle_unicode"
118 .PP
119 If necessary switch the input stream to handle unicode. This only has
120 any effect for I/O handle based streams.
121 .PP
122 The default implementation does nothing.
123 .PP
124 \fR\f(CI\*(C`get_select_handles\*(C'\fR\fI\fR
125 .IX Subsection "get_select_handles"
126 .PP
127 Return a list of filehandles that may be used upstream in a \fBselect()\fR
128 call to signal that this Iterator is ready. Iterators that are not
129 handle-based should return an empty list.
130 .PP
131 The default implementation does nothing.
132 .PP
133 \fR\f(CI\*(C`wait\*(C'\fR\fI\fR
134 .IX Subsection "wait"
135 .PP
136 \&\fBNote:\fR this method is abstract and should be overridden.
137 .PP
138 .Vb 1
139 \& my $wait_status = $iter\->wait;
140 .Ve
141 .PP
142 Return the \f(CW\*(C`wait\*(C'\fR status for this iterator.
143 .PP
144 \fR\f(CI\*(C`exit\*(C'\fR\fI\fR
145 .IX Subsection "exit"
146 .PP
147 \&\fBNote:\fR this method is abstract and should be overridden.
148 .PP
149 .Vb 1
150 \& my $wait_status = $iter\->exit;
151 .Ve
152 .PP
153 Return the \f(CW\*(C`exit\*(C'\fR status for this iterator.
154 .SH SUBCLASSING
155 .IX Header "SUBCLASSING"
156 Please see "SUBCLASSING" in TAP::Parser for a subclassing overview.
157 .PP
158 You must override the abstract methods as noted above.
159 .SS Example
160 .IX Subsection "Example"
161 TAP::Parser::Iterator::Array is probably the easiest example to follow.
162 There's not much point repeating it here.
163 .SH "SEE ALSO"
164 .IX Header "SEE ALSO"
165 TAP::Object,
166 TAP::Parser,
167 TAP::Parser::Iterator::Array,
168 TAP::Parser::Iterator::Stream,
169 TAP::Parser::Iterator::Process,