lib/Test/Valgrind/Parser.pm

   1 package Test::Valgrind::Parser;
   2
   3 use strict;
   4 use warnings;
   5
   6 =head1 NAME
   7
   8 Test::Valgrind::Parser - Base class for Test::Valgrind parsers.
   9
  10 =head1 VERSION
  11
  12 Version 1.02
  13
  14 =cut
  15
  16 our $VERSION = '1.02';
  17
  18 =head1 DESCRIPTION
  19
  20 This class is the base for L<Test::Valgrind> parsers.
  21
  22 =cut
  23
  24 use base qw/Test::Valgrind::Carp/;
  25
  26 =head1 METHODS
  27
  28 =head2 C<new>
  29
  30 =cut
  31
  32 sub new {
  33  my $class = shift;
  34  $class = ref($class) || $class;
  35
  36  bless { }, $class;
  37 }
  38
  39 =head2 C<args $session, $fh>
  40
  41 Returns the list of parser-specific arguments that are to be passed to C<valgrind>.
  42
  43 Defaults to the empty list.
  44
  45 =cut
  46
  47 sub args { }
  48
  49 =head2 C<parse $session, $fh>
  50
  51 This method must be implemented when subclassing.
  52
  53 =cut
  54
  55 sub parse;
  56
  57 =head1 SEE ALSO
  58
  59 L<Test::Valgrind>, L<Test::Valgrind::Session>.
  60
  61 =head1 AUTHOR
  62
  63 Vincent Pit, C<< <perl at profvince.com> >>, L<http://www.profvince.com>.
  64
  65 You can contact me by mail or on C<irc.perl.org> (vincent).
  66
  67 =head1 BUGS
  68
  69 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>.
  70 I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
  71
  72 =head1 SUPPORT
  73
  74 You can find documentation for this module with the perldoc command.
  75
  76     perldoc Test::Valgrind::Parser
  77
  78 =head1 COPYRIGHT & LICENSE
  79
  80 Copyright 2009 Vincent Pit, all rights reserved.
  81
  82 This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
  83
  84 =cut
  85
  86 1; # End of Test::Valgrind::Parser