1 package Test::Valgrind::Tool;
8 Test::Valgrind::Tool - Base class for Test::Valgrind tools.
16 our $VERSION = '1.13';
20 This class is the base for L<Test::Valgrind> tools.
22 They wrap around C<valgrind> tools by parsing its output and sending reports to the parent session whenever an error occurs.
23 They are expected to function both in suppressions generation and in analysis mode.
27 use base qw<Test::Valgrind::Component Test::Valgrind::Carp>;
31 =head2 C<requires_version>
33 my $required_version = $tvt->requires_version;
35 The minimum C<valgrind> version needed to run this tool.
40 sub requires_version { '3.1.0' }
44 my $tvt = Test::Valgrind::Tool->new(tool => $tool);
46 Creates a new tool object of type C<$tool> by requiring and redispatching the method call to the module named C<$tool> if it contains C<'::'> or to C<Test::Valgrind::Tool::$tool> otherwise.
47 The class represented by C<$tool> must inherit this class.
53 $class = ref($class) || $class;
57 if ($class eq __PACKAGE__) {
58 my $tool = delete $args{tool} || 'memcheck';
60 $tool = __PACKAGE__ . "::$tool" if $tool !~ /::/;
61 $class->_croak("Couldn't load tool $tool: $@") unless eval "require $tool; 1";
62 return $tool->new(%args);
65 $class->SUPER::new(@_);
70 my $tvt_train = Test::Valgrind::Tool->new_trainer;
72 Creates a new tool object suitable for generating suppressions.
74 Defaults to return C<undef>, which skips suppression generation.
80 =head2 C<parser_class>
82 my $parser_class = $tvt->parser_class($session);
84 Returns the class from which the parser for this tool output will be instanciated.
86 This method must be implemented when subclassing.
92 =head2 C<report_class>
94 my $report_class = $tvt->report_class($session);
96 Returns the class in which suppression reports generated by this tool will be blessed.
98 This method must be implemented when subclassing.
106 my @args = $tvt->args($session);
108 Returns the list of tool-specific arguments that are to be passed to C<valgrind>.
109 All the suppression arguments are already handled by the session.
111 Defaults to the empty list.
117 =head2 C<suppressions_tag>
119 my $tag = $tvt->suppressions_tag($session);
121 Returns a identifier that will be used to pick up the right suppressions for running the tool, or C<undef> to indicate that no special suppressions are needed.
123 This method must be implemented when subclassing.
127 sub suppressions_tag;
131 $tvt->start($session);
133 Called when the C<$session> starts.
135 Defaults to set L<Test::Valgrind::Component/started>.
139 my $filtered_report = $tvt->filter($session, $report);
141 The C<$session> calls this method after receiving a report from the parser and before letting the command filter it.
142 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.
144 Defaults to the identity function.
152 $tvt->finish($session);
154 Called when the C<$session> finishes.
156 Defaults to clear L<Test::Valgrind::Component/started>.
160 L<Test::Valgrind>, L<Test::Valgrind::Component>, L<Test::Valgrind::Session>.
164 Vincent Pit, C<< <perl at profvince.com> >>, L<http://www.profvince.com>.
166 You can contact me by mail or on C<irc.perl.org> (vincent).
170 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>.
171 I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
175 You can find documentation for this module with the perldoc command.
177 perldoc Test::Valgrind::Tool
179 =head1 COPYRIGHT & LICENSE
181 Copyright 2009,2010,2011,2013 Vincent Pit, all rights reserved.
183 This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
187 1; # End of Test::Valgrind::Tool