.\" Automatically generated by Pod::Man 4.14 (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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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 "Test::Valgrind::Report 3pm"
.TH Test::Valgrind::Report 3pm "2023-08-04" "perl v5.36.0" "User Contributed Perl Documentation"
.\" 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"
Test::Valgrind::Report \- Base class for Test::Valgrind error reports.
.SH "VERSION"
.IX Header "VERSION"
Version 1.19
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This class provides a generic \s-1API\s0 for messages (the so-called \fIreports\fR) generated by the parser, filtered by the tool and the command, and handled by the action.
The tool has authority for deciding in which subclass of this one reports should be blessed.
.PP
Reports are classified by \fIkinds\fR.
The \f(CW\*(C`Diag\*(C'\fR kind is reserved for diagnostics.
.ie n .SS """new"""
.el .SS "\f(CWnew\fP"
.IX Subsection "new"
.Vb 5
\&   my $tvr = Test::Valgrind::Report\->new(
\&    kind => $kind,
\&    id   => $id,
\&    data => $data,
\&   );
.Ve
.PP
Your usual constructor.
.PP
All options are mandatory :
.IP "\(bu" 4
\&\f(CW\*(C`kind\*(C'\fR is the category of the report.
.IP "\(bu" 4
\&\f(CW\*(C`id\*(C'\fR is an unique identifier for the report.
.IP "\(bu" 4
\&\f(CW\*(C`data\*(C'\fR is the content.
.ie n .SS """new_diag"""
.el .SS "\f(CWnew_diag\fP"
.IX Subsection "new_diag"
.Vb 1
\&    my $diag_report = Test::Valgrind::Report\->new_diag($data);
.Ve
.PP
Constructs a report with kind \f(CW\*(AqDiag\*(Aq\fR, an auto-incremented identifier and the given \f(CW$data\fR.
.ie n .SS """kind"""
.el .SS "\f(CWkind\fP"
.IX Subsection "kind"
.Vb 1
\&    my $kind = $tvr\->kind;
.Ve
.PP
Read-only accessor for the \f(CW\*(C`kind\*(C'\fR option.
.ie n .SS """id"""
.el .SS "\f(CWid\fP"
.IX Subsection "id"
.Vb 1
\&    my $id = $tvr\->id;
.Ve
.PP
Read-only accessor for the \f(CW\*(C`id\*(C'\fR option.
.ie n .SS """data"""
.el .SS "\f(CWdata\fP"
.IX Subsection "data"
.Vb 1
\&    my $data = $tvr\->data;
.Ve
.PP
Read-only accessor for the \f(CW\*(C`data\*(C'\fR option.
.ie n .SS """is_diag"""
.el .SS "\f(CWis_diag\fP"
.IX Subsection "is_diag"
.Vb 1
\&    $tvr\->is_diag;
.Ve
.PP
Tells if a report has the \f(CW\*(AqDiag\*(Aq\fR kind, i.e. is a diagnostic.
.ie n .SS """kinds"""
.el .SS "\f(CWkinds\fP"
.IX Subsection "kinds"
.Vb 1
\&    my @kinds = $tvr\->kinds;
.Ve
.PP
Returns the list of valid kinds for this report class.
.PP
Defaults to \f(CW\*(AqDiag\*(Aq\fR.
.ie n .SS """valid_kind"""
.el .SS "\f(CWvalid_kind\fP"
.IX Subsection "valid_kind"
.Vb 1
\&    $tvr\->valid_kind($kind);
.Ve
.PP
Tells whether \f(CW$kind\fR is a valid kind for this report class.
.PP
Defaults to true iff \f(CW\*(C`$kind eq \*(AqDiag\*(Aq\*(C'\fR.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Test::Valgrind.
.SH "AUTHOR"
.IX Header "AUTHOR"
Vincent Pit, \f(CW\*(C`<perl at profvince.com>\*(C'\fR, <http://www.profvince.com>.
.PP
You can contact me by mail or on \f(CW\*(C`irc.perl.org\*(C'\fR (vincent).
.SH "BUGS"
.IX Header "BUGS"
Please report any bugs or feature requests to \f(CW\*(C`bug\-test\-valgrind at rt.cpan.org\*(C'\fR, or through the web interface at <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Test\-Valgrind>.
I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
.SH "SUPPORT"
.IX Header "SUPPORT"
You can find documentation for this module with the perldoc command.
.PP
.Vb 1
\&    perldoc Test::Valgrind::Report
.Ve
.SH "COPYRIGHT & LICENSE"
.IX Header "COPYRIGHT & LICENSE"
Copyright 2009,2010,2011,2013,2015,2016 Vincent Pit, all rights reserved.
.PP
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.