.\" -*- 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 "PPI::Token::Quote 3pm"
.TH PPI::Token::Quote 3pm 2024-03-16 "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
PPI::Token::Quote \- String quote abstract base class
.SH INHERITANCE
.IX Header "INHERITANCE"
.Vb 3
\&  PPI::Token::Quote
\&  isa PPI::Token
\&      isa PPI::Element
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
The \f(CW\*(C`PPI::Token::Quote\*(C'\fR class is never instantiated, and simply
provides a common abstract base class for the four quote classes.
In PPI, a "quote" is limited to only the quote-like things that
themselves directly represent a string. (although this includes
double quotes with interpolated elements inside them, note that
String::InterpolatedVariables allows to extract them).
.PP
The subclasses of \f(CW\*(C`PPI::Token::Quote\*(C'\fR are:
.ie n .IP "\*(Aq\*(Aq \- PPI::Token::Quote::Single" 2
.el .IP "\f(CW\*(Aq\*(Aq\fR \- PPI::Token::Quote::Single" 2
.IX Item " - PPI::Token::Quote::Single"
.PD 0
.ie n .IP """q{}"" \- PPI::Token::Quote::Literal" 2
.el .IP "\f(CWq{}\fR \- PPI::Token::Quote::Literal" 2
.IX Item "q{} - PPI::Token::Quote::Literal"
.ie n .IP """"" \- PPI::Token::Quote::Double" 2
.el .IP "\f(CW""""\fR \- PPI::Token::Quote::Double" 2
.IX Item """"" - PPI::Token::Quote::Double"
.ie n .IP """qq{}"" \- PPI::Token::Quote::Interpolate" 2
.el .IP "\f(CWqq{}\fR \- PPI::Token::Quote::Interpolate" 2
.IX Item "qq{} - PPI::Token::Quote::Interpolate"
.PD
.PP
The names are hopefully obvious enough not to have to explain what
each class is here. See their respective pages for more details.
.PP
Please note that although the here-doc \fBdoes\fR represent a literal
string, it is such a nasty piece of work that in PPI it is given the
honor of its own token class (PPI::Token::HereDoc).
.SH METHODS
.IX Header "METHODS"
.SS string
.IX Subsection "string"
The \f(CW\*(C`string\*(C'\fR method is provided by all four ::Quote classes. It won't
get you the actual literal Perl value, but it will strip off the wrapping
of the quotes.
.PP
.Vb 5
\&  # The following all return foo from the \->string method
\&  \*(Aqfoo\*(Aq
\&  "foo"
\&  q{foo}
\&  qq <foo>
.Ve
.SS literal
.IX Subsection "literal"
The \f(CW\*(C`literal\*(C'\fR method is provided by ::Quote::Literal and
::Quote::Single.  This returns the value of the string as Perl sees
it: without the quote marks and with \f(CW\*(C`\e\e\*(C'\fR and \f(CW\*(C`\e\*(Aq\*(C'\fR resolved to \f(CW\*(C`\e\*(C'\fR
and \f(CW\*(C`\*(Aq\*(C'\fR.
.PP
The \f(CW\*(C`literal\*(C'\fR method is not implemented by ::Quote::Double or
::Quote::Interpolate yet.
.SH SUPPORT
.IX Header "SUPPORT"
See the support section in the main module.
.SH AUTHOR
.IX Header "AUTHOR"
Adam Kennedy <adamk@cpan.org>
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright 2001 \- 2011 Adam Kennedy.
.PP
This program is free software; you can redistribute
it and/or modify it under the same terms as Perl itself.
.PP
The full text of the license can be found in the
LICENSE file included with this module.