tap::parser::iterator::process5.18(3pm) [mojave man page]

TAP::Parser::Iterator::Process(3pm)			 Perl Programmers Reference Guide		       TAP::Parser::Iterator::Process(3pm)

NAME

       TAP::Parser::Iterator::Process - Iterator for process-based TAP sources

VERSION

       Version 3.26

SYNOPSIS

	 use TAP::Parser::Iterator::Process;
	 my %args = (
	  command  => ['python', 'setup.py', 'test'],
	  merge    => 1,
	  setup    => sub { ... },
	  teardown => sub { ... },
	 );
	 my $it   = TAP::Parser::Iterator::Process->new(\%args);
	 my $line = $it->next;

DESCRIPTION

       This is a simple iterator wrapper for executing external processes, used by TAP::Parser.  Unless you're writing a plugin or subclassing,
       you probably won't need to use this module directly.

METHODS

   Class Methods
       "new"

       Create an iterator.  Expects one argument containing a hashref of the form:

	  command  => @command_to_execute
	  merge    => $attempt_merge_stderr_and_stdout?
	  setup    => $callback_to_setup_command
	  teardown => $callback_to_teardown_command

       Tries to uses IPC::Open3 & IO::Select to communicate with the spawned process if they are available.  Falls back onto "open()".

   Instance Methods
       "next"

       Iterate through the process output, of course.

       "next_raw"

       Iterate raw input without applying any fixes for quirky input syntax.

       "wait"

       Get the wait status for this iterator's process.

       "exit"

       Get the exit status for this iterator's process.

       "handle_unicode"

       Upgrade the input stream to handle UTF8.

       "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
       handle based should return an empty list.

ATTRIBUTION

       Originally ripped off from Test::Harness.

SEE ALSO

       TAP::Object, TAP::Parser, TAP::Parser::Iterator,

perl v5.18.2							    2014-01-06				       TAP::Parser::Iterator::Process(3pm)

TAP::Parser::Iterator(3pm)				 Perl Programmers Reference Guide				TAP::Parser::Iterator(3pm)

NAME

       TAP::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 TAP::Parser's iterator API.  Iterators are typically created from
       TAP::Parser::SourceHandlers.

METHODS

   Class Methods
       "new"

       Create an iterator.  Provided by TAP::Object.

   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
       handle-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 "SUBCLASSING" in TAP::Parser for a subclassing overview.

       You must override the abstract methods as noted above.

   Example
       TAP::Parser::Iterator::Array is probably the easiest example to follow.	There's not much point repeating it here.

SEE ALSO

       TAP::Object, TAP::Parser, TAP::Parser::Iterator::Array, TAP::Parser::Iterator::Stream, TAP::Parser::Iterator::Process,

perl v5.18.2							    2014-01-06						TAP::Parser::Iterator(3pm)