1 package Test::Valgrind::Command;
8 Test::Valgrind::Command - Base class for Test::Valgrind commands.
16 our $VERSION = '1.15';
20 This class is the base for L<Test::Valgrind> commands.
22 Commands gather information about the target of the analysis.
23 They should also provide a default setup for generating suppressions.
27 use base qw<Test::Valgrind::Carp>;
33 my $tvc = Test::Valgrind::Command->new(
38 Creates a new command object of type C<$command> by requiring and redispatching the method call to the module named C<$command> if it contains C<'::'> or to C<Test::Valgrind::Command::$command> otherwise.
39 The class represented by C<$command> must inherit this class.
41 The C<args> key is used to initialize the L</args> accessor.
47 $class = ref($class) || $class;
51 if ($class eq __PACKAGE__ and my $cmd = delete $args{command}) {
53 $cmd = __PACKAGE__ . "::$cmd" if $cmd !~ /::/;
54 $class->_croak("Couldn't load command $cmd: $@") unless eval "require $cmd;1";
55 return $cmd->new(%args);
58 my $args = delete $args{args};
59 $class->_croak('Invalid argument list') if $args and ref $args ne 'ARRAY';
68 Creates a new command object suitable for generating suppressions.
70 Defaults to return C<undef>, which skips suppression generation.
78 my @args = $tvc->args($session);
80 Returns the list of command-specific arguments that are to be passed to C<valgrind>.
82 Defaults to return the contents of the C<args> option.
86 sub args { @{$_[0]->{args} || []} }
90 my $env = $tvc->env($session);
92 This event is called in scalar context before the command is ran, and the returned value goes out of scope when the analysis ends.
93 It's useful for e.g. setting up C<%ENV> for the child process by returning an L<Env::Sanctify> object, hence the name.
101 =head2 C<suppressions_tag>
103 my $tag = $tvc->suppressions_tag($session);
105 Returns a identifier that will be used to pick up the right suppressions for running the command, or C<undef> to indicate that no special suppressions are needed.
107 This method must be implemented when subclassing.
111 sub suppressions_tag;
113 =head2 C<check_suppressions_file>
115 my $supp_ok = $tvc->check_suppressions_file($file);
117 Returns a boolean indicating whether the suppressions contained in C<$file> are compatible with the command.
123 sub check_suppressions_file { 1 }
127 my $filtered_report = $tvc->filter($session, $report);
129 The C<$session> calls this method after receiving a report from the tool and before forwarding it to the action.
130 You can either return a mangled C<$report> (which does not need to be a clone of the original) or C<undef> if you want the action to ignore it completely.
132 Defaults to the identity function.
140 L<Test::Valgrind>, L<Test::Valgrind::Session>.
144 Vincent Pit, C<< <perl at profvince.com> >>, L<http://www.profvince.com>.
146 You can contact me by mail or on C<irc.perl.org> (vincent).
150 Please report any bugs or feature requests to C<bug-test-valgrind at rt.cpan.org>, or through the web interface at L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Test-Valgrind>.
151 I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
155 You can find documentation for this module with the perldoc command.
157 perldoc Test::Valgrind::Command
159 =head1 COPYRIGHT & LICENSE
161 Copyright 2009,2010,2011,2013,2015 Vincent Pit, all rights reserved.
163 This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
167 1; # Test::Valgrind::Command