TAP::Parser::Iterator - Base class for TAP source iterators
Version 3.42
# to subclass:
use TAP::Parser::Iterator ();
use base 'TAP::Parser::Iterator';
sub _initialize {
# see TAP::Object...
}
sub next_raw { ... }
sub wait { ... }
sub exit { ... }
This is a simple iterator base class that defines the TAP::Parser manpage's iterator
API. Iterators are typically created from the TAP::Parser::SourceHandler manpages.
Create an iterator. Provided by the TAP::Object manpage.
while ( my $item = $iter->next ) { ... }
Iterate through it, of course.
Note: this method is abstract and should be overridden.
while ( my $item = $iter->next_raw ) { ... }
Iterate raw input without applying any fixes for quirky input syntax.
If necessary switch the input stream to handle unicode. This only has
any effect for I/O handle based streams.
The default implementation does nothing.
Return a list of filehandles that may be used upstream in a select()
call to signal that this Iterator is ready. Iterators that are not
handle-based should return an empty list.
The default implementation does nothing.
Note: this method is abstract and should be overridden.
my $wait_status = $iter->wait;
Return the wait status for this iterator.
Note: this method is abstract and should be overridden.
my $wait_status = $iter->exit;
Return the exit status for this iterator.
Please see SUBCLASSING in the TAP::Parser manpage for a subclassing overview.
You must override the abstract methods as noted above.
the TAP::Parser::Iterator::Array manpage is probably the easiest example to follow.
There's not much point repeating it here.
the TAP::Object manpage,
the TAP::Parser manpage,
the TAP::Parser::Iterator::Array manpage,
the TAP::Parser::Iterator::Stream manpage,
the TAP::Parser::Iterator::Process manpage,
|