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