xref: /freebsd/contrib/bmake/unit-tests/varmod-match-escape.mk (revision 87b759f0fa1f7554d50ce640c40138512bbded44)
1# $NetBSD: varmod-match-escape.mk,v 1.17 2024/07/09 17:07:23 rillig Exp $
2#
3# As of 2020-08-01, the :M and :N modifiers interpret backslashes differently,
4# depending on whether there was an expression somewhere before the
5# first backslash or not.  See ParseModifier_Match, "copy = true".
6#
7# Apart from the different and possibly confusing debug output, there is no
8# difference in behavior.  When parsing the modifier text, only \{, \} and \:
9# are unescaped, and in the pattern matching these have the same meaning as
10# their plain variants '{', '}' and ':'.  In the pattern matching from
11# Str_Match, only \*, \? or \[ would make a noticeable difference.
12
13.MAKEFLAGS: -dcv
14
15SPECIALS=	\: : \\ * \*
16.if ${SPECIALS:M${:U}\:} != ${SPECIALS:M\:${:U}}
17.  warning unexpected
18.endif
19
20# And now both cases combined: A single modifier with both an escaped ':'
21# as well as an expression that expands to a ':'.
22#
23# XXX: As of 2020-11-01, when an escaped ':' occurs before the
24# expression, the whole modifier text is subject to unescaping '\:' to ':',
25# before the expression is expanded.  This means that the '\:' in
26# the expression is expanded as well, turning ${:U\:} into a simple
27# ${:U:}, which silently expands to an empty string, instead of generating
28# an error message.
29#
30# XXX: As of 2020-11-01, the modifier on the right-hand side of the
31# comparison is parsed differently though.  First, the expression
32# is parsed, resulting in ':' and needSubst=true.  After that, the escaped
33# ':' is seen, and this time, copy=true is not executed but stays copy=false.
34# Therefore the escaped ':' is kept as-is, and the final pattern becomes
35# ':\:'.
36#
37# If ParseModifier_Match had used the same parsing algorithm as Var_Subst,
38# both patterns would end up as '::'.
39#
40VALUES=		: :: :\:
41.if ${VALUES:M\:${:U\:}} != ${VALUES:M${:U\:}\:}
42# expect+1: warning: XXX: Oops
43.  warning XXX: Oops
44.endif
45
46.MAKEFLAGS: -d0
47
48# XXX: As of 2020-11-01, unlike all other variable modifiers, a '$' in the
49# :M and :N modifiers is written as '$$', not as '\$'.  This is confusing,
50# undocumented and hopefully not used in practice.
51.if ${:U\$:M$$} != "\$"
52.  error
53.endif
54
55# XXX: As of 2020-11-01, unlike all other variable modifiers, '\$' is not
56# parsed as an escaped '$'.  Instead, ParseModifier_Match first scans for
57# the ':' at the end of the modifier, which results in the pattern '\$'.
58# No unescaping takes place since the pattern neither contained '\:' nor
59# '\{' nor '\}'.  But the text is expanded, and a lonely '$' at the end
60# is silently discarded.  The resulting expanded pattern is thus '\', that
61# is a single backslash.
62.if ${:U\$:M\$} != ""
63.  error
64.endif
65
66# In lint mode, the case of a lonely '$' is covered with an error message.
67.MAKEFLAGS: -dL
68# expect+1: while evaluating "${:U\$:M\$} != """ with value "$": Dollar followed by nothing
69.if ${:U\$:M\$} != ""
70.  error
71.endif
72
73# The control flow of the pattern parser depends on the actual string that
74# is being matched.  There needs to be either a test that shows a difference
75# in behavior, or a proof that the behavior does not depend on the actual
76# string.
77#
78# TODO: Str_Match("a-z]", "[a-z]")
79# TODO: Str_Match("012", "[0-]]")
80# TODO: Str_Match("[", "[[]")
81# TODO: Str_Match("]", "[]")
82# TODO: Str_Match("]", "[[-]]")
83
84# Demonstrate an inconsistency between positive and negative character lists
85# when the range ends with the character ']'.
86#
87# 'A' begins the range, 'B' is in the middle of the range, ']' ends the range,
88# 'a' is outside the range.
89WORDS=		A A] A]] B B] B]] ] ]] ]]] a a] a]]
90# The ']' is part of the character range and at the same time ends the
91# character list.
92EXP.[A-]=	A B ]
93# The first ']' is part of the character range and at the same time ends the
94# character list.
95EXP.[A-]]=	A] B] ]]
96# The first ']' is part of the character range and at the same time ends the
97# character list.
98EXP.[A-]]]=	A]] B]] ]]]
99# For negative character lists, the ']' ends the character range but does not
100# end the character list.
101# XXX: This is unnecessarily inconsistent but irrelevant in practice as there
102# is no practical need for a character range that ends at ']'.
103EXP.[^A-]=	a
104EXP.[^A-]]=	a
105EXP.[^A-]]]=	a]
106
107.for pattern in [A-] [A-]] [A-]]] [^A-] [^A-]] [^A-]]]
108# expect+2: while evaluating variable "WORDS" with value "A A] A]] B B] B]] ] ]] ]]] a a] a]]": Unfinished character list in pattern '[A-]' of modifier ':M'
109# expect+1: while evaluating variable "WORDS" with value "A A] A]] B B] B]] ] ]] ]]] a a] a]]": Unfinished character list in pattern '[^A-]' of modifier ':M'
110.  if ${WORDS:M${pattern}} != ${EXP.${pattern}}
111.    warning ${pattern}: ${WORDS:M${pattern}} != ${EXP.${pattern}}
112.  endif
113.endfor
114
115# In brackets, the backslash is just an ordinary character.
116# Outside brackets, it is an escape character for a few special characters.
117# TODO: Str_Match("\\", "[\\-]]")
118# TODO: Str_Match("-]", "[\\-]]")
119
120all:
121	@:;
122