<html><head><meta name="color-scheme" content="light dark"></head><body><pre style="word-wrap: break-word; white-space: pre-wrap;">package TAP::Parser::Result::Plan;

use strict;
use warnings;

use base 'TAP::Parser::Result';

=head1 NAME

TAP::Parser::Result::Plan - Plan result token.

=head1 VERSION

Version 3.50

=cut

our $VERSION = '3.50';

=head1 DESCRIPTION

This is a subclass of L&lt;TAP::Parser::Result&gt;.  A token of this class will be
returned if a plan line is encountered.

 1..1
 ok 1 - woo hooo!

C&lt;1..1&gt; is the plan.  Gotta have a plan.

=head1 OVERRIDDEN METHODS

Mainly listed here to shut up the pitiful screams of the pod coverage tests.
They keep me awake at night.

=over 4

=item * C&lt;as_string&gt;

=item * C&lt;raw&gt;

=back

=cut

##############################################################################

=head2 Instance Methods

=head3 C&lt;plan&gt; 

  if ( $result-&gt;is_plan ) {
     print $result-&gt;plan;
  }

This is merely a synonym for C&lt;as_string&gt;.

=cut

sub plan { '1..' . shift-&gt;{tests_planned} }

##############################################################################

=head3 C&lt;tests_planned&gt;

  my $planned = $result-&gt;tests_planned;

Returns the number of tests planned.  For example, a plan of C&lt;1..17&gt; will
cause this method to return '17'.

=cut

sub tests_planned { shift-&gt;{tests_planned} }

##############################################################################

=head3 C&lt;directive&gt;

 my $directive = $plan-&gt;directive; 

If a SKIP directive is included with the plan, this method will return it.

 1..0 # SKIP: why bother?

=cut

sub directive { shift-&gt;{directive} }

##############################################################################

=head3 C&lt;has_skip&gt;

  if ( $result-&gt;has_skip ) { ... }

Returns a boolean value indicating whether or not this test has a SKIP
directive.

=head3 C&lt;explanation&gt;

 my $explanation = $plan-&gt;explanation;

If a SKIP directive was included with the plan, this method will return the
explanation, if any.

=cut

sub explanation { shift-&gt;{explanation} }

=head3 C&lt;todo_list&gt;

  my $todo = $result-&gt;todo_list;
  for ( @$todo ) {
      ...
  }

=cut

sub todo_list { shift-&gt;{todo_list} }

1;
</pre></body></html>