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