Debian Codegraph @

upstream/debian-unstable/man3/TAP::Formatter::Session.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::Formatter::Session 3perl"
58 .TH TAP::Formatter::Session 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::Formatter::Session \- Abstract base class for harness output delegate
65 .SH VERSION
66 .IX Header "VERSION"
67 Version 3.48
68 .SH METHODS
69 .IX Header "METHODS"
70 .SS "Class Methods"
71 .IX Subsection "Class Methods"
72 \fR\f(CI\*(C`new\*(C'\fR\fI\fR
73 .IX Subsection "new"
74 .PP
75 .Vb 4
76 \& my %args = (
77 \& formatter => $self,
78 \& )
79 \& my $harness = TAP::Formatter::Console::Session\->new( \e%args );
80 .Ve
81 .PP
82 The constructor returns a new \f(CW\*(C`TAP::Formatter::Console::Session\*(C'\fR object.
83 .IP \(bu 4
84 \&\f(CW\*(C`formatter\*(C'\fR
85 .IP \(bu 4
86 \&\f(CW\*(C`parser\*(C'\fR
87 .IP \(bu 4
88 \&\f(CW\*(C`name\*(C'\fR
89 .IP \(bu 4
90 \&\f(CW\*(C`show_count\*(C'\fR
91 .PP
92 \fR\f(CI\*(C`header\*(C'\fR\fI\fR
93 .IX Subsection "header"
94 .PP
95 Output test preamble
96 .PP
97 \fR\f(CI\*(C`result\*(C'\fR\fI\fR
98 .IX Subsection "result"
99 .PP
100 Called by the harness for each line of TAP it receives.
101 .PP
102 \fR\f(CI\*(C`close_test\*(C'\fR\fI\fR
103 .IX Subsection "close_test"
104 .PP
105 Called to close a test session.
106 .PP
107 \fR\f(CI\*(C`clear_for_close\*(C'\fR\fI\fR
108 .IX Subsection "clear_for_close"
109 .PP
110 Called by \f(CW\*(C`close_test\*(C'\fR to clear the line showing test progress, or the parallel
111 test ruler, prior to printing the final test result.
112 .PP
113 \fR\f(CI\*(C`time_report\*(C'\fR\fI\fR
114 .IX Subsection "time_report"
115 .PP
116 Return a formatted string about the elapsed (wall-clock) time
117 and about the consumed CPU time.