.\" 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::Action 3pm"
.TH Test::Valgrind::Action 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::Action \- Base class for Test::Valgrind actions.
.SH "VERSION"
.IX Header "VERSION"
Version 1.19
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This class is the base for Test::Valgrind actions.
.PP
Actions are called each time a tool encounter an error and decide what to do with it (for example passing or failing tests).
.SH "METHODS"
.IX Header "METHODS"
.ie n .SS """new"""
.el .SS "\f(CWnew\fP"
.IX Subsection "new"
.Vb 1
\&    my $tva = Test::Valgrind::Action\->new(action => $action);
.Ve
.PP
Creates a new action object of type \f(CW$action\fR by requiring and redispatching the method call to the module named \f(CW$action\fR if it contains \f(CW\*(Aq::\*(Aq\fR or to \f(CW\*(C`Test::Valgrind::Action::$action\*(C'\fR otherwise.
The class represented by \f(CW$action\fR must inherit this class.
.ie n .SS """do_suppressions"""
.el .SS "\f(CWdo_suppressions\fP"
.IX Subsection "do_suppressions"
Indicates if the action wants \f(CW\*(C`valgrind\*(C'\fR to run in suppression-generating mode or in analysis mode.
.ie n .SS """start"""
.el .SS "\f(CWstart\fP"
.IX Subsection "start"
.Vb 1
\&    $tva\->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 """report"""
.el .SS "\f(CWreport\fP"
.IX Subsection "report"
.Vb 1
\&    $tva\->report($session, $report);
.Ve
.PP
Invoked each time the \f(CW\*(C`valgrind\*(C'\fR process attached to the \f(CW$session\fR spots an error.
\&\f(CW$report\fR is a Test::Valgrind::Report object describing the error.
.PP
Defaults to check \*(L"started\*(R" in Test::Valgrind::Component.
.ie n .SS """abort"""
.el .SS "\f(CWabort\fP"
.IX Subsection "abort"
.Vb 1
\&    $tva\->abort($session, $msg);
.Ve
.PP
Triggered when the \f(CW$session\fR has to interrupt the action.
.PP
Defaults to croak.
.ie n .SS """finish"""
.el .SS "\f(CWfinish\fP"
.IX Subsection "finish"
.Vb 1
\&    $tva\->finish($session);
.Ve
.PP
Called when the \f(CW$session\fR finishes.
.PP
Defaults to clear \*(L"started\*(R" in Test::Valgrind::Component.
.ie n .SS """status"""
.el .SS "\f(CWstatus\fP"
.IX Subsection "status"
.Vb 1
\&    $tva\->status($session);
.Ve
.PP
Returns the status code corresponding to the last run of the action.
.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::Action
.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.