File Coverage

blib/lib/Test/Valgrind/Parser.pm
Criterion Covered Total %
statement 9 9 100.0
branch n/a
condition n/a
subroutine 4 4 100.0
pod 1 1 100.0
total 14 14 100.0


line stmt bran cond sub pod time code
1             package Test::Valgrind::Parser;
2              
3 4     4   96568 use strict;
  4         10  
  4         98  
4 4     4   20 use warnings;
  4         8  
  4         180  
5              
6             =head1 NAME
7              
8             Test::Valgrind::Parser - Base class for Test::Valgrind parsers.
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 parsers.
21              
22             =cut
23              
24 4     4   22 use base qw;
  4         8  
  4         468  
25              
26             =head1 METHODS
27              
28             =head2 C
29              
30             my $tvp = Test::Valgrind::Parser->new;
31              
32             The parser constructor, called without arguments.
33              
34             Defaults to L.
35              
36             =head2 C
37              
38             $tvp->start($session);
39              
40             Called when the C<$session> starts.
41              
42             Defaults to set L.
43              
44             =head2 C
45              
46             my @args = $tvp->args($session, $fh);
47              
48             Returns the list of parser-specific arguments that are to be passed to the C process spawned by the session C<$session> and whose output will be captured by the filehandle C<$fh>.
49              
50             Defaults to the empty list.
51              
52             =cut
53              
54       2 1   sub args { }
55              
56             =head2 C
57              
58             my $aborted = $tvp->parse($session, $fh);
59              
60             Parses the output of the C process attached to the session C<$session> received through the filehandle C<$fh>.
61             Returns true when the output indicates that C has aborted.
62              
63             This method must be implemented when subclassing.
64              
65             =cut
66              
67             sub parse;
68              
69             =head2 C
70              
71             $tvp->finish($session);
72              
73             Called when the C<$session> finishes.
74              
75             Defaults to clear L.
76              
77             =head1 SEE ALSO
78              
79             L, L, L.
80              
81             =head1 AUTHOR
82              
83             Vincent Pit, C<< >>, L.
84              
85             You can contact me by mail or on C (vincent).
86              
87             =head1 BUGS
88              
89             Please report any bugs or feature requests to C, or through the web interface at L.
90             I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
91              
92             =head1 SUPPORT
93              
94             You can find documentation for this module with the perldoc command.
95              
96             perldoc Test::Valgrind::Parser
97              
98             =head1 COPYRIGHT & LICENSE
99              
100             Copyright 2009,2010,2011,2013,2015 Vincent Pit, all rights reserved.
101              
102             This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
103              
104             =cut
105              
106             1; # End of Test::Valgrind::Parser