2 * Copyright (c) 1988, 1989, 1990, 1993
3 * The Regents of the University of California. All rights reserved.
4 * Copyright (c) 1989 by Berkeley Softworks
7 * This code is derived from software contributed to Berkeley by
10 * Redistribution and use in source and binary forms, with or without
11 * modification, are permitted provided that the following conditions
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. All advertising materials mentioning features or use of this software
19 * must display the following acknowledgement:
20 * This product includes software developed by the University of
21 * California, Berkeley and its contributors.
22 * 4. Neither the name of the University nor the names of its contributors
23 * may be used to endorse or promote products derived from this software
24 * without specific prior written permission.
26 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
27 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
29 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
30 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
31 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
32 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
33 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
35 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
38 * @(#)var.c 8.3 (Berkeley) 3/19/94
39 * $FreeBSD: src/usr.bin/make/var.c,v 1.16.2.3 2002/02/27 14:18:57 cjc Exp $
40 * $DragonFly: src/usr.bin/make/var.c,v 1.82 2005/02/11 22:34:02 okumoto Exp $
45 * Variable-handling functions
48 * Var_Set Set the value of a variable in the given
49 * context. The variable is created if it doesn't
50 * yet exist. The value and variable name need not
53 * Var_Append Append more characters to an existing variable
54 * in the given context. The variable needn't
55 * exist already -- it will be created if it doesn't.
56 * A space is placed between the old value and the
59 * Var_Exists See if a variable exists.
61 * Var_Value Return the value of a variable in a context or
62 * NULL if the variable is undefined.
64 * Var_Subst Substitute named variable, or all variables if
65 * NULL in a string using
66 * the given context as the top-most one. If the
67 * third argument is non-zero, Parse_Error is
68 * called if any variables are undefined.
70 * Var_Parse Parse a variable expansion from a string and
71 * return the result and the number of characters
74 * Var_Delete Delete a variable in a context.
76 * Var_Init Initialize this module.
79 * Var_Dump Print out all variables defined in the given
82 * XXX: There's a lot of duplication in these functions.
102 * This is a harmless return value for Var_Parse that can be used by Var_Subst
103 * to determine if there was an error in parsing -- easier than returning
104 * a flag, as things outside this module don't give a hoot.
106 char var_Error[] = "";
109 * Similar to var_Error, but returned when the 'err' flag for Var_Parse is
110 * set false. Why not just use a constant? Well, gcc likes to condense
111 * identical string instances...
113 static char varNoError[] = "";
116 * Internally, variables are contained in four different contexts.
117 * 1) the environment. They may not be changed. If an environment
118 * variable is appended-to, the result is placed in the global
120 * 2) the global context. Variables set in the Makefile are located in
121 * the global context. It is the penultimate context searched when
123 * 3) the command-line context. All variables set on the command line
124 * are placed in this context. They are UNALTERABLE once placed here.
125 * 4) the local context. Each target has associated with it a context
126 * list. On this list are located the structures describing such
127 * local variables as $(@) and $(*)
128 * The four contexts are searched in the reverse order from which they are
131 GNode *VAR_GLOBAL; /* variables from the makefile */
132 GNode *VAR_CMD; /* variables defined on the command-line */
134 #define FIND_CMD 0x1 /* look in VAR_CMD when searching */
135 #define FIND_GLOBAL 0x2 /* look in VAR_GLOBAL as well */
136 #define FIND_ENV 0x4 /* look in the environment also */
138 #define OPEN_PAREN '('
139 #define CLOSE_PAREN ')'
140 #define OPEN_BRACE '{'
141 #define CLOSE_BRACE '}'
143 static char *VarGetPattern(GNode *, int, char **, int, int *, size_t *,
145 static int VarPrintVar(void *, void *);
148 * Create a Var object.
150 * @param name Name of variable.
151 * @param value Value of variable.
152 * @param flags Flags set on variable.
155 VarCreate(const char name[], const char value[], int flags)
159 v = emalloc(sizeof(Var));
160 v->name = estrdup(name);
161 v->val = Buf_Init(0);
165 Buf_Append(v->val, value);
171 * Destroy a Var object.
173 * @param v Object to destroy.
174 * @param f true if internal buffer in Buffer object is to be
178 VarDestroy(Var *v, Boolean f)
181 Buf_Destroy(v->val, f);
187 *-----------------------------------------------------------------------
189 * See if the given variable matches the named one. Called from
190 * Lst_Find when searching for a variable of a given name.
193 * 0 if they match. non-zero otherwise.
197 *-----------------------------------------------------------------------
200 VarCmp(const void *v, const void *name)
203 return (strcmp(name, ((const Var *)v)->name));
207 *-----------------------------------------------------------------------
208 * VarPossiblyExpand --
209 * Expand a variable name's embedded variables in the given context.
212 * The contents of name, possibly expanded.
213 *-----------------------------------------------------------------------
216 VarPossiblyExpand(const char *name, GNode *ctxt)
221 * XXX make a temporary copy of the name because Var_Subst insists
222 * on writing into the string.
225 if (strchr(name, '$') != NULL) {
229 buf = Var_Subst(NULL, tmp, ctxt, 0);
230 str = Buf_GetAll(buf, NULL);
231 Buf_Destroy(buf, FALSE);
240 *-----------------------------------------------------------------------
242 * Find the given variable in the given context and any other contexts
246 * FIND_GLOBAL set means look in the VAR_GLOBAL context too
247 * FIND_CMD set means to look in the VAR_CMD context too
248 * FIND_ENV set means to look in the environment
251 * A pointer to the structure describing the desired variable or
252 * NULL if the variable does not exist.
256 *-----------------------------------------------------------------------
259 VarFind(const char *name, GNode *ctxt, int flags)
261 Boolean localCheckEnvFirst;
266 * If the variable name begins with a '.', it could very well be one of
267 * the local ones. We check the name against all the local variables
268 * and substitute the short version in for 'name' if it matches one of
271 if (name[0] == '.') {
274 if (!strcmp(name, ".ALLSRC"))
276 if (!strcmp(name, ".ARCHIVE"))
280 if (!strcmp(name, ".IMPSRC"))
284 if (!strcmp(name, ".MEMBER"))
288 if (!strcmp(name, ".OODATE"))
292 if (!strcmp(name, ".PREFIX"))
296 if (!strcmp(name, ".TARGET"))
305 * Note whether this is one of the specific variables we were told
306 * through the -E flag to use environment-variable-override for.
308 if (Lst_Find(&envFirstVars, name, (CompareProc *)strcmp) != NULL) {
309 localCheckEnvFirst = TRUE;
311 localCheckEnvFirst = FALSE;
315 * First look for the variable in the given context. If it's not there,
316 * look for it in VAR_CMD, VAR_GLOBAL and the environment,
317 * in that order, depending on the FIND_* flags in 'flags'
319 var = Lst_Find(&ctxt->context, name, VarCmp);
322 return (Lst_Datum(var));
325 /* not there - try command line context */
326 if ((flags & FIND_CMD) && (ctxt != VAR_CMD)) {
327 var = Lst_Find(&VAR_CMD->context, name, VarCmp);
329 return (Lst_Datum(var));
332 /* not there - try global context, but only if not -e/-E */
333 if ((flags & FIND_GLOBAL) && (ctxt != VAR_GLOBAL) &&
334 !checkEnvFirst && !localCheckEnvFirst) {
335 var = Lst_Find(&VAR_GLOBAL->context, name, VarCmp);
337 return (Lst_Datum(var));
340 if (!(flags & FIND_ENV))
341 /* we were not told to look into the environment */
344 /* look in the environment */
345 if ((env = getenv(name)) != NULL) {
346 /* craft this variable from the environment value */
347 return (VarCreate(name, env, VAR_FROM_ENV));
350 /* deferred check for the environment (in case of -e/-E) */
351 if ((checkEnvFirst || localCheckEnvFirst) &&
352 (flags & FIND_GLOBAL) && (ctxt != VAR_GLOBAL)) {
353 var = Lst_Find(&VAR_GLOBAL->context, name, VarCmp);
355 return (Lst_Datum(var));
361 *-----------------------------------------------------------------------
363 * Add a new variable of name name and value val to the given context.
369 * The new variable is placed at the front of the given context
370 * The name and val arguments are duplicated so they may
372 *-----------------------------------------------------------------------
375 VarAdd(const char *name, const char *val, GNode *ctxt)
378 Lst_AtFront(&ctxt->context, VarCreate(name, val, 0));
380 DEBUGF(VAR, ("%s:%s = %s\n", ctxt->name, name, val));
384 *-----------------------------------------------------------------------
386 * Remove a variable from a context.
392 * The Var structure is removed and freed.
394 *-----------------------------------------------------------------------
397 Var_Delete(const char *name, GNode *ctxt)
401 DEBUGF(VAR, ("%s:delete %s\n", ctxt->name, name));
402 ln = Lst_Find(&ctxt->context, name, VarCmp);
404 VarDestroy(Lst_Datum(ln), TRUE);
405 Lst_Remove(&ctxt->context, ln);
410 *-----------------------------------------------------------------------
412 * Set the variable name to the value val in the given context.
418 * If the variable doesn't yet exist, a new record is created for it.
419 * Else the old value is freed and the new one stuck in its place
422 * The variable is searched for only in its context before being
423 * created in that context. I.e. if the context is VAR_GLOBAL,
424 * only VAR_GLOBAL->context is searched. Likewise if it is VAR_CMD, only
425 * VAR_CMD->context is searched. This is done to avoid the literally
426 * thousands of unnecessary strcmp's that used to be done to
427 * set, say, $(@) or $(<).
428 *-----------------------------------------------------------------------
431 Var_Set(const char *name, const char *val, GNode *ctxt)
437 * We only look for a variable in the given context since anything set
438 * here will override anything in a lower context, so there's not much
439 * point in searching them all just to save a bit of memory...
441 n = VarPossiblyExpand(name, ctxt);
442 v = VarFind(n, ctxt, 0);
444 VarAdd(n, val, ctxt);
447 Buf_Append(v->val, val);
449 DEBUGF(VAR, ("%s:%s = %s\n", ctxt->name, n, val));
452 * Any variables given on the command line are automatically exported
453 * to the environment (as per POSIX standard)
455 if (ctxt == VAR_CMD || (v != (Var *)NULL && (v->flags & VAR_TO_ENV))) {
463 * Set the VAR_TO_ENV flag on a variable
466 Var_SetEnv(const char *name, GNode *ctxt)
470 v = VarFind(name, ctxt, FIND_CMD|FIND_GLOBAL|FIND_ENV);
472 if ((v->flags & VAR_TO_ENV) == 0) {
473 v->flags |= VAR_TO_ENV;
474 setenv(v->name, Buf_GetAll(v->val, NULL), 1);
477 Error("Cannot set environment flag on non-existant variable %s", name);
482 *-----------------------------------------------------------------------
484 * The variable of the given name has the given value appended to it in
491 * If the variable doesn't exist, it is created. Else the strings
492 * are concatenated (with a space in between).
495 * Only if the variable is being sought in the global context is the
496 * environment searched.
497 * XXX: Knows its calling circumstances in that if called with ctxt
498 * an actual target, it will only search that context since only
499 * a local variable could be being appended to. This is actually
500 * a big win and must be tolerated.
501 *-----------------------------------------------------------------------
504 Var_Append(const char *name, const char *val, GNode *ctxt)
509 n = VarPossiblyExpand(name, ctxt);
510 v = VarFind(n, ctxt, (ctxt == VAR_GLOBAL) ? FIND_ENV : 0);
513 VarAdd(n, val, ctxt);
515 Buf_AddByte(v->val, (Byte)' ');
516 Buf_Append(v->val, val);
518 DEBUGF(VAR, ("%s:%s = %s\n", ctxt->name, n,
519 (char *)Buf_GetAll(v->val, (size_t *)NULL)));
521 if (v->flags & VAR_FROM_ENV) {
523 * If the original variable came from the environment, we
524 * have to install it in the global context (we could place
525 * it in the environment, but then we should provide a way to
526 * export other variables...)
528 v->flags &= ~VAR_FROM_ENV;
529 Lst_AtFront(&ctxt->context, v);
536 *-----------------------------------------------------------------------
538 * See if the given variable exists.
541 * TRUE if it does, FALSE if it doesn't
546 *-----------------------------------------------------------------------
549 Var_Exists(const char *name, GNode *ctxt)
554 n = VarPossiblyExpand(name, ctxt);
555 v = VarFind(n, ctxt, FIND_CMD|FIND_GLOBAL|FIND_ENV);
560 } else if (v->flags & VAR_FROM_ENV) {
567 *-----------------------------------------------------------------------
569 * Return the value of the named variable in the given context
572 * The value if the variable exists, NULL if it doesn't
576 *-----------------------------------------------------------------------
579 Var_Value(const char *name, GNode *ctxt, char **frp)
584 n = VarPossiblyExpand(name, ctxt);
585 v = VarFind(n, ctxt, FIND_ENV | FIND_GLOBAL | FIND_CMD);
589 char *p = (char *)Buf_GetAll(v->val, (size_t *)NULL);
591 if (v->flags & VAR_FROM_ENV) {
592 VarDestroy(v, FALSE);
602 *-----------------------------------------------------------------------
604 * Modify each of the words of the passed string using the given
605 * function. Used to implement all modifiers.
608 * A string of all the words modified appropriately.
613 *-----------------------------------------------------------------------
616 VarModify(char *str, VarModifyProc *modProc, void *datum)
618 Buffer *buf; /* Buffer for the new string */
619 Boolean addSpace; /* TRUE if need to add a space to the
620 * buffer before adding the trimmed
622 char **av; /* word list [first word does not count] */
628 av = brk_string(str, &ac, FALSE);
630 for (i = 1; i < ac; i++)
631 addSpace = (*modProc)(av[i], addSpace, buf, datum);
633 Buf_AddByte(buf, '\0');
634 str = (char *)Buf_GetAll(buf, (size_t *)NULL);
635 Buf_Destroy(buf, FALSE);
640 *-----------------------------------------------------------------------
642 * Sort the words in the string.
645 * str String whose words should be sorted
646 * cmp A comparison function to control the ordering
649 * A string containing the words sorted
654 *-----------------------------------------------------------------------
657 VarSortWords(char *str, int (*cmp)(const void *, const void *))
664 av = brk_string(str, &ac, FALSE);
665 qsort(av + 1, ac - 1, sizeof(char *), cmp);
666 for (i = 1; i < ac; i++) {
667 Buf_Append(buf, av[i]);
668 Buf_AddByte(buf, (Byte)((i < ac - 1) ? ' ' : '\0'));
670 str = (char *)Buf_GetAll(buf, (size_t *)NULL);
671 Buf_Destroy(buf, FALSE);
676 SortIncreasing(const void *l, const void *r)
679 return (strcmp(*(const char* const*)l, *(const char* const*)r));
683 *-----------------------------------------------------------------------
685 * Pass through the tstr looking for 1) escaped delimiters,
686 * '$'s and backslashes (place the escaped character in
687 * uninterpreted) and 2) unescaped $'s that aren't before
688 * the delimiter (expand the variable substitution unless flags
689 * has VAR_NOSUBST set).
690 * Return the expanded string or NULL if the delimiter was missing
691 * If pattern is specified, handle escaped ampersands, and replace
692 * unescaped ampersands with the lhs of the pattern.
695 * A string of all the words modified appropriately.
696 * If length is specified, return the string length of the buffer
697 * If flags is specified and the last character of the pattern is a
698 * $ set the VAR_MATCH_END bit of flags.
702 *-----------------------------------------------------------------------
705 VarGetPattern(GNode *ctxt, int err, char **tstr, int delim, int *flags,
706 size_t *length, VarPattern *pattern)
709 Buffer *buf = Buf_Init(0);
715 #define IS_A_MATCH(cp, delim) \
716 ((cp[0] == '\\') && ((cp[1] == delim) || \
717 (cp[1] == '\\') || (cp[1] == '$') || (pattern && (cp[1] == '&'))))
720 * Skim through until the matching delimiter is found;
721 * pick up variable substitutions on the way. Also allow
722 * backslashes to quote the delimiter, $, and \, but don't
723 * touch other backslashes.
725 for (cp = *tstr; *cp && (*cp != delim); cp++) {
726 if (IS_A_MATCH(cp, delim)) {
727 Buf_AddByte(buf, (Byte)cp[1]);
729 } else if (*cp == '$') {
730 if (cp[1] == delim) {
732 Buf_AddByte(buf, (Byte)*cp);
735 * Unescaped $ at end of pattern => anchor
738 *flags |= VAR_MATCH_END;
740 if (flags == NULL || (*flags & VAR_NOSUBST) == 0) {
746 * If unescaped dollar sign not before the
747 * delimiter, assume it's a variable
748 * substitution and recurse.
750 cp2 = Var_Parse(cp, ctxt, err, &len, &freeIt);
751 Buf_Append(buf, cp2);
758 if (*cp2 == OPEN_PAREN || *cp2 == OPEN_BRACE) {
760 * Find the end of this variable reference
761 * and suck it in without further ado.
762 * It will be interperated later.
765 int want = (*cp2 == OPEN_PAREN) ? CLOSE_PAREN : CLOSE_BRACE;
768 for (++cp2; *cp2 != '\0' && depth > 0; ++cp2) {
769 if (cp2[-1] != '\\') {
776 Buf_AppendRange(buf, cp, cp2);
779 Buf_AddByte(buf, (Byte)*cp);
783 else if (pattern && *cp == '&')
784 Buf_AddBytes(buf, pattern->leftLen, (Byte *)pattern->lhs);
786 Buf_AddByte(buf, (Byte)*cp);
789 Buf_AddByte(buf, (Byte)'\0');
797 cp = (char *)Buf_GetAll(buf, length);
798 *length -= 1; /* Don't count the NULL */
799 Buf_Destroy(buf, FALSE);
805 *-----------------------------------------------------------------------
807 * Quote shell meta-characters in the string
815 *-----------------------------------------------------------------------
818 Var_Quote(const char *str)
821 /* This should cover most shells :-( */
822 static char meta[] = "\n \t'`\";&<>()|*?{}[]\\$!#^~";
825 buf = Buf_Init(MAKE_BSIZE);
826 for (; *str; str++) {
827 if (strchr(meta, *str) != NULL)
828 Buf_AddByte(buf, (Byte)'\\');
829 Buf_AddByte(buf, (Byte)*str);
831 Buf_AddByte(buf, (Byte)'\0');
832 ret = Buf_GetAll(buf, NULL);
833 Buf_Destroy(buf, FALSE);
838 *-----------------------------------------------------------------------
840 * Print the error caused by a regcomp or regexec call.
846 * An error gets printed.
848 *-----------------------------------------------------------------------
851 VarREError(int err, regex_t *pat, const char *str)
856 errlen = regerror(err, pat, 0, 0);
857 errbuf = emalloc(errlen);
858 regerror(err, pat, errbuf, errlen);
859 Error("%s: %s", str, errbuf);
864 *-----------------------------------------------------------------------
866 * Given the start of a variable invocation, extract the variable
867 * name and find its value, then modify it according to the
871 * The (possibly-modified) value of the variable or var_Error if the
872 * specification is invalid. The length of the specification is
873 * placed in *lengthPtr (for invalid specifications, this is just
874 * 2 to skip the '$' and the following letter, or 1 if '$' was the
875 * last character in the string).
876 * A Boolean in *freePtr telling whether the returned string should
877 * be freed by the caller.
882 *-----------------------------------------------------------------------
885 Var_Parse(char *str, GNode *ctxt, Boolean err, size_t *lengthPtr,
888 char *tstr; /* Pointer into str */
889 Var *v; /* Variable in invocation */
890 Boolean haveModifier; /* TRUE if have modifiers for the variable */
891 char endc; /* Ending character when variable in parens
893 char startc; /* Starting character when variable in parens
896 Boolean dynamic; /* TRUE if the variable is local and we're
897 * expanding it in a non-local context. This
898 * is done to support dynamic sources. The
899 * result is just the invocation, unaltered */
902 * It is assumed that Var_Parse() is called with str[0] == '$'
905 if (str[1] == '\0') {
907 * Error, there is only a dollar sign in the input string.
911 return (err ? var_Error : varNoError);
913 } else if (str[1] == OPEN_PAREN || str[1] == OPEN_BRACE) {
915 * Check if brackets contain a variable name.
917 int vlen; /* length of variable name, after embedded variable
920 /* build up expanded variable name in this buffer */
921 Buffer *buf = Buf_Init(MAKE_BSIZE);
924 * Skip to the end character or a colon, whichever comes first,
925 * replacing embedded variables as we go.
928 endc = (startc == OPEN_PAREN) ? CLOSE_PAREN : CLOSE_BRACE;
931 while (*tstr != '\0' && *tstr != endc && *tstr != ':') {
937 rval = Var_Parse(tstr, ctxt, err, &rlen, &rfree);
938 if (rval == var_Error) {
939 Fatal("Error expanding embedded variable.");
942 Buf_Append(buf, rval);
948 Buf_AddByte(buf, (Byte)*tstr);
955 * If we never did find the end character, return NULL
956 * right now, setting the length to be the distance to
957 * the end of the string, since that's what make does.
960 *lengthPtr = tstr - str;
964 haveModifier = (*tstr == ':');
965 *tstr = '\0'; /* modify input string */
968 Buf_AddByte(buf, (Byte)'\0');
969 str = Buf_GetAll(buf, (size_t *)NULL); /* REPLACE str */
972 v = VarFind(str, ctxt, FIND_ENV | FIND_GLOBAL | FIND_CMD);
974 if ((v == (Var *)NULL) && (ctxt != VAR_CMD) && (ctxt != VAR_GLOBAL) &&
975 (vlen == 2) && (str[1] == 'F' || str[1] == 'D'))
978 * Check for bogus D and F forms of local variables since we're
979 * in a local context and the name is the right length.
993 * Well, it's local -- go look for it.
998 v = VarFind(vname, ctxt, 0);
999 if (v != NULL && !haveModifier) {
1001 * No need for nested expansion or anything, as we're
1002 * the only one who sets these things and we sure don't
1003 * put nested invocations in them...
1005 val = (char *)Buf_GetAll(v->val, (size_t *)NULL);
1007 if (str[1] == 'D') {
1008 val = VarModify(val, VarHead, (void *)NULL);
1010 val = VarModify(val, VarTail, (void *)NULL);
1013 * Resulting string is dynamically allocated, so
1014 * tell caller to free it.
1017 *lengthPtr = tstr - start + 1;
1019 Buf_Destroy(buf, TRUE);
1029 if (v == (Var *)NULL) {
1031 (((vlen == 2) && (str[1] == 'F' || str[1] == 'D')))) &&
1032 ((ctxt == VAR_CMD) || (ctxt == VAR_GLOBAL)))
1035 * If substituting a local variable in a non-local context,
1036 * assume it's for dynamic source stuff. We have to handle
1037 * this specially and return the longhand for the variable
1038 * with the dollar sign escaped so it makes it back to the
1039 * caller. Only four of the local variables are treated
1040 * specially as they are the only four that will be set
1041 * when dynamic sources are expanded.
1054 } else if ((vlen > 2) && (str[0] == '.') &&
1055 isupper((unsigned char)str[1]) &&
1056 ((ctxt == VAR_CMD) || (ctxt == VAR_GLOBAL)))
1061 if ((strncmp(str, ".TARGET", len) == 0) ||
1062 (strncmp(str, ".ARCHIVE", len) == 0) ||
1063 (strncmp(str, ".PREFIX", len) == 0) ||
1064 (strncmp(str, ".MEMBER", len) == 0))
1076 * Still need to get to the end of the variable specification,
1077 * so kludge up a Var structure for the modifications
1079 v = VarCreate(str, NULL, VAR_JUNK);
1083 * No modifiers -- have specification length so we can return
1086 *lengthPtr = tstr - start + 1;
1089 str = emalloc(*lengthPtr + 1);
1090 strncpy(str, start, *lengthPtr);
1091 str[*lengthPtr] = '\0';
1093 Buf_Destroy(buf, TRUE);
1097 Buf_Destroy(buf, TRUE);
1098 return (err ? var_Error : varNoError);
1105 Buf_Destroy(buf, TRUE);
1109 * If it's not bounded by braces of some sort, life is much simpler.
1110 * We just need to check for the first character and return the
1111 * value if it exists.
1119 v = VarFind(name, ctxt, FIND_ENV | FIND_GLOBAL | FIND_CMD);
1121 if ((ctxt == VAR_CMD) || (ctxt == VAR_GLOBAL)) {
1123 * If substituting a local variable in a non-local context,
1124 * assume it's for dynamic source stuff. We have to handle
1125 * this specially and return the longhand for the variable
1126 * with the dollar sign escaped so it makes it back to the
1127 * caller. Only four of the local variables are treated
1128 * specially as they are the only four that will be set
1129 * when dynamic sources are expanded.
1131 /* XXX: It looks like $% and $! are reversed here */
1135 return ("$(.TARGET)");
1137 return ("$(.ARCHIVE)");
1139 return ("$(.PREFIX)");
1141 return ("$(.MEMBER)");
1143 return (err ? var_Error : varNoError);
1147 return (err ? var_Error : varNoError);
1153 haveModifier = FALSE;
1161 * Make sure this variable is fully expanded.
1162 * XXX This section really should be its own function.
1165 if (v->flags & VAR_IN_USE) {
1166 Fatal("Variable %s is recursive.", v->name);
1169 v->flags |= VAR_IN_USE;
1173 * Before doing any modification, we have to make sure the
1174 * value has been fully expanded. If it looks like recursion
1175 * might be necessary (there's a dollar sign somewhere in the
1176 * variable's value) we just call Var_Subst to do any other
1177 * substitutions that are necessary. Note that the value
1178 * returned by Var_Subst will have been
1179 * dynamically-allocated, so it will need freeing when we
1182 str = (char *)Buf_GetAll(v->val, (size_t *)NULL);
1183 if (strchr(str, '$') != NULL) {
1186 buf = Var_Subst(NULL, str, ctxt, err);
1187 str = Buf_GetAll(buf, NULL);
1188 Buf_Destroy(buf, FALSE);
1192 v->flags &= ~VAR_IN_USE;
1196 * Now we need to apply any modifiers the user wants applied.
1198 * :M<pattern> words which match the given <pattern>.
1199 * <pattern> is of the standard file
1201 * :S<d><pat1><d><pat2><d>[g]
1202 * Substitute <pat2> for <pat1> in the value
1203 * :C<d><pat1><d><pat2><d>[g]
1204 * Substitute <pat2> for regex <pat1> in the value
1205 * :H Substitute the head of each word
1206 * :T Substitute the tail of each word
1207 * :E Substitute the extension (minus '.') of
1209 * :R Substitute the root of each word
1210 * (pathname minus the suffix).
1211 * :lhs=rhs Like :S, but the rhs goes to the end of
1213 * :U Converts variable to upper-case.
1214 * :L Converts variable to lower-case.
1216 if ((str != NULL) && haveModifier) {
1219 * Skip initial colon while putting it back.
1222 while (*tstr != endc) {
1223 char *newStr; /* New value to return */
1224 char termc; /* Character which terminated scan */
1226 DEBUGF(VAR, ("Applying :%c to \"%s\"\n", *tstr, str));
1237 *cp != '\0' && *cp != ':' && *cp != endc;
1240 if (*cp == '\\' && (cp[1] == ':' || cp[1] == endc)) {
1249 * Need to compress the \:'s out of the pattern, so
1250 * allocate enough room to hold the uncompressed
1251 * pattern (note that cp started at tstr+1, so
1252 * cp - tstr takes the null byte into account) and
1253 * compress the pattern into the space.
1255 pattern = emalloc(cp - tstr);
1256 for (cp2 = pattern, cp = tstr + 1;
1260 if ((*cp == '\\') &&
1261 (cp[1] == ':' || cp[1] == endc)) {
1270 if (*tstr == 'M' || *tstr == 'm') {
1271 newStr = VarModify(str, VarMatch, pattern);
1273 newStr = VarModify(str, VarNoMatch, pattern);
1284 Buffer *buf; /* Buffer for patterns */
1291 * If pattern begins with '^', it is anchored to the
1292 * start of the word -- skip over it and flag pattern.
1295 pattern.flags |= VAR_MATCH_START;
1302 * Pass through the lhs looking for 1) escaped delimiters,
1303 * '$'s and backslashes (place the escaped character in
1304 * uninterpreted) and 2) unescaped $'s that aren't before
1305 * the delimiter (expand the variable substitution).
1306 * The result is left in the Buffer buf.
1308 for (cp = tstr; *cp != '\0' && *cp != del; cp++) {
1309 if ((*cp == '\\') &&
1314 Buf_AddByte(buf, (Byte)cp[1]);
1316 } else if (*cp == '$') {
1319 * If unescaped dollar sign not before the
1320 * delimiter, assume it's a variable
1321 * substitution and recurse.
1327 cp2 = Var_Parse(cp, ctxt, err, &len, &freeIt);
1328 Buf_Append(buf, cp2);
1335 * Unescaped $ at end of pattern => anchor
1338 pattern.flags |= VAR_MATCH_END;
1341 Buf_AddByte(buf, (Byte)*cp);
1345 Buf_AddByte(buf, (Byte)'\0');
1348 * If lhs didn't end with the delimiter, complain and
1352 Fatal("Unclosed substitution for %s (%c missing)",
1357 * Fetch pattern and destroy buffer, but preserve the data
1358 * in it, since that's our lhs. Note that Buf_GetAll
1359 * will return the actual number of bytes, which includes
1360 * the null byte, so we have to decrement the length by
1363 pattern.lhs = (char *)Buf_GetAll(buf, &pattern.leftLen);
1365 Buf_Destroy(buf, FALSE);
1368 * Now comes the replacement string. Three things need to
1369 * be done here: 1) need to compress escaped delimiters and
1370 * ampersands and 2) need to replace unescaped ampersands
1371 * with the l.h.s. (since this isn't regexp, we can do
1372 * it right here) and 3) expand any variable substitutions.
1377 for (cp = tstr; *cp != '\0' && *cp != del; cp++) {
1378 if ((*cp == '\\') &&
1384 Buf_AddByte(buf, (Byte)cp[1]);
1386 } else if ((*cp == '$') && (cp[1] != del)) {
1391 cp2 = Var_Parse(cp, ctxt, err, &len, &freeIt);
1392 Buf_Append(buf, cp2);
1397 } else if (*cp == '&') {
1398 Buf_AddBytes(buf, pattern.leftLen,
1399 (Byte *)pattern.lhs);
1401 Buf_AddByte(buf, (Byte)*cp);
1405 Buf_AddByte(buf, (Byte)'\0');
1408 * If didn't end in delimiter character, complain
1411 Fatal("Unclosed substitution for %s (%c missing)",
1415 pattern.rhs = (char *)Buf_GetAll(buf, &pattern.rightLen);
1417 Buf_Destroy(buf, FALSE);
1420 * Check for global substitution. If 'g' after the final
1421 * delimiter, substitution is global and is marked that
1426 pattern.flags |= VAR_SUB_GLOBAL;
1431 * Global substitution of the empty string causes an
1432 * infinite number of matches, unless anchored by '^'
1433 * (start of string) or '$' (end of string). Catch the
1434 * infinite substitution here.
1435 * Note that flags can only contain the 3 bits we're
1436 * interested in so we don't have to mask unrelated
1437 * bits. We can test for equality.
1439 if (!pattern.leftLen && pattern.flags == VAR_SUB_GLOBAL)
1440 Fatal("Global substitution of the empty string");
1443 newStr = VarModify(str, VarSubstitute, &pattern);
1445 * Free the two strings.
1454 VarREPattern pattern;
1464 if ((re = VarGetPattern(ctxt, err, &cp, delim, NULL,
1465 NULL, NULL)) == NULL) {
1466 /* was: goto cleanup */
1467 *lengthPtr = cp - start + 1;
1471 Fatal("Unclosed substitution for %s (%c missing)",
1476 if ((pattern.replace = VarGetPattern(ctxt, err, &cp,
1477 delim, NULL, NULL, NULL)) == NULL){
1480 /* was: goto cleanup */
1481 *lengthPtr = cp - start + 1;
1485 Fatal("Unclosed substitution for %s (%c missing)",
1493 pattern.flags |= VAR_SUB_GLOBAL;
1496 pattern.flags |= VAR_SUB_ONE;
1506 error = regcomp(&pattern.re, re, REG_EXTENDED);
1509 *lengthPtr = cp - start + 1;
1510 VarREError(error, &pattern.re, "RE substitution error");
1511 free(pattern.replace);
1515 pattern.nsub = pattern.re.re_nsub + 1;
1516 if (pattern.nsub < 1)
1518 if (pattern.nsub > 10)
1520 pattern.matches = emalloc(pattern.nsub *
1521 sizeof(regmatch_t));
1522 newStr = VarModify(str, VarRESubstitute, &pattern);
1523 regfree(&pattern.re);
1524 free(pattern.replace);
1525 free(pattern.matches);
1529 if (tstr[1] == endc || tstr[1] == ':') {
1531 buf = Buf_Init(MAKE_BSIZE);
1532 for (cp = str; *cp ; cp++)
1533 Buf_AddByte(buf, (Byte)tolower(*cp));
1535 Buf_AddByte(buf, (Byte)'\0');
1536 newStr = (char *)Buf_GetAll(buf, (size_t *)NULL);
1537 Buf_Destroy(buf, FALSE);
1545 if (tstr[1] == endc || tstr[1] == ':') {
1546 newStr = VarSortWords(str, SortIncreasing);
1553 if (tstr[1] == endc || tstr[1] == ':') {
1554 newStr = Var_Quote(str);
1561 if (tstr[1] == endc || tstr[1] == ':') {
1562 newStr = VarModify(str, VarTail, (void *)NULL);
1569 if (tstr[1] == endc || tstr[1] == ':') {
1571 buf = Buf_Init(MAKE_BSIZE);
1572 for (cp = str; *cp ; cp++)
1573 Buf_AddByte(buf, (Byte)toupper(*cp));
1575 Buf_AddByte(buf, (Byte)'\0');
1576 newStr = (char *)Buf_GetAll(buf, (size_t *)NULL);
1577 Buf_Destroy(buf, FALSE);
1585 if (tstr[1] == endc || tstr[1] == ':') {
1586 newStr = VarModify(str, VarHead, (void *)NULL);
1593 if (tstr[1] == endc || tstr[1] == ':') {
1594 newStr = VarModify(str, VarSuffix, (void *)NULL);
1601 if (tstr[1] == endc || tstr[1] == ':') {
1602 newStr = VarModify(str, VarRoot, (void *)NULL);
1610 if (tstr[1] == 'h' && (tstr[2] == endc || tstr[2] == ':')) {
1614 buf = Cmd_Exec(str, &error);
1615 newStr = Buf_GetAll(buf, NULL);
1616 Buf_Destroy(buf, FALSE);
1630 * This can either be a bogus modifier or a System-V
1631 * substitution command.
1640 * First we make a pass through the string trying
1641 * to verify it is a SYSV-make-style translation:
1642 * it must be: <string1>=<string2>)
1646 while (*cp != '\0' && cnt) {
1649 /* continue looking for endc */
1651 else if (*cp == endc)
1653 else if (*cp == startc)
1658 if (*cp == endc && eqFound) {
1662 * Now we break this sucker into the lhs and
1663 * rhs. We must null terminate them of course.
1668 if ((pattern.lhs = VarGetPattern(ctxt,
1669 err, &cp, delim, &pattern.flags, &pattern.leftLen,
1671 /* was: goto cleanup */
1672 *lengthPtr = cp - start + 1;
1676 Fatal("Unclosed substitution for %s (%c missing)",
1682 if ((pattern.rhs = VarGetPattern(ctxt,
1683 err, &cp, delim, NULL, &pattern.rightLen,
1684 &pattern)) == NULL) {
1685 /* was: goto cleanup */
1686 *lengthPtr = cp - start + 1;
1690 Fatal("Unclosed substitution for %s (%c missing)",
1696 * SYSV modifications happen through the whole
1697 * string. Note the pattern is anchored at the end.
1701 newStr = VarModify(str, VarSYSVMatch, &pattern);
1710 Error("Unknown modifier '%c'\n", *tstr);
1712 *cp != ':' && *cp != endc && *cp != '\0';
1720 DEBUGF(VAR, ("Result is \"%s\"\n", newStr));
1726 if (str != var_Error) {
1731 if (termc == '\0') {
1732 Error("Unclosed variable specification for %s", v->name);
1733 } else if (termc == ':') {
1740 *lengthPtr = tstr - start + 1;
1742 *lengthPtr = tstr - start + 1;
1746 if (v->flags & VAR_FROM_ENV) {
1747 Boolean destroy = FALSE;
1749 if (str != (char *)Buf_GetAll(v->val, (size_t *)NULL)) {
1753 * Returning the value unmodified, so tell the caller to free
1758 VarDestroy(v, destroy);
1759 } else if (v->flags & VAR_JUNK) {
1761 * Perform any free'ing needed and set *freePtr to FALSE so the caller
1762 * doesn't try to free a static pointer.
1768 VarDestroy(v, TRUE);
1770 str = emalloc(*lengthPtr + 1);
1771 strncpy(str, start, *lengthPtr);
1772 str[*lengthPtr] = '\0';
1775 str = err ? var_Error : varNoError;
1782 *-----------------------------------------------------------------------
1784 * Substitute for all variables in the given string in the given context
1785 * If undefErr is TRUE, Parse_Error will be called when an undefined
1786 * variable is encountered.
1789 * The resulting string.
1792 * None. The old string must be freed by the caller
1793 *-----------------------------------------------------------------------
1796 Var_Subst(const char *var, const char *str, GNode *ctxt, Boolean undefErr)
1798 Boolean errorReported;
1799 Buffer *buf; /* Buffer for forming things */
1802 * Set TRUE if an error has already been reported to prevent a
1803 * plethora of messages when recursing.
1805 errorReported = FALSE;
1809 if (var == NULL && (str[0] == '$') && (str[1] == '$')) {
1811 * A dollar sign may be escaped either with another dollar sign.
1812 * In such a case, we skip over the escape character and store the
1813 * dollar sign into the buffer directly.
1815 Buf_AddByte(buf, (Byte)str[0]);
1818 } else if (str[0] == '$') {
1819 char *val; /* Value to substitute for a variable */
1820 size_t length; /* Length of the variable invocation */
1821 Boolean doFree; /* Set true if val should be freed */
1823 * Variable invocation.
1828 if (str[1] == OPEN_PAREN || str[1] == OPEN_BRACE) {
1830 const char *p = str + 2;
1833 * Scan up to the end of the variable name.
1835 while (*p != '\0' &&
1837 *p != CLOSE_PAREN &&
1838 *p != CLOSE_BRACE &&
1844 * A variable inside the variable. We cannot expand
1845 * the external variable yet, so we try again with
1849 Buf_AppendRange(buf, str, p);
1855 if (var[ln] == '\0' && strncmp(var, str + 2, ln) == 0) {
1859 * Not the variable we want to expand, scan
1860 * until the next variable
1862 while (*p != '$' && *p != '\0')
1865 Buf_AppendRange(buf, str, p);
1871 * Single letter variable name
1873 if (var[1] == '\0' && var[0] == str[1]) {
1876 Buf_AddBytes(buf, 2, (const Byte *)str);
1887 val = Var_Parse(str, ctxt, undefErr, &length, &doFree);
1890 * When we come down here, val should either point to the
1891 * value of this variable, suitably modified, or be NULL.
1892 * Length should be the total length of the potential
1893 * variable invocation (from $ to end character...)
1895 if (val == var_Error || val == varNoError) {
1897 * If performing old-time variable substitution, skip over
1898 * the variable and continue with the substitution. Otherwise,
1899 * store the dollar sign and advance str so we continue with
1904 } else if (undefErr) {
1906 * If variable is undefined, complain and skip the
1907 * variable. The complaint will stop us from doing anything
1908 * when the file is parsed.
1910 if (!errorReported) {
1911 Parse_Error(PARSE_FATAL,
1912 "Undefined variable \"%.*s\"",length,str);
1915 errorReported = TRUE;
1917 Buf_AddByte(buf, (Byte)*str);
1922 * We've now got a variable structure to store in. But first,
1923 * advance the string pointer.
1928 * Copy all the characters from the variable value straight
1929 * into the new string.
1931 Buf_Append(buf, val);
1938 * Skip as many characters as possible -- either to the end of
1939 * the string or to the next dollar sign (variable invocation).
1941 const char *cp = str;
1945 } while (str[0] != '$' && str[0] != '\0');
1947 Buf_AppendRange(buf, cp, str);
1955 *-----------------------------------------------------------------------
1957 * Return the tail from each of a list of words. Used to set the
1958 * System V local variables.
1961 * The resulting string.
1966 *-----------------------------------------------------------------------
1969 Var_GetTail(char *file)
1972 return (VarModify(file, VarTail, (void *)NULL));
1976 *-----------------------------------------------------------------------
1978 * Find the leading components of a (list of) filename(s).
1979 * XXX: VarHead does not replace foo by ., as (sun) System V make
1983 * The leading components.
1988 *-----------------------------------------------------------------------
1991 Var_GetHead(char *file)
1994 return (VarModify(file, VarHead, (void *)NULL));
1998 *-----------------------------------------------------------------------
2000 * Initialize the module
2006 * The VAR_CMD and VAR_GLOBAL contexts are created
2007 *-----------------------------------------------------------------------
2013 VAR_GLOBAL = Targ_NewGN("Global");
2014 VAR_CMD = Targ_NewGN("Command");
2017 /****************** PRINT DEBUGGING INFO *****************/
2019 VarPrintVar(void *vp, void *dummy __unused)
2021 Var *v = (Var *) vp;
2023 printf("%-16s = %s\n", v->name, (char *)Buf_GetAll(v->val, (size_t *)NULL));
2028 *-----------------------------------------------------------------------
2030 * print all variables in a context
2031 *-----------------------------------------------------------------------
2034 Var_Dump(GNode *ctxt)
2037 Lst_ForEach(&ctxt->context, VarPrintVar, (void *)NULL);