1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195
|
package PPIx::EditorTools::Lexer;
our $AUTHORITY = 'cpan:YANICK';
# ABSTRACT: Simple Lexer used for syntax highlighting
$PPIx::EditorTools::Lexer::VERSION = '0.21';
use 5.008;
use strict;
use warnings;
use Carp;
use base 'PPIx::EditorTools';
use Class::XSAccessor accessors => {};
use PPI;
sub lexer {
my ( $self, %args ) = @_;
my $markup = delete $args{highlighter};
$self->process_doc(%args);
my $ppi = $self->ppi;
return [] unless defined $ppi;
$ppi->index_locations;
my @tokens = $ppi->tokens;
foreach my $t (@tokens) {
my ( $row, $rowchar ) = @{ $t->location };
my $css = class_to_css($t);
my $len = $t->length;
$markup->( $css, $row, $rowchar, $len );
}
}
sub class_to_css {
my $Token = shift;
if ( $Token->isa('PPI::Token::Word') ) {
# There are some words we can be very confident are
# being used as keywords
unless ( $Token->snext_sibling and $Token->snext_sibling->content eq '=>' ) {
if ( $Token->content =~ /^(?:sub|return)$/ ) {
return 'keyword';
} elsif ( $Token->content =~ /^(?:undef|shift|defined|bless)$/ ) {
return 'core';
}
}
if ( $Token->previous_sibling and $Token->previous_sibling->content eq '->' ) {
if ( $Token->content =~ /^(?:new)$/ ) {
return 'core';
}
}
if ( $Token->parent->isa('PPI::Statement::Include') ) {
if ( $Token->content =~ /^(?:use|no)$/ ) {
return 'keyword';
}
if ( $Token->content eq $Token->parent->pragma ) {
return 'pragma';
}
} elsif ( $Token->parent->isa('PPI::Statement::Variable') ) {
if ( $Token->content =~ /^(?:my|local|our)$/ ) {
return 'keyword';
}
} elsif ( $Token->parent->isa('PPI::Statement::Compound') ) {
if ( $Token->content =~ /^(?:if|else|elsif|unless|for|foreach|while|my)$/ ) {
return 'keyword';
}
} elsif ( $Token->parent->isa('PPI::Statement::Package') ) {
if ( $Token->content eq 'package' ) {
return 'keyword';
}
} elsif ( $Token->parent->isa('PPI::Statement::Scheduled') ) {
return 'keyword';
}
}
# Normal coloring
my $css = ref $Token;
$css =~ s/^.+:://;
$css;
}
1;
=pod
=encoding UTF-8
=head1 NAME
PPIx::EditorTools::Lexer - Simple Lexer used for syntax highlighting
=head1 VERSION
version 0.21
=head1 SYNOPSIS
PPIx::EditorTools::Lexer->new->lexer(
code => "package TestPackage;\nsub x { 1;\n",
highlighter => sub {
my ( $css, $row, $rowchar, $len ) = @_;
...
},
);
=head1 DESCRIPTION
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
=head1 METHODS
=over 4
=item new()
Constructor. Generally shouldn't be called with any arguments.
=item find( ppi => PPI::Document $ppi, highlighter => sub {...} )
=item find( code => Str $code, highlighter => sub ...{} )
Accepts either a C<PPI::Document> to process or a string containing
the code (which will be converted into a C<PPI::Document>) to process.
Return a reference to an array.
=back
=head1 SEE ALSO
This class inherits from C<PPIx::EditorTools>.
Also see L<App::EditorTools>, L<Padre>, and L<PPI>.
=head1 AUTHORS
=over 4
=item *
Steffen Mueller C<smueller@cpan.org>
=item *
Mark Grimes C<mgrimes@cpan.org>
=item *
Ahmad M. Zawawi <ahmad.zawawi@gmail.com>
=item *
Gabor Szabo <gabor@szabgab.com>
=item *
Yanick Champoux <yanick@cpan.org>
=back
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2017, 2014, 2012 by The Padre development team as listed in Padre.pm..
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
=cut
__END__
# Copyright 2008-2011 The Padre development team as listed in Padre.pm.
# LICENSE
# This program is free software; you can redistribute it and/or
# modify it under the same terms as Perl 5 itself.
|