1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
|
.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" 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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
. ds C` ""
. ds C' ""
'br\}
.el\{\
. ds C`
. ds C'
'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 >0, 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.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
. if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. if !\nF==2 \{\
. nr % 0
. nr F 2
. \}
. \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "TAP::Parser::Iterator 3perl"
.TH TAP::Parser::Iterator 3perl 2024-02-11 "perl v5.38.2" "Perl Programmers Reference Guide"
.\" 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 \- Base class for TAP source iterators
.SH VERSION
.IX Header "VERSION"
Version 3.44
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 6
\& # to subclass:
\& use TAP::Parser::Iterator ();
\& use base \*(AqTAP::Parser::Iterator\*(Aq;
\& sub _initialize {
\& # see TAP::Object...
\& }
\&
\& sub next_raw { ... }
\& sub wait { ... }
\& sub exit { ... }
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This is a simple iterator base class that defines TAP::Parser's iterator
API. Iterators are typically created from TAP::Parser::SourceHandlers.
.SH METHODS
.IX Header "METHODS"
.SS "Class Methods"
.IX Subsection "Class Methods"
\fR\f(CI\*(C`new\*(C'\fR\fI\fR
.IX Subsection "new"
.PP
Create an iterator. Provided by TAP::Object.
.SS "Instance Methods"
.IX Subsection "Instance Methods"
\fR\f(CI\*(C`next\*(C'\fR\fI\fR
.IX Subsection "next"
.PP
.Vb 1
\& while ( my $item = $iter\->next ) { ... }
.Ve
.PP
Iterate through it, of course.
.PP
\fR\f(CI\*(C`next_raw\*(C'\fR\fI\fR
.IX Subsection "next_raw"
.PP
\&\fBNote:\fR this method is abstract and should be overridden.
.PP
.Vb 1
\& while ( my $item = $iter\->next_raw ) { ... }
.Ve
.PP
Iterate raw input without applying any fixes for quirky input syntax.
.PP
\fR\f(CI\*(C`handle_unicode\*(C'\fR\fI\fR
.IX Subsection "handle_unicode"
.PP
If necessary switch the input stream to handle unicode. This only has
any effect for I/O handle based streams.
.PP
The default implementation does nothing.
.PP
\fR\f(CI\*(C`get_select_handles\*(C'\fR\fI\fR
.IX Subsection "get_select_handles"
.PP
Return a list of filehandles that may be used upstream in a \fBselect()\fR
call to signal that this Iterator is ready. Iterators that are not
handle-based should return an empty list.
.PP
The default implementation does nothing.
.PP
\fR\f(CI\*(C`wait\*(C'\fR\fI\fR
.IX Subsection "wait"
.PP
\&\fBNote:\fR this method is abstract and should be overridden.
.PP
.Vb 1
\& my $wait_status = $iter\->wait;
.Ve
.PP
Return the \f(CW\*(C`wait\*(C'\fR status for this iterator.
.PP
\fR\f(CI\*(C`exit\*(C'\fR\fI\fR
.IX Subsection "exit"
.PP
\&\fBNote:\fR this method is abstract and should be overridden.
.PP
.Vb 1
\& my $wait_status = $iter\->exit;
.Ve
.PP
Return the \f(CW\*(C`exit\*(C'\fR status for this iterator.
.SH SUBCLASSING
.IX Header "SUBCLASSING"
Please see "SUBCLASSING" in TAP::Parser for a subclassing overview.
.PP
You must override the abstract methods as noted above.
.SS Example
.IX Subsection "Example"
TAP::Parser::Iterator::Array is probably the easiest example to follow.
There's not much point repeating it here.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
TAP::Object,
TAP::Parser,
TAP::Parser::Iterator::Array,
TAP::Parser::Iterator::Stream,
TAP::Parser::Iterator::Process,
|
