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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
|
.\" -*- 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::ResultFactory 3perl"
.TH TAP::Parser::ResultFactory 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::ResultFactory \- Factory for creating TAP::Parser output objects
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 4
\& use TAP::Parser::ResultFactory;
\& my $token = {...};
\& my $factory = TAP::Parser::ResultFactory\->new;
\& my $result = $factory\->make_result( $token );
.Ve
.SH VERSION
.IX Header "VERSION"
Version 3.44
.SS DESCRIPTION
.IX Subsection "DESCRIPTION"
This is a simple factory class which returns a TAP::Parser::Result subclass
representing the current bit of test data from TAP (usually a single line).
It is used primarily by TAP::Parser::Grammar. Unless you're subclassing,
you probably won't need to use this module directly.
.SS METHODS
.IX Subsection "METHODS"
.SS "Class Methods"
.IX Subsection "Class Methods"
\fR\f(CI\*(C`new\*(C'\fR\fI\fR
.IX Subsection "new"
.PP
Creates a new factory class.
\&\fINote:\fR You currently don't need to instantiate a factory in order to use it.
.PP
\fR\f(CI\*(C`make_result\*(C'\fR\fI\fR
.IX Subsection "make_result"
.PP
Returns an instance the appropriate class for the test token passed in.
.PP
.Vb 1
\& my $result = TAP::Parser::ResultFactory\->make_result($token);
.Ve
.PP
Can also be called as an instance method.
.PP
\fR\f(CI\*(C`class_for\*(C'\fR\fI\fR
.IX Subsection "class_for"
.PP
Takes one argument: \f(CW$type\fR. Returns the class for this \f(CW$type\fR, or \f(CW\*(C`croak\*(C'\fRs
with an error.
.PP
\fR\f(CI\*(C`register_type\*(C'\fR\fI\fR
.IX Subsection "register_type"
.PP
Takes two arguments: \f(CW$type\fR, \f(CW$class\fR
.PP
This lets you override an existing type with your own custom type, or register
a completely new type, eg:
.PP
.Vb 4
\& # create a custom result type:
\& package MyResult;
\& use strict;
\& use base \*(AqTAP::Parser::Result\*(Aq;
\&
\& # register with the factory:
\& TAP::Parser::ResultFactory\->register_type( \*(Aqmy_type\*(Aq => _\|_PACKAGE_\|_ );
\&
\& # use it:
\& my $r = TAP::Parser::ResultFactory\->( { type => \*(Aqmy_type\*(Aq } );
.Ve
.PP
Your custom type should then be picked up automatically by the TAP::Parser.
.SH SUBCLASSING
.IX Header "SUBCLASSING"
Please see "SUBCLASSING" in TAP::Parser for a subclassing overview.
.PP
There are a few things to bear in mind when creating your own
\&\f(CW\*(C`ResultFactory\*(C'\fR:
.IP 1. 4
The factory itself is never instantiated (this \fImay\fR change in the future).
This means that \f(CW\*(C`_initialize\*(C'\fR is never called.
.IP 2. 4
\&\f(CW\*(C`TAP::Parser::Result\->new\*(C'\fR is never called, \f(CW$tokens\fR are reblessed.
This \fIwill\fR change in a future version!
.IP 3. 4
TAP::Parser::Result subclasses will register themselves with
TAP::Parser::ResultFactory directly:
.Sp
.Vb 2
\& package MyFooResult;
\& TAP::Parser::ResultFactory\->register_type( foo => _\|_PACKAGE_\|_ );
.Ve
.Sp
Of course, it's up to you to decide whether or not to ignore them.
.SS Example
.IX Subsection "Example"
.Vb 1
\& package MyResultFactory;
\&
\& use strict;
\&
\& use MyResult;
\&
\& use base \*(AqTAP::Parser::ResultFactory\*(Aq;
\&
\& # force all results to be \*(AqMyResult\*(Aq
\& sub class_for {
\& return \*(AqMyResult\*(Aq;
\& }
\&
\& 1;
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
TAP::Parser,
TAP::Parser::Result,
TAP::Parser::Grammar
|
