File Manager

Editing File: /usr/local/share/man/man3/TAP::Parser::ResultFactory.3pm

.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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 turned on, 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
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "TAP::Parser::ResultFactory 3"
.TH TAP::Parser::ResultFactory 3 "2018-03-19" "perl v5.16.3" "User Contributed Perl Documentation"
.\" 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.42
.SS "\s-1DESCRIPTION\s0"
.IX Subsection "DESCRIPTION"
This is a simple factory class which returns a TAP::Parser::Result subclass
representing the current bit of test data from \s-1TAP \s0(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 "\s-1METHODS\s0"
.IX Subsection "METHODS"
.SS "Class Methods"
.IX Subsection "Class Methods"
\fI\f(CI\*(C`new\*(C'\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
\fI\f(CI\*(C`make_result\*(C'\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
\fI\f(CI\*(C`class_for\*(C'\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
\fI\f(CI\*(C`register_type\*(C'\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 \*(L"\s-1SUBCLASSING\*(R"\s0 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

Back to Directory File Manager