xref: /netbsd-src/usr.bin/make/var.c (revision 7d62b00eb9ad855ffcd7da46b41e23feb5476fac)
1 /*	$NetBSD: var.c,v 1.1048 2023/03/09 06:49:37 rillig Exp $	*/
2 
3 /*
4  * Copyright (c) 1988, 1989, 1990, 1993
5  *	The Regents of the University of California.  All rights reserved.
6  *
7  * This code is derived from software contributed to Berkeley by
8  * Adam de Boor.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  * 3. Neither the name of the University nor the names of its contributors
19  *    may be used to endorse or promote products derived from this software
20  *    without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32  * SUCH DAMAGE.
33  */
34 
35 /*
36  * Copyright (c) 1989 by Berkeley Softworks
37  * All rights reserved.
38  *
39  * This code is derived from software contributed to Berkeley by
40  * Adam de Boor.
41  *
42  * Redistribution and use in source and binary forms, with or without
43  * modification, are permitted provided that the following conditions
44  * are met:
45  * 1. Redistributions of source code must retain the above copyright
46  *    notice, this list of conditions and the following disclaimer.
47  * 2. Redistributions in binary form must reproduce the above copyright
48  *    notice, this list of conditions and the following disclaimer in the
49  *    documentation and/or other materials provided with the distribution.
50  * 3. All advertising materials mentioning features or use of this software
51  *    must display the following acknowledgement:
52  *	This product includes software developed by the University of
53  *	California, Berkeley and its contributors.
54  * 4. Neither the name of the University nor the names of its contributors
55  *    may be used to endorse or promote products derived from this software
56  *    without specific prior written permission.
57  *
58  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
59  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
60  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
61  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
62  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
63  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
64  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
65  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
66  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
67  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
68  * SUCH DAMAGE.
69  */
70 
71 /*
72  * Handling of variables and the expressions formed from them.
73  *
74  * Variables are set using lines of the form VAR=value.  Both the variable
75  * name and the value can contain references to other variables, by using
76  * expressions like ${VAR}, ${VAR:Modifiers}, ${${VARNAME}} or ${VAR:${MODS}}.
77  *
78  * Interface:
79  *	Var_Init	Initialize this module.
80  *
81  *	Var_End		Clean up the module.
82  *
83  *	Var_Set
84  *	Var_SetExpand
85  *			Set the value of the variable, creating it if
86  *			necessary.
87  *
88  *	Var_Append
89  *	Var_AppendExpand
90  *			Append more characters to the variable, creating it if
91  *			necessary. A space is placed between the old value and
92  *			the new one.
93  *
94  *	Var_Exists
95  *	Var_ExistsExpand
96  *			See if a variable exists.
97  *
98  *	Var_Value	Return the unexpanded value of a variable, or NULL if
99  *			the variable is undefined.
100  *
101  *	Var_Subst	Substitute all variable expressions in a string.
102  *
103  *	Var_Parse	Parse a variable expression such as ${VAR:Mpattern}.
104  *
105  *	Var_Delete
106  *			Delete a variable.
107  *
108  *	Var_ReexportVars
109  *			Export some or even all variables to the environment
110  *			of this process and its child processes.
111  *
112  *	Var_Export	Export the variable to the environment of this process
113  *			and its child processes.
114  *
115  *	Var_UnExport	Don't export the variable anymore.
116  *
117  * Debugging:
118  *	Var_Stats	Print out hashing statistics if in -dh mode.
119  *
120  *	Var_Dump	Print out all variables defined in the given scope.
121  *
122  * XXX: There's a lot of almost duplicate code in these functions that only
123  *  differs in subtle details that are not mentioned in the manual page.
124  */
125 
126 #include <sys/stat.h>
127 #ifndef NO_REGEX
128 #include <sys/types.h>
129 #include <regex.h>
130 #endif
131 #include <errno.h>
132 #include <inttypes.h>
133 #include <limits.h>
134 #include <time.h>
135 
136 #include "make.h"
137 #include "dir.h"
138 #include "job.h"
139 #include "metachar.h"
140 
141 /*	"@(#)var.c	8.3 (Berkeley) 3/19/94" */
142 MAKE_RCSID("$NetBSD: var.c,v 1.1048 2023/03/09 06:49:37 rillig Exp $");
143 
144 /*
145  * Variables are defined using one of the VAR=value assignments.  Their
146  * value can be queried by expressions such as $V, ${VAR}, or with modifiers
147  * such as ${VAR:S,from,to,g:Q}.
148  *
149  * There are 3 kinds of variables: scope variables, environment variables,
150  * undefined variables.
151  *
152  * Scope variables are stored in a GNode.scope.  The only way to undefine
153  * a scope variable is using the .undef directive.  In particular, it must
154  * not be possible to undefine a variable during the evaluation of an
155  * expression, or Var.name might point nowhere.  (There is another,
156  * unintended way to undefine a scope variable, see varmod-loop-delete.mk.)
157  *
158  * Environment variables are short-lived.  They are returned by VarFind, and
159  * after using them, they must be freed using VarFreeShortLived.
160  *
161  * Undefined variables occur during evaluation of variable expressions such
162  * as ${UNDEF:Ufallback} in Var_Parse and ApplyModifiers.
163  */
164 typedef struct Var {
165 	/*
166 	 * The name of the variable, once set, doesn't change anymore.
167 	 * For scope variables, it aliases the corresponding HashEntry name.
168 	 * For environment and undefined variables, it is allocated.
169 	 */
170 	FStr name;
171 
172 	/* The unexpanded value of the variable. */
173 	Buffer val;
174 
175 	/* The variable came from the command line. */
176 	bool fromCmd:1;
177 
178 	/*
179 	 * The variable is short-lived.
180 	 * These variables are not registered in any GNode, therefore they
181 	 * must be freed after use.
182 	 */
183 	bool shortLived:1;
184 
185 	/*
186 	 * The variable comes from the environment.
187 	 * Appending to its value moves the variable to the global scope.
188 	 */
189 	bool fromEnvironment:1;
190 
191 	/*
192 	 * The variable value cannot be changed anymore, and the variable
193 	 * cannot be deleted.  Any attempts to do so are silently ignored,
194 	 * they are logged with -dv though.
195 	 * Use .[NO]READONLY: to adjust.
196 	 *
197 	 * See VAR_SET_READONLY.
198 	 */
199 	bool readOnly:1;
200 
201 	/*
202 	 * The variable is currently being accessed by Var_Parse or Var_Subst.
203 	 * This temporary marker is used to avoid endless recursion.
204 	 */
205 	bool inUse:1;
206 
207 	/*
208 	 * The variable is exported to the environment, to be used by child
209 	 * processes.
210 	 */
211 	bool exported:1;
212 
213 	/*
214 	 * At the point where this variable was exported, it contained an
215 	 * unresolved reference to another variable.  Before any child
216 	 * process is started, it needs to be exported again, in the hope
217 	 * that the referenced variable can then be resolved.
218 	 */
219 	bool reexport:1;
220 } Var;
221 
222 /*
223  * Exporting variables is expensive and may leak memory, so skip it if we
224  * can.
225  *
226  * To avoid this, it might be worth encapsulating the environment variables
227  * in a separate data structure called EnvVars.
228  */
229 typedef enum VarExportedMode {
230 	VAR_EXPORTED_NONE,
231 	VAR_EXPORTED_SOME,
232 	VAR_EXPORTED_ALL
233 } VarExportedMode;
234 
235 typedef enum UnexportWhat {
236 	/* Unexport the variables given by name. */
237 	UNEXPORT_NAMED,
238 	/*
239 	 * Unexport all globals previously exported, but keep the environment
240 	 * inherited from the parent.
241 	 */
242 	UNEXPORT_ALL,
243 	/*
244 	 * Unexport all globals previously exported and clear the environment
245 	 * inherited from the parent.
246 	 */
247 	UNEXPORT_ENV
248 } UnexportWhat;
249 
250 /* Flags for pattern matching in the :S and :C modifiers */
251 typedef struct PatternFlags {
252 	bool subGlobal:1;	/* 'g': replace as often as possible */
253 	bool subOnce:1;		/* '1': replace only once */
254 	bool anchorStart:1;	/* '^': match only at start of word */
255 	bool anchorEnd:1;	/* '$': match only at end of word */
256 } PatternFlags;
257 
258 /* SepBuf builds a string from words interleaved with separators. */
259 typedef struct SepBuf {
260 	Buffer buf;
261 	bool needSep;
262 	/* Usually ' ', but see the ':ts' modifier. */
263 	char sep;
264 } SepBuf;
265 
266 
267 /*
268  * This lets us tell if we have replaced the original environ
269  * (which we cannot free).
270  */
271 char **savedEnv = NULL;
272 
273 /*
274  * Special return value for Var_Parse, indicating a parse error.  It may be
275  * caused by an undefined variable, a syntax error in a modifier or
276  * something entirely different.
277  */
278 char var_Error[] = "";
279 
280 /*
281  * Special return value for Var_Parse, indicating an undefined variable in
282  * a case where VARE_UNDEFERR is not set.  This undefined variable is
283  * typically a dynamic variable such as ${.TARGET}, whose expansion needs to
284  * be deferred until it is defined in an actual target.
285  *
286  * See VARE_EVAL_KEEP_UNDEF.
287  */
288 static char varUndefined[] = "";
289 
290 /*
291  * Traditionally this make consumed $$ during := like any other expansion.
292  * Other make's do not, and this make follows straight since 2016-01-09.
293  *
294  * This knob allows controlling the behavior:
295  *	false to consume $$ during := assignment.
296  *	true to preserve $$ during := assignment.
297  */
298 #define MAKE_SAVE_DOLLARS ".MAKE.SAVE_DOLLARS"
299 static bool save_dollars = true;
300 
301 /*
302  * A scope collects variable names and their values.
303  *
304  * The main scope is SCOPE_GLOBAL, which contains the variables that are set
305  * in the makefiles.  SCOPE_INTERNAL acts as a fallback for SCOPE_GLOBAL and
306  * contains some internal make variables.  These internal variables can thus
307  * be overridden, they can also be restored by undefining the overriding
308  * variable.
309  *
310  * SCOPE_CMDLINE contains variables from the command line arguments.  These
311  * override variables from SCOPE_GLOBAL.
312  *
313  * There is no scope for environment variables, these are generated on-the-fly
314  * whenever they are referenced.  If there were such a scope, each change to
315  * environment variables would have to be reflected in that scope, which may
316  * be simpler or more complex than the current implementation.
317  *
318  * Each target has its own scope, containing the 7 target-local variables
319  * .TARGET, .ALLSRC, etc.  Variables set on dependency lines also go in
320  * this scope.
321  */
322 
323 GNode *SCOPE_CMDLINE;
324 GNode *SCOPE_GLOBAL;
325 GNode *SCOPE_INTERNAL;
326 
327 static VarExportedMode var_exportedVars = VAR_EXPORTED_NONE;
328 
329 static const char VarEvalMode_Name[][32] = {
330 	"parse-only",
331 	"parse-balanced",
332 	"eval",
333 	"eval-defined",
334 	"eval-keep-dollar",
335 	"eval-keep-undefined",
336 	"eval-keep-dollar-and-undefined",
337 };
338 
339 
340 static Var *
341 VarNew(FStr name, const char *value,
342        bool shortLived, bool fromEnvironment, bool readOnly)
343 {
344 	size_t value_len = strlen(value);
345 	Var *var = bmake_malloc(sizeof *var);
346 	var->name = name;
347 	Buf_InitSize(&var->val, value_len + 1);
348 	Buf_AddBytes(&var->val, value, value_len);
349 	var->fromCmd = false;
350 	var->shortLived = shortLived;
351 	var->fromEnvironment = fromEnvironment;
352 	var->readOnly = readOnly;
353 	var->inUse = false;
354 	var->exported = false;
355 	var->reexport = false;
356 	return var;
357 }
358 
359 static Substring
360 CanonicalVarname(Substring name)
361 {
362 
363 	if (!(Substring_Length(name) > 0 && name.start[0] == '.'))
364 		return name;
365 
366 	if (Substring_Equals(name, ".ALLSRC"))
367 		return Substring_InitStr(ALLSRC);
368 	if (Substring_Equals(name, ".ARCHIVE"))
369 		return Substring_InitStr(ARCHIVE);
370 	if (Substring_Equals(name, ".IMPSRC"))
371 		return Substring_InitStr(IMPSRC);
372 	if (Substring_Equals(name, ".MEMBER"))
373 		return Substring_InitStr(MEMBER);
374 	if (Substring_Equals(name, ".OODATE"))
375 		return Substring_InitStr(OODATE);
376 	if (Substring_Equals(name, ".PREFIX"))
377 		return Substring_InitStr(PREFIX);
378 	if (Substring_Equals(name, ".TARGET"))
379 		return Substring_InitStr(TARGET);
380 
381 	if (Substring_Equals(name, ".SHELL") && shellPath == NULL)
382 		Shell_Init();
383 
384 	/* GNU make has an additional alias $^ == ${.ALLSRC}. */
385 
386 	return name;
387 }
388 
389 static Var *
390 GNode_FindVar(GNode *scope, Substring varname, unsigned int hash)
391 {
392 	return HashTable_FindValueBySubstringHash(&scope->vars, varname, hash);
393 }
394 
395 /*
396  * Find the variable in the scope, and maybe in other scopes as well.
397  *
398  * Input:
399  *	name		name to find, is not expanded any further
400  *	scope		scope in which to look first
401  *	elsewhere	true to look in other scopes as well
402  *
403  * Results:
404  *	The found variable, or NULL if the variable does not exist.
405  *	If the variable is short-lived (such as environment variables), it
406  *	must be freed using VarFreeShortLived after use.
407  */
408 static Var *
409 VarFindSubstring(Substring name, GNode *scope, bool elsewhere)
410 {
411 	Var *var;
412 	unsigned int nameHash;
413 
414 	/* Replace '.TARGET' with '@', likewise for other local variables. */
415 	name = CanonicalVarname(name);
416 	nameHash = Hash_Substring(name);
417 
418 	var = GNode_FindVar(scope, name, nameHash);
419 	if (!elsewhere)
420 		return var;
421 
422 	if (var == NULL && scope != SCOPE_CMDLINE)
423 		var = GNode_FindVar(SCOPE_CMDLINE, name, nameHash);
424 
425 	if (!opts.checkEnvFirst && var == NULL && scope != SCOPE_GLOBAL) {
426 		var = GNode_FindVar(SCOPE_GLOBAL, name, nameHash);
427 		if (var == NULL && scope != SCOPE_INTERNAL) {
428 			/* SCOPE_INTERNAL is subordinate to SCOPE_GLOBAL */
429 			var = GNode_FindVar(SCOPE_INTERNAL, name, nameHash);
430 		}
431 	}
432 
433 	if (var == NULL) {
434 		FStr envName;
435 		const char *envValue;
436 
437 		envName = Substring_Str(name);
438 		envValue = getenv(envName.str);
439 		if (envValue != NULL)
440 			return VarNew(envName, envValue, true, true, false);
441 		FStr_Done(&envName);
442 
443 		if (opts.checkEnvFirst && scope != SCOPE_GLOBAL) {
444 			var = GNode_FindVar(SCOPE_GLOBAL, name, nameHash);
445 			if (var == NULL && scope != SCOPE_INTERNAL)
446 				var = GNode_FindVar(SCOPE_INTERNAL, name,
447 				    nameHash);
448 			return var;
449 		}
450 
451 		return NULL;
452 	}
453 
454 	return var;
455 }
456 
457 static Var *
458 VarFind(const char *name, GNode *scope, bool elsewhere)
459 {
460 	return VarFindSubstring(Substring_InitStr(name), scope, elsewhere);
461 }
462 
463 /* If the variable is short-lived, free it, including its value. */
464 static void
465 VarFreeShortLived(Var *v)
466 {
467 	if (!v->shortLived)
468 		return;
469 
470 	FStr_Done(&v->name);
471 	Buf_Done(&v->val);
472 	free(v);
473 }
474 
475 static const char *
476 ValueDescription(const char *value)
477 {
478 	if (value[0] == '\0')
479 		return "# (empty)";
480 	if (ch_isspace(value[strlen(value) - 1]))
481 		return "# (ends with space)";
482 	return "";
483 }
484 
485 /* Add a new variable of the given name and value to the given scope. */
486 static Var *
487 VarAdd(const char *name, const char *value, GNode *scope, VarSetFlags flags)
488 {
489 	HashEntry *he = HashTable_CreateEntry(&scope->vars, name, NULL);
490 	Var *v = VarNew(FStr_InitRefer(/* aliased to */ he->key), value,
491 	    false, false, (flags & VAR_SET_READONLY) != 0);
492 	HashEntry_Set(he, v);
493 	DEBUG4(VAR, "%s: %s = %s%s\n",
494 	    scope->name, name, value, ValueDescription(value));
495 	return v;
496 }
497 
498 /*
499  * Remove a variable from a scope, freeing all related memory as well.
500  * The variable name is kept as-is, it is not expanded.
501  */
502 void
503 Var_Delete(GNode *scope, const char *varname)
504 {
505 	HashEntry *he = HashTable_FindEntry(&scope->vars, varname);
506 	Var *v;
507 
508 	if (he == NULL) {
509 		DEBUG2(VAR, "%s: delete %s (not found)\n",
510 		    scope->name, varname);
511 		return;
512 	}
513 
514 	DEBUG2(VAR, "%s: delete %s\n", scope->name, varname);
515 	v = he->value;
516 	if (v->inUse) {
517 		Parse_Error(PARSE_FATAL,
518 		    "Cannot delete variable \"%s\" while it is used",
519 		    v->name.str);
520 		return;
521 	}
522 
523 	if (v->exported)
524 		unsetenv(v->name.str);
525 	if (strcmp(v->name.str, ".MAKE.EXPORTED") == 0)
526 		var_exportedVars = VAR_EXPORTED_NONE;
527 
528 	assert(v->name.freeIt == NULL);
529 	HashTable_DeleteEntry(&scope->vars, he);
530 	Buf_Done(&v->val);
531 	free(v);
532 }
533 
534 /*
535  * Undefine one or more variables from the global scope.
536  * The argument is expanded exactly once and then split into words.
537  */
538 void
539 Var_Undef(const char *arg)
540 {
541 	char *expanded;
542 	Words varnames;
543 	size_t i;
544 
545 	if (arg[0] == '\0') {
546 		Parse_Error(PARSE_FATAL,
547 		    "The .undef directive requires an argument");
548 		return;
549 	}
550 
551 	expanded = Var_Subst(arg, SCOPE_GLOBAL, VARE_WANTRES);
552 	if (expanded == var_Error) {
553 		/* TODO: Make this part of the code reachable. */
554 		Parse_Error(PARSE_FATAL,
555 		    "Error in variable names to be undefined");
556 		return;
557 	}
558 
559 	varnames = Str_Words(expanded, false);
560 	if (varnames.len == 1 && varnames.words[0][0] == '\0')
561 		varnames.len = 0;
562 
563 	for (i = 0; i < varnames.len; i++) {
564 		const char *varname = varnames.words[i];
565 		Global_Delete(varname);
566 	}
567 
568 	Words_Free(varnames);
569 	free(expanded);
570 }
571 
572 static bool
573 MayExport(const char *name)
574 {
575 	if (name[0] == '.')
576 		return false;	/* skip internals */
577 	if (name[0] == '-')
578 		return false;	/* skip misnamed variables */
579 	if (name[1] == '\0') {
580 		/*
581 		 * A single char.
582 		 * If it is one of the variables that should only appear in
583 		 * local scope, skip it, else we can get Var_Subst
584 		 * into a loop.
585 		 */
586 		switch (name[0]) {
587 		case '@':
588 		case '%':
589 		case '*':
590 		case '!':
591 			return false;
592 		}
593 	}
594 	return true;
595 }
596 
597 static bool
598 ExportVarEnv(Var *v)
599 {
600 	const char *name = v->name.str;
601 	char *val = v->val.data;
602 	char *expr;
603 
604 	if (v->exported && !v->reexport)
605 		return false;	/* nothing to do */
606 
607 	if (strchr(val, '$') == NULL) {
608 		if (!v->exported)
609 			setenv(name, val, 1);
610 		return true;
611 	}
612 
613 	if (v->inUse) {
614 		/*
615 		 * We recursed while exporting in a child.
616 		 * This isn't going to end well, just skip it.
617 		 */
618 		return false;
619 	}
620 
621 	/* XXX: name is injected without escaping it */
622 	expr = str_concat3("${", name, "}");
623 	val = Var_Subst(expr, SCOPE_GLOBAL, VARE_WANTRES);
624 	/* TODO: handle errors */
625 	setenv(name, val, 1);
626 	free(val);
627 	free(expr);
628 	return true;
629 }
630 
631 static bool
632 ExportVarPlain(Var *v)
633 {
634 	if (strchr(v->val.data, '$') == NULL) {
635 		setenv(v->name.str, v->val.data, 1);
636 		v->exported = true;
637 		v->reexport = false;
638 		return true;
639 	}
640 
641 	/*
642 	 * Flag the variable as something we need to re-export.
643 	 * No point actually exporting it now though,
644 	 * the child process can do it at the last minute.
645 	 * Avoid calling setenv more often than necessary since it can leak.
646 	 */
647 	v->exported = true;
648 	v->reexport = true;
649 	return true;
650 }
651 
652 static bool
653 ExportVarLiteral(Var *v)
654 {
655 	if (v->exported && !v->reexport)
656 		return false;
657 
658 	if (!v->exported)
659 		setenv(v->name.str, v->val.data, 1);
660 
661 	return true;
662 }
663 
664 /*
665  * Mark a single variable to be exported later for subprocesses.
666  *
667  * Internal variables (those starting with '.') are not exported.
668  */
669 static bool
670 ExportVar(const char *name, VarExportMode mode)
671 {
672 	Var *v;
673 
674 	if (!MayExport(name))
675 		return false;
676 
677 	v = VarFind(name, SCOPE_GLOBAL, false);
678 	if (v == NULL)
679 		return false;
680 
681 	if (mode == VEM_ENV)
682 		return ExportVarEnv(v);
683 	else if (mode == VEM_PLAIN)
684 		return ExportVarPlain(v);
685 	else
686 		return ExportVarLiteral(v);
687 }
688 
689 /*
690  * Actually export the variables that have been marked as needing to be
691  * re-exported.
692  */
693 void
694 Var_ReexportVars(void)
695 {
696 	char *xvarnames;
697 
698 	/*
699 	 * Several make implementations support this sort of mechanism for
700 	 * tracking recursion - but each uses a different name.
701 	 * We allow the makefiles to update MAKELEVEL and ensure
702 	 * children see a correctly incremented value.
703 	 */
704 	char tmp[21];
705 	snprintf(tmp, sizeof tmp, "%d", makelevel + 1);
706 	setenv(MAKE_LEVEL_ENV, tmp, 1);
707 
708 	if (var_exportedVars == VAR_EXPORTED_NONE)
709 		return;
710 
711 	if (var_exportedVars == VAR_EXPORTED_ALL) {
712 		HashIter hi;
713 
714 		/* Ouch! Exporting all variables at once is crazy. */
715 		HashIter_Init(&hi, &SCOPE_GLOBAL->vars);
716 		while (HashIter_Next(&hi) != NULL) {
717 			Var *var = hi.entry->value;
718 			ExportVar(var->name.str, VEM_ENV);
719 		}
720 		return;
721 	}
722 
723 	xvarnames = Var_Subst("${.MAKE.EXPORTED:O:u}", SCOPE_GLOBAL,
724 	    VARE_WANTRES);
725 	/* TODO: handle errors */
726 	if (xvarnames[0] != '\0') {
727 		Words varnames = Str_Words(xvarnames, false);
728 		size_t i;
729 
730 		for (i = 0; i < varnames.len; i++)
731 			ExportVar(varnames.words[i], VEM_ENV);
732 		Words_Free(varnames);
733 	}
734 	free(xvarnames);
735 }
736 
737 static void
738 ExportVars(const char *varnames, bool isExport, VarExportMode mode)
739 /* TODO: try to combine the parameters 'isExport' and 'mode'. */
740 {
741 	Words words = Str_Words(varnames, false);
742 	size_t i;
743 
744 	if (words.len == 1 && words.words[0][0] == '\0')
745 		words.len = 0;
746 
747 	for (i = 0; i < words.len; i++) {
748 		const char *varname = words.words[i];
749 		if (!ExportVar(varname, mode))
750 			continue;
751 
752 		if (var_exportedVars == VAR_EXPORTED_NONE)
753 			var_exportedVars = VAR_EXPORTED_SOME;
754 
755 		if (isExport && mode == VEM_PLAIN)
756 			Global_Append(".MAKE.EXPORTED", varname);
757 	}
758 	Words_Free(words);
759 }
760 
761 static void
762 ExportVarsExpand(const char *uvarnames, bool isExport, VarExportMode mode)
763 {
764 	char *xvarnames = Var_Subst(uvarnames, SCOPE_GLOBAL, VARE_WANTRES);
765 	/* TODO: handle errors */
766 	ExportVars(xvarnames, isExport, mode);
767 	free(xvarnames);
768 }
769 
770 /* Export the named variables, or all variables. */
771 void
772 Var_Export(VarExportMode mode, const char *varnames)
773 {
774 	if (mode == VEM_PLAIN && varnames[0] == '\0') {
775 		var_exportedVars = VAR_EXPORTED_ALL; /* use with caution! */
776 		return;
777 	}
778 
779 	ExportVarsExpand(varnames, true, mode);
780 }
781 
782 void
783 Var_ExportVars(const char *varnames)
784 {
785 	ExportVarsExpand(varnames, false, VEM_PLAIN);
786 }
787 
788 
789 extern char **environ;
790 
791 static void
792 ClearEnv(void)
793 {
794 	const char *cp;
795 	char **newenv;
796 
797 	cp = getenv(MAKE_LEVEL_ENV);	/* we should preserve this */
798 	if (environ == savedEnv) {
799 		/* we have been here before! */
800 		newenv = bmake_realloc(environ, 2 * sizeof(char *));
801 	} else {
802 		if (savedEnv != NULL) {
803 			free(savedEnv);
804 			savedEnv = NULL;
805 		}
806 		newenv = bmake_malloc(2 * sizeof(char *));
807 	}
808 
809 	/* Note: we cannot safely free() the original environ. */
810 	environ = savedEnv = newenv;
811 	newenv[0] = NULL;
812 	newenv[1] = NULL;
813 	if (cp != NULL && *cp != '\0')
814 		setenv(MAKE_LEVEL_ENV, cp, 1);
815 }
816 
817 static void
818 GetVarnamesToUnexport(bool isEnv, const char *arg,
819 		      FStr *out_varnames, UnexportWhat *out_what)
820 {
821 	UnexportWhat what;
822 	FStr varnames = FStr_InitRefer("");
823 
824 	if (isEnv) {
825 		if (arg[0] != '\0') {
826 			Parse_Error(PARSE_FATAL,
827 			    "The directive .unexport-env does not take "
828 			    "arguments");
829 			/* continue anyway */
830 		}
831 		what = UNEXPORT_ENV;
832 
833 	} else {
834 		what = arg[0] != '\0' ? UNEXPORT_NAMED : UNEXPORT_ALL;
835 		if (what == UNEXPORT_NAMED)
836 			varnames = FStr_InitRefer(arg);
837 	}
838 
839 	if (what != UNEXPORT_NAMED) {
840 		char *expanded = Var_Subst("${.MAKE.EXPORTED:O:u}",
841 		    SCOPE_GLOBAL, VARE_WANTRES);
842 		/* TODO: handle errors */
843 		varnames = FStr_InitOwn(expanded);
844 	}
845 
846 	*out_varnames = varnames;
847 	*out_what = what;
848 }
849 
850 static void
851 UnexportVar(Substring varname, UnexportWhat what)
852 {
853 	Var *v = VarFindSubstring(varname, SCOPE_GLOBAL, false);
854 	if (v == NULL) {
855 		DEBUG2(VAR, "Not unexporting \"%.*s\" (not found)\n",
856 		    (int)Substring_Length(varname), varname.start);
857 		return;
858 	}
859 
860 	DEBUG2(VAR, "Unexporting \"%.*s\"\n",
861 	    (int)Substring_Length(varname), varname.start);
862 	if (what != UNEXPORT_ENV && v->exported && !v->reexport)
863 		unsetenv(v->name.str);
864 	v->exported = false;
865 	v->reexport = false;
866 
867 	if (what == UNEXPORT_NAMED) {
868 		/* Remove the variable names from .MAKE.EXPORTED. */
869 		/* XXX: v->name is injected without escaping it */
870 		char *expr = str_concat3("${.MAKE.EXPORTED:N",
871 		    v->name.str, "}");
872 		char *cp = Var_Subst(expr, SCOPE_GLOBAL, VARE_WANTRES);
873 		/* TODO: handle errors */
874 		Global_Set(".MAKE.EXPORTED", cp);
875 		free(cp);
876 		free(expr);
877 	}
878 }
879 
880 static void
881 UnexportVars(FStr *varnames, UnexportWhat what)
882 {
883 	size_t i;
884 	SubstringWords words;
885 
886 	if (what == UNEXPORT_ENV)
887 		ClearEnv();
888 
889 	words = Substring_Words(varnames->str, false);
890 	for (i = 0; i < words.len; i++)
891 		UnexportVar(words.words[i], what);
892 	SubstringWords_Free(words);
893 
894 	if (what != UNEXPORT_NAMED)
895 		Global_Delete(".MAKE.EXPORTED");
896 }
897 
898 /*
899  * This is called when .unexport[-env] is seen.
900  *
901  * str must have the form "unexport[-env] varname...".
902  */
903 void
904 Var_UnExport(bool isEnv, const char *arg)
905 {
906 	UnexportWhat what;
907 	FStr varnames;
908 
909 	GetVarnamesToUnexport(isEnv, arg, &varnames, &what);
910 	UnexportVars(&varnames, what);
911 	FStr_Done(&varnames);
912 }
913 
914 /*
915  * When there is a variable of the same name in the command line scope, the
916  * global variable would not be visible anywhere.  Therefore there is no
917  * point in setting it at all.
918  *
919  * See 'scope == SCOPE_CMDLINE' in Var_SetWithFlags.
920  */
921 static bool
922 ExistsInCmdline(const char *name, const char *val)
923 {
924 	Var *v;
925 
926 	v = VarFind(name, SCOPE_CMDLINE, false);
927 	if (v == NULL)
928 		return false;
929 
930 	if (v->fromCmd) {
931 		DEBUG3(VAR, "%s: %s = %s ignored!\n",
932 		    SCOPE_GLOBAL->name, name, val);
933 		return true;
934 	}
935 
936 	VarFreeShortLived(v);
937 	return false;
938 }
939 
940 /* Set the variable to the value; the name is not expanded. */
941 void
942 Var_SetWithFlags(GNode *scope, const char *name, const char *val,
943 		 VarSetFlags flags)
944 {
945 	Var *v;
946 
947 	assert(val != NULL);
948 	if (name[0] == '\0') {
949 		DEBUG0(VAR, "SetVar: variable name is empty - ignored\n");
950 		return;
951 	}
952 
953 	if (scope == SCOPE_GLOBAL && ExistsInCmdline(name, val))
954 		return;
955 
956 	/*
957 	 * Only look for a variable in the given scope since anything set
958 	 * here will override anything in a lower scope, so there's not much
959 	 * point in searching them all.
960 	 */
961 	v = VarFind(name, scope, false);
962 	if (v == NULL) {
963 		if (scope == SCOPE_CMDLINE && !(flags & VAR_SET_NO_EXPORT)) {
964 			/*
965 			 * This var would normally prevent the same name being
966 			 * added to SCOPE_GLOBAL, so delete it from there if
967 			 * needed. Otherwise -V name may show the wrong value.
968 			 *
969 			 * See ExistsInCmdline.
970 			 */
971 			Var_Delete(SCOPE_GLOBAL, name);
972 		}
973 		if (strcmp(name, ".SUFFIXES") == 0) {
974 			/* special: treat as readOnly */
975 			DEBUG3(VAR, "%s: %s = %s ignored (read-only)\n",
976 			    scope->name, name, val);
977 			return;
978 		}
979 		v = VarAdd(name, val, scope, flags);
980 	} else {
981 		if (v->readOnly && !(flags & VAR_SET_READONLY)) {
982 			DEBUG3(VAR, "%s: %s = %s ignored (read-only)\n",
983 			    scope->name, name, val);
984 			return;
985 		}
986 		Buf_Clear(&v->val);
987 		Buf_AddStr(&v->val, val);
988 
989 		DEBUG4(VAR, "%s: %s = %s%s\n",
990 		    scope->name, name, val, ValueDescription(val));
991 		if (v->exported)
992 			ExportVar(name, VEM_PLAIN);
993 	}
994 
995 	/*
996 	 * Any variables given on the command line are automatically exported
997 	 * to the environment (as per POSIX standard), except for internals.
998 	 */
999 	if (scope == SCOPE_CMDLINE && !(flags & VAR_SET_NO_EXPORT) &&
1000 	    name[0] != '.') {
1001 		v->fromCmd = true;
1002 
1003 		/*
1004 		 * If requested, don't export these in the environment
1005 		 * individually.  We still put them in .MAKEOVERRIDES so
1006 		 * that the command-line settings continue to override
1007 		 * Makefile settings.
1008 		 */
1009 		if (!opts.varNoExportEnv)
1010 			setenv(name, val, 1);
1011 		/* XXX: What about .MAKE.EXPORTED? */
1012 		/*
1013 		 * XXX: Why not just mark the variable for needing export, as
1014 		 * in ExportVarPlain?
1015 		 */
1016 
1017 		Global_Append(".MAKEOVERRIDES", name);
1018 	}
1019 
1020 	if (name[0] == '.' && strcmp(name, MAKE_SAVE_DOLLARS) == 0)
1021 		save_dollars = ParseBoolean(val, save_dollars);
1022 
1023 	if (v != NULL)
1024 		VarFreeShortLived(v);
1025 }
1026 
1027 void
1028 Var_Set(GNode *scope, const char *name, const char *val)
1029 {
1030 	Var_SetWithFlags(scope, name, val, VAR_SET_NONE);
1031 }
1032 
1033 /*
1034  * Set the variable name to the value val in the given scope.
1035  *
1036  * If the variable doesn't yet exist, it is created.
1037  * Otherwise the new value overwrites and replaces the old value.
1038  *
1039  * Input:
1040  *	scope		scope in which to set it
1041  *	name		name of the variable to set, is expanded once
1042  *	val		value to give to the variable
1043  */
1044 void
1045 Var_SetExpand(GNode *scope, const char *name, const char *val)
1046 {
1047 	const char *unexpanded_name = name;
1048 	FStr varname = FStr_InitRefer(name);
1049 
1050 	assert(val != NULL);
1051 
1052 	Var_Expand(&varname, scope, VARE_WANTRES);
1053 
1054 	if (varname.str[0] == '\0') {
1055 		DEBUG2(VAR,
1056 		    "Var_SetExpand: variable name \"%s\" expands "
1057 		    "to empty string, with value \"%s\" - ignored\n",
1058 		    unexpanded_name, val);
1059 	} else
1060 		Var_SetWithFlags(scope, varname.str, val, VAR_SET_NONE);
1061 
1062 	FStr_Done(&varname);
1063 }
1064 
1065 void
1066 Global_Set(const char *name, const char *value)
1067 {
1068 	Var_Set(SCOPE_GLOBAL, name, value);
1069 }
1070 
1071 void
1072 Global_Delete(const char *name)
1073 {
1074 	Var_Delete(SCOPE_GLOBAL, name);
1075 }
1076 
1077 void
1078 Global_Set_ReadOnly(const char *name, const char *value)
1079 {
1080 	Var_SetWithFlags(SCOPE_GLOBAL, name, value, VAR_SET_READONLY);
1081 }
1082 
1083 /*
1084  * Append the value to the named variable.
1085  *
1086  * If the variable doesn't exist, it is created.  Otherwise a single space
1087  * and the given value are appended.
1088  */
1089 void
1090 Var_Append(GNode *scope, const char *name, const char *val)
1091 {
1092 	Var *v;
1093 
1094 	v = VarFind(name, scope, scope == SCOPE_GLOBAL);
1095 
1096 	if (v == NULL) {
1097 		Var_SetWithFlags(scope, name, val, VAR_SET_NONE);
1098 	} else if (v->readOnly) {
1099 		DEBUG1(VAR, "Ignoring append to %s since it is read-only\n",
1100 		    name);
1101 	} else if (scope == SCOPE_CMDLINE || !v->fromCmd) {
1102 		Buf_AddByte(&v->val, ' ');
1103 		Buf_AddStr(&v->val, val);
1104 
1105 		DEBUG3(VAR, "%s: %s = %s\n", scope->name, name, v->val.data);
1106 
1107 		if (v->fromEnvironment) {
1108 			/* See VarAdd. */
1109 			HashEntry *he =
1110 			    HashTable_CreateEntry(&scope->vars, name, NULL);
1111 			HashEntry_Set(he, v);
1112 			FStr_Done(&v->name);
1113 			v->name = FStr_InitRefer(/* aliased to */ he->key);
1114 			v->shortLived = false;
1115 			v->fromEnvironment = false;
1116 		}
1117 	}
1118 }
1119 
1120 /*
1121  * The variable of the given name has the given value appended to it in the
1122  * given scope.
1123  *
1124  * If the variable doesn't exist, it is created. Otherwise the strings are
1125  * concatenated, with a space in between.
1126  *
1127  * Input:
1128  *	scope		scope in which this should occur
1129  *	name		name of the variable to modify, is expanded once
1130  *	val		string to append to it
1131  *
1132  * Notes:
1133  *	Only if the variable is being sought in the global scope is the
1134  *	environment searched.
1135  *	XXX: Knows its calling circumstances in that if called with scope
1136  *	an actual target, it will only search that scope since only
1137  *	a local variable could be being appended to. This is actually
1138  *	a big win and must be tolerated.
1139  */
1140 void
1141 Var_AppendExpand(GNode *scope, const char *name, const char *val)
1142 {
1143 	FStr xname = FStr_InitRefer(name);
1144 
1145 	assert(val != NULL);
1146 
1147 	Var_Expand(&xname, scope, VARE_WANTRES);
1148 	if (xname.str != name && xname.str[0] == '\0')
1149 		DEBUG2(VAR,
1150 		    "Var_AppendExpand: variable name \"%s\" expands "
1151 		    "to empty string, with value \"%s\" - ignored\n",
1152 		    name, val);
1153 	else
1154 		Var_Append(scope, xname.str, val);
1155 
1156 	FStr_Done(&xname);
1157 }
1158 
1159 void
1160 Global_Append(const char *name, const char *value)
1161 {
1162 	Var_Append(SCOPE_GLOBAL, name, value);
1163 }
1164 
1165 bool
1166 Var_Exists(GNode *scope, const char *name)
1167 {
1168 	Var *v = VarFind(name, scope, true);
1169 	if (v == NULL)
1170 		return false;
1171 
1172 	VarFreeShortLived(v);
1173 	return true;
1174 }
1175 
1176 /*
1177  * See if the given variable exists, in the given scope or in other
1178  * fallback scopes.
1179  *
1180  * Input:
1181  *	scope		scope in which to start search
1182  *	name		name of the variable to find, is expanded once
1183  */
1184 bool
1185 Var_ExistsExpand(GNode *scope, const char *name)
1186 {
1187 	FStr varname = FStr_InitRefer(name);
1188 	bool exists;
1189 
1190 	Var_Expand(&varname, scope, VARE_WANTRES);
1191 	exists = Var_Exists(scope, varname.str);
1192 	FStr_Done(&varname);
1193 	return exists;
1194 }
1195 
1196 /*
1197  * Return the unexpanded value of the given variable in the given scope,
1198  * or the usual scopes.
1199  *
1200  * Input:
1201  *	scope		scope in which to search for it
1202  *	name		name to find, is not expanded any further
1203  *
1204  * Results:
1205  *	The value if the variable exists, NULL if it doesn't.
1206  *	The value is valid until the next modification to any variable.
1207  */
1208 FStr
1209 Var_Value(GNode *scope, const char *name)
1210 {
1211 	Var *v = VarFind(name, scope, true);
1212 	char *value;
1213 
1214 	if (v == NULL)
1215 		return FStr_InitRefer(NULL);
1216 
1217 	if (!v->shortLived)
1218 		return FStr_InitRefer(v->val.data);
1219 
1220 	value = v->val.data;
1221 	v->val.data = NULL;
1222 	VarFreeShortLived(v);
1223 
1224 	return FStr_InitOwn(value);
1225 }
1226 
1227 /*
1228  * set readOnly attribute of specified var if it exists
1229  */
1230 void
1231 Var_ReadOnly(const char *name, bool bf)
1232 {
1233 	Var *v;
1234 
1235 	v = VarFind(name, SCOPE_GLOBAL, false);
1236 	if (v == NULL) {
1237 		DEBUG1(VAR, "Var_ReadOnly: %s not found\n", name);
1238 		return;
1239 	}
1240 	v->readOnly = bf;
1241 	DEBUG2(VAR, "Var_ReadOnly: %s %s\n", name, bf ? "true" : "false");
1242 }
1243 
1244 /*
1245  * Return the unexpanded variable value from this node, without trying to look
1246  * up the variable in any other scope.
1247  */
1248 const char *
1249 GNode_ValueDirect(GNode *gn, const char *name)
1250 {
1251 	Var *v = VarFind(name, gn, false);
1252 	return v != NULL ? v->val.data : NULL;
1253 }
1254 
1255 static VarEvalMode
1256 VarEvalMode_WithoutKeepDollar(VarEvalMode emode)
1257 {
1258 	if (emode == VARE_KEEP_DOLLAR_UNDEF)
1259 		return VARE_EVAL_KEEP_UNDEF;
1260 	if (emode == VARE_EVAL_KEEP_DOLLAR)
1261 		return VARE_WANTRES;
1262 	return emode;
1263 }
1264 
1265 static VarEvalMode
1266 VarEvalMode_UndefOk(VarEvalMode emode)
1267 {
1268 	return emode == VARE_UNDEFERR ? VARE_WANTRES : emode;
1269 }
1270 
1271 static bool
1272 VarEvalMode_ShouldEval(VarEvalMode emode)
1273 {
1274 	return emode != VARE_PARSE_ONLY;
1275 }
1276 
1277 static bool
1278 VarEvalMode_ShouldKeepUndef(VarEvalMode emode)
1279 {
1280 	return emode == VARE_EVAL_KEEP_UNDEF ||
1281 	       emode == VARE_KEEP_DOLLAR_UNDEF;
1282 }
1283 
1284 static bool
1285 VarEvalMode_ShouldKeepDollar(VarEvalMode emode)
1286 {
1287 	return emode == VARE_EVAL_KEEP_DOLLAR ||
1288 	       emode == VARE_KEEP_DOLLAR_UNDEF;
1289 }
1290 
1291 
1292 static void
1293 SepBuf_Init(SepBuf *buf, char sep)
1294 {
1295 	Buf_InitSize(&buf->buf, 32);
1296 	buf->needSep = false;
1297 	buf->sep = sep;
1298 }
1299 
1300 static void
1301 SepBuf_Sep(SepBuf *buf)
1302 {
1303 	buf->needSep = true;
1304 }
1305 
1306 static void
1307 SepBuf_AddBytes(SepBuf *buf, const char *mem, size_t mem_size)
1308 {
1309 	if (mem_size == 0)
1310 		return;
1311 	if (buf->needSep && buf->sep != '\0') {
1312 		Buf_AddByte(&buf->buf, buf->sep);
1313 		buf->needSep = false;
1314 	}
1315 	Buf_AddBytes(&buf->buf, mem, mem_size);
1316 }
1317 
1318 static void
1319 SepBuf_AddBytesBetween(SepBuf *buf, const char *start, const char *end)
1320 {
1321 	SepBuf_AddBytes(buf, start, (size_t)(end - start));
1322 }
1323 
1324 static void
1325 SepBuf_AddStr(SepBuf *buf, const char *str)
1326 {
1327 	SepBuf_AddBytes(buf, str, strlen(str));
1328 }
1329 
1330 static void
1331 SepBuf_AddSubstring(SepBuf *buf, Substring sub)
1332 {
1333 	SepBuf_AddBytesBetween(buf, sub.start, sub.end);
1334 }
1335 
1336 static char *
1337 SepBuf_DoneData(SepBuf *buf)
1338 {
1339 	return Buf_DoneData(&buf->buf);
1340 }
1341 
1342 
1343 /*
1344  * This callback for ModifyWords gets a single word from a variable expression
1345  * and typically adds a modification of this word to the buffer. It may also
1346  * do nothing or add several words.
1347  *
1348  * For example, when evaluating the modifier ':M*b' in ${:Ua b c:M*b}, the
1349  * callback is called 3 times, once for "a", "b" and "c".
1350  *
1351  * Some ModifyWord functions assume that they are always passed a
1352  * null-terminated substring, which is currently guaranteed but may change in
1353  * the future.
1354  */
1355 typedef void (*ModifyWordProc)(Substring word, SepBuf *buf, void *data);
1356 
1357 
1358 /*
1359  * Callback for ModifyWords to implement the :H modifier.
1360  * Add the dirname of the given word to the buffer.
1361  */
1362 /*ARGSUSED*/
1363 static void
1364 ModifyWord_Head(Substring word, SepBuf *buf, void *dummy MAKE_ATTR_UNUSED)
1365 {
1366 	SepBuf_AddSubstring(buf, Substring_Dirname(word));
1367 }
1368 
1369 /*
1370  * Callback for ModifyWords to implement the :T modifier.
1371  * Add the basename of the given word to the buffer.
1372  */
1373 /*ARGSUSED*/
1374 static void
1375 ModifyWord_Tail(Substring word, SepBuf *buf, void *dummy MAKE_ATTR_UNUSED)
1376 {
1377 	SepBuf_AddSubstring(buf, Substring_Basename(word));
1378 }
1379 
1380 /*
1381  * Callback for ModifyWords to implement the :E modifier.
1382  * Add the filename suffix of the given word to the buffer, if it exists.
1383  */
1384 /*ARGSUSED*/
1385 static void
1386 ModifyWord_Suffix(Substring word, SepBuf *buf, void *dummy MAKE_ATTR_UNUSED)
1387 {
1388 	const char *lastDot = Substring_LastIndex(word, '.');
1389 	if (lastDot != NULL)
1390 		SepBuf_AddBytesBetween(buf, lastDot + 1, word.end);
1391 }
1392 
1393 /*
1394  * Callback for ModifyWords to implement the :R modifier.
1395  * Add the filename without extension of the given word to the buffer.
1396  */
1397 /*ARGSUSED*/
1398 static void
1399 ModifyWord_Root(Substring word, SepBuf *buf, void *dummy MAKE_ATTR_UNUSED)
1400 {
1401 	const char *lastDot, *end;
1402 
1403 	lastDot = Substring_LastIndex(word, '.');
1404 	end = lastDot != NULL ? lastDot : word.end;
1405 	SepBuf_AddBytesBetween(buf, word.start, end);
1406 }
1407 
1408 /*
1409  * Callback for ModifyWords to implement the :M modifier.
1410  * Place the word in the buffer if it matches the given pattern.
1411  */
1412 static void
1413 ModifyWord_Match(Substring word, SepBuf *buf, void *data)
1414 {
1415 	const char *pattern = data;
1416 
1417 	assert(word.end[0] == '\0');	/* assume null-terminated word */
1418 	if (Str_Match(word.start, pattern))
1419 		SepBuf_AddSubstring(buf, word);
1420 }
1421 
1422 /*
1423  * Callback for ModifyWords to implement the :N modifier.
1424  * Place the word in the buffer if it doesn't match the given pattern.
1425  */
1426 static void
1427 ModifyWord_NoMatch(Substring word, SepBuf *buf, void *data)
1428 {
1429 	const char *pattern = data;
1430 
1431 	assert(word.end[0] == '\0');	/* assume null-terminated word */
1432 	if (!Str_Match(word.start, pattern))
1433 		SepBuf_AddSubstring(buf, word);
1434 }
1435 
1436 #ifdef SYSVVARSUB
1437 struct ModifyWord_SysVSubstArgs {
1438 	GNode *scope;
1439 	Substring lhsPrefix;
1440 	bool lhsPercent;
1441 	Substring lhsSuffix;
1442 	const char *rhs;
1443 };
1444 
1445 /* Callback for ModifyWords to implement the :%.from=%.to modifier. */
1446 static void
1447 ModifyWord_SysVSubst(Substring word, SepBuf *buf, void *data)
1448 {
1449 	const struct ModifyWord_SysVSubstArgs *args = data;
1450 	FStr rhs;
1451 	const char *percent;
1452 
1453 	if (Substring_IsEmpty(word))
1454 		return;
1455 
1456 	if (!Substring_HasPrefix(word, args->lhsPrefix) ||
1457 	    !Substring_HasSuffix(word, args->lhsSuffix)) {
1458 		SepBuf_AddSubstring(buf, word);
1459 		return;
1460 	}
1461 
1462 	rhs = FStr_InitRefer(args->rhs);
1463 	Var_Expand(&rhs, args->scope, VARE_WANTRES);
1464 
1465 	percent = args->lhsPercent ? strchr(rhs.str, '%') : NULL;
1466 
1467 	if (percent != NULL)
1468 		SepBuf_AddBytesBetween(buf, rhs.str, percent);
1469 	if (percent != NULL || !args->lhsPercent)
1470 		SepBuf_AddBytesBetween(buf,
1471 		    word.start + Substring_Length(args->lhsPrefix),
1472 		    word.end - Substring_Length(args->lhsSuffix));
1473 	SepBuf_AddStr(buf, percent != NULL ? percent + 1 : rhs.str);
1474 
1475 	FStr_Done(&rhs);
1476 }
1477 #endif
1478 
1479 
1480 struct ModifyWord_SubstArgs {
1481 	Substring lhs;
1482 	Substring rhs;
1483 	PatternFlags pflags;
1484 	bool matched;
1485 };
1486 
1487 static const char *
1488 Substring_Find(Substring haystack, Substring needle)
1489 {
1490 	size_t len, needleLen, i;
1491 
1492 	len = Substring_Length(haystack);
1493 	needleLen = Substring_Length(needle);
1494 	for (i = 0; i + needleLen <= len; i++)
1495 		if (memcmp(haystack.start + i, needle.start, needleLen) == 0)
1496 			return haystack.start + i;
1497 	return NULL;
1498 }
1499 
1500 /*
1501  * Callback for ModifyWords to implement the :S,from,to, modifier.
1502  * Perform a string substitution on the given word.
1503  */
1504 static void
1505 ModifyWord_Subst(Substring word, SepBuf *buf, void *data)
1506 {
1507 	struct ModifyWord_SubstArgs *args = data;
1508 	size_t wordLen, lhsLen;
1509 	const char *wordEnd, *match;
1510 
1511 	wordLen = Substring_Length(word);
1512 	wordEnd = word.end;
1513 	if (args->pflags.subOnce && args->matched)
1514 		goto nosub;
1515 
1516 	lhsLen = Substring_Length(args->lhs);
1517 	if (args->pflags.anchorStart) {
1518 		if (wordLen < lhsLen ||
1519 		    memcmp(word.start, args->lhs.start, lhsLen) != 0)
1520 			goto nosub;
1521 
1522 		if (args->pflags.anchorEnd && wordLen != lhsLen)
1523 			goto nosub;
1524 
1525 		/* :S,^prefix,replacement, or :S,^whole$,replacement, */
1526 		SepBuf_AddSubstring(buf, args->rhs);
1527 		SepBuf_AddBytesBetween(buf, word.start + lhsLen, wordEnd);
1528 		args->matched = true;
1529 		return;
1530 	}
1531 
1532 	if (args->pflags.anchorEnd) {
1533 		if (wordLen < lhsLen)
1534 			goto nosub;
1535 		if (memcmp(wordEnd - lhsLen, args->lhs.start, lhsLen) != 0)
1536 			goto nosub;
1537 
1538 		/* :S,suffix$,replacement, */
1539 		SepBuf_AddBytesBetween(buf, word.start, wordEnd - lhsLen);
1540 		SepBuf_AddSubstring(buf, args->rhs);
1541 		args->matched = true;
1542 		return;
1543 	}
1544 
1545 	if (Substring_IsEmpty(args->lhs))
1546 		goto nosub;
1547 
1548 	/* unanchored case, may match more than once */
1549 	while ((match = Substring_Find(word, args->lhs)) != NULL) {
1550 		SepBuf_AddBytesBetween(buf, word.start, match);
1551 		SepBuf_AddSubstring(buf, args->rhs);
1552 		args->matched = true;
1553 		word.start = match + lhsLen;
1554 		if (Substring_IsEmpty(word) || !args->pflags.subGlobal)
1555 			break;
1556 	}
1557 nosub:
1558 	SepBuf_AddSubstring(buf, word);
1559 }
1560 
1561 #ifndef NO_REGEX
1562 /* Print the error caused by a regcomp or regexec call. */
1563 static void
1564 VarREError(int reerr, const regex_t *pat, const char *str)
1565 {
1566 	size_t errlen = regerror(reerr, pat, NULL, 0);
1567 	char *errbuf = bmake_malloc(errlen);
1568 	regerror(reerr, pat, errbuf, errlen);
1569 	Error("%s: %s", str, errbuf);
1570 	free(errbuf);
1571 }
1572 
1573 /* In the modifier ':C', replace a backreference from \0 to \9. */
1574 static void
1575 RegexReplaceBackref(char ref, SepBuf *buf, const char *wp,
1576 		    const regmatch_t *m, size_t nsub)
1577 {
1578 	unsigned int n = (unsigned)ref - '0';
1579 
1580 	if (n >= nsub)
1581 		Error("No subexpression \\%u", n);
1582 	else if (m[n].rm_so == -1) {
1583 		if (opts.strict)
1584 			Error("No match for subexpression \\%u", n);
1585 	} else {
1586 		SepBuf_AddBytesBetween(buf,
1587 		    wp + (size_t)m[n].rm_so,
1588 		    wp + (size_t)m[n].rm_eo);
1589 	}
1590 }
1591 
1592 /*
1593  * The regular expression matches the word; now add the replacement to the
1594  * buffer, taking back-references from 'wp'.
1595  */
1596 static void
1597 RegexReplace(Substring replace, SepBuf *buf, const char *wp,
1598 	     const regmatch_t *m, size_t nsub)
1599 {
1600 	const char *rp;
1601 
1602 	for (rp = replace.start; rp != replace.end; rp++) {
1603 		if (*rp == '\\' && rp + 1 != replace.end &&
1604 		    (rp[1] == '&' || rp[1] == '\\'))
1605 			SepBuf_AddBytes(buf, ++rp, 1);
1606 		else if (*rp == '\\' && rp + 1 != replace.end &&
1607 			 ch_isdigit(rp[1]))
1608 			RegexReplaceBackref(*++rp, buf, wp, m, nsub);
1609 		else if (*rp == '&') {
1610 			SepBuf_AddBytesBetween(buf,
1611 			    wp + (size_t)m[0].rm_so,
1612 			    wp + (size_t)m[0].rm_eo);
1613 		} else
1614 			SepBuf_AddBytes(buf, rp, 1);
1615 	}
1616 }
1617 
1618 struct ModifyWord_SubstRegexArgs {
1619 	regex_t re;
1620 	size_t nsub;
1621 	Substring replace;
1622 	PatternFlags pflags;
1623 	bool matched;
1624 };
1625 
1626 /*
1627  * Callback for ModifyWords to implement the :C/from/to/ modifier.
1628  * Perform a regex substitution on the given word.
1629  */
1630 static void
1631 ModifyWord_SubstRegex(Substring word, SepBuf *buf, void *data)
1632 {
1633 	struct ModifyWord_SubstRegexArgs *args = data;
1634 	int xrv;
1635 	const char *wp;
1636 	int flags = 0;
1637 	regmatch_t m[10];
1638 
1639 	assert(word.end[0] == '\0');	/* assume null-terminated word */
1640 	wp = word.start;
1641 	if (args->pflags.subOnce && args->matched)
1642 		goto no_match;
1643 
1644 again:
1645 	xrv = regexec(&args->re, wp, args->nsub, m, flags);
1646 	if (xrv == 0)
1647 		goto ok;
1648 	if (xrv != REG_NOMATCH)
1649 		VarREError(xrv, &args->re, "Unexpected regex error");
1650 no_match:
1651 	SepBuf_AddBytesBetween(buf, wp, word.end);
1652 	return;
1653 
1654 ok:
1655 	args->matched = true;
1656 	SepBuf_AddBytes(buf, wp, (size_t)m[0].rm_so);
1657 
1658 	RegexReplace(args->replace, buf, wp, m, args->nsub);
1659 
1660 	wp += (size_t)m[0].rm_eo;
1661 	if (args->pflags.subGlobal) {
1662 		flags |= REG_NOTBOL;
1663 		if (m[0].rm_so == 0 && m[0].rm_eo == 0) {
1664 			SepBuf_AddBytes(buf, wp, 1);
1665 			wp++;
1666 		}
1667 		if (*wp != '\0')
1668 			goto again;
1669 	}
1670 	if (*wp != '\0')
1671 		SepBuf_AddStr(buf, wp);
1672 }
1673 #endif
1674 
1675 
1676 struct ModifyWord_LoopArgs {
1677 	GNode *scope;
1678 	const char *var;	/* name of the temporary variable */
1679 	const char *body;	/* string to expand */
1680 	VarEvalMode emode;
1681 };
1682 
1683 /* Callback for ModifyWords to implement the :@var@...@ modifier of ODE make. */
1684 static void
1685 ModifyWord_Loop(Substring word, SepBuf *buf, void *data)
1686 {
1687 	const struct ModifyWord_LoopArgs *args;
1688 	char *s;
1689 
1690 	if (Substring_IsEmpty(word))
1691 		return;
1692 
1693 	args = data;
1694 	assert(word.end[0] == '\0');	/* assume null-terminated word */
1695 	Var_SetWithFlags(args->scope, args->var, word.start,
1696 	    VAR_SET_NO_EXPORT);
1697 	s = Var_Subst(args->body, args->scope, args->emode);
1698 	/* TODO: handle errors */
1699 
1700 	assert(word.end[0] == '\0');	/* assume null-terminated word */
1701 	DEBUG4(VAR, "ModifyWord_Loop: "
1702 		    "in \"%s\", replace \"%s\" with \"%s\" to \"%s\"\n",
1703 	    word.start, args->var, args->body, s);
1704 
1705 	if (s[0] == '\n' || Buf_EndsWith(&buf->buf, '\n'))
1706 		buf->needSep = false;
1707 	SepBuf_AddStr(buf, s);
1708 	free(s);
1709 }
1710 
1711 
1712 /*
1713  * The :[first..last] modifier selects words from the expression.
1714  * It can also reverse the words.
1715  */
1716 static char *
1717 VarSelectWords(const char *str, int first, int last,
1718 	       char sep, bool oneBigWord)
1719 {
1720 	SubstringWords words;
1721 	int len, start, end, step;
1722 	int i;
1723 
1724 	SepBuf buf;
1725 	SepBuf_Init(&buf, sep);
1726 
1727 	if (oneBigWord) {
1728 		/* fake what Substring_Words() would do */
1729 		words.len = 1;
1730 		words.words = bmake_malloc(sizeof(words.words[0]));
1731 		words.freeIt = NULL;
1732 		words.words[0] = Substring_InitStr(str); /* no need to copy */
1733 	} else {
1734 		words = Substring_Words(str, false);
1735 	}
1736 
1737 	/*
1738 	 * Now sanitize the given range.  If first or last are negative,
1739 	 * convert them to the positive equivalents (-1 gets converted to len,
1740 	 * -2 gets converted to (len - 1), etc.).
1741 	 */
1742 	len = (int)words.len;
1743 	if (first < 0)
1744 		first += len + 1;
1745 	if (last < 0)
1746 		last += len + 1;
1747 
1748 	/* We avoid scanning more of the list than we need to. */
1749 	if (first > last) {
1750 		start = (first > len ? len : first) - 1;
1751 		end = last < 1 ? 0 : last - 1;
1752 		step = -1;
1753 	} else {
1754 		start = first < 1 ? 0 : first - 1;
1755 		end = last > len ? len : last;
1756 		step = 1;
1757 	}
1758 
1759 	for (i = start; (step < 0) == (i >= end); i += step) {
1760 		SepBuf_AddSubstring(&buf, words.words[i]);
1761 		SepBuf_Sep(&buf);
1762 	}
1763 
1764 	SubstringWords_Free(words);
1765 
1766 	return SepBuf_DoneData(&buf);
1767 }
1768 
1769 
1770 /*
1771  * Callback for ModifyWords to implement the :tA modifier.
1772  * Replace each word with the result of realpath() if successful.
1773  */
1774 /*ARGSUSED*/
1775 static void
1776 ModifyWord_Realpath(Substring word, SepBuf *buf, void *data MAKE_ATTR_UNUSED)
1777 {
1778 	struct stat st;
1779 	char rbuf[MAXPATHLEN];
1780 	const char *rp;
1781 
1782 	assert(word.end[0] == '\0');	/* assume null-terminated word */
1783 	rp = cached_realpath(word.start, rbuf);
1784 	if (rp != NULL && *rp == '/' && stat(rp, &st) == 0)
1785 		SepBuf_AddStr(buf, rp);
1786 	else
1787 		SepBuf_AddSubstring(buf, word);
1788 }
1789 
1790 
1791 static char *
1792 SubstringWords_JoinFree(SubstringWords words)
1793 {
1794 	Buffer buf;
1795 	size_t i;
1796 
1797 	Buf_Init(&buf);
1798 
1799 	for (i = 0; i < words.len; i++) {
1800 		if (i != 0) {
1801 			/*
1802 			 * XXX: Use ch->sep instead of ' ', for consistency.
1803 			 */
1804 			Buf_AddByte(&buf, ' ');
1805 		}
1806 		Buf_AddBytesBetween(&buf,
1807 		    words.words[i].start, words.words[i].end);
1808 	}
1809 
1810 	SubstringWords_Free(words);
1811 
1812 	return Buf_DoneData(&buf);
1813 }
1814 
1815 
1816 /*
1817  * Quote shell meta-characters and space characters in the string.
1818  * If quoteDollar is set, also quote and double any '$' characters.
1819  */
1820 static void
1821 VarQuote(const char *str, bool quoteDollar, LazyBuf *buf)
1822 {
1823 	const char *p;
1824 
1825 	LazyBuf_Init(buf, str);
1826 	for (p = str; *p != '\0'; p++) {
1827 		if (*p == '\n') {
1828 			const char *newline = Shell_GetNewline();
1829 			if (newline == NULL)
1830 				newline = "\\\n";
1831 			LazyBuf_AddStr(buf, newline);
1832 			continue;
1833 		}
1834 		if (ch_isspace(*p) || ch_is_shell_meta(*p))
1835 			LazyBuf_Add(buf, '\\');
1836 		LazyBuf_Add(buf, *p);
1837 		if (quoteDollar && *p == '$')
1838 			LazyBuf_AddStr(buf, "\\$");
1839 	}
1840 }
1841 
1842 /*
1843  * Compute the 32-bit hash of the given string, using the MurmurHash3
1844  * algorithm. Output is encoded as 8 hex digits, in Little Endian order.
1845  */
1846 static char *
1847 VarHash(const char *str)
1848 {
1849 	static const char hexdigits[16] = "0123456789abcdef";
1850 	const unsigned char *ustr = (const unsigned char *)str;
1851 
1852 	uint32_t h = 0x971e137bU;
1853 	uint32_t c1 = 0x95543787U;
1854 	uint32_t c2 = 0x2ad7eb25U;
1855 	size_t len2 = strlen(str);
1856 
1857 	char *buf;
1858 	size_t i;
1859 
1860 	size_t len;
1861 	for (len = len2; len != 0;) {
1862 		uint32_t k = 0;
1863 		switch (len) {
1864 		default:
1865 			k = ((uint32_t)ustr[3] << 24) |
1866 			    ((uint32_t)ustr[2] << 16) |
1867 			    ((uint32_t)ustr[1] << 8) |
1868 			    (uint32_t)ustr[0];
1869 			len -= 4;
1870 			ustr += 4;
1871 			break;
1872 		case 3:
1873 			k |= (uint32_t)ustr[2] << 16;
1874 			/* FALLTHROUGH */
1875 		case 2:
1876 			k |= (uint32_t)ustr[1] << 8;
1877 			/* FALLTHROUGH */
1878 		case 1:
1879 			k |= (uint32_t)ustr[0];
1880 			len = 0;
1881 		}
1882 		c1 = c1 * 5 + 0x7b7d159cU;
1883 		c2 = c2 * 5 + 0x6bce6396U;
1884 		k *= c1;
1885 		k = (k << 11) ^ (k >> 21);
1886 		k *= c2;
1887 		h = (h << 13) ^ (h >> 19);
1888 		h = h * 5 + 0x52dce729U;
1889 		h ^= k;
1890 	}
1891 	h ^= (uint32_t)len2;
1892 	h *= 0x85ebca6b;
1893 	h ^= h >> 13;
1894 	h *= 0xc2b2ae35;
1895 	h ^= h >> 16;
1896 
1897 	buf = bmake_malloc(9);
1898 	for (i = 0; i < 8; i++) {
1899 		buf[i] = hexdigits[h & 0x0f];
1900 		h >>= 4;
1901 	}
1902 	buf[8] = '\0';
1903 	return buf;
1904 }
1905 
1906 static char *
1907 VarStrftime(const char *fmt, time_t t, bool gmt)
1908 {
1909 	char buf[BUFSIZ];
1910 
1911 	if (t == 0)
1912 		time(&t);
1913 	if (*fmt == '\0')
1914 		fmt = "%c";
1915 	strftime(buf, sizeof buf, fmt, gmt ? gmtime(&t) : localtime(&t));
1916 
1917 	buf[sizeof buf - 1] = '\0';
1918 	return bmake_strdup(buf);
1919 }
1920 
1921 /*
1922  * The ApplyModifier functions take an expression that is being evaluated.
1923  * Their task is to apply a single modifier to the expression.  This involves
1924  * parsing the modifier, evaluating it and finally updating the value of the
1925  * expression.
1926  *
1927  * Parsing the modifier
1928  *
1929  * If parsing succeeds, the parsing position *pp is updated to point to the
1930  * first character following the modifier, which typically is either ':' or
1931  * ch->endc.  The modifier doesn't have to check for this delimiter character,
1932  * this is done by ApplyModifiers.
1933  *
1934  * XXX: As of 2020-11-15, some modifiers such as :S, :C, :P, :L do not
1935  * need to be followed by a ':' or endc; this was an unintended mistake.
1936  *
1937  * If parsing fails because of a missing delimiter (as in the :S, :C or :@
1938  * modifiers), return AMR_CLEANUP.
1939  *
1940  * If parsing fails because the modifier is unknown, return AMR_UNKNOWN to
1941  * try the SysV modifier ${VAR:from=to} as fallback.  This should only be
1942  * done as long as there have been no side effects from evaluating nested
1943  * variables, to avoid evaluating them more than once.  In this case, the
1944  * parsing position may or may not be updated.  (XXX: Why not? The original
1945  * parsing position is well-known in ApplyModifiers.)
1946  *
1947  * If parsing fails and the SysV modifier ${VAR:from=to} should not be used
1948  * as a fallback, either issue an error message using Error or Parse_Error
1949  * and then return AMR_CLEANUP, or return AMR_BAD for the default error
1950  * message.  Both of these return values will stop processing the variable
1951  * expression.  (XXX: As of 2020-08-23, evaluation of the whole string
1952  * continues nevertheless after skipping a few bytes, which essentially is
1953  * undefined behavior.  Not in the sense of C, but still the resulting string
1954  * is garbage.)
1955  *
1956  * Evaluating the modifier
1957  *
1958  * After parsing, the modifier is evaluated.  The side effects from evaluating
1959  * nested variable expressions in the modifier text often already happen
1960  * during parsing though.  For most modifiers this doesn't matter since their
1961  * only noticeable effect is that they update the value of the expression.
1962  * Some modifiers such as ':sh' or '::=' have noticeable side effects though.
1963  *
1964  * Evaluating the modifier usually takes the current value of the variable
1965  * expression from ch->expr->value, or the variable name from ch->var->name
1966  * and stores the result back in expr->value via Expr_SetValueOwn or
1967  * Expr_SetValueRefer.
1968  *
1969  * If evaluating fails (as of 2020-08-23), an error message is printed using
1970  * Error.  This function has no side-effects, it really just prints the error
1971  * message.  Processing the expression continues as if everything were ok.
1972  * XXX: This should be fixed by adding proper error handling to Var_Subst,
1973  * Var_Parse, ApplyModifiers and ModifyWords.
1974  *
1975  * Housekeeping
1976  *
1977  * Some modifiers such as :D and :U turn undefined expressions into defined
1978  * expressions (see Expr_Define).
1979  *
1980  * Some modifiers need to free some memory.
1981  */
1982 
1983 typedef enum ExprDefined {
1984 	/* The variable expression is based on a regular, defined variable. */
1985 	DEF_REGULAR,
1986 	/* The variable expression is based on an undefined variable. */
1987 	DEF_UNDEF,
1988 	/*
1989 	 * The variable expression started as an undefined expression, but one
1990 	 * of the modifiers (such as ':D' or ':U') has turned the expression
1991 	 * from undefined to defined.
1992 	 */
1993 	DEF_DEFINED
1994 } ExprDefined;
1995 
1996 static const char ExprDefined_Name[][10] = {
1997 	"regular",
1998 	"undefined",
1999 	"defined"
2000 };
2001 
2002 #if __STDC_VERSION__ >= 199901L
2003 #define const_member		const
2004 #else
2005 #define const_member		/* no const possible */
2006 #endif
2007 
2008 /* An expression based on a variable, such as $@ or ${VAR:Mpattern:Q}. */
2009 typedef struct Expr {
2010 	const char *name;
2011 	FStr value;
2012 	VarEvalMode const_member emode;
2013 	GNode *const_member scope;
2014 	ExprDefined defined;
2015 } Expr;
2016 
2017 /*
2018  * The status of applying a chain of modifiers to an expression.
2019  *
2020  * The modifiers of an expression are broken into chains of modifiers,
2021  * starting a new nested chain whenever an indirect modifier starts.  There
2022  * are at most 2 nesting levels: the outer one for the direct modifiers, and
2023  * the inner one for the indirect modifiers.
2024  *
2025  * For example, the expression ${VAR:M*:${IND1}:${IND2}:O:u} has 3 chains of
2026  * modifiers:
2027  *
2028  *	Chain 1 starts with the single modifier ':M*'.
2029  *	  Chain 2 starts with all modifiers from ${IND1}.
2030  *	  Chain 2 ends at the ':' between ${IND1} and ${IND2}.
2031  *	  Chain 3 starts with all modifiers from ${IND2}.
2032  *	  Chain 3 ends at the ':' after ${IND2}.
2033  *	Chain 1 continues with the 2 modifiers ':O' and ':u'.
2034  *	Chain 1 ends at the final '}' of the expression.
2035  *
2036  * After such a chain ends, its properties no longer have any effect.
2037  *
2038  * It may or may not have been intended that 'defined' has scope Expr while
2039  * 'sep' and 'oneBigWord' have smaller scope.
2040  *
2041  * See varmod-indirect.mk.
2042  */
2043 typedef struct ModChain {
2044 	Expr *expr;
2045 	/* '\0' or '{' or '(' */
2046 	char const_member startc;
2047 	/* '\0' or '}' or ')' */
2048 	char const_member endc;
2049 	/* Word separator in expansions (see the :ts modifier). */
2050 	char sep;
2051 	/*
2052 	 * True if some modifiers that otherwise split the variable value
2053 	 * into words, like :S and :C, treat the variable value as a single
2054 	 * big word, possibly containing spaces.
2055 	 */
2056 	bool oneBigWord;
2057 } ModChain;
2058 
2059 static void
2060 Expr_Define(Expr *expr)
2061 {
2062 	if (expr->defined == DEF_UNDEF)
2063 		expr->defined = DEF_DEFINED;
2064 }
2065 
2066 static const char *
2067 Expr_Str(const Expr *expr)
2068 {
2069 	return expr->value.str;
2070 }
2071 
2072 static SubstringWords
2073 Expr_Words(const Expr *expr)
2074 {
2075 	return Substring_Words(Expr_Str(expr), false);
2076 }
2077 
2078 static void
2079 Expr_SetValue(Expr *expr, FStr value)
2080 {
2081 	FStr_Done(&expr->value);
2082 	expr->value = value;
2083 }
2084 
2085 static void
2086 Expr_SetValueOwn(Expr *expr, char *value)
2087 {
2088 	Expr_SetValue(expr, FStr_InitOwn(value));
2089 }
2090 
2091 static void
2092 Expr_SetValueRefer(Expr *expr, const char *value)
2093 {
2094 	Expr_SetValue(expr, FStr_InitRefer(value));
2095 }
2096 
2097 static bool
2098 Expr_ShouldEval(const Expr *expr)
2099 {
2100 	return VarEvalMode_ShouldEval(expr->emode);
2101 }
2102 
2103 static bool
2104 ModChain_ShouldEval(const ModChain *ch)
2105 {
2106 	return Expr_ShouldEval(ch->expr);
2107 }
2108 
2109 
2110 typedef enum ApplyModifierResult {
2111 	/* Continue parsing */
2112 	AMR_OK,
2113 	/* Not a match, try other modifiers as well. */
2114 	AMR_UNKNOWN,
2115 	/* Error out with "Bad modifier" message. */
2116 	AMR_BAD,
2117 	/* Error out without the standard error message. */
2118 	AMR_CLEANUP
2119 } ApplyModifierResult;
2120 
2121 /*
2122  * Allow backslashes to escape the delimiter, $, and \, but don't touch other
2123  * backslashes.
2124  */
2125 static bool
2126 IsEscapedModifierPart(const char *p, char delim,
2127 		      struct ModifyWord_SubstArgs *subst)
2128 {
2129 	if (p[0] != '\\')
2130 		return false;
2131 	if (p[1] == delim || p[1] == '\\' || p[1] == '$')
2132 		return true;
2133 	return p[1] == '&' && subst != NULL;
2134 }
2135 
2136 /*
2137  * In a part of a modifier, parse a subexpression and evaluate it.
2138  */
2139 static void
2140 ParseModifierPartExpr(const char **pp, LazyBuf *part, const ModChain *ch,
2141 		      VarEvalMode emode)
2142 {
2143 	const char *p = *pp;
2144 	FStr nested_val = Var_Parse(&p, ch->expr->scope,
2145 	    VarEvalMode_WithoutKeepDollar(emode));
2146 	/* TODO: handle errors */
2147 	if (VarEvalMode_ShouldEval(emode))
2148 		LazyBuf_AddStr(part, nested_val.str);
2149 	else
2150 		LazyBuf_AddSubstring(part, Substring_Init(*pp, p));
2151 	FStr_Done(&nested_val);
2152 	*pp = p;
2153 }
2154 
2155 /*
2156  * In a part of a modifier, parse some text that looks like a subexpression.
2157  * If the text starts with '$(', any '(' and ')' must be balanced.
2158  * If the text starts with '${', any '{' and '}' must be balanced.
2159  * If the text starts with '$', that '$' is copied, it is not parsed as a
2160  * short-name variable expression.
2161  */
2162 static void
2163 ParseModifierPartBalanced(const char **pp, LazyBuf *part)
2164 {
2165 	const char *p = *pp;
2166 	const char *start = *pp;
2167 
2168 	if (p[1] == '(' || p[1] == '{') {
2169 		char startc = p[1];
2170 		int endc = startc == '(' ? ')' : '}';
2171 		int depth = 1;
2172 
2173 		for (p += 2; *p != '\0' && depth > 0; p++) {
2174 			if (p[-1] != '\\') {
2175 				if (*p == startc)
2176 					depth++;
2177 				if (*p == endc)
2178 					depth--;
2179 			}
2180 		}
2181 		LazyBuf_AddSubstring(part, Substring_Init(start, p));
2182 		*pp = p;
2183 	} else {
2184 		LazyBuf_Add(part, *start);
2185 		*pp = p + 1;
2186 	}
2187 }
2188 
2189 /* See ParseModifierPart for the documentation. */
2190 static bool
2191 ParseModifierPartSubst(
2192     const char **pp,
2193     char delim,
2194     VarEvalMode emode,
2195     ModChain *ch,
2196     LazyBuf *part,
2197     /*
2198      * For the first part of the modifier ':S', set anchorEnd if the last
2199      * character of the pattern is a $.
2200      */
2201     PatternFlags *out_pflags,
2202     /*
2203      * For the second part of the :S modifier, allow ampersands to be escaped
2204      * and replace unescaped ampersands with subst->lhs.
2205      */
2206     struct ModifyWord_SubstArgs *subst
2207 )
2208 {
2209 	const char *p;
2210 
2211 	p = *pp;
2212 	LazyBuf_Init(part, p);
2213 
2214 	while (*p != '\0' && *p != delim) {
2215 		if (IsEscapedModifierPart(p, delim, subst)) {
2216 			LazyBuf_Add(part, p[1]);
2217 			p += 2;
2218 		} else if (*p != '$') {	/* Unescaped, simple text */
2219 			if (subst != NULL && *p == '&')
2220 				LazyBuf_AddSubstring(part, subst->lhs);
2221 			else
2222 				LazyBuf_Add(part, *p);
2223 			p++;
2224 		} else if (p[1] == delim) {	/* Unescaped '$' at end */
2225 			if (out_pflags != NULL)
2226 				out_pflags->anchorEnd = true;
2227 			else
2228 				LazyBuf_Add(part, *p);
2229 			p++;
2230 		} else if (emode == VARE_PARSE_BALANCED)
2231 			ParseModifierPartBalanced(&p, part);
2232 		else
2233 			ParseModifierPartExpr(&p, part, ch, emode);
2234 	}
2235 
2236 	if (*p != delim) {
2237 		*pp = p;
2238 		Error("Unfinished modifier for \"%s\" ('%c' missing)",
2239 		    ch->expr->name, delim);
2240 		LazyBuf_Done(part);
2241 		return false;
2242 	}
2243 
2244 	*pp = p + 1;
2245 
2246 	{
2247 		Substring sub = LazyBuf_Get(part);
2248 		DEBUG2(VAR, "Modifier part: \"%.*s\"\n",
2249 		    (int)Substring_Length(sub), sub.start);
2250 	}
2251 
2252 	return true;
2253 }
2254 
2255 /*
2256  * Parse a part of a modifier such as the "from" and "to" in :S/from/to/ or
2257  * the "var" or "replacement ${var}" in :@var@replacement ${var}@, up to and
2258  * including the next unescaped delimiter.  The delimiter, as well as the
2259  * backslash or the dollar, can be escaped with a backslash.
2260  *
2261  * Return true if parsing succeeded, together with the parsed (and possibly
2262  * expanded) part.  In that case, pp points right after the delimiter.  The
2263  * delimiter is not included in the part though.
2264  */
2265 static bool
2266 ParseModifierPart(
2267     /* The parsing position, updated upon return */
2268     const char **pp,
2269     /* Parsing stops at this delimiter */
2270     char delim,
2271     /* Mode for evaluating nested variables. */
2272     VarEvalMode emode,
2273     ModChain *ch,
2274     LazyBuf *part
2275 )
2276 {
2277 	return ParseModifierPartSubst(pp, delim, emode, ch, part, NULL, NULL);
2278 }
2279 
2280 MAKE_INLINE bool
2281 IsDelimiter(char c, const ModChain *ch)
2282 {
2283 	return c == ':' || c == ch->endc || c == '\0';
2284 }
2285 
2286 /* Test whether mod starts with modname, followed by a delimiter. */
2287 MAKE_INLINE bool
2288 ModMatch(const char *mod, const char *modname, const ModChain *ch)
2289 {
2290 	size_t n = strlen(modname);
2291 	return strncmp(mod, modname, n) == 0 && IsDelimiter(mod[n], ch);
2292 }
2293 
2294 /* Test whether mod starts with modname, followed by a delimiter or '='. */
2295 MAKE_INLINE bool
2296 ModMatchEq(const char *mod, const char *modname, const ModChain *ch)
2297 {
2298 	size_t n = strlen(modname);
2299 	return strncmp(mod, modname, n) == 0 &&
2300 	       (IsDelimiter(mod[n], ch) || mod[n] == '=');
2301 }
2302 
2303 static bool
2304 TryParseIntBase0(const char **pp, int *out_num)
2305 {
2306 	char *end;
2307 	long n;
2308 
2309 	errno = 0;
2310 	n = strtol(*pp, &end, 0);
2311 
2312 	if (end == *pp)
2313 		return false;
2314 	if ((n == LONG_MIN || n == LONG_MAX) && errno == ERANGE)
2315 		return false;
2316 	if (n < INT_MIN || n > INT_MAX)
2317 		return false;
2318 
2319 	*pp = end;
2320 	*out_num = (int)n;
2321 	return true;
2322 }
2323 
2324 static bool
2325 TryParseSize(const char **pp, size_t *out_num)
2326 {
2327 	char *end;
2328 	unsigned long n;
2329 
2330 	if (!ch_isdigit(**pp))
2331 		return false;
2332 
2333 	errno = 0;
2334 	n = strtoul(*pp, &end, 10);
2335 	if (n == ULONG_MAX && errno == ERANGE)
2336 		return false;
2337 	if (n > SIZE_MAX)
2338 		return false;
2339 
2340 	*pp = end;
2341 	*out_num = (size_t)n;
2342 	return true;
2343 }
2344 
2345 static bool
2346 TryParseChar(const char **pp, int base, char *out_ch)
2347 {
2348 	char *end;
2349 	unsigned long n;
2350 
2351 	if (!ch_isalnum(**pp))
2352 		return false;
2353 
2354 	errno = 0;
2355 	n = strtoul(*pp, &end, base);
2356 	if (n == ULONG_MAX && errno == ERANGE)
2357 		return false;
2358 	if (n > UCHAR_MAX)
2359 		return false;
2360 
2361 	*pp = end;
2362 	*out_ch = (char)n;
2363 	return true;
2364 }
2365 
2366 /*
2367  * Modify each word of the expression using the given function and place the
2368  * result back in the expression.
2369  */
2370 static void
2371 ModifyWords(ModChain *ch,
2372 	    ModifyWordProc modifyWord, void *modifyWord_args,
2373 	    bool oneBigWord)
2374 {
2375 	Expr *expr = ch->expr;
2376 	const char *val = Expr_Str(expr);
2377 	SepBuf result;
2378 	SubstringWords words;
2379 	size_t i;
2380 	Substring word;
2381 
2382 	if (oneBigWord) {
2383 		SepBuf_Init(&result, ch->sep);
2384 		/* XXX: performance: Substring_InitStr calls strlen */
2385 		word = Substring_InitStr(val);
2386 		modifyWord(word, &result, modifyWord_args);
2387 		goto done;
2388 	}
2389 
2390 	words = Substring_Words(val, false);
2391 
2392 	DEBUG3(VAR, "ModifyWords: split \"%s\" into %u %s\n",
2393 	    val, (unsigned)words.len, words.len != 1 ? "words" : "word");
2394 
2395 	SepBuf_Init(&result, ch->sep);
2396 	for (i = 0; i < words.len; i++) {
2397 		modifyWord(words.words[i], &result, modifyWord_args);
2398 		if (result.buf.len > 0)
2399 			SepBuf_Sep(&result);
2400 	}
2401 
2402 	SubstringWords_Free(words);
2403 
2404 done:
2405 	Expr_SetValueOwn(expr, SepBuf_DoneData(&result));
2406 }
2407 
2408 /* :@var@...${var}...@ */
2409 static ApplyModifierResult
2410 ApplyModifier_Loop(const char **pp, ModChain *ch)
2411 {
2412 	Expr *expr = ch->expr;
2413 	struct ModifyWord_LoopArgs args;
2414 	char prev_sep;
2415 	LazyBuf tvarBuf, strBuf;
2416 	FStr tvar, str;
2417 
2418 	args.scope = expr->scope;
2419 
2420 	(*pp)++;		/* Skip the first '@' */
2421 	if (!ParseModifierPart(pp, '@', VARE_PARSE_ONLY, ch, &tvarBuf))
2422 		return AMR_CLEANUP;
2423 	tvar = LazyBuf_DoneGet(&tvarBuf);
2424 	args.var = tvar.str;
2425 	if (strchr(args.var, '$') != NULL) {
2426 		Parse_Error(PARSE_FATAL,
2427 		    "In the :@ modifier of \"%s\", the variable name \"%s\" "
2428 		    "must not contain a dollar",
2429 		    expr->name, args.var);
2430 		return AMR_CLEANUP;
2431 	}
2432 
2433 	if (!ParseModifierPart(pp, '@', VARE_PARSE_BALANCED, ch, &strBuf))
2434 		return AMR_CLEANUP;
2435 	str = LazyBuf_DoneGet(&strBuf);
2436 	args.body = str.str;
2437 
2438 	if (!Expr_ShouldEval(expr))
2439 		goto done;
2440 
2441 	args.emode = VarEvalMode_WithoutKeepDollar(expr->emode);
2442 	prev_sep = ch->sep;
2443 	ch->sep = ' ';		/* XXX: should be ch->sep for consistency */
2444 	ModifyWords(ch, ModifyWord_Loop, &args, ch->oneBigWord);
2445 	ch->sep = prev_sep;
2446 	/* XXX: Consider restoring the previous value instead of deleting. */
2447 	Var_Delete(expr->scope, args.var);
2448 
2449 done:
2450 	FStr_Done(&tvar);
2451 	FStr_Done(&str);
2452 	return AMR_OK;
2453 }
2454 
2455 static void
2456 ParseModifier_Defined(const char **pp, ModChain *ch, bool shouldEval,
2457 		      LazyBuf *buf)
2458 {
2459 	const char *p;
2460 
2461 	p = *pp + 1;
2462 	LazyBuf_Init(buf, p);
2463 	while (!IsDelimiter(*p, ch)) {
2464 
2465 		/*
2466 		 * XXX: This code is similar to the one in Var_Parse. See if
2467 		 * the code can be merged. See also ApplyModifier_Match and
2468 		 * ParseModifierPart.
2469 		 */
2470 
2471 		/* Escaped delimiter or other special character */
2472 		/* See Buf_AddEscaped in for.c. */
2473 		if (*p == '\\') {
2474 			char c = p[1];
2475 			if ((IsDelimiter(c, ch) && c != '\0') ||
2476 			    c == '$' || c == '\\') {
2477 				if (shouldEval)
2478 					LazyBuf_Add(buf, c);
2479 				p += 2;
2480 				continue;
2481 			}
2482 		}
2483 
2484 		/* Nested variable expression */
2485 		if (*p == '$') {
2486 			FStr val = Var_Parse(&p, ch->expr->scope,
2487 			    shouldEval ? ch->expr->emode : VARE_PARSE_ONLY);
2488 			/* TODO: handle errors */
2489 			if (shouldEval)
2490 				LazyBuf_AddStr(buf, val.str);
2491 			FStr_Done(&val);
2492 			continue;
2493 		}
2494 
2495 		/* Ordinary text */
2496 		if (shouldEval)
2497 			LazyBuf_Add(buf, *p);
2498 		p++;
2499 	}
2500 	*pp = p;
2501 }
2502 
2503 /* :Ddefined or :Uundefined */
2504 static ApplyModifierResult
2505 ApplyModifier_Defined(const char **pp, ModChain *ch)
2506 {
2507 	Expr *expr = ch->expr;
2508 	LazyBuf buf;
2509 	bool shouldEval =
2510 	    Expr_ShouldEval(expr) &&
2511 	    (**pp == 'D') == (expr->defined == DEF_REGULAR);
2512 
2513 	ParseModifier_Defined(pp, ch, shouldEval, &buf);
2514 
2515 	Expr_Define(expr);
2516 	if (shouldEval)
2517 		Expr_SetValue(expr, Substring_Str(LazyBuf_Get(&buf)));
2518 
2519 	return AMR_OK;
2520 }
2521 
2522 /* :L */
2523 static ApplyModifierResult
2524 ApplyModifier_Literal(const char **pp, ModChain *ch)
2525 {
2526 	Expr *expr = ch->expr;
2527 
2528 	(*pp)++;
2529 
2530 	if (Expr_ShouldEval(expr)) {
2531 		Expr_Define(expr);
2532 		Expr_SetValueOwn(expr, bmake_strdup(expr->name));
2533 	}
2534 
2535 	return AMR_OK;
2536 }
2537 
2538 static bool
2539 TryParseTime(const char **pp, time_t *out_time)
2540 {
2541 	char *end;
2542 	unsigned long n;
2543 
2544 	if (!ch_isdigit(**pp))
2545 		return false;
2546 
2547 	errno = 0;
2548 	n = strtoul(*pp, &end, 10);
2549 	if (n == ULONG_MAX && errno == ERANGE)
2550 		return false;
2551 
2552 	*pp = end;
2553 	*out_time = (time_t)n;	/* ignore possible truncation for now */
2554 	return true;
2555 }
2556 
2557 /* :gmtime and :localtime */
2558 static ApplyModifierResult
2559 ApplyModifier_Time(const char **pp, ModChain *ch)
2560 {
2561 	Expr *expr;
2562 	time_t t;
2563 	const char *args;
2564 	const char *mod = *pp;
2565 	bool gmt = mod[0] == 'g';
2566 
2567 	if (!ModMatchEq(mod, gmt ? "gmtime" : "localtime", ch))
2568 		return AMR_UNKNOWN;
2569 	args = mod + (gmt ? 6 : 9);
2570 
2571 	if (args[0] == '=') {
2572 		const char *p = args + 1;
2573 		if (!TryParseTime(&p, &t)) {
2574 			Parse_Error(PARSE_FATAL,
2575 			    "Invalid time value at \"%s\"", p);
2576 			return AMR_CLEANUP;
2577 		}
2578 		*pp = p;
2579 	} else {
2580 		t = 0;
2581 		*pp = args;
2582 	}
2583 
2584 	expr = ch->expr;
2585 	if (Expr_ShouldEval(expr))
2586 		Expr_SetValueOwn(expr, VarStrftime(Expr_Str(expr), t, gmt));
2587 
2588 	return AMR_OK;
2589 }
2590 
2591 /* :hash */
2592 static ApplyModifierResult
2593 ApplyModifier_Hash(const char **pp, ModChain *ch)
2594 {
2595 	if (!ModMatch(*pp, "hash", ch))
2596 		return AMR_UNKNOWN;
2597 	*pp += 4;
2598 
2599 	if (ModChain_ShouldEval(ch))
2600 		Expr_SetValueOwn(ch->expr, VarHash(Expr_Str(ch->expr)));
2601 
2602 	return AMR_OK;
2603 }
2604 
2605 /* :P */
2606 static ApplyModifierResult
2607 ApplyModifier_Path(const char **pp, ModChain *ch)
2608 {
2609 	Expr *expr = ch->expr;
2610 	GNode *gn;
2611 	char *path;
2612 
2613 	(*pp)++;
2614 
2615 	if (!Expr_ShouldEval(expr))
2616 		return AMR_OK;
2617 
2618 	Expr_Define(expr);
2619 
2620 	gn = Targ_FindNode(expr->name);
2621 	if (gn == NULL || gn->type & OP_NOPATH) {
2622 		path = NULL;
2623 	} else if (gn->path != NULL) {
2624 		path = bmake_strdup(gn->path);
2625 	} else {
2626 		SearchPath *searchPath = Suff_FindPath(gn);
2627 		path = Dir_FindFile(expr->name, searchPath);
2628 	}
2629 	if (path == NULL)
2630 		path = bmake_strdup(expr->name);
2631 	Expr_SetValueOwn(expr, path);
2632 
2633 	return AMR_OK;
2634 }
2635 
2636 /* :!cmd! */
2637 static ApplyModifierResult
2638 ApplyModifier_ShellCommand(const char **pp, ModChain *ch)
2639 {
2640 	Expr *expr = ch->expr;
2641 	LazyBuf cmdBuf;
2642 	FStr cmd;
2643 
2644 	(*pp)++;
2645 	if (!ParseModifierPart(pp, '!', expr->emode, ch, &cmdBuf))
2646 		return AMR_CLEANUP;
2647 	cmd = LazyBuf_DoneGet(&cmdBuf);
2648 
2649 	if (Expr_ShouldEval(expr)) {
2650 		char *output, *error;
2651 		output = Cmd_Exec(cmd.str, &error);
2652 		Expr_SetValueOwn(expr, output);
2653 		if (error != NULL) {
2654 			/* XXX: why still return AMR_OK? */
2655 			Error("%s", error);
2656 			free(error);
2657 		}
2658 	} else
2659 		Expr_SetValueRefer(expr, "");
2660 
2661 	FStr_Done(&cmd);
2662 	Expr_Define(expr);
2663 
2664 	return AMR_OK;
2665 }
2666 
2667 /*
2668  * The :range modifier generates an integer sequence as long as the words.
2669  * The :range=7 modifier generates an integer sequence from 1 to 7.
2670  */
2671 static ApplyModifierResult
2672 ApplyModifier_Range(const char **pp, ModChain *ch)
2673 {
2674 	size_t n;
2675 	Buffer buf;
2676 	size_t i;
2677 
2678 	const char *mod = *pp;
2679 	if (!ModMatchEq(mod, "range", ch))
2680 		return AMR_UNKNOWN;
2681 
2682 	if (mod[5] == '=') {
2683 		const char *p = mod + 6;
2684 		if (!TryParseSize(&p, &n)) {
2685 			Parse_Error(PARSE_FATAL,
2686 			    "Invalid number \"%s\" for ':range' modifier",
2687 			    mod + 6);
2688 			return AMR_CLEANUP;
2689 		}
2690 		*pp = p;
2691 	} else {
2692 		n = 0;
2693 		*pp = mod + 5;
2694 	}
2695 
2696 	if (!ModChain_ShouldEval(ch))
2697 		return AMR_OK;
2698 
2699 	if (n == 0) {
2700 		SubstringWords words = Expr_Words(ch->expr);
2701 		n = words.len;
2702 		SubstringWords_Free(words);
2703 	}
2704 
2705 	Buf_Init(&buf);
2706 
2707 	for (i = 0; i < n; i++) {
2708 		if (i != 0) {
2709 			/*
2710 			 * XXX: Use ch->sep instead of ' ', for consistency.
2711 			 */
2712 			Buf_AddByte(&buf, ' ');
2713 		}
2714 		Buf_AddInt(&buf, 1 + (int)i);
2715 	}
2716 
2717 	Expr_SetValueOwn(ch->expr, Buf_DoneData(&buf));
2718 	return AMR_OK;
2719 }
2720 
2721 /* Parse a ':M' or ':N' modifier. */
2722 static char *
2723 ParseModifier_Match(const char **pp, const ModChain *ch)
2724 {
2725 	const char *mod = *pp;
2726 	Expr *expr = ch->expr;
2727 	bool copy = false;	/* pattern should be, or has been, copied */
2728 	bool needSubst = false;
2729 	const char *endpat;
2730 	char *pattern;
2731 
2732 	/*
2733 	 * In the loop below, ignore ':' unless we are at (or back to) the
2734 	 * original brace level.
2735 	 * XXX: This will likely not work right if $() and ${} are intermixed.
2736 	 */
2737 	/*
2738 	 * XXX: This code is similar to the one in Var_Parse.
2739 	 * See if the code can be merged.
2740 	 * See also ApplyModifier_Defined.
2741 	 */
2742 	int nest = 0;
2743 	const char *p;
2744 	for (p = mod + 1; *p != '\0' && !(*p == ':' && nest == 0); p++) {
2745 		if (*p == '\\' && p[1] != '\0' &&
2746 		    (IsDelimiter(p[1], ch) || p[1] == ch->startc)) {
2747 			if (!needSubst)
2748 				copy = true;
2749 			p++;
2750 			continue;
2751 		}
2752 		if (*p == '$')
2753 			needSubst = true;
2754 		if (*p == '(' || *p == '{')
2755 			nest++;
2756 		if (*p == ')' || *p == '}') {
2757 			nest--;
2758 			if (nest < 0)
2759 				break;
2760 		}
2761 	}
2762 	*pp = p;
2763 	endpat = p;
2764 
2765 	if (copy) {
2766 		char *dst;
2767 		const char *src;
2768 
2769 		/* Compress the \:'s out of the pattern. */
2770 		pattern = bmake_malloc((size_t)(endpat - (mod + 1)) + 1);
2771 		dst = pattern;
2772 		src = mod + 1;
2773 		for (; src < endpat; src++, dst++) {
2774 			if (src[0] == '\\' && src + 1 < endpat &&
2775 			    /* XXX: ch->startc is missing here; see above */
2776 			    IsDelimiter(src[1], ch))
2777 				src++;
2778 			*dst = *src;
2779 		}
2780 		*dst = '\0';
2781 	} else {
2782 		pattern = bmake_strsedup(mod + 1, endpat);
2783 	}
2784 
2785 	if (needSubst) {
2786 		char *old_pattern = pattern;
2787 		/*
2788 		 * XXX: Contrary to ParseModifierPart, a dollar in a ':M' or
2789 		 * ':N' modifier must be escaped as '$$', not as '\$'.
2790 		 */
2791 		pattern = Var_Subst(pattern, expr->scope, expr->emode);
2792 		/* TODO: handle errors */
2793 		free(old_pattern);
2794 	}
2795 
2796 	DEBUG2(VAR, "Pattern for ':%c' is \"%s\"\n", mod[0], pattern);
2797 
2798 	return pattern;
2799 }
2800 
2801 /* :Mpattern or :Npattern */
2802 static ApplyModifierResult
2803 ApplyModifier_Match(const char **pp, ModChain *ch)
2804 {
2805 	char mod = **pp;
2806 	char *pattern;
2807 
2808 	pattern = ParseModifier_Match(pp, ch);
2809 
2810 	if (ModChain_ShouldEval(ch)) {
2811 		ModifyWordProc modifyWord =
2812 		    mod == 'M' ? ModifyWord_Match : ModifyWord_NoMatch;
2813 		ModifyWords(ch, modifyWord, pattern, ch->oneBigWord);
2814 	}
2815 
2816 	free(pattern);
2817 	return AMR_OK;
2818 }
2819 
2820 static void
2821 ParsePatternFlags(const char **pp, PatternFlags *pflags, bool *oneBigWord)
2822 {
2823 	for (;; (*pp)++) {
2824 		if (**pp == 'g')
2825 			pflags->subGlobal = true;
2826 		else if (**pp == '1')
2827 			pflags->subOnce = true;
2828 		else if (**pp == 'W')
2829 			*oneBigWord = true;
2830 		else
2831 			break;
2832 	}
2833 }
2834 
2835 MAKE_INLINE PatternFlags
2836 PatternFlags_None(void)
2837 {
2838 	PatternFlags pflags = { false, false, false, false };
2839 	return pflags;
2840 }
2841 
2842 /* :S,from,to, */
2843 static ApplyModifierResult
2844 ApplyModifier_Subst(const char **pp, ModChain *ch)
2845 {
2846 	struct ModifyWord_SubstArgs args;
2847 	bool oneBigWord;
2848 	LazyBuf lhsBuf, rhsBuf;
2849 
2850 	char delim = (*pp)[1];
2851 	if (delim == '\0') {
2852 		Error("Missing delimiter for modifier ':S'");
2853 		(*pp)++;
2854 		return AMR_CLEANUP;
2855 	}
2856 
2857 	*pp += 2;
2858 
2859 	args.pflags = PatternFlags_None();
2860 	args.matched = false;
2861 
2862 	if (**pp == '^') {
2863 		args.pflags.anchorStart = true;
2864 		(*pp)++;
2865 	}
2866 
2867 	if (!ParseModifierPartSubst(pp, delim, ch->expr->emode, ch, &lhsBuf,
2868 	    &args.pflags, NULL))
2869 		return AMR_CLEANUP;
2870 	args.lhs = LazyBuf_Get(&lhsBuf);
2871 
2872 	if (!ParseModifierPartSubst(pp, delim, ch->expr->emode, ch, &rhsBuf,
2873 	    NULL, &args)) {
2874 		LazyBuf_Done(&lhsBuf);
2875 		return AMR_CLEANUP;
2876 	}
2877 	args.rhs = LazyBuf_Get(&rhsBuf);
2878 
2879 	oneBigWord = ch->oneBigWord;
2880 	ParsePatternFlags(pp, &args.pflags, &oneBigWord);
2881 
2882 	ModifyWords(ch, ModifyWord_Subst, &args, oneBigWord);
2883 
2884 	LazyBuf_Done(&lhsBuf);
2885 	LazyBuf_Done(&rhsBuf);
2886 	return AMR_OK;
2887 }
2888 
2889 #ifndef NO_REGEX
2890 
2891 /* :C,from,to, */
2892 static ApplyModifierResult
2893 ApplyModifier_Regex(const char **pp, ModChain *ch)
2894 {
2895 	struct ModifyWord_SubstRegexArgs args;
2896 	bool oneBigWord;
2897 	int error;
2898 	LazyBuf reBuf, replaceBuf;
2899 	FStr re;
2900 
2901 	char delim = (*pp)[1];
2902 	if (delim == '\0') {
2903 		Error("Missing delimiter for :C modifier");
2904 		(*pp)++;
2905 		return AMR_CLEANUP;
2906 	}
2907 
2908 	*pp += 2;
2909 
2910 	if (!ParseModifierPart(pp, delim, ch->expr->emode, ch, &reBuf))
2911 		return AMR_CLEANUP;
2912 	re = LazyBuf_DoneGet(&reBuf);
2913 
2914 	if (!ParseModifierPart(pp, delim, ch->expr->emode, ch, &replaceBuf)) {
2915 		FStr_Done(&re);
2916 		return AMR_CLEANUP;
2917 	}
2918 	args.replace = LazyBuf_Get(&replaceBuf);
2919 
2920 	args.pflags = PatternFlags_None();
2921 	args.matched = false;
2922 	oneBigWord = ch->oneBigWord;
2923 	ParsePatternFlags(pp, &args.pflags, &oneBigWord);
2924 
2925 	if (!ModChain_ShouldEval(ch))
2926 		goto done;
2927 
2928 	error = regcomp(&args.re, re.str, REG_EXTENDED);
2929 	if (error != 0) {
2930 		VarREError(error, &args.re, "Regex compilation error");
2931 		LazyBuf_Done(&replaceBuf);
2932 		FStr_Done(&re);
2933 		return AMR_CLEANUP;
2934 	}
2935 
2936 	args.nsub = args.re.re_nsub + 1;
2937 	if (args.nsub > 10)
2938 		args.nsub = 10;
2939 
2940 	ModifyWords(ch, ModifyWord_SubstRegex, &args, oneBigWord);
2941 
2942 	regfree(&args.re);
2943 done:
2944 	LazyBuf_Done(&replaceBuf);
2945 	FStr_Done(&re);
2946 	return AMR_OK;
2947 }
2948 
2949 #endif
2950 
2951 /* :Q, :q */
2952 static ApplyModifierResult
2953 ApplyModifier_Quote(const char **pp, ModChain *ch)
2954 {
2955 	LazyBuf buf;
2956 	bool quoteDollar;
2957 
2958 	quoteDollar = **pp == 'q';
2959 	if (!IsDelimiter((*pp)[1], ch))
2960 		return AMR_UNKNOWN;
2961 	(*pp)++;
2962 
2963 	if (!ModChain_ShouldEval(ch))
2964 		return AMR_OK;
2965 
2966 	VarQuote(Expr_Str(ch->expr), quoteDollar, &buf);
2967 	if (buf.data != NULL)
2968 		Expr_SetValue(ch->expr, LazyBuf_DoneGet(&buf));
2969 	else
2970 		LazyBuf_Done(&buf);
2971 
2972 	return AMR_OK;
2973 }
2974 
2975 /*ARGSUSED*/
2976 static void
2977 ModifyWord_Copy(Substring word, SepBuf *buf, void *data MAKE_ATTR_UNUSED)
2978 {
2979 	SepBuf_AddSubstring(buf, word);
2980 }
2981 
2982 /* :ts<separator> */
2983 static ApplyModifierResult
2984 ApplyModifier_ToSep(const char **pp, ModChain *ch)
2985 {
2986 	const char *sep = *pp + 2;
2987 
2988 	/*
2989 	 * Even in parse-only mode, proceed as normal since there is
2990 	 * neither any observable side effect nor a performance penalty.
2991 	 * Checking for wantRes for every single piece of code in here
2992 	 * would make the code in this function too hard to read.
2993 	 */
2994 
2995 	/* ":ts<any><endc>" or ":ts<any>:" */
2996 	if (sep[0] != ch->endc && IsDelimiter(sep[1], ch)) {
2997 		*pp = sep + 1;
2998 		ch->sep = sep[0];
2999 		goto ok;
3000 	}
3001 
3002 	/* ":ts<endc>" or ":ts:" */
3003 	if (IsDelimiter(sep[0], ch)) {
3004 		*pp = sep;
3005 		ch->sep = '\0';	/* no separator */
3006 		goto ok;
3007 	}
3008 
3009 	/* ":ts<unrecognised><unrecognised>". */
3010 	if (sep[0] != '\\') {
3011 		(*pp)++;	/* just for backwards compatibility */
3012 		return AMR_BAD;
3013 	}
3014 
3015 	/* ":ts\n" */
3016 	if (sep[1] == 'n') {
3017 		*pp = sep + 2;
3018 		ch->sep = '\n';
3019 		goto ok;
3020 	}
3021 
3022 	/* ":ts\t" */
3023 	if (sep[1] == 't') {
3024 		*pp = sep + 2;
3025 		ch->sep = '\t';
3026 		goto ok;
3027 	}
3028 
3029 	/* ":ts\x40" or ":ts\100" */
3030 	{
3031 		const char *p = sep + 1;
3032 		int base = 8;	/* assume octal */
3033 
3034 		if (sep[1] == 'x') {
3035 			base = 16;
3036 			p++;
3037 		} else if (!ch_isdigit(sep[1])) {
3038 			(*pp)++;	/* just for backwards compatibility */
3039 			return AMR_BAD;	/* ":ts<backslash><unrecognised>". */
3040 		}
3041 
3042 		if (!TryParseChar(&p, base, &ch->sep)) {
3043 			Parse_Error(PARSE_FATAL,
3044 			    "Invalid character number at \"%s\"", p);
3045 			return AMR_CLEANUP;
3046 		}
3047 		if (!IsDelimiter(*p, ch)) {
3048 			(*pp)++;	/* just for backwards compatibility */
3049 			return AMR_BAD;
3050 		}
3051 
3052 		*pp = p;
3053 	}
3054 
3055 ok:
3056 	ModifyWords(ch, ModifyWord_Copy, NULL, ch->oneBigWord);
3057 	return AMR_OK;
3058 }
3059 
3060 static char *
3061 str_toupper(const char *str)
3062 {
3063 	char *res;
3064 	size_t i, len;
3065 
3066 	len = strlen(str);
3067 	res = bmake_malloc(len + 1);
3068 	for (i = 0; i < len + 1; i++)
3069 		res[i] = ch_toupper(str[i]);
3070 
3071 	return res;
3072 }
3073 
3074 static char *
3075 str_tolower(const char *str)
3076 {
3077 	char *res;
3078 	size_t i, len;
3079 
3080 	len = strlen(str);
3081 	res = bmake_malloc(len + 1);
3082 	for (i = 0; i < len + 1; i++)
3083 		res[i] = ch_tolower(str[i]);
3084 
3085 	return res;
3086 }
3087 
3088 /* :tA, :tu, :tl, :ts<separator>, etc. */
3089 static ApplyModifierResult
3090 ApplyModifier_To(const char **pp, ModChain *ch)
3091 {
3092 	Expr *expr = ch->expr;
3093 	const char *mod = *pp;
3094 	assert(mod[0] == 't');
3095 
3096 	if (IsDelimiter(mod[1], ch)) {
3097 		*pp = mod + 1;
3098 		return AMR_BAD;	/* Found ":t<endc>" or ":t:". */
3099 	}
3100 
3101 	if (mod[1] == 's')
3102 		return ApplyModifier_ToSep(pp, ch);
3103 
3104 	if (!IsDelimiter(mod[2], ch)) {			/* :t<any><any> */
3105 		*pp = mod + 1;
3106 		return AMR_BAD;
3107 	}
3108 
3109 	if (mod[1] == 'A') {				/* :tA */
3110 		*pp = mod + 2;
3111 		ModifyWords(ch, ModifyWord_Realpath, NULL, ch->oneBigWord);
3112 		return AMR_OK;
3113 	}
3114 
3115 	if (mod[1] == 'u') {				/* :tu */
3116 		*pp = mod + 2;
3117 		if (Expr_ShouldEval(expr))
3118 			Expr_SetValueOwn(expr, str_toupper(Expr_Str(expr)));
3119 		return AMR_OK;
3120 	}
3121 
3122 	if (mod[1] == 'l') {				/* :tl */
3123 		*pp = mod + 2;
3124 		if (Expr_ShouldEval(expr))
3125 			Expr_SetValueOwn(expr, str_tolower(Expr_Str(expr)));
3126 		return AMR_OK;
3127 	}
3128 
3129 	if (mod[1] == 'W' || mod[1] == 'w') {		/* :tW, :tw */
3130 		*pp = mod + 2;
3131 		ch->oneBigWord = mod[1] == 'W';
3132 		return AMR_OK;
3133 	}
3134 
3135 	/* Found ":t<unrecognised>:" or ":t<unrecognised><endc>". */
3136 	*pp = mod + 1;		/* XXX: unnecessary but observable */
3137 	return AMR_BAD;
3138 }
3139 
3140 /* :[#], :[1], :[-1..1], etc. */
3141 static ApplyModifierResult
3142 ApplyModifier_Words(const char **pp, ModChain *ch)
3143 {
3144 	Expr *expr = ch->expr;
3145 	const char *estr;
3146 	int first, last;
3147 	const char *p;
3148 	LazyBuf estrBuf;
3149 	FStr festr;
3150 
3151 	(*pp)++;		/* skip the '[' */
3152 	if (!ParseModifierPart(pp, ']', expr->emode, ch, &estrBuf))
3153 		return AMR_CLEANUP;
3154 	festr = LazyBuf_DoneGet(&estrBuf);
3155 	estr = festr.str;
3156 
3157 	if (!IsDelimiter(**pp, ch))
3158 		goto bad_modifier;		/* Found junk after ']' */
3159 
3160 	if (!ModChain_ShouldEval(ch))
3161 		goto ok;
3162 
3163 	if (estr[0] == '\0')
3164 		goto bad_modifier;			/* Found ":[]". */
3165 
3166 	if (estr[0] == '#' && estr[1] == '\0') {	/* Found ":[#]" */
3167 		if (ch->oneBigWord) {
3168 			Expr_SetValueRefer(expr, "1");
3169 		} else {
3170 			Buffer buf;
3171 
3172 			SubstringWords words = Expr_Words(expr);
3173 			size_t ac = words.len;
3174 			SubstringWords_Free(words);
3175 
3176 			/* 3 digits + '\0' is usually enough */
3177 			Buf_InitSize(&buf, 4);
3178 			Buf_AddInt(&buf, (int)ac);
3179 			Expr_SetValueOwn(expr, Buf_DoneData(&buf));
3180 		}
3181 		goto ok;
3182 	}
3183 
3184 	if (estr[0] == '*' && estr[1] == '\0') {	/* Found ":[*]" */
3185 		ch->oneBigWord = true;
3186 		goto ok;
3187 	}
3188 
3189 	if (estr[0] == '@' && estr[1] == '\0') {	/* Found ":[@]" */
3190 		ch->oneBigWord = false;
3191 		goto ok;
3192 	}
3193 
3194 	/*
3195 	 * We expect estr to contain a single integer for :[N], or two
3196 	 * integers separated by ".." for :[start..end].
3197 	 */
3198 	p = estr;
3199 	if (!TryParseIntBase0(&p, &first))
3200 		goto bad_modifier;	/* Found junk instead of a number */
3201 
3202 	if (p[0] == '\0') {		/* Found only one integer in :[N] */
3203 		last = first;
3204 	} else if (p[0] == '.' && p[1] == '.' && p[2] != '\0') {
3205 		/* Expecting another integer after ".." */
3206 		p += 2;
3207 		if (!TryParseIntBase0(&p, &last) || *p != '\0')
3208 			goto bad_modifier; /* Found junk after ".." */
3209 	} else
3210 		goto bad_modifier;	/* Found junk instead of ".." */
3211 
3212 	/*
3213 	 * Now first and last are properly filled in, but we still have to
3214 	 * check for 0 as a special case.
3215 	 */
3216 	if (first == 0 && last == 0) {
3217 		/* ":[0]" or perhaps ":[0..0]" */
3218 		ch->oneBigWord = true;
3219 		goto ok;
3220 	}
3221 
3222 	/* ":[0..N]" or ":[N..0]" */
3223 	if (first == 0 || last == 0)
3224 		goto bad_modifier;
3225 
3226 	/* Normal case: select the words described by first and last. */
3227 	Expr_SetValueOwn(expr,
3228 	    VarSelectWords(Expr_Str(expr), first, last,
3229 		ch->sep, ch->oneBigWord));
3230 
3231 ok:
3232 	FStr_Done(&festr);
3233 	return AMR_OK;
3234 
3235 bad_modifier:
3236 	FStr_Done(&festr);
3237 	return AMR_BAD;
3238 }
3239 
3240 #if __STDC_VERSION__ >= 199901L
3241 # define NUM_TYPE long long
3242 # define PARSE_NUM_TYPE strtoll
3243 #else
3244 # define NUM_TYPE long
3245 # define PARSE_NUM_TYPE strtol
3246 #endif
3247 
3248 static NUM_TYPE
3249 num_val(Substring s)
3250 {
3251 	NUM_TYPE val;
3252 	char *ep;
3253 
3254 	val = PARSE_NUM_TYPE(s.start, &ep, 0);
3255 	if (ep != s.start) {
3256 		switch (*ep) {
3257 		case 'K':
3258 		case 'k':
3259 			val <<= 10;
3260 			break;
3261 		case 'M':
3262 		case 'm':
3263 			val <<= 20;
3264 			break;
3265 		case 'G':
3266 		case 'g':
3267 			val <<= 30;
3268 			break;
3269 		}
3270 	}
3271 	return val;
3272 }
3273 
3274 static int
3275 SubNumAsc(const void *sa, const void *sb)
3276 {
3277 	NUM_TYPE a, b;
3278 
3279 	a = num_val(*((const Substring *)sa));
3280 	b = num_val(*((const Substring *)sb));
3281 	return (a > b) ? 1 : (b > a) ? -1 : 0;
3282 }
3283 
3284 static int
3285 SubNumDesc(const void *sa, const void *sb)
3286 {
3287 	return SubNumAsc(sb, sa);
3288 }
3289 
3290 static int
3291 SubStrAsc(const void *sa, const void *sb)
3292 {
3293 	return strcmp(
3294 	    ((const Substring *)sa)->start, ((const Substring *)sb)->start);
3295 }
3296 
3297 static int
3298 SubStrDesc(const void *sa, const void *sb)
3299 {
3300 	return SubStrAsc(sb, sa);
3301 }
3302 
3303 static void
3304 ShuffleSubstrings(Substring *strs, size_t n)
3305 {
3306 	size_t i;
3307 
3308 	for (i = n - 1; i > 0; i--) {
3309 		size_t rndidx = (size_t)random() % (i + 1);
3310 		Substring t = strs[i];
3311 		strs[i] = strs[rndidx];
3312 		strs[rndidx] = t;
3313 	}
3314 }
3315 
3316 /*
3317  * :O		order ascending
3318  * :Or		order descending
3319  * :Ox		shuffle
3320  * :On		numeric ascending
3321  * :Onr, :Orn	numeric descending
3322  */
3323 static ApplyModifierResult
3324 ApplyModifier_Order(const char **pp, ModChain *ch)
3325 {
3326 	const char *mod = *pp;
3327 	SubstringWords words;
3328 	int (*cmp)(const void *, const void *);
3329 
3330 	if (IsDelimiter(mod[1], ch)) {
3331 		cmp = SubStrAsc;
3332 		(*pp)++;
3333 	} else if (IsDelimiter(mod[2], ch)) {
3334 		if (mod[1] == 'n')
3335 			cmp = SubNumAsc;
3336 		else if (mod[1] == 'r')
3337 			cmp = SubStrDesc;
3338 		else if (mod[1] == 'x')
3339 			cmp = NULL;
3340 		else
3341 			goto bad;
3342 		*pp += 2;
3343 	} else if (IsDelimiter(mod[3], ch)) {
3344 		if ((mod[1] == 'n' && mod[2] == 'r') ||
3345 		    (mod[1] == 'r' && mod[2] == 'n'))
3346 			cmp = SubNumDesc;
3347 		else
3348 			goto bad;
3349 		*pp += 3;
3350 	} else
3351 		goto bad;
3352 
3353 	if (!ModChain_ShouldEval(ch))
3354 		return AMR_OK;
3355 
3356 	words = Expr_Words(ch->expr);
3357 	if (cmp == NULL)
3358 		ShuffleSubstrings(words.words, words.len);
3359 	else {
3360 		assert(words.words[0].end[0] == '\0');
3361 		qsort(words.words, words.len, sizeof(words.words[0]), cmp);
3362 	}
3363 	Expr_SetValueOwn(ch->expr, SubstringWords_JoinFree(words));
3364 
3365 	return AMR_OK;
3366 
3367 bad:
3368 	(*pp)++;
3369 	return AMR_BAD;
3370 }
3371 
3372 /* :? then : else */
3373 static ApplyModifierResult
3374 ApplyModifier_IfElse(const char **pp, ModChain *ch)
3375 {
3376 	Expr *expr = ch->expr;
3377 	LazyBuf thenBuf;
3378 	LazyBuf elseBuf;
3379 
3380 	VarEvalMode then_emode = VARE_PARSE_ONLY;
3381 	VarEvalMode else_emode = VARE_PARSE_ONLY;
3382 
3383 	CondResult cond_rc = CR_TRUE;	/* just not CR_ERROR */
3384 	if (Expr_ShouldEval(expr)) {
3385 		cond_rc = Cond_EvalCondition(expr->name);
3386 		if (cond_rc == CR_TRUE)
3387 			then_emode = expr->emode;
3388 		if (cond_rc == CR_FALSE)
3389 			else_emode = expr->emode;
3390 	}
3391 
3392 	(*pp)++;		/* skip past the '?' */
3393 	if (!ParseModifierPart(pp, ':', then_emode, ch, &thenBuf))
3394 		return AMR_CLEANUP;
3395 
3396 	if (!ParseModifierPart(pp, ch->endc, else_emode, ch, &elseBuf)) {
3397 		LazyBuf_Done(&thenBuf);
3398 		return AMR_CLEANUP;
3399 	}
3400 
3401 	(*pp)--;		/* Go back to the ch->endc. */
3402 
3403 	if (cond_rc == CR_ERROR) {
3404 		Substring thenExpr = LazyBuf_Get(&thenBuf);
3405 		Substring elseExpr = LazyBuf_Get(&elseBuf);
3406 		Error("Bad conditional expression '%s' in '%s?%.*s:%.*s'",
3407 		    expr->name, expr->name,
3408 		    (int)Substring_Length(thenExpr), thenExpr.start,
3409 		    (int)Substring_Length(elseExpr), elseExpr.start);
3410 		LazyBuf_Done(&thenBuf);
3411 		LazyBuf_Done(&elseBuf);
3412 		return AMR_CLEANUP;
3413 	}
3414 
3415 	if (!Expr_ShouldEval(expr)) {
3416 		LazyBuf_Done(&thenBuf);
3417 		LazyBuf_Done(&elseBuf);
3418 	} else if (cond_rc == CR_TRUE) {
3419 		Expr_SetValue(expr, LazyBuf_DoneGet(&thenBuf));
3420 		LazyBuf_Done(&elseBuf);
3421 	} else {
3422 		LazyBuf_Done(&thenBuf);
3423 		Expr_SetValue(expr, LazyBuf_DoneGet(&elseBuf));
3424 	}
3425 	Expr_Define(expr);
3426 	return AMR_OK;
3427 }
3428 
3429 /*
3430  * The ::= modifiers are special in that they do not read the variable value
3431  * but instead assign to that variable.  They always expand to an empty
3432  * string.
3433  *
3434  * Their main purpose is in supporting .for loops that generate shell commands
3435  * since an ordinary variable assignment at that point would terminate the
3436  * dependency group for these targets.  For example:
3437  *
3438  * list-targets: .USE
3439  * .for i in ${.TARGET} ${.TARGET:R}.gz
3440  *	@${t::=$i}
3441  *	@echo 'The target is ${t:T}.'
3442  * .endfor
3443  *
3444  *	  ::=<str>	Assigns <str> as the new value of variable.
3445  *	  ::?=<str>	Assigns <str> as value of variable if
3446  *			it was not already set.
3447  *	  ::+=<str>	Appends <str> to variable.
3448  *	  ::!=<cmd>	Assigns output of <cmd> as the new value of
3449  *			variable.
3450  */
3451 static ApplyModifierResult
3452 ApplyModifier_Assign(const char **pp, ModChain *ch)
3453 {
3454 	Expr *expr = ch->expr;
3455 	GNode *scope;
3456 	FStr val;
3457 	LazyBuf buf;
3458 
3459 	const char *mod = *pp;
3460 	const char *op = mod + 1;
3461 
3462 	if (op[0] == '=')
3463 		goto found_op;
3464 	if ((op[0] == '+' || op[0] == '?' || op[0] == '!') && op[1] == '=')
3465 		goto found_op;
3466 	return AMR_UNKNOWN;	/* "::<unrecognised>" */
3467 
3468 found_op:
3469 	if (expr->name[0] == '\0') {
3470 		*pp = mod + 1;
3471 		return AMR_BAD;
3472 	}
3473 
3474 	*pp = mod + (op[0] == '+' || op[0] == '?' || op[0] == '!' ? 3 : 2);
3475 
3476 	if (!ParseModifierPart(pp, ch->endc, expr->emode, ch, &buf))
3477 		return AMR_CLEANUP;
3478 	val = LazyBuf_DoneGet(&buf);
3479 
3480 	(*pp)--;		/* Go back to the ch->endc. */
3481 
3482 	if (!Expr_ShouldEval(expr))
3483 		goto done;
3484 
3485 	scope = expr->scope;	/* scope where v belongs */
3486 	if (expr->defined == DEF_REGULAR && expr->scope != SCOPE_GLOBAL) {
3487 		Var *v = VarFind(expr->name, expr->scope, false);
3488 		if (v == NULL)
3489 			scope = SCOPE_GLOBAL;
3490 		else
3491 			VarFreeShortLived(v);
3492 	}
3493 
3494 	if (op[0] == '+')
3495 		Var_Append(scope, expr->name, val.str);
3496 	else if (op[0] == '!') {
3497 		char *output, *error;
3498 		output = Cmd_Exec(val.str, &error);
3499 		if (error != NULL) {
3500 			Error("%s", error);
3501 			free(error);
3502 		} else
3503 			Var_Set(scope, expr->name, output);
3504 		free(output);
3505 	} else if (op[0] == '?' && expr->defined == DEF_REGULAR) {
3506 		/* Do nothing. */
3507 	} else
3508 		Var_Set(scope, expr->name, val.str);
3509 
3510 	Expr_SetValueRefer(expr, "");
3511 
3512 done:
3513 	FStr_Done(&val);
3514 	return AMR_OK;
3515 }
3516 
3517 /*
3518  * :_=...
3519  * remember current value
3520  */
3521 static ApplyModifierResult
3522 ApplyModifier_Remember(const char **pp, ModChain *ch)
3523 {
3524 	Expr *expr = ch->expr;
3525 	const char *mod = *pp;
3526 	FStr name;
3527 
3528 	if (!ModMatchEq(mod, "_", ch))
3529 		return AMR_UNKNOWN;
3530 
3531 	name = FStr_InitRefer("_");
3532 	if (mod[1] == '=') {
3533 		/*
3534 		 * XXX: This ad-hoc call to strcspn deviates from the usual
3535 		 * behavior defined in ParseModifierPart.  This creates an
3536 		 * unnecessary, undocumented inconsistency in make.
3537 		 */
3538 		const char *arg = mod + 2;
3539 		size_t argLen = strcspn(arg, ":)}");
3540 		*pp = arg + argLen;
3541 		name = FStr_InitOwn(bmake_strldup(arg, argLen));
3542 	} else
3543 		*pp = mod + 1;
3544 
3545 	if (Expr_ShouldEval(expr))
3546 		Var_Set(SCOPE_GLOBAL, name.str, Expr_Str(expr));
3547 	FStr_Done(&name);
3548 
3549 	return AMR_OK;
3550 }
3551 
3552 /*
3553  * Apply the given function to each word of the variable value,
3554  * for a single-letter modifier such as :H, :T.
3555  */
3556 static ApplyModifierResult
3557 ApplyModifier_WordFunc(const char **pp, ModChain *ch,
3558 		       ModifyWordProc modifyWord)
3559 {
3560 	if (!IsDelimiter((*pp)[1], ch))
3561 		return AMR_UNKNOWN;
3562 	(*pp)++;
3563 
3564 	if (ModChain_ShouldEval(ch))
3565 		ModifyWords(ch, modifyWord, NULL, ch->oneBigWord);
3566 
3567 	return AMR_OK;
3568 }
3569 
3570 /* Remove adjacent duplicate words. */
3571 static ApplyModifierResult
3572 ApplyModifier_Unique(const char **pp, ModChain *ch)
3573 {
3574 	SubstringWords words;
3575 
3576 	if (!IsDelimiter((*pp)[1], ch))
3577 		return AMR_UNKNOWN;
3578 	(*pp)++;
3579 
3580 	if (!ModChain_ShouldEval(ch))
3581 		return AMR_OK;
3582 
3583 	words = Expr_Words(ch->expr);
3584 
3585 	if (words.len > 1) {
3586 		size_t si, di;
3587 
3588 		di = 0;
3589 		for (si = 1; si < words.len; si++) {
3590 			if (!Substring_Eq(words.words[si], words.words[di])) {
3591 				di++;
3592 				if (di != si)
3593 					words.words[di] = words.words[si];
3594 			}
3595 		}
3596 		words.len = di + 1;
3597 	}
3598 
3599 	Expr_SetValueOwn(ch->expr, SubstringWords_JoinFree(words));
3600 
3601 	return AMR_OK;
3602 }
3603 
3604 #ifdef SYSVVARSUB
3605 /* :from=to */
3606 static ApplyModifierResult
3607 ApplyModifier_SysV(const char **pp, ModChain *ch)
3608 {
3609 	Expr *expr = ch->expr;
3610 	LazyBuf lhsBuf, rhsBuf;
3611 	FStr rhs;
3612 	struct ModifyWord_SysVSubstArgs args;
3613 	Substring lhs;
3614 	const char *lhsSuffix;
3615 
3616 	const char *mod = *pp;
3617 	bool eqFound = false;
3618 
3619 	/*
3620 	 * First we make a pass through the string trying to verify it is a
3621 	 * SysV-make-style translation. It must be: <lhs>=<rhs>
3622 	 */
3623 	int depth = 1;
3624 	const char *p = mod;
3625 	while (*p != '\0' && depth > 0) {
3626 		if (*p == '=') {	/* XXX: should also test depth == 1 */
3627 			eqFound = true;
3628 			/* continue looking for ch->endc */
3629 		} else if (*p == ch->endc)
3630 			depth--;
3631 		else if (*p == ch->startc)
3632 			depth++;
3633 		if (depth > 0)
3634 			p++;
3635 	}
3636 	if (*p != ch->endc || !eqFound)
3637 		return AMR_UNKNOWN;
3638 
3639 	if (!ParseModifierPart(pp, '=', expr->emode, ch, &lhsBuf))
3640 		return AMR_CLEANUP;
3641 
3642 	/*
3643 	 * The SysV modifier lasts until the end of the variable expression.
3644 	 */
3645 	if (!ParseModifierPart(pp, ch->endc, expr->emode, ch, &rhsBuf)) {
3646 		LazyBuf_Done(&lhsBuf);
3647 		return AMR_CLEANUP;
3648 	}
3649 	rhs = LazyBuf_DoneGet(&rhsBuf);
3650 
3651 	(*pp)--;		/* Go back to the ch->endc. */
3652 
3653 	/* Do not turn an empty expression into non-empty. */
3654 	if (lhsBuf.len == 0 && Expr_Str(expr)[0] == '\0')
3655 		goto done;
3656 
3657 	lhs = LazyBuf_Get(&lhsBuf);
3658 	lhsSuffix = Substring_SkipFirst(lhs, '%');
3659 
3660 	args.scope = expr->scope;
3661 	args.lhsPrefix = Substring_Init(lhs.start,
3662 	    lhsSuffix != lhs.start ? lhsSuffix - 1 : lhs.start);
3663 	args.lhsPercent = lhsSuffix != lhs.start;
3664 	args.lhsSuffix = Substring_Init(lhsSuffix, lhs.end);
3665 	args.rhs = rhs.str;
3666 
3667 	ModifyWords(ch, ModifyWord_SysVSubst, &args, ch->oneBigWord);
3668 
3669 done:
3670 	LazyBuf_Done(&lhsBuf);
3671 	FStr_Done(&rhs);
3672 	return AMR_OK;
3673 }
3674 #endif
3675 
3676 #ifdef SUNSHCMD
3677 /* :sh */
3678 static ApplyModifierResult
3679 ApplyModifier_SunShell(const char **pp, ModChain *ch)
3680 {
3681 	Expr *expr = ch->expr;
3682 	const char *p = *pp;
3683 	if (!(p[1] == 'h' && IsDelimiter(p[2], ch)))
3684 		return AMR_UNKNOWN;
3685 	*pp = p + 2;
3686 
3687 	if (Expr_ShouldEval(expr)) {
3688 		char *output, *error;
3689 		output = Cmd_Exec(Expr_Str(expr), &error);
3690 		if (error != NULL) {
3691 			Error("%s", error);
3692 			free(error);
3693 		}
3694 		Expr_SetValueOwn(expr, output);
3695 	}
3696 
3697 	return AMR_OK;
3698 }
3699 #endif
3700 
3701 /*
3702  * In cases where the evaluation mode and the definedness are the "standard"
3703  * ones, don't log them, to keep the logs readable.
3704  */
3705 static bool
3706 ShouldLogInSimpleFormat(const Expr *expr)
3707 {
3708 	return (expr->emode == VARE_WANTRES ||
3709 		expr->emode == VARE_UNDEFERR) &&
3710 	       expr->defined == DEF_REGULAR;
3711 }
3712 
3713 static void
3714 LogBeforeApply(const ModChain *ch, const char *mod)
3715 {
3716 	const Expr *expr = ch->expr;
3717 	bool is_single_char = mod[0] != '\0' && IsDelimiter(mod[1], ch);
3718 
3719 	/*
3720 	 * At this point, only the first character of the modifier can
3721 	 * be used since the end of the modifier is not yet known.
3722 	 */
3723 
3724 	if (!Expr_ShouldEval(expr)) {
3725 		debug_printf("Parsing modifier ${%s:%c%s}\n",
3726 		    expr->name, mod[0], is_single_char ? "" : "...");
3727 		return;
3728 	}
3729 
3730 	if (ShouldLogInSimpleFormat(expr)) {
3731 		debug_printf(
3732 		    "Evaluating modifier ${%s:%c%s} on value \"%s\"\n",
3733 		    expr->name, mod[0], is_single_char ? "" : "...",
3734 		    Expr_Str(expr));
3735 		return;
3736 	}
3737 
3738 	debug_printf(
3739 	    "Evaluating modifier ${%s:%c%s} on value \"%s\" (%s, %s)\n",
3740 	    expr->name, mod[0], is_single_char ? "" : "...", Expr_Str(expr),
3741 	    VarEvalMode_Name[expr->emode], ExprDefined_Name[expr->defined]);
3742 }
3743 
3744 static void
3745 LogAfterApply(const ModChain *ch, const char *p, const char *mod)
3746 {
3747 	const Expr *expr = ch->expr;
3748 	const char *value = Expr_Str(expr);
3749 	const char *quot = value == var_Error ? "" : "\"";
3750 
3751 	if (ShouldLogInSimpleFormat(expr)) {
3752 		debug_printf("Result of ${%s:%.*s} is %s%s%s\n",
3753 		    expr->name, (int)(p - mod), mod,
3754 		    quot, value == var_Error ? "error" : value, quot);
3755 		return;
3756 	}
3757 
3758 	debug_printf("Result of ${%s:%.*s} is %s%s%s (%s, %s)\n",
3759 	    expr->name, (int)(p - mod), mod,
3760 	    quot, value == var_Error ? "error" : value, quot,
3761 	    VarEvalMode_Name[expr->emode],
3762 	    ExprDefined_Name[expr->defined]);
3763 }
3764 
3765 static ApplyModifierResult
3766 ApplyModifier(const char **pp, ModChain *ch)
3767 {
3768 	switch (**pp) {
3769 	case '!':
3770 		return ApplyModifier_ShellCommand(pp, ch);
3771 	case ':':
3772 		return ApplyModifier_Assign(pp, ch);
3773 	case '?':
3774 		return ApplyModifier_IfElse(pp, ch);
3775 	case '@':
3776 		return ApplyModifier_Loop(pp, ch);
3777 	case '[':
3778 		return ApplyModifier_Words(pp, ch);
3779 	case '_':
3780 		return ApplyModifier_Remember(pp, ch);
3781 #ifndef NO_REGEX
3782 	case 'C':
3783 		return ApplyModifier_Regex(pp, ch);
3784 #endif
3785 	case 'D':
3786 	case 'U':
3787 		return ApplyModifier_Defined(pp, ch);
3788 	case 'E':
3789 		return ApplyModifier_WordFunc(pp, ch, ModifyWord_Suffix);
3790 	case 'g':
3791 	case 'l':
3792 		return ApplyModifier_Time(pp, ch);
3793 	case 'H':
3794 		return ApplyModifier_WordFunc(pp, ch, ModifyWord_Head);
3795 	case 'h':
3796 		return ApplyModifier_Hash(pp, ch);
3797 	case 'L':
3798 		return ApplyModifier_Literal(pp, ch);
3799 	case 'M':
3800 	case 'N':
3801 		return ApplyModifier_Match(pp, ch);
3802 	case 'O':
3803 		return ApplyModifier_Order(pp, ch);
3804 	case 'P':
3805 		return ApplyModifier_Path(pp, ch);
3806 	case 'Q':
3807 	case 'q':
3808 		return ApplyModifier_Quote(pp, ch);
3809 	case 'R':
3810 		return ApplyModifier_WordFunc(pp, ch, ModifyWord_Root);
3811 	case 'r':
3812 		return ApplyModifier_Range(pp, ch);
3813 	case 'S':
3814 		return ApplyModifier_Subst(pp, ch);
3815 #ifdef SUNSHCMD
3816 	case 's':
3817 		return ApplyModifier_SunShell(pp, ch);
3818 #endif
3819 	case 'T':
3820 		return ApplyModifier_WordFunc(pp, ch, ModifyWord_Tail);
3821 	case 't':
3822 		return ApplyModifier_To(pp, ch);
3823 	case 'u':
3824 		return ApplyModifier_Unique(pp, ch);
3825 	default:
3826 		return AMR_UNKNOWN;
3827 	}
3828 }
3829 
3830 static void ApplyModifiers(Expr *, const char **, char, char);
3831 
3832 typedef enum ApplyModifiersIndirectResult {
3833 	/* The indirect modifiers have been applied successfully. */
3834 	AMIR_CONTINUE,
3835 	/* Fall back to the SysV modifier. */
3836 	AMIR_SYSV,
3837 	/* Error out. */
3838 	AMIR_OUT
3839 } ApplyModifiersIndirectResult;
3840 
3841 /*
3842  * While expanding a variable expression, expand and apply indirect modifiers,
3843  * such as in ${VAR:${M_indirect}}.
3844  *
3845  * All indirect modifiers of a group must come from a single variable
3846  * expression.  ${VAR:${M1}} is valid but ${VAR:${M1}${M2}} is not.
3847  *
3848  * Multiple groups of indirect modifiers can be chained by separating them
3849  * with colons.  ${VAR:${M1}:${M2}} contains 2 indirect modifiers.
3850  *
3851  * If the variable expression is not followed by ch->endc or ':', fall
3852  * back to trying the SysV modifier, such as in ${VAR:${FROM}=${TO}}.
3853  */
3854 static ApplyModifiersIndirectResult
3855 ApplyModifiersIndirect(ModChain *ch, const char **pp)
3856 {
3857 	Expr *expr = ch->expr;
3858 	const char *p = *pp;
3859 	FStr mods = Var_Parse(&p, expr->scope, expr->emode);
3860 	/* TODO: handle errors */
3861 
3862 	if (mods.str[0] != '\0' && !IsDelimiter(*p, ch)) {
3863 		FStr_Done(&mods);
3864 		return AMIR_SYSV;
3865 	}
3866 
3867 	DEBUG3(VAR, "Indirect modifier \"%s\" from \"%.*s\"\n",
3868 	    mods.str, (int)(p - *pp), *pp);
3869 
3870 	if (mods.str[0] != '\0') {
3871 		const char *modsp = mods.str;
3872 		ApplyModifiers(expr, &modsp, '\0', '\0');
3873 		if (Expr_Str(expr) == var_Error || *modsp != '\0') {
3874 			FStr_Done(&mods);
3875 			*pp = p;
3876 			return AMIR_OUT;	/* error already reported */
3877 		}
3878 	}
3879 	FStr_Done(&mods);
3880 
3881 	if (*p == ':')
3882 		p++;
3883 	else if (*p == '\0' && ch->endc != '\0') {
3884 		Error("Unclosed variable expression after indirect "
3885 		      "modifier, expecting '%c' for variable \"%s\"",
3886 		    ch->endc, expr->name);
3887 		*pp = p;
3888 		return AMIR_OUT;
3889 	}
3890 
3891 	*pp = p;
3892 	return AMIR_CONTINUE;
3893 }
3894 
3895 static ApplyModifierResult
3896 ApplySingleModifier(const char **pp, ModChain *ch)
3897 {
3898 	ApplyModifierResult res;
3899 	const char *mod = *pp;
3900 	const char *p = *pp;
3901 
3902 	if (DEBUG(VAR))
3903 		LogBeforeApply(ch, mod);
3904 
3905 	res = ApplyModifier(&p, ch);
3906 
3907 #ifdef SYSVVARSUB
3908 	if (res == AMR_UNKNOWN) {
3909 		assert(p == mod);
3910 		res = ApplyModifier_SysV(&p, ch);
3911 	}
3912 #endif
3913 
3914 	if (res == AMR_UNKNOWN) {
3915 		/*
3916 		 * Guess the end of the current modifier.
3917 		 * XXX: Skipping the rest of the modifier hides
3918 		 * errors and leads to wrong results.
3919 		 * Parsing should rather stop here.
3920 		 */
3921 		for (p++; !IsDelimiter(*p, ch); p++)
3922 			continue;
3923 		Parse_Error(PARSE_FATAL, "Unknown modifier \"%.*s\"",
3924 		    (int)(p - mod), mod);
3925 		Expr_SetValueRefer(ch->expr, var_Error);
3926 	}
3927 	if (res == AMR_CLEANUP || res == AMR_BAD) {
3928 		*pp = p;
3929 		return res;
3930 	}
3931 
3932 	if (DEBUG(VAR))
3933 		LogAfterApply(ch, p, mod);
3934 
3935 	if (*p == '\0' && ch->endc != '\0') {
3936 		Error(
3937 		    "Unclosed variable expression, expecting '%c' for "
3938 		    "modifier \"%.*s\" of variable \"%s\" with value \"%s\"",
3939 		    ch->endc,
3940 		    (int)(p - mod), mod,
3941 		    ch->expr->name, Expr_Str(ch->expr));
3942 	} else if (*p == ':') {
3943 		p++;
3944 	} else if (opts.strict && *p != '\0' && *p != ch->endc) {
3945 		Parse_Error(PARSE_FATAL,
3946 		    "Missing delimiter ':' after modifier \"%.*s\"",
3947 		    (int)(p - mod), mod);
3948 		/*
3949 		 * TODO: propagate parse error to the enclosing
3950 		 * expression
3951 		 */
3952 	}
3953 	*pp = p;
3954 	return AMR_OK;
3955 }
3956 
3957 #if __STDC_VERSION__ >= 199901L
3958 #define ModChain_Literal(expr, startc, endc, sep, oneBigWord) \
3959 	(ModChain) { expr, startc, endc, sep, oneBigWord }
3960 #else
3961 MAKE_INLINE ModChain
3962 ModChain_Literal(Expr *expr, char startc, char endc, char sep, bool oneBigWord)
3963 {
3964 	ModChain ch;
3965 	ch.expr = expr;
3966 	ch.startc = startc;
3967 	ch.endc = endc;
3968 	ch.sep = sep;
3969 	ch.oneBigWord = oneBigWord;
3970 	return ch;
3971 }
3972 #endif
3973 
3974 /* Apply any modifiers (such as :Mpattern or :@var@loop@ or :Q or ::=value). */
3975 static void
3976 ApplyModifiers(
3977     Expr *expr,
3978     const char **pp,	/* the parsing position, updated upon return */
3979     char startc,	/* '(' or '{'; or '\0' for indirect modifiers */
3980     char endc		/* ')' or '}'; or '\0' for indirect modifiers */
3981 )
3982 {
3983 	ModChain ch = ModChain_Literal(expr, startc, endc, ' ', false);
3984 	const char *p;
3985 	const char *mod;
3986 
3987 	assert(startc == '(' || startc == '{' || startc == '\0');
3988 	assert(endc == ')' || endc == '}' || endc == '\0');
3989 	assert(Expr_Str(expr) != NULL);
3990 
3991 	p = *pp;
3992 
3993 	if (*p == '\0' && endc != '\0') {
3994 		Error(
3995 		    "Unclosed variable expression (expecting '%c') for \"%s\"",
3996 		    ch.endc, expr->name);
3997 		goto cleanup;
3998 	}
3999 
4000 	while (*p != '\0' && *p != endc) {
4001 		ApplyModifierResult res;
4002 
4003 		if (*p == '$') {
4004 			ApplyModifiersIndirectResult amir =
4005 			    ApplyModifiersIndirect(&ch, &p);
4006 			if (amir == AMIR_CONTINUE)
4007 				continue;
4008 			if (amir == AMIR_OUT)
4009 				break;
4010 			/*
4011 			 * It's neither '${VAR}:' nor '${VAR}}'.  Try to parse
4012 			 * it as a SysV modifier, as that is the only modifier
4013 			 * that can start with '$'.
4014 			 */
4015 		}
4016 
4017 		mod = p;
4018 
4019 		res = ApplySingleModifier(&p, &ch);
4020 		if (res == AMR_CLEANUP)
4021 			goto cleanup;
4022 		if (res == AMR_BAD)
4023 			goto bad_modifier;
4024 	}
4025 
4026 	*pp = p;
4027 	assert(Expr_Str(expr) != NULL);	/* Use var_Error or varUndefined. */
4028 	return;
4029 
4030 bad_modifier:
4031 	/* XXX: The modifier end is only guessed. */
4032 	Error("Bad modifier \":%.*s\" for variable \"%s\"",
4033 	    (int)strcspn(mod, ":)}"), mod, expr->name);
4034 
4035 cleanup:
4036 	/*
4037 	 * TODO: Use p + strlen(p) instead, to stop parsing immediately.
4038 	 *
4039 	 * In the unit tests, this generates a few shell commands with
4040 	 * unbalanced quotes.  Instead of producing these incomplete strings,
4041 	 * commands with evaluation errors should not be run at all.
4042 	 *
4043 	 * To make that happen, Var_Subst must report the actual errors
4044 	 * instead of returning the resulting string unconditionally.
4045 	 */
4046 	*pp = p;
4047 	Expr_SetValueRefer(expr, var_Error);
4048 }
4049 
4050 /*
4051  * Only 4 of the 7 built-in local variables are treated specially as they are
4052  * the only ones that will be set when dynamic sources are expanded.
4053  */
4054 static bool
4055 VarnameIsDynamic(Substring varname)
4056 {
4057 	const char *name;
4058 	size_t len;
4059 
4060 	name = varname.start;
4061 	len = Substring_Length(varname);
4062 	if (len == 1 || (len == 2 && (name[1] == 'F' || name[1] == 'D'))) {
4063 		switch (name[0]) {
4064 		case '@':
4065 		case '%':
4066 		case '*':
4067 		case '!':
4068 			return true;
4069 		}
4070 		return false;
4071 	}
4072 
4073 	if ((len == 7 || len == 8) && name[0] == '.' && ch_isupper(name[1])) {
4074 		return Substring_Equals(varname, ".TARGET") ||
4075 		       Substring_Equals(varname, ".ARCHIVE") ||
4076 		       Substring_Equals(varname, ".PREFIX") ||
4077 		       Substring_Equals(varname, ".MEMBER");
4078 	}
4079 
4080 	return false;
4081 }
4082 
4083 static const char *
4084 UndefinedShortVarValue(char varname, const GNode *scope)
4085 {
4086 	if (scope == SCOPE_CMDLINE || scope == SCOPE_GLOBAL) {
4087 		/*
4088 		 * If substituting a local variable in a non-local scope,
4089 		 * assume it's for dynamic source stuff. We have to handle
4090 		 * this specially and return the longhand for the variable
4091 		 * with the dollar sign escaped so it makes it back to the
4092 		 * caller. Only four of the local variables are treated
4093 		 * specially as they are the only four that will be set
4094 		 * when dynamic sources are expanded.
4095 		 */
4096 		switch (varname) {
4097 		case '@':
4098 			return "$(.TARGET)";
4099 		case '%':
4100 			return "$(.MEMBER)";
4101 		case '*':
4102 			return "$(.PREFIX)";
4103 		case '!':
4104 			return "$(.ARCHIVE)";
4105 		}
4106 	}
4107 	return NULL;
4108 }
4109 
4110 /*
4111  * Parse a variable name, until the end character or a colon, whichever
4112  * comes first.
4113  */
4114 static void
4115 ParseVarname(const char **pp, char startc, char endc,
4116 	     GNode *scope, VarEvalMode emode,
4117 	     LazyBuf *buf)
4118 {
4119 	const char *p = *pp;
4120 	int depth = 0;		/* Track depth so we can spot parse errors. */
4121 
4122 	LazyBuf_Init(buf, p);
4123 
4124 	while (*p != '\0') {
4125 		if ((*p == endc || *p == ':') && depth == 0)
4126 			break;
4127 		if (*p == startc)
4128 			depth++;
4129 		if (*p == endc)
4130 			depth--;
4131 
4132 		/* A variable inside a variable, expand. */
4133 		if (*p == '$') {
4134 			FStr nested_val = Var_Parse(&p, scope, emode);
4135 			/* TODO: handle errors */
4136 			LazyBuf_AddStr(buf, nested_val.str);
4137 			FStr_Done(&nested_val);
4138 		} else {
4139 			LazyBuf_Add(buf, *p);
4140 			p++;
4141 		}
4142 	}
4143 	*pp = p;
4144 }
4145 
4146 static bool
4147 IsShortVarnameValid(char varname, const char *start)
4148 {
4149 	if (varname != '$' && varname != ':' && varname != '}' &&
4150 	    varname != ')' && varname != '\0')
4151 		return true;
4152 
4153 	if (!opts.strict)
4154 		return false;	/* XXX: Missing error message */
4155 
4156 	if (varname == '$')
4157 		Parse_Error(PARSE_FATAL,
4158 		    "To escape a dollar, use \\$, not $$, at \"%s\"", start);
4159 	else if (varname == '\0')
4160 		Parse_Error(PARSE_FATAL, "Dollar followed by nothing");
4161 	else
4162 		Parse_Error(PARSE_FATAL,
4163 		    "Invalid variable name '%c', at \"%s\"", varname, start);
4164 
4165 	return false;
4166 }
4167 
4168 /*
4169  * Parse a single-character variable name such as in $V or $@.
4170  * Return whether to continue parsing.
4171  */
4172 static bool
4173 ParseVarnameShort(char varname, const char **pp, GNode *scope,
4174 		  VarEvalMode emode,
4175 		  const char **out_false_val,
4176 		  Var **out_true_var)
4177 {
4178 	char name[2];
4179 	Var *v;
4180 	const char *val;
4181 
4182 	if (!IsShortVarnameValid(varname, *pp)) {
4183 		(*pp)++;	/* only skip the '$' */
4184 		*out_false_val = var_Error;
4185 		return false;
4186 	}
4187 
4188 	name[0] = varname;
4189 	name[1] = '\0';
4190 	v = VarFind(name, scope, true);
4191 	if (v != NULL) {
4192 		/* No need to advance *pp, the calling code handles this. */
4193 		*out_true_var = v;
4194 		return true;
4195 	}
4196 
4197 	*pp += 2;
4198 
4199 	val = UndefinedShortVarValue(varname, scope);
4200 	if (val == NULL)
4201 		val = emode == VARE_UNDEFERR ? var_Error : varUndefined;
4202 
4203 	if (opts.strict && val == var_Error) {
4204 		Parse_Error(PARSE_FATAL,
4205 		    "Variable \"%s\" is undefined", name);
4206 	}
4207 
4208 	*out_false_val = val;
4209 	return false;
4210 }
4211 
4212 /* Find variables like @F or <D. */
4213 static Var *
4214 FindLocalLegacyVar(Substring varname, GNode *scope,
4215 		   const char **out_extraModifiers)
4216 {
4217 	Var *v;
4218 
4219 	/* Only resolve these variables if scope is a "real" target. */
4220 	if (scope == SCOPE_CMDLINE || scope == SCOPE_GLOBAL)
4221 		return NULL;
4222 
4223 	if (Substring_Length(varname) != 2)
4224 		return NULL;
4225 	if (varname.start[1] != 'F' && varname.start[1] != 'D')
4226 		return NULL;
4227 	if (strchr("@%?*!<>", varname.start[0]) == NULL)
4228 		return NULL;
4229 
4230 	v = VarFindSubstring(Substring_Sub(varname, 0, 1), scope, false);
4231 	if (v == NULL)
4232 		return NULL;
4233 
4234 	*out_extraModifiers = varname.start[1] == 'D' ? "H:" : "T:";
4235 	return v;
4236 }
4237 
4238 static FStr
4239 EvalUndefined(bool dynamic, const char *start, const char *p,
4240 	      Substring varname, VarEvalMode emode)
4241 {
4242 	if (dynamic)
4243 		return FStr_InitOwn(bmake_strsedup(start, p));
4244 
4245 	if (emode == VARE_UNDEFERR && opts.strict) {
4246 		Parse_Error(PARSE_FATAL,
4247 		    "Variable \"%.*s\" is undefined",
4248 		    (int)Substring_Length(varname), varname.start);
4249 		return FStr_InitRefer(var_Error);
4250 	}
4251 
4252 	return FStr_InitRefer(
4253 	    emode == VARE_UNDEFERR ? var_Error : varUndefined);
4254 }
4255 
4256 /*
4257  * Parse a long variable name enclosed in braces or parentheses such as $(VAR)
4258  * or ${VAR}, up to the closing brace or parenthesis, or in the case of
4259  * ${VAR:Modifiers}, up to the ':' that starts the modifiers.
4260  * Return whether to continue parsing.
4261  */
4262 static bool
4263 ParseVarnameLong(
4264 	const char **pp,
4265 	char startc,
4266 	GNode *scope,
4267 	VarEvalMode emode,
4268 
4269 	const char **out_false_pp,
4270 	FStr *out_false_val,
4271 
4272 	char *out_true_endc,
4273 	Var **out_true_v,
4274 	bool *out_true_haveModifier,
4275 	const char **out_true_extraModifiers,
4276 	bool *out_true_dynamic,
4277 	ExprDefined *out_true_exprDefined
4278 )
4279 {
4280 	LazyBuf varname;
4281 	Substring name;
4282 	Var *v;
4283 	bool haveModifier;
4284 	bool dynamic = false;
4285 
4286 	const char *p = *pp;
4287 	const char *const start = p;
4288 	char endc = startc == '(' ? ')' : '}';
4289 
4290 	p += 2;			/* skip "${" or "$(" or "y(" */
4291 	ParseVarname(&p, startc, endc, scope, emode, &varname);
4292 	name = LazyBuf_Get(&varname);
4293 
4294 	if (*p == ':') {
4295 		haveModifier = true;
4296 	} else if (*p == endc) {
4297 		haveModifier = false;
4298 	} else {
4299 		Parse_Error(PARSE_FATAL, "Unclosed variable \"%.*s\"",
4300 		    (int)Substring_Length(name), name.start);
4301 		LazyBuf_Done(&varname);
4302 		*out_false_pp = p;
4303 		*out_false_val = FStr_InitRefer(var_Error);
4304 		return false;
4305 	}
4306 
4307 	v = VarFindSubstring(name, scope, true);
4308 
4309 	/*
4310 	 * At this point, p points just after the variable name, either at
4311 	 * ':' or at endc.
4312 	 */
4313 
4314 	if (v == NULL && Substring_Equals(name, ".SUFFIXES")) {
4315 		char *suffixes = Suff_NamesStr();
4316 		v = VarNew(FStr_InitRefer(".SUFFIXES"), suffixes,
4317 		    true, false, true);
4318 		free(suffixes);
4319 	} else if (v == NULL)
4320 		v = FindLocalLegacyVar(name, scope, out_true_extraModifiers);
4321 
4322 	if (v == NULL) {
4323 		/*
4324 		 * Defer expansion of dynamic variables if they appear in
4325 		 * non-local scope since they are not defined there.
4326 		 */
4327 		dynamic = VarnameIsDynamic(name) &&
4328 			  (scope == SCOPE_CMDLINE || scope == SCOPE_GLOBAL);
4329 
4330 		if (!haveModifier) {
4331 			p++;	/* skip endc */
4332 			*out_false_pp = p;
4333 			*out_false_val = EvalUndefined(dynamic, start, p,
4334 			    name, emode);
4335 			LazyBuf_Done(&varname);
4336 			return false;
4337 		}
4338 
4339 		/*
4340 		 * The variable expression is based on an undefined variable.
4341 		 * Nevertheless it needs a Var, for modifiers that access the
4342 		 * variable name, such as :L or :?.
4343 		 *
4344 		 * Most modifiers leave this expression in the "undefined"
4345 		 * state (VES_UNDEF), only a few modifiers like :D, :U, :L,
4346 		 * :P turn this undefined expression into a defined
4347 		 * expression (VES_DEF).
4348 		 *
4349 		 * In the end, after applying all modifiers, if the expression
4350 		 * is still undefined, Var_Parse will return an empty string
4351 		 * instead of the actually computed value.
4352 		 */
4353 		v = VarNew(LazyBuf_DoneGet(&varname), "",
4354 		    true, false, false);
4355 		*out_true_exprDefined = DEF_UNDEF;
4356 	} else
4357 		LazyBuf_Done(&varname);
4358 
4359 	*pp = p;
4360 	*out_true_endc = endc;
4361 	*out_true_v = v;
4362 	*out_true_haveModifier = haveModifier;
4363 	*out_true_dynamic = dynamic;
4364 	return true;
4365 }
4366 
4367 #if __STDC_VERSION__ >= 199901L
4368 #define Expr_Literal(name, value, emode, scope, defined) \
4369 	{ name, value, emode, scope, defined }
4370 #else
4371 MAKE_INLINE Expr
4372 Expr_Literal(const char *name, FStr value,
4373 	     VarEvalMode emode, GNode *scope, ExprDefined defined)
4374 {
4375 	Expr expr;
4376 
4377 	expr.name = name;
4378 	expr.value = value;
4379 	expr.emode = emode;
4380 	expr.scope = scope;
4381 	expr.defined = defined;
4382 	return expr;
4383 }
4384 #endif
4385 
4386 /*
4387  * Expressions of the form ${:U...} with a trivial value are often generated
4388  * by .for loops and are boring, therefore parse and evaluate them in a fast
4389  * lane without debug logging.
4390  */
4391 static bool
4392 Var_Parse_FastLane(const char **pp, VarEvalMode emode, FStr *out_value)
4393 {
4394 	const char *p;
4395 
4396 	p = *pp;
4397 	if (!(p[0] == '$' && p[1] == '{' && p[2] == ':' && p[3] == 'U'))
4398 		return false;
4399 
4400 	p += 4;
4401 	while (*p != '$' && *p != '{' && *p != ':' && *p != '\\' &&
4402 	       *p != '}' && *p != '\0')
4403 		p++;
4404 	if (*p != '}')
4405 		return false;
4406 
4407 	if (emode == VARE_PARSE_ONLY)
4408 		*out_value = FStr_InitRefer("");
4409 	else
4410 		*out_value = FStr_InitOwn(bmake_strsedup(*pp + 4, p));
4411 	*pp = p + 1;
4412 	return true;
4413 }
4414 
4415 /*
4416  * Given the start of a variable expression (such as $v, $(VAR),
4417  * ${VAR:Mpattern}), extract the variable name and value, and the modifiers,
4418  * if any.  While doing that, apply the modifiers to the value of the
4419  * expression, forming its final value.  A few of the modifiers such as :!cmd!
4420  * or ::= have side effects.
4421  *
4422  * Input:
4423  *	*pp		The string to parse.
4424  *			When called from CondParser_FuncCallEmpty, it can
4425  *			also point to the "y" of "empty(VARNAME:Modifiers)".
4426  *	scope		The scope for finding variables
4427  *	emode		Controls the exact details of parsing and evaluation
4428  *
4429  * Output:
4430  *	*pp		The position where to continue parsing.
4431  *			TODO: After a parse error, the value of *pp is
4432  *			unspecified.  It may not have been updated at all,
4433  *			point to some random character in the string, to the
4434  *			location of the parse error, or at the end of the
4435  *			string.
4436  *	return		The value of the variable expression, never NULL.
4437  *	return		var_Error if there was a parse error.
4438  *	return		var_Error if the base variable of the expression was
4439  *			undefined, emode is VARE_UNDEFERR, and none of
4440  *			the modifiers turned the undefined expression into a
4441  *			defined expression.
4442  *			XXX: It is not guaranteed that an error message has
4443  *			been printed.
4444  *	return		varUndefined if the base variable of the expression
4445  *			was undefined, emode was not VARE_UNDEFERR,
4446  *			and none of the modifiers turned the undefined
4447  *			expression into a defined expression.
4448  *			XXX: It is not guaranteed that an error message has
4449  *			been printed.
4450  */
4451 FStr
4452 Var_Parse(const char **pp, GNode *scope, VarEvalMode emode)
4453 {
4454 	const char *p = *pp;
4455 	const char *const start = p;
4456 	bool haveModifier;	/* true for ${VAR:...}, false for ${VAR} */
4457 	char startc;		/* the actual '{' or '(' or '\0' */
4458 	char endc;		/* the expected '}' or ')' or '\0' */
4459 	/*
4460 	 * true if the expression is based on one of the 7 predefined
4461 	 * variables that are local to a target, and the expression is
4462 	 * expanded in a non-local scope.  The result is the text of the
4463 	 * expression, unaltered.  This is needed to support dynamic sources.
4464 	 */
4465 	bool dynamic;
4466 	const char *extramodifiers;
4467 	Var *v;
4468 	Expr expr = Expr_Literal(NULL, FStr_InitRefer(NULL), emode,
4469 	    scope, DEF_REGULAR);
4470 	FStr val;
4471 
4472 	if (Var_Parse_FastLane(pp, emode, &val))
4473 		return val;
4474 
4475 	/* TODO: Reduce computations in parse-only mode. */
4476 
4477 	DEBUG2(VAR, "Var_Parse: %s (%s)\n", start, VarEvalMode_Name[emode]);
4478 
4479 	val = FStr_InitRefer(NULL);
4480 	extramodifiers = NULL;	/* extra modifiers to apply first */
4481 	dynamic = false;
4482 
4483 	endc = '\0';		/* Appease GCC. */
4484 
4485 	startc = p[1];
4486 	if (startc != '(' && startc != '{') {
4487 		if (!ParseVarnameShort(startc, pp, scope, emode, &val.str, &v))
4488 			return val;
4489 		haveModifier = false;
4490 		p++;
4491 	} else {
4492 		if (!ParseVarnameLong(&p, startc, scope, emode,
4493 		    pp, &val,
4494 		    &endc, &v, &haveModifier, &extramodifiers,
4495 		    &dynamic, &expr.defined))
4496 			return val;
4497 	}
4498 
4499 	expr.name = v->name.str;
4500 	if (v->inUse && VarEvalMode_ShouldEval(emode)) {
4501 		if (scope->fname != NULL) {
4502 			fprintf(stderr, "In a command near ");
4503 			PrintLocation(stderr, false, scope);
4504 		}
4505 		Fatal("Variable %s is recursive.", v->name.str);
4506 	}
4507 
4508 	/*
4509 	 * XXX: This assignment creates an alias to the current value of the
4510 	 * variable.  This means that as long as the value of the expression
4511 	 * stays the same, the value of the variable must not change.
4512 	 * Using the '::=' modifier, it could be possible to trigger exactly
4513 	 * this situation.
4514 	 *
4515 	 * At the bottom of this function, the resulting value is compared to
4516 	 * the then-current value of the variable.  This might also invoke
4517 	 * undefined behavior.
4518 	 */
4519 	expr.value = FStr_InitRefer(v->val.data);
4520 
4521 	/*
4522 	 * Before applying any modifiers, expand any nested expressions from
4523 	 * the variable value.
4524 	 */
4525 	if (VarEvalMode_ShouldEval(emode) &&
4526 	    strchr(Expr_Str(&expr), '$') != NULL) {
4527 		char *expanded;
4528 		VarEvalMode nested_emode = emode;
4529 		if (opts.strict)
4530 			nested_emode = VarEvalMode_UndefOk(nested_emode);
4531 		v->inUse = true;
4532 		expanded = Var_Subst(Expr_Str(&expr), scope, nested_emode);
4533 		v->inUse = false;
4534 		/* TODO: handle errors */
4535 		Expr_SetValueOwn(&expr, expanded);
4536 	}
4537 
4538 	if (extramodifiers != NULL) {
4539 		const char *em = extramodifiers;
4540 		ApplyModifiers(&expr, &em, '\0', '\0');
4541 	}
4542 
4543 	if (haveModifier) {
4544 		p++;		/* Skip initial colon. */
4545 		ApplyModifiers(&expr, &p, startc, endc);
4546 	}
4547 
4548 	if (*p != '\0')		/* Skip past endc if possible. */
4549 		p++;
4550 
4551 	*pp = p;
4552 
4553 	if (expr.defined == DEF_UNDEF) {
4554 		if (dynamic)
4555 			Expr_SetValueOwn(&expr, bmake_strsedup(start, p));
4556 		else {
4557 			/*
4558 			 * The expression is still undefined, therefore
4559 			 * discard the actual value and return an error marker
4560 			 * instead.
4561 			 */
4562 			Expr_SetValueRefer(&expr,
4563 			    emode == VARE_UNDEFERR
4564 				? var_Error : varUndefined);
4565 		}
4566 	}
4567 
4568 	if (v->shortLived) {
4569 		if (expr.value.str == v->val.data) {
4570 			/* move ownership */
4571 			expr.value.freeIt = v->val.data;
4572 			v->val.data = NULL;
4573 		}
4574 		VarFreeShortLived(v);
4575 	}
4576 
4577 	return expr.value;
4578 }
4579 
4580 static void
4581 VarSubstDollarDollar(const char **pp, Buffer *res, VarEvalMode emode)
4582 {
4583 	/* A dollar sign may be escaped with another dollar sign. */
4584 	if (save_dollars && VarEvalMode_ShouldKeepDollar(emode))
4585 		Buf_AddByte(res, '$');
4586 	Buf_AddByte(res, '$');
4587 	*pp += 2;
4588 }
4589 
4590 static void
4591 VarSubstExpr(const char **pp, Buffer *buf, GNode *scope,
4592 	     VarEvalMode emode, bool *inout_errorReported)
4593 {
4594 	const char *p = *pp;
4595 	const char *nested_p = p;
4596 	FStr val = Var_Parse(&nested_p, scope, emode);
4597 	/* TODO: handle errors */
4598 
4599 	if (val.str == var_Error || val.str == varUndefined) {
4600 		if (!VarEvalMode_ShouldKeepUndef(emode)) {
4601 			p = nested_p;
4602 		} else if (val.str == var_Error) {
4603 
4604 			/*
4605 			 * XXX: This condition is wrong.  If val == var_Error,
4606 			 * this doesn't necessarily mean there was an undefined
4607 			 * variable.  It could equally well be a parse error;
4608 			 * see unit-tests/varmod-order.exp.
4609 			 */
4610 
4611 			/*
4612 			 * If variable is undefined, complain and skip the
4613 			 * variable. The complaint will stop us from doing
4614 			 * anything when the file is parsed.
4615 			 */
4616 			if (!*inout_errorReported) {
4617 				Parse_Error(PARSE_FATAL,
4618 				    "Undefined variable \"%.*s\"",
4619 				    (int)(size_t)(nested_p - p), p);
4620 			}
4621 			p = nested_p;
4622 			*inout_errorReported = true;
4623 		} else {
4624 			/*
4625 			 * Copy the initial '$' of the undefined expression,
4626 			 * thereby deferring expansion of the expression, but
4627 			 * expand nested expressions if already possible. See
4628 			 * unit-tests/varparse-undef-partial.mk.
4629 			 */
4630 			Buf_AddByte(buf, *p);
4631 			p++;
4632 		}
4633 	} else {
4634 		p = nested_p;
4635 		Buf_AddStr(buf, val.str);
4636 	}
4637 
4638 	FStr_Done(&val);
4639 
4640 	*pp = p;
4641 }
4642 
4643 /*
4644  * Skip as many characters as possible -- either to the end of the string
4645  * or to the next dollar sign (variable expression).
4646  */
4647 static void
4648 VarSubstPlain(const char **pp, Buffer *res)
4649 {
4650 	const char *p = *pp;
4651 	const char *start = p;
4652 
4653 	for (p++; *p != '$' && *p != '\0'; p++)
4654 		continue;
4655 	Buf_AddBytesBetween(res, start, p);
4656 	*pp = p;
4657 }
4658 
4659 /*
4660  * Expand all variable expressions like $V, ${VAR}, $(VAR:Modifiers) in the
4661  * given string.
4662  *
4663  * Input:
4664  *	str		The string in which the variable expressions are
4665  *			expanded.
4666  *	scope		The scope in which to start searching for
4667  *			variables.  The other scopes are searched as well.
4668  *	emode		The mode for parsing or evaluating subexpressions.
4669  */
4670 char *
4671 Var_Subst(const char *str, GNode *scope, VarEvalMode emode)
4672 {
4673 	const char *p = str;
4674 	Buffer res;
4675 
4676 	/*
4677 	 * Set true if an error has already been reported, to prevent a
4678 	 * plethora of messages when recursing
4679 	 */
4680 	/* See varparse-errors.mk for why the 'static' is necessary here. */
4681 	static bool errorReported;
4682 
4683 	Buf_Init(&res);
4684 	errorReported = false;
4685 
4686 	while (*p != '\0') {
4687 		if (p[0] == '$' && p[1] == '$')
4688 			VarSubstDollarDollar(&p, &res, emode);
4689 		else if (p[0] == '$')
4690 			VarSubstExpr(&p, &res, scope, emode, &errorReported);
4691 		else
4692 			VarSubstPlain(&p, &res);
4693 	}
4694 
4695 	return Buf_DoneDataCompact(&res);
4696 }
4697 
4698 void
4699 Var_Expand(FStr *str, GNode *scope, VarEvalMode emode)
4700 {
4701 	char *expanded;
4702 
4703 	if (strchr(str->str, '$') == NULL)
4704 		return;
4705 	expanded = Var_Subst(str->str, scope, emode);
4706 	/* TODO: handle errors */
4707 	FStr_Done(str);
4708 	*str = FStr_InitOwn(expanded);
4709 }
4710 
4711 /* Initialize the variables module. */
4712 void
4713 Var_Init(void)
4714 {
4715 	SCOPE_INTERNAL = GNode_New("Internal");
4716 	SCOPE_GLOBAL = GNode_New("Global");
4717 	SCOPE_CMDLINE = GNode_New("Command");
4718 }
4719 
4720 /* Clean up the variables module. */
4721 void
4722 Var_End(void)
4723 {
4724 	Var_Stats();
4725 }
4726 
4727 void
4728 Var_Stats(void)
4729 {
4730 	HashTable_DebugStats(&SCOPE_GLOBAL->vars, "Global variables");
4731 }
4732 
4733 static int
4734 StrAsc(const void *sa, const void *sb)
4735 {
4736 	return strcmp(
4737 	    *((const char *const *)sa), *((const char *const *)sb));
4738 }
4739 
4740 
4741 /* Print all variables in a scope, sorted by name. */
4742 void
4743 Var_Dump(GNode *scope)
4744 {
4745 	Vector /* of const char * */ vec;
4746 	HashIter hi;
4747 	size_t i;
4748 	const char **varnames;
4749 
4750 	Vector_Init(&vec, sizeof(const char *));
4751 
4752 	HashIter_Init(&hi, &scope->vars);
4753 	while (HashIter_Next(&hi) != NULL)
4754 		*(const char **)Vector_Push(&vec) = hi.entry->key;
4755 	varnames = vec.items;
4756 
4757 	qsort(varnames, vec.len, sizeof varnames[0], StrAsc);
4758 
4759 	for (i = 0; i < vec.len; i++) {
4760 		const char *varname = varnames[i];
4761 		const Var *var = HashTable_FindValue(&scope->vars, varname);
4762 		debug_printf("%-16s = %s%s\n", varname,
4763 		    var->val.data, ValueDescription(var->val.data));
4764 	}
4765 
4766 	Vector_Done(&vec);
4767 }
4768