/usr/share/perl5/Test/Valgrind/Tool.pm is in libtest-valgrind-perl 1.18-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 | package Test::Valgrind::Tool;
use strict;
use warnings;
=head1 NAME
Test::Valgrind::Tool - Base class for Test::Valgrind tools.
=head1 VERSION
Version 1.18
=cut
our $VERSION = '1.18';
=head1 DESCRIPTION
This class is the base for L<Test::Valgrind> tools.
They wrap around C<valgrind> tools by parsing its output and sending reports to the parent session whenever an error occurs.
They are expected to function both in suppressions generation and in analysis mode.
=cut
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>.
=cut
sub requires_version { '3.1.0' }
=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.
=cut
sub new {
my $class = shift;
$class = ref($class) || $class;
my %args = @_;
if ($class eq __PACKAGE__) {
my ($tool, $msg) = Test::Valgrind::Util::validate_subclass(
delete $args{tool} || 'memcheck',
);
$class->_croak($msg) unless defined $tool;
return $tool->new(%args);
}
$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.
=cut
sub new_trainer { }
=head2 C<parser_class>
my $parser_class = $tvt->parser_class($session);
Returns the class from which the parser for this tool output will be instanciated.
This method must be implemented when subclassing.
=cut
sub parser_class;
=head2 C<report_class>
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;
=head2 C<args>
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.
Defaults to the empty list.
=cut
sub args { }
=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.
This method must be implemented when subclassing.
=cut
sub suppressions_tag;
=head2 C<start>
$tvt->start($session);
Called when the C<$session> starts.
Defaults to set L<Test::Valgrind::Component/started>.
=head2 C<filter>
my $filtered_report = $tvt->filter($session, $report);
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.
Defaults to the identity function.
=cut
sub filter { $_[2] }
=head2 C<finish>
$tvt->finish($session);
Called when the C<$session> finishes.
Defaults to clear L<Test::Valgrind::Component/started>.
=head1 SEE ALSO
L<Test::Valgrind>, L<Test::Valgrind::Component>, L<Test::Valgrind::Session>.
=head1 AUTHOR
Vincent Pit, C<< <perl at profvince.com> >>, L<http://www.profvince.com>.
You can contact me by mail or on C<irc.perl.org> (vincent).
=head1 BUGS
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>.
I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
=head1 SUPPORT
You can find documentation for this module with the perldoc command.
perldoc Test::Valgrind::Tool
=head1 COPYRIGHT & LICENSE
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.
=cut
1; # End of Test::Valgrind::Tool
|