.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.29)
.\"
.\" 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 turned on, 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::Tool 3pm"
.TH Test::Valgrind::Tool 3pm "2016-08-01" "perl v5.22.2" "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::Tool \- Base class for Test::Valgrind tools.
.SH "VERSION"
.IX Header "VERSION"
Version 1.19
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This class is the base for Test::Valgrind tools.
.PP
They wrap around \f(CW\*(C`valgrind\*(C'\fR tools by parsing its output and sending reports to the parent session whenever an error occurs.
They are expected to function both in suppressions generation and in analysis mode.
.SH "METHODS"
.IX Header "METHODS"
.ie n .SS """requires_version"""
.el .SS "\f(CWrequires_version\fP"
.IX Subsection "requires_version"
.Vb 1
\&    my $required_version = $tvt\->requires_version;
.Ve
.PP
The minimum \f(CW\*(C`valgrind\*(C'\fR version needed to run this tool.
Defaults to \f(CW3.1.0\fR.
.ie n .SS """new"""
.el .SS "\f(CWnew\fP"
.IX Subsection "new"
.Vb 1
\&    my $tvt = Test::Valgrind::Tool\->new(tool => $tool);
.Ve
.PP
Creates a new tool object of type \f(CW$tool\fR by requiring and redispatching the method call to the module named \f(CW$tool\fR if it contains \f(CW\*(Aq::\*(Aq\fR or to \f(CW\*(C`Test::Valgrind::Tool::$tool\*(C'\fR otherwise.
The class represented by \f(CW$tool\fR must inherit this class.
.ie n .SS """new_trainer"""
.el .SS "\f(CWnew_trainer\fP"
.IX Subsection "new_trainer"
.Vb 1
\&    my $tvt_train = Test::Valgrind::Tool\->new_trainer;
.Ve
.PP
Creates a new tool object suitable for generating suppressions.
.PP
Defaults to return \f(CW\*(C`undef\*(C'\fR, which skips suppression generation.
.ie n .SS """parser_class"""
.el .SS "\f(CWparser_class\fP"
.IX Subsection "parser_class"
.Vb 1
\&    my $parser_class = $tvt\->parser_class($session);
.Ve
.PP
Returns the class from which the parser for this tool output will be instantiated.
.PP
This method must be implemented when subclassing.
.ie n .SS """report_class"""
.el .SS "\f(CWreport_class\fP"
.IX Subsection "report_class"
.Vb 1
\&    my $report_class = $tvt\->report_class($session);
.Ve
.PP
Returns the class in which suppression reports generated by this tool will be blessed.
.PP
This method must be implemented when subclassing.
.ie n .SS """args"""
.el .SS "\f(CWargs\fP"
.IX Subsection "args"
.Vb 1
\&    my @args = $tvt\->args($session);
.Ve
.PP
Returns the list of tool-specific arguments that are to be passed to \f(CW\*(C`valgrind\*(C'\fR.
All the suppression arguments are already handled by the session.
.PP
Defaults to the empty list.
.ie n .SS """suppressions_tag"""
.el .SS "\f(CWsuppressions_tag\fP"
.IX Subsection "suppressions_tag"
.Vb 1
\&    my $tag = $tvt\->suppressions_tag($session);
.Ve
.PP
Returns a identifier that will be used to pick up the right suppressions for running the tool, or \f(CW\*(C`undef\*(C'\fR to indicate that no special suppressions are needed.
.PP
This method must be implemented when subclassing.
.ie n .SS """start"""
.el .SS "\f(CWstart\fP"
.IX Subsection "start"
.Vb 1
\&    $tvt\->start($session);
.Ve
.PP
Called when the \f(CW$session\fR starts.
.PP
Defaults to set \*(L"started\*(R" in Test::Valgrind::Component.
.ie n .SS """filter"""
.el .SS "\f(CWfilter\fP"
.IX Subsection "filter"
.Vb 1
\&    my $filtered_report = $tvt\->filter($session, $report);
.Ve
.PP
The \f(CW$session\fR calls this method after receiving a report from the parser and before letting the command filter it.
You can either return a mangled \f(CW$report\fR (which does not need to be a clone of the original) or \f(CW\*(C`undef\*(C'\fR if you want the action to ignore it completely.
.PP
Defaults to the identity function.
.ie n .SS """finish"""
.el .SS "\f(CWfinish\fP"
.IX Subsection "finish"
.Vb 1
\&    $tvt\->finish($session);
.Ve
.PP
Called when the \f(CW$session\fR finishes.
.PP
Defaults to clear \*(L"started\*(R" in Test::Valgrind::Component.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Test::Valgrind, Test::Valgrind::Component, Test::Valgrind::Session.
.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::Tool
.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.