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