var.c revision 1.937 1 /* $NetBSD: var.c,v 1.937 2021/06/21 18:12:49 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.937 2021/06/21 18:12:49 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 PatternFlags {
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 } PatternFlags;
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 PatternFlags 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 /*
1589 * Replacement of regular expressions is not specified by POSIX, therefore
1590 * re-implement it here.
1591 */
1592 static void
1593 RegexReplace(const char *replace, SepBuf *buf, const char *wp,
1594 const regmatch_t *m, size_t nsub)
1595 {
1596 const char *rp;
1597 size_t n;
1598
1599 for (rp = replace; *rp != '\0'; rp++) {
1600 if (*rp == '\\' && (rp[1] == '&' || rp[1] == '\\')) {
1601 SepBuf_AddBytes(buf, rp + 1, 1);
1602 rp++;
1603 continue;
1604 }
1605
1606 if (*rp == '&') {
1607 SepBuf_AddBytesBetween(buf,
1608 wp + m[0].rm_so, wp + m[0].rm_eo);
1609 continue;
1610 }
1611
1612 if (*rp != '\\' || !ch_isdigit(rp[1])) {
1613 SepBuf_AddBytes(buf, rp, 1);
1614 continue;
1615 }
1616
1617 /* \0 to \9 backreference */
1618 n = (size_t)(rp[1] - '0');
1619 rp++;
1620
1621 if (n >= nsub) {
1622 Error("No subexpression \\%u", (unsigned)n);
1623 } else if (m[n].rm_so == -1) {
1624 if (opts.strict) {
1625 Error("No match for subexpression \\%u",
1626 (unsigned)n);
1627 }
1628 } else {
1629 SepBuf_AddBytesBetween(buf,
1630 wp + m[n].rm_so, wp + m[n].rm_eo);
1631 }
1632 }
1633 }
1634
1635 struct ModifyWord_SubstRegexArgs {
1636 regex_t re;
1637 size_t nsub;
1638 const char *replace;
1639 PatternFlags pflags;
1640 bool matched;
1641 };
1642
1643 /*
1644 * Callback for ModifyWords to implement the :C/from/to/ modifier.
1645 * Perform a regex substitution on the given word.
1646 */
1647 static void
1648 ModifyWord_SubstRegex(Substring word, SepBuf *buf, void *data)
1649 {
1650 struct ModifyWord_SubstRegexArgs *args = data;
1651 int xrv;
1652 const char *wp;
1653 int flags = 0;
1654 regmatch_t m[10];
1655
1656 assert(word.end[0] == '\0'); /* assume null-terminated word */
1657 wp = word.start;
1658 if (args->pflags.subOnce && args->matched)
1659 goto no_match;
1660
1661 again:
1662 xrv = regexec(&args->re, wp, args->nsub, m, flags);
1663 if (xrv == 0)
1664 goto ok;
1665 if (xrv != REG_NOMATCH)
1666 VarREError(xrv, &args->re, "Unexpected regex error");
1667 no_match:
1668 SepBuf_AddStr(buf, wp);
1669 return;
1670
1671 ok:
1672 args->matched = true;
1673 SepBuf_AddBytes(buf, wp, (size_t)m[0].rm_so);
1674
1675 RegexReplace(args->replace, buf, wp, m, args->nsub);
1676
1677 wp += m[0].rm_eo;
1678 if (args->pflags.subGlobal) {
1679 flags |= REG_NOTBOL;
1680 if (m[0].rm_so == 0 && m[0].rm_eo == 0) {
1681 SepBuf_AddBytes(buf, wp, 1);
1682 wp++;
1683 }
1684 if (*wp != '\0')
1685 goto again;
1686 }
1687 if (*wp != '\0')
1688 SepBuf_AddStr(buf, wp);
1689 }
1690 #endif
1691
1692
1693 struct ModifyWord_LoopArgs {
1694 GNode *scope;
1695 const char *var; /* name of the temporary variable */
1696 const char *body; /* string to expand */
1697 VarEvalMode emode;
1698 };
1699
1700 /* Callback for ModifyWords to implement the :@var (at) ...@ modifier of ODE make. */
1701 static void
1702 ModifyWord_Loop(Substring word, SepBuf *buf, void *data)
1703 {
1704 const struct ModifyWord_LoopArgs *args;
1705 char *s;
1706
1707 if (Substring_IsEmpty(word))
1708 return;
1709
1710 args = data;
1711 assert(word.end[0] == '\0'); /* assume null-terminated word */
1712 Var_SetWithFlags(args->scope, args->var, word.start,
1713 VAR_SET_NO_EXPORT);
1714 (void)Var_Subst(args->body, args->scope, args->emode, &s);
1715 /* TODO: handle errors */
1716
1717 assert(word.end[0] == '\0'); /* assume null-terminated word */
1718 DEBUG4(VAR, "ModifyWord_Loop: "
1719 "in \"%s\", replace \"%s\" with \"%s\" to \"%s\"\n",
1720 word.start, args->var, args->body, s);
1721
1722 if (s[0] == '\n' || Buf_EndsWith(&buf->buf, '\n'))
1723 buf->needSep = false;
1724 SepBuf_AddStr(buf, s);
1725 free(s);
1726 }
1727
1728
1729 /*
1730 * The :[first..last] modifier selects words from the expression.
1731 * It can also reverse the words.
1732 */
1733 static char *
1734 VarSelectWords(const char *str, int first, int last,
1735 char sep, bool oneBigWord)
1736 {
1737 Words words;
1738 int len, start, end, step;
1739 int i;
1740
1741 SepBuf buf;
1742 SepBuf_Init(&buf, sep);
1743
1744 if (oneBigWord) {
1745 /* fake what Str_Words() would do if there were only one word */
1746 words.len = 1;
1747 words.words = bmake_malloc(
1748 (words.len + 1) * sizeof(words.words[0]));
1749 words.freeIt = bmake_strdup(str);
1750 words.words[0] = words.freeIt;
1751 words.words[1] = NULL;
1752 } else {
1753 words = Str_Words(str, false);
1754 }
1755
1756 /*
1757 * Now sanitize the given range. If first or last are negative,
1758 * convert them to the positive equivalents (-1 gets converted to len,
1759 * -2 gets converted to (len - 1), etc.).
1760 */
1761 len = (int)words.len;
1762 if (first < 0)
1763 first += len + 1;
1764 if (last < 0)
1765 last += len + 1;
1766
1767 /* We avoid scanning more of the list than we need to. */
1768 if (first > last) {
1769 start = (first > len ? len : first) - 1;
1770 end = last < 1 ? 0 : last - 1;
1771 step = -1;
1772 } else {
1773 start = first < 1 ? 0 : first - 1;
1774 end = last > len ? len : last;
1775 step = 1;
1776 }
1777
1778 for (i = start; (step < 0) == (i >= end); i += step) {
1779 SepBuf_AddStr(&buf, words.words[i]);
1780 SepBuf_Sep(&buf);
1781 }
1782
1783 Words_Free(words);
1784
1785 return SepBuf_DoneData(&buf);
1786 }
1787
1788
1789 /*
1790 * Callback for ModifyWords to implement the :tA modifier.
1791 * Replace each word with the result of realpath() if successful.
1792 */
1793 /*ARGSUSED*/
1794 static void
1795 ModifyWord_Realpath(Substring word, SepBuf *buf, void *data MAKE_ATTR_UNUSED)
1796 {
1797 struct stat st;
1798 char rbuf[MAXPATHLEN];
1799 const char *rp;
1800
1801 assert(word.end[0] == '\0'); /* assume null-terminated word */
1802 rp = cached_realpath(word.start, rbuf);
1803 if (rp != NULL && *rp == '/' && stat(rp, &st) == 0)
1804 SepBuf_AddStr(buf, rp);
1805 else
1806 SepBuf_AddSubstring(buf, word);
1807 }
1808
1809
1810 static char *
1811 Words_JoinFree(Words words)
1812 {
1813 Buffer buf;
1814 size_t i;
1815
1816 Buf_Init(&buf);
1817
1818 for (i = 0; i < words.len; i++) {
1819 if (i != 0) {
1820 /* XXX: Use ch->sep instead of ' ', for consistency. */
1821 Buf_AddByte(&buf, ' ');
1822 }
1823 Buf_AddStr(&buf, words.words[i]);
1824 }
1825
1826 Words_Free(words);
1827
1828 return Buf_DoneData(&buf);
1829 }
1830
1831
1832 /*
1833 * Quote shell meta-characters and space characters in the string.
1834 * If quoteDollar is set, also quote and double any '$' characters.
1835 */
1836 static void
1837 VarQuote(const char *str, bool quoteDollar, LazyBuf *buf)
1838 {
1839 const char *p;
1840
1841 LazyBuf_Init(buf, str);
1842 for (p = str; *p != '\0'; p++) {
1843 if (*p == '\n') {
1844 const char *newline = Shell_GetNewline();
1845 if (newline == NULL)
1846 newline = "\\\n";
1847 LazyBuf_AddStr(buf, newline);
1848 continue;
1849 }
1850 if (ch_isspace(*p) || is_shell_metachar((unsigned char)*p))
1851 LazyBuf_Add(buf, '\\');
1852 LazyBuf_Add(buf, *p);
1853 if (quoteDollar && *p == '$')
1854 LazyBuf_AddStr(buf, "\\$");
1855 }
1856 }
1857
1858 /*
1859 * Compute the 32-bit hash of the given string, using the MurmurHash3
1860 * algorithm. Output is encoded as 8 hex digits, in Little Endian order.
1861 */
1862 static char *
1863 VarHash(const char *str)
1864 {
1865 static const char hexdigits[16] = "0123456789abcdef";
1866 const unsigned char *ustr = (const unsigned char *)str;
1867
1868 uint32_t h = 0x971e137bU;
1869 uint32_t c1 = 0x95543787U;
1870 uint32_t c2 = 0x2ad7eb25U;
1871 size_t len2 = strlen(str);
1872
1873 char *buf;
1874 size_t i;
1875
1876 size_t len;
1877 for (len = len2; len != 0;) {
1878 uint32_t k = 0;
1879 switch (len) {
1880 default:
1881 k = ((uint32_t)ustr[3] << 24) |
1882 ((uint32_t)ustr[2] << 16) |
1883 ((uint32_t)ustr[1] << 8) |
1884 (uint32_t)ustr[0];
1885 len -= 4;
1886 ustr += 4;
1887 break;
1888 case 3:
1889 k |= (uint32_t)ustr[2] << 16;
1890 /* FALLTHROUGH */
1891 case 2:
1892 k |= (uint32_t)ustr[1] << 8;
1893 /* FALLTHROUGH */
1894 case 1:
1895 k |= (uint32_t)ustr[0];
1896 len = 0;
1897 }
1898 c1 = c1 * 5 + 0x7b7d159cU;
1899 c2 = c2 * 5 + 0x6bce6396U;
1900 k *= c1;
1901 k = (k << 11) ^ (k >> 21);
1902 k *= c2;
1903 h = (h << 13) ^ (h >> 19);
1904 h = h * 5 + 0x52dce729U;
1905 h ^= k;
1906 }
1907 h ^= (uint32_t)len2;
1908 h *= 0x85ebca6b;
1909 h ^= h >> 13;
1910 h *= 0xc2b2ae35;
1911 h ^= h >> 16;
1912
1913 buf = bmake_malloc(9);
1914 for (i = 0; i < 8; i++) {
1915 buf[i] = hexdigits[h & 0x0f];
1916 h >>= 4;
1917 }
1918 buf[8] = '\0';
1919 return buf;
1920 }
1921
1922 static char *
1923 VarStrftime(const char *fmt, bool zulu, time_t tim)
1924 {
1925 char buf[BUFSIZ];
1926
1927 if (tim == 0)
1928 time(&tim);
1929 if (*fmt == '\0')
1930 fmt = "%c";
1931 strftime(buf, sizeof buf, fmt, zulu ? gmtime(&tim) : localtime(&tim));
1932
1933 buf[sizeof buf - 1] = '\0';
1934 return bmake_strdup(buf);
1935 }
1936
1937 /*
1938 * The ApplyModifier functions take an expression that is being evaluated.
1939 * Their task is to apply a single modifier to the expression. This involves
1940 * parsing the modifier, evaluating it and finally updating the value of the
1941 * expression.
1942 *
1943 * Parsing the modifier
1944 *
1945 * If parsing succeeds, the parsing position *pp is updated to point to the
1946 * first character following the modifier, which typically is either ':' or
1947 * ch->endc. The modifier doesn't have to check for this delimiter character,
1948 * this is done by ApplyModifiers.
1949 *
1950 * XXX: As of 2020-11-15, some modifiers such as :S, :C, :P, :L do not
1951 * need to be followed by a ':' or endc; this was an unintended mistake.
1952 *
1953 * If parsing fails because of a missing delimiter (as in the :S, :C or :@
1954 * modifiers), return AMR_CLEANUP.
1955 *
1956 * If parsing fails because the modifier is unknown, return AMR_UNKNOWN to
1957 * try the SysV modifier ${VAR:from=to} as fallback. This should only be
1958 * done as long as there have been no side effects from evaluating nested
1959 * variables, to avoid evaluating them more than once. In this case, the
1960 * parsing position may or may not be updated. (XXX: Why not? The original
1961 * parsing position is well-known in ApplyModifiers.)
1962 *
1963 * If parsing fails and the SysV modifier ${VAR:from=to} should not be used
1964 * as a fallback, either issue an error message using Error or Parse_Error
1965 * and then return AMR_CLEANUP, or return AMR_BAD for the default error
1966 * message. Both of these return values will stop processing the variable
1967 * expression. (XXX: As of 2020-08-23, evaluation of the whole string
1968 * continues nevertheless after skipping a few bytes, which essentially is
1969 * undefined behavior. Not in the sense of C, but still the resulting string
1970 * is garbage.)
1971 *
1972 * Evaluating the modifier
1973 *
1974 * After parsing, the modifier is evaluated. The side effects from evaluating
1975 * nested variable expressions in the modifier text often already happen
1976 * during parsing though. For most modifiers this doesn't matter since their
1977 * only noticeable effect is that the update the value of the expression.
1978 * Some modifiers such as ':sh' or '::=' have noticeable side effects though.
1979 *
1980 * Evaluating the modifier usually takes the current value of the variable
1981 * expression from ch->expr->value, or the variable name from ch->var->name
1982 * and stores the result back in expr->value via Expr_SetValueOwn or
1983 * Expr_SetValueRefer.
1984 *
1985 * If evaluating fails (as of 2020-08-23), an error message is printed using
1986 * Error. This function has no side-effects, it really just prints the error
1987 * message. Processing the expression continues as if everything were ok.
1988 * XXX: This should be fixed by adding proper error handling to Var_Subst,
1989 * Var_Parse, ApplyModifiers and ModifyWords.
1990 *
1991 * Housekeeping
1992 *
1993 * Some modifiers such as :D and :U turn undefined expressions into defined
1994 * expressions (see Expr_Define).
1995 *
1996 * Some modifiers need to free some memory.
1997 */
1998
1999 typedef enum ExprDefined {
2000 /* The variable expression is based on a regular, defined variable. */
2001 DEF_REGULAR,
2002 /* The variable expression is based on an undefined variable. */
2003 DEF_UNDEF,
2004 /*
2005 * The variable expression started as an undefined expression, but one
2006 * of the modifiers (such as ':D' or ':U') has turned the expression
2007 * from undefined to defined.
2008 */
2009 DEF_DEFINED
2010 } ExprDefined;
2011
2012 static const char *const ExprDefined_Name[] = {
2013 "regular",
2014 "undefined",
2015 "defined"
2016 };
2017
2018 #if __STDC_VERSION__ >= 199901L
2019 #define const_member const
2020 #else
2021 #define const_member /* no const possible */
2022 #endif
2023
2024 /* A variable expression such as $@ or ${VAR:Mpattern:Q}. */
2025 typedef struct Expr {
2026 const char *name;
2027 FStr value;
2028 VarEvalMode const_member emode;
2029 GNode *const_member scope;
2030 ExprDefined defined;
2031 } Expr;
2032
2033 /*
2034 * The status of applying a chain of modifiers to an expression.
2035 *
2036 * The modifiers of an expression are broken into chains of modifiers,
2037 * starting a new nested chain whenever an indirect modifier starts. There
2038 * are at most 2 nesting levels: the outer one for the direct modifiers, and
2039 * the inner one for the indirect modifiers.
2040 *
2041 * For example, the expression ${VAR:M*:${IND1}:${IND2}:O:u} has 3 chains of
2042 * modifiers:
2043 *
2044 * Chain 1 starts with the single modifier ':M*'.
2045 * Chain 2 starts with all modifiers from ${IND1}.
2046 * Chain 2 ends at the ':' between ${IND1} and ${IND2}.
2047 * Chain 3 starts with all modifiers from ${IND2}.
2048 * Chain 3 ends at the ':' after ${IND2}.
2049 * Chain 1 continues with the the 2 modifiers ':O' and ':u'.
2050 * Chain 1 ends at the final '}' of the expression.
2051 *
2052 * After such a chain ends, its properties no longer have any effect.
2053 *
2054 * It may or may not have been intended that 'defined' has scope Expr while
2055 * 'sep' and 'oneBigWord' have smaller scope.
2056 *
2057 * See varmod-indirect.mk.
2058 */
2059 typedef struct ModChain {
2060 Expr *expr;
2061 /* '\0' or '{' or '(' */
2062 char const_member startc;
2063 /* '\0' or '}' or ')' */
2064 char const_member endc;
2065 /* Word separator in expansions (see the :ts modifier). */
2066 char sep;
2067 /*
2068 * True if some modifiers that otherwise split the variable value
2069 * into words, like :S and :C, treat the variable value as a single
2070 * big word, possibly containing spaces.
2071 */
2072 bool oneBigWord;
2073 } ModChain;
2074
2075 static void
2076 Expr_Define(Expr *expr)
2077 {
2078 if (expr->defined == DEF_UNDEF)
2079 expr->defined = DEF_DEFINED;
2080 }
2081
2082 static void
2083 Expr_SetValue(Expr *expr, FStr value)
2084 {
2085 FStr_Done(&expr->value);
2086 expr->value = value;
2087 }
2088
2089 static void
2090 Expr_SetValueOwn(Expr *expr, char *value)
2091 {
2092 Expr_SetValue(expr, FStr_InitOwn(value));
2093 }
2094
2095 static void
2096 Expr_SetValueRefer(Expr *expr, const char *value)
2097 {
2098 Expr_SetValue(expr, FStr_InitRefer(value));
2099 }
2100
2101 static bool
2102 Expr_ShouldEval(const Expr *expr)
2103 {
2104 return VarEvalMode_ShouldEval(expr->emode);
2105 }
2106
2107 static bool
2108 ModChain_ShouldEval(const ModChain *ch)
2109 {
2110 return Expr_ShouldEval(ch->expr);
2111 }
2112
2113
2114 typedef enum ApplyModifierResult {
2115 /* Continue parsing */
2116 AMR_OK,
2117 /* Not a match, try other modifiers as well. */
2118 AMR_UNKNOWN,
2119 /* Error out with "Bad modifier" message. */
2120 AMR_BAD,
2121 /* Error out without the standard error message. */
2122 AMR_CLEANUP
2123 } ApplyModifierResult;
2124
2125 /*
2126 * Allow backslashes to escape the delimiter, $, and \, but don't touch other
2127 * backslashes.
2128 */
2129 static bool
2130 IsEscapedModifierPart(const char *p, char delim,
2131 struct ModifyWord_SubstArgs *subst)
2132 {
2133 if (p[0] != '\\')
2134 return false;
2135 if (p[1] == delim || p[1] == '\\' || p[1] == '$')
2136 return true;
2137 return p[1] == '&' && subst != NULL;
2138 }
2139
2140 /* See ParseModifierPart for the documentation. */
2141 static VarParseResult
2142 ParseModifierPartSubst(
2143 const char **pp,
2144 char delim,
2145 VarEvalMode emode,
2146 ModChain *ch,
2147 LazyBuf *part,
2148 /* For the first part of the modifier ':S', set anchorEnd if the last
2149 * character of the pattern is a $. */
2150 PatternFlags *out_pflags,
2151 /* For the second part of the :S modifier, allow ampersands to be
2152 * escaped and replace unescaped ampersands with subst->lhs. */
2153 struct ModifyWord_SubstArgs *subst
2154 )
2155 {
2156 const char *p;
2157
2158 p = *pp;
2159 LazyBuf_Init(part, p);
2160
2161 /*
2162 * Skim through until the matching delimiter is found; pick up
2163 * variable expressions on the way.
2164 */
2165 while (*p != '\0' && *p != delim) {
2166 const char *varstart;
2167
2168 if (IsEscapedModifierPart(p, delim, subst)) {
2169 LazyBuf_Add(part, p[1]);
2170 p += 2;
2171 continue;
2172 }
2173
2174 if (*p != '$') { /* Unescaped, simple text */
2175 if (subst != NULL && *p == '&')
2176 LazyBuf_AddSubstring(part, subst->lhs);
2177 else
2178 LazyBuf_Add(part, *p);
2179 p++;
2180 continue;
2181 }
2182
2183 if (p[1] == delim) { /* Unescaped $ at end of pattern */
2184 if (out_pflags != NULL)
2185 out_pflags->anchorEnd = true;
2186 else
2187 LazyBuf_Add(part, *p);
2188 p++;
2189 continue;
2190 }
2191
2192 if (VarEvalMode_ShouldEval(emode)) {
2193 /* Nested variable, evaluated */
2194 const char *nested_p = p;
2195 FStr nested_val;
2196
2197 (void)Var_Parse(&nested_p, ch->expr->scope,
2198 VarEvalMode_WithoutKeepDollar(emode), &nested_val);
2199 /* TODO: handle errors */
2200 LazyBuf_AddStr(part, nested_val.str);
2201 FStr_Done(&nested_val);
2202 p += nested_p - p;
2203 continue;
2204 }
2205
2206 /*
2207 * XXX: This whole block is very similar to Var_Parse without
2208 * VARE_WANTRES. There may be subtle edge cases
2209 * though that are not yet covered in the unit tests and that
2210 * are parsed differently, depending on whether they are
2211 * evaluated or not.
2212 *
2213 * This subtle difference is not documented in the manual
2214 * page, neither is the difference between parsing :D and
2215 * :M documented. No code should ever depend on these
2216 * details, but who knows.
2217 */
2218
2219 varstart = p; /* Nested variable, only parsed */
2220 if (p[1] == '(' || p[1] == '{') {
2221 /*
2222 * Find the end of this variable reference
2223 * and suck it in without further ado.
2224 * It will be interpreted later.
2225 */
2226 char startc = p[1];
2227 int endc = startc == '(' ? ')' : '}';
2228 int depth = 1;
2229
2230 for (p += 2; *p != '\0' && depth > 0; p++) {
2231 if (p[-1] != '\\') {
2232 if (*p == startc)
2233 depth++;
2234 if (*p == endc)
2235 depth--;
2236 }
2237 }
2238 LazyBuf_AddBytesBetween(part, varstart, p);
2239 } else {
2240 LazyBuf_Add(part, *varstart);
2241 p++;
2242 }
2243 }
2244
2245 if (*p != delim) {
2246 *pp = p;
2247 Error("Unfinished modifier for \"%s\" ('%c' missing)",
2248 ch->expr->name, delim);
2249 LazyBuf_Done(part);
2250 return VPR_ERR;
2251 }
2252
2253 *pp = p + 1;
2254
2255 {
2256 Substring sub = LazyBuf_Get(part);
2257 DEBUG2(VAR, "Modifier part: \"%.*s\"\n",
2258 (int)Substring_Length(sub), sub.start);
2259 }
2260
2261 return VPR_OK;
2262 }
2263
2264 /*
2265 * Parse a part of a modifier such as the "from" and "to" in :S/from/to/ or
2266 * the "var" or "replacement ${var}" in :@var@replacement ${var}@, up to and
2267 * including the next unescaped delimiter. The delimiter, as well as the
2268 * backslash or the dollar, can be escaped with a backslash.
2269 *
2270 * Return VPR_OK if parsing succeeded, together with the parsed (and possibly
2271 * expanded) part. In that case, pp points right after the delimiter. The
2272 * delimiter is not included in the part though.
2273 */
2274 static VarParseResult
2275 ParseModifierPart(
2276 /* The parsing position, updated upon return */
2277 const char **pp,
2278 /* Parsing stops at this delimiter */
2279 char delim,
2280 /* Mode for evaluating nested variables. */
2281 VarEvalMode emode,
2282 ModChain *ch,
2283 LazyBuf *part
2284 )
2285 {
2286 return ParseModifierPartSubst(pp, delim, emode, ch, part, NULL, NULL);
2287 }
2288
2289 MAKE_INLINE bool
2290 IsDelimiter(char c, const ModChain *ch)
2291 {
2292 return c == ':' || c == ch->endc;
2293 }
2294
2295 /* Test whether mod starts with modname, followed by a delimiter. */
2296 MAKE_INLINE bool
2297 ModMatch(const char *mod, const char *modname, const ModChain *ch)
2298 {
2299 size_t n = strlen(modname);
2300 return strncmp(mod, modname, n) == 0 && IsDelimiter(mod[n], ch);
2301 }
2302
2303 /* Test whether mod starts with modname, followed by a delimiter or '='. */
2304 MAKE_INLINE bool
2305 ModMatchEq(const char *mod, const char *modname, const ModChain *ch)
2306 {
2307 size_t n = strlen(modname);
2308 return strncmp(mod, modname, n) == 0 &&
2309 (IsDelimiter(mod[n], ch) || mod[n] == '=');
2310 }
2311
2312 static bool
2313 TryParseIntBase0(const char **pp, int *out_num)
2314 {
2315 char *end;
2316 long n;
2317
2318 errno = 0;
2319 n = strtol(*pp, &end, 0);
2320
2321 if (end == *pp)
2322 return false;
2323 if ((n == LONG_MIN || n == LONG_MAX) && errno == ERANGE)
2324 return false;
2325 if (n < INT_MIN || n > INT_MAX)
2326 return false;
2327
2328 *pp = end;
2329 *out_num = (int)n;
2330 return true;
2331 }
2332
2333 static bool
2334 TryParseSize(const char **pp, size_t *out_num)
2335 {
2336 char *end;
2337 unsigned long n;
2338
2339 if (!ch_isdigit(**pp))
2340 return false;
2341
2342 errno = 0;
2343 n = strtoul(*pp, &end, 10);
2344 if (n == ULONG_MAX && errno == ERANGE)
2345 return false;
2346 if (n > SIZE_MAX)
2347 return false;
2348
2349 *pp = end;
2350 *out_num = (size_t)n;
2351 return true;
2352 }
2353
2354 static bool
2355 TryParseChar(const char **pp, int base, char *out_ch)
2356 {
2357 char *end;
2358 unsigned long n;
2359
2360 if (!ch_isalnum(**pp))
2361 return false;
2362
2363 errno = 0;
2364 n = strtoul(*pp, &end, base);
2365 if (n == ULONG_MAX && errno == ERANGE)
2366 return false;
2367 if (n > UCHAR_MAX)
2368 return false;
2369
2370 *pp = end;
2371 *out_ch = (char)n;
2372 return true;
2373 }
2374
2375 /*
2376 * Modify each word of the expression using the given function and place the
2377 * result back in the expression.
2378 */
2379 static void
2380 ModifyWords(ModChain *ch,
2381 ModifyWordProc modifyWord, void *modifyWord_args,
2382 bool oneBigWord)
2383 {
2384 Expr *expr = ch->expr;
2385 const char *val = expr->value.str;
2386 SepBuf result;
2387 SubstringWords words;
2388 size_t i;
2389 Substring word;
2390
2391 if (oneBigWord) {
2392 SepBuf_Init(&result, ch->sep);
2393 /* XXX: performance: Substring_InitStr calls strlen */
2394 word = Substring_InitStr(val);
2395 modifyWord(word, &result, modifyWord_args);
2396 goto done;
2397 }
2398
2399 words = Substring_Words(val, false);
2400
2401 DEBUG2(VAR, "ModifyWords: split \"%s\" into %u words\n",
2402 val, (unsigned)words.len);
2403
2404 SepBuf_Init(&result, ch->sep);
2405 for (i = 0; i < words.len; i++) {
2406 modifyWord(words.words[i], &result, modifyWord_args);
2407 if (result.buf.len > 0)
2408 SepBuf_Sep(&result);
2409 }
2410
2411 SubstringWords_Free(words);
2412
2413 done:
2414 Expr_SetValueOwn(expr, SepBuf_DoneData(&result));
2415 }
2416
2417 /* :@var (at) ...${var}...@ */
2418 static ApplyModifierResult
2419 ApplyModifier_Loop(const char **pp, ModChain *ch)
2420 {
2421 Expr *expr = ch->expr;
2422 struct ModifyWord_LoopArgs args;
2423 char prev_sep;
2424 VarParseResult res;
2425 LazyBuf tvarBuf, strBuf;
2426 FStr tvar, str;
2427
2428 args.scope = expr->scope;
2429
2430 (*pp)++; /* Skip the first '@' */
2431 res = ParseModifierPart(pp, '@', VARE_PARSE_ONLY, ch, &tvarBuf);
2432 if (res != VPR_OK)
2433 return AMR_CLEANUP;
2434 tvar = LazyBuf_DoneGet(&tvarBuf);
2435 args.var = tvar.str;
2436 if (strchr(args.var, '$') != NULL) {
2437 Parse_Error(PARSE_FATAL,
2438 "In the :@ modifier of \"%s\", the variable name \"%s\" "
2439 "must not contain a dollar.",
2440 expr->name, args.var);
2441 return AMR_CLEANUP;
2442 }
2443
2444 res = ParseModifierPart(pp, '@', VARE_PARSE_ONLY, ch, &strBuf);
2445 if (res != VPR_OK)
2446 return AMR_CLEANUP;
2447 str = LazyBuf_DoneGet(&strBuf);
2448 args.body = str.str;
2449
2450 if (!Expr_ShouldEval(expr))
2451 goto done;
2452
2453 args.emode = VarEvalMode_WithoutKeepDollar(expr->emode);
2454 prev_sep = ch->sep;
2455 ch->sep = ' '; /* XXX: should be ch->sep for consistency */
2456 ModifyWords(ch, ModifyWord_Loop, &args, ch->oneBigWord);
2457 ch->sep = prev_sep;
2458 /* XXX: Consider restoring the previous value instead of deleting. */
2459 Var_Delete(expr->scope, args.var);
2460
2461 done:
2462 FStr_Done(&tvar);
2463 FStr_Done(&str);
2464 return AMR_OK;
2465 }
2466
2467 /* :Ddefined or :Uundefined */
2468 static ApplyModifierResult
2469 ApplyModifier_Defined(const char **pp, ModChain *ch)
2470 {
2471 Expr *expr = ch->expr;
2472 LazyBuf buf;
2473 const char *p;
2474
2475 VarEvalMode emode = VARE_PARSE_ONLY;
2476 if (Expr_ShouldEval(expr))
2477 if ((**pp == 'D') == (expr->defined == DEF_REGULAR))
2478 emode = expr->emode;
2479
2480 p = *pp + 1;
2481 LazyBuf_Init(&buf, p);
2482 while (!IsDelimiter(*p, ch) && *p != '\0') {
2483
2484 /* XXX: This code is similar to the one in Var_Parse.
2485 * See if the code can be merged.
2486 * See also ApplyModifier_Match and ParseModifierPart. */
2487
2488 /* Escaped delimiter or other special character */
2489 /* See Buf_AddEscaped in for.c. */
2490 if (*p == '\\') {
2491 char c = p[1];
2492 if (IsDelimiter(c, ch) || c == '$' || c == '\\') {
2493 LazyBuf_Add(&buf, c);
2494 p += 2;
2495 continue;
2496 }
2497 }
2498
2499 /* Nested variable expression */
2500 if (*p == '$') {
2501 FStr nested_val;
2502
2503 (void)Var_Parse(&p, expr->scope, emode, &nested_val);
2504 /* TODO: handle errors */
2505 if (Expr_ShouldEval(expr))
2506 LazyBuf_AddStr(&buf, nested_val.str);
2507 FStr_Done(&nested_val);
2508 continue;
2509 }
2510
2511 /* Ordinary text */
2512 LazyBuf_Add(&buf, *p);
2513 p++;
2514 }
2515 *pp = p;
2516
2517 Expr_Define(expr);
2518
2519 if (VarEvalMode_ShouldEval(emode))
2520 Expr_SetValue(expr, Substring_Str(LazyBuf_Get(&buf)));
2521 else
2522 LazyBuf_Done(&buf);
2523
2524 return AMR_OK;
2525 }
2526
2527 /* :L */
2528 static ApplyModifierResult
2529 ApplyModifier_Literal(const char **pp, ModChain *ch)
2530 {
2531 Expr *expr = ch->expr;
2532
2533 (*pp)++;
2534
2535 if (Expr_ShouldEval(expr)) {
2536 Expr_Define(expr);
2537 Expr_SetValueOwn(expr, bmake_strdup(expr->name));
2538 }
2539
2540 return AMR_OK;
2541 }
2542
2543 static bool
2544 TryParseTime(const char **pp, time_t *out_time)
2545 {
2546 char *end;
2547 unsigned long n;
2548
2549 if (!ch_isdigit(**pp))
2550 return false;
2551
2552 errno = 0;
2553 n = strtoul(*pp, &end, 10);
2554 if (n == ULONG_MAX && errno == ERANGE)
2555 return false;
2556
2557 *pp = end;
2558 *out_time = (time_t)n; /* ignore possible truncation for now */
2559 return true;
2560 }
2561
2562 /* :gmtime */
2563 static ApplyModifierResult
2564 ApplyModifier_Gmtime(const char **pp, ModChain *ch)
2565 {
2566 time_t utc;
2567
2568 const char *mod = *pp;
2569 if (!ModMatchEq(mod, "gmtime", ch))
2570 return AMR_UNKNOWN;
2571
2572 if (mod[6] == '=') {
2573 const char *p = mod + 7;
2574 if (!TryParseTime(&p, &utc)) {
2575 Parse_Error(PARSE_FATAL,
2576 "Invalid time value: %s", mod + 7);
2577 return AMR_CLEANUP;
2578 }
2579 *pp = p;
2580 } else {
2581 utc = 0;
2582 *pp = mod + 6;
2583 }
2584
2585 if (ModChain_ShouldEval(ch))
2586 Expr_SetValueOwn(ch->expr,
2587 VarStrftime(ch->expr->value.str, true, utc));
2588
2589 return AMR_OK;
2590 }
2591
2592 /* :localtime */
2593 static ApplyModifierResult
2594 ApplyModifier_Localtime(const char **pp, ModChain *ch)
2595 {
2596 time_t utc;
2597
2598 const char *mod = *pp;
2599 if (!ModMatchEq(mod, "localtime", ch))
2600 return AMR_UNKNOWN;
2601
2602 if (mod[9] == '=') {
2603 const char *p = mod + 10;
2604 if (!TryParseTime(&p, &utc)) {
2605 Parse_Error(PARSE_FATAL,
2606 "Invalid time value: %s", mod + 10);
2607 return AMR_CLEANUP;
2608 }
2609 *pp = p;
2610 } else {
2611 utc = 0;
2612 *pp = mod + 9;
2613 }
2614
2615 if (ModChain_ShouldEval(ch))
2616 Expr_SetValueOwn(ch->expr,
2617 VarStrftime(ch->expr->value.str, false, utc));
2618
2619 return AMR_OK;
2620 }
2621
2622 /* :hash */
2623 static ApplyModifierResult
2624 ApplyModifier_Hash(const char **pp, ModChain *ch)
2625 {
2626 if (!ModMatch(*pp, "hash", ch))
2627 return AMR_UNKNOWN;
2628 *pp += 4;
2629
2630 if (ModChain_ShouldEval(ch))
2631 Expr_SetValueOwn(ch->expr, VarHash(ch->expr->value.str));
2632
2633 return AMR_OK;
2634 }
2635
2636 /* :P */
2637 static ApplyModifierResult
2638 ApplyModifier_Path(const char **pp, ModChain *ch)
2639 {
2640 Expr *expr = ch->expr;
2641 GNode *gn;
2642 char *path;
2643
2644 (*pp)++;
2645
2646 if (!ModChain_ShouldEval(ch))
2647 return AMR_OK;
2648
2649 Expr_Define(expr);
2650
2651 gn = Targ_FindNode(expr->name);
2652 if (gn == NULL || gn->type & OP_NOPATH) {
2653 path = NULL;
2654 } else if (gn->path != NULL) {
2655 path = bmake_strdup(gn->path);
2656 } else {
2657 SearchPath *searchPath = Suff_FindPath(gn);
2658 path = Dir_FindFile(expr->name, searchPath);
2659 }
2660 if (path == NULL)
2661 path = bmake_strdup(expr->name);
2662 Expr_SetValueOwn(expr, path);
2663
2664 return AMR_OK;
2665 }
2666
2667 /* :!cmd! */
2668 static ApplyModifierResult
2669 ApplyModifier_ShellCommand(const char **pp, ModChain *ch)
2670 {
2671 Expr *expr = ch->expr;
2672 const char *errfmt;
2673 VarParseResult res;
2674 LazyBuf cmdBuf;
2675 FStr cmd;
2676
2677 (*pp)++;
2678 res = ParseModifierPart(pp, '!', expr->emode, ch, &cmdBuf);
2679 if (res != VPR_OK)
2680 return AMR_CLEANUP;
2681 cmd = LazyBuf_DoneGet(&cmdBuf);
2682
2683
2684 errfmt = NULL;
2685 if (Expr_ShouldEval(expr))
2686 Expr_SetValueOwn(expr, Cmd_Exec(cmd.str, &errfmt));
2687 else
2688 Expr_SetValueRefer(expr, "");
2689 if (errfmt != NULL)
2690 Error(errfmt, cmd.str); /* XXX: why still return AMR_OK? */
2691 FStr_Done(&cmd);
2692 Expr_Define(expr);
2693
2694 return AMR_OK;
2695 }
2696
2697 /*
2698 * The :range modifier generates an integer sequence as long as the words.
2699 * The :range=7 modifier generates an integer sequence from 1 to 7.
2700 */
2701 static ApplyModifierResult
2702 ApplyModifier_Range(const char **pp, ModChain *ch)
2703 {
2704 size_t n;
2705 Buffer buf;
2706 size_t i;
2707
2708 const char *mod = *pp;
2709 if (!ModMatchEq(mod, "range", ch))
2710 return AMR_UNKNOWN;
2711
2712 if (mod[5] == '=') {
2713 const char *p = mod + 6;
2714 if (!TryParseSize(&p, &n)) {
2715 Parse_Error(PARSE_FATAL,
2716 "Invalid number \"%s\" for ':range' modifier",
2717 mod + 6);
2718 return AMR_CLEANUP;
2719 }
2720 *pp = p;
2721 } else {
2722 n = 0;
2723 *pp = mod + 5;
2724 }
2725
2726 if (!ModChain_ShouldEval(ch))
2727 return AMR_OK;
2728
2729 if (n == 0) {
2730 Words words = Str_Words(ch->expr->value.str, false);
2731 n = words.len;
2732 Words_Free(words);
2733 }
2734
2735 Buf_Init(&buf);
2736
2737 for (i = 0; i < n; i++) {
2738 if (i != 0) {
2739 /* XXX: Use ch->sep instead of ' ', for consistency. */
2740 Buf_AddByte(&buf, ' ');
2741 }
2742 Buf_AddInt(&buf, 1 + (int)i);
2743 }
2744
2745 Expr_SetValueOwn(ch->expr, Buf_DoneData(&buf));
2746 return AMR_OK;
2747 }
2748
2749 /* Parse a ':M' or ':N' modifier. */
2750 static void
2751 ParseModifier_Match(const char **pp, const ModChain *ch,
2752 char **out_pattern)
2753 {
2754 const char *mod = *pp;
2755 Expr *expr = ch->expr;
2756 bool copy = false; /* pattern should be, or has been, copied */
2757 bool needSubst = false;
2758 const char *endpat;
2759 char *pattern;
2760
2761 /*
2762 * In the loop below, ignore ':' unless we are at (or back to) the
2763 * original brace level.
2764 * XXX: This will likely not work right if $() and ${} are intermixed.
2765 */
2766 /*
2767 * XXX: This code is similar to the one in Var_Parse.
2768 * See if the code can be merged.
2769 * See also ApplyModifier_Defined.
2770 */
2771 int nest = 0;
2772 const char *p;
2773 for (p = mod + 1; *p != '\0' && !(*p == ':' && nest == 0); p++) {
2774 if (*p == '\\' &&
2775 (IsDelimiter(p[1], ch) || p[1] == ch->startc)) {
2776 if (!needSubst)
2777 copy = true;
2778 p++;
2779 continue;
2780 }
2781 if (*p == '$')
2782 needSubst = true;
2783 if (*p == '(' || *p == '{')
2784 nest++;
2785 if (*p == ')' || *p == '}') {
2786 nest--;
2787 if (nest < 0)
2788 break;
2789 }
2790 }
2791 *pp = p;
2792 endpat = p;
2793
2794 if (copy) {
2795 char *dst;
2796 const char *src;
2797
2798 /* Compress the \:'s out of the pattern. */
2799 pattern = bmake_malloc((size_t)(endpat - (mod + 1)) + 1);
2800 dst = pattern;
2801 src = mod + 1;
2802 for (; src < endpat; src++, dst++) {
2803 if (src[0] == '\\' && src + 1 < endpat &&
2804 /* XXX: ch->startc is missing here; see above */
2805 IsDelimiter(src[1], ch))
2806 src++;
2807 *dst = *src;
2808 }
2809 *dst = '\0';
2810 } else {
2811 pattern = bmake_strsedup(mod + 1, endpat);
2812 }
2813
2814 if (needSubst) {
2815 char *old_pattern = pattern;
2816 (void)Var_Subst(pattern, expr->scope, expr->emode, &pattern);
2817 /* TODO: handle errors */
2818 free(old_pattern);
2819 }
2820
2821 DEBUG2(VAR, "Pattern for ':%c' is \"%s\"\n", mod[0], pattern);
2822
2823 *out_pattern = pattern;
2824 }
2825
2826 /* :Mpattern or :Npattern */
2827 static ApplyModifierResult
2828 ApplyModifier_Match(const char **pp, ModChain *ch)
2829 {
2830 const char mod = **pp;
2831 char *pattern;
2832
2833 ParseModifier_Match(pp, ch, &pattern);
2834
2835 if (ModChain_ShouldEval(ch)) {
2836 ModifyWordProc modifyWord =
2837 mod == 'M' ? ModifyWord_Match : ModifyWord_NoMatch;
2838 ModifyWords(ch, modifyWord, pattern, ch->oneBigWord);
2839 }
2840
2841 free(pattern);
2842 return AMR_OK;
2843 }
2844
2845 static void
2846 ParsePatternFlags(const char **pp, PatternFlags *pflags, bool *oneBigWord)
2847 {
2848 for (;; (*pp)++) {
2849 if (**pp == 'g')
2850 pflags->subGlobal = true;
2851 else if (**pp == '1')
2852 pflags->subOnce = true;
2853 else if (**pp == 'W')
2854 *oneBigWord = true;
2855 else
2856 break;
2857 }
2858 }
2859
2860 MAKE_INLINE PatternFlags
2861 PatternFlags_None(void)
2862 {
2863 PatternFlags pflags = { false, false, false, false };
2864 return pflags;
2865 }
2866
2867 /* :S,from,to, */
2868 static ApplyModifierResult
2869 ApplyModifier_Subst(const char **pp, ModChain *ch)
2870 {
2871 struct ModifyWord_SubstArgs args;
2872 bool oneBigWord;
2873 VarParseResult res;
2874 LazyBuf lhsBuf, rhsBuf;
2875
2876 char delim = (*pp)[1];
2877 if (delim == '\0') {
2878 Error("Missing delimiter for modifier ':S'");
2879 (*pp)++;
2880 return AMR_CLEANUP;
2881 }
2882
2883 *pp += 2;
2884
2885 args.pflags = PatternFlags_None();
2886 args.matched = false;
2887
2888 if (**pp == '^') {
2889 args.pflags.anchorStart = true;
2890 (*pp)++;
2891 }
2892
2893 res = ParseModifierPartSubst(pp, delim, ch->expr->emode, ch, &lhsBuf,
2894 &args.pflags, NULL);
2895 if (res != VPR_OK)
2896 return AMR_CLEANUP;
2897 args.lhs = LazyBuf_Get(&lhsBuf);
2898
2899 res = ParseModifierPartSubst(pp, delim, ch->expr->emode, ch, &rhsBuf,
2900 NULL, &args);
2901 if (res != VPR_OK) {
2902 LazyBuf_Done(&lhsBuf);
2903 return AMR_CLEANUP;
2904 }
2905 args.rhs = LazyBuf_Get(&rhsBuf);
2906
2907 oneBigWord = ch->oneBigWord;
2908 ParsePatternFlags(pp, &args.pflags, &oneBigWord);
2909
2910 ModifyWords(ch, ModifyWord_Subst, &args, oneBigWord);
2911
2912 LazyBuf_Done(&lhsBuf);
2913 LazyBuf_Done(&rhsBuf);
2914 return AMR_OK;
2915 }
2916
2917 #ifndef NO_REGEX
2918
2919 /* :C,from,to, */
2920 static ApplyModifierResult
2921 ApplyModifier_Regex(const char **pp, ModChain *ch)
2922 {
2923 struct ModifyWord_SubstRegexArgs args;
2924 bool oneBigWord;
2925 int error;
2926 VarParseResult res;
2927 LazyBuf reBuf, replaceBuf;
2928 FStr re, replace;
2929
2930 char delim = (*pp)[1];
2931 if (delim == '\0') {
2932 Error("Missing delimiter for :C modifier");
2933 (*pp)++;
2934 return AMR_CLEANUP;
2935 }
2936
2937 *pp += 2;
2938
2939 res = ParseModifierPart(pp, delim, ch->expr->emode, ch, &reBuf);
2940 if (res != VPR_OK)
2941 return AMR_CLEANUP;
2942 re = LazyBuf_DoneGet(&reBuf);
2943
2944 res = ParseModifierPart(pp, delim, ch->expr->emode, ch, &replaceBuf);
2945 if (res != VPR_OK) {
2946 FStr_Done(&re);
2947 return AMR_CLEANUP;
2948 }
2949 replace = LazyBuf_DoneGet(&replaceBuf);
2950 args.replace = replace.str;
2951
2952 args.pflags = PatternFlags_None();
2953 args.matched = false;
2954 oneBigWord = ch->oneBigWord;
2955 ParsePatternFlags(pp, &args.pflags, &oneBigWord);
2956
2957 if (!ModChain_ShouldEval(ch)) {
2958 FStr_Done(&replace);
2959 FStr_Done(&re);
2960 return AMR_OK;
2961 }
2962
2963 error = regcomp(&args.re, re.str, REG_EXTENDED);
2964 if (error != 0) {
2965 VarREError(error, &args.re, "Regex compilation error");
2966 FStr_Done(&replace);
2967 FStr_Done(&re);
2968 return AMR_CLEANUP;
2969 }
2970
2971 args.nsub = args.re.re_nsub + 1;
2972 if (args.nsub > 10)
2973 args.nsub = 10;
2974
2975 ModifyWords(ch, ModifyWord_SubstRegex, &args, oneBigWord);
2976
2977 regfree(&args.re);
2978 FStr_Done(&replace);
2979 FStr_Done(&re);
2980 return AMR_OK;
2981 }
2982
2983 #endif
2984
2985 /* :Q, :q */
2986 static ApplyModifierResult
2987 ApplyModifier_Quote(const char **pp, ModChain *ch)
2988 {
2989 LazyBuf buf;
2990 bool quoteDollar;
2991
2992 quoteDollar = **pp == 'q';
2993 if (!IsDelimiter((*pp)[1], ch))
2994 return AMR_UNKNOWN;
2995 (*pp)++;
2996
2997 if (!ModChain_ShouldEval(ch))
2998 return AMR_OK;
2999
3000 VarQuote(ch->expr->value.str, quoteDollar, &buf);
3001 if (buf.data != NULL)
3002 Expr_SetValue(ch->expr, LazyBuf_DoneGet(&buf));
3003 else
3004 LazyBuf_Done(&buf);
3005
3006 return AMR_OK;
3007 }
3008
3009 /*ARGSUSED*/
3010 static void
3011 ModifyWord_Copy(Substring word, SepBuf *buf, void *data MAKE_ATTR_UNUSED)
3012 {
3013 SepBuf_AddSubstring(buf, word);
3014 }
3015
3016 /* :ts<separator> */
3017 static ApplyModifierResult
3018 ApplyModifier_ToSep(const char **pp, ModChain *ch)
3019 {
3020 const char *sep = *pp + 2;
3021
3022 /*
3023 * Even in parse-only mode, proceed as normal since there is
3024 * neither any observable side effect nor a performance penalty.
3025 * Checking for wantRes for every single piece of code in here
3026 * would make the code in this function too hard to read.
3027 */
3028
3029 /* ":ts<any><endc>" or ":ts<any>:" */
3030 if (sep[0] != ch->endc && IsDelimiter(sep[1], ch)) {
3031 *pp = sep + 1;
3032 ch->sep = sep[0];
3033 goto ok;
3034 }
3035
3036 /* ":ts<endc>" or ":ts:" */
3037 if (IsDelimiter(sep[0], ch)) {
3038 *pp = sep;
3039 ch->sep = '\0'; /* no separator */
3040 goto ok;
3041 }
3042
3043 /* ":ts<unrecognised><unrecognised>". */
3044 if (sep[0] != '\\') {
3045 (*pp)++; /* just for backwards compatibility */
3046 return AMR_BAD;
3047 }
3048
3049 /* ":ts\n" */
3050 if (sep[1] == 'n') {
3051 *pp = sep + 2;
3052 ch->sep = '\n';
3053 goto ok;
3054 }
3055
3056 /* ":ts\t" */
3057 if (sep[1] == 't') {
3058 *pp = sep + 2;
3059 ch->sep = '\t';
3060 goto ok;
3061 }
3062
3063 /* ":ts\x40" or ":ts\100" */
3064 {
3065 const char *p = sep + 1;
3066 int base = 8; /* assume octal */
3067
3068 if (sep[1] == 'x') {
3069 base = 16;
3070 p++;
3071 } else if (!ch_isdigit(sep[1])) {
3072 (*pp)++; /* just for backwards compatibility */
3073 return AMR_BAD; /* ":ts<backslash><unrecognised>". */
3074 }
3075
3076 if (!TryParseChar(&p, base, &ch->sep)) {
3077 Parse_Error(PARSE_FATAL,
3078 "Invalid character number: %s", p);
3079 return AMR_CLEANUP;
3080 }
3081 if (!IsDelimiter(*p, ch)) {
3082 (*pp)++; /* just for backwards compatibility */
3083 return AMR_BAD;
3084 }
3085
3086 *pp = p;
3087 }
3088
3089 ok:
3090 ModifyWords(ch, ModifyWord_Copy, NULL, ch->oneBigWord);
3091 return AMR_OK;
3092 }
3093
3094 static char *
3095 str_toupper(const char *str)
3096 {
3097 char *res;
3098 size_t i, len;
3099
3100 len = strlen(str);
3101 res = bmake_malloc(len + 1);
3102 for (i = 0; i < len + 1; i++)
3103 res[i] = ch_toupper(str[i]);
3104
3105 return res;
3106 }
3107
3108 static char *
3109 str_tolower(const char *str)
3110 {
3111 char *res;
3112 size_t i, len;
3113
3114 len = strlen(str);
3115 res = bmake_malloc(len + 1);
3116 for (i = 0; i < len + 1; i++)
3117 res[i] = ch_tolower(str[i]);
3118
3119 return res;
3120 }
3121
3122 /* :tA, :tu, :tl, :ts<separator>, etc. */
3123 static ApplyModifierResult
3124 ApplyModifier_To(const char **pp, ModChain *ch)
3125 {
3126 Expr *expr = ch->expr;
3127 const char *mod = *pp;
3128 assert(mod[0] == 't');
3129
3130 if (IsDelimiter(mod[1], ch) || mod[1] == '\0') {
3131 *pp = mod + 1;
3132 return AMR_BAD; /* Found ":t<endc>" or ":t:". */
3133 }
3134
3135 if (mod[1] == 's')
3136 return ApplyModifier_ToSep(pp, ch);
3137
3138 if (!IsDelimiter(mod[2], ch)) { /* :t<unrecognized> */
3139 *pp = mod + 1;
3140 return AMR_BAD;
3141 }
3142
3143 if (mod[1] == 'A') { /* :tA */
3144 *pp = mod + 2;
3145 ModifyWords(ch, ModifyWord_Realpath, NULL, ch->oneBigWord);
3146 return AMR_OK;
3147 }
3148
3149 if (mod[1] == 'u') { /* :tu */
3150 *pp = mod + 2;
3151 if (ModChain_ShouldEval(ch))
3152 Expr_SetValueOwn(expr, str_toupper(expr->value.str));
3153 return AMR_OK;
3154 }
3155
3156 if (mod[1] == 'l') { /* :tl */
3157 *pp = mod + 2;
3158 if (ModChain_ShouldEval(ch))
3159 Expr_SetValueOwn(expr, str_tolower(expr->value.str));
3160 return AMR_OK;
3161 }
3162
3163 if (mod[1] == 'W' || mod[1] == 'w') { /* :tW, :tw */
3164 *pp = mod + 2;
3165 ch->oneBigWord = mod[1] == 'W';
3166 return AMR_OK;
3167 }
3168
3169 /* Found ":t<unrecognised>:" or ":t<unrecognised><endc>". */
3170 *pp = mod + 1; /* XXX: unnecessary but observable */
3171 return AMR_BAD;
3172 }
3173
3174 /* :[#], :[1], :[-1..1], etc. */
3175 static ApplyModifierResult
3176 ApplyModifier_Words(const char **pp, ModChain *ch)
3177 {
3178 Expr *expr = ch->expr;
3179 const char *estr;
3180 int first, last;
3181 VarParseResult res;
3182 const char *p;
3183 LazyBuf estrBuf;
3184 FStr festr;
3185
3186 (*pp)++; /* skip the '[' */
3187 res = ParseModifierPart(pp, ']', expr->emode, ch, &estrBuf);
3188 if (res != VPR_OK)
3189 return AMR_CLEANUP;
3190 festr = LazyBuf_DoneGet(&estrBuf);
3191 estr = festr.str;
3192
3193 if (!IsDelimiter(**pp, ch))
3194 goto bad_modifier; /* Found junk after ']' */
3195
3196 if (!ModChain_ShouldEval(ch))
3197 goto ok;
3198
3199 if (estr[0] == '\0')
3200 goto bad_modifier; /* Found ":[]". */
3201
3202 if (estr[0] == '#' && estr[1] == '\0') { /* Found ":[#]" */
3203 if (ch->oneBigWord) {
3204 Expr_SetValueRefer(expr, "1");
3205 } else {
3206 Buffer buf;
3207
3208 Words words = Str_Words(expr->value.str, false);
3209 size_t ac = words.len;
3210 Words_Free(words);
3211
3212 /* 3 digits + '\0' is usually enough */
3213 Buf_InitSize(&buf, 4);
3214 Buf_AddInt(&buf, (int)ac);
3215 Expr_SetValueOwn(expr, Buf_DoneData(&buf));
3216 }
3217 goto ok;
3218 }
3219
3220 if (estr[0] == '*' && estr[1] == '\0') { /* Found ":[*]" */
3221 ch->oneBigWord = true;
3222 goto ok;
3223 }
3224
3225 if (estr[0] == '@' && estr[1] == '\0') { /* Found ":[@]" */
3226 ch->oneBigWord = false;
3227 goto ok;
3228 }
3229
3230 /*
3231 * We expect estr to contain a single integer for :[N], or two
3232 * integers separated by ".." for :[start..end].
3233 */
3234 p = estr;
3235 if (!TryParseIntBase0(&p, &first))
3236 goto bad_modifier; /* Found junk instead of a number */
3237
3238 if (p[0] == '\0') { /* Found only one integer in :[N] */
3239 last = first;
3240 } else if (p[0] == '.' && p[1] == '.' && p[2] != '\0') {
3241 /* Expecting another integer after ".." */
3242 p += 2;
3243 if (!TryParseIntBase0(&p, &last) || *p != '\0')
3244 goto bad_modifier; /* Found junk after ".." */
3245 } else
3246 goto bad_modifier; /* Found junk instead of ".." */
3247
3248 /*
3249 * Now first and last are properly filled in, but we still have to
3250 * check for 0 as a special case.
3251 */
3252 if (first == 0 && last == 0) {
3253 /* ":[0]" or perhaps ":[0..0]" */
3254 ch->oneBigWord = true;
3255 goto ok;
3256 }
3257
3258 /* ":[0..N]" or ":[N..0]" */
3259 if (first == 0 || last == 0)
3260 goto bad_modifier;
3261
3262 /* Normal case: select the words described by first and last. */
3263 Expr_SetValueOwn(expr,
3264 VarSelectWords(expr->value.str, first, last,
3265 ch->sep, ch->oneBigWord));
3266
3267 ok:
3268 FStr_Done(&festr);
3269 return AMR_OK;
3270
3271 bad_modifier:
3272 FStr_Done(&festr);
3273 return AMR_BAD;
3274 }
3275
3276 static int
3277 str_cmp_asc(const void *a, const void *b)
3278 {
3279 return strcmp(*(const char *const *)a, *(const char *const *)b);
3280 }
3281
3282 static int
3283 str_cmp_desc(const void *a, const void *b)
3284 {
3285 return strcmp(*(const char *const *)b, *(const char *const *)a);
3286 }
3287
3288 static void
3289 ShuffleStrings(char **strs, size_t n)
3290 {
3291 size_t i;
3292
3293 for (i = n - 1; i > 0; i--) {
3294 size_t rndidx = (size_t)random() % (i + 1);
3295 char *t = strs[i];
3296 strs[i] = strs[rndidx];
3297 strs[rndidx] = t;
3298 }
3299 }
3300
3301 /* :O (order ascending) or :Or (order descending) or :Ox (shuffle) */
3302 static ApplyModifierResult
3303 ApplyModifier_Order(const char **pp, ModChain *ch)
3304 {
3305 const char *mod = (*pp)++; /* skip past the 'O' in any case */
3306 Words words;
3307 enum SortMode {
3308 ASC, DESC, SHUFFLE
3309 } mode;
3310
3311 if (IsDelimiter(mod[1], ch)) {
3312 mode = ASC;
3313 } else if ((mod[1] == 'r' || mod[1] == 'x') &&
3314 IsDelimiter(mod[2], ch)) {
3315 (*pp)++;
3316 mode = mod[1] == 'r' ? DESC : SHUFFLE;
3317 } else
3318 return AMR_BAD;
3319
3320 if (!ModChain_ShouldEval(ch))
3321 return AMR_OK;
3322
3323 words = Str_Words(ch->expr->value.str, false);
3324 if (mode == SHUFFLE)
3325 ShuffleStrings(words.words, words.len);
3326 else
3327 qsort(words.words, words.len, sizeof words.words[0],
3328 mode == ASC ? str_cmp_asc : str_cmp_desc);
3329 Expr_SetValueOwn(ch->expr, Words_JoinFree(words));
3330
3331 return AMR_OK;
3332 }
3333
3334 /* :? then : else */
3335 static ApplyModifierResult
3336 ApplyModifier_IfElse(const char **pp, ModChain *ch)
3337 {
3338 Expr *expr = ch->expr;
3339 VarParseResult res;
3340 LazyBuf buf;
3341 FStr then_expr, else_expr;
3342
3343 bool value = false;
3344 VarEvalMode then_emode = VARE_PARSE_ONLY;
3345 VarEvalMode else_emode = VARE_PARSE_ONLY;
3346
3347 int cond_rc = COND_PARSE; /* anything other than COND_INVALID */
3348 if (Expr_ShouldEval(expr)) {
3349 cond_rc = Cond_EvalCondition(expr->name, &value);
3350 if (cond_rc != COND_INVALID && value)
3351 then_emode = expr->emode;
3352 if (cond_rc != COND_INVALID && !value)
3353 else_emode = expr->emode;
3354 }
3355
3356 (*pp)++; /* skip past the '?' */
3357 res = ParseModifierPart(pp, ':', then_emode, ch, &buf);
3358 if (res != VPR_OK)
3359 return AMR_CLEANUP;
3360 then_expr = LazyBuf_DoneGet(&buf);
3361
3362 res = ParseModifierPart(pp, ch->endc, else_emode, ch, &buf);
3363 if (res != VPR_OK) {
3364 FStr_Done(&then_expr);
3365 return AMR_CLEANUP;
3366 }
3367 else_expr = LazyBuf_DoneGet(&buf);
3368
3369 (*pp)--; /* Go back to the ch->endc. */
3370
3371 if (cond_rc == COND_INVALID) {
3372 Error("Bad conditional expression '%s' in '%s?%s:%s'",
3373 expr->name, expr->name, then_expr.str, else_expr.str);
3374 return AMR_CLEANUP;
3375 }
3376
3377 if (!ModChain_ShouldEval(ch)) {
3378 FStr_Done(&then_expr);
3379 FStr_Done(&else_expr);
3380 } else if (value) {
3381 Expr_SetValue(expr, then_expr);
3382 FStr_Done(&else_expr);
3383 } else {
3384 FStr_Done(&then_expr);
3385 Expr_SetValue(expr, else_expr);
3386 }
3387 Expr_Define(expr);
3388 return AMR_OK;
3389 }
3390
3391 /*
3392 * The ::= modifiers are special in that they do not read the variable value
3393 * but instead assign to that variable. They always expand to an empty
3394 * string.
3395 *
3396 * Their main purpose is in supporting .for loops that generate shell commands
3397 * since an ordinary variable assignment at that point would terminate the
3398 * dependency group for these targets. For example:
3399 *
3400 * list-targets: .USE
3401 * .for i in ${.TARGET} ${.TARGET:R}.gz
3402 * @${t::=$i}
3403 * @echo 'The target is ${t:T}.'
3404 * .endfor
3405 *
3406 * ::=<str> Assigns <str> as the new value of variable.
3407 * ::?=<str> Assigns <str> as value of variable if
3408 * it was not already set.
3409 * ::+=<str> Appends <str> to variable.
3410 * ::!=<cmd> Assigns output of <cmd> as the new value of
3411 * variable.
3412 */
3413 static ApplyModifierResult
3414 ApplyModifier_Assign(const char **pp, ModChain *ch)
3415 {
3416 Expr *expr = ch->expr;
3417 GNode *scope;
3418 FStr val;
3419 VarParseResult res;
3420 LazyBuf buf;
3421
3422 const char *mod = *pp;
3423 const char *op = mod + 1;
3424
3425 if (op[0] == '=')
3426 goto ok;
3427 if ((op[0] == '!' || op[0] == '+' || op[0] == '?') && op[1] == '=')
3428 goto ok;
3429 return AMR_UNKNOWN; /* "::<unrecognised>" */
3430
3431 ok:
3432 if (expr->name[0] == '\0') {
3433 *pp = mod + 1;
3434 return AMR_BAD;
3435 }
3436
3437 switch (op[0]) {
3438 case '+':
3439 case '?':
3440 case '!':
3441 *pp = mod + 3;
3442 break;
3443 default:
3444 *pp = mod + 2;
3445 break;
3446 }
3447
3448 res = ParseModifierPart(pp, ch->endc, expr->emode, ch, &buf);
3449 if (res != VPR_OK)
3450 return AMR_CLEANUP;
3451 val = LazyBuf_DoneGet(&buf);
3452
3453 (*pp)--; /* Go back to the ch->endc. */
3454
3455 if (!Expr_ShouldEval(expr))
3456 goto done;
3457
3458 scope = expr->scope; /* scope where v belongs */
3459 if (expr->defined == DEF_REGULAR && expr->scope != SCOPE_GLOBAL) {
3460 Var *gv = VarFind(expr->name, expr->scope, false);
3461 if (gv == NULL)
3462 scope = SCOPE_GLOBAL;
3463 else
3464 VarFreeEnv(gv);
3465 }
3466
3467 switch (op[0]) {
3468 case '+':
3469 Var_Append(scope, expr->name, val.str);
3470 break;
3471 case '!': {
3472 const char *errfmt;
3473 char *cmd_output = Cmd_Exec(val.str, &errfmt);
3474 if (errfmt != NULL)
3475 Error(errfmt, val.str);
3476 else
3477 Var_Set(scope, expr->name, cmd_output);
3478 free(cmd_output);
3479 break;
3480 }
3481 case '?':
3482 if (expr->defined == DEF_REGULAR)
3483 break;
3484 /* FALLTHROUGH */
3485 default:
3486 Var_Set(scope, expr->name, val.str);
3487 break;
3488 }
3489 Expr_SetValueRefer(expr, "");
3490
3491 done:
3492 FStr_Done(&val);
3493 return AMR_OK;
3494 }
3495
3496 /*
3497 * :_=...
3498 * remember current value
3499 */
3500 static ApplyModifierResult
3501 ApplyModifier_Remember(const char **pp, ModChain *ch)
3502 {
3503 Expr *expr = ch->expr;
3504 const char *mod = *pp;
3505 FStr name;
3506
3507 if (!ModMatchEq(mod, "_", ch))
3508 return AMR_UNKNOWN;
3509
3510 name = FStr_InitRefer("_");
3511 if (mod[1] == '=') {
3512 /*
3513 * XXX: This ad-hoc call to strcspn deviates from the usual
3514 * behavior defined in ParseModifierPart. This creates an
3515 * unnecessary, undocumented inconsistency in make.
3516 */
3517 const char *arg = mod + 2;
3518 size_t argLen = strcspn(arg, ":)}");
3519 *pp = arg + argLen;
3520 name = FStr_InitOwn(bmake_strldup(arg, argLen));
3521 } else
3522 *pp = mod + 1;
3523
3524 if (Expr_ShouldEval(expr))
3525 Var_Set(expr->scope, name.str, expr->value.str);
3526 FStr_Done(&name);
3527
3528 return AMR_OK;
3529 }
3530
3531 /*
3532 * Apply the given function to each word of the variable value,
3533 * for a single-letter modifier such as :H, :T.
3534 */
3535 static ApplyModifierResult
3536 ApplyModifier_WordFunc(const char **pp, ModChain *ch,
3537 ModifyWordProc modifyWord)
3538 {
3539 if (!IsDelimiter((*pp)[1], ch))
3540 return AMR_UNKNOWN;
3541 (*pp)++;
3542
3543 if (ModChain_ShouldEval(ch))
3544 ModifyWords(ch, modifyWord, NULL, ch->oneBigWord);
3545
3546 return AMR_OK;
3547 }
3548
3549 /* Remove adjacent duplicate words. */
3550 static ApplyModifierResult
3551 ApplyModifier_Unique(const char **pp, ModChain *ch)
3552 {
3553 Words words;
3554
3555 if (!IsDelimiter((*pp)[1], ch))
3556 return AMR_UNKNOWN;
3557 (*pp)++;
3558
3559 if (!ModChain_ShouldEval(ch))
3560 return AMR_OK;
3561
3562 words = Str_Words(ch->expr->value.str, false);
3563
3564 if (words.len > 1) {
3565 size_t si, di;
3566
3567 di = 0;
3568 for (si = 1; si < words.len; si++) {
3569 if (strcmp(words.words[si], words.words[di]) != 0) {
3570 di++;
3571 if (di != si)
3572 words.words[di] = words.words[si];
3573 }
3574 }
3575 words.len = di + 1;
3576 }
3577
3578 Expr_SetValueOwn(ch->expr, Words_JoinFree(words));
3579
3580 return AMR_OK;
3581 }
3582
3583 #ifdef SYSVVARSUB
3584 /* :from=to */
3585 static ApplyModifierResult
3586 ApplyModifier_SysV(const char **pp, ModChain *ch)
3587 {
3588 Expr *expr = ch->expr;
3589 VarParseResult res;
3590 LazyBuf lhsBuf, rhsBuf;
3591 FStr rhs;
3592 struct ModifyWord_SysVSubstArgs args;
3593 Substring lhs;
3594 const char *lhsSuffix;
3595
3596 const char *mod = *pp;
3597 bool eqFound = false;
3598
3599 /*
3600 * First we make a pass through the string trying to verify it is a
3601 * SysV-make-style translation. It must be: <lhs>=<rhs>
3602 */
3603 int depth = 1;
3604 const char *p = mod;
3605 while (*p != '\0' && depth > 0) {
3606 if (*p == '=') { /* XXX: should also test depth == 1 */
3607 eqFound = true;
3608 /* continue looking for ch->endc */
3609 } else if (*p == ch->endc)
3610 depth--;
3611 else if (*p == ch->startc)
3612 depth++;
3613 if (depth > 0)
3614 p++;
3615 }
3616 if (*p != ch->endc || !eqFound)
3617 return AMR_UNKNOWN;
3618
3619 res = ParseModifierPart(pp, '=', expr->emode, ch, &lhsBuf);
3620 if (res != VPR_OK)
3621 return AMR_CLEANUP;
3622
3623 /* The SysV modifier lasts until the end of the variable expression. */
3624 res = ParseModifierPart(pp, ch->endc, expr->emode, ch, &rhsBuf);
3625 if (res != VPR_OK) {
3626 LazyBuf_Done(&lhsBuf);
3627 return AMR_CLEANUP;
3628 }
3629 rhs = LazyBuf_DoneGet(&rhsBuf);
3630
3631 (*pp)--; /* Go back to the ch->endc. */
3632
3633 /* Do not turn an empty expression into non-empty. */
3634 if (lhsBuf.len == 0 && expr->value.str[0] == '\0')
3635 goto done;
3636
3637 lhs = LazyBuf_Get(&lhsBuf);
3638 lhsSuffix = Substring_SkipFirst(lhs, '%');
3639
3640 args.scope = expr->scope;
3641 args.lhsPrefix = Substring_Init(lhs.start,
3642 lhsSuffix != lhs.start ? lhsSuffix - 1 : lhs.start);
3643 args.lhsPercent = lhsSuffix != lhs.start;
3644 args.lhsSuffix = Substring_Init(lhsSuffix, lhs.end);
3645 args.rhs = rhs.str;
3646
3647 ModifyWords(ch, ModifyWord_SysVSubst, &args, ch->oneBigWord);
3648
3649 done:
3650 LazyBuf_Done(&lhsBuf);
3651 return AMR_OK;
3652 }
3653 #endif
3654
3655 #ifdef SUNSHCMD
3656 /* :sh */
3657 static ApplyModifierResult
3658 ApplyModifier_SunShell(const char **pp, ModChain *ch)
3659 {
3660 Expr *expr = ch->expr;
3661 const char *p = *pp;
3662 if (!(p[1] == 'h' && IsDelimiter(p[2], ch)))
3663 return AMR_UNKNOWN;
3664 *pp = p + 2;
3665
3666 if (Expr_ShouldEval(expr)) {
3667 const char *errfmt;
3668 char *output = Cmd_Exec(expr->value.str, &errfmt);
3669 if (errfmt != NULL)
3670 Error(errfmt, expr->value.str);
3671 Expr_SetValueOwn(expr, output);
3672 }
3673
3674 return AMR_OK;
3675 }
3676 #endif
3677
3678 static void
3679 LogBeforeApply(const ModChain *ch, const char *mod)
3680 {
3681 const Expr *expr = ch->expr;
3682 bool is_single_char = mod[0] != '\0' && IsDelimiter(mod[1], ch);
3683
3684 /*
3685 * At this point, only the first character of the modifier can
3686 * be used since the end of the modifier is not yet known.
3687 */
3688
3689 if (!Expr_ShouldEval(expr)) {
3690 debug_printf("Parsing modifier ${%s:%c%s}\n",
3691 expr->name, mod[0], is_single_char ? "" : "...");
3692 return;
3693 }
3694
3695 if ((expr->emode == VARE_WANTRES || expr->emode == VARE_UNDEFERR) &&
3696 expr->defined == DEF_REGULAR) {
3697 debug_printf(
3698 "Evaluating modifier ${%s:%c%s} on value \"%s\"\n",
3699 expr->name, mod[0], is_single_char ? "" : "...",
3700 expr->value.str);
3701 return;
3702 }
3703
3704 debug_printf(
3705 "Evaluating modifier ${%s:%c%s} on value \"%s\" (%s, %s)\n",
3706 expr->name, mod[0], is_single_char ? "" : "...", expr->value.str,
3707 VarEvalMode_Name[expr->emode], ExprDefined_Name[expr->defined]);
3708 }
3709
3710 static void
3711 LogAfterApply(const ModChain *ch, const char *p, const char *mod)
3712 {
3713 const Expr *expr = ch->expr;
3714 const char *value = expr->value.str;
3715 const char *quot = value == var_Error ? "" : "\"";
3716
3717 if ((expr->emode == VARE_WANTRES || expr->emode == VARE_UNDEFERR) &&
3718 expr->defined == DEF_REGULAR) {
3719
3720 debug_printf("Result of ${%s:%.*s} is %s%s%s\n",
3721 expr->name, (int)(p - mod), mod,
3722 quot, value == var_Error ? "error" : value, quot);
3723 return;
3724 }
3725
3726 debug_printf("Result of ${%s:%.*s} is %s%s%s (%s, %s)\n",
3727 expr->name, (int)(p - mod), mod,
3728 quot, value == var_Error ? "error" : value, quot,
3729 VarEvalMode_Name[expr->emode],
3730 ExprDefined_Name[expr->defined]);
3731 }
3732
3733 static ApplyModifierResult
3734 ApplyModifier(const char **pp, ModChain *ch)
3735 {
3736 switch (**pp) {
3737 case '!':
3738 return ApplyModifier_ShellCommand(pp, ch);
3739 case ':':
3740 return ApplyModifier_Assign(pp, ch);
3741 case '?':
3742 return ApplyModifier_IfElse(pp, ch);
3743 case '@':
3744 return ApplyModifier_Loop(pp, ch);
3745 case '[':
3746 return ApplyModifier_Words(pp, ch);
3747 case '_':
3748 return ApplyModifier_Remember(pp, ch);
3749 #ifndef NO_REGEX
3750 case 'C':
3751 return ApplyModifier_Regex(pp, ch);
3752 #endif
3753 case 'D':
3754 return ApplyModifier_Defined(pp, ch);
3755 case 'E':
3756 return ApplyModifier_WordFunc(pp, ch, ModifyWord_Suffix);
3757 case 'g':
3758 return ApplyModifier_Gmtime(pp, ch);
3759 case 'H':
3760 return ApplyModifier_WordFunc(pp, ch, ModifyWord_Head);
3761 case 'h':
3762 return ApplyModifier_Hash(pp, ch);
3763 case 'L':
3764 return ApplyModifier_Literal(pp, ch);
3765 case 'l':
3766 return ApplyModifier_Localtime(pp, ch);
3767 case 'M':
3768 case 'N':
3769 return ApplyModifier_Match(pp, ch);
3770 case 'O':
3771 return ApplyModifier_Order(pp, ch);
3772 case 'P':
3773 return ApplyModifier_Path(pp, ch);
3774 case 'Q':
3775 case 'q':
3776 return ApplyModifier_Quote(pp, ch);
3777 case 'R':
3778 return ApplyModifier_WordFunc(pp, ch, ModifyWord_Root);
3779 case 'r':
3780 return ApplyModifier_Range(pp, ch);
3781 case 'S':
3782 return ApplyModifier_Subst(pp, ch);
3783 #ifdef SUNSHCMD
3784 case 's':
3785 return ApplyModifier_SunShell(pp, ch);
3786 #endif
3787 case 'T':
3788 return ApplyModifier_WordFunc(pp, ch, ModifyWord_Tail);
3789 case 't':
3790 return ApplyModifier_To(pp, ch);
3791 case 'U':
3792 return ApplyModifier_Defined(pp, ch);
3793 case 'u':
3794 return ApplyModifier_Unique(pp, ch);
3795 default:
3796 return AMR_UNKNOWN;
3797 }
3798 }
3799
3800 static void ApplyModifiers(Expr *, const char **, char, char);
3801
3802 typedef enum ApplyModifiersIndirectResult {
3803 /* The indirect modifiers have been applied successfully. */
3804 AMIR_CONTINUE,
3805 /* Fall back to the SysV modifier. */
3806 AMIR_SYSV,
3807 /* Error out. */
3808 AMIR_OUT
3809 } ApplyModifiersIndirectResult;
3810
3811 /*
3812 * While expanding a variable expression, expand and apply indirect modifiers,
3813 * such as in ${VAR:${M_indirect}}.
3814 *
3815 * All indirect modifiers of a group must come from a single variable
3816 * expression. ${VAR:${M1}} is valid but ${VAR:${M1}${M2}} is not.
3817 *
3818 * Multiple groups of indirect modifiers can be chained by separating them
3819 * with colons. ${VAR:${M1}:${M2}} contains 2 indirect modifiers.
3820 *
3821 * If the variable expression is not followed by ch->endc or ':', fall
3822 * back to trying the SysV modifier, such as in ${VAR:${FROM}=${TO}}.
3823 */
3824 static ApplyModifiersIndirectResult
3825 ApplyModifiersIndirect(ModChain *ch, const char **pp)
3826 {
3827 Expr *expr = ch->expr;
3828 const char *p = *pp;
3829 FStr mods;
3830
3831 (void)Var_Parse(&p, expr->scope, expr->emode, &mods);
3832 /* TODO: handle errors */
3833
3834 if (mods.str[0] != '\0' && *p != '\0' && !IsDelimiter(*p, ch)) {
3835 FStr_Done(&mods);
3836 return AMIR_SYSV;
3837 }
3838
3839 DEBUG3(VAR, "Indirect modifier \"%s\" from \"%.*s\"\n",
3840 mods.str, (int)(p - *pp), *pp);
3841
3842 if (mods.str[0] != '\0') {
3843 const char *modsp = mods.str;
3844 ApplyModifiers(expr, &modsp, '\0', '\0');
3845 if (expr->value.str == var_Error || *modsp != '\0') {
3846 FStr_Done(&mods);
3847 *pp = p;
3848 return AMIR_OUT; /* error already reported */
3849 }
3850 }
3851 FStr_Done(&mods);
3852
3853 if (*p == ':')
3854 p++;
3855 else if (*p == '\0' && ch->endc != '\0') {
3856 Error("Unclosed variable expression after indirect "
3857 "modifier, expecting '%c' for variable \"%s\"",
3858 ch->endc, expr->name);
3859 *pp = p;
3860 return AMIR_OUT;
3861 }
3862
3863 *pp = p;
3864 return AMIR_CONTINUE;
3865 }
3866
3867 static ApplyModifierResult
3868 ApplySingleModifier(const char **pp, ModChain *ch)
3869 {
3870 ApplyModifierResult res;
3871 const char *mod = *pp;
3872 const char *p = *pp;
3873
3874 if (DEBUG(VAR))
3875 LogBeforeApply(ch, mod);
3876
3877 res = ApplyModifier(&p, ch);
3878
3879 #ifdef SYSVVARSUB
3880 if (res == AMR_UNKNOWN) {
3881 assert(p == mod);
3882 res = ApplyModifier_SysV(&p, ch);
3883 }
3884 #endif
3885
3886 if (res == AMR_UNKNOWN) {
3887 /*
3888 * Guess the end of the current modifier.
3889 * XXX: Skipping the rest of the modifier hides
3890 * errors and leads to wrong results.
3891 * Parsing should rather stop here.
3892 */
3893 for (p++; !IsDelimiter(*p, ch) && *p != '\0'; p++)
3894 continue;
3895 Parse_Error(PARSE_FATAL, "Unknown modifier \"%.*s\"",
3896 (int)(p - mod), mod);
3897 Expr_SetValueRefer(ch->expr, var_Error);
3898 }
3899 if (res == AMR_CLEANUP || res == AMR_BAD) {
3900 *pp = p;
3901 return res;
3902 }
3903
3904 if (DEBUG(VAR))
3905 LogAfterApply(ch, p, mod);
3906
3907 if (*p == '\0' && ch->endc != '\0') {
3908 Error(
3909 "Unclosed variable expression, expecting '%c' for "
3910 "modifier \"%.*s\" of variable \"%s\" with value \"%s\"",
3911 ch->endc,
3912 (int)(p - mod), mod,
3913 ch->expr->name, ch->expr->value.str);
3914 } else if (*p == ':') {
3915 p++;
3916 } else if (opts.strict && *p != '\0' && *p != ch->endc) {
3917 Parse_Error(PARSE_FATAL,
3918 "Missing delimiter ':' after modifier \"%.*s\"",
3919 (int)(p - mod), mod);
3920 /*
3921 * TODO: propagate parse error to the enclosing
3922 * expression
3923 */
3924 }
3925 *pp = p;
3926 return AMR_OK;
3927 }
3928
3929 #if __STDC_VERSION__ >= 199901L
3930 #define ModChain_Literal(expr, startc, endc, sep, oneBigWord) \
3931 (ModChain) { expr, startc, endc, sep, oneBigWord }
3932 #else
3933 MAKE_INLINE ModChain
3934 ModChain_Literal(Expr *expr, char startc, char endc, char sep, bool oneBigWord)
3935 {
3936 ModChain ch;
3937 ch.expr = expr;
3938 ch.startc = startc;
3939 ch.endc = endc;
3940 ch.sep = sep;
3941 ch.oneBigWord = oneBigWord;
3942 return ch;
3943 }
3944 #endif
3945
3946 /* Apply any modifiers (such as :Mpattern or :@var@loop@ or :Q or ::=value). */
3947 static void
3948 ApplyModifiers(
3949 Expr *expr,
3950 const char **pp, /* the parsing position, updated upon return */
3951 char startc, /* '(' or '{'; or '\0' for indirect modifiers */
3952 char endc /* ')' or '}'; or '\0' for indirect modifiers */
3953 )
3954 {
3955 ModChain ch = ModChain_Literal(expr, startc, endc, ' ', false);
3956 const char *p;
3957 const char *mod;
3958
3959 assert(startc == '(' || startc == '{' || startc == '\0');
3960 assert(endc == ')' || endc == '}' || endc == '\0');
3961 assert(expr->value.str != NULL);
3962
3963 p = *pp;
3964
3965 if (*p == '\0' && endc != '\0') {
3966 Error(
3967 "Unclosed variable expression (expecting '%c') for \"%s\"",
3968 ch.endc, expr->name);
3969 goto cleanup;
3970 }
3971
3972 while (*p != '\0' && *p != endc) {
3973 ApplyModifierResult res;
3974
3975 if (*p == '$') {
3976 ApplyModifiersIndirectResult amir =
3977 ApplyModifiersIndirect(&ch, &p);
3978 if (amir == AMIR_CONTINUE)
3979 continue;
3980 if (amir == AMIR_OUT)
3981 break;
3982 /*
3983 * It's neither '${VAR}:' nor '${VAR}}'. Try to parse
3984 * it as a SysV modifier, as that is the only modifier
3985 * that can start with '$'.
3986 */
3987 }
3988
3989 mod = p;
3990
3991 res = ApplySingleModifier(&p, &ch);
3992 if (res == AMR_CLEANUP)
3993 goto cleanup;
3994 if (res == AMR_BAD)
3995 goto bad_modifier;
3996 }
3997
3998 *pp = p;
3999 assert(expr->value.str != NULL); /* Use var_Error or varUndefined. */
4000 return;
4001
4002 bad_modifier:
4003 /* XXX: The modifier end is only guessed. */
4004 Error("Bad modifier \":%.*s\" for variable \"%s\"",
4005 (int)strcspn(mod, ":)}"), mod, expr->name);
4006
4007 cleanup:
4008 /*
4009 * TODO: Use p + strlen(p) instead, to stop parsing immediately.
4010 *
4011 * In the unit tests, this generates a few unterminated strings in the
4012 * shell commands though. Instead of producing these unfinished
4013 * strings, commands with evaluation errors should not be run at all.
4014 *
4015 * To make that happen, Var_Subst must report the actual errors
4016 * instead of returning VPR_OK unconditionally.
4017 */
4018 *pp = p;
4019 Expr_SetValueRefer(expr, var_Error);
4020 }
4021
4022 /*
4023 * Only 4 of the 7 local variables are treated specially as they are the only
4024 * ones that will be set when dynamic sources are expanded.
4025 */
4026 static bool
4027 VarnameIsDynamic(Substring varname)
4028 {
4029 const char *name;
4030 size_t len;
4031
4032 name = varname.start;
4033 len = Substring_Length(varname);
4034 if (len == 1 || (len == 2 && (name[1] == 'F' || name[1] == 'D'))) {
4035 switch (name[0]) {
4036 case '@':
4037 case '%':
4038 case '*':
4039 case '!':
4040 return true;
4041 }
4042 return false;
4043 }
4044
4045 if ((len == 7 || len == 8) && name[0] == '.' && ch_isupper(name[1])) {
4046 return Substring_Equals(varname, ".TARGET") ||
4047 Substring_Equals(varname, ".ARCHIVE") ||
4048 Substring_Equals(varname, ".PREFIX") ||
4049 Substring_Equals(varname, ".MEMBER");
4050 }
4051
4052 return false;
4053 }
4054
4055 static const char *
4056 UndefinedShortVarValue(char varname, const GNode *scope)
4057 {
4058 if (scope == SCOPE_CMDLINE || scope == SCOPE_GLOBAL) {
4059 /*
4060 * If substituting a local variable in a non-local scope,
4061 * assume it's for dynamic source stuff. We have to handle
4062 * this specially and return the longhand for the variable
4063 * with the dollar sign escaped so it makes it back to the
4064 * caller. Only four of the local variables are treated
4065 * specially as they are the only four that will be set
4066 * when dynamic sources are expanded.
4067 */
4068 switch (varname) {
4069 case '@':
4070 return "$(.TARGET)";
4071 case '%':
4072 return "$(.MEMBER)";
4073 case '*':
4074 return "$(.PREFIX)";
4075 case '!':
4076 return "$(.ARCHIVE)";
4077 }
4078 }
4079 return NULL;
4080 }
4081
4082 /*
4083 * Parse a variable name, until the end character or a colon, whichever
4084 * comes first.
4085 */
4086 static void
4087 ParseVarname(const char **pp, char startc, char endc,
4088 GNode *scope, VarEvalMode emode,
4089 LazyBuf *buf)
4090 {
4091 const char *p = *pp;
4092 int depth = 0; /* Track depth so we can spot parse errors. */
4093
4094 LazyBuf_Init(buf, p);
4095
4096 while (*p != '\0') {
4097 if ((*p == endc || *p == ':') && depth == 0)
4098 break;
4099 if (*p == startc)
4100 depth++;
4101 if (*p == endc)
4102 depth--;
4103
4104 /* A variable inside a variable, expand. */
4105 if (*p == '$') {
4106 FStr nested_val;
4107 (void)Var_Parse(&p, scope, emode, &nested_val);
4108 /* TODO: handle errors */
4109 LazyBuf_AddStr(buf, nested_val.str);
4110 FStr_Done(&nested_val);
4111 } else {
4112 LazyBuf_Add(buf, *p);
4113 p++;
4114 }
4115 }
4116 *pp = p;
4117 }
4118
4119 static VarParseResult
4120 ValidShortVarname(char varname, const char *start)
4121 {
4122 if (varname != '$' && varname != ':' && varname != '}' &&
4123 varname != ')' && varname != '\0')
4124 return VPR_OK;
4125
4126 if (!opts.strict)
4127 return VPR_ERR; /* XXX: Missing error message */
4128
4129 if (varname == '$')
4130 Parse_Error(PARSE_FATAL,
4131 "To escape a dollar, use \\$, not $$, at \"%s\"", start);
4132 else if (varname == '\0')
4133 Parse_Error(PARSE_FATAL, "Dollar followed by nothing");
4134 else
4135 Parse_Error(PARSE_FATAL,
4136 "Invalid variable name '%c', at \"%s\"", varname, start);
4137
4138 return VPR_ERR;
4139 }
4140
4141 /*
4142 * Parse a single-character variable name such as in $V or $@.
4143 * Return whether to continue parsing.
4144 */
4145 static bool
4146 ParseVarnameShort(char varname, const char **pp, GNode *scope,
4147 VarEvalMode emode,
4148 VarParseResult *out_false_res, const char **out_false_val,
4149 Var **out_true_var)
4150 {
4151 char name[2];
4152 Var *v;
4153 VarParseResult vpr;
4154
4155 vpr = ValidShortVarname(varname, *pp);
4156 if (vpr != VPR_OK) {
4157 (*pp)++;
4158 *out_false_res = vpr;
4159 *out_false_val = var_Error;
4160 return false;
4161 }
4162
4163 name[0] = varname;
4164 name[1] = '\0';
4165 v = VarFind(name, scope, true);
4166 if (v == NULL) {
4167 const char *val;
4168 *pp += 2;
4169
4170 val = UndefinedShortVarValue(varname, scope);
4171 if (val == NULL)
4172 val = emode == VARE_UNDEFERR
4173 ? var_Error : varUndefined;
4174
4175 if (opts.strict && val == var_Error) {
4176 Parse_Error(PARSE_FATAL,
4177 "Variable \"%s\" is undefined", name);
4178 *out_false_res = VPR_ERR;
4179 *out_false_val = val;
4180 return false;
4181 }
4182
4183 /*
4184 * XXX: This looks completely wrong.
4185 *
4186 * If undefined expressions are not allowed, this should
4187 * rather be VPR_ERR instead of VPR_UNDEF, together with an
4188 * error message.
4189 *
4190 * If undefined expressions are allowed, this should rather
4191 * be VPR_UNDEF instead of VPR_OK.
4192 */
4193 *out_false_res = emode == VARE_UNDEFERR
4194 ? VPR_UNDEF : VPR_OK;
4195 *out_false_val = val;
4196 return false;
4197 }
4198
4199 *out_true_var = v;
4200 return true;
4201 }
4202
4203 /* Find variables like @F or <D. */
4204 static Var *
4205 FindLocalLegacyVar(Substring varname, GNode *scope,
4206 const char **out_extraModifiers)
4207 {
4208 Var *v;
4209
4210 /* Only resolve these variables if scope is a "real" target. */
4211 if (scope == SCOPE_CMDLINE || scope == SCOPE_GLOBAL)
4212 return NULL;
4213
4214 if (Substring_Length(varname) != 2)
4215 return NULL;
4216 if (varname.start[1] != 'F' && varname.start[1] != 'D')
4217 return NULL;
4218 if (strchr("@%?*!<>", varname.start[0]) == NULL)
4219 return NULL;
4220
4221 v = VarFindSubstring(Substring_Sub(varname, 0, 1), scope, false);
4222 if (v == NULL)
4223 return NULL;
4224
4225 *out_extraModifiers = varname.start[1] == 'D' ? "H:" : "T:";
4226 return v;
4227 }
4228
4229 static VarParseResult
4230 EvalUndefined(bool dynamic, const char *start, const char *p,
4231 Substring varname, VarEvalMode emode, FStr *out_val)
4232 {
4233 if (dynamic) {
4234 *out_val = FStr_InitOwn(bmake_strsedup(start, p));
4235 return VPR_OK;
4236 }
4237
4238 if (emode == VARE_UNDEFERR && opts.strict) {
4239 Parse_Error(PARSE_FATAL,
4240 "Variable \"%.*s\" is undefined",
4241 (int)Substring_Length(varname), varname.start);
4242 *out_val = FStr_InitRefer(var_Error);
4243 return VPR_ERR;
4244 }
4245
4246 if (emode == VARE_UNDEFERR) {
4247 *out_val = FStr_InitRefer(var_Error);
4248 return VPR_UNDEF; /* XXX: Should be VPR_ERR instead. */
4249 }
4250
4251 *out_val = FStr_InitRefer(varUndefined);
4252 return VPR_OK;
4253 }
4254
4255 /*
4256 * Parse a long variable name enclosed in braces or parentheses such as $(VAR)
4257 * or ${VAR}, up to the closing brace or parenthesis, or in the case of
4258 * ${VAR:Modifiers}, up to the ':' that starts the modifiers.
4259 * Return whether to continue parsing.
4260 */
4261 static bool
4262 ParseVarnameLong(
4263 const char **pp,
4264 char startc,
4265 GNode *scope,
4266 VarEvalMode emode,
4267
4268 const char **out_false_pp,
4269 VarParseResult *out_false_res,
4270 FStr *out_false_val,
4271
4272 char *out_true_endc,
4273 Var **out_true_v,
4274 bool *out_true_haveModifier,
4275 const char **out_true_extraModifiers,
4276 bool *out_true_dynamic,
4277 ExprDefined *out_true_exprDefined
4278 )
4279 {
4280 LazyBuf varname;
4281 Var *v;
4282 bool haveModifier;
4283 bool dynamic = false;
4284
4285 const char *p = *pp;
4286 const char *const start = p;
4287 char endc = startc == '(' ? ')' : '}';
4288
4289 p += 2; /* skip "${" or "$(" or "y(" */
4290 ParseVarname(&p, startc, endc, scope, emode, &varname);
4291
4292 if (*p == ':') {
4293 haveModifier = true;
4294 } else if (*p == endc) {
4295 haveModifier = false;
4296 } else {
4297 Substring name = LazyBuf_Get(&varname);
4298 Parse_Error(PARSE_FATAL, "Unclosed variable \"%.*s\"",
4299 (int)Substring_Length(name), name.start);
4300 LazyBuf_Done(&varname);
4301 *out_false_pp = p;
4302 *out_false_val = FStr_InitRefer(var_Error);
4303 *out_false_res = VPR_ERR;
4304 return false;
4305 }
4306
4307 v = VarFindSubstring(LazyBuf_Get(&varname), scope, true);
4308
4309 /* At this point, p points just after the variable name,
4310 * either at ':' or at endc. */
4311
4312 if (v == NULL) {
4313 v = FindLocalLegacyVar(LazyBuf_Get(&varname), scope,
4314 out_true_extraModifiers);
4315 }
4316
4317 if (v == NULL) {
4318 /*
4319 * Defer expansion of dynamic variables if they appear in
4320 * non-local scope since they are not defined there.
4321 */
4322 dynamic = VarnameIsDynamic(LazyBuf_Get(&varname)) &&
4323 (scope == SCOPE_CMDLINE || scope == SCOPE_GLOBAL);
4324
4325 if (!haveModifier) {
4326 p++; /* skip endc */
4327 *out_false_pp = p;
4328 *out_false_res = EvalUndefined(dynamic, start, p,
4329 LazyBuf_Get(&varname), emode, out_false_val);
4330 return false;
4331 }
4332
4333 /*
4334 * The variable expression is based on an undefined variable.
4335 * Nevertheless it needs a Var, for modifiers that access the
4336 * variable name, such as :L or :?.
4337 *
4338 * Most modifiers leave this expression in the "undefined"
4339 * state (VES_UNDEF), only a few modifiers like :D, :U, :L,
4340 * :P turn this undefined expression into a defined
4341 * expression (VES_DEF).
4342 *
4343 * In the end, after applying all modifiers, if the expression
4344 * is still undefined, Var_Parse will return an empty string
4345 * instead of the actually computed value.
4346 */
4347 v = VarNew(LazyBuf_DoneGet(&varname), "", false, false);
4348 *out_true_exprDefined = DEF_UNDEF;
4349 } else
4350 LazyBuf_Done(&varname);
4351
4352 *pp = p;
4353 *out_true_endc = endc;
4354 *out_true_v = v;
4355 *out_true_haveModifier = haveModifier;
4356 *out_true_dynamic = dynamic;
4357 return true;
4358 }
4359
4360 /* Free the environment variable now since we own it. */
4361 static void
4362 FreeEnvVar(Var *v, FStr *inout_val)
4363 {
4364 char *varValue = Buf_DoneData(&v->val);
4365 if (inout_val->str == varValue)
4366 inout_val->freeIt = varValue;
4367 else
4368 free(varValue);
4369
4370 FStr_Done(&v->name);
4371 free(v);
4372 }
4373
4374 #if __STDC_VERSION__ >= 199901L
4375 #define Expr_Literal(name, value, emode, scope, defined) \
4376 { name, value, emode, scope, defined }
4377 #else
4378 MAKE_INLINE Expr
4379 Expr_Literal(const char *name, FStr value,
4380 VarEvalMode emode, GNode *scope, ExprDefined defined)
4381 {
4382 Expr expr;
4383
4384 expr.name = name;
4385 expr.value = value;
4386 expr.emode = emode;
4387 expr.scope = scope;
4388 expr.defined = defined;
4389 return expr;
4390 }
4391 #endif
4392
4393 /*
4394 * Expressions of the form ${:U...} with a trivial value are often generated
4395 * by .for loops and are boring, therefore parse and evaluate them in a fast
4396 * lane without debug logging.
4397 */
4398 static bool
4399 Var_Parse_FastLane(const char **pp, VarEvalMode emode, FStr *out_value)
4400 {
4401 const char *p;
4402
4403 p = *pp;
4404 if (!(p[0] == '$' && p[1] == '{' && p[2] == ':' && p[3] == 'U'))
4405 return false;
4406
4407 p += 4;
4408 while (*p != '$' && *p != '{' && *p != ':' && *p != '\\' &&
4409 *p != '}' && *p != '\0')
4410 p++;
4411 if (*p != '}')
4412 return false;
4413
4414 if (emode == VARE_PARSE_ONLY)
4415 *out_value = FStr_InitRefer("");
4416 else
4417 *out_value = FStr_InitOwn(bmake_strsedup(*pp + 4, p));
4418 *pp = p + 1;
4419 return true;
4420 }
4421
4422 /*
4423 * Given the start of a variable expression (such as $v, $(VAR),
4424 * ${VAR:Mpattern}), extract the variable name and value, and the modifiers,
4425 * if any. While doing that, apply the modifiers to the value of the
4426 * expression, forming its final value. A few of the modifiers such as :!cmd!
4427 * or ::= have side effects.
4428 *
4429 * Input:
4430 * *pp The string to parse.
4431 * When parsing a condition in ParseEmptyArg, it may also
4432 * point to the "y" of "empty(VARNAME:Modifiers)", which
4433 * is syntactically the same.
4434 * scope The scope for finding variables
4435 * emode Controls the exact details of parsing and evaluation
4436 *
4437 * Output:
4438 * *pp The position where to continue parsing.
4439 * TODO: After a parse error, the value of *pp is
4440 * unspecified. It may not have been updated at all,
4441 * point to some random character in the string, to the
4442 * location of the parse error, or at the end of the
4443 * string.
4444 * *out_val The value of the variable expression, never NULL.
4445 * *out_val var_Error if there was a parse error.
4446 * *out_val var_Error if the base variable of the expression was
4447 * undefined, emode is VARE_UNDEFERR, and none of
4448 * the modifiers turned the undefined expression into a
4449 * defined expression.
4450 * XXX: It is not guaranteed that an error message has
4451 * been printed.
4452 * *out_val varUndefined if the base variable of the expression
4453 * was undefined, emode was not VARE_UNDEFERR,
4454 * and none of the modifiers turned the undefined
4455 * expression into a defined expression.
4456 * XXX: It is not guaranteed that an error message has
4457 * been printed.
4458 */
4459 VarParseResult
4460 Var_Parse(const char **pp, GNode *scope, VarEvalMode emode, FStr *out_val)
4461 {
4462 const char *p = *pp;
4463 const char *const start = p;
4464 /* true if have modifiers for the variable. */
4465 bool haveModifier;
4466 /* Starting character if variable in parens or braces. */
4467 char startc;
4468 /* Ending character if variable in parens or braces. */
4469 char endc;
4470 /*
4471 * true if the variable is local and we're expanding it in a
4472 * non-local scope. This is done to support dynamic sources.
4473 * The result is just the expression, unaltered.
4474 */
4475 bool dynamic;
4476 const char *extramodifiers;
4477 Var *v;
4478 Expr expr = Expr_Literal(NULL, FStr_InitRefer(NULL), emode,
4479 scope, DEF_REGULAR);
4480
4481 if (Var_Parse_FastLane(pp, emode, out_val))
4482 return VPR_OK;
4483
4484 DEBUG2(VAR, "Var_Parse: %s (%s)\n", start, VarEvalMode_Name[emode]);
4485
4486 *out_val = FStr_InitRefer(NULL);
4487 extramodifiers = NULL; /* extra modifiers to apply first */
4488 dynamic = false;
4489
4490 /*
4491 * Appease GCC, which thinks that the variable might not be
4492 * initialized.
4493 */
4494 endc = '\0';
4495
4496 startc = p[1];
4497 if (startc != '(' && startc != '{') {
4498 VarParseResult res;
4499 if (!ParseVarnameShort(startc, pp, scope, emode, &res,
4500 &out_val->str, &v))
4501 return res;
4502 haveModifier = false;
4503 p++;
4504 } else {
4505 VarParseResult res;
4506 if (!ParseVarnameLong(&p, startc, scope, emode,
4507 pp, &res, out_val,
4508 &endc, &v, &haveModifier, &extramodifiers,
4509 &dynamic, &expr.defined))
4510 return res;
4511 }
4512
4513 expr.name = v->name.str;
4514 if (v->inUse)
4515 Fatal("Variable %s is recursive.", v->name.str);
4516
4517 /*
4518 * XXX: This assignment creates an alias to the current value of the
4519 * variable. This means that as long as the value of the expression
4520 * stays the same, the value of the variable must not change.
4521 * Using the '::=' modifier, it could be possible to do exactly this.
4522 * At the bottom of this function, the resulting value is compared to
4523 * the then-current value of the variable. This might also invoke
4524 * undefined behavior.
4525 */
4526 expr.value = FStr_InitRefer(v->val.data);
4527
4528 /*
4529 * Before applying any modifiers, expand any nested expressions from
4530 * the variable value.
4531 */
4532 if (strchr(expr.value.str, '$') != NULL &&
4533 VarEvalMode_ShouldEval(emode)) {
4534 char *expanded;
4535 VarEvalMode nested_emode = emode;
4536 if (opts.strict)
4537 nested_emode = VarEvalMode_UndefOk(nested_emode);
4538 v->inUse = true;
4539 (void)Var_Subst(expr.value.str, scope, nested_emode,
4540 &expanded);
4541 v->inUse = false;
4542 /* TODO: handle errors */
4543 Expr_SetValueOwn(&expr, expanded);
4544 }
4545
4546 if (extramodifiers != NULL) {
4547 const char *em = extramodifiers;
4548 ApplyModifiers(&expr, &em, '\0', '\0');
4549 }
4550
4551 if (haveModifier) {
4552 p++; /* Skip initial colon. */
4553 ApplyModifiers(&expr, &p, startc, endc);
4554 }
4555
4556 if (*p != '\0') /* Skip past endc if possible. */
4557 p++;
4558
4559 *pp = p;
4560
4561 if (v->fromEnv) {
4562 FreeEnvVar(v, &expr.value);
4563
4564 } else if (expr.defined != DEF_REGULAR) {
4565 if (expr.defined == DEF_UNDEF) {
4566 if (dynamic) {
4567 Expr_SetValueOwn(&expr,
4568 bmake_strsedup(start, p));
4569 } else {
4570 /*
4571 * The expression is still undefined,
4572 * therefore discard the actual value and
4573 * return an error marker instead.
4574 */
4575 Expr_SetValueRefer(&expr,
4576 emode == VARE_UNDEFERR
4577 ? var_Error : varUndefined);
4578 }
4579 }
4580 /* XXX: This is not standard memory management. */
4581 if (expr.value.str != v->val.data)
4582 Buf_Done(&v->val);
4583 FStr_Done(&v->name);
4584 free(v);
4585 }
4586 *out_val = expr.value;
4587 return VPR_OK; /* XXX: Is not correct in all cases */
4588 }
4589
4590 static void
4591 VarSubstDollarDollar(const char **pp, Buffer *res, VarEvalMode emode)
4592 {
4593 /* A dollar sign may be escaped with another dollar sign. */
4594 if (save_dollars && VarEvalMode_ShouldKeepDollar(emode))
4595 Buf_AddByte(res, '$');
4596 Buf_AddByte(res, '$');
4597 *pp += 2;
4598 }
4599
4600 static void
4601 VarSubstExpr(const char **pp, Buffer *buf, GNode *scope,
4602 VarEvalMode emode, bool *inout_errorReported)
4603 {
4604 const char *p = *pp;
4605 const char *nested_p = p;
4606 FStr val;
4607
4608 (void)Var_Parse(&nested_p, scope, emode, &val);
4609 /* TODO: handle errors */
4610
4611 if (val.str == var_Error || val.str == varUndefined) {
4612 if (!VarEvalMode_ShouldKeepUndef(emode)) {
4613 p = nested_p;
4614 } else if (emode == VARE_UNDEFERR || val.str == var_Error) {
4615
4616 /*
4617 * XXX: This condition is wrong. If val == var_Error,
4618 * this doesn't necessarily mean there was an undefined
4619 * variable. It could equally well be a parse error;
4620 * see unit-tests/varmod-order.exp.
4621 */
4622
4623 /*
4624 * If variable is undefined, complain and skip the
4625 * variable. The complaint will stop us from doing
4626 * anything when the file is parsed.
4627 */
4628 if (!*inout_errorReported) {
4629 Parse_Error(PARSE_FATAL,
4630 "Undefined variable \"%.*s\"",
4631 (int)(size_t)(nested_p - p), p);
4632 }
4633 p = nested_p;
4634 *inout_errorReported = true;
4635 } else {
4636 /* Copy the initial '$' of the undefined expression,
4637 * thereby deferring expansion of the expression, but
4638 * expand nested expressions if already possible.
4639 * See unit-tests/varparse-undef-partial.mk. */
4640 Buf_AddByte(buf, *p);
4641 p++;
4642 }
4643 } else {
4644 p = nested_p;
4645 Buf_AddStr(buf, val.str);
4646 }
4647
4648 FStr_Done(&val);
4649
4650 *pp = p;
4651 }
4652
4653 /*
4654 * Skip as many characters as possible -- either to the end of the string
4655 * or to the next dollar sign (variable expression).
4656 */
4657 static void
4658 VarSubstPlain(const char **pp, Buffer *res)
4659 {
4660 const char *p = *pp;
4661 const char *start = p;
4662
4663 for (p++; *p != '$' && *p != '\0'; p++)
4664 continue;
4665 Buf_AddBytesBetween(res, start, p);
4666 *pp = p;
4667 }
4668
4669 /*
4670 * Expand all variable expressions like $V, ${VAR}, $(VAR:Modifiers) in the
4671 * given string.
4672 *
4673 * Input:
4674 * str The string in which the variable expressions are
4675 * expanded.
4676 * scope The scope in which to start searching for
4677 * variables. The other scopes are searched as well.
4678 * emode The mode for parsing or evaluating subexpressions.
4679 */
4680 VarParseResult
4681 Var_Subst(const char *str, GNode *scope, VarEvalMode emode, char **out_res)
4682 {
4683 const char *p = str;
4684 Buffer res;
4685
4686 /* Set true if an error has already been reported,
4687 * to prevent a plethora of messages when recursing */
4688 /* XXX: Why is the 'static' necessary here? */
4689 static bool errorReported;
4690
4691 Buf_Init(&res);
4692 errorReported = false;
4693
4694 while (*p != '\0') {
4695 if (p[0] == '$' && p[1] == '$')
4696 VarSubstDollarDollar(&p, &res, emode);
4697 else if (p[0] == '$')
4698 VarSubstExpr(&p, &res, scope, emode, &errorReported);
4699 else
4700 VarSubstPlain(&p, &res);
4701 }
4702
4703 *out_res = Buf_DoneDataCompact(&res);
4704 return VPR_OK;
4705 }
4706
4707 /* Initialize the variables module. */
4708 void
4709 Var_Init(void)
4710 {
4711 SCOPE_INTERNAL = GNode_New("Internal");
4712 SCOPE_GLOBAL = GNode_New("Global");
4713 SCOPE_CMDLINE = GNode_New("Command");
4714 }
4715
4716 /* Clean up the variables module. */
4717 void
4718 Var_End(void)
4719 {
4720 Var_Stats();
4721 }
4722
4723 void
4724 Var_Stats(void)
4725 {
4726 HashTable_DebugStats(&SCOPE_GLOBAL->vars, "Global variables");
4727 }
4728
4729 /* Print all variables in a scope, sorted by name. */
4730 void
4731 Var_Dump(GNode *scope)
4732 {
4733 Vector /* of const char * */ vec;
4734 HashIter hi;
4735 size_t i;
4736 const char **varnames;
4737
4738 Vector_Init(&vec, sizeof(const char *));
4739
4740 HashIter_Init(&hi, &scope->vars);
4741 while (HashIter_Next(&hi) != NULL)
4742 *(const char **)Vector_Push(&vec) = hi.entry->key;
4743 varnames = vec.items;
4744
4745 qsort(varnames, vec.len, sizeof varnames[0], str_cmp_asc);
4746
4747 for (i = 0; i < vec.len; i++) {
4748 const char *varname = varnames[i];
4749 Var *var = HashTable_FindValue(&scope->vars, varname);
4750 debug_printf("%-16s = %s\n", varname, var->val.data);
4751 }
4752
4753 Vector_Done(&vec);
4754 }
4755