Debian Codegraph @

upstream/debian-unstable/man3/TAP::Parser::SourceHandler::Executable.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::Executable 3perl"
58 .TH TAP::Parser::SourceHandler::Executable 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::Executable \- Stream output from an executable TAP source
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([\*(Aq/usr/bin/ruby\*(Aq, \*(Aqmytest.rb\*(Aq]);
75 \& $source\->assemble_meta;
76 \&
77 \& my $class = \*(AqTAP::Parser::SourceHandler::Executable\*(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 an \fIexecutable\fR TAP::Parser::SourceHandler \- it has 2 jobs:
84 .PP
85 1. Figure out if the TAP::Parser::Source it's given is an executable
86 command ("can_handle").
87 .PP
88 2. Creates an iterator for executable commands ("make_iterator").
89 .PP
90 Unless you're writing a plugin or subclassing TAP::Parser, you
91 probably 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 an executable file. Casts the
104 following votes:
105 .PP
106 .Vb 3
107 \& 0.9 if it\*(Aqs a hash with an \*(Aqexec\*(Aq key
108 \& 0.8 if it\*(Aqs a .bat file
109 \& 0.75 if it\*(Aqs got an execute bit set
110 .Ve
111 .PP
112 \fR\f(CI\*(C`make_iterator\*(C'\fR\fI\fR
113 .IX Subsection "make_iterator"
114 .PP
115 .Vb 1
116 \& my $iterator = $class\->make_iterator( $source );
117 .Ve
118 .PP
119 Returns a new TAP::Parser::Iterator::Process for the source.
120 \&\f(CW\*(C`$source\->raw\*(C'\fR must be in one of the following forms:
121 .PP
122 .Vb 1
123 \& { exec => [ @exec ] }
124 \&
125 \& [ @exec ]
126 \&
127 \& $file
128 .Ve
129 .PP
130 \&\f(CW\*(C`croak\*(C'\fRs on error.
131 .PP
132 \fR\f(CI\*(C`iterator_class\*(C'\fR\fI\fR
133 .IX Subsection "iterator_class"
134 .PP
135 The class of iterator to use, override if you're sub-classing. Defaults
136 to TAP::Parser::Iterator::Process.
137 .SH SUBCLASSING
138 .IX Header "SUBCLASSING"
139 Please see "SUBCLASSING" in TAP::Parser for a subclassing overview.
140 .SS Example
141 .IX Subsection "Example"
142 .Vb 1
143 \& package MyRubySourceHandler;
144 \&
145 \& use strict;
146 \&
147 \& use Carp qw( croak );
148 \& use TAP::Parser::SourceHandler::Executable;
149 \&
150 \& use base \*(AqTAP::Parser::SourceHandler::Executable\*(Aq;
151 \&
152 \& # expect $handler\->([\*(Aqmytest.rb\*(Aq, \*(Aqcmdline\*(Aq, \*(Aqargs\*(Aq]);
153 \& sub make_iterator {
154 \& my ($self, $source) = @_;
155 \& my @test_args = @{ $source\->test_args };
156 \& my $rb_file = $test_args[0];
157 \& croak("error: Ruby file \*(Aq$rb_file\*(Aq not found!") unless (\-f $rb_file);
158 \& return $self\->SUPER::raw_source([\*(Aq/usr/bin/ruby\*(Aq, @test_args]);
159 \& }
160 .Ve
161 .SH "SEE ALSO"
162 .IX Header "SEE ALSO"
163 TAP::Object,
164 TAP::Parser,
165 TAP::Parser::IteratorFactory,
166 TAP::Parser::SourceHandler,
167 TAP::Parser::SourceHandler::Perl,
168 TAP::Parser::SourceHandler::File,
169 TAP::Parser::SourceHandler::Handle,
170 TAP::Parser::SourceHandler::RawTAP