.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.0102 (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
.\" ========================================================================
.\"
.IX Title "PPIx::Regexp::Token::Code 3"
.TH PPIx::Regexp::Token::Code 3 2024-09-01 "perl v5.40.0" "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::Token::Code \- Represent a chunk of Perl embedded in a regular expression.
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 3
\& use PPIx::Regexp::Dumper;
\& PPIx::Regexp::Dumper\->new(
\&     \*(Aqqr{(?{print "hello sailor\en"})}smx\*(Aq)\->print;
.Ve
.SH INHERITANCE
.IX Header "INHERITANCE"
\&\f(CW\*(C`PPIx::Regexp::Token::Code\*(C'\fR is a
PPIx::Regexp::Token.
.PP
\&\f(CW\*(C`PPIx::Regexp::Token::Code\*(C'\fR is the parent of
PPIx::Regexp::Token::Interpolation.
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This class represents a chunk of Perl code embedded in a regular
expression. Specifically, it results from parsing things like
.PP
.Vb 2
\& (?{ code })
\& (??{ code })
.Ve
.PP
or from the replacement side of an s///e. Technically, interpolations
are also code, but they parse differently and therefore end up in a
different token.
.PP
This token may not appear inside a regex set (i.e. \f(CW\*(C`(?[ ... ])\*(C'\fR. If
found, it will become a \f(CW\*(C`PPIx::Regexp::Token::Unknown\*(C'\fR.
.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 is_matcher
.IX Subsection "is_matcher"
This method returns \f(CW\*(C`undef\*(C'\fR because a static analysis can not in
general tell whether an interpolated value matches anything.
.SS ppi
.IX Subsection "ppi"
This convenience method returns the PPI::Document
representing the content. This document should be considered read only.
.PP
\&\fBNote\fR that if the location of the invocant is available the PPI
document will have stuff prefixed to it to make the location of the
tokens in the new document consistent with the location. This "stuff"
will include at least a \f(CW\*(C`#line\*(C'\fR directive, and maybe leading white
space.
.SH SUPPORT
.IX Header "SUPPORT"
Support is by the author. Please file bug reports at
<https://rt.cpan.org/Public/Dist/Display.html?Name=PPIx\-Regexp>,
<https://github.com/trwyant/perl\-PPIx\-Regexp/issues>, or in
electronic mail to the author.
.SH AUTHOR
.IX Header "AUTHOR"
Thomas R. Wyant, III \fIwyant at cpan dot org\fR
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright (C) 2009\-2023 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.