.\" -*- 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::HereDoc 3pm"
.TH PPI::Token::HereDoc 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::HereDoc \- Token class for the here\-doc
.SH INHERITANCE
.IX Header "INHERITANCE"
.Vb 3
\&  PPI::Token::HereDoc
\&  isa PPI::Token
\&      isa PPI::Element
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Here-docs are incredibly handy when writing Perl, but incredibly tricky
when parsing it, primarily because they don't follow the general flow of
input.
.PP
They jump ahead and nab lines directly off the input buffer. Whitespace
and newlines may not matter in most Perl code, but they matter in here-docs.
.PP
They are also tricky to store as an object. They look sort of like an
operator and a string, but they don't act like it. And they have a second
section that should be something like a separate token, but isn't because a
string can span from above the here-doc content to below it.
.PP
So when parsing, this is what we do.
.PP
Firstly, the PPI::Token::HereDoc object, does not represent the \f(CW\*(C`<<\*(C'\fR
operator, or the "END_FLAG", or the content, or even the terminator.
.PP
It represents all of them at once.
.PP
The token itself has only the declaration part as its "content".
.PP
.Vb 2
\&  # This is what the content of a HereDoc token is
\&  <<FOO
\&  
\&  # Or this
\&  <<"FOO"
\&  
\&  # Or even this
\&  <<      \*(AqFOO\*(Aq
.Ve
.PP
That is, the "operator", any whitespace separator, and the quoted or bare
terminator. So when you call the \f(CW\*(C`content\*(C'\fR method on a HereDoc token, you
get '<< "FOO"'.
.PP
As for the content and the terminator, when treated purely in "content" terms
they do not exist.
.PP
The content is made available with the \f(CW\*(C`heredoc\*(C'\fR method, and the name of
the terminator with the \f(CW\*(C`terminator\*(C'\fR method.
.PP
To make things work in the way you expect, PPI has to play some games
when doing line/column location calculation for tokens, and also during
the content parsing and generation processes.
.PP
Documents cannot simply by recreated by stitching together the token
contents, and involve a somewhat more expensive procedure, but the extra
expense should be relatively negligible unless you are doing huge
quantities of them.
.PP
Please note that due to the immature nature of PPI in general, we expect
\&\f(CW\*(C`HereDocs\*(C'\fR to be a rich (bad) source of corner-case bugs for quite a while,
but for the most part they should more or less DWYM.
.SS "Comparison to other string types"
.IX Subsection "Comparison to other string types"
Although technically it can be considered a quote, for the time being
\&\f(CW\*(C`HereDocs\*(C'\fR are being treated as a completely separate \f(CW\*(C`Token\*(C'\fR subclass,
and will not be found in a search for PPI::Token::Quote or
PPI::Token::QuoteLike objects.
.PP
This may change in the future, with it most likely to end up under
QuoteLike.
.SH METHODS
.IX Header "METHODS"
Although it has the standard set of \f(CW\*(C`Token\*(C'\fR methods, \f(CW\*(C`HereDoc\*(C'\fR objects
have a relatively large number of unique methods all of their own.
.SS heredoc
.IX Subsection "heredoc"
The \f(CW\*(C`heredoc\*(C'\fR method is the authoritative method for accessing the contents
of the \f(CW\*(C`HereDoc\*(C'\fR object.
.PP
It returns the contents of the here-doc as a list of newline-terminated
strings. If called in scalar context, it returns the number of lines in
the here-doc, \fBexcluding\fR the terminator line.
.SS indentation
.IX Subsection "indentation"
The \f(CW\*(C`indentation\*(C'\fR method returns the indentation string of an indented
here-doc if that can be determined. If the indented here-doc is damaged
(say, missing terminator) or the here-doc was not indented, it returns
\&\f(CW\*(C`undef\*(C'\fR.
.SS terminator
.IX Subsection "terminator"
The \f(CW\*(C`terminator\*(C'\fR method returns the name of the terminating string for the
here-doc.
.PP
Returns the terminating string as an unescaped string (in the rare case
the terminator has an escaped quote in it).
.SH "TO DO"
.IX Header "TO DO"
\&\- Implement PPI::Token::Quote interface compatibility
.PP
\&\- Check CPAN for any use of the null here-doc or here\-doc\-in\-s///e
.PP
\&\- Add support for the null here-doc
.PP
\&\- Add support for here-doc in s///e
.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.