]> git.vpit.fr Git - perl/modules/Test-Valgrind.git/blobdiff - lib/Test/Valgrind/Tool.pm
This is 1.10
[perl/modules/Test-Valgrind.git] / lib / Test / Valgrind / Tool.pm
index a82b95d676632a0f65c0e6d632375908b6ab3105..7560d52217e64663a11af909a9102c1ac70ae934 100644 (file)
@@ -9,11 +9,11 @@ Test::Valgrind::Tool - Base class for Test::Valgrind tools.
 
 =head1 VERSION
 
-Version 1.02
+Version 1.10
 
 =cut
 
-our $VERSION = '1.02';
+our $VERSION = '1.10';
 
 =head1 DESCRIPTION
 
@@ -71,41 +71,25 @@ 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>.
-
-=cut
-
-sub report_class {
- my ($self, $sess) = @_;
-
- if ($sess->do_suppressions) {
-  $self->report_class_suppressions($sess);
- } else {
-  $self->report_class_analysis($sess);
- }
-}
+=head2 C<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 $session>
 
-Returns the class in which error reports generated by this tool will be blessed.
+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 $session>
 
@@ -134,44 +118,16 @@ Called when the C<$session> starts.
 
 Defaults to set L<Test::Valgrind::Component/started>.
 
-=head2 C<parse $session, $fh>
-
-Wraps around either L</parse_suppressions> or L</parse_analysis> depending on the running mode of the C<$session>.
-Croaks if the tool isn't started.
-
-=cut
+=head2 C<filter $session, $report>
 
-sub parse {
- my ($self, $sess, $fh) = @_;
+The <$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.
 
- $self->_croak('Tool isn\'t started') unless $self->started;
-
- if ($sess->do_suppressions) {
-  $self->parse_suppressions($sess, $fh);
- } else {
-  $self->parse_analysis($sess, $fh);
- }
-}
-
-=head2 C<parse_suppressions $sesssion, $fh>
-
-Parse the suppression reports that the C<valgrind> process attached to the session C<$session> send through the filehandle C<$fh>.
-
-This method must be implemented when subclassing.
-
-=cut
-
-sub parse_suppressions;
-
-=head2 C<parse_analysis $sesssion, $fh>
-
-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.
+Defaults to the identity function.
 
 =cut
 
-sub parse_analysis;
+sub filter { $_[2] }
 
 =head2 C<finish $session>