GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  PADRE::TASK::PPI (3)

.ds Aq ’

NAME

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

CONTENTS

SYNOPSIS



  package Padre::Task::MyFancyTest;
 
  use strict;
  use base Padre::Task::PPI;
 
  # Will be called after ppi-parsing:
  sub process {
      my $self   = shift;
      my $ppi    = shift or return;
      my $result = ...expensive_calculation_using_ppi...
      $self->{result} = $result;
      return;
  }
 
  1;
 
  # elsewhere:
 
  Padre::Task::MyFancyTest->new(
      text => parse-this!,
  )->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-2013 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.

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 PADRE::TASK::PPI (3) 2013-11-09

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.