Debian Codegraph @

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