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