xref: /freebsd/contrib/bmake/unit-tests/directive-for-escape.mk (revision dd41de95a84d979615a2ef11df6850622bf6184e)
1# $NetBSD: directive-for-escape.mk,v 1.6 2021/01/25 19:05:39 rillig Exp $
2#
3# Test escaping of special characters in the iteration values of a .for loop.
4# These values get expanded later using the :U variable modifier, and this
5# escaping and unescaping must pass all characters and strings effectively
6# unmodified.
7
8.MAKEFLAGS: -df
9
10# Even though the .for loops takes quotes into account when splitting the
11# string into words, the quotes don't need to be balances, as of 2020-12-31.
12# This could be considered a bug.
13ASCII=	!"\#$$%&'()*+,-./0-9:;<=>?@A-Z[\]_^a-z{|}~
14
15# XXX: As of 2020-12-31, the '#' is not preserved in the expanded body of
16# the loop since it would not need only the escaping for the :U variable
17# modifier but also the escaping for the line-end comment.
18.for chars in ${ASCII}
19.  info ${chars}
20.endfor
21
22# As of 2020-12-31, using 2 backslashes before be '#' would treat the '#'
23# as comment character.  Using 3 backslashes doesn't help either since
24# then the situation is essentially the same as with 1 backslash.
25# This means that a '#' sign cannot be passed in the value of a .for loop
26# at all.
27ASCII.2020-12-31=	!"\\\#$$%&'()*+,-./0-9:;<=>?@A-Z[\]_^a-z{|}~
28.for chars in ${ASCII.2020-12-31}
29.  info ${chars}
30.endfor
31
32# Cover the code in for_var_len.
33#
34# XXX: It is unexpected that the variable V gets expanded in the loop body.
35# The double '$$' should prevent exactly this.  Probably nobody was
36# adventurous enough to use literal dollar signs in the values for a .for
37# loop.
38V=		value
39VALUES=		$$ $${V} $${V:=-with-modifier} $$(V) $$(V:=-with-modifier)
40.for i in ${VALUES}
41.  info $i
42.endfor
43
44# Try to cover the code for nested '{}' in for_var_len, without success.
45#
46# The value of VALUES is not meant to be a variable expression.  Instead, it
47# is meant to represent dollar, lbrace, "UNDEF:U", backslash, dollar,
48# backslash, dollar, space, nested braces, space, "end}".
49#
50# The .for loop splits ${VALUES} into 3 words, at the space characters, since
51# these are not escaped.
52VALUES=		$${UNDEF:U\$$\$$ {{}} end}
53# XXX: Where does the '\$$\$$' get converted into a single '\$'?
54.for i in ${VALUES}
55.  info $i
56.endfor
57
58# Second try to cover the code for nested '{}' in for_var_len.
59#
60# XXX: It is wrong that for_var_len requires the braces to be balanced.
61# Each variable modifier has its own inconsistent way of parsing nested
62# variable expressions, braces and parentheses.  The only sensible thing
63# to do is therefore to let Var_Parse do all the parsing work.
64VALUES=		begin<$${UNDEF:Ufallback:N{{{}}}}>end
65.for i in ${VALUES}
66.  info $i
67.endfor
68
69# A single trailing dollar doesn't happen in practice.
70# The dollar sign is correctly passed through to the body of the .for loop.
71# There, it is expanded by the .info directive, but even there a trailing
72# dollar sign is kept as-is.
73.for i in ${:U\$}
74.  info ${i}
75.endfor
76
77# As of 2020-12-31, the name of the iteration variable can even contain
78# colons, which then affects variable expressions having this exact modifier.
79# This is clearly an unintended side effect of the implementation.
80NUMBERS=	one two three
81.for NUMBERS:M*e in replaced
82.  info ${NUMBERS} ${NUMBERS:M*e}
83.endfor
84
85# As of 2020-12-31, the name of the iteration variable can contain braces,
86# which gets even more surprising than colons, since it allows to replace
87# sequences of variable expressions.  There is no practical use case for
88# this, though.
89BASENAME=	one
90EXT=		.c
91.for BASENAME}${EXT in replaced
92.  info ${BASENAME}${EXT}
93.endfor
94
95# Demonstrate the various ways to refer to the iteration variable.
96i=		outer
97i2=		two
98i,=		comma
99.for i in inner
100.  info .        $$i: $i
101.  info .      $${i}: ${i}
102.  info .   $${i:M*}: ${i:M*}
103.  info .      $$(i): $(i)
104.  info .   $$(i:M*): $(i:M*)
105.  info . $${i$${:U}}: ${i${:U}}
106.  info .    $${i\}}: ${i\}}	# XXX: unclear why ForLoop_SubstVarLong needs this
107.  info .     $${i2}: ${i2}
108.  info .     $${i,}: ${i,}
109.  info .  adjacent: $i${i}${i:M*}$i
110.endfor
111
112all:
113