App::Grepl::Results - PPI-powered grep results object
Version 0.01
OO interface to grepl's results
use App::Grepl::Results; my $found = App::Grepl::Results->new( { file => $file, } ); $found->add_results( $token => \@results ); print $found->file, "\n"; while ( my $result = $found->next ) { print $result->token, "matched:\n"; while ( my $item = $result->next ) { print "\t$item\n"; } }
new
my $grepl = App::Grepl::Results->new( { file => $file } );
file
my $file = $result->file; $result->file($file);
Get or set the filename the results pertain to. Will croak if the file does not exist.
croak
have_results
if ( $found->have_results ) { ... }
Boolean accessor indicating if we have results for the search.
add_results
$found->add_results( 'heredoc' => \@array_ref_of_strings );
Add results to the result object. Takes two arguments:
token
This should be a string representing the result type (e.g., comment, pod, etc).
comment
pod
Will croak if App::Grepl does not recognize the result type.
App::Grepl
results
This should be an array reference of strings. These are the actual results.
Will croak if something other than an array reference is passed.
filename_only
if ( $result->filename_only ) { ... } $result->filename_only(1);
A boolean getter/setter for whether or not results are 'filename only'. These are returned to indicated that a file matched the criteria. The actual matches will not be returned.
next
while ( defined ( my $result = $found->next ) ) { ... }
Returns the next result found.
Will croak if results are requested from a 'filename_only' object.
Note that the iterator is destructive.
Curtis Poe, <ovid at cpan.org>
<ovid at cpan.org>
Please report any bugs or feature requests to bug-app-grepl at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=App-Grepl. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
bug-app-grepl at rt.cpan.org
You can find documentation for this module with the perldoc command.
perldoc App::Grepl::Results
You can also look for information at:
AnnoCPAN: Annotated CPAN documentation
http://annocpan.org/dist/App-Grepl
CPAN Ratings
http://cpanratings.perl.org/d/App-Grepl
RT: CPAN's request tracker
http://rt.cpan.org/NoAuth/Bugs.html?Dist=App-Grepl
Search CPAN
http://search.cpan.org/dist/App-Grepl
Copyright 2007 Curtis Poe, all rights reserved.
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
To install App::Grepl, copy and paste the appropriate command in to your terminal.
cpanm
cpanm App::Grepl
CPAN shell
perl -MCPAN -e shell install App::Grepl
For more information on module installation, please visit the detailed CPAN module installation guide.