Debian Codegraph @

upstream/opensuse-tumbleweed/man3/TAP::Parser::SourceHandler::File.3pm

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man v6.0.2 (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 .\" Required to disable full justification in groff 1.23.0.
57 .if n .ds AD l
58 .\" ========================================================================
59 .\"
60 .IX Title "TAP::Parser::SourceHandler::File 3pm"
61 .TH TAP::Parser::SourceHandler::File 3pm 2026-03-09 "perl v5.42.1" "Perl Programmers Reference Guide"
62 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
63 .\" way too many mistakes in technical documents.
64 .if n .ad l
65 .nh
66 .SH NAME
67 TAP::Parser::SourceHandler::File \- Stream TAP from a text file.
68 .SH VERSION
69 .IX Header "VERSION"
70 Version 3.50
71 .SH SYNOPSIS
72 .IX Header "SYNOPSIS"
73 .Vb 2
74 \& use TAP::Parser::Source;
75 \& use TAP::Parser::SourceHandler::File;
76 \&
77 \& my $source = TAP::Parser::Source\->new\->raw( \e\*(Aqfile.tap\*(Aq );
78 \& $source\->assemble_meta;
79 \&
80 \& my $class = \*(AqTAP::Parser::SourceHandler::File\*(Aq;
81 \& my $vote = $class\->can_handle( $source );
82 \& my $iter = $class\->make_iterator( $source );
83 .Ve
84 .SH DESCRIPTION
85 .IX Header "DESCRIPTION"
86 This is a \fIraw TAP stored in a file\fR TAP::Parser::SourceHandler \- it has 2 jobs:
87 .PP
88 1. Figure out if the \fIraw\fR source it\*(Aqs given is a file containing raw TAP
89 output. See TAP::Parser::IteratorFactory for more details.
90 .PP
91 2. Takes raw TAP from the text file given, and converts into an iterator.
92 .PP
93 Unless you\*(Aqre writing a plugin or subclassing TAP::Parser, you probably
94 won\*(Aqt need to use this module directly.
95 .SH METHODS
96 .IX Header "METHODS"
97 .SS "Class Methods"
98 .IX Subsection "Class Methods"
99 \fR\f(CI\*(C`can_handle\*(C'\fR\fI\fR
100 .IX Subsection "can_handle"
101 .PP
102 .Vb 1
103 \& my $vote = $class\->can_handle( $source );
104 .Ve
105 .PP
106 Only votes if \f(CW$source\fR looks like a regular file. Casts the following votes:
107 .PP
108 .Vb 2
109 \& 0.9 if it\*(Aqs a .tap file
110 \& 0.9 if it has an extension matching any given in user config.
111 .Ve
112 .PP
113 \fR\f(CI\*(C`make_iterator\*(C'\fR\fI\fR
114 .IX Subsection "make_iterator"
115 .PP
116 .Vb 1
117 \& my $iterator = $class\->make_iterator( $source );
118 .Ve
119 .PP
120 Returns a new TAP::Parser::Iterator::Stream for the source. \f(CW\*(C`croak\*(C'\fRs
121 on error.
122 .PP
123 \fR\f(CI\*(C`iterator_class\*(C'\fR\fI\fR
124 .IX Subsection "iterator_class"
125 .PP
126 The class of iterator to use, override if you\*(Aqre sub\-classing. Defaults
127 to TAP::Parser::Iterator::Stream.
128 .SH CONFIGURATION
129 .IX Header "CONFIGURATION"
130 .Vb 3
131 \& {
132 \& extensions => [ @case_insensitive_exts_to_match ]
133 \& }
134 .Ve
135 .SH SUBCLASSING
136 .IX Header "SUBCLASSING"
137 Please see "SUBCLASSING" in TAP::Parser for a subclassing overview.
138 .SH "SEE ALSO"
139 .IX Header "SEE ALSO"
140 TAP::Object,
141 TAP::Parser,
142 TAP::Parser::SourceHandler,
143 TAP::Parser::SourceHandler::Executable,
144 TAP::Parser::SourceHandler::Perl,
145 TAP::Parser::SourceHandler::Handle,
146 TAP::Parser::SourceHandler::RawTAP