PPIx::EditorTools::Lexer(3pm)

PPIx::EditorTools::Lexer3pm

Simple lexer used for syntax highlighting

Usage

  PPIx::EditorTools::Lexer->new->lexer(
        code => "package TestPackage;\nsub x { 1;\n",
        highlighter => sub {
                my ( $css, $row, $rowchar, $len ) = @_;
                ...
        },
      );

Version

version 0.21

Overview

Go over the various interesting elements of a give piece of code or an already process PPI tree. For each token call the user supplied 'highlighter' function with the follow values:

  $css     - The keyword that can be used for colouring.
  $row     - The row number where the token starts
  $rowchar - The character within that row where the token starts
  $len     - The length of the token

Methods

new()

Constructor. Generally shouldn't be called with any arguments.

find( ppi => PPI::Document $ppi, highlighter => sub {...} )
find( code => Str $code, highlighter => sub ...{} )

Accepts either a "PPI::Document" to process or a string containing the code (which will be converted into a "PPI::Document") to process. Return a reference to an array.

Releases

7 releases since Debian 7 (Wheezy); the text changed 3 times.

  1. 7
  2. 8–9
  3. 10–11
  4. 12–13