lib/Test/Valgrind/Tool.pm

   1 package Test::Valgrind::Tool;
   2
   3 use strict;
   4 use warnings;
   5
   6 =head1 NAME
   7
   8 Test::Valgrind::Tool - Base class for Test::Valgrind tools.
   9
  10 =head1 VERSION
  11
  12 Version 1.10
  13
  14 =cut
  15
  16 our $VERSION = '1.10';
  17
  18 =head1 DESCRIPTION
  19
  20 This class is the base for L<Test::Valgrind> tools.
  21
  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.
  24
  25 =cut
  26
  27 use base qw/Test::Valgrind::Component Test::Valgrind::Carp/;
  28
  29 =head1 METHODS
  30
  31 =head2 C<requires_version>
  32
  33 The minimum C<valgrind> version needed to run this tool.
  34 Defaults to C<3.1.0>.
  35
  36 =cut
  37
  38 sub requires_version { '3.1.0' }
  39
  40 =head2 C<< new tool => $tool >>
  41
  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.
  44
  45 =cut
  46
  47 sub new {
  48  my $class = shift;
  49  $class = ref($class) || $class;
  50
  51  my %args = @_;
  52
  53  if ($class eq __PACKAGE__) {
  54   my $tool = delete $args{tool} || 'memcheck';
  55   $tool =~ s/[^\w:]//g;
  56   $tool = __PACKAGE__ . "::$tool" if $tool !~ /::/;
  57   $class->_croak("Couldn't load tool $tool: $@") unless eval "require $tool; 1";
  58   return $tool->new(%args);
  59  }
  60
  61  $class->SUPER::new(@_);
  62 }
  63
  64 =head2 C<new_trainer>
  65
  66 Creates a new tool object suitable for generating suppressions.
  67
  68 Defaults to return C<undef>, which skips suppression generation.
  69
  70 =cut
  71
  72 sub new_trainer { }
  73
  74 =head2 C<parser_class $session>
  75
  76 Returns the class from which the parser for this tool output will be instanciated.
  77
  78 This method must be implemented when subclassing.
  79
  80 =cut
  81
  82 sub parser_class;
  83
  84 =head2 C<report_class $session>
  85
  86 Returns the class in which suppression reports generated by this tool will be blessed.
  87
  88 This method must be implemented when subclassing.
  89
  90 =cut
  91
  92 sub report_class;
  93
  94 =head2 C<args $session>
  95
  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.
  98
  99 Defaults to the empty list.
 100
 101 =cut
 102
 103 sub args { }
 104
 105 =head2 C<suppressions_tag $session>
 106
 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.
 108
 109 This method must be implemented when subclassing.
 110
 111 =cut
 112
 113 sub suppressions_tag;
 114
 115 =head2 C<start $session>
 116
 117 Called when the C<$session> starts.
 118
 119 Defaults to set L<Test::Valgrind::Component/started>.
 120
 121 =head2 C<filter $session, $report>
 122
 123 The C<$session> calls this method after receiving a report from the parser and before letting the command filter it.
 124 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.
 125
 126 Defaults to the identity function.
 127
 128 =cut
 129
 130 sub filter { $_[2] }
 131
 132 =head2 C<finish $session>
 133
 134 Called when the C<$session> finishes.
 135
 136 Defaults to clear L<Test::Valgrind::Component/started>.
 137
 138 =head1 SEE ALSO
 139
 140 L<Test::Valgrind>, L<Test::Valgrind::Component>, L<Test::Valgrind::Session>.
 141
 142 =head1 AUTHOR
 143
 144 Vincent Pit, C<< <perl at profvince.com> >>, L<http://www.profvince.com>.
 145
 146 You can contact me by mail or on C<irc.perl.org> (vincent).
 147
 148 =head1 BUGS
 149
 150 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>.
 151 I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
 152
 153 =head1 SUPPORT
 154
 155 You can find documentation for this module with the perldoc command.
 156
 157     perldoc Test::Valgrind::Tool
 158
 159 =head1 COPYRIGHT & LICENSE
 160
 161 Copyright 2009 Vincent Pit, all rights reserved.
 162
 163 This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
 164
 165 =cut
 166
 167 1; # End of Test::Valgrind::Tool