Current Path : /proc/2/root/usr/share/man/man3/ |
|
Current File : //proc/2/root/usr/share/man/man3/TAP::Parser::SourceHandler::File.3pm |
.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.13)
.\"
.\" 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" ''
'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.
.ie \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. nr % 0
. rr F
.\}
.el \{\
. de IX
..
.\}
.\" ========================================================================
.\"
.IX Title "TAP::Parser::SourceHandler::File 3"
.TH TAP::Parser::SourceHandler::File 3 "2018-03-19" "perl v5.10.1" "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::SourceHandler::File \- Stream TAP from a text file.
.SH "VERSION"
.IX Header "VERSION"
Version 3.42
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\& use TAP::Parser::Source;
\& use TAP::Parser::SourceHandler::File;
\&
\& my $source = TAP::Parser::Source\->new\->raw( \e\*(Aqfile.tap\*(Aq );
\& $source\->assemble_meta;
\&
\& my $class = \*(AqTAP::Parser::SourceHandler::File\*(Aq;
\& my $vote = $class\->can_handle( $source );
\& my $iter = $class\->make_iterator( $source );
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This is a \fIraw \s-1TAP\s0 stored in a file\fR TAP::Parser::SourceHandler \- it has 2 jobs:
.PP
1. Figure out if the \fIraw\fR source it's given is a file containing raw \s-1TAP\s0
output. See TAP::Parser::IteratorFactory for more details.
.PP
2. Takes raw \s-1TAP\s0 from the text file given, and converts into an iterator.
.PP
Unless you're writing a plugin or subclassing TAP::Parser, you probably
won't need to use this module directly.
.SH "METHODS"
.IX Header "METHODS"
.SS "Class Methods"
.IX Subsection "Class Methods"
\fI\f(CI\*(C`can_handle\*(C'\fI\fR
.IX Subsection "can_handle"
.PP
.Vb 1
\& my $vote = $class\->can_handle( $source );
.Ve
.PP
Only votes if \f(CW$source\fR looks like a regular file. Casts the following votes:
.PP
.Vb 2
\& 0.9 if it\*(Aqs a .tap file
\& 0.9 if it has an extension matching any given in user config.
.Ve
.PP
\fI\f(CI\*(C`make_iterator\*(C'\fI\fR
.IX Subsection "make_iterator"
.PP
.Vb 1
\& my $iterator = $class\->make_iterator( $source );
.Ve
.PP
Returns a new TAP::Parser::Iterator::Stream for the source. \f(CW\*(C`croak\*(C'\fRs
on error.
.PP
\fI\f(CI\*(C`iterator_class\*(C'\fI\fR
.IX Subsection "iterator_class"
.PP
The class of iterator to use, override if you're sub-classing. Defaults
to TAP::Parser::Iterator::Stream.
.SH "CONFIGURATION"
.IX Header "CONFIGURATION"
.Vb 3
\& {
\& extensions => [ @case_insensitive_exts_to_match ]
\& }
.Ve
.SH "SUBCLASSING"
.IX Header "SUBCLASSING"
Please see \*(L"\s-1SUBCLASSING\s0\*(R" in TAP::Parser for a subclassing overview.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
TAP::Object,
TAP::Parser,
TAP::Parser::SourceHandler,
TAP::Parser::SourceHandler::Executable,
TAP::Parser::SourceHandler::Perl,
TAP::Parser::SourceHandler::Handle,
TAP::Parser::SourceHandler::RawTAP
Copyright 2K16 - 2K18 Indonesian Hacker Rulez