About this Document This is the PPI manual. It describes its reason for existing, its general structure, its use, an overview of the API, and provides a few implementation samples. Background The ability to read, and manipulate Perl (the language) pr...

PPI::XS provides XS-based acceleration of the core PPI packages. It selectively replaces a (small but growing) number of methods throughout PPI with identical but much faster C versions. Once installed, it will be auto-detected and loaded in by PPI c...

The "PPI::Node" class provides an abstract base class for the Element classes that are able to contain other elements PPI::Document, PPI::Statement, and PPI::Structure. As well as those listed below, all of the methods that apply to PPI::Element obje...

PPI::Find is the primary PDOM searching class in the core PPI package. History It became quite obvious during the development of PPI that many of the modules that would be built on top of it were going to need large numbers of saved, storable or easi...

PPI::HTML converts Perl documents into syntax highlighted HTML pages....

"PPI::Token" is the abstract base class for all Tokens. In PPI terms, a "Token" is a PPI::Element that directly represents bytes of source code....

The is the PPI Lexer. In the larger scheme of things, its job is to take token streams, in a variety of forms, and "lex" them into nested structures. Pretty much everything in this module happens behind the scenes at this point. In fact, at the momen...

"PPI::Cache" provides the default caching functionality for PPI. It integrates automatically with PPI itself. Once enabled, any attempt to load a document from the filesystem will be cached via cache. Please note that creating a PPI::Document from ra...

The PDOM trees in PPI are quite complex, and getting a dump of their structure for development and debugging purposes is important. This module provides that functionality. The process is relatively simple. Create a dumper object with a particular se...

The abstract "PPI::Element" serves as a base class for all source-related objects, from a single whitespace token to an entire document. It provides a basic set of methods to provide a common interface and basic implementations....

The "PPI::Document" class represents a single Perl "document". A "PPI::Document" object acts as a root PPI::Node, with some additional methods for loading and saving, and working with the line/column locations of Elements within a file. The exemption...

"PPI::Transform" provides an API for the creation of classes and objects that modify or transform PPI documents....

PPI::Structure is the root class for all Perl bracing structures. This covers all forms of " [ ... ] ", " { ... } ", and " ( ... ) " brace types, and includes cases where only one half of the pair exist. The class PPI::Structure itself is full abstra...

PPI::Statement is the root class for all Perl statements. This includes (from perlsyn) "Declarations", "Simple Statements" and "Compound Statements". The class PPI::Statement itself represents a "Simple Statement" as defined in the perlsyn manpage....

PPI::Tokenizer is the class that provides Tokenizer objects for use in breaking strings of Perl source code into Tokens. By the time you are reading this, you probably need to know a little about the difference between how perl parses Perl "code" and...

All exceptions thrown from within PPI will be instances or derivations of this class....

The PPI PowerToys are a small collection of utilities for working with Perl files, modules and distributions. To kick off the collection, he's added a very simple and raw version of one of his own little tools. ppi_version > ppi_version show > ppi_ve...

use PPI::Xref; my $xref = PPI::Xref->new(); # Constructor. PPI::Xref can be used to process files of Perl code or Perl code as a string, and then generate cross-references of its contents. The code is never executed, only parsed as a document tree. N...

This package implements a wxWindows desktop application which provides the ability to interactively test the PPI perl parser. The "PPI::Tester" module implements the application, but is itself of no use to the user. The launcher for the application '...