Here document: Difference between revisions

{{task}} [[Category: Syntax elements]]

<langsyntaxhighlight lang="forth">

<langsyntaxhighlight Adalang="ada">with Ada.Containers.Indefinite_Vectors, Ada.Text_IO;

end Here_Doc;</langsyntaxhighlight>

<langsyntaxhighlight lang="algol68">#!/usr/local/bin/a68g --script #

<langsyntaxhighlight AutoHotkeylang="autohotkey">MyVar = "This is the text inside MyVar"

MsgBox % MyVariable</langsyntaxhighlight>

<langsyntaxhighlight lang="bracmat">( {Multiline string:}

)</langsyntaxhighlight>

<langsyntaxhighlight lang="cpp">#include <iostream> // Only for cout to demonstrate

}</langsyntaxhighlight>

<langsyntaxhighlight lang="coffeescript">myDoc = '''

console.log doc2</langsyntaxhighlight>

<langsyntaxhighlight lang="d">import std.stdio, std.string;

}</langsyntaxhighlight>

<langsyntaxhighlight lang="delphi">PrintLn("This is

sample");</langsyntaxhighlight>

<langsyntaxhighlight lang="elixir">IO.puts """

"""</langsyntaxhighlight>

produces:<langsyntaxhighlight lang="sh">привет

мир</langsyntaxhighlight>

<langsyntaxhighlight lang="elixir">iex(1)> a=2

iex(3)></langsyntaxhighlight>

Factor strings surround by '"' are multiline, but accept escape sequences (like "\n", "\uxxxxxxxx"). Strings surrounded by '"""' don't have to escape '"'. Use HEREDOC: (and other variants, like <pre>[[</pre>) for verbatim text

<langsyntaxhighlight lang="factor">" a multiline

EOF</langsyntaxhighlight>

<langsyntaxhighlight Forthlang="forth">\ GForth specific words:

R> AND \ notEOD && input-stream ->

ALICE type ." --" cr RABBIT type</langsyntaxhighlight>

In Fortran, spaces outside text literals are nowhere significant, not even within words, so that <code>GOTO = G OTO = GO TO</code> and there are no reserved words either so GOTO might be the name of a variable as well and both can be used in the same source. Statements were originally specified with a special format: columns one to five were for statement labels (integers only, not zero), column six specified a continuation line if not blank or zero, and columns 73-80 were for sequence numbers in case you dropped the deck of cards. Thus, source was found in columns 7-72, and layout of the source could be varied without effect on the results. Originally, the only way to produce text in the output (as for annotating the numerical results) was via the "Hollerith" format code, of the form nH where n specified the ''exact'' count of characters following the H. Any characters. Miscounts would cause a syntax error - if you were lucky! Happily, a quoted literal syntax was soon introduced, using apostrophes as delimiters with two apostrophes in a row signifying a contained apostrophe. Later, either an apostrophe or a double quote could be used to start a text string (and the same one must be used to end it) so that if one or the other were desired within a text literal, the other could be used as its delimiters. If both were desired, then there would be no escape from doubling for one.

INTEGER I !A stepper.

CHARACTER*666 I AM !Sufficient space.

DO I = 0,600,66 !Known length.

WRITE (6,1) I AM(I + 1:I + 66) !Reveal one line.

1 FORMAT (A66) !No control characters are expected.

END DO !On to the next line.

<langsyntaxhighlight lang="frink">

<langsyntaxhighlight lang="go">var m = ` leading spaces

and blank lines`</langsyntaxhighlight>

<langsyntaxhighlight lang="groovy">println '''

