=head1 VERSION
-Version 1.02
+Version 1.17
=cut
-our $VERSION = '1.02';
+our $VERSION = '1.17';
=head1 DESCRIPTION
=cut
-use base qw/Test::Valgrind::Carp/;
+use Test::Valgrind::Util;
+
+use base qw<Test::Valgrind::Component Test::Valgrind::Carp>;
=head1 METHODS
=head2 C<requires_version>
+ my $required_version = $tvt->requires_version;
+
The minimum C<valgrind> version needed to run this tool.
Defaults to C<3.1.0>.
sub requires_version { '3.1.0' }
-=head2 C<< new tool => $tool >>
+=head2 C<new>
+
+ my $tvt = Test::Valgrind::Tool->new(tool => $tool);
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.
The class represented by C<$tool> must inherit this class.
my %args = @_;
if ($class eq __PACKAGE__) {
- my $tool = delete $args{tool} || 'memcheck';
- $tool =~ s/[^\w:]//g;
- $tool = __PACKAGE__ . "::$tool" if $tool !~ /::/;
- $class->_croak("Couldn't load tool $tool: $@") unless eval "require $tool; 1";
+ my ($tool, $msg) = Test::Valgrind::Util::validate_subclass(
+ delete $args{tool} || 'memcheck',
+ );
+ $class->_croak($msg) unless defined $tool;
return $tool->new(%args);
}
- bless { }, $class;
+ $class->SUPER::new(@_);
}
=head2 C<new_trainer>
+ my $tvt_train = Test::Valgrind::Tool->new_trainer;
+
Creates a new tool object suitable for generating suppressions.
Defaults to return C<undef>, which skips suppression generation.
sub new_trainer { }
-=head2 C<report_class $session>
-
-Wraps around either L</report_class_suppressions> or L</report_class_analysis> depending on the running mode of the C<$session>.
+=head2 C<parser_class>
-=cut
-
-sub report_class {
- my ($self, $sess) = @_;
-
- if ($sess->do_suppressions) {
- $self->report_class_suppressions($sess);
- } else {
- $self->report_class_analysis($sess);
- }
-}
+ my $parser_class = $tvt->parser_class($session);
-=head2 C<report_class_suppressions $session>
-
-Returns the class in which suppression reports generated by this tool will be blessed.
+Returns the class from which the parser for this tool output will be instanciated.
This method must be implemented when subclassing.
=cut
-sub report_class_suppression;
+sub parser_class;
-=head2 C<report_class_analysis $session>
+=head2 C<report_class>
-Returns the class in which error reports generated by this tool will be blessed.
+ my $report_class = $tvt->report_class($session);
+
+Returns the class in which suppression reports generated by this tool will be blessed.
This method must be implemented when subclassing.
=cut
-sub report_class_analysis;
+sub report_class;
+
+=head2 C<args>
-=head2 C<args $session>
+ my @args = $tvt->args($session);
Returns the list of tool-specific arguments that are to be passed to C<valgrind>.
All the suppression arguments are already handled by the session.
=cut
-sub args { }
+sub args { }
-=head2 C<suppressions_tag $session>
+=head2 C<suppressions_tag>
+
+ my $tag = $tvt->suppressions_tag($session);
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.
sub suppressions_tag;
-=head2 C<start $session>
-
-Called when the C<$session> starts.
+=head2 C<start>
-Defaults to void.
+ $tvt->start($session);
-=cut
-
-sub start { }
-
-=head2 C<parse $session, $fh>
-
-Wraps around either L</parse_suppressions> or L</parse_analysis> depending on the running mode of the C<$session>.
-
-=cut
+Called when the C<$session> starts.
-sub parse {
- my ($self, $sess, $fh) = @_;
+Defaults to set L<Test::Valgrind::Component/started>.
- if ($sess->do_suppressions) {
- $self->parse_suppressions($sess, $fh);
- } else {
- $self->parse_analysis($sess, $fh);
- }
-}
+=head2 C<filter>
-=head2 C<parse_suppressions $sesssion, $fh>
+ my $filtered_report = $tvt->filter($session, $report);
-Parse the suppression reports that the C<valgrind> process attached to the session C<$session> send through the filehandle C<$fh>.
+The C<$session> calls this method after receiving a report from the parser and before letting the command filter it.
+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.
-This method must be implemented when subclassing.
+Defaults to the identity function.
=cut
-sub parse_suppressions;
+sub filter { $_[2] }
-=head2 C<parse_analysis $sesssion, $fh>
+=head2 C<finish>
-Parse the error reports sent by the C<valgrind> process attached to the session C<$session> through the filehandle C<$fh>.
-
-This method must be implemented when subclassing.
-
-=cut
-
-sub parse_analysis;
-
-=head2 C<finish $session>
+ $tvt->finish($session);
Called when the C<$session> finishes.
-Defaults to void.
-
-=cut
-
-sub finish { }
+Defaults to clear L<Test::Valgrind::Component/started>.
=head1 SEE ALSO
-L<Test::Valgrind>, L<Test::Valgrind::Session>.
+L<Test::Valgrind>, L<Test::Valgrind::Component>, L<Test::Valgrind::Session>.
=head1 AUTHOR
=head1 COPYRIGHT & LICENSE
-Copyright 2009 Vincent Pit, all rights reserved.
+Copyright 2009,2010,2011,2013,2015 Vincent Pit, all rights reserved.
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
projects / perl / modules / Test-Valgrind.git / blobdiff