Debian Codegraph @

upstream/debian-unstable/man3/TAP::Parser::SourceHandler::RawTAP.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::RawTAP 3perl"
58 .TH TAP::Parser::SourceHandler::RawTAP 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::RawTAP \- Stream output from raw TAP in a scalar/array ref.
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::RawTAP;
73 \&
74 \& my $source = TAP::Parser::Source\->new\->raw( \e"1..1\enok 1\en" );
75 \& $source\->assemble_meta;
76 \&
77 \& my $class = \*(AqTAP::Parser::SourceHandler::RawTAP\*(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 output\fR TAP::Parser::SourceHandler \- it has 2 jobs:
84 .PP
85 1. Figure out if the TAP::Parser::Source it's given is raw TAP output
86 ("can_handle").
87 .PP
88 2. Creates an iterator for raw TAP output ("make_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 is an array, or a scalar with newlines. Casts the
104 following votes:
105 .PP
106 .Vb 4
107 \& 0.9 if it\*(Aqs a scalar with \*(Aq..\*(Aq in it
108 \& 0.7 if it\*(Aqs a scalar with \*(Aqok\*(Aq in it
109 \& 0.3 if it\*(Aqs just a scalar with newlines
110 \& 0.5 if it\*(Aqs an array
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::Array for the source.
121 \&\f(CW\*(C`$source\->raw\*(C'\fR must be an array ref, or a scalar ref.
122 .PP
123 \&\f(CW\*(C`croak\*(C'\fRs on error.
124 .SH SUBCLASSING
125 .IX Header "SUBCLASSING"
126 Please see "SUBCLASSING" in TAP::Parser for a subclassing overview.
127 .SH "SEE ALSO"
128 .IX Header "SEE ALSO"
129 TAP::Object,
130 TAP::Parser,
131 TAP::Parser::IteratorFactory,
132 TAP::Parser::SourceHandler,
133 TAP::Parser::SourceHandler::Executable,
134 TAP::Parser::SourceHandler::Perl,
135 TAP::Parser::SourceHandler::File,
136 TAP::Parser::SourceHandler::Handle