NAME¶
Test::Valgrind::Report - Base class for Test::Valgrind error reports.
VERSION¶
Version 1.14
DESCRIPTION¶
This class provides a generic API for messages (the so-called
reports)
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.
Reports are classified by
kinds. The "Diag" kind is reserved
for diagnostics.
"new"¶
my $tvr = Test::Valgrind::Report->new(
kind => $kind,
id => $id,
data => $data,
);
Your usual constructor.
All options are mandatory :
- •
- "kind" is the category of the report.
- •
- "id" is an unique identifier for the report.
- •
- "data" is the content.
"new_diag"¶
my $diag_report = Test::Valgrind::Report->new_diag($data);
Constructs a report with kind 'Diag', an auto-incremented identifier and the
given $data.
"kind"¶
my $kind = $tvr->kind;
Read-only accessor for the "kind" option.
"id"¶
my $id = $tvr->id;
Read-only accessor for the "id" option.
"data"¶
my $data = $tvr->data;
Read-only accessor for the "data" option.
"is_diag"¶
$tvr->is_diag;
Tells if a report has the 'Diag' kind, i.e. is a diagnostic.
"kinds"¶
my @kinds = $tvr->kinds;
Returns the list of valid kinds for this report class.
Defaults to 'Diag'.
"valid_kind"¶
$tvr->valid_kind($kind);
Tells whether $kind is a valid kind for this report class.
Defaults to true iff "$kind eq 'Diag'".
SEE ALSO¶
Test::Valgrind.
AUTHOR¶
Vincent Pit, "<perl at profvince.com>",
<
http://www.profvince.com>.
You can contact me by mail or on "irc.perl.org" (vincent).
BUGS¶
Please report any bugs or feature requests to "bug-test-valgrind at
rt.cpan.org", 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.
SUPPORT¶
You can find documentation for this module with the perldoc command.
perldoc Test::Valgrind::Report
COPYRIGHT & LICENSE¶
Copyright 2009,2010,2011,2013 Vincent Pit, all rights reserved.
This program is free software; you can redistribute it and/or modify it under
the same terms as Perl itself.