In the parent process, L</import> calls L</analyse> with the arguments it received itself - except that if no C<file> option was supplied, it tries to pick the first caller context that looks like a script.
When the analysis ends, it exits with the status returned by the action (for the default TAP-generator action, it's the number of failed tests).
In the parent process, L</import> calls L</analyse> with the arguments it received itself - except that if no C<file> option was supplied, it tries to pick the first caller context that looks like a script.
When the analysis ends, it exits with the status returned by the action (for the default TAP-generator action, it's the number of failed tests).
@@ -27,7+27,9 @@ use base qw<Test::Valgrind::Component Test::Valgrind::Carp>;
=head1 METHODS
=head1 METHODS
-=head2 C<< new action => $action >>
+=head2 C<new>
+
+ my $tva = Test::Valgrind::Action->new(action => $action);
Creates a new action object of type C<$action> by requiring and redispatching the method call to the module named C<$action> if it contains C<'::'> or to C<Test::Valgrind::Action::$action> otherwise.
The class represented by C<$action> must inherit this class.
Creates a new action object of type C<$action> by requiring and redispatching the method call to the module named C<$action> if it contains C<'::'> or to C<Test::Valgrind::Action::$action> otherwise.
The class represented by C<$action> must inherit this class.
@@ -60,13+62,17 @@ Indicates if the action wants C<valgrind> to run in suppression-generating mode
sub do_suppressions { 0 }
sub do_suppressions { 0 }
-=head2 C<start $session>
+=head2 C<start>
+
+ $tva->start($session);
Called when the C<$session> starts.
Defaults to set L<Test::Valgrind::Component/started>.
Called when the C<$session> starts.
Defaults to set L<Test::Valgrind::Component/started>.
-=head2 C<report $session, $report>
+=head2 C<report>
+
+ $tva->report($session, $report);
Invoked each time the C<valgrind> process attached to the C<$session> spots an error.
C<$report> is a L<Test::Valgrind::Report> object describing the error.
Invoked each time the C<valgrind> process attached to the C<$session> spots an error.
C<$report> is a L<Test::Valgrind::Report> object describing the error.
@@ -28,7+28,12 @@ use base qw<Test::Valgrind::Carp>;
=head1 METHODS
=head1 METHODS
-=head2 C<< new command => $command, args => \@args >>
+=head2 C<new>
+
+ my $tvc = Test::Valgrind::Command->new(
+ command => $command,
+ args => \@args,
+ );
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.
The class represented by C<$command> must inherit this class.
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.
The class represented by C<$command> must inherit this class.
@@ -68,7+73,9 @@ Defaults to return C<undef>, which skips suppression generation.
sub new_trainer { }
sub new_trainer { }
-=head2 C<args $session>
+=head2 C<args>
+
+ my @args = $tvc->args($session);
Returns the list of command-specific arguments that are to be passed to C<valgrind>.
Returns the list of command-specific arguments that are to be passed to C<valgrind>.
@@ -78,7+85,9 @@ Defaults to return the contents of the C<args> option.
sub args { @{$_[0]->{args} || []} }
sub args { @{$_[0]->{args} || []} }
-=head2 C<env $session>
+=head2 C<env>
+
+ my $env = $tvc->env($session);
This event is called in scalar context before the command is ran, and the returned value goes out of scope when the analysis ends.
It's useful for e.g. setting up C<%ENV> for the child process by returning an L<Env::Sanctify> object, hence the name.
This event is called in scalar context before the command is ran, and the returned value goes out of scope when the analysis ends.
It's useful for e.g. setting up C<%ENV> for the child process by returning an L<Env::Sanctify> object, hence the name.
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.
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.
@@ -99,7+110,9 @@ This method must be implemented when subclassing.
sub suppressions_tag;
sub suppressions_tag;
-=head2 C<filter $session, $report>
+=head2 C<filter>
+
+ my $filtered_report = $tvc->filter($session, $report);
The C<$session> calls this method after receiving a report from the tool and before forwarding it to the action.
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.
The C<$session> calls this method after receiving a report from the tool and before forwarding it to the action.
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.
@@ -27,17+27,23 @@ use base qw<Test::Valgrind::Component Test::Valgrind::Carp>;
=head2 C<new>
=head2 C<new>
+ my $tvp = Test::Valgrind::Parser->new;
+
The parser constructor, called without arguments.
Defaults to L<Test::Valgrind::Component/new>.
The parser constructor, called without arguments.
Defaults to L<Test::Valgrind::Component/new>.
-=head2 C<start $session>
+=head2 C<start>
+
+ $tvp->start($session);
Called when the C<$session> starts.
Defaults to set L<Test::Valgrind::Component/started>.
Called when the C<$session> starts.
Defaults to set L<Test::Valgrind::Component/started>.
-=head2 C<args $session, $fh>
+=head2 C<args>
+
+ my @args = $tvp->args($session, $fh);
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>.
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>.
Generates suppressions for the command C<< $command->new_trainer >> and the tool C<< $tool->new_trainer >>, and writes them in the file specified by C<$target>.
The action used behind the scenes is L<Test::Valgrind::Action::Suppressions>.
Generates suppressions for the command C<< $command->new_trainer >> and the tool C<< $tool->new_trainer >>, and writes them in the file specified by C<$target>.
The action used behind the scenes is L<Test::Valgrind::Action::Suppressions>.
+ 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.
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.
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.
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.
@@ -112,13+126,17 @@ This method must be implemented when subclassing.
sub suppressions_tag;
sub suppressions_tag;
-=head2 C<start $session>
+=head2 C<start>
+
+ $tvt->start($session);
Called when the C<$session> starts.
Defaults to set L<Test::Valgrind::Component/started>.
Called when the C<$session> starts.
Defaults to set L<Test::Valgrind::Component/started>.
-=head2 C<filter $session, $report>
+=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.
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.
@@ -129,7+147,9 @@ Defaults to the identity function.
sub suppressions_tag { 'memcheck-' . $_[1]->version }
sub suppressions_tag { 'memcheck-' . $_[1]->version }
-=head2 C<parser_class $session>
+=head2 C<parser_class>
+
+ my $parser_class = $tvtm->parser_class($session);
This tool uses a L<Test::Valgrind::Parser::XML::Twig> parser in analysis mode, and a L<Test::Valgrind::Parser::Suppressions::Text> parser in suppressions mode.
This tool uses a L<Test::Valgrind::Parser::XML::Twig> parser in analysis mode, and a L<Test::Valgrind::Parser::Suppressions::Text> parser in suppressions mode.
+ my $report_class = $tvtm->report_class($session);
This tool emits C<Test::Valgrind::Tool::memcheck::Report> object reports in analysis mode, and C<Test::Valgrind::Report::Suppressions> object reports in suppressions mode.
This tool emits C<Test::Valgrind::Tool::memcheck::Report> object reports in analysis mode, and C<Test::Valgrind::Report::Suppressions> object reports in suppressions mode.
projects / perl / modules / Test-Valgrind.git / commitdiff