.\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\" ========================================================================
.\"
.IX Title "Test2::Formatter::TAP 3pm"
.TH Test2::Formatter::TAP 3pm "2017-01-13" "perl v5.24.1" "User Contributed Perl Documentation"
.\" 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"
Test2::Formatter::TAP \- Standard TAP formatter
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This is what takes events and turns them into \s-1TAP.\s0
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&    use Test2::Formatter::TAP;
\&    my $tap = Test2::Formatter::TAP\->new();
\&
\&    # Switch to utf8
\&    $tap\->encoding(\*(Aqutf8\*(Aq);
\&
\&    $tap\->write($event, $number); # Output an event
.Ve
.SH "METHODS"
.IX Header "METHODS"
.ie n .IP "$bool = $tap\->no_numbers" 4
.el .IP "\f(CW$bool\fR = \f(CW$tap\fR\->no_numbers" 4
.IX Item "$bool = $tap->no_numbers"
.PD 0
.ie n .IP "$tap\->set_no_numbers($bool)" 4
.el .IP "\f(CW$tap\fR\->set_no_numbers($bool)" 4
.IX Item "$tap->set_no_numbers($bool)"
.PD
Use to turn numbers on and off.
.ie n .IP "$arrayref = $tap\->handles" 4
.el .IP "\f(CW$arrayref\fR = \f(CW$tap\fR\->handles" 4
.IX Item "$arrayref = $tap->handles"
.PD 0
.ie n .IP "$tap\->set_handles(\e@handles);" 4
.el .IP "\f(CW$tap\fR\->set_handles(\e@handles);" 4
.IX Item "$tap->set_handles(@handles);"
.PD
Can be used to get/set the filehandles. Indexes are identified by the
\&\f(CW\*(C`OUT_STD\*(C'\fR and \f(CW\*(C`OUT_ERR\*(C'\fR constants.
.ie n .IP "$encoding = $tap\->encoding" 4
.el .IP "\f(CW$encoding\fR = \f(CW$tap\fR\->encoding" 4
.IX Item "$encoding = $tap->encoding"
.PD 0
.ie n .IP "$tap\->encoding($encoding)" 4
.el .IP "\f(CW$tap\fR\->encoding($encoding)" 4
.IX Item "$tap->encoding($encoding)"
.PD
Get or set the encoding. By default no encoding is set, the original settings
of \s-1STDOUT\s0 and \s-1STDERR\s0 are used.
.Sp
This directly modifies the stored filehandles, it does not create new ones.
.ie n .IP "$tap\->write($e, $num)" 4
.el .IP "\f(CW$tap\fR\->write($e, \f(CW$num\fR)" 4
.IX Item "$tap->write($e, $num)"
Write an event to the console.
.IP "Test2::Formatter::TAP\->register_event($pkg, sub { ... });" 4
.IX Item "Test2::Formatter::TAP->register_event($pkg, sub { ... });"
In general custom events are not supported. There are however occasions where
you might want to write a custom event type that results in \s-1TAP\s0 output. In
order to do this you use the \f(CW\*(C`register_event()\*(C'\fR class method.
.Sp
.Vb 2
\&    package My::Event;
\&    use Test2::Formatter::TAP;
\&
\&    use base \*(AqTest2::Event\*(Aq;
\&    use Test2::Util::HashBase qw/pass name diag note/;
\&
\&    Test2::Formatter::TAP\->register_event(
\&        _\|_PACKAGE_\|_,
\&        sub {
\&            my $self = shift;
\&            my ($e, $num) = @_;
\&            return (
\&                [Test2::Formatter::TAP::OUT_STD, "ok $num \- " . $e\->name . "\en"],
\&                [Test2::Formatter::TAP::OUT_ERR, "# " . $e\->name . " " . $e\->diag . "\en"],
\&                [Test2::Formatter::TAP::OUT_STD, "# " . $e\->name . " " . $e\->note . "\en"],
\&            );
\&        }
\&    );
\&
\&    1;
.Ve
.SS "\s-1EVENT METHODS\s0"
.IX Subsection "EVENT METHODS"
All these methods require the event itself. Optionally they can all except a
test number.
.PP
All methods return a list of array-refs. Each array-ref will have 2 items, the
first is an integer identifying an output handle, the second is a string that
should be written to the handle.
.ie n .IP "@out = $TAP\->event_ok($e)" 4
.el .IP "\f(CW@out\fR = \f(CW$TAP\fR\->event_ok($e)" 4
.IX Item "@out = $TAP->event_ok($e)"
.PD 0
.ie n .IP "@out = $TAP\->event_ok($e, $num)" 4
.el .IP "\f(CW@out\fR = \f(CW$TAP\fR\->event_ok($e, \f(CW$num\fR)" 4
.IX Item "@out = $TAP->event_ok($e, $num)"
.PD
Process an Test2::Event::Ok event.
.ie n .IP "@out = $TAP\->event_plan($e)" 4
.el .IP "\f(CW@out\fR = \f(CW$TAP\fR\->event_plan($e)" 4
.IX Item "@out = $TAP->event_plan($e)"
.PD 0
.ie n .IP "@out = $TAP\->event_plan($e, $num)" 4
.el .IP "\f(CW@out\fR = \f(CW$TAP\fR\->event_plan($e, \f(CW$num\fR)" 4
.IX Item "@out = $TAP->event_plan($e, $num)"
.PD
Process an Test2::Event::Plan event.
.ie n .IP "@out = $TAP\->event_note($e)" 4
.el .IP "\f(CW@out\fR = \f(CW$TAP\fR\->event_note($e)" 4
.IX Item "@out = $TAP->event_note($e)"
.PD 0
.ie n .IP "@out = $TAP\->event_note($e, $num)" 4
.el .IP "\f(CW@out\fR = \f(CW$TAP\fR\->event_note($e, \f(CW$num\fR)" 4
.IX Item "@out = $TAP->event_note($e, $num)"
.PD
Process an Test2::Event::Note event.
.ie n .IP "@out = $TAP\->event_diag($e)" 4
.el .IP "\f(CW@out\fR = \f(CW$TAP\fR\->event_diag($e)" 4
.IX Item "@out = $TAP->event_diag($e)"
.PD 0
.ie n .IP "@out = $TAP\->event_diag($e, $num)" 4
.el .IP "\f(CW@out\fR = \f(CW$TAP\fR\->event_diag($e, \f(CW$num\fR)" 4
.IX Item "@out = $TAP->event_diag($e, $num)"
.PD
Process an Test2::Event::Diag event.
.ie n .IP "@out = $TAP\->event_bail($e)" 4
.el .IP "\f(CW@out\fR = \f(CW$TAP\fR\->event_bail($e)" 4
.IX Item "@out = $TAP->event_bail($e)"
.PD 0
.ie n .IP "@out = $TAP\->event_bail($e, $num)" 4
.el .IP "\f(CW@out\fR = \f(CW$TAP\fR\->event_bail($e, \f(CW$num\fR)" 4
.IX Item "@out = $TAP->event_bail($e, $num)"
.PD
Process an Test2::Event::Bail event.
.ie n .IP "@out = $TAP\->event_exception($e)" 4
.el .IP "\f(CW@out\fR = \f(CW$TAP\fR\->event_exception($e)" 4
.IX Item "@out = $TAP->event_exception($e)"
.PD 0
.ie n .IP "@out = $TAP\->event_exception($e, $num)" 4
.el .IP "\f(CW@out\fR = \f(CW$TAP\fR\->event_exception($e, \f(CW$num\fR)" 4
.IX Item "@out = $TAP->event_exception($e, $num)"
.PD
Process an Test2::Event::Exception event.
.ie n .IP "@out = $TAP\->event_skip($e)" 4
.el .IP "\f(CW@out\fR = \f(CW$TAP\fR\->event_skip($e)" 4
.IX Item "@out = $TAP->event_skip($e)"
.PD 0
.ie n .IP "@out = $TAP\->event_skip($e, $num)" 4
.el .IP "\f(CW@out\fR = \f(CW$TAP\fR\->event_skip($e, \f(CW$num\fR)" 4
.IX Item "@out = $TAP->event_skip($e, $num)"
.PD
Process an Test2::Event::Skip event.
.ie n .IP "@out = $TAP\->event_subtest($e)" 4
.el .IP "\f(CW@out\fR = \f(CW$TAP\fR\->event_subtest($e)" 4
.IX Item "@out = $TAP->event_subtest($e)"
.PD 0
.ie n .IP "@out = $TAP\->event_subtest($e, $num)" 4
.el .IP "\f(CW@out\fR = \f(CW$TAP\fR\->event_subtest($e, \f(CW$num\fR)" 4
.IX Item "@out = $TAP->event_subtest($e, $num)"
.PD
Process an Test2::Event::Subtest event.
.ie n .IP "@out = $TAP\->event_other($e, $num)" 4
.el .IP "\f(CW@out\fR = \f(CW$TAP\fR\->event_other($e, \f(CW$num\fR)" 4
.IX Item "@out = $TAP->event_other($e, $num)"
Fallback for unregistered event types. It uses the Test2::Event \s-1API\s0 to
convert the event to \s-1TAP.\s0
.SH "SOURCE"
.IX Header "SOURCE"
The source code repository for Test2 can be found at
\&\fIhttp://github.com/Test\-More/test\-more/\fR.
.SH "MAINTAINERS"
.IX Header "MAINTAINERS"
.IP "Chad Granum <exodist@cpan.org>" 4
.IX Item "Chad Granum <exodist@cpan.org>"
.SH "AUTHORS"
.IX Header "AUTHORS"
.PD 0
.IP "Chad Granum <exodist@cpan.org>" 4
.IX Item "Chad Granum <exodist@cpan.org>"
.IP "Kent Fredric <kentnl@cpan.org>" 4
.IX Item "Kent Fredric <kentnl@cpan.org>"
.PD
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright 2016 Chad Granum <exodist@cpan.org>.
.PP
This program is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.
.PP
See \fIhttp://dev.perl.org/licenses/\fR