Debian Codegraph @

upstream/debian-unstable/man3/TAP::Parser::SourceHandler::Handle.3perl

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