.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)
.\"
.\" 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
.\"
.\" Required to disable full justification in groff 1.23.0.
.if n .ds AD l
.\" ========================================================================
.\"
.IX Title "PPIx::Regexp::Lexer 3"
.TH PPIx::Regexp::Lexer 3 2026-06-15 "perl v5.42.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
PPIx::Regexp::Lexer \- Assemble tokenizer output.
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 5
\& use PPIx::Regexp::Lexer;
\& use PPIx::Regexp::Dumper;
\& my $lex = PPIx::Regexp::Lexer\->new(\*(Aqqr{foo}smx\*(Aq);
\& my $dmp = PPIx::Regexp::Dumper\->new( $lex );
\& $dmp\->print();
.Ve
.SH INHERITANCE
.IX Header "INHERITANCE"
\&\f(CW\*(C`PPIx::Regexp::Lexer\*(C'\fR is a
PPIx::Regexp::Support.
.PP
\&\f(CW\*(C`PPIx::Regexp::Lexer\*(C'\fR has no descendants.
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This class takes the token stream generated by
PPIx::Regexp::Tokenizer and generates the
parse tree.
.SH METHODS
.IX Header "METHODS"
This class provides the following public methods. Methods not documented
here are private, and unsupported in the sense that the author reserves
the right to change or remove them without notice.
.SS new
.IX Subsection "new"
This method instantiates the lexer. It takes as its argument either a
PPIx::Regexp::Tokenizer or the text to be
parsed. In the latter case the tokenizer is instantiated from the text.
.PP
Any optional name/value pairs after the first argument are passed to the
tokenizer, which interprets them or not as the case may be.
.SS errstr
.IX Subsection "errstr"
This method returns the error string from the last attempt to
instantiate a \f(CW\*(C`PPIx::Regexp::Lexer\*(C'\fR. If the last attempt succeeded, the
error will be \f(CW\*(C`undef\*(C'\fR.
.SS failures
.IX Subsection "failures"
.Vb 1
\& print $lexer\->failures(), " parse failures\en";
.Ve
.PP
This method returns the number of parse failures encountered. A
parse failure is either a tokenization failure (see
PPIx::Regexp::Tokenizer\->\fBfailures()\fR)
or a structural error.
.SS lex
.IX Subsection "lex"
This method lexes the tokens in the text, and returns the lexed list of
elements.
.SS strict
.IX Subsection "strict"
This method returns true or false based on the value of the \f(CW\*(Aqstrict\*(Aq\fR
argument to \f(CWnew()\fR.
.SH SUPPORT
.IX Header "SUPPORT"
Support is by the author. Please file bug reports at
<https://github.com/trwyant/perl\-PPIx\-Regexp/issues> or in
electronic mail to the author.
.SH AUTHOR
.IX Header "AUTHOR"
Thomas R. Wyant, III \fIharryfmudd at comcast dot net\fR
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright (C) 2009\-2023, 2025\-2026 by Thomas R. Wyant, III
.PP
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl 5.10.0. For more details, see the full text
of the licenses in the directory LICENSES.
.PP
This program is distributed in the hope that it will be useful, but
without any warranty; without even the implied warranty of
merchantability or fitness for a particular purpose.