1 package Test::Valgrind::Tool;
8 Test::Valgrind::Tool - Base class for Test::Valgrind tools.
16 our $VERSION = '1.02';
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 The minimum C<valgrind> version needed to run this tool.
38 sub requires_version { '3.1.0' }
40 =head2 C<< new tool => $tool >>
42 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.
43 The class represented by C<$tool> must inherit this class.
49 $class = ref($class) || $class;
53 if ($class eq __PACKAGE__) {
54 my $tool = delete $args{tool} || 'memcheck';
56 $tool = __PACKAGE__ . "::$tool" if $tool !~ /::/;
57 $class->_croak("Couldn't load tool $tool: $@") unless eval "require $tool; 1";
58 return $tool->new(%args);
61 $class->SUPER::new(@_);
66 Creates a new tool object suitable for generating suppressions.
68 Defaults to return C<undef>, which skips suppression generation.
74 =head2 C<parser_class $session>
76 Returns the class from which the parser for this tool output will be instanciated.
78 This method must be implemented when subclassing.
84 =head2 C<report_class $session>
86 Returns the class in which suppression reports generated by this tool will be blessed.
88 This method must be implemented when subclassing.
94 =head2 C<args $session>
96 Returns the list of tool-specific arguments that are to be passed to C<valgrind>.
97 All the suppression arguments are already handled by the session.
99 Defaults to the empty list.
105 =head2 C<suppressions_tag $session>
107 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.
109 This method must be implemented when subclassing.
113 sub suppressions_tag;
115 =head2 C<start $session>
117 Called when the C<$session> starts.
119 Defaults to set L<Test::Valgrind::Component/started>.
121 =head2 C<parse $session, $fh>
123 Wraps around either L</parse_suppressions> or L</parse_analysis> depending on the running mode of the C<$session>.
124 Croaks if the tool isn't started.
129 my ($self, $sess, $fh) = @_;
131 $self->_croak('Tool isn\'t started') unless $self->started;
133 if ($sess->do_suppressions) {
134 $self->parse_suppressions($sess, $fh);
136 $self->parse_analysis($sess, $fh);
140 =head2 C<parse_suppressions $sesssion, $fh>
142 Parse the suppression reports that the C<valgrind> process attached to the session C<$session> send through the filehandle C<$fh>.
144 This method must be implemented when subclassing.
148 sub parse_suppressions;
150 =head2 C<parse_analysis $sesssion, $fh>
152 Parse the error reports sent by the C<valgrind> process attached to the session C<$session> through the filehandle C<$fh>.
154 This method must be implemented when subclassing.
160 =head2 C<finish $session>
162 Called when the C<$session> finishes.
164 Defaults to clear L<Test::Valgrind::Component/started>.
168 L<Test::Valgrind>, L<Test::Valgrind::Component>, L<Test::Valgrind::Session>.
172 Vincent Pit, C<< <perl at profvince.com> >>, L<http://www.profvince.com>.
174 You can contact me by mail or on C<irc.perl.org> (vincent).
178 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>.
179 I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
183 You can find documentation for this module with the perldoc command.
185 perldoc Test::Valgrind::Tool
187 =head1 COPYRIGHT & LICENSE
189 Copyright 2009 Vincent Pit, all rights reserved.
191 This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
195 1; # End of Test::Valgrind::Tool