D7net
Home
Console
Upload
information
Create File
Create Folder
About
Tools
:
/
opt
/
lampp
/
share
/
man
/
man3
/
Filename :
TAP::Parser::SourceHandler::File.3
back
Copy
.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.20) .\" .\" 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 .. .\} .\" .\" 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::SourceHandler::File 3" .TH TAP::Parser::SourceHandler::File 3 "2013-03-04" "perl v5.16.3" "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::SourceHandler::File \- Stream TAP from a text file. .SH "VERSION" .IX Header "VERSION" Version 3.23 .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