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.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> parsers.
  21
  22 =cut
  23
  24 use base qw/Test::Valgrind::Component Test::Valgrind::Carp/;
  25
  26 =head1 METHODS
  27
  28 =head2 C<new>
  29
  30 The parser constructor, called without arguments.
  31
  32 Defaults to L<Test::Valgrind::Component/new>.
  33
  34 =head2 C<start $session>
  35
  36 Called when the C<$session> starts.
  37
  38 Defaults to set L<Test::Valgrind::Component/started>.
  39
  40 =head2 C<args $session, $fh>
  41
  42 Returns the list of parser-specific arguments that are to be passed to the C<valgrind> process spawned by the session C<$session> and whose output will be captured by the filehandle C<$fh>.
  43
  44 Defaults to the empty list.
  45
  46 =cut
  47
  48 sub args { }
  49
  50 =head2 C<parse $session, $fh>
  51
  52 Parse the output of the C<valgrind> process attached to the session C<$session> received through the filehandle C<$fh>.
  53
  54 This method must be implemented when subclassing.
  55
  56 =cut
  57
  58 sub parse;
  59
  60 =head2 C<finish $session>
  61
  62 Called when the C<$session> finishes.
  63
  64 Defaults to clear L<Test::Valgrind::Component/started>.
  65
  66 =head1 SEE ALSO
  67
  68 L<Test::Valgrind>, L<Test::Valgrind::Component>, L<Test::Valgrind::Session>.
  69
  70 =head1 AUTHOR
  71
  72 Vincent Pit, C<< <perl at profvince.com> >>, L<http://www.profvince.com>.
  73
  74 You can contact me by mail or on C<irc.perl.org> (vincent).
  75
  76 =head1 BUGS
  77
  78 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>.
  79 I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
  80
  81 =head1 SUPPORT
  82
  83 You can find documentation for this module with the perldoc command.
  84
  85     perldoc Test::Valgrind::Parser
  86
  87 =head1 COPYRIGHT & LICENSE
  88
  89 Copyright 2009 Vincent Pit, all rights reserved.
  90
  91 This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
  92
  93 =cut
  94
  95 1; # End of Test::Valgrind::Parser