1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
|
.\" -*- 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::Plan 3pm"
.TH TAP::Parser::Result::Plan 3pm 2023-11-28 "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::Plan \- Plan result token.
.SH VERSION
.IX Header "VERSION"
Version 3.44
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This is a subclass of TAP::Parser::Result. A token of this class will be
returned if a plan line is encountered.
.PP
.Vb 2
\& 1..1
\& ok 1 \- woo hooo!
.Ve
.PP
\&\f(CW1..1\fR is the plan. Gotta have a plan.
.SH "OVERRIDDEN METHODS"
.IX Header "OVERRIDDEN METHODS"
Mainly listed here to shut up the pitiful screams of the pod coverage tests.
They keep me awake at night.
.IP \(bu 4
\&\f(CW\*(C`as_string\*(C'\fR
.IP \(bu 4
\&\f(CW\*(C`raw\*(C'\fR
.SS "Instance Methods"
.IX Subsection "Instance Methods"
\fR\f(CI\*(C`plan\*(C'\fR\fI\fR
.IX Subsection "plan"
.PP
.Vb 3
\& if ( $result\->is_plan ) {
\& print $result\->plan;
\& }
.Ve
.PP
This is merely a synonym for \f(CW\*(C`as_string\*(C'\fR.
.PP
\fR\f(CI\*(C`tests_planned\*(C'\fR\fI\fR
.IX Subsection "tests_planned"
.PP
.Vb 1
\& my $planned = $result\->tests_planned;
.Ve
.PP
Returns the number of tests planned. For example, a plan of \f(CW1..17\fR will
cause this method to return '17'.
.PP
\fR\f(CI\*(C`directive\*(C'\fR\fI\fR
.IX Subsection "directive"
.PP
.Vb 1
\& my $directive = $plan\->directive;
.Ve
.PP
If a SKIP directive is included with the plan, this method will return it.
.PP
.Vb 1
\& 1..0 # SKIP: why bother?
.Ve
.PP
\fR\f(CI\*(C`has_skip\*(C'\fR\fI\fR
.IX Subsection "has_skip"
.PP
.Vb 1
\& if ( $result\->has_skip ) { ... }
.Ve
.PP
Returns a boolean value indicating whether or not this test has a SKIP
directive.
.PP
\fR\f(CI\*(C`explanation\*(C'\fR\fI\fR
.IX Subsection "explanation"
.PP
.Vb 1
\& my $explanation = $plan\->explanation;
.Ve
.PP
If a SKIP directive was included with the plan, this method will return the
explanation, if any.
.PP
\fR\f(CI\*(C`todo_list\*(C'\fR\fI\fR
.IX Subsection "todo_list"
.PP
.Vb 4
\& my $todo = $result\->todo_list;
\& for ( @$todo ) {
\& ...
\& }
.Ve
|
