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