Linux Certif

Toute la documentation sur la certification Linux LPI

Padre::Task::PPI.3pm

NAME

Padre::Task::PPI - Generic PPI background processing task

SYNOPSIS

   package Padre::Task::PPI::MyFancyTest;
   use base 'Padre::Task::PPI';
 
   # will be called after ppi-parsing:
   sub process_ppi  {
           my $self = shift;
           my $ppi  = shift or return;
           my $result = ...expensive_calculation_using_ppi...
           $self->{result} = $result;
           return();
   },
 
   sub finish {
           my $self = shift;
           my $result = $self->{result};
           # update GUI here...
   };
 
   1;
 
   # elsewhere:
 
   # by default, the text of the current document
   # will be fetched.
   my $task = Padre::Task::PPI::MyFancyTest->new();
   $task->schedule;
 
   my $task2 = Padre::Task::PPI::MyFancyTest->new(
     text => 'parse-this!',
   );
   $task2->schedule;
 
 

DESCRIPTION

This is a base class for all tasks that need to do expensive calculations using PPI. The class will setup a PPI::Document object from a given piece of code and then call the "process_ppi" method on the task object and pass the PPI::Document as first argument.

You can either let "Padre::Task::PPI" fetch the Perl code for parsing from the current document or specify it as the ""text"" parameter to the constructor.

Note: If you don't supply the document text and there is no currently open document to fetch it from, "new()" will simply return the empty list instead of a "Padre::Task::PPI" object.

SEE ALSO

This class inherits from "Padre::Task" and its instances can be scheduled using "Padre::TaskManager".

The transfer of the objects to and from the worker threads is implemented with Storable.

AUTHOR

Steffen Mueller "smueller@cpan.org"

COPYRIGHT AND LICENSE

Copyright 2008-2010 The Padre development team as listed in Padre.pm.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl 5 itself.