.\" 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::Command 3pm" .TH Test::Valgrind::Command 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::Command \- Base class for Test::Valgrind commands. .SH "VERSION" .IX Header "VERSION" Version 1.19 .SH "DESCRIPTION" .IX Header "DESCRIPTION" This class is the base for Test::Valgrind commands. .PP Commands gather information about the target of the analysis. They should also provide a default setup for generating suppressions. .SH "METHODS" .IX Header "METHODS" .ie n .SS """new""" .el .SS "\f(CWnew\fP" .IX Subsection "new" .Vb 4 \& my $tvc = Test::Valgrind::Command\->new( \& command => $command, \& args => \e@args, \& ); .Ve .PP Creates a new command object of type \f(CW$command\fR by requiring and redispatching the method call to the module named \f(CW$command\fR if it contains \f(CW\*(Aq::\*(Aq\fR or to \f(CW\*(C`Test::Valgrind::Command::$command\*(C'\fR otherwise. The class represented by \f(CW$command\fR must inherit this class. .PP The \f(CW\*(C`args\*(C'\fR key is used to initialize the \*(L"args\*(R" accessor. .ie n .SS """new_trainer""" .el .SS "\f(CWnew_trainer\fP" .IX Subsection "new_trainer" Creates a new command object suitable for generating suppressions. .PP Defaults to return \f(CW\*(C`undef\*(C'\fR, which skips suppression generation. .ie n .SS """args""" .el .SS "\f(CWargs\fP" .IX Subsection "args" .Vb 1 \& my @args = $tvc\->args($session); .Ve .PP Returns the list of command-specific arguments that are to be passed to \f(CW\*(C`valgrind\*(C'\fR. .PP Defaults to return the contents of the \f(CW\*(C`args\*(C'\fR option. .ie n .SS """env""" .el .SS "\f(CWenv\fP" .IX Subsection "env" .Vb 1 \& my $env = $tvc\->env($session); .Ve .PP This event is called in scalar context before the command is ran, and the returned value goes out of scope when the analysis ends. It's useful for e.g. setting up \f(CW%ENV\fR for the child process by returning an Env::Sanctify object, hence the name. .PP Defaults to void. .ie n .SS """suppressions_tag""" .el .SS "\f(CWsuppressions_tag\fP" .IX Subsection "suppressions_tag" .Vb 1 \& my $tag = $tvc\->suppressions_tag($session); .Ve .PP Returns a identifier that will be used to pick up the right suppressions for running the command, 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 """check_suppressions_file""" .el .SS "\f(CWcheck_suppressions_file\fP" .IX Subsection "check_suppressions_file" .Vb 1 \& my $supp_ok = $tvc\->check_suppressions_file($file); .Ve .PP Returns a boolean indicating whether the suppressions contained in \f(CW$file\fR are compatible with the command. .PP Defaults to true. .ie n .SS """filter""" .el .SS "\f(CWfilter\fP" .IX Subsection "filter" .Vb 1 \& my $filtered_report = $tvc\->filter($session, $report); .Ve .PP The \f(CW$session\fR calls this method after receiving a report from the tool and before forwarding it to the action. 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. .SH "SEE ALSO" .IX Header "SEE ALSO" Test::Valgrind, Test::Valgrind::Session. .SH "AUTHOR" .IX Header "AUTHOR" Vincent Pit, \f(CW\*(C`\*(C'\fR, . .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 . 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::Command .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.