1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
|
.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
. ds C` ""
. ds C' ""
'br\}
.el\{\
. ds C`
. ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
. if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. if !\nF==2 \{\
. nr % 0
. nr F 2
. \}
. \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "TAP::Formatter::Session 3pm"
.TH TAP::Formatter::Session 3pm 2023-11-28 "perl v5.38.2" "Perl Programmers Reference Guide"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
TAP::Formatter::Session \- Abstract base class for harness output delegate
.SH VERSION
.IX Header "VERSION"
Version 3.44
.SH METHODS
.IX Header "METHODS"
.SS "Class Methods"
.IX Subsection "Class Methods"
\fR\f(CI\*(C`new\*(C'\fR\fI\fR
.IX Subsection "new"
.PP
.Vb 4
\& my %args = (
\& formatter => $self,
\& )
\& my $harness = TAP::Formatter::Console::Session\->new( \e%args );
.Ve
.PP
The constructor returns a new \f(CW\*(C`TAP::Formatter::Console::Session\*(C'\fR object.
.IP \(bu 4
\&\f(CW\*(C`formatter\*(C'\fR
.IP \(bu 4
\&\f(CW\*(C`parser\*(C'\fR
.IP \(bu 4
\&\f(CW\*(C`name\*(C'\fR
.IP \(bu 4
\&\f(CW\*(C`show_count\*(C'\fR
.PP
\fR\f(CI\*(C`header\*(C'\fR\fI\fR
.IX Subsection "header"
.PP
Output test preamble
.PP
\fR\f(CI\*(C`result\*(C'\fR\fI\fR
.IX Subsection "result"
.PP
Called by the harness for each line of TAP it receives.
.PP
\fR\f(CI\*(C`close_test\*(C'\fR\fI\fR
.IX Subsection "close_test"
.PP
Called to close a test session.
.PP
\fR\f(CI\*(C`clear_for_close\*(C'\fR\fI\fR
.IX Subsection "clear_for_close"
.PP
Called by \f(CW\*(C`close_test\*(C'\fR to clear the line showing test progress, or the parallel
test ruler, prior to printing the final test result.
.PP
\fR\f(CI\*(C`time_report\*(C'\fR\fI\fR
.IX Subsection "time_report"
.PP
Return a formatted string about the elapsed (wall-clock) time
and about the consumed CPU time.
|