.\" 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::Session 3pm"
.TH Test::Valgrind::Session 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::Session \- Test::Valgrind session object.
.SH "VERSION"
.IX Header "VERSION"
Version 1.19
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This class supervises the execution of the \f(CW\*(C`valgrind\*(C'\fR process.
It also acts as a dispatcher between the different components.
.SH "METHODS"
.IX Header "METHODS"
.ie n .SS """new"""
.el .SS "\f(CWnew\fP"
.IX Subsection "new"
.Vb 10
\&    my $tvs = Test::Valgrind::Session\->new(
\&     search_dirs    => \e@search_dirs,
\&     valgrind       => $valgrind,  # One candidate
\&     valgrind       => \e@valgrind, # Several candidates
\&     min_version    => $min_version,
\&     regen_def_supp => $regen_def_supp,
\&     no_def_supp    => $no_def_supp,
\&     allow_no_supp  => $allow_no_supp,
\&     extra_supps    => \e@extra_supps,
\&    );
.Ve
.PP
The package constructor, which takes several options :
.IP "\(bu" 4
All the directories from \f(CW@search_dirs\fR will have \fIvalgrind\fR appended to create a list of candidates for the \f(CW\*(C`valgrind\*(C'\fR executable.
.Sp
Defaults to the current \f(CW\*(C`PATH\*(C'\fR environment variable.
.IP "\(bu" 4
If a simple scalar \f(CW$valgrind\fR is passed as the value to \f(CW\*(Aqvalgrind\*(Aq\fR, it will be the only candidate.
\&\f(CW@search_dirs\fR will then be ignored.
.Sp
If an array reference \f(CW\*(C`\e@valgrind\*(C'\fR is passed, its values will be \fIprepended\fR to the list of the candidates resulting from \f(CW@search_dirs\fR.
.IP "\(bu" 4
\&\f(CW$min_version\fR specifies the minimal \f(CW\*(C`valgrind\*(C'\fR version required.
The constructor will croak if it's not able to find an adequate \f(CW\*(C`valgrind\*(C'\fR from the supplied candidates list and search path.
.Sp
Defaults to none.
.IP "\(bu" 4
If \f(CW$regen_def_supp\fR is true, the default suppression file associated with the tool and the command will be forcefully regenerated.
.Sp
Defaults to false.
.IP "\(bu" 4
If \f(CW$no_def_supp\fR is true, \f(CW\*(C`valgrind\*(C'\fR won't read the default suppression file associated with the tool and the command.
.Sp
Defaults to false.
.IP "\(bu" 4
If \f(CW$allow_no_supp\fR is true, the command will always be run into \f(CW\*(C`valgrind\*(C'\fR even if no appropriate suppression file is available.
.Sp
Defaults to false.
.IP "\(bu" 4
\&\f(CW$extra_supps\fR is a reference to an array of optional suppression files that will be passed to \f(CW\*(C`valgrind\*(C'\fR.
.Sp
Defaults to none.
.ie n .SS """valgrind"""
.el .SS "\f(CWvalgrind\fP"
.IX Subsection "valgrind"
.Vb 1
\&    my $valgrind_path = $tvs\->valgrind;
.Ve
.PP
The path to the selected \f(CW\*(C`valgrind\*(C'\fR executable.
.ie n .SS """version"""
.el .SS "\f(CWversion\fP"
.IX Subsection "version"
.Vb 1
\&    my $valgrind_version = $tvs\->version;
.Ve
.PP
The Test::Valgrind::Version object associated to the selected \f(CW\*(C`valgrind\*(C'\fR.
.ie n .SS """regen_def_supp"""
.el .SS "\f(CWregen_def_supp\fP"
.IX Subsection "regen_def_supp"
.Vb 1
\&    my $regen_def_supp = $tvs\->regen_def_supp;
.Ve
.PP
Read-only accessor for the \f(CW\*(C`regen_def_supp\*(C'\fR option.
.ie n .SS """no_def_supp"""
.el .SS "\f(CWno_def_supp\fP"
.IX Subsection "no_def_supp"
.Vb 1
\&    my $no_def_supp = $tvs\->no_def_supp;
.Ve
.PP
Read-only accessor for the \f(CW\*(C`no_def_supp\*(C'\fR option.
.ie n .SS """allow_no_supp"""
.el .SS "\f(CWallow_no_supp\fP"
.IX Subsection "allow_no_supp"
.Vb 1
\&    my $allow_no_supp = $tvs\->allow_no_supp;
.Ve
.PP
Read-only accessor for the \f(CW\*(C`allow_no_supp\*(C'\fR option.
.ie n .SS """extra_supps"""
.el .SS "\f(CWextra_supps\fP"
.IX Subsection "extra_supps"
.Vb 1
\&    my @extra_supps = $tvs\->extra_supps;
.Ve
.PP
Read-only accessor for the \f(CW\*(C`extra_supps\*(C'\fR option.
.ie n .SS """run"""
.el .SS "\f(CWrun\fP"
.IX Subsection "run"
.Vb 5
\&    $tvs\->run(
\&     action  => $action,
\&     tool    => $tool,
\&     command => $command,
\&    );
.Ve
.PP
Runs the command \f(CW$command\fR through \f(CW\*(C`valgrind\*(C'\fR with the tool \f(CW$tool\fR, which will report to the action \f(CW$action\fR.
.PP
If the command is a Test::Valgrind::Command::Aggregate object, the action and the tool will be initialized once before running all the aggregated commands.
.ie n .SS """action"""
.el .SS "\f(CWaction\fP"
.IX Subsection "action"
Read-only accessor for the \f(CW\*(C`action\*(C'\fR associated to the current run.
.ie n .SS """tool"""
.el .SS "\f(CWtool\fP"
.IX Subsection "tool"
Read-only accessor for the \f(CW\*(C`tool\*(C'\fR associated to the current run.
.ie n .SS """parser"""
.el .SS "\f(CWparser\fP"
.IX Subsection "parser"
Read-only accessor for the \f(CW\*(C`parser\*(C'\fR associated to the current tool.
.ie n .SS """command"""
.el .SS "\f(CWcommand\fP"
.IX Subsection "command"
Read-only accessor for the \f(CW\*(C`command\*(C'\fR associated to the current run.
.ie n .SS """do_suppressions"""
.el .SS "\f(CWdo_suppressions\fP"
.IX Subsection "do_suppressions"
Forwards to \f(CW\*(C`\->action\->do_suppressions\*(C'\fR.
.ie n .SS """parser_class"""
.el .SS "\f(CWparser_class\fP"
.IX Subsection "parser_class"
Calls \f(CW\*(C`\->tool\->parser_class\*(C'\fR with the current session object as the unique argument.
.ie n .SS """report_class"""
.el .SS "\f(CWreport_class\fP"
.IX Subsection "report_class"
Calls \f(CW\*(C`\->tool\->report_class\*(C'\fR with the current session object as the unique argument.
.ie n .SS """def_supp_file"""
.el .SS "\f(CWdef_supp_file\fP"
.IX Subsection "def_supp_file"
Returns an absolute path to the default suppression file associated to the current session.
.PP
\&\f(CW\*(C`undef\*(C'\fR will be returned as soon as any of \f(CW\*(C`\->command\->suppressions_tag\*(C'\fR or \f(CW\*(C`\->tool\->suppressions_tag\*(C'\fR are also \f(CW\*(C`undef\*(C'\fR.
Otherwise, the file part of the name is builded by joining those two together, and the directory part is roughly \fIFile::HomeDir\->my_home / .perl / Test-Valgrind / suppressions / \f(CI$VERSION\fI\fR.
.ie n .SS """suppressions"""
.el .SS "\f(CWsuppressions\fP"
.IX Subsection "suppressions"
.Vb 1
\&    my @suppressions = $tvs\->suppressions;
.Ve
.PP
Returns the list of all the suppressions that will be passed to \f(CW\*(C`valgrind\*(C'\fR.
Honors \*(L"no_def_supp\*(R" and \*(L"extra_supps\*(R".
.ie n .SS """start"""
.el .SS "\f(CWstart\fP"
.IX Subsection "start"
.Vb 1
\&    $tvs\->start;
.Ve
.PP
Starts the action and tool associated to the current run.
It's automatically called at the beginning of \*(L"run\*(R".
.ie n .SS """abort"""
.el .SS "\f(CWabort\fP"
.IX Subsection "abort"
.Vb 1
\&    $tvs\->abort($msg);
.Ve
.PP
Forwards to \f(CW\*(C`\->action\->abort\*(C'\fR after unshifting the session object to the argument list.
.ie n .SS """report"""
.el .SS "\f(CWreport\fP"
.IX Subsection "report"
.Vb 1
\&    $tvs\->report($report);
.Ve
.PP
Forwards to \f(CW\*(C`\->action\->report\*(C'\fR after unshifting the session object to the argument list.
.ie n .SS """finish"""
.el .SS "\f(CWfinish\fP"
.IX Subsection "finish"
.Vb 1
\&    $tvs\->finish;
.Ve
.PP
Finishes the action and tool associated to the current run.
It's automatically called at the end of \*(L"run\*(R".
.ie n .SS """status"""
.el .SS "\f(CWstatus\fP"
.IX Subsection "status"
.Vb 1
\&    my $status = $tvs\->status;
.Ve
.PP
Returns the status code of the last run of the session.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Test::Valgrind, Test::Valgrind::Action, Test::Valgrind::Command, Test::Valgrind::Tool, Test::Valgrind::Parser.
.PP
File::HomeDir.
.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::Session
.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.