.\" -*- 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::QuoteLike::Token::Interpolation 3"
.TH PPIx::QuoteLike::Token::Interpolation 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::QuoteLike::Token::Interpolation \- Represent an interpolation
.SH SYNOPSIS
.IX Header "SYNOPSIS"
This class should not be instantiated by the user. See below for public
methods.
.SH INHERITANCE
.IX Header "INHERITANCE"
\&\f(CW\*(C`PPIx::QuoteLike::Token::Interpolation\*(C'\fR is a
PPIx::QuoteLike::Token.
.PP
\&\f(CW\*(C`PPIx::QuoteLike::Token::Interpolation\*(C'\fR has no descendants.
.SH DESCRIPTION
.IX Header "DESCRIPTION"
This Perl class represents an interpolation into a quote-like string.
.SH METHODS
.IX Header "METHODS"
This class supports the following public methods in addition to those of
its superclass:
.SS ppi
.IX Subsection "ppi"
.Vb 1
\& my $ppi = $elem\->ppi();
.Ve
.PP
This convenience method returns the PPI::Document
representing the content. This document should be considered read only.
An exception will be thrown if PPI::Document can not be
loaded.
.PP
Note that the content of the returned PPI::Document may
not be the same as the content of the original
\&\f(CW\*(C`PPIx::Regexp::Token::Interpolation\*(C'\fR. This can happen because
interpolated variable names may be enclosed in curly brackets, but this
does not happen in normal code. For example, in \f(CW\*(C`/${foo}bar/\*(C'\fR, the
content of the \f(CW\*(C`PPIx::Regexp::Token::Interpolation\*(C'\fR object will be
\&\f(CW\*(Aq${foo}\*(Aq\fR, but the content of the \f(CW\*(C`PPI::Document\*(C'\fR will be \f(CW\*(Aq$foo\*(Aq\fR.
.SS variables
.IX Subsection "variables"
.Vb 1
\& say "Interpolates $_" for $elem\->variables();
.Ve
.PP
\&\fBNOTE\fR that this method is discouraged, and may well be deprecated and
removed. I have two problems with it. The first is that it returns
variable names rather than PPI::Element objects, leaving
you no idea how the variables are used. The second is that it does not
properly handle things like \f(CW"${^CAPTURE[0]}"\fR, and it seems infeasible
to make it do so. It was originally written for the benefit of
Perl::Critic::Policy::Variables::ProhibitUnusedVarsStricter,
but has proven inadequate to that policy's needs.
.PP
This convenience method returns all interpolated variables. Each is
returned only once, and they are returned in no particular order.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
PPIx::QuoteLike::Token.
.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\-QuoteLike>,
<https://github.com/trwyant/perl\-PPIx\-QuoteLike/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) 2016\-2022 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.