.\" -*- 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::Result 3perl"
.TH TAP::Parser::Result 3perl 2024-05-30 "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::Result \- Base class for TAP::Parser output objects
.SH VERSION
.IX Header "VERSION"
Version 3.44
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 2
\&  # abstract class \- not meant to be used directly
\&  # see TAP::Parser::ResultFactory for preferred usage
\&
\&  # directly:
\&  use TAP::Parser::Result;
\&  my $token  = {...};
\&  my $result = TAP::Parser::Result\->new( $token );
.Ve
.SS DESCRIPTION
.IX Subsection "DESCRIPTION"
This is a simple base class used by TAP::Parser to store objects that
represent the current bit of test output data from TAP (usually a single
line).  Unless you're subclassing, you probably won't need to use this module
directly.
.SS METHODS
.IX Subsection "METHODS"
\fR\f(CI\*(C`new\*(C'\fR\fI\fR
.IX Subsection "new"
.PP
.Vb 1
\&  # see TAP::Parser::ResultFactory for preferred usage
\&
\&  # to use directly:
\&  my $result = TAP::Parser::Result\->new($token);
.Ve
.PP
Returns an instance the appropriate class for the test token passed in.
.SS "Boolean methods"
.IX Subsection "Boolean methods"
The following methods all return a boolean value and are to be overridden in
the appropriate subclass.
.IP \(bu 4
\&\f(CW\*(C`is_plan\*(C'\fR
.Sp
Indicates whether or not this is the test plan line.
.Sp
.Vb 1
\& 1..3
.Ve
.IP \(bu 4
\&\f(CW\*(C`is_pragma\*(C'\fR
.Sp
Indicates whether or not this is a pragma line.
.Sp
.Vb 1
\& pragma +strict
.Ve
.IP \(bu 4
\&\f(CW\*(C`is_test\*(C'\fR
.Sp
Indicates whether or not this is a test line.
.Sp
.Vb 1
\& ok 1 Is OK!
.Ve
.IP \(bu 4
\&\f(CW\*(C`is_comment\*(C'\fR
.Sp
Indicates whether or not this is a comment.
.Sp
.Vb 1
\& # this is a comment
.Ve
.IP \(bu 4
\&\f(CW\*(C`is_bailout\*(C'\fR
.Sp
Indicates whether or not this is bailout line.
.Sp
.Vb 1
\& Bail out! We\*(Aqre out of dilithium crystals.
.Ve
.IP \(bu 4
\&\f(CW\*(C`is_version\*(C'\fR
.Sp
Indicates whether or not this is a TAP version line.
.Sp
.Vb 1
\& TAP version 4
.Ve
.IP \(bu 4
\&\f(CW\*(C`is_unknown\*(C'\fR
.Sp
Indicates whether or not the current line could be parsed.
.Sp
.Vb 1
\& ... this line is junk ...
.Ve
.IP \(bu 4
\&\f(CW\*(C`is_yaml\*(C'\fR
.Sp
Indicates whether or not this is a YAML chunk.
.PP
\fR\f(CI\*(C`raw\*(C'\fR\fI\fR
.IX Subsection "raw"
.PP
.Vb 1
\&  print $result\->raw;
.Ve
.PP
Returns the original line of text which was parsed.
.PP
\fR\f(CI\*(C`type\*(C'\fR\fI\fR
.IX Subsection "type"
.PP
.Vb 1
\&  my $type = $result\->type;
.Ve
.PP
Returns the "type" of a token, such as \f(CW\*(C`comment\*(C'\fR or \f(CW\*(C`test\*(C'\fR.
.PP
\fR\f(CI\*(C`as_string\*(C'\fR\fI\fR
.IX Subsection "as_string"
.PP
.Vb 1
\&  print $result\->as_string;
.Ve
.PP
Prints a string representation of the token.  This might not be the exact
output, however.  Tests will have test numbers added if not present, TODO and
SKIP directives will be capitalized and, in general, things will be cleaned
up.  If you need the original text for the token, see the \f(CW\*(C`raw\*(C'\fR method.
.PP
\fR\f(CI\*(C`is_ok\*(C'\fR\fI\fR
.IX Subsection "is_ok"
.PP
.Vb 1
\&  if ( $result\->is_ok ) { ... }
.Ve
.PP
Reports whether or not a given result has passed.  Anything which is \fBnot\fR a
test result returns true.  This is merely provided as a convenient shortcut.
.PP
\fR\f(CI\*(C`passed\*(C'\fR\fI\fR
.IX Subsection "passed"
.PP
Deprecated.  Please use \f(CW\*(C`is_ok\*(C'\fR instead.
.PP
\fR\f(CI\*(C`has_directive\*(C'\fR\fI\fR
.IX Subsection "has_directive"
.PP
.Vb 3
\&  if ( $result\->has_directive ) {
\&     ...
\&  }
.Ve
.PP
Indicates whether or not the given result has a TODO or SKIP directive.
.PP
\fR\f(CI\*(C`has_todo\*(C'\fR\fI\fR
.IX Subsection "has_todo"
.PP
.Vb 3
\& if ( $result\->has_todo ) {
\&     ...
\& }
.Ve
.PP
Indicates whether or not the given result has a TODO directive.
.PP
\fR\f(CI\*(C`has_skip\*(C'\fR\fI\fR
.IX Subsection "has_skip"
.PP
.Vb 3
\& if ( $result\->has_skip ) {
\&     ...
\& }
.Ve
.PP
Indicates whether or not the given result has a SKIP directive.
.PP
\fR\f(CI\*(C`set_directive\*(C'\fR\fI\fR
.IX Subsection "set_directive"
.PP
Set the directive associated with this token. Used internally to fake
TODO tests.
.SH SUBCLASSING
.IX Header "SUBCLASSING"
Please see "SUBCLASSING" in TAP::Parser for a subclassing overview.
.PP
Remember: if you want your subclass to be automatically used by the parser,
you'll have to register it with "register_type" in TAP::Parser::ResultFactory.
.PP
If you're creating a completely new result \fItype\fR, you'll probably need to
subclass TAP::Parser::Grammar too, or else it'll never get used.
.SS Example
.IX Subsection "Example"
.Vb 1
\&  package MyResult;
\&
\&  use strict;
\&
\&  use base \*(AqTAP::Parser::Result\*(Aq;
\&
\&  # register with the factory:
\&  TAP::Parser::ResultFactory\->register_type( \*(Aqmy_type\*(Aq => _\|_PACKAGE_\|_ );
\&
\&  sub as_string { \*(AqMy results all look the same\*(Aq }
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
TAP::Object,
TAP::Parser,
TAP::Parser::ResultFactory,
TAP::Parser::Result::Bailout,
TAP::Parser::Result::Comment,
TAP::Parser::Result::Plan,
TAP::Parser::Result::Pragma,
TAP::Parser::Result::Test,
TAP::Parser::Result::Unknown,
TAP::Parser::Result::Version,
TAP::Parser::Result::YAML,