Debian Codegraph @

upstream/mageia-cauldron/man3pm/TAP::Parser::SourceHandler::Handle.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::Handle 3pm"
61 .TH TAP::Parser::SourceHandler::Handle 3pm 2025-06-24 "perl v5.42.0" "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::Handle \- Stream TAP from an IO::Handle or a GLOB.
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::Executable;
76 \&
77 \& my $source = TAP::Parser::Source\->new\->raw( \e*TAP_FILE );
78 \& $source\->assemble_meta;
79 \&
80 \& my $class = \*(AqTAP::Parser::SourceHandler::Handle\*(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 an IO Handle\fR TAP::Parser::SourceHandler class. It
87 has 2 jobs:
88 .PP
89 1. Figure out if the TAP::Parser::Source it\*(Aqs given is an IO::Handle or
90 GLOB containing raw TAP output ("can_handle").
91 .PP
92 2. Creates an iterator for IO::Handle\*(Aqs & globs ("make_iterator").
93 .PP
94 Unless you\*(Aqre writing a plugin or subclassing TAP::Parser, you probably
95 won\*(Aqt need to use this module directly.
96 .SH METHODS
97 .IX Header "METHODS"
98 .SS "Class Methods"
99 .IX Subsection "Class Methods"
100 \fR\f(CI\*(C`can_handle\*(C'\fR\fI\fR
101 .IX Subsection "can_handle"
102 .PP
103 .Vb 1
104 \& my $vote = $class\->can_handle( $source );
105 .Ve
106 .PP
107 Casts the following votes:
108 .PP
109 .Vb 2
110 \& 0.9 if $source is an IO::Handle
111 \& 0.8 if $source is a glob
112 .Ve
113 .PP
114 \fR\f(CI\*(C`make_iterator\*(C'\fR\fI\fR
115 .IX Subsection "make_iterator"
116 .PP
117 .Vb 1
118 \& my $iterator = $class\->make_iterator( $source );
119 .Ve
120 .PP
121 Returns a new TAP::Parser::Iterator::Stream for the source.
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 SUBCLASSING
129 .IX Header "SUBCLASSING"
130 Please see "SUBCLASSING" in TAP::Parser for a subclassing overview.
131 .SH "SEE ALSO"
132 .IX Header "SEE ALSO"
133 TAP::Object,
134 TAP::Parser,
135 TAP::Parser::Iterator,
136 TAP::Parser::Iterator::Stream,
137 TAP::Parser::IteratorFactory,
138 TAP::Parser::SourceHandler,
139 TAP::Parser::SourceHandler::Executable,
140 TAP::Parser::SourceHandler::Perl,
141 TAP::Parser::SourceHandler::File,
142 TAP::Parser::SourceHandler::RawTAP