Debian Codegraph @

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