TAP::Parser::Iterator(User Contributed Perl DocumentatTAP::Parser::Iterator(3)NAMETAP::Parser::Iterator - Base class for TAP source iterators
VERSION
Version 3.26
SYNOPSIS
# to subclass:
use vars qw(@ISA);
use TAP::Parser::Iterator ();
@ISA = qw(TAP::Parser::Iterator);
sub _initialize {
# see TAP::Object...
}
sub next_raw { ... }
sub wait { ... }
sub exit { ... }
DESCRIPTION
This is a simple iterator base class that defines the TAP::Parser man‐
page's iterator API. Iterators are typically created from the
TAP::Parser::SourceHandler manpages.
METHODS
Class Methods
"new"
Create an iterator. Provided by the TAP::Object manpage.
Instance Methods
"next"
while ( my $item = $iter->next ) { ... }
Iterate through it, of course.
"next_raw"
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.
"handle_unicode"
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.
"get_select_handles"
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 han‐
dle-based should return an empty list.
The default implementation does nothing.
"wait"
Note: this method is abstract and should be overridden.
my $wait_status = $iter->wait;
Return the "wait" status for this iterator.
"exit"
Note: this method is abstract and should be overridden.
my $wait_status = $iter->exit;
Return the "exit" status for this iterator.
SUBCLASSING
Please see the SUBCLASSING entry in the TAP::Parser manpage for a sub‐
classing overview.
You must override the abstract methods as noted above.
Example
the TAP::Parser::Iterator::Array manpage is probably the easiest exam‐
ple to follow. There's not much point repeating it here.
SEE ALSO
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,
3rd Berkeley Distribution perl v5.6.1 TAP::Parser::Iterator(3)
