| 1 |
.\" -*- mode: troff; coding: utf-8 -*- |
| 2 |
.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45) |
| 3 |
.\" |
| 4 |
.\" Standard preamble: |
| 5 |
.\" ======================================================================== |
| 6 |
.de Sp \" Vertical space (when we can't use .PP) |
| 7 |
.if t .sp .5v |
| 8 |
.if n .sp |
| 9 |
.. |
| 10 |
.de Vb \" Begin verbatim text |
| 11 |
.ft CW |
| 12 |
.nf |
| 13 |
.ne \\$1 |
| 14 |
.. |
| 15 |
.de Ve \" End verbatim text |
| 16 |
.ft R |
| 17 |
.fi |
| 18 |
.. |
| 19 |
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. |
| 20 |
.ie n \{\ |
| 21 |
. ds C` "" |
| 22 |
. ds C' "" |
| 23 |
'br\} |
| 24 |
.el\{\ |
| 25 |
. ds C` |
| 26 |
. ds C' |
| 27 |
'br\} |
| 28 |
.\" |
| 29 |
.\" Escape single quotes in literal strings from groff's Unicode transform. |
| 30 |
.ie \n(.g .ds Aq \(aq |
| 31 |
.el .ds Aq ' |
| 32 |
.\" |
| 33 |
.\" If the F register is >0, we'll generate index entries on stderr for |
| 34 |
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index |
| 35 |
.\" entries marked with X<> in POD. Of course, you'll have to process the |
| 36 |
.\" output yourself in some meaningful fashion. |
| 37 |
.\" |
| 38 |
.\" Avoid warning from groff about undefined register 'F'. |
| 39 |
.de IX |
| 40 |
.. |
| 41 |
.nr rF 0 |
| 42 |
.if \n(.g .if rF .nr rF 1 |
| 43 |
.if (\n(rF:(\n(.g==0)) \{\ |
| 44 |
. if \nF \{\ |
| 45 |
. de IX |
| 46 |
. tm Index:\\$1\t\\n%\t"\\$2" |
| 47 |
.. |
| 48 |
. if !\nF==2 \{\ |
| 49 |
. nr % 0 |
| 50 |
. nr F 2 |
| 51 |
. \} |
| 52 |
. \} |
| 53 |
.\} |
| 54 |
.rr rF |
| 55 |
.\" ======================================================================== |
| 56 |
.\" |
| 57 |
.IX Title "TAP::Parser::SourceHandler::File 3perl" |
| 58 |
.TH TAP::Parser::SourceHandler::File 3perl 2025-11-16 "perl v5.40.1" "Perl Programmers Reference Guide" |
| 59 |
.\" For nroff, turn off justification. Always turn off hyphenation; it makes |
| 60 |
.\" way too many mistakes in technical documents. |
| 61 |
.if n .ad l |
| 62 |
.nh |
| 63 |
.SH NAME |
| 64 |
TAP::Parser::SourceHandler::File \- Stream TAP from a text file. |
| 65 |
.SH VERSION |
| 66 |
.IX Header "VERSION" |
| 67 |
Version 3.48 |
| 68 |
.SH SYNOPSIS |
| 69 |
.IX Header "SYNOPSIS" |
| 70 |
.Vb 2 |
| 71 |
\& use TAP::Parser::Source; |
| 72 |
\& use TAP::Parser::SourceHandler::File; |
| 73 |
\& |
| 74 |
\& my $source = TAP::Parser::Source\->new\->raw( \e\*(Aqfile.tap\*(Aq ); |
| 75 |
\& $source\->assemble_meta; |
| 76 |
\& |
| 77 |
\& my $class = \*(AqTAP::Parser::SourceHandler::File\*(Aq; |
| 78 |
\& my $vote = $class\->can_handle( $source ); |
| 79 |
\& my $iter = $class\->make_iterator( $source ); |
| 80 |
.Ve |
| 81 |
.SH DESCRIPTION |
| 82 |
.IX Header "DESCRIPTION" |
| 83 |
This is a \fIraw TAP stored in a file\fR TAP::Parser::SourceHandler \- it has 2 jobs: |
| 84 |
.PP |
| 85 |
1. Figure out if the \fIraw\fR source it's given is a file containing raw TAP |
| 86 |
output. See TAP::Parser::IteratorFactory for more details. |
| 87 |
.PP |
| 88 |
2. Takes raw TAP from the text file given, and converts into an iterator. |
| 89 |
.PP |
| 90 |
Unless you're writing a plugin or subclassing TAP::Parser, you probably |
| 91 |
won't need to use this module directly. |
| 92 |
.SH METHODS |
| 93 |
.IX Header "METHODS" |
| 94 |
.SS "Class Methods" |
| 95 |
.IX Subsection "Class Methods" |
| 96 |
\fR\f(CI\*(C`can_handle\*(C'\fR\fI\fR |
| 97 |
.IX Subsection "can_handle" |
| 98 |
.PP |
| 99 |
.Vb 1 |
| 100 |
\& my $vote = $class\->can_handle( $source ); |
| 101 |
.Ve |
| 102 |
.PP |
| 103 |
Only votes if \f(CW$source\fR looks like a regular file. Casts the following votes: |
| 104 |
.PP |
| 105 |
.Vb 2 |
| 106 |
\& 0.9 if it\*(Aqs a .tap file |
| 107 |
\& 0.9 if it has an extension matching any given in user config. |
| 108 |
.Ve |
| 109 |
.PP |
| 110 |
\fR\f(CI\*(C`make_iterator\*(C'\fR\fI\fR |
| 111 |
.IX Subsection "make_iterator" |
| 112 |
.PP |
| 113 |
.Vb 1 |
| 114 |
\& my $iterator = $class\->make_iterator( $source ); |
| 115 |
.Ve |
| 116 |
.PP |
| 117 |
Returns a new TAP::Parser::Iterator::Stream for the source. \f(CW\*(C`croak\*(C'\fRs |
| 118 |
on error. |
| 119 |
.PP |
| 120 |
\fR\f(CI\*(C`iterator_class\*(C'\fR\fI\fR |
| 121 |
.IX Subsection "iterator_class" |
| 122 |
.PP |
| 123 |
The class of iterator to use, override if you're sub-classing. Defaults |
| 124 |
to TAP::Parser::Iterator::Stream. |
| 125 |
.SH CONFIGURATION |
| 126 |
.IX Header "CONFIGURATION" |
| 127 |
.Vb 3 |
| 128 |
\& { |
| 129 |
\& extensions => [ @case_insensitive_exts_to_match ] |
| 130 |
\& } |
| 131 |
.Ve |
| 132 |
.SH SUBCLASSING |
| 133 |
.IX Header "SUBCLASSING" |
| 134 |
Please see "SUBCLASSING" in TAP::Parser for a subclassing overview. |
| 135 |
.SH "SEE ALSO" |
| 136 |
.IX Header "SEE ALSO" |
| 137 |
TAP::Object, |
| 138 |
TAP::Parser, |
| 139 |
TAP::Parser::SourceHandler, |
| 140 |
TAP::Parser::SourceHandler::Executable, |
| 141 |
TAP::Parser::SourceHandler::Perl, |
| 142 |
TAP::Parser::SourceHandler::Handle, |
| 143 |
TAP::Parser::SourceHandler::RawTAP |