| 1 |
.\" -*- mode: troff; coding: utf-8 -*- |
| 2 |
.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45) |
| 3 |
.\" |
| 4 |
.\" Standard preamble: |
| 5 |
.\" ======================================================================== |
| 6 |
.de Sp \" Vertical space (when we can't use .PP) |
| 7 |
.if t .sp .5v |
| 8 |
.if n .sp |
| 9 |
.. |
| 10 |
.de Vb \" Begin verbatim text |
| 11 |
.ft CW |
| 12 |
.nf |
| 13 |
.ne \\$1 |
| 14 |
.. |
| 15 |
.de Ve \" End verbatim text |
| 16 |
.ft R |
| 17 |
.fi |
| 18 |
.. |
| 19 |
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. |
| 20 |
.ie n \{\ |
| 21 |
. ds C` "" |
| 22 |
. ds C' "" |
| 23 |
'br\} |
| 24 |
.el\{\ |
| 25 |
. ds C` |
| 26 |
. ds C' |
| 27 |
'br\} |
| 28 |
.\" |
| 29 |
.\" Escape single quotes in literal strings from groff's Unicode transform. |
| 30 |
.ie \n(.g .ds Aq \(aq |
| 31 |
.el .ds Aq ' |
| 32 |
.\" |
| 33 |
.\" If the F register is >0, we'll generate index entries on stderr for |
| 34 |
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index |
| 35 |
.\" entries marked with X<> in POD. Of course, you'll have to process the |
| 36 |
.\" output yourself in some meaningful fashion. |
| 37 |
.\" |
| 38 |
.\" Avoid warning from groff about undefined register 'F'. |
| 39 |
.de IX |
| 40 |
.. |
| 41 |
.nr rF 0 |
| 42 |
.if \n(.g .if rF .nr rF 1 |
| 43 |
.if (\n(rF:(\n(.g==0)) \{\ |
| 44 |
. if \nF \{\ |
| 45 |
. de IX |
| 46 |
. tm Index:\\$1\t\\n%\t"\\$2" |
| 47 |
.. |
| 48 |
. if !\nF==2 \{\ |
| 49 |
. nr % 0 |
| 50 |
. nr F 2 |
| 51 |
. \} |
| 52 |
. \} |
| 53 |
.\} |
| 54 |
.rr rF |
| 55 |
.\" ======================================================================== |
| 56 |
.\" |
| 57 |
.IX Title "TAP::Parser::Result::Plan 3perl" |
| 58 |
.TH TAP::Parser::Result::Plan 3perl 2025-11-16 "perl v5.40.1" "Perl Programmers Reference Guide" |
| 59 |
.\" For nroff, turn off justification. Always turn off hyphenation; it makes |
| 60 |
.\" way too many mistakes in technical documents. |
| 61 |
.if n .ad l |
| 62 |
.nh |
| 63 |
.SH NAME |
| 64 |
TAP::Parser::Result::Plan \- Plan result token. |
| 65 |
.SH VERSION |
| 66 |
.IX Header "VERSION" |
| 67 |
Version 3.48 |
| 68 |
.SH DESCRIPTION |
| 69 |
.IX Header "DESCRIPTION" |
| 70 |
This is a subclass of TAP::Parser::Result. A token of this class will be |
| 71 |
returned if a plan line is encountered. |
| 72 |
.PP |
| 73 |
.Vb 2 |
| 74 |
\& 1..1 |
| 75 |
\& ok 1 \- woo hooo! |
| 76 |
.Ve |
| 77 |
.PP |
| 78 |
\&\f(CW1..1\fR is the plan. Gotta have a plan. |
| 79 |
.SH "OVERRIDDEN METHODS" |
| 80 |
.IX Header "OVERRIDDEN METHODS" |
| 81 |
Mainly listed here to shut up the pitiful screams of the pod coverage tests. |
| 82 |
They keep me awake at night. |
| 83 |
.IP \(bu 4 |
| 84 |
\&\f(CW\*(C`as_string\*(C'\fR |
| 85 |
.IP \(bu 4 |
| 86 |
\&\f(CW\*(C`raw\*(C'\fR |
| 87 |
.SS "Instance Methods" |
| 88 |
.IX Subsection "Instance Methods" |
| 89 |
\fR\f(CI\*(C`plan\*(C'\fR\fI\fR |
| 90 |
.IX Subsection "plan" |
| 91 |
.PP |
| 92 |
.Vb 3 |
| 93 |
\& if ( $result\->is_plan ) { |
| 94 |
\& print $result\->plan; |
| 95 |
\& } |
| 96 |
.Ve |
| 97 |
.PP |
| 98 |
This is merely a synonym for \f(CW\*(C`as_string\*(C'\fR. |
| 99 |
.PP |
| 100 |
\fR\f(CI\*(C`tests_planned\*(C'\fR\fI\fR |
| 101 |
.IX Subsection "tests_planned" |
| 102 |
.PP |
| 103 |
.Vb 1 |
| 104 |
\& my $planned = $result\->tests_planned; |
| 105 |
.Ve |
| 106 |
.PP |
| 107 |
Returns the number of tests planned. For example, a plan of \f(CW1..17\fR will |
| 108 |
cause this method to return '17'. |
| 109 |
.PP |
| 110 |
\fR\f(CI\*(C`directive\*(C'\fR\fI\fR |
| 111 |
.IX Subsection "directive" |
| 112 |
.PP |
| 113 |
.Vb 1 |
| 114 |
\& my $directive = $plan\->directive; |
| 115 |
.Ve |
| 116 |
.PP |
| 117 |
If a SKIP directive is included with the plan, this method will return it. |
| 118 |
.PP |
| 119 |
.Vb 1 |
| 120 |
\& 1..0 # SKIP: why bother? |
| 121 |
.Ve |
| 122 |
.PP |
| 123 |
\fR\f(CI\*(C`has_skip\*(C'\fR\fI\fR |
| 124 |
.IX Subsection "has_skip" |
| 125 |
.PP |
| 126 |
.Vb 1 |
| 127 |
\& if ( $result\->has_skip ) { ... } |
| 128 |
.Ve |
| 129 |
.PP |
| 130 |
Returns a boolean value indicating whether or not this test has a SKIP |
| 131 |
directive. |
| 132 |
.PP |
| 133 |
\fR\f(CI\*(C`explanation\*(C'\fR\fI\fR |
| 134 |
.IX Subsection "explanation" |
| 135 |
.PP |
| 136 |
.Vb 1 |
| 137 |
\& my $explanation = $plan\->explanation; |
| 138 |
.Ve |
| 139 |
.PP |
| 140 |
If a SKIP directive was included with the plan, this method will return the |
| 141 |
explanation, if any. |
| 142 |
.PP |
| 143 |
\fR\f(CI\*(C`todo_list\*(C'\fR\fI\fR |
| 144 |
.IX Subsection "todo_list" |
| 145 |
.PP |
| 146 |
.Vb 4 |
| 147 |
\& my $todo = $result\->todo_list; |
| 148 |
\& for ( @$todo ) { |
| 149 |
\& ... |
| 150 |
\& } |
| 151 |
.Ve |