var.c revision 1.1025 1 /* $NetBSD: var.c,v 1.1025 2022/06/14 19:57:56 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.1025 2022/06/14 19:57:56 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 envName = Substring_Str(name);
436 envValue = getenv(envName.str);
437 if (envValue != NULL)
438 return VarNew(envName, envValue, true, true, false);
439 FStr_Done(&envName);
440
441 if (opts.checkEnvFirst && scope != SCOPE_GLOBAL) {
442 var = GNode_FindVar(SCOPE_GLOBAL, name, nameHash);
443 if (var == NULL && scope != SCOPE_INTERNAL)
444 var = GNode_FindVar(SCOPE_INTERNAL, name,
445 nameHash);
446 return var;
447 }
448
449 return NULL;
450 }
451
452 return var;
453 }
454
455 static Var *
456 VarFind(const char *name, GNode *scope, bool elsewhere)
457 {
458 return VarFindSubstring(Substring_InitStr(name), scope, elsewhere);
459 }
460
461 /* If the variable is short-lived, free it, including its value. */
462 static void
463 VarFreeShortLived(Var *v)
464 {
465 if (!v->shortLived)
466 return;
467
468 FStr_Done(&v->name);
469 Buf_Done(&v->val);
470 free(v);
471 }
472
473 static const char *
474 ValueDescription(const char *value)
475 {
476 if (value[0] == '\0')
477 return "# (empty)";
478 if (ch_isspace(value[strlen(value) - 1]))
479 return "# (ends with space)";
480 return "";
481 }
482
483 /* Add a new variable of the given name and value to the given scope. */
484 static Var *
485 VarAdd(const char *name, const char *value, GNode *scope, VarSetFlags flags)
486 {
487 HashEntry *he = HashTable_CreateEntry(&scope->vars, name, NULL);
488 Var *v = VarNew(FStr_InitRefer(/* aliased to */ he->key), value,
489 false, false, (flags & VAR_SET_READONLY) != 0);
490 HashEntry_Set(he, v);
491 DEBUG4(VAR, "%s: %s = %s%s\n",
492 scope->name, name, value, ValueDescription(value));
493 return v;
494 }
495
496 /*
497 * Remove a variable from a scope, freeing all related memory as well.
498 * The variable name is kept as-is, it is not expanded.
499 */
500 void
501 Var_Delete(GNode *scope, const char *varname)
502 {
503 HashEntry *he = HashTable_FindEntry(&scope->vars, varname);
504 Var *v;
505
506 if (he == NULL) {
507 DEBUG2(VAR, "%s: delete %s (not found)\n",
508 scope->name, varname);
509 return;
510 }
511
512 DEBUG2(VAR, "%s: delete %s\n", scope->name, varname);
513 v = he->value;
514 if (v->inUse) {
515 Parse_Error(PARSE_FATAL,
516 "Cannot delete variable \"%s\" while it is used",
517 v->name.str);
518 return;
519 }
520
521 if (v->exported)
522 unsetenv(v->name.str);
523 if (strcmp(v->name.str, MAKE_EXPORTED) == 0)
524 var_exportedVars = VAR_EXPORTED_NONE;
525
526 assert(v->name.freeIt == NULL);
527 HashTable_DeleteEntry(&scope->vars, he);
528 Buf_Done(&v->val);
529 free(v);
530 }
531
532 /*
533 * Undefine one or more variables from the global scope.
534 * The argument is expanded exactly once and then split into words.
535 */
536 void
537 Var_Undef(const char *arg)
538 {
539 VarParseResult vpr;
540 char *expanded;
541 Words varnames;
542 size_t i;
543
544 if (arg[0] == '\0') {
545 Parse_Error(PARSE_FATAL,
546 "The .undef directive requires an argument");
547 return;
548 }
549
550 vpr = Var_Subst(arg, SCOPE_GLOBAL, VARE_WANTRES, &expanded);
551 if (vpr != VPR_OK) {
552 Parse_Error(PARSE_FATAL,
553 "Error in variable names to be undefined");
554 return;
555 }
556
557 varnames = Str_Words(expanded, false);
558 if (varnames.len == 1 && varnames.words[0][0] == '\0')
559 varnames.len = 0;
560
561 for (i = 0; i < varnames.len; i++) {
562 const char *varname = varnames.words[i];
563 Global_Delete(varname);
564 }
565
566 Words_Free(varnames);
567 free(expanded);
568 }
569
570 static bool
571 MayExport(const char *name)
572 {
573 if (name[0] == '.')
574 return false; /* skip internals */
575 if (name[0] == '-')
576 return false; /* skip misnamed variables */
577 if (name[1] == '\0') {
578 /*
579 * A single char.
580 * If it is one of the variables that should only appear in
581 * local scope, skip it, else we can get Var_Subst
582 * into a loop.
583 */
584 switch (name[0]) {
585 case '@':
586 case '%':
587 case '*':
588 case '!':
589 return false;
590 }
591 }
592 return true;
593 }
594
595 static bool
596 ExportVarEnv(Var *v)
597 {
598 const char *name = v->name.str;
599 char *val = v->val.data;
600 char *expr;
601
602 if (v->exported && !v->reexport)
603 return false; /* nothing to do */
604
605 if (strchr(val, '$') == NULL) {
606 if (!v->exported)
607 setenv(name, val, 1);
608 return true;
609 }
610
611 if (v->inUse) {
612 /*
613 * We recursed while exporting in a child.
614 * This isn't going to end well, just skip it.
615 */
616 return false;
617 }
618
619 /* XXX: name is injected without escaping it */
620 expr = str_concat3("${", name, "}");
621 (void)Var_Subst(expr, SCOPE_GLOBAL, VARE_WANTRES, &val);
622 /* TODO: handle errors */
623 setenv(name, val, 1);
624 free(val);
625 free(expr);
626 return true;
627 }
628
629 static bool
630 ExportVarPlain(Var *v)
631 {
632 if (strchr(v->val.data, '$') == NULL) {
633 setenv(v->name.str, v->val.data, 1);
634 v->exported = true;
635 v->reexport = false;
636 return true;
637 }
638
639 /*
640 * Flag the variable as something we need to re-export.
641 * No point actually exporting it now though,
642 * the child process can do it at the last minute.
643 * Avoid calling setenv more often than necessary since it can leak.
644 */
645 v->exported = true;
646 v->reexport = true;
647 return true;
648 }
649
650 static bool
651 ExportVarLiteral(Var *v)
652 {
653 if (v->exported && !v->reexport)
654 return false;
655
656 if (!v->exported)
657 setenv(v->name.str, v->val.data, 1);
658
659 return true;
660 }
661
662 /*
663 * Mark a single variable to be exported later for subprocesses.
664 *
665 * Internal variables (those starting with '.') are not exported.
666 */
667 static bool
668 ExportVar(const char *name, VarExportMode mode)
669 {
670 Var *v;
671
672 if (!MayExport(name))
673 return false;
674
675 v = VarFind(name, SCOPE_GLOBAL, false);
676 if (v == NULL)
677 return false;
678
679 if (mode == VEM_ENV)
680 return ExportVarEnv(v);
681 else if (mode == VEM_PLAIN)
682 return ExportVarPlain(v);
683 else
684 return ExportVarLiteral(v);
685 }
686
687 /*
688 * Actually export the variables that have been marked as needing to be
689 * re-exported.
690 */
691 void
692 Var_ReexportVars(void)
693 {
694 char *xvarnames;
695
696 /*
697 * Several make implementations support this sort of mechanism for
698 * tracking recursion - but each uses a different name.
699 * We allow the makefiles to update MAKELEVEL and ensure
700 * children see a correctly incremented value.
701 */
702 char tmp[21];
703 snprintf(tmp, sizeof tmp, "%d", makelevel + 1);
704 setenv(MAKE_LEVEL_ENV, tmp, 1);
705
706 if (var_exportedVars == VAR_EXPORTED_NONE)
707 return;
708
709 if (var_exportedVars == VAR_EXPORTED_ALL) {
710 HashIter hi;
711
712 /* Ouch! Exporting all variables at once is crazy. */
713 HashIter_Init(&hi, &SCOPE_GLOBAL->vars);
714 while (HashIter_Next(&hi) != NULL) {
715 Var *var = hi.entry->value;
716 ExportVar(var->name.str, VEM_ENV);
717 }
718 return;
719 }
720
721 (void)Var_Subst("${" MAKE_EXPORTED ":O:u}", SCOPE_GLOBAL, VARE_WANTRES,
722 &xvarnames);
723 /* TODO: handle errors */
724 if (xvarnames[0] != '\0') {
725 Words varnames = Str_Words(xvarnames, false);
726 size_t i;
727
728 for (i = 0; i < varnames.len; i++)
729 ExportVar(varnames.words[i], VEM_ENV);
730 Words_Free(varnames);
731 }
732 free(xvarnames);
733 }
734
735 static void
736 ExportVars(const char *varnames, bool isExport, VarExportMode mode)
737 /* TODO: try to combine the parameters 'isExport' and 'mode'. */
738 {
739 Words words = Str_Words(varnames, false);
740 size_t i;
741
742 if (words.len == 1 && words.words[0][0] == '\0')
743 words.len = 0;
744
745 for (i = 0; i < words.len; i++) {
746 const char *varname = words.words[i];
747 if (!ExportVar(varname, mode))
748 continue;
749
750 if (var_exportedVars == VAR_EXPORTED_NONE)
751 var_exportedVars = VAR_EXPORTED_SOME;
752
753 if (isExport && mode == VEM_PLAIN)
754 Global_Append(MAKE_EXPORTED, varname);
755 }
756 Words_Free(words);
757 }
758
759 static void
760 ExportVarsExpand(const char *uvarnames, bool isExport, VarExportMode mode)
761 {
762 char *xvarnames;
763
764 (void)Var_Subst(uvarnames, SCOPE_GLOBAL, VARE_WANTRES, &xvarnames);
765 /* TODO: handle errors */
766 ExportVars(xvarnames, isExport, mode);
767 free(xvarnames);
768 }
769
770 /* Export the named variables, or all variables. */
771 void
772 Var_Export(VarExportMode mode, const char *varnames)
773 {
774 if (mode == VEM_PLAIN && varnames[0] == '\0') {
775 var_exportedVars = VAR_EXPORTED_ALL; /* use with caution! */
776 return;
777 }
778
779 ExportVarsExpand(varnames, true, mode);
780 }
781
782 void
783 Var_ExportVars(const char *varnames)
784 {
785 ExportVarsExpand(varnames, false, VEM_PLAIN);
786 }
787
788
789 extern char **environ;
790
791 static void
792 ClearEnv(void)
793 {
794 const char *cp;
795 char **newenv;
796
797 cp = getenv(MAKE_LEVEL_ENV); /* we should preserve this */
798 if (environ == savedEnv) {
799 /* we have been here before! */
800 newenv = bmake_realloc(environ, 2 * sizeof(char *));
801 } else {
802 if (savedEnv != NULL) {
803 free(savedEnv);
804 savedEnv = NULL;
805 }
806 newenv = bmake_malloc(2 * sizeof(char *));
807 }
808
809 /* Note: we cannot safely free() the original environ. */
810 environ = savedEnv = newenv;
811 newenv[0] = NULL;
812 newenv[1] = NULL;
813 if (cp != NULL && *cp != '\0')
814 setenv(MAKE_LEVEL_ENV, cp, 1);
815 }
816
817 static void
818 GetVarnamesToUnexport(bool isEnv, const char *arg,
819 FStr *out_varnames, UnexportWhat *out_what)
820 {
821 UnexportWhat what;
822 FStr varnames = FStr_InitRefer("");
823
824 if (isEnv) {
825 if (arg[0] != '\0') {
826 Parse_Error(PARSE_FATAL,
827 "The directive .unexport-env does not take "
828 "arguments");
829 /* continue anyway */
830 }
831 what = UNEXPORT_ENV;
832
833 } else {
834 what = arg[0] != '\0' ? UNEXPORT_NAMED : UNEXPORT_ALL;
835 if (what == UNEXPORT_NAMED)
836 varnames = FStr_InitRefer(arg);
837 }
838
839 if (what != UNEXPORT_NAMED) {
840 char *expanded;
841 /* Using .MAKE.EXPORTED */
842 (void)Var_Subst("${" MAKE_EXPORTED ":O:u}", SCOPE_GLOBAL,
843 VARE_WANTRES, &expanded);
844 /* TODO: handle errors */
845 varnames = FStr_InitOwn(expanded);
846 }
847
848 *out_varnames = varnames;
849 *out_what = what;
850 }
851
852 static void
853 UnexportVar(Substring varname, UnexportWhat what)
854 {
855 Var *v = VarFindSubstring(varname, SCOPE_GLOBAL, false);
856 if (v == NULL) {
857 DEBUG2(VAR, "Not unexporting \"%.*s\" (not found)\n",
858 (int)Substring_Length(varname), varname.start);
859 return;
860 }
861
862 DEBUG2(VAR, "Unexporting \"%.*s\"\n",
863 (int)Substring_Length(varname), varname.start);
864 if (what != UNEXPORT_ENV && v->exported && !v->reexport)
865 unsetenv(v->name.str);
866 v->exported = false;
867 v->reexport = false;
868
869 if (what == UNEXPORT_NAMED) {
870 /* Remove the variable names from .MAKE.EXPORTED. */
871 /* XXX: v->name is injected without escaping it */
872 char *expr = str_concat3("${" MAKE_EXPORTED ":N",
873 v->name.str, "}");
874 char *cp;
875 (void)Var_Subst(expr, SCOPE_GLOBAL, VARE_WANTRES, &cp);
876 /* TODO: handle errors */
877 Global_Set(MAKE_EXPORTED, cp);
878 free(cp);
879 free(expr);
880 }
881 }
882
883 static void
884 UnexportVars(FStr *varnames, UnexportWhat what)
885 {
886 size_t i;
887 SubstringWords words;
888
889 if (what == UNEXPORT_ENV)
890 ClearEnv();
891
892 words = Substring_Words(varnames->str, false);
893 for (i = 0; i < words.len; i++)
894 UnexportVar(words.words[i], what);
895 SubstringWords_Free(words);
896
897 if (what != UNEXPORT_NAMED)
898 Global_Delete(MAKE_EXPORTED);
899 }
900
901 /*
902 * This is called when .unexport[-env] is seen.
903 *
904 * str must have the form "unexport[-env] varname...".
905 */
906 void
907 Var_UnExport(bool isEnv, const char *arg)
908 {
909 UnexportWhat what;
910 FStr varnames;
911
912 GetVarnamesToUnexport(isEnv, arg, &varnames, &what);
913 UnexportVars(&varnames, what);
914 FStr_Done(&varnames);
915 }
916
917 /*
918 * When there is a variable of the same name in the command line scope, the
919 * global variable would not be visible anywhere. Therefore there is no
920 * point in setting it at all.
921 *
922 * See 'scope == SCOPE_CMDLINE' in Var_SetWithFlags.
923 */
924 static bool
925 ExistsInCmdline(const char *name, const char *val)
926 {
927 Var *v;
928
929 v = VarFind(name, SCOPE_CMDLINE, false);
930 if (v == NULL)
931 return false;
932
933 if (v->fromCmd) {
934 DEBUG3(VAR, "%s: %s = %s ignored!\n",
935 SCOPE_GLOBAL->name, name, val);
936 return true;
937 }
938
939 VarFreeShortLived(v);
940 return false;
941 }
942
943 /* Set the variable to the value; the name is not expanded. */
944 void
945 Var_SetWithFlags(GNode *scope, const char *name, const char *val,
946 VarSetFlags flags)
947 {
948 Var *v;
949
950 assert(val != NULL);
951 if (name[0] == '\0') {
952 DEBUG0(VAR, "SetVar: variable name is empty - ignored\n");
953 return;
954 }
955
956 if (scope == SCOPE_GLOBAL && ExistsInCmdline(name, val))
957 return;
958
959 /*
960 * Only look for a variable in the given scope since anything set
961 * here will override anything in a lower scope, so there's not much
962 * point in searching them all.
963 */
964 v = VarFind(name, scope, false);
965 if (v == NULL) {
966 if (scope == SCOPE_CMDLINE && !(flags & VAR_SET_NO_EXPORT)) {
967 /*
968 * This var would normally prevent the same name being
969 * added to SCOPE_GLOBAL, so delete it from there if
970 * needed. Otherwise -V name may show the wrong value.
971 *
972 * See ExistsInCmdline.
973 */
974 Var_Delete(SCOPE_GLOBAL, name);
975 }
976 if (strcmp(name, ".SUFFIXES") == 0) {
977 /* special: treat as readOnly */
978 DEBUG3(VAR, "%s: %s = %s ignored (read-only)\n",
979 scope->name, name, val);
980 return;
981 }
982 v = VarAdd(name, val, scope, flags);
983 } else {
984 if (v->readOnly && !(flags & VAR_SET_READONLY)) {
985 DEBUG3(VAR, "%s: %s = %s ignored (read-only)\n",
986 scope->name, name, val);
987 return;
988 }
989 Buf_Clear(&v->val);
990 Buf_AddStr(&v->val, val);
991
992 DEBUG4(VAR, "%s: %s = %s%s\n",
993 scope->name, name, val, ValueDescription(val));
994 if (v->exported)
995 ExportVar(name, VEM_PLAIN);
996 }
997
998 /*
999 * Any variables given on the command line are automatically exported
1000 * to the environment (as per POSIX standard), except for internals.
1001 */
1002 if (scope == SCOPE_CMDLINE && !(flags & VAR_SET_NO_EXPORT) &&
1003 name[0] != '.') {
1004 v->fromCmd = true;
1005
1006 /*
1007 * If requested, don't export these in the environment
1008 * individually. We still put them in MAKEOVERRIDES so
1009 * that the command-line settings continue to override
1010 * Makefile settings.
1011 */
1012 if (!opts.varNoExportEnv)
1013 setenv(name, val, 1);
1014 /* XXX: What about .MAKE.EXPORTED? */
1015 /*
1016 * XXX: Why not just mark the variable for needing export, as
1017 * in ExportVarPlain?
1018 */
1019
1020 Global_Append(MAKEOVERRIDES, name);
1021 }
1022
1023 if (name[0] == '.' && strcmp(name, MAKE_SAVE_DOLLARS) == 0)
1024 save_dollars = ParseBoolean(val, save_dollars);
1025
1026 if (v != NULL)
1027 VarFreeShortLived(v);
1028 }
1029
1030 void
1031 Var_Set(GNode *scope, const char *name, const char *val)
1032 {
1033 Var_SetWithFlags(scope, name, val, VAR_SET_NONE);
1034 }
1035
1036 /*
1037 * Set the variable name to the value val in the given scope.
1038 *
1039 * If the variable doesn't yet exist, it is created.
1040 * Otherwise the new value overwrites and replaces the old value.
1041 *
1042 * Input:
1043 * scope scope in which to set it
1044 * name name of the variable to set, is expanded once
1045 * val value to give to the variable
1046 */
1047 void
1048 Var_SetExpand(GNode *scope, const char *name, const char *val)
1049 {
1050 const char *unexpanded_name = name;
1051 FStr varname = FStr_InitRefer(name);
1052
1053 assert(val != NULL);
1054
1055 Var_Expand(&varname, scope, VARE_WANTRES);
1056
1057 if (varname.str[0] == '\0') {
1058 DEBUG2(VAR,
1059 "Var_SetExpand: variable name \"%s\" expands "
1060 "to empty string, with value \"%s\" - ignored\n",
1061 unexpanded_name, val);
1062 } else
1063 Var_SetWithFlags(scope, varname.str, val, VAR_SET_NONE);
1064
1065 FStr_Done(&varname);
1066 }
1067
1068 void
1069 Global_Set(const char *name, const char *value)
1070 {
1071 Var_Set(SCOPE_GLOBAL, name, value);
1072 }
1073
1074 void
1075 Global_Delete(const char *name)
1076 {
1077 Var_Delete(SCOPE_GLOBAL, name);
1078 }
1079
1080 /*
1081 * Append the value to the named variable.
1082 *
1083 * If the variable doesn't exist, it is created. Otherwise a single space
1084 * and the given value are appended.
1085 */
1086 void
1087 Var_Append(GNode *scope, const char *name, const char *val)
1088 {
1089 Var *v;
1090
1091 v = VarFind(name, scope, scope == SCOPE_GLOBAL);
1092
1093 if (v == NULL) {
1094 Var_SetWithFlags(scope, name, val, VAR_SET_NONE);
1095 } else if (v->readOnly) {
1096 DEBUG1(VAR, "Ignoring append to %s since it is read-only\n",
1097 name);
1098 } else if (scope == SCOPE_CMDLINE || !v->fromCmd) {
1099 Buf_AddByte(&v->val, ' ');
1100 Buf_AddStr(&v->val, val);
1101
1102 DEBUG3(VAR, "%s: %s = %s\n", scope->name, name, v->val.data);
1103
1104 if (v->fromEnvironment) {
1105 /* See VarAdd. */
1106 HashEntry *he =
1107 HashTable_CreateEntry(&scope->vars, name, NULL);
1108 HashEntry_Set(he, v);
1109 FStr_Done(&v->name);
1110 v->name = FStr_InitRefer(/* aliased to */ he->key);
1111 v->shortLived = false;
1112 v->fromEnvironment = false;
1113 }
1114 }
1115 }
1116
1117 /*
1118 * The variable of the given name has the given value appended to it in the
1119 * given scope.
1120 *
1121 * If the variable doesn't exist, it is created. Otherwise the strings are
1122 * concatenated, with a space in between.
1123 *
1124 * Input:
1125 * scope scope in which this should occur
1126 * name name of the variable to modify, is expanded once
1127 * val string to append to it
1128 *
1129 * Notes:
1130 * Only if the variable is being sought in the global scope is the
1131 * environment searched.
1132 * XXX: Knows its calling circumstances in that if called with scope
1133 * an actual target, it will only search that scope since only
1134 * a local variable could be being appended to. This is actually
1135 * a big win and must be tolerated.
1136 */
1137 void
1138 Var_AppendExpand(GNode *scope, const char *name, const char *val)
1139 {
1140 FStr xname = FStr_InitRefer(name);
1141
1142 assert(val != NULL);
1143
1144 Var_Expand(&xname, scope, VARE_WANTRES);
1145 if (xname.str != name && xname.str[0] == '\0')
1146 DEBUG2(VAR,
1147 "Var_AppendExpand: variable name \"%s\" expands "
1148 "to empty string, with value \"%s\" - ignored\n",
1149 name, val);
1150 else
1151 Var_Append(scope, xname.str, val);
1152
1153 FStr_Done(&xname);
1154 }
1155
1156 void
1157 Global_Append(const char *name, const char *value)
1158 {
1159 Var_Append(SCOPE_GLOBAL, name, value);
1160 }
1161
1162 bool
1163 Var_Exists(GNode *scope, const char *name)
1164 {
1165 Var *v = VarFind(name, scope, true);
1166 if (v == NULL)
1167 return false;
1168
1169 VarFreeShortLived(v);
1170 return true;
1171 }
1172
1173 /*
1174 * See if the given variable exists, in the given scope or in other
1175 * fallback scopes.
1176 *
1177 * Input:
1178 * scope scope in which to start search
1179 * name name of the variable to find, is expanded once
1180 */
1181 bool
1182 Var_ExistsExpand(GNode *scope, const char *name)
1183 {
1184 FStr varname = FStr_InitRefer(name);
1185 bool exists;
1186
1187 Var_Expand(&varname, scope, VARE_WANTRES);
1188 exists = Var_Exists(scope, varname.str);
1189 FStr_Done(&varname);
1190 return exists;
1191 }
1192
1193 /*
1194 * Return the unexpanded value of the given variable in the given scope,
1195 * or the usual scopes.
1196 *
1197 * Input:
1198 * scope scope in which to search for it
1199 * name name to find, is not expanded any further
1200 *
1201 * Results:
1202 * The value if the variable exists, NULL if it doesn't.
1203 * The value is valid until the next modification to any variable.
1204 */
1205 FStr
1206 Var_Value(GNode *scope, const char *name)
1207 {
1208 Var *v = VarFind(name, scope, true);
1209 char *value;
1210
1211 if (v == NULL)
1212 return FStr_InitRefer(NULL);
1213
1214 if (!v->shortLived)
1215 return FStr_InitRefer(v->val.data);
1216
1217 value = v->val.data;
1218 v->val.data = NULL;
1219 VarFreeShortLived(v);
1220
1221 return FStr_InitOwn(value);
1222 }
1223
1224 /*
1225 * Return the unexpanded variable value from this node, without trying to look
1226 * up the variable in any other scope.
1227 */
1228 const char *
1229 GNode_ValueDirect(GNode *gn, const char *name)
1230 {
1231 Var *v = VarFind(name, gn, false);
1232 return v != NULL ? v->val.data : NULL;
1233 }
1234
1235 static VarEvalMode
1236 VarEvalMode_WithoutKeepDollar(VarEvalMode emode)
1237 {
1238 if (emode == VARE_KEEP_DOLLAR_UNDEF)
1239 return VARE_EVAL_KEEP_UNDEF;
1240 if (emode == VARE_EVAL_KEEP_DOLLAR)
1241 return VARE_WANTRES;
1242 return emode;
1243 }
1244
1245 static VarEvalMode
1246 VarEvalMode_UndefOk(VarEvalMode emode)
1247 {
1248 return emode == VARE_UNDEFERR ? VARE_WANTRES : emode;
1249 }
1250
1251 static bool
1252 VarEvalMode_ShouldEval(VarEvalMode emode)
1253 {
1254 return emode != VARE_PARSE_ONLY;
1255 }
1256
1257 static bool
1258 VarEvalMode_ShouldKeepUndef(VarEvalMode emode)
1259 {
1260 return emode == VARE_EVAL_KEEP_UNDEF ||
1261 emode == VARE_KEEP_DOLLAR_UNDEF;
1262 }
1263
1264 static bool
1265 VarEvalMode_ShouldKeepDollar(VarEvalMode emode)
1266 {
1267 return emode == VARE_EVAL_KEEP_DOLLAR ||
1268 emode == VARE_KEEP_DOLLAR_UNDEF;
1269 }
1270
1271
1272 static void
1273 SepBuf_Init(SepBuf *buf, char sep)
1274 {
1275 Buf_InitSize(&buf->buf, 32);
1276 buf->needSep = false;
1277 buf->sep = sep;
1278 }
1279
1280 static void
1281 SepBuf_Sep(SepBuf *buf)
1282 {
1283 buf->needSep = true;
1284 }
1285
1286 static void
1287 SepBuf_AddBytes(SepBuf *buf, const char *mem, size_t mem_size)
1288 {
1289 if (mem_size == 0)
1290 return;
1291 if (buf->needSep && buf->sep != '\0') {
1292 Buf_AddByte(&buf->buf, buf->sep);
1293 buf->needSep = false;
1294 }
1295 Buf_AddBytes(&buf->buf, mem, mem_size);
1296 }
1297
1298 static void
1299 SepBuf_AddBytesBetween(SepBuf *buf, const char *start, const char *end)
1300 {
1301 SepBuf_AddBytes(buf, start, (size_t)(end - start));
1302 }
1303
1304 static void
1305 SepBuf_AddStr(SepBuf *buf, const char *str)
1306 {
1307 SepBuf_AddBytes(buf, str, strlen(str));
1308 }
1309
1310 static void
1311 SepBuf_AddSubstring(SepBuf *buf, Substring sub)
1312 {
1313 SepBuf_AddBytesBetween(buf, sub.start, sub.end);
1314 }
1315
1316 static char *
1317 SepBuf_DoneData(SepBuf *buf)
1318 {
1319 return Buf_DoneData(&buf->buf);
1320 }
1321
1322
1323 /*
1324 * This callback for ModifyWords gets a single word from a variable expression
1325 * and typically adds a modification of this word to the buffer. It may also
1326 * do nothing or add several words.
1327 *
1328 * For example, when evaluating the modifier ':M*b' in ${:Ua b c:M*b}, the
1329 * callback is called 3 times, once for "a", "b" and "c".
1330 *
1331 * Some ModifyWord functions assume that they are always passed a
1332 * null-terminated substring, which is currently guaranteed but may change in
1333 * the future.
1334 */
1335 typedef void (*ModifyWordProc)(Substring word, SepBuf *buf, void *data);
1336
1337
1338 /*
1339 * Callback for ModifyWords to implement the :H modifier.
1340 * Add the dirname of the given word to the buffer.
1341 */
1342 /*ARGSUSED*/
1343 static void
1344 ModifyWord_Head(Substring word, SepBuf *buf, void *dummy MAKE_ATTR_UNUSED)
1345 {
1346 SepBuf_AddSubstring(buf, Substring_Dirname(word));
1347 }
1348
1349 /*
1350 * Callback for ModifyWords to implement the :T modifier.
1351 * Add the basename of the given word to the buffer.
1352 */
1353 /*ARGSUSED*/
1354 static void
1355 ModifyWord_Tail(Substring word, SepBuf *buf, void *dummy MAKE_ATTR_UNUSED)
1356 {
1357 SepBuf_AddSubstring(buf, Substring_Basename(word));
1358 }
1359
1360 /*
1361 * Callback for ModifyWords to implement the :E modifier.
1362 * Add the filename suffix of the given word to the buffer, if it exists.
1363 */
1364 /*ARGSUSED*/
1365 static void
1366 ModifyWord_Suffix(Substring word, SepBuf *buf, void *dummy MAKE_ATTR_UNUSED)
1367 {
1368 const char *lastDot = Substring_LastIndex(word, '.');
1369 if (lastDot != NULL)
1370 SepBuf_AddBytesBetween(buf, lastDot + 1, word.end);
1371 }
1372
1373 /*
1374 * Callback for ModifyWords to implement the :R modifier.
1375 * Add the filename without extension of the given word to the buffer.
1376 */
1377 /*ARGSUSED*/
1378 static void
1379 ModifyWord_Root(Substring word, SepBuf *buf, void *dummy MAKE_ATTR_UNUSED)
1380 {
1381 const char *lastDot, *end;
1382
1383 lastDot = Substring_LastIndex(word, '.');
1384 end = lastDot != NULL ? lastDot : word.end;
1385 SepBuf_AddBytesBetween(buf, word.start, end);
1386 }
1387
1388 /*
1389 * Callback for ModifyWords to implement the :M modifier.
1390 * Place the word in the buffer if it matches the given pattern.
1391 */
1392 static void
1393 ModifyWord_Match(Substring word, SepBuf *buf, void *data)
1394 {
1395 const char *pattern = data;
1396
1397 assert(word.end[0] == '\0'); /* assume null-terminated word */
1398 if (Str_Match(word.start, pattern))
1399 SepBuf_AddSubstring(buf, word);
1400 }
1401
1402 /*
1403 * Callback for ModifyWords to implement the :N modifier.
1404 * Place the word in the buffer if it doesn't match the given pattern.
1405 */
1406 static void
1407 ModifyWord_NoMatch(Substring word, SepBuf *buf, void *data)
1408 {
1409 const char *pattern = data;
1410
1411 assert(word.end[0] == '\0'); /* assume null-terminated word */
1412 if (!Str_Match(word.start, pattern))
1413 SepBuf_AddSubstring(buf, word);
1414 }
1415
1416 #ifdef SYSVVARSUB
1417 struct ModifyWord_SysVSubstArgs {
1418 GNode *scope;
1419 Substring lhsPrefix;
1420 bool lhsPercent;
1421 Substring lhsSuffix;
1422 const char *rhs;
1423 };
1424
1425 /* Callback for ModifyWords to implement the :%.from=%.to modifier. */
1426 static void
1427 ModifyWord_SysVSubst(Substring word, SepBuf *buf, void *data)
1428 {
1429 const struct ModifyWord_SysVSubstArgs *args = data;
1430 FStr rhs;
1431 const char *percent;
1432
1433 if (Substring_IsEmpty(word))
1434 return;
1435
1436 if (!Substring_HasPrefix(word, args->lhsPrefix) ||
1437 !Substring_HasSuffix(word, args->lhsSuffix)) {
1438 SepBuf_AddSubstring(buf, word);
1439 return;
1440 }
1441
1442 rhs = FStr_InitRefer(args->rhs);
1443 Var_Expand(&rhs, args->scope, VARE_WANTRES);
1444
1445 percent = args->lhsPercent ? strchr(rhs.str, '%') : NULL;
1446
1447 if (percent != NULL)
1448 SepBuf_AddBytesBetween(buf, rhs.str, percent);
1449 if (percent != NULL || !args->lhsPercent)
1450 SepBuf_AddBytesBetween(buf,
1451 word.start + Substring_Length(args->lhsPrefix),
1452 word.end - Substring_Length(args->lhsSuffix));
1453 SepBuf_AddStr(buf, percent != NULL ? percent + 1 : rhs.str);
1454
1455 FStr_Done(&rhs);
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 char *
2707 ParseModifier_Match(const char **pp, const ModChain *ch)
2708 {
2709 const char *mod = *pp;
2710 Expr *expr = ch->expr;
2711 bool copy = false; /* pattern should be, or has been, copied */
2712 bool needSubst = false;
2713 const char *endpat;
2714 char *pattern;
2715
2716 /*
2717 * In the loop below, ignore ':' unless we are at (or back to) the
2718 * original brace level.
2719 * XXX: This will likely not work right if $() and ${} are intermixed.
2720 */
2721 /*
2722 * XXX: This code is similar to the one in Var_Parse.
2723 * See if the code can be merged.
2724 * See also ApplyModifier_Defined.
2725 */
2726 int nest = 0;
2727 const char *p;
2728 for (p = mod + 1; *p != '\0' && !(*p == ':' && nest == 0); p++) {
2729 if (*p == '\\' &&
2730 (IsDelimiter(p[1], ch) || p[1] == ch->startc)) {
2731 if (!needSubst)
2732 copy = true;
2733 p++;
2734 continue;
2735 }
2736 if (*p == '$')
2737 needSubst = true;
2738 if (*p == '(' || *p == '{')
2739 nest++;
2740 if (*p == ')' || *p == '}') {
2741 nest--;
2742 if (nest < 0)
2743 break;
2744 }
2745 }
2746 *pp = p;
2747 endpat = p;
2748
2749 if (copy) {
2750 char *dst;
2751 const char *src;
2752
2753 /* Compress the \:'s out of the pattern. */
2754 pattern = bmake_malloc((size_t)(endpat - (mod + 1)) + 1);
2755 dst = pattern;
2756 src = mod + 1;
2757 for (; src < endpat; src++, dst++) {
2758 if (src[0] == '\\' && src + 1 < endpat &&
2759 /* XXX: ch->startc is missing here; see above */
2760 IsDelimiter(src[1], ch))
2761 src++;
2762 *dst = *src;
2763 }
2764 *dst = '\0';
2765 } else {
2766 pattern = bmake_strsedup(mod + 1, endpat);
2767 }
2768
2769 if (needSubst) {
2770 char *old_pattern = pattern;
2771 /*
2772 * XXX: Contrary to ParseModifierPart, a dollar in a ':M' or
2773 * ':N' modifier must be escaped as '$$', not as '\$'.
2774 */
2775 (void)Var_Subst(pattern, expr->scope, expr->emode, &pattern);
2776 /* TODO: handle errors */
2777 free(old_pattern);
2778 }
2779
2780 DEBUG2(VAR, "Pattern for ':%c' is \"%s\"\n", mod[0], pattern);
2781
2782 return pattern;
2783 }
2784
2785 /* :Mpattern or :Npattern */
2786 static ApplyModifierResult
2787 ApplyModifier_Match(const char **pp, ModChain *ch)
2788 {
2789 char mod = **pp;
2790 char *pattern;
2791
2792 pattern = ParseModifier_Match(pp, ch);
2793
2794 if (ModChain_ShouldEval(ch)) {
2795 ModifyWordProc modifyWord =
2796 mod == 'M' ? ModifyWord_Match : ModifyWord_NoMatch;
2797 ModifyWords(ch, modifyWord, pattern, ch->oneBigWord);
2798 }
2799
2800 free(pattern);
2801 return AMR_OK;
2802 }
2803
2804 static void
2805 ParsePatternFlags(const char **pp, PatternFlags *pflags, bool *oneBigWord)
2806 {
2807 for (;; (*pp)++) {
2808 if (**pp == 'g')
2809 pflags->subGlobal = true;
2810 else if (**pp == '1')
2811 pflags->subOnce = true;
2812 else if (**pp == 'W')
2813 *oneBigWord = true;
2814 else
2815 break;
2816 }
2817 }
2818
2819 MAKE_INLINE PatternFlags
2820 PatternFlags_None(void)
2821 {
2822 PatternFlags pflags = { false, false, false, false };
2823 return pflags;
2824 }
2825
2826 /* :S,from,to, */
2827 static ApplyModifierResult
2828 ApplyModifier_Subst(const char **pp, ModChain *ch)
2829 {
2830 struct ModifyWord_SubstArgs args;
2831 bool oneBigWord;
2832 VarParseResult res;
2833 LazyBuf lhsBuf, rhsBuf;
2834
2835 char delim = (*pp)[1];
2836 if (delim == '\0') {
2837 Error("Missing delimiter for modifier ':S'");
2838 (*pp)++;
2839 return AMR_CLEANUP;
2840 }
2841
2842 *pp += 2;
2843
2844 args.pflags = PatternFlags_None();
2845 args.matched = false;
2846
2847 if (**pp == '^') {
2848 args.pflags.anchorStart = true;
2849 (*pp)++;
2850 }
2851
2852 res = ParseModifierPartSubst(pp, delim, ch->expr->emode, ch, &lhsBuf,
2853 &args.pflags, NULL);
2854 if (res != VPR_OK)
2855 return AMR_CLEANUP;
2856 args.lhs = LazyBuf_Get(&lhsBuf);
2857
2858 res = ParseModifierPartSubst(pp, delim, ch->expr->emode, ch, &rhsBuf,
2859 NULL, &args);
2860 if (res != VPR_OK) {
2861 LazyBuf_Done(&lhsBuf);
2862 return AMR_CLEANUP;
2863 }
2864 args.rhs = LazyBuf_Get(&rhsBuf);
2865
2866 oneBigWord = ch->oneBigWord;
2867 ParsePatternFlags(pp, &args.pflags, &oneBigWord);
2868
2869 ModifyWords(ch, ModifyWord_Subst, &args, oneBigWord);
2870
2871 LazyBuf_Done(&lhsBuf);
2872 LazyBuf_Done(&rhsBuf);
2873 return AMR_OK;
2874 }
2875
2876 #ifndef NO_REGEX
2877
2878 /* :C,from,to, */
2879 static ApplyModifierResult
2880 ApplyModifier_Regex(const char **pp, ModChain *ch)
2881 {
2882 struct ModifyWord_SubstRegexArgs args;
2883 bool oneBigWord;
2884 int error;
2885 VarParseResult res;
2886 LazyBuf reBuf, replaceBuf;
2887 FStr re;
2888
2889 char delim = (*pp)[1];
2890 if (delim == '\0') {
2891 Error("Missing delimiter for :C modifier");
2892 (*pp)++;
2893 return AMR_CLEANUP;
2894 }
2895
2896 *pp += 2;
2897
2898 res = ParseModifierPart(pp, delim, ch->expr->emode, ch, &reBuf);
2899 if (res != VPR_OK)
2900 return AMR_CLEANUP;
2901 re = LazyBuf_DoneGet(&reBuf);
2902
2903 res = ParseModifierPart(pp, delim, ch->expr->emode, ch, &replaceBuf);
2904 if (res != VPR_OK) {
2905 FStr_Done(&re);
2906 return AMR_CLEANUP;
2907 }
2908 args.replace = LazyBuf_Get(&replaceBuf);
2909
2910 args.pflags = PatternFlags_None();
2911 args.matched = false;
2912 oneBigWord = ch->oneBigWord;
2913 ParsePatternFlags(pp, &args.pflags, &oneBigWord);
2914
2915 if (!ModChain_ShouldEval(ch)) {
2916 LazyBuf_Done(&replaceBuf);
2917 FStr_Done(&re);
2918 return AMR_OK;
2919 }
2920
2921 error = regcomp(&args.re, re.str, REG_EXTENDED);
2922 if (error != 0) {
2923 VarREError(error, &args.re, "Regex compilation error");
2924 LazyBuf_Done(&replaceBuf);
2925 FStr_Done(&re);
2926 return AMR_CLEANUP;
2927 }
2928
2929 args.nsub = args.re.re_nsub + 1;
2930 if (args.nsub > 10)
2931 args.nsub = 10;
2932
2933 ModifyWords(ch, ModifyWord_SubstRegex, &args, oneBigWord);
2934
2935 regfree(&args.re);
2936 LazyBuf_Done(&replaceBuf);
2937 FStr_Done(&re);
2938 return AMR_OK;
2939 }
2940
2941 #endif
2942
2943 /* :Q, :q */
2944 static ApplyModifierResult
2945 ApplyModifier_Quote(const char **pp, ModChain *ch)
2946 {
2947 LazyBuf buf;
2948 bool quoteDollar;
2949
2950 quoteDollar = **pp == 'q';
2951 if (!IsDelimiter((*pp)[1], ch))
2952 return AMR_UNKNOWN;
2953 (*pp)++;
2954
2955 if (!ModChain_ShouldEval(ch))
2956 return AMR_OK;
2957
2958 VarQuote(Expr_Str(ch->expr), quoteDollar, &buf);
2959 if (buf.data != NULL)
2960 Expr_SetValue(ch->expr, LazyBuf_DoneGet(&buf));
2961 else
2962 LazyBuf_Done(&buf);
2963
2964 return AMR_OK;
2965 }
2966
2967 /*ARGSUSED*/
2968 static void
2969 ModifyWord_Copy(Substring word, SepBuf *buf, void *data MAKE_ATTR_UNUSED)
2970 {
2971 SepBuf_AddSubstring(buf, word);
2972 }
2973
2974 /* :ts<separator> */
2975 static ApplyModifierResult
2976 ApplyModifier_ToSep(const char **pp, ModChain *ch)
2977 {
2978 const char *sep = *pp + 2;
2979
2980 /*
2981 * Even in parse-only mode, proceed as normal since there is
2982 * neither any observable side effect nor a performance penalty.
2983 * Checking for wantRes for every single piece of code in here
2984 * would make the code in this function too hard to read.
2985 */
2986
2987 /* ":ts<any><endc>" or ":ts<any>:" */
2988 if (sep[0] != ch->endc && IsDelimiter(sep[1], ch)) {
2989 *pp = sep + 1;
2990 ch->sep = sep[0];
2991 goto ok;
2992 }
2993
2994 /* ":ts<endc>" or ":ts:" */
2995 if (IsDelimiter(sep[0], ch)) {
2996 *pp = sep;
2997 ch->sep = '\0'; /* no separator */
2998 goto ok;
2999 }
3000
3001 /* ":ts<unrecognised><unrecognised>". */
3002 if (sep[0] != '\\') {
3003 (*pp)++; /* just for backwards compatibility */
3004 return AMR_BAD;
3005 }
3006
3007 /* ":ts\n" */
3008 if (sep[1] == 'n') {
3009 *pp = sep + 2;
3010 ch->sep = '\n';
3011 goto ok;
3012 }
3013
3014 /* ":ts\t" */
3015 if (sep[1] == 't') {
3016 *pp = sep + 2;
3017 ch->sep = '\t';
3018 goto ok;
3019 }
3020
3021 /* ":ts\x40" or ":ts\100" */
3022 {
3023 const char *p = sep + 1;
3024 int base = 8; /* assume octal */
3025
3026 if (sep[1] == 'x') {
3027 base = 16;
3028 p++;
3029 } else if (!ch_isdigit(sep[1])) {
3030 (*pp)++; /* just for backwards compatibility */
3031 return AMR_BAD; /* ":ts<backslash><unrecognised>". */
3032 }
3033
3034 if (!TryParseChar(&p, base, &ch->sep)) {
3035 Parse_Error(PARSE_FATAL,
3036 "Invalid character number at \"%s\"", p);
3037 return AMR_CLEANUP;
3038 }
3039 if (!IsDelimiter(*p, ch)) {
3040 (*pp)++; /* just for backwards compatibility */
3041 return AMR_BAD;
3042 }
3043
3044 *pp = p;
3045 }
3046
3047 ok:
3048 ModifyWords(ch, ModifyWord_Copy, NULL, ch->oneBigWord);
3049 return AMR_OK;
3050 }
3051
3052 static char *
3053 str_toupper(const char *str)
3054 {
3055 char *res;
3056 size_t i, len;
3057
3058 len = strlen(str);
3059 res = bmake_malloc(len + 1);
3060 for (i = 0; i < len + 1; i++)
3061 res[i] = ch_toupper(str[i]);
3062
3063 return res;
3064 }
3065
3066 static char *
3067 str_tolower(const char *str)
3068 {
3069 char *res;
3070 size_t i, len;
3071
3072 len = strlen(str);
3073 res = bmake_malloc(len + 1);
3074 for (i = 0; i < len + 1; i++)
3075 res[i] = ch_tolower(str[i]);
3076
3077 return res;
3078 }
3079
3080 /* :tA, :tu, :tl, :ts<separator>, etc. */
3081 static ApplyModifierResult
3082 ApplyModifier_To(const char **pp, ModChain *ch)
3083 {
3084 Expr *expr = ch->expr;
3085 const char *mod = *pp;
3086 assert(mod[0] == 't');
3087
3088 if (IsDelimiter(mod[1], ch) || mod[1] == '\0') {
3089 *pp = mod + 1;
3090 return AMR_BAD; /* Found ":t<endc>" or ":t:". */
3091 }
3092
3093 if (mod[1] == 's')
3094 return ApplyModifier_ToSep(pp, ch);
3095
3096 if (!IsDelimiter(mod[2], ch)) { /* :t<unrecognized> */
3097 *pp = mod + 1;
3098 return AMR_BAD;
3099 }
3100
3101 if (mod[1] == 'A') { /* :tA */
3102 *pp = mod + 2;
3103 ModifyWords(ch, ModifyWord_Realpath, NULL, ch->oneBigWord);
3104 return AMR_OK;
3105 }
3106
3107 if (mod[1] == 'u') { /* :tu */
3108 *pp = mod + 2;
3109 if (Expr_ShouldEval(expr))
3110 Expr_SetValueOwn(expr, str_toupper(Expr_Str(expr)));
3111 return AMR_OK;
3112 }
3113
3114 if (mod[1] == 'l') { /* :tl */
3115 *pp = mod + 2;
3116 if (Expr_ShouldEval(expr))
3117 Expr_SetValueOwn(expr, str_tolower(Expr_Str(expr)));
3118 return AMR_OK;
3119 }
3120
3121 if (mod[1] == 'W' || mod[1] == 'w') { /* :tW, :tw */
3122 *pp = mod + 2;
3123 ch->oneBigWord = mod[1] == 'W';
3124 return AMR_OK;
3125 }
3126
3127 /* Found ":t<unrecognised>:" or ":t<unrecognised><endc>". */
3128 *pp = mod + 1; /* XXX: unnecessary but observable */
3129 return AMR_BAD;
3130 }
3131
3132 /* :[#], :[1], :[-1..1], etc. */
3133 static ApplyModifierResult
3134 ApplyModifier_Words(const char **pp, ModChain *ch)
3135 {
3136 Expr *expr = ch->expr;
3137 const char *estr;
3138 int first, last;
3139 VarParseResult res;
3140 const char *p;
3141 LazyBuf estrBuf;
3142 FStr festr;
3143
3144 (*pp)++; /* skip the '[' */
3145 res = ParseModifierPart(pp, ']', expr->emode, ch, &estrBuf);
3146 if (res != VPR_OK)
3147 return AMR_CLEANUP;
3148 festr = LazyBuf_DoneGet(&estrBuf);
3149 estr = festr.str;
3150
3151 if (!IsDelimiter(**pp, ch))
3152 goto bad_modifier; /* Found junk after ']' */
3153
3154 if (!ModChain_ShouldEval(ch))
3155 goto ok;
3156
3157 if (estr[0] == '\0')
3158 goto bad_modifier; /* Found ":[]". */
3159
3160 if (estr[0] == '#' && estr[1] == '\0') { /* Found ":[#]" */
3161 if (ch->oneBigWord) {
3162 Expr_SetValueRefer(expr, "1");
3163 } else {
3164 Buffer buf;
3165
3166 SubstringWords words = Expr_Words(expr);
3167 size_t ac = words.len;
3168 SubstringWords_Free(words);
3169
3170 /* 3 digits + '\0' is usually enough */
3171 Buf_InitSize(&buf, 4);
3172 Buf_AddInt(&buf, (int)ac);
3173 Expr_SetValueOwn(expr, Buf_DoneData(&buf));
3174 }
3175 goto ok;
3176 }
3177
3178 if (estr[0] == '*' && estr[1] == '\0') { /* Found ":[*]" */
3179 ch->oneBigWord = true;
3180 goto ok;
3181 }
3182
3183 if (estr[0] == '@' && estr[1] == '\0') { /* Found ":[@]" */
3184 ch->oneBigWord = false;
3185 goto ok;
3186 }
3187
3188 /*
3189 * We expect estr to contain a single integer for :[N], or two
3190 * integers separated by ".." for :[start..end].
3191 */
3192 p = estr;
3193 if (!TryParseIntBase0(&p, &first))
3194 goto bad_modifier; /* Found junk instead of a number */
3195
3196 if (p[0] == '\0') { /* Found only one integer in :[N] */
3197 last = first;
3198 } else if (p[0] == '.' && p[1] == '.' && p[2] != '\0') {
3199 /* Expecting another integer after ".." */
3200 p += 2;
3201 if (!TryParseIntBase0(&p, &last) || *p != '\0')
3202 goto bad_modifier; /* Found junk after ".." */
3203 } else
3204 goto bad_modifier; /* Found junk instead of ".." */
3205
3206 /*
3207 * Now first and last are properly filled in, but we still have to
3208 * check for 0 as a special case.
3209 */
3210 if (first == 0 && last == 0) {
3211 /* ":[0]" or perhaps ":[0..0]" */
3212 ch->oneBigWord = true;
3213 goto ok;
3214 }
3215
3216 /* ":[0..N]" or ":[N..0]" */
3217 if (first == 0 || last == 0)
3218 goto bad_modifier;
3219
3220 /* Normal case: select the words described by first and last. */
3221 Expr_SetValueOwn(expr,
3222 VarSelectWords(Expr_Str(expr), first, last,
3223 ch->sep, ch->oneBigWord));
3224
3225 ok:
3226 FStr_Done(&festr);
3227 return AMR_OK;
3228
3229 bad_modifier:
3230 FStr_Done(&festr);
3231 return AMR_BAD;
3232 }
3233
3234 #if __STDC_VERSION__ >= 199901L
3235 # define NUM_TYPE long long
3236 # define PARSE_NUM_TYPE strtoll
3237 #else
3238 # define NUM_TYPE long
3239 # define PARSE_NUM_TYPE strtol
3240 #endif
3241
3242 static NUM_TYPE
3243 num_val(Substring s)
3244 {
3245 NUM_TYPE val;
3246 char *ep;
3247
3248 val = PARSE_NUM_TYPE(s.start, &ep, 0);
3249 if (ep != s.start) {
3250 switch (*ep) {
3251 case 'K':
3252 case 'k':
3253 val <<= 10;
3254 break;
3255 case 'M':
3256 case 'm':
3257 val <<= 20;
3258 break;
3259 case 'G':
3260 case 'g':
3261 val <<= 30;
3262 break;
3263 }
3264 }
3265 return val;
3266 }
3267
3268 static int
3269 SubNumAsc(const void *sa, const void *sb)
3270 {
3271 NUM_TYPE a, b;
3272
3273 a = num_val(*((const Substring *)sa));
3274 b = num_val(*((const Substring *)sb));
3275 return (a > b) ? 1 : (b > a) ? -1 : 0;
3276 }
3277
3278 static int
3279 SubNumDesc(const void *sa, const void *sb)
3280 {
3281 return SubNumAsc(sb, sa);
3282 }
3283
3284 static int
3285 SubStrAsc(const void *sa, const void *sb)
3286 {
3287 return strcmp(
3288 ((const Substring *)sa)->start, ((const Substring *)sb)->start);
3289 }
3290
3291 static int
3292 SubStrDesc(const void *sa, const void *sb)
3293 {
3294 return SubStrAsc(sb, sa);
3295 }
3296
3297 static void
3298 ShuffleSubstrings(Substring *strs, size_t n)
3299 {
3300 size_t i;
3301
3302 for (i = n - 1; i > 0; i--) {
3303 size_t rndidx = (size_t)random() % (i + 1);
3304 Substring t = strs[i];
3305 strs[i] = strs[rndidx];
3306 strs[rndidx] = t;
3307 }
3308 }
3309
3310 /*
3311 * :O order ascending
3312 * :Or order descending
3313 * :Ox shuffle
3314 * :On numeric ascending
3315 * :Onr, :Orn numeric descending
3316 */
3317 static ApplyModifierResult
3318 ApplyModifier_Order(const char **pp, ModChain *ch)
3319 {
3320 const char *mod = *pp;
3321 SubstringWords words;
3322 int (*cmp)(const void *, const void *);
3323
3324 if (IsDelimiter(mod[1], ch) || mod[1] == '\0') {
3325 cmp = SubStrAsc;
3326 (*pp)++;
3327 } else if (IsDelimiter(mod[2], ch) || mod[2] == '\0') {
3328 if (mod[1] == 'n')
3329 cmp = SubNumAsc;
3330 else if (mod[1] == 'r')
3331 cmp = SubStrDesc;
3332 else if (mod[1] == 'x')
3333 cmp = NULL;
3334 else
3335 goto bad;
3336 *pp += 2;
3337 } else if (IsDelimiter(mod[3], ch) || mod[3] == '\0') {
3338 if ((mod[1] == 'n' && mod[2] == 'r') ||
3339 (mod[1] == 'r' && mod[2] == 'n'))
3340 cmp = SubNumDesc;
3341 else
3342 goto bad;
3343 *pp += 3;
3344 } else
3345 goto bad;
3346
3347 if (!ModChain_ShouldEval(ch))
3348 return AMR_OK;
3349
3350 words = Expr_Words(ch->expr);
3351 if (cmp == NULL)
3352 ShuffleSubstrings(words.words, words.len);
3353 else {
3354 assert(words.words[0].end[0] == '\0');
3355 qsort(words.words, words.len, sizeof(words.words[0]), cmp);
3356 }
3357 Expr_SetValueOwn(ch->expr, SubstringWords_JoinFree(words));
3358
3359 return AMR_OK;
3360
3361 bad:
3362 (*pp)++;
3363 return AMR_BAD;
3364 }
3365
3366 /* :? then : else */
3367 static ApplyModifierResult
3368 ApplyModifier_IfElse(const char **pp, ModChain *ch)
3369 {
3370 Expr *expr = ch->expr;
3371 VarParseResult res;
3372 LazyBuf thenBuf;
3373 LazyBuf elseBuf;
3374
3375 VarEvalMode then_emode = VARE_PARSE_ONLY;
3376 VarEvalMode else_emode = VARE_PARSE_ONLY;
3377
3378 CondResult cond_rc = CR_TRUE; /* just not CR_ERROR */
3379 if (Expr_ShouldEval(expr)) {
3380 cond_rc = Cond_EvalCondition(expr->name);
3381 if (cond_rc == CR_TRUE)
3382 then_emode = expr->emode;
3383 if (cond_rc == CR_FALSE)
3384 else_emode = expr->emode;
3385 }
3386
3387 (*pp)++; /* skip past the '?' */
3388 res = ParseModifierPart(pp, ':', then_emode, ch, &thenBuf);
3389 if (res != VPR_OK)
3390 return AMR_CLEANUP;
3391
3392 res = ParseModifierPart(pp, ch->endc, else_emode, ch, &elseBuf);
3393 if (res != VPR_OK) {
3394 LazyBuf_Done(&thenBuf);
3395 return AMR_CLEANUP;
3396 }
3397
3398 (*pp)--; /* Go back to the ch->endc. */
3399
3400 if (cond_rc == CR_ERROR) {
3401 Substring thenExpr = LazyBuf_Get(&thenBuf);
3402 Substring elseExpr = LazyBuf_Get(&elseBuf);
3403 Error("Bad conditional expression '%s' in '%s?%.*s:%.*s'",
3404 expr->name, expr->name,
3405 (int)Substring_Length(thenExpr), thenExpr.start,
3406 (int)Substring_Length(elseExpr), elseExpr.start);
3407 LazyBuf_Done(&thenBuf);
3408 LazyBuf_Done(&elseBuf);
3409 return AMR_CLEANUP;
3410 }
3411
3412 if (!Expr_ShouldEval(expr)) {
3413 LazyBuf_Done(&thenBuf);
3414 LazyBuf_Done(&elseBuf);
3415 } else if (cond_rc == CR_TRUE) {
3416 Expr_SetValue(expr, LazyBuf_DoneGet(&thenBuf));
3417 LazyBuf_Done(&elseBuf);
3418 } else {
3419 LazyBuf_Done(&thenBuf);
3420 Expr_SetValue(expr, LazyBuf_DoneGet(&elseBuf));
3421 }
3422 Expr_Define(expr);
3423 return AMR_OK;
3424 }
3425
3426 /*
3427 * The ::= modifiers are special in that they do not read the variable value
3428 * but instead assign to that variable. They always expand to an empty
3429 * string.
3430 *
3431 * Their main purpose is in supporting .for loops that generate shell commands
3432 * since an ordinary variable assignment at that point would terminate the
3433 * dependency group for these targets. For example:
3434 *
3435 * list-targets: .USE
3436 * .for i in ${.TARGET} ${.TARGET:R}.gz
3437 * @${t::=$i}
3438 * @echo 'The target is ${t:T}.'
3439 * .endfor
3440 *
3441 * ::=<str> Assigns <str> as the new value of variable.
3442 * ::?=<str> Assigns <str> as value of variable if
3443 * it was not already set.
3444 * ::+=<str> Appends <str> to variable.
3445 * ::!=<cmd> Assigns output of <cmd> as the new value of
3446 * variable.
3447 */
3448 static ApplyModifierResult
3449 ApplyModifier_Assign(const char **pp, ModChain *ch)
3450 {
3451 Expr *expr = ch->expr;
3452 GNode *scope;
3453 FStr val;
3454 VarParseResult res;
3455 LazyBuf buf;
3456
3457 const char *mod = *pp;
3458 const char *op = mod + 1;
3459
3460 if (op[0] == '=')
3461 goto found_op;
3462 if ((op[0] == '+' || op[0] == '?' || op[0] == '!') && op[1] == '=')
3463 goto found_op;
3464 return AMR_UNKNOWN; /* "::<unrecognised>" */
3465
3466 found_op:
3467 if (expr->name[0] == '\0') {
3468 *pp = mod + 1;
3469 return AMR_BAD;
3470 }
3471
3472 *pp = mod + (op[0] == '+' || op[0] == '?' || op[0] == '!' ? 3 : 2);
3473
3474 res = ParseModifierPart(pp, ch->endc, expr->emode, ch, &buf);
3475 if (res != VPR_OK)
3476 return AMR_CLEANUP;
3477 val = LazyBuf_DoneGet(&buf);
3478
3479 (*pp)--; /* Go back to the ch->endc. */
3480
3481 if (!Expr_ShouldEval(expr))
3482 goto done;
3483
3484 scope = expr->scope; /* scope where v belongs */
3485 if (expr->defined == DEF_REGULAR && expr->scope != SCOPE_GLOBAL) {
3486 Var *v = VarFind(expr->name, expr->scope, false);
3487 if (v == NULL)
3488 scope = SCOPE_GLOBAL;
3489 else
3490 VarFreeShortLived(v);
3491 }
3492
3493 if (op[0] == '+')
3494 Var_Append(scope, expr->name, val.str);
3495 else if (op[0] == '!') {
3496 char *output, *error;
3497 output = Cmd_Exec(val.str, &error);
3498 if (error != NULL) {
3499 Error("%s", error);
3500 free(error);
3501 } else
3502 Var_Set(scope, expr->name, output);
3503 free(output);
3504 } else if (op[0] == '?' && expr->defined == DEF_REGULAR) {
3505 /* Do nothing. */
3506 } else
3507 Var_Set(scope, expr->name, val.str);
3508
3509 Expr_SetValueRefer(expr, "");
3510
3511 done:
3512 FStr_Done(&val);
3513 return AMR_OK;
3514 }
3515
3516 /*
3517 * :_=...
3518 * remember current value
3519 */
3520 static ApplyModifierResult
3521 ApplyModifier_Remember(const char **pp, ModChain *ch)
3522 {
3523 Expr *expr = ch->expr;
3524 const char *mod = *pp;
3525 FStr name;
3526
3527 if (!ModMatchEq(mod, "_", ch))
3528 return AMR_UNKNOWN;
3529
3530 name = FStr_InitRefer("_");
3531 if (mod[1] == '=') {
3532 /*
3533 * XXX: This ad-hoc call to strcspn deviates from the usual
3534 * behavior defined in ParseModifierPart. This creates an
3535 * unnecessary, undocumented inconsistency in make.
3536 */
3537 const char *arg = mod + 2;
3538 size_t argLen = strcspn(arg, ":)}");
3539 *pp = arg + argLen;
3540 name = FStr_InitOwn(bmake_strldup(arg, argLen));
3541 } else
3542 *pp = mod + 1;
3543
3544 if (Expr_ShouldEval(expr))
3545 Var_Set(expr->scope, name.str, Expr_Str(expr));
3546 FStr_Done(&name);
3547
3548 return AMR_OK;
3549 }
3550
3551 /*
3552 * Apply the given function to each word of the variable value,
3553 * for a single-letter modifier such as :H, :T.
3554 */
3555 static ApplyModifierResult
3556 ApplyModifier_WordFunc(const char **pp, ModChain *ch,
3557 ModifyWordProc modifyWord)
3558 {
3559 if (!IsDelimiter((*pp)[1], ch))
3560 return AMR_UNKNOWN;
3561 (*pp)++;
3562
3563 if (ModChain_ShouldEval(ch))
3564 ModifyWords(ch, modifyWord, NULL, ch->oneBigWord);
3565
3566 return AMR_OK;
3567 }
3568
3569 /* Remove adjacent duplicate words. */
3570 static ApplyModifierResult
3571 ApplyModifier_Unique(const char **pp, ModChain *ch)
3572 {
3573 SubstringWords words;
3574
3575 if (!IsDelimiter((*pp)[1], ch))
3576 return AMR_UNKNOWN;
3577 (*pp)++;
3578
3579 if (!ModChain_ShouldEval(ch))
3580 return AMR_OK;
3581
3582 words = Expr_Words(ch->expr);
3583
3584 if (words.len > 1) {
3585 size_t si, di;
3586
3587 di = 0;
3588 for (si = 1; si < words.len; si++) {
3589 if (!Substring_Eq(words.words[si], words.words[di])) {
3590 di++;
3591 if (di != si)
3592 words.words[di] = words.words[si];
3593 }
3594 }
3595 words.len = di + 1;
3596 }
3597
3598 Expr_SetValueOwn(ch->expr, SubstringWords_JoinFree(words));
3599
3600 return AMR_OK;
3601 }
3602
3603 #ifdef SYSVVARSUB
3604 /* :from=to */
3605 static ApplyModifierResult
3606 ApplyModifier_SysV(const char **pp, ModChain *ch)
3607 {
3608 Expr *expr = ch->expr;
3609 VarParseResult res;
3610 LazyBuf lhsBuf, rhsBuf;
3611 FStr rhs;
3612 struct ModifyWord_SysVSubstArgs args;
3613 Substring lhs;
3614 const char *lhsSuffix;
3615
3616 const char *mod = *pp;
3617 bool eqFound = false;
3618
3619 /*
3620 * First we make a pass through the string trying to verify it is a
3621 * SysV-make-style translation. It must be: <lhs>=<rhs>
3622 */
3623 int depth = 1;
3624 const char *p = mod;
3625 while (*p != '\0' && depth > 0) {
3626 if (*p == '=') { /* XXX: should also test depth == 1 */
3627 eqFound = true;
3628 /* continue looking for ch->endc */
3629 } else if (*p == ch->endc)
3630 depth--;
3631 else if (*p == ch->startc)
3632 depth++;
3633 if (depth > 0)
3634 p++;
3635 }
3636 if (*p != ch->endc || !eqFound)
3637 return AMR_UNKNOWN;
3638
3639 res = ParseModifierPart(pp, '=', expr->emode, ch, &lhsBuf);
3640 if (res != VPR_OK)
3641 return AMR_CLEANUP;
3642
3643 /*
3644 * The SysV modifier lasts until the end of the variable expression.
3645 */
3646 res = ParseModifierPart(pp, ch->endc, expr->emode, ch, &rhsBuf);
3647 if (res != VPR_OK) {
3648 LazyBuf_Done(&lhsBuf);
3649 return AMR_CLEANUP;
3650 }
3651 rhs = LazyBuf_DoneGet(&rhsBuf);
3652
3653 (*pp)--; /* Go back to the ch->endc. */
3654
3655 /* Do not turn an empty expression into non-empty. */
3656 if (lhsBuf.len == 0 && Expr_Str(expr)[0] == '\0')
3657 goto done;
3658
3659 lhs = LazyBuf_Get(&lhsBuf);
3660 lhsSuffix = Substring_SkipFirst(lhs, '%');
3661
3662 args.scope = expr->scope;
3663 args.lhsPrefix = Substring_Init(lhs.start,
3664 lhsSuffix != lhs.start ? lhsSuffix - 1 : lhs.start);
3665 args.lhsPercent = lhsSuffix != lhs.start;
3666 args.lhsSuffix = Substring_Init(lhsSuffix, lhs.end);
3667 args.rhs = rhs.str;
3668
3669 ModifyWords(ch, ModifyWord_SysVSubst, &args, ch->oneBigWord);
3670
3671 done:
3672 LazyBuf_Done(&lhsBuf);
3673 return AMR_OK;
3674 }
3675 #endif
3676
3677 #ifdef SUNSHCMD
3678 /* :sh */
3679 static ApplyModifierResult
3680 ApplyModifier_SunShell(const char **pp, ModChain *ch)
3681 {
3682 Expr *expr = ch->expr;
3683 const char *p = *pp;
3684 if (!(p[1] == 'h' && IsDelimiter(p[2], ch)))
3685 return AMR_UNKNOWN;
3686 *pp = p + 2;
3687
3688 if (Expr_ShouldEval(expr)) {
3689 char *output, *error;
3690 output = Cmd_Exec(Expr_Str(expr), &error);
3691 if (error != NULL) {
3692 Error("%s", error);
3693 free(error);
3694 }
3695 Expr_SetValueOwn(expr, output);
3696 }
3697
3698 return AMR_OK;
3699 }
3700 #endif
3701
3702 static void
3703 LogBeforeApply(const ModChain *ch, const char *mod)
3704 {
3705 const Expr *expr = ch->expr;
3706 bool is_single_char = mod[0] != '\0' && IsDelimiter(mod[1], ch);
3707
3708 /*
3709 * At this point, only the first character of the modifier can
3710 * be used since the end of the modifier is not yet known.
3711 */
3712
3713 if (!Expr_ShouldEval(expr)) {
3714 debug_printf("Parsing modifier ${%s:%c%s}\n",
3715 expr->name, mod[0], is_single_char ? "" : "...");
3716 return;
3717 }
3718
3719 if ((expr->emode == VARE_WANTRES || expr->emode == VARE_UNDEFERR) &&
3720 expr->defined == DEF_REGULAR) {
3721 debug_printf(
3722 "Evaluating modifier ${%s:%c%s} on value \"%s\"\n",
3723 expr->name, mod[0], is_single_char ? "" : "...",
3724 Expr_Str(expr));
3725 return;
3726 }
3727
3728 debug_printf(
3729 "Evaluating modifier ${%s:%c%s} on value \"%s\" (%s, %s)\n",
3730 expr->name, mod[0], is_single_char ? "" : "...", Expr_Str(expr),
3731 VarEvalMode_Name[expr->emode], ExprDefined_Name[expr->defined]);
3732 }
3733
3734 static void
3735 LogAfterApply(const ModChain *ch, const char *p, const char *mod)
3736 {
3737 const Expr *expr = ch->expr;
3738 const char *value = Expr_Str(expr);
3739 const char *quot = value == var_Error ? "" : "\"";
3740
3741 if ((expr->emode == VARE_WANTRES || expr->emode == VARE_UNDEFERR) &&
3742 expr->defined == DEF_REGULAR) {
3743
3744 debug_printf("Result of ${%s:%.*s} is %s%s%s\n",
3745 expr->name, (int)(p - mod), mod,
3746 quot, value == var_Error ? "error" : value, quot);
3747 return;
3748 }
3749
3750 debug_printf("Result of ${%s:%.*s} is %s%s%s (%s, %s)\n",
3751 expr->name, (int)(p - mod), mod,
3752 quot, value == var_Error ? "error" : value, quot,
3753 VarEvalMode_Name[expr->emode],
3754 ExprDefined_Name[expr->defined]);
3755 }
3756
3757 static ApplyModifierResult
3758 ApplyModifier(const char **pp, ModChain *ch)
3759 {
3760 switch (**pp) {
3761 case '!':
3762 return ApplyModifier_ShellCommand(pp, ch);
3763 case ':':
3764 return ApplyModifier_Assign(pp, ch);
3765 case '?':
3766 return ApplyModifier_IfElse(pp, ch);
3767 case '@':
3768 return ApplyModifier_Loop(pp, ch);
3769 case '[':
3770 return ApplyModifier_Words(pp, ch);
3771 case '_':
3772 return ApplyModifier_Remember(pp, ch);
3773 #ifndef NO_REGEX
3774 case 'C':
3775 return ApplyModifier_Regex(pp, ch);
3776 #endif
3777 case 'D':
3778 case 'U':
3779 return ApplyModifier_Defined(pp, ch);
3780 case 'E':
3781 return ApplyModifier_WordFunc(pp, ch, ModifyWord_Suffix);
3782 case 'g':
3783 case 'l':
3784 return ApplyModifier_Time(pp, ch);
3785 case 'H':
3786 return ApplyModifier_WordFunc(pp, ch, ModifyWord_Head);
3787 case 'h':
3788 return ApplyModifier_Hash(pp, ch);
3789 case 'L':
3790 return ApplyModifier_Literal(pp, ch);
3791 case 'M':
3792 case 'N':
3793 return ApplyModifier_Match(pp, ch);
3794 case 'O':
3795 return ApplyModifier_Order(pp, ch);
3796 case 'P':
3797 return ApplyModifier_Path(pp, ch);
3798 case 'Q':
3799 case 'q':
3800 return ApplyModifier_Quote(pp, ch);
3801 case 'R':
3802 return ApplyModifier_WordFunc(pp, ch, ModifyWord_Root);
3803 case 'r':
3804 return ApplyModifier_Range(pp, ch);
3805 case 'S':
3806 return ApplyModifier_Subst(pp, ch);
3807 #ifdef SUNSHCMD
3808 case 's':
3809 return ApplyModifier_SunShell(pp, ch);
3810 #endif
3811 case 'T':
3812 return ApplyModifier_WordFunc(pp, ch, ModifyWord_Tail);
3813 case 't':
3814 return ApplyModifier_To(pp, ch);
3815 case 'u':
3816 return ApplyModifier_Unique(pp, ch);
3817 default:
3818 return AMR_UNKNOWN;
3819 }
3820 }
3821
3822 static void ApplyModifiers(Expr *, const char **, char, char);
3823
3824 typedef enum ApplyModifiersIndirectResult {
3825 /* The indirect modifiers have been applied successfully. */
3826 AMIR_CONTINUE,
3827 /* Fall back to the SysV modifier. */
3828 AMIR_SYSV,
3829 /* Error out. */
3830 AMIR_OUT
3831 } ApplyModifiersIndirectResult;
3832
3833 /*
3834 * While expanding a variable expression, expand and apply indirect modifiers,
3835 * such as in ${VAR:${M_indirect}}.
3836 *
3837 * All indirect modifiers of a group must come from a single variable
3838 * expression. ${VAR:${M1}} is valid but ${VAR:${M1}${M2}} is not.
3839 *
3840 * Multiple groups of indirect modifiers can be chained by separating them
3841 * with colons. ${VAR:${M1}:${M2}} contains 2 indirect modifiers.
3842 *
3843 * If the variable expression is not followed by ch->endc or ':', fall
3844 * back to trying the SysV modifier, such as in ${VAR:${FROM}=${TO}}.
3845 */
3846 static ApplyModifiersIndirectResult
3847 ApplyModifiersIndirect(ModChain *ch, const char **pp)
3848 {
3849 Expr *expr = ch->expr;
3850 const char *p = *pp;
3851 FStr mods;
3852
3853 (void)Var_Parse(&p, expr->scope, expr->emode, &mods);
3854 /* TODO: handle errors */
3855
3856 if (mods.str[0] != '\0' && *p != '\0' && !IsDelimiter(*p, ch)) {
3857 FStr_Done(&mods);
3858 return AMIR_SYSV;
3859 }
3860
3861 DEBUG3(VAR, "Indirect modifier \"%s\" from \"%.*s\"\n",
3862 mods.str, (int)(p - *pp), *pp);
3863
3864 if (mods.str[0] != '\0') {
3865 const char *modsp = mods.str;
3866 ApplyModifiers(expr, &modsp, '\0', '\0');
3867 if (Expr_Str(expr) == var_Error || *modsp != '\0') {
3868 FStr_Done(&mods);
3869 *pp = p;
3870 return AMIR_OUT; /* error already reported */
3871 }
3872 }
3873 FStr_Done(&mods);
3874
3875 if (*p == ':')
3876 p++;
3877 else if (*p == '\0' && ch->endc != '\0') {
3878 Error("Unclosed variable expression after indirect "
3879 "modifier, expecting '%c' for variable \"%s\"",
3880 ch->endc, expr->name);
3881 *pp = p;
3882 return AMIR_OUT;
3883 }
3884
3885 *pp = p;
3886 return AMIR_CONTINUE;
3887 }
3888
3889 static ApplyModifierResult
3890 ApplySingleModifier(const char **pp, ModChain *ch)
3891 {
3892 ApplyModifierResult res;
3893 const char *mod = *pp;
3894 const char *p = *pp;
3895
3896 if (DEBUG(VAR))
3897 LogBeforeApply(ch, mod);
3898
3899 res = ApplyModifier(&p, ch);
3900
3901 #ifdef SYSVVARSUB
3902 if (res == AMR_UNKNOWN) {
3903 assert(p == mod);
3904 res = ApplyModifier_SysV(&p, ch);
3905 }
3906 #endif
3907
3908 if (res == AMR_UNKNOWN) {
3909 /*
3910 * Guess the end of the current modifier.
3911 * XXX: Skipping the rest of the modifier hides
3912 * errors and leads to wrong results.
3913 * Parsing should rather stop here.
3914 */
3915 for (p++; !IsDelimiter(*p, ch) && *p != '\0'; p++)
3916 continue;
3917 Parse_Error(PARSE_FATAL, "Unknown modifier \"%.*s\"",
3918 (int)(p - mod), mod);
3919 Expr_SetValueRefer(ch->expr, var_Error);
3920 }
3921 if (res == AMR_CLEANUP || res == AMR_BAD) {
3922 *pp = p;
3923 return res;
3924 }
3925
3926 if (DEBUG(VAR))
3927 LogAfterApply(ch, p, mod);
3928
3929 if (*p == '\0' && ch->endc != '\0') {
3930 Error(
3931 "Unclosed variable expression, expecting '%c' for "
3932 "modifier \"%.*s\" of variable \"%s\" with value \"%s\"",
3933 ch->endc,
3934 (int)(p - mod), mod,
3935 ch->expr->name, Expr_Str(ch->expr));
3936 } else if (*p == ':') {
3937 p++;
3938 } else if (opts.strict && *p != '\0' && *p != ch->endc) {
3939 Parse_Error(PARSE_FATAL,
3940 "Missing delimiter ':' after modifier \"%.*s\"",
3941 (int)(p - mod), mod);
3942 /*
3943 * TODO: propagate parse error to the enclosing
3944 * expression
3945 */
3946 }
3947 *pp = p;
3948 return AMR_OK;
3949 }
3950
3951 #if __STDC_VERSION__ >= 199901L
3952 #define ModChain_Literal(expr, startc, endc, sep, oneBigWord) \
3953 (ModChain) { expr, startc, endc, sep, oneBigWord }
3954 #else
3955 MAKE_INLINE ModChain
3956 ModChain_Literal(Expr *expr, char startc, char endc, char sep, bool oneBigWord)
3957 {
3958 ModChain ch;
3959 ch.expr = expr;
3960 ch.startc = startc;
3961 ch.endc = endc;
3962 ch.sep = sep;
3963 ch.oneBigWord = oneBigWord;
3964 return ch;
3965 }
3966 #endif
3967
3968 /* Apply any modifiers (such as :Mpattern or :@var@loop@ or :Q or ::=value). */
3969 static void
3970 ApplyModifiers(
3971 Expr *expr,
3972 const char **pp, /* the parsing position, updated upon return */
3973 char startc, /* '(' or '{'; or '\0' for indirect modifiers */
3974 char endc /* ')' or '}'; or '\0' for indirect modifiers */
3975 )
3976 {
3977 ModChain ch = ModChain_Literal(expr, startc, endc, ' ', false);
3978 const char *p;
3979 const char *mod;
3980
3981 assert(startc == '(' || startc == '{' || startc == '\0');
3982 assert(endc == ')' || endc == '}' || endc == '\0');
3983 assert(Expr_Str(expr) != NULL);
3984
3985 p = *pp;
3986
3987 if (*p == '\0' && endc != '\0') {
3988 Error(
3989 "Unclosed variable expression (expecting '%c') for \"%s\"",
3990 ch.endc, expr->name);
3991 goto cleanup;
3992 }
3993
3994 while (*p != '\0' && *p != endc) {
3995 ApplyModifierResult res;
3996
3997 if (*p == '$') {
3998 ApplyModifiersIndirectResult amir =
3999 ApplyModifiersIndirect(&ch, &p);
4000 if (amir == AMIR_CONTINUE)
4001 continue;
4002 if (amir == AMIR_OUT)
4003 break;
4004 /*
4005 * It's neither '${VAR}:' nor '${VAR}}'. Try to parse
4006 * it as a SysV modifier, as that is the only modifier
4007 * that can start with '$'.
4008 */
4009 }
4010
4011 mod = p;
4012
4013 res = ApplySingleModifier(&p, &ch);
4014 if (res == AMR_CLEANUP)
4015 goto cleanup;
4016 if (res == AMR_BAD)
4017 goto bad_modifier;
4018 }
4019
4020 *pp = p;
4021 assert(Expr_Str(expr) != NULL); /* Use var_Error or varUndefined. */
4022 return;
4023
4024 bad_modifier:
4025 /* XXX: The modifier end is only guessed. */
4026 Error("Bad modifier \":%.*s\" for variable \"%s\"",
4027 (int)strcspn(mod, ":)}"), mod, expr->name);
4028
4029 cleanup:
4030 /*
4031 * TODO: Use p + strlen(p) instead, to stop parsing immediately.
4032 *
4033 * In the unit tests, this generates a few shell commands with
4034 * unbalanced quotes. Instead of producing these incomplete strings,
4035 * commands with evaluation errors should not be run at all.
4036 *
4037 * To make that happen, Var_Subst must report the actual errors
4038 * instead of returning VPR_OK unconditionally.
4039 */
4040 *pp = p;
4041 Expr_SetValueRefer(expr, var_Error);
4042 }
4043
4044 /*
4045 * Only 4 of the 7 built-in local variables are treated specially as they are
4046 * the only ones that will be set when dynamic sources are expanded.
4047 */
4048 static bool
4049 VarnameIsDynamic(Substring varname)
4050 {
4051 const char *name;
4052 size_t len;
4053
4054 name = varname.start;
4055 len = Substring_Length(varname);
4056 if (len == 1 || (len == 2 && (name[1] == 'F' || name[1] == 'D'))) {
4057 switch (name[0]) {
4058 case '@':
4059 case '%':
4060 case '*':
4061 case '!':
4062 return true;
4063 }
4064 return false;
4065 }
4066
4067 if ((len == 7 || len == 8) && name[0] == '.' && ch_isupper(name[1])) {
4068 return Substring_Equals(varname, ".TARGET") ||
4069 Substring_Equals(varname, ".ARCHIVE") ||
4070 Substring_Equals(varname, ".PREFIX") ||
4071 Substring_Equals(varname, ".MEMBER");
4072 }
4073
4074 return false;
4075 }
4076
4077 static const char *
4078 UndefinedShortVarValue(char varname, const GNode *scope)
4079 {
4080 if (scope == SCOPE_CMDLINE || scope == SCOPE_GLOBAL) {
4081 /*
4082 * If substituting a local variable in a non-local scope,
4083 * assume it's for dynamic source stuff. We have to handle
4084 * this specially and return the longhand for the variable
4085 * with the dollar sign escaped so it makes it back to the
4086 * caller. Only four of the local variables are treated
4087 * specially as they are the only four that will be set
4088 * when dynamic sources are expanded.
4089 */
4090 switch (varname) {
4091 case '@':
4092 return "$(.TARGET)";
4093 case '%':
4094 return "$(.MEMBER)";
4095 case '*':
4096 return "$(.PREFIX)";
4097 case '!':
4098 return "$(.ARCHIVE)";
4099 }
4100 }
4101 return NULL;
4102 }
4103
4104 /*
4105 * Parse a variable name, until the end character or a colon, whichever
4106 * comes first.
4107 */
4108 static void
4109 ParseVarname(const char **pp, char startc, char endc,
4110 GNode *scope, VarEvalMode emode,
4111 LazyBuf *buf)
4112 {
4113 const char *p = *pp;
4114 int depth = 0; /* Track depth so we can spot parse errors. */
4115
4116 LazyBuf_Init(buf, p);
4117
4118 while (*p != '\0') {
4119 if ((*p == endc || *p == ':') && depth == 0)
4120 break;
4121 if (*p == startc)
4122 depth++;
4123 if (*p == endc)
4124 depth--;
4125
4126 /* A variable inside a variable, expand. */
4127 if (*p == '$') {
4128 FStr nested_val;
4129 (void)Var_Parse(&p, scope, emode, &nested_val);
4130 /* TODO: handle errors */
4131 LazyBuf_AddStr(buf, nested_val.str);
4132 FStr_Done(&nested_val);
4133 } else {
4134 LazyBuf_Add(buf, *p);
4135 p++;
4136 }
4137 }
4138 *pp = p;
4139 }
4140
4141 static bool
4142 IsShortVarnameValid(char varname, const char *start)
4143 {
4144 if (varname != '$' && varname != ':' && varname != '}' &&
4145 varname != ')' && varname != '\0')
4146 return true;
4147
4148 if (!opts.strict)
4149 return false; /* XXX: Missing error message */
4150
4151 if (varname == '$')
4152 Parse_Error(PARSE_FATAL,
4153 "To escape a dollar, use \\$, not $$, at \"%s\"", start);
4154 else if (varname == '\0')
4155 Parse_Error(PARSE_FATAL, "Dollar followed by nothing");
4156 else
4157 Parse_Error(PARSE_FATAL,
4158 "Invalid variable name '%c', at \"%s\"", varname, start);
4159
4160 return false;
4161 }
4162
4163 /*
4164 * Parse a single-character variable name such as in $V or $@.
4165 * Return whether to continue parsing.
4166 */
4167 static bool
4168 ParseVarnameShort(char varname, const char **pp, GNode *scope,
4169 VarEvalMode emode,
4170 VarParseResult *out_false_res, const char **out_false_val,
4171 Var **out_true_var)
4172 {
4173 char name[2];
4174 Var *v;
4175 const char *val;
4176
4177 if (!IsShortVarnameValid(varname, *pp)) {
4178 (*pp)++; /* only skip the '$' */
4179 *out_false_res = VPR_ERR;
4180 *out_false_val = var_Error;
4181 return false;
4182 }
4183
4184 name[0] = varname;
4185 name[1] = '\0';
4186 v = VarFind(name, scope, true);
4187 if (v != NULL) {
4188 /* No need to advance *pp, the calling code handles this. */
4189 *out_true_var = v;
4190 return true;
4191 }
4192
4193 *pp += 2;
4194
4195 val = UndefinedShortVarValue(varname, scope);
4196 if (val == NULL)
4197 val = emode == VARE_UNDEFERR ? var_Error : varUndefined;
4198
4199 if (opts.strict && val == var_Error) {
4200 Parse_Error(PARSE_FATAL,
4201 "Variable \"%s\" is undefined", name);
4202 *out_false_res = VPR_ERR;
4203 *out_false_val = val;
4204 return false;
4205 }
4206
4207 /*
4208 * XXX: This looks completely wrong.
4209 *
4210 * If undefined expressions are not allowed, this should
4211 * rather be VPR_ERR instead of VPR_UNDEF, together with an
4212 * error message.
4213 *
4214 * If undefined expressions are allowed, this should rather
4215 * be VPR_UNDEF instead of VPR_OK.
4216 */
4217 *out_false_res = emode == VARE_UNDEFERR ? VPR_UNDEF : VPR_OK;
4218 *out_false_val = val;
4219 return false;
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 * When called from CondParser_FuncCallEmpty, it can
4445 * also point to the "y" of "empty(VARNAME:Modifiers)".
4446 * scope The scope for finding variables
4447 * emode Controls the exact details of parsing and evaluation
4448 *
4449 * Output:
4450 * *pp The position where to continue parsing.
4451 * TODO: After a parse error, the value of *pp is
4452 * unspecified. It may not have been updated at all,
4453 * point to some random character in the string, to the
4454 * location of the parse error, or at the end of the
4455 * string.
4456 * *out_val The value of the variable expression, never NULL.
4457 * *out_val var_Error if there was a parse error.
4458 * *out_val var_Error if the base variable of the expression was
4459 * undefined, emode is VARE_UNDEFERR, and none of
4460 * the modifiers turned the undefined expression into a
4461 * defined expression.
4462 * XXX: It is not guaranteed that an error message has
4463 * been printed.
4464 * *out_val varUndefined if the base variable of the expression
4465 * was undefined, emode was not VARE_UNDEFERR,
4466 * and none of the modifiers turned the undefined
4467 * expression into a defined expression.
4468 * XXX: It is not guaranteed that an error message has
4469 * been printed.
4470 */
4471 VarParseResult
4472 Var_Parse(const char **pp, GNode *scope, VarEvalMode emode, FStr *out_val)
4473 {
4474 const char *p = *pp;
4475 const char *const start = p;
4476 bool haveModifier; /* true for ${VAR:...}, false for ${VAR} */
4477 char startc; /* the actual '{' or '(' or '\0' */
4478 char endc; /* the expected '}' or ')' or '\0' */
4479 /*
4480 * true if the expression is based on one of the 7 predefined
4481 * variables that are local to a target, and the expression is
4482 * expanded in a non-local scope. The result is the text of the
4483 * expression, unaltered. This is needed to support dynamic sources.
4484 */
4485 bool dynamic;
4486 const char *extramodifiers;
4487 Var *v;
4488 Expr expr = Expr_Literal(NULL, FStr_InitRefer(NULL), emode,
4489 scope, DEF_REGULAR);
4490
4491 if (Var_Parse_FastLane(pp, emode, out_val))
4492 return VPR_OK;
4493
4494 DEBUG2(VAR, "Var_Parse: %s (%s)\n", start, VarEvalMode_Name[emode]);
4495
4496 *out_val = FStr_InitRefer(NULL);
4497 extramodifiers = NULL; /* extra modifiers to apply first */
4498 dynamic = false;
4499
4500 endc = '\0'; /* Appease GCC. */
4501
4502 startc = p[1];
4503 if (startc != '(' && startc != '{') {
4504 VarParseResult res;
4505 if (!ParseVarnameShort(startc, pp, scope, emode, &res,
4506 &out_val->str, &v))
4507 return res;
4508 haveModifier = false;
4509 p++;
4510 } else {
4511 VarParseResult res;
4512 if (!ParseVarnameLong(&p, startc, scope, emode,
4513 pp, &res, out_val,
4514 &endc, &v, &haveModifier, &extramodifiers,
4515 &dynamic, &expr.defined))
4516 return res;
4517 }
4518
4519 expr.name = v->name.str;
4520 if (v->inUse) {
4521 if (scope->fname != NULL) {
4522 fprintf(stderr, "In a command near ");
4523 PrintLocation(stderr, false, scope);
4524 }
4525 Fatal("Variable %s is recursive.", v->name.str);
4526 }
4527
4528 /*
4529 * XXX: This assignment creates an alias to the current value of the
4530 * variable. This means that as long as the value of the expression
4531 * stays the same, the value of the variable must not change.
4532 * Using the '::=' modifier, it could be possible to trigger exactly
4533 * this situation.
4534 *
4535 * At the bottom of this function, the resulting value is compared to
4536 * the then-current value of the variable. This might also invoke
4537 * undefined behavior.
4538 */
4539 expr.value = FStr_InitRefer(v->val.data);
4540
4541 /*
4542 * Before applying any modifiers, expand any nested expressions from
4543 * the variable value.
4544 */
4545 if (VarEvalMode_ShouldEval(emode) &&
4546 strchr(Expr_Str(&expr), '$') != NULL) {
4547 char *expanded;
4548 VarEvalMode nested_emode = emode;
4549 if (opts.strict)
4550 nested_emode = VarEvalMode_UndefOk(nested_emode);
4551 v->inUse = true;
4552 (void)Var_Subst(Expr_Str(&expr), scope, nested_emode,
4553 &expanded);
4554 v->inUse = false;
4555 /* TODO: handle errors */
4556 Expr_SetValueOwn(&expr, expanded);
4557 }
4558
4559 if (extramodifiers != NULL) {
4560 const char *em = extramodifiers;
4561 ApplyModifiers(&expr, &em, '\0', '\0');
4562 }
4563
4564 if (haveModifier) {
4565 p++; /* Skip initial colon. */
4566 ApplyModifiers(&expr, &p, startc, endc);
4567 }
4568
4569 if (*p != '\0') /* Skip past endc if possible. */
4570 p++;
4571
4572 *pp = p;
4573
4574 if (expr.defined == DEF_UNDEF) {
4575 if (dynamic)
4576 Expr_SetValueOwn(&expr, bmake_strsedup(start, p));
4577 else {
4578 /*
4579 * The expression is still undefined, therefore
4580 * discard the actual value and return an error marker
4581 * instead.
4582 */
4583 Expr_SetValueRefer(&expr,
4584 emode == VARE_UNDEFERR
4585 ? var_Error : varUndefined);
4586 }
4587 }
4588
4589 if (v->shortLived) {
4590 if (expr.value.str == v->val.data) {
4591 /* move ownership */
4592 expr.value.freeIt = v->val.data;
4593 v->val.data = NULL;
4594 }
4595 VarFreeShortLived(v);
4596 }
4597
4598 *out_val = expr.value;
4599 return VPR_OK; /* XXX: Is not correct in all cases */
4600 }
4601
4602 static void
4603 VarSubstDollarDollar(const char **pp, Buffer *res, VarEvalMode emode)
4604 {
4605 /* A dollar sign may be escaped with another dollar sign. */
4606 if (save_dollars && VarEvalMode_ShouldKeepDollar(emode))
4607 Buf_AddByte(res, '$');
4608 Buf_AddByte(res, '$');
4609 *pp += 2;
4610 }
4611
4612 static void
4613 VarSubstExpr(const char **pp, Buffer *buf, GNode *scope,
4614 VarEvalMode emode, bool *inout_errorReported)
4615 {
4616 const char *p = *pp;
4617 const char *nested_p = p;
4618 FStr val;
4619
4620 (void)Var_Parse(&nested_p, scope, emode, &val);
4621 /* TODO: handle errors */
4622
4623 if (val.str == var_Error || val.str == varUndefined) {
4624 if (!VarEvalMode_ShouldKeepUndef(emode)) {
4625 p = nested_p;
4626 } else if (val.str == var_Error) {
4627
4628 /*
4629 * XXX: This condition is wrong. If val == var_Error,
4630 * this doesn't necessarily mean there was an undefined
4631 * variable. It could equally well be a parse error;
4632 * see unit-tests/varmod-order.exp.
4633 */
4634
4635 /*
4636 * If variable is undefined, complain and skip the
4637 * variable. The complaint will stop us from doing
4638 * anything when the file is parsed.
4639 */
4640 if (!*inout_errorReported) {
4641 Parse_Error(PARSE_FATAL,
4642 "Undefined variable \"%.*s\"",
4643 (int)(size_t)(nested_p - p), p);
4644 }
4645 p = nested_p;
4646 *inout_errorReported = true;
4647 } else {
4648 /*
4649 * Copy the initial '$' of the undefined expression,
4650 * thereby deferring expansion of the expression, but
4651 * expand nested expressions if already possible. See
4652 * unit-tests/varparse-undef-partial.mk.
4653 */
4654 Buf_AddByte(buf, *p);
4655 p++;
4656 }
4657 } else {
4658 p = nested_p;
4659 Buf_AddStr(buf, val.str);
4660 }
4661
4662 FStr_Done(&val);
4663
4664 *pp = p;
4665 }
4666
4667 /*
4668 * Skip as many characters as possible -- either to the end of the string
4669 * or to the next dollar sign (variable expression).
4670 */
4671 static void
4672 VarSubstPlain(const char **pp, Buffer *res)
4673 {
4674 const char *p = *pp;
4675 const char *start = p;
4676
4677 for (p++; *p != '$' && *p != '\0'; p++)
4678 continue;
4679 Buf_AddBytesBetween(res, start, p);
4680 *pp = p;
4681 }
4682
4683 /*
4684 * Expand all variable expressions like $V, ${VAR}, $(VAR:Modifiers) in the
4685 * given string.
4686 *
4687 * Input:
4688 * str The string in which the variable expressions are
4689 * expanded.
4690 * scope The scope in which to start searching for
4691 * variables. The other scopes are searched as well.
4692 * emode The mode for parsing or evaluating subexpressions.
4693 */
4694 VarParseResult
4695 Var_Subst(const char *str, GNode *scope, VarEvalMode emode, char **out_res)
4696 {
4697 const char *p = str;
4698 Buffer res;
4699
4700 /*
4701 * Set true if an error has already been reported, to prevent a
4702 * plethora of messages when recursing
4703 */
4704 /* See varparse-errors.mk for why the 'static' is necessary here. */
4705 static bool errorReported;
4706
4707 Buf_Init(&res);
4708 errorReported = false;
4709
4710 while (*p != '\0') {
4711 if (p[0] == '$' && p[1] == '$')
4712 VarSubstDollarDollar(&p, &res, emode);
4713 else if (p[0] == '$')
4714 VarSubstExpr(&p, &res, scope, emode, &errorReported);
4715 else
4716 VarSubstPlain(&p, &res);
4717 }
4718
4719 *out_res = Buf_DoneDataCompact(&res);
4720 return VPR_OK;
4721 }
4722
4723 void
4724 Var_Expand(FStr *str, GNode *scope, VarEvalMode emode)
4725 {
4726 char *expanded;
4727
4728 if (strchr(str->str, '$') == NULL)
4729 return;
4730 (void)Var_Subst(str->str, scope, emode, &expanded);
4731 /* TODO: handle errors */
4732 FStr_Done(str);
4733 *str = FStr_InitOwn(expanded);
4734 }
4735
4736 /* Initialize the variables module. */
4737 void
4738 Var_Init(void)
4739 {
4740 SCOPE_INTERNAL = GNode_New("Internal");
4741 SCOPE_GLOBAL = GNode_New("Global");
4742 SCOPE_CMDLINE = GNode_New("Command");
4743 }
4744
4745 /* Clean up the variables module. */
4746 void
4747 Var_End(void)
4748 {
4749 Var_Stats();
4750 }
4751
4752 void
4753 Var_Stats(void)
4754 {
4755 HashTable_DebugStats(&SCOPE_GLOBAL->vars, "Global variables");
4756 }
4757
4758 static int
4759 StrAsc(const void *sa, const void *sb)
4760 {
4761 return strcmp(
4762 *((const char *const *)sa), *((const char *const *)sb));
4763 }
4764
4765
4766 /* Print all variables in a scope, sorted by name. */
4767 void
4768 Var_Dump(GNode *scope)
4769 {
4770 Vector /* of const char * */ vec;
4771 HashIter hi;
4772 size_t i;
4773 const char **varnames;
4774
4775 Vector_Init(&vec, sizeof(const char *));
4776
4777 HashIter_Init(&hi, &scope->vars);
4778 while (HashIter_Next(&hi) != NULL)
4779 *(const char **)Vector_Push(&vec) = hi.entry->key;
4780 varnames = vec.items;
4781
4782 qsort(varnames, vec.len, sizeof varnames[0], StrAsc);
4783
4784 for (i = 0; i < vec.len; i++) {
4785 const char *varname = varnames[i];
4786 Var *var = HashTable_FindValue(&scope->vars, varname);
4787 debug_printf("%-16s = %s%s\n", varname,
4788 var->val.data, ValueDescription(var->val.data));
4789 }
4790
4791 Vector_Done(&vec);
4792 }
4793