.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Compiler::Lexer 3pm"
.TH Compiler::Lexer 3pm 2024-03-07 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Compiler::Lexer \- Lexical Analyzer for Perl5
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 2
\&  use Compiler::Lexer;
\&  use Data::Dumper;
\&
\&  my $filename = $ARGV[0];
\&  open my $fh, \*(Aq<\*(Aq, $filename or die "Cannot open $filename: $!";
\&  my $script = do { local $/; <$fh> };
\&
\&  my $lexer = Compiler::Lexer\->new($filename);
\&  my $tokens = $lexer\->tokenize($script);
\&  print Dumper $tokens;
\&
\&  my $modules = $lexer\->get_used_modules($script);
\&  print Dumper $modules;
.Ve
.SH METHODS
.IX Header "METHODS"
.ie n .IP "my $lexer = Compiler::Lexer\->new($options);" 4
.el .IP "my \f(CW$lexer\fR = Compiler::Lexer\->new($options);" 4
.IX Item "my $lexer = Compiler::Lexer->new($options);"
create new instance.
You can create object from \f(CW$options\fR in hash reference.
.Sp
\&\fBoptions list\fR
.RS 4
.IP filename 4
.IX Item "filename"
.PD 0
.IP "verbose : includes token of Pod, Comment and WhiteSpace" 4
.IX Item "verbose : includes token of Pod, Comment and WhiteSpace"
.RE
.RS 4
.RE
.ie n .IP $lexer\->tokenize($script); 4
.el .IP \f(CW$lexer\fR\->tokenize($script); 4
.IX Item "$lexer->tokenize($script);"
.PD
get token objects includes parameter of 'name' or 'type' or 'line' and so on.
This method requires perl source code in string.
.ie n .IP "$lexer\->set_library_path(['path1', 'path2' ...])" 4
.el .IP "\f(CW$lexer\fR\->set_library_path(['path1', 'path2' ...])" 4
.IX Item "$lexer->set_library_path(['path1', 'path2' ...])"
set libraries path for reading recursively. Default paths are \f(CW@INC\fR.
.ie n .IP $lexer\->recursive_tokenize($script) 4
.el .IP \f(CW$lexer\fR\->recursive_tokenize($script) 4
.IX Item "$lexer->recursive_tokenize($script)"
get hash reference like { 'module_nameA' => [], 'module_nameB' => [] ... }.
This method requires per source code in string.
.ie n .IP $lexer\->get_used_modules($script); 4
.el .IP \f(CW$lexer\fR\->get_used_modules($script); 4
.IX Item "$lexer->get_used_modules($script);"
get names of used module.
This method requires perl source code in string.
.SH AUTHOR
.IX Header "AUTHOR"
Masaaki Goshima (goccy) <goccy(at)cpan.org>
.SH CONTRIBUTORS
.IX Header "CONTRIBUTORS"
tokuhirom: Tokuhiro Matsuno
.SH "LICENSE AND COPYRIGHT"
.IX Header "LICENSE AND COPYRIGHT"
Copyright (c) 2013, Masaaki Goshima (goccy). All rights reserved.
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.