1 package Test::Valgrind::Command;
8 Test::Valgrind::Command - Base class for Test::Valgrind commands.
16 our $VERSION = '1.13';
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>;
31 =head2 C<< new command => $command, args => \@args >>
33 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.
34 The class represented by C<$command> must inherit this class.
36 The C<args> key is used to initialize the L</args> accessor.
42 $class = ref($class) || $class;
46 if ($class eq __PACKAGE__ and my $cmd = delete $args{command}) {
48 $cmd = __PACKAGE__ . "::$cmd" if $cmd !~ /::/;
49 $class->_croak("Couldn't load command $cmd: $@") unless eval "require $cmd;1";
50 return $cmd->new(%args);
53 my $args = delete $args{args};
54 $class->_croak('Invalid argument list') if $args and ref $args ne 'ARRAY';
63 Creates a new command object suitable for generating suppressions.
65 Defaults to return C<undef>, which skips suppression generation.
71 =head2 C<args $session>
73 Returns the list of command-specific arguments that are to be passed to C<valgrind>.
75 Defaults to return the contents of the C<args> option.
79 sub args { @{$_[0]->{args} || []} }
81 =head2 C<env $session>
83 This event is called in scalar context before the command is ran, and the returned value goes out of scope when the analysis ends.
84 It's useful for e.g. setting up C<%ENV> for the child process by returning an L<Env::Sanctify> object, hence the name.
92 =head2 C<suppressions_tag $session>
94 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.
96 This method must be implemented when subclassing.
100 sub suppressions_tag;
102 =head2 C<filter $session, $report>
104 The C<$session> calls this method after receiving a report from the tool and before forwarding it to the action.
105 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.
107 Defaults to the identity function.
115 L<Test::Valgrind>, L<Test::Valgrind::Session>.
119 Vincent Pit, C<< <perl at profvince.com> >>, L<http://www.profvince.com>.
121 You can contact me by mail or on C<irc.perl.org> (vincent).
125 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>.
126 I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
130 You can find documentation for this module with the perldoc command.
132 perldoc Test::Valgrind::Command
134 =head1 COPYRIGHT & LICENSE
136 Copyright 2009,2010,2011 Vincent Pit, all rights reserved.
138 This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
142 1; # Test::Valgrind::Command