'''</langsyntaxhighlight>

<langsyntaxhighlight lang="groovy">def expired='defunct'

"""</langsyntaxhighlight>

<langsyntaxhighlight lang="j">here=:0 :0

For example, consider:<langsyntaxhighlight lang="jq">

s</langsyntaxhighlight>

<langsyntaxhighlight lang="sh">$ jq -n s.jq

"x\ny\nz"</langsyntaxhighlight>

<langsyntaxhighlight lang="jq">def specifier(a):

specifier("y")</langsyntaxhighlight>

<langsyntaxhighlight lang="jq">"a

tab: end

d"</langsyntaxhighlight>

<langsyntaxhighlight lang="sh">"a\ntab:\tend\nparens:()\nsingle quotation mark:'\ndouble quotation mark must be escaped:\"\nb\nd"</langsyntaxhighlight>

<langsyntaxhighlight lang="julia">print("""\

""")</langsyntaxhighlight>

Lua uses the [ [ to mark the start of a dochere block and ] ] to mark the end. It can be used directly or while assigning strings to a variable. An arbitrary but matching number of = may be placed between the brackets in both delimiters to allow ] ] to appear in the string.

<langsyntaxhighlight lang="lua">

<langsyntaxhighlight Mathematicalang="mathematica">Print["Mathematica

s\\ashed!"];</langsyntaxhighlight>

<langsyntaxhighlight lang="nmake.exe">target0: dependent0

<<KEEP</langsyntaxhighlight>

=={{header|NewLISPOCaml}}==

In Perl, there must not be a space between the "<<" and the token string. TheBy default, the ending token must always be the entire end line (i.e. no surrounding spaces) for it to be recognisedrecognized (but see exception below). Interpolation is allowed, like a double-quoted string:

<langsyntaxhighlight lang="perl">$address = <<END;

END</langsyntaxhighlight>

<langsyntaxhighlight lang="perl">$pancake = <<"NO MORE INGREDIENTS";

NO MORE INGREDIENTS</langsyntaxhighlight>

<langsyntaxhighlight lang="perl">$x = <<'FOO';

FOO</langsyntaxhighlight>

<langsyntaxhighlight lang="perl">$output = <<`BAR`;

BAR</langsyntaxhighlight>

<langsyntaxhighlight lang="perl">print(<<EOF . "lamb\n");

EOF</langsyntaxhighlight>

I'll let you be in my dream,lamb

if I can be in yours.END

works (all %d tests)

justworks

file.""",length(tests)) just

<langsyntaxhighlight lang="php">$address = <<<END

END;</langsyntaxhighlight>

<langsyntaxhighlight lang="php">$x = <<<'FOO'

FOO;</langsyntaxhighlight>

<langsyntaxhighlight PicoLisplang="picolisp">(out "file.txt" # Write to "file.txt"

(in "file.txt" (echo)) # Show "file.txt"</langsyntaxhighlight>

<langsyntaxhighlight lang="python">print("""\

""")</langsyntaxhighlight>

<langsyntaxhighlight Ravenlang="raven">'Buffy the Vampire Slayer' as sender

<langsyntaxhighlight Ravenlang="raven">'Buffy the Vampire Slayer' as sender

<langsyntaxhighlight lang="rexx">/*REXX program demonstrates a method to use "here" documents in REXX. */

────────────────────────────────────end of "here" docs──────────────────*/</langsyntaxhighlight>

<langsyntaxhighlight lang="ring">

<langsyntaxhighlight lang="ruby">address = <<END

END</langsyntaxhighlight>

<langsyntaxhighlight lang="ruby">pancake = <<"NO MORE INGREDIENTS"

NO MORE INGREDIENTS</langsyntaxhighlight>

<langsyntaxhighlight lang="ruby">x = <<'FOO'

FOO</langsyntaxhighlight>

<langsyntaxhighlight lang="ruby">output = <<`BAR`

BAR</langsyntaxhighlight>

<langsyntaxhighlight lang="ruby">puts <<EOF + "lamb"

EOF</langsyntaxhighlight>

<langsyntaxhighlight lang="runbasic">text$ ="

print text$</langsyntaxhighlight>

Similar to [[#C++|C++]], Rust offers raw strings. In a manner resembling [[#Lua|Lua]]'s delimiters, an arbitrary but matching number of # on both ends may be used to allow inclusion of # into the string:

<langsyntaxhighlight lang="rust">let x = r#"

"#;</lang>

{{libheader|Scala}}<langsyntaxhighlight Scalalang="scala">object temp {

}</langsyntaxhighlight>

<langsyntaxhighlight lang="ruby">var text = <<"EOF";

EOF</langsyntaxhighlight>

<langsyntaxhighlight lang="ruby">var x = <<'FOO';

FOO</langsyntaxhighlight>

<langsyntaxhighlight lang="ruby">say (<<EOF + "lamb");

EOF</langsyntaxhighlight>

<langsyntaxhighlight lang="ruby">say (<<EOF

+ "lamb");</langsyntaxhighlight>

<langsyntaxhighlight lang="tcl">set hereDocExample {

}</langsyntaxhighlight>

<langsyntaxhighlight lang="txr">#!/usr/bin/txr -f

@(end)</langsyntaxhighlight>

<langsyntaxhighlight lang="bash">#!/bin/sh

ANARBITRARYTOKEN</langsyntaxhighlight>

<langsyntaxhighlight lang="bash">cat << EOF

EOF</langsyntaxhighlight>

<langsyntaxhighlight lang="bash">if true; then

cat <<- EOF

The <<- variant deletes any tabs from start of each line.

EOF

fi</langsyntaxhighlight>

<langsyntaxhighlight lang="bash">cat << 'TOKEN'

TOKEN</langsyntaxhighlight>

<langsyntaxhighlight lang="csh">#!/bin/csh -f

'ANARBITRARYTOKEN'</langsyntaxhighlight>

<langsyntaxhighlight Ursalalang="ursala">hd =

first order function such as the previous three examples.]-</langsyntaxhighlight>

' The TXT file can even be another VBS file.

' 1.0 8may2009 Initial release

WshShell.Popup "No file selected.", 2, " ", 64

' WScript.Echo "found"

OVRWT=MSGBOX(strFileNameOUT & " exists already"&vbCRLF&"Overwrite?",vbYesNoCancel,"Overwrite?")

if OVRWT = 6 then

'proceed

objFSO.DeleteFile(strFileNameOUT)

else

WshShell.Popup "Exiting as requested.", 1, " ", 64

Wscript.Quit

End If

' WScript.Echo "not found" 'strFileNameOUT does NOT exists already

strNewText = """) &vbCrLf"&VBCRLF&" strText=strText& ("""

objFile.WriteLine " 'returns a string containing the contents of the file called "&strFileName

objFile.WriteLine " Dim strText"

objFile.WriteLine " strText= ("""&strText&""") &vbCrLf"

objFile.WriteLine " "&strBaseName&"=strText"

<langsyntaxhighlight XPL0lang="xpl0">code Text=12;

marks (^") and any carets (^^) within the string must be escaped.")</langsyntaxhighlight>

<langsyntaxhighlight lang="xml"><?xml version="1.0" encoding="UTF-8"?>

]]>]]<![CDATA[>

</xsl:stylesheet></langsyntaxhighlight>

]]>

<langsyntaxhighlight lang="zkl">x:=

x.println();</langsyntaxhighlight>