lib/Test/Valgrind/Command.pm

   1 package Test::Valgrind::Command;
   2
   3 use strict;
   4 use warnings;
   5
   6 =head1 NAME
   7
   8 Test::Valgrind::Command - Base class for Test::Valgrind commands.
   9
  10 =head1 VERSION
  11
  12 Version 1.18
  13
  14 =cut
  15
  16 our $VERSION = '1.18';
  17
  18 =head1 DESCRIPTION
  19
  20 This class is the base for L<Test::Valgrind> commands.
  21
  22 Commands gather information about the target of the analysis.
  23 They should also provide a default setup for generating suppressions.
  24
  25 =cut
  26
  27 use Test::Valgrind::Util;
  28
  29 use base qw<Test::Valgrind::Carp>;
  30
  31 =head1 METHODS
  32
  33 =head2 C<new>
  34
  35     my $tvc = Test::Valgrind::Command->new(
  36      command => $command,
  37      args    => \@args,
  38     );
  39
  40 Creates a new command object of type C<$command> by requiring and redispatching the method call to the module named C<$command> if it contains C<'::'> or to C<Test::Valgrind::Command::$command> otherwise.
  41 The class represented by C<$command> must inherit this class.
  42
  43 The C<args> key is used to initialize the L</args> accessor.
  44
  45 =cut
  46
  47 sub new {
  48  my $class = shift;
  49  $class = ref($class) || $class;
  50
  51  my %args = @_;
  52
  53  my $cmd = delete $args{command};
  54  if ($class eq __PACKAGE__ and defined $cmd) {
  55   ($cmd, my $msg) = Test::Valgrind::Util::validate_subclass($cmd);
  56   $class->_croak($msg) unless defined $cmd;
  57   return $cmd->new(%args);
  58  }
  59
  60  my $args = delete $args{args};
  61  $class->_croak('Invalid argument list') if $args and ref $args ne 'ARRAY';
  62
  63  bless {
  64   args => $args,
  65  }, $class;
  66 }
  67
  68 =head2 C<new_trainer>
  69
  70 Creates a new command object suitable for generating suppressions.
  71
  72 Defaults to return C<undef>, which skips suppression generation.
  73
  74 =cut
  75
  76 sub new_trainer { }
  77
  78 =head2 C<args>
  79
  80     my @args = $tvc->args($session);
  81
  82 Returns the list of command-specific arguments that are to be passed to C<valgrind>.
  83
  84 Defaults to return the contents of the C<args> option.
  85
  86 =cut
  87
  88 sub args { @{$_[0]->{args} || []} }
  89
  90 =head2 C<env>
  91
  92     my $env = $tvc->env($session);
  93
  94 This event is called in scalar context before the command is ran, and the returned value goes out of scope when the analysis ends.
  95 It's useful for e.g. setting up C<%ENV> for the child process by returning an L<Env::Sanctify> object, hence the name.
  96
  97 Defaults to void.
  98
  99 =cut
 100
 101 sub env { }
 102
 103 =head2 C<suppressions_tag>
 104
 105     my $tag = $tvc->suppressions_tag($session);
 106
 107 Returns a identifier that will be used to pick up the right suppressions for running the command, 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<check_suppressions_file>
 116
 117     my $supp_ok = $tvc->check_suppressions_file($file);
 118
 119 Returns a boolean indicating whether the suppressions contained in C<$file> are compatible with the command.
 120
 121 Defaults to true.
 122
 123 =cut
 124
 125 sub check_suppressions_file { 1 }
 126
 127 =head2 C<filter>
 128
 129     my $filtered_report = $tvc->filter($session, $report);
 130
 131 The C<$session> calls this method after receiving a report from the tool and before forwarding it to the action.
 132 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.
 133
 134 Defaults to the identity function.
 135
 136 =cut
 137
 138 sub filter { $_[2] }
 139
 140 =head1 SEE ALSO
 141
 142 L<Test::Valgrind>, L<Test::Valgrind::Session>.
 143
 144 =head1 AUTHOR
 145
 146 Vincent Pit, C<< <perl at profvince.com> >>, L<http://www.profvince.com>.
 147
 148 You can contact me by mail or on C<irc.perl.org> (vincent).
 149
 150 =head1 BUGS
 151
 152 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>.
 153 I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
 154
 155 =head1 SUPPORT
 156
 157 You can find documentation for this module with the perldoc command.
 158
 159     perldoc Test::Valgrind::Command
 160
 161 =head1 COPYRIGHT & LICENSE
 162
 163 Copyright 2009,2010,2011,2013,2015,2016 Vincent Pit, all rights reserved.
 164
 165 This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
 166
 167 =cut
 168
 169 1; # Test::Valgrind::Command