patch-7.110 var.c
[dragonfly.git] / usr.bin / make / var.c
1 /*-
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
5  * 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. 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.
25  *
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
36  * SUCH DAMAGE.
37  *
38  * @(#)var.c    8.3 (Berkeley) 3/19/94
39  * $FreeBSD: src/usr.bin/make/var.c,v 1.83 2005/02/11 10:49:01 harti Exp $
40  * $DragonFly: src/usr.bin/make/var.c,v 1.133 2005/03/04 23:51:28 okumoto Exp $
41  */
42
43 /*-
44  * var.c --
45  *      Variable-handling functions
46  *
47  * Interface:
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
51  *                          be preserved.
52  *
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
57  *                          new one.
58  *
59  *      Var_Exists          See if a variable exists.
60  *
61  *      Var_Value           Return the value of a variable in a context or
62  *                          NULL if the variable is undefined.
63  *
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.
69  *
70  *      Var_Parse           Parse a variable expansion from a string and
71  *                          return the result and the number of characters
72  *                          consumed.
73  *
74  *      Var_Delete          Delete a variable in a context.
75  *
76  *      Var_Init            Initialize this module.
77  *
78  * Debugging:
79  *      Var_Dump            Print out all variables defined in the given
80  *                          context.
81  *
82  * XXX: There's a lot of duplication in these functions.
83  */
84
85 #include <assert.h>
86 #include <ctype.h>
87 #include <stdlib.h>
88 #include <string.h>
89
90 #include "buf.h"
91 #include "config.h"
92 #include "globals.h"
93 #include "GNode.h"
94 #include "make.h"
95 #include "nonints.h"
96 #include "parse.h"
97 #include "str.h"
98 #include "targ.h"
99 #include "util.h"
100 #include "var.h"
101
102 /*
103  * This is a harmless return value for Var_Parse that can be used by Var_Subst
104  * to determine if there was an error in parsing -- easier than returning
105  * a flag, as things outside this module don't give a hoot.
106  */
107 char    var_Error[] = "";
108
109 /*
110  * Similar to var_Error, but returned when the 'err' flag for Var_Parse is
111  * set false. Why not just use a constant? Well, gcc likes to condense
112  * identical string instances...
113  */
114 static char     varNoError[] = "";
115
116 /*
117  * Internally, variables are contained in four different contexts.
118  *      1) the environment. They may not be changed. If an environment
119  *          variable is appended-to, the result is placed in the global
120  *          context.
121  *      2) the global context. Variables set in the Makefile are located in
122  *          the global context. It is the penultimate context searched when
123  *          substituting.
124  *      3) the command-line context. All variables set on the command line
125  *         are placed in this context. They are UNALTERABLE once placed here.
126  *      4) the local context. Each target has associated with it a context
127  *         list. On this list are located the structures describing such
128  *         local variables as $(@) and $(*)
129  * The four contexts are searched in the reverse order from which they are
130  * listed.
131  */
132 GNode          *VAR_GLOBAL;   /* variables from the makefile */
133 GNode          *VAR_CMD;      /* variables defined on the command-line */
134
135 #define FIND_CMD        0x1   /* look in VAR_CMD when searching */
136 #define FIND_GLOBAL     0x2   /* look in VAR_GLOBAL as well */
137 #define FIND_ENV        0x4   /* look in the environment also */
138
139 #define OPEN_PAREN              '('
140 #define CLOSE_PAREN             ')'
141 #define OPEN_BRACE              '{'
142 #define CLOSE_BRACE             '}'
143
144 static int VarPrintVar(void *, void *);
145
146 /*
147  * Create a Var object.
148  *
149  * @param name          Name of variable.
150  * @param value         Value of variable.
151  * @param flags         Flags set on variable.
152  */
153 static Var *
154 VarCreate(const char name[], const char value[], int flags)
155 {
156         Var *v;
157
158         v = emalloc(sizeof(Var));
159         v->name = estrdup(name);
160         v->val  = Buf_Init(0);
161         v->flags        = flags;
162
163         if (value != NULL) {
164                 Buf_Append(v->val, value);
165         }
166         return (v);
167 }
168
169 /*
170  * Destroy a Var object.
171  *
172  * @param v     Object to destroy.
173  * @param f     true if internal buffer in Buffer object is to be
174  *              removed.
175  */
176 static void
177 VarDestroy(Var *v, Boolean f)
178 {
179
180         Buf_Destroy(v->val, f);
181         free(v->name);
182         free(v);
183 }
184
185 /*-
186  *-----------------------------------------------------------------------
187  * VarCmp  --
188  *      See if the given variable matches the named one. Called from
189  *      Lst_Find when searching for a variable of a given name.
190  *
191  * Results:
192  *      0 if they match. non-zero otherwise.
193  *
194  * Side Effects:
195  *      none
196  *-----------------------------------------------------------------------
197  */
198 static int
199 VarCmp(const void *v, const void *name)
200 {
201
202     return (strcmp(name, ((const Var *)v)->name));
203 }
204
205 /*-
206  *-----------------------------------------------------------------------
207  * VarPossiblyExpand --
208  *      Expand a variable name's embedded variables in the given context.
209  *
210  * Results:
211  *      The contents of name, possibly expanded.
212  *-----------------------------------------------------------------------
213  */
214 static char *
215 VarPossiblyExpand(const char *name, GNode *ctxt)
216 {
217         Buffer  *buf;
218         char    *str;
219         char    *tmp;
220
221         /*
222          * XXX make a temporary copy of the name because Var_Subst insists
223          * on writing into the string.
224          */
225         tmp = estrdup(name);
226         if (strchr(name, '$') != NULL) {
227                 buf = Var_Subst(NULL, tmp, ctxt, 0);
228                 str = Buf_GetAll(buf, NULL);
229                 Buf_Destroy(buf, FALSE);
230
231                 free(tmp);
232                 return (str);
233         } else {
234                 return (tmp);
235         }
236 }
237
238 /*-
239  *-----------------------------------------------------------------------
240  * VarFind --
241  *      Find the given variable in the given context and any other contexts
242  *      indicated.
243  *
244  *      Flags:
245  *              FIND_GLOBAL     set means look in the VAR_GLOBAL context too
246  *              FIND_CMD        set means to look in the VAR_CMD context too
247  *              FIND_ENV        set means to look in the environment
248  *
249  * Results:
250  *      A pointer to the structure describing the desired variable or
251  *      NULL if the variable does not exist.
252  *
253  * Side Effects:
254  *      None
255  *-----------------------------------------------------------------------
256  */
257 static Var *
258 VarFind(const char *name, GNode *ctxt, int flags)
259 {
260         Boolean localCheckEnvFirst;
261         LstNode *var;
262         char    *env;
263
264         /*
265          * If the variable name begins with a '.', it could very well be one of
266          * the local ones.  We check the name against all the local variables
267          * and substitute the short version in for 'name' if it matches one of
268          * them.
269          */
270         if (name[0] == '.') {
271                 switch (name[1]) {
272                 case 'A':
273                         if (!strcmp(name, ".ALLSRC"))
274                                 name = ALLSRC;
275                         if (!strcmp(name, ".ARCHIVE"))
276                                 name = ARCHIVE;
277                         break;
278                 case 'I':
279                         if (!strcmp(name, ".IMPSRC"))
280                                 name = IMPSRC;
281                         break;
282                 case 'M':
283                         if (!strcmp(name, ".MEMBER"))
284                                 name = MEMBER;
285                         break;
286                 case 'O':
287                         if (!strcmp(name, ".OODATE"))
288                                 name = OODATE;
289                         break;
290                 case 'P':
291                         if (!strcmp(name, ".PREFIX"))
292                                 name = PREFIX;
293                         break;
294                 case 'T':
295                         if (!strcmp(name, ".TARGET"))
296                                 name = TARGET;
297                         break;
298                 default:
299                         break;
300                 }
301         }
302
303         /*
304          * Note whether this is one of the specific variables we were told
305          * through the -E flag to use environment-variable-override for.
306          */
307         if (Lst_Find(&envFirstVars, name, (CompareProc *)strcmp) != NULL) {
308                 localCheckEnvFirst = TRUE;
309         } else {
310                 localCheckEnvFirst = FALSE;
311         }
312
313         /*
314          * First look for the variable in the given context. If it's not there,
315          * look for it in VAR_CMD, VAR_GLOBAL and the environment,
316          * in that order, depending on the FIND_* flags in 'flags'
317          */
318         var = Lst_Find(&ctxt->context, name, VarCmp);
319         if (var != NULL) {
320                 /* got it */
321                 return (Lst_Datum(var));
322         }
323
324         /* not there - try command line context */
325         if ((flags & FIND_CMD) && (ctxt != VAR_CMD)) {
326                 var = Lst_Find(&VAR_CMD->context, name, VarCmp);
327                 if (var != NULL)
328                         return (Lst_Datum(var));
329         }
330
331         /* not there - try global context, but only if not -e/-E */
332         if ((flags & FIND_GLOBAL) && (ctxt != VAR_GLOBAL) &&
333             !checkEnvFirst && !localCheckEnvFirst) {
334                 var = Lst_Find(&VAR_GLOBAL->context, name, VarCmp);
335                 if (var != NULL)
336                         return (Lst_Datum(var));
337         }
338
339         if (!(flags & FIND_ENV))
340                 /* we were not told to look into the environment */
341                 return (NULL);
342
343         /* look in the environment */
344         if ((env = getenv(name)) != NULL) {
345                 /* craft this variable from the environment value */
346                 return (VarCreate(name, env, VAR_FROM_ENV));
347         }
348
349         /* deferred check for the environment (in case of -e/-E) */
350         if ((checkEnvFirst || localCheckEnvFirst) &&
351             (flags & FIND_GLOBAL) && (ctxt != VAR_GLOBAL)) {
352                 var = Lst_Find(&VAR_GLOBAL->context, name, VarCmp);
353                 if (var != NULL)
354                         return (Lst_Datum(var));
355         }
356         return (NULL);
357 }
358
359 /*-
360  *-----------------------------------------------------------------------
361  * VarAdd  --
362  *      Add a new variable of name name and value val to the given context.
363  *
364  * Results:
365  *      None
366  *
367  * Side Effects:
368  *      The new variable is placed at the front of the given context
369  *      The name and val arguments are duplicated so they may
370  *      safely be freed.
371  *-----------------------------------------------------------------------
372  */
373 static void
374 VarAdd(const char *name, const char *val, GNode *ctxt)
375 {
376
377     Lst_AtFront(&ctxt->context, VarCreate(name, val, 0));
378
379     DEBUGF(VAR, ("%s:%s = %s\n", ctxt->name, name, val));
380 }
381
382 /*-
383  *-----------------------------------------------------------------------
384  * Var_Delete --
385  *      Remove a variable from a context.
386  *
387  * Results:
388  *      None.
389  *
390  * Side Effects:
391  *      The Var structure is removed and freed.
392  *
393  *-----------------------------------------------------------------------
394  */
395 void
396 Var_Delete(const char *name, GNode *ctxt)
397 {
398     LstNode *ln;
399
400     DEBUGF(VAR, ("%s:delete %s\n", ctxt->name, name));
401     ln = Lst_Find(&ctxt->context, name, VarCmp);
402     if (ln != NULL) {
403         VarDestroy(Lst_Datum(ln), TRUE);
404         Lst_Remove(&ctxt->context, ln);
405     }
406 }
407
408 /*-
409  *-----------------------------------------------------------------------
410  * Var_Set --
411  *      Set the variable name to the value val in the given context.
412  *
413  * Results:
414  *      None.
415  *
416  * Side Effects:
417  *      If the variable doesn't yet exist, a new record is created for it.
418  *      Else the old value is freed and the new one stuck in its place
419  *
420  * Notes:
421  *      The variable is searched for only in its context before being
422  *      created in that context. I.e. if the context is VAR_GLOBAL,
423  *      only VAR_GLOBAL->context is searched. Likewise if it is VAR_CMD, only
424  *      VAR_CMD->context is searched. This is done to avoid the literally
425  *      thousands of unnecessary strcmp's that used to be done to
426  *      set, say, $(@) or $(<).
427  *-----------------------------------------------------------------------
428  */
429 void
430 Var_Set(const char *name, const char *val, GNode *ctxt)
431 {
432     Var         *v;
433     char        *n;
434
435     /*
436      * We only look for a variable in the given context since anything set
437      * here will override anything in a lower context, so there's not much
438      * point in searching them all just to save a bit of memory...
439      */
440     n = VarPossiblyExpand(name, ctxt);
441     v = VarFind(n, ctxt, 0);
442     if (v == NULL) {
443         VarAdd(n, val, ctxt);
444     } else {
445         Buf_Clear(v->val);
446         Buf_Append(v->val, val);
447
448         DEBUGF(VAR, ("%s:%s = %s\n", ctxt->name, n, val));
449     }
450     /*
451      * Any variables given on the command line are automatically exported
452      * to the environment (as per POSIX standard)
453      */
454     if (ctxt == VAR_CMD || (v != (Var *)NULL && (v->flags & VAR_TO_ENV))) {
455         setenv(n, val, 1);
456     }
457     free(n);
458 }
459
460 /*
461  * Var_SetEnv --
462  *      Set the VAR_TO_ENV flag on a variable
463  */
464 void
465 Var_SetEnv(const char *name, GNode *ctxt)
466 {
467     Var *v;
468
469     v = VarFind(name, ctxt, FIND_CMD|FIND_GLOBAL|FIND_ENV);
470     if (v) {
471         if ((v->flags & VAR_TO_ENV) == 0) {
472             v->flags |= VAR_TO_ENV;
473             setenv(v->name, Buf_GetAll(v->val, NULL), 1);
474         }
475     } else {
476         Error("Cannot set environment flag on non-existant variable %s", name);
477     }
478 }
479
480 /*-
481  *-----------------------------------------------------------------------
482  * Var_Append --
483  *      The variable of the given name has the given value appended to it in
484  *      the given context.
485  *
486  * Results:
487  *      None
488  *
489  * Side Effects:
490  *      If the variable doesn't exist, it is created. Else the strings
491  *      are concatenated (with a space in between).
492  *
493  * Notes:
494  *      Only if the variable is being sought in the global context is the
495  *      environment searched.
496  *      XXX: Knows its calling circumstances in that if called with ctxt
497  *      an actual target, it will only search that context since only
498  *      a local variable could be being appended to. This is actually
499  *      a big win and must be tolerated.
500  *-----------------------------------------------------------------------
501  */
502 void
503 Var_Append(const char *name, const char *val, GNode *ctxt)
504 {
505     Var         *v;
506     char        *n;
507
508     n = VarPossiblyExpand(name, ctxt);
509     v = VarFind(n, ctxt, (ctxt == VAR_GLOBAL) ? FIND_ENV : 0);
510
511     if (v == NULL) {
512         VarAdd(n, val, ctxt);
513     } else {
514         Buf_AddByte(v->val, (Byte)' ');
515         Buf_Append(v->val, val);
516
517         DEBUGF(VAR, ("%s:%s = %s\n", ctxt->name, n,
518                (char *)Buf_GetAll(v->val, (size_t *)NULL)));
519
520         if (v->flags & VAR_FROM_ENV) {
521             /*
522              * If the original variable came from the environment, we
523              * have to install it in the global context (we could place
524              * it in the environment, but then we should provide a way to
525              * export other variables...)
526              */
527             v->flags &= ~VAR_FROM_ENV;
528             Lst_AtFront(&ctxt->context, v);
529         }
530     }
531     free(n);
532 }
533
534 /*-
535  *-----------------------------------------------------------------------
536  * Var_Exists --
537  *      See if the given variable exists.
538  *
539  * Results:
540  *      TRUE if it does, FALSE if it doesn't
541  *
542  * Side Effects:
543  *      None.
544  *
545  *-----------------------------------------------------------------------
546  */
547 Boolean
548 Var_Exists(const char *name, GNode *ctxt)
549 {
550     Var         *v;
551     char        *n;
552
553     n = VarPossiblyExpand(name, ctxt);
554     v = VarFind(n, ctxt, FIND_CMD|FIND_GLOBAL|FIND_ENV);
555     free(n);
556
557     if (v == NULL) {
558         return (FALSE);
559     } else if (v->flags & VAR_FROM_ENV) {
560         VarDestroy(v, TRUE);
561     }
562     return (TRUE);
563 }
564
565 /*-
566  *-----------------------------------------------------------------------
567  * Var_Value --
568  *      Return the value of the named variable in the given context
569  *
570  * Results:
571  *      The value if the variable exists, NULL if it doesn't
572  *
573  * Side Effects:
574  *      None
575  *-----------------------------------------------------------------------
576  */
577 char *
578 Var_Value(const char *name, GNode *ctxt, char **frp)
579 {
580     Var         *v;
581     char        *n;
582
583     n = VarPossiblyExpand(name, ctxt);
584     v = VarFind(n, ctxt, FIND_ENV | FIND_GLOBAL | FIND_CMD);
585     free(n);
586     *frp = NULL;
587     if (v != NULL) {
588         char *p = (char *)Buf_GetAll(v->val, (size_t *)NULL);
589
590         if (v->flags & VAR_FROM_ENV) {
591             VarDestroy(v, FALSE);
592             *frp = p;
593         }
594         return (p);
595     } else {
596         return (NULL);
597     }
598 }
599
600 /*-
601  *-----------------------------------------------------------------------
602  * VarModify --
603  *      Modify each of the words of the passed string using the given
604  *      function. Used to implement all modifiers.
605  *
606  * Results:
607  *      A string of all the words modified appropriately.
608  *
609  * Side Effects:
610  *      Uses brk_string() so it invalidates any previous call to
611  *      brk_string().
612  *
613  *-----------------------------------------------------------------------
614  */
615 static char *
616 VarModify(const char *str, VarModifyProc *modProc, void *datum)
617 {
618         char    **av;           /* word list [first word does not count] */
619         int     ac;
620         Buffer  *buf;           /* Buffer for the new string */
621         Boolean addSpace;       /* TRUE if need to add a space to the buffer
622                                  * before adding the trimmed word */
623         int     i;
624         char    *result;
625
626         av = brk_string(str, &ac, FALSE);
627
628         buf = Buf_Init(0);
629
630         addSpace = FALSE;
631         for (i = 1; i < ac; i++)
632                 addSpace = (*modProc) (av[i], addSpace, buf, datum);
633
634         result = (char *)Buf_GetAll(buf, (size_t *) NULL);
635         Buf_Destroy(buf, FALSE);
636
637         return (result);
638 }
639
640 /*-
641  *-----------------------------------------------------------------------
642  * VarSortWords --
643  *      Sort the words in the string.
644  *
645  * Input:
646  *      str             String whose words should be sorted
647  *      cmp             A comparison function to control the ordering
648  *
649  * Results:
650  *      A string containing the words sorted
651  *
652  * Side Effects:
653  *      Uses brk_string() so it invalidates any previous call to
654  *      brk_string().
655  *
656  *-----------------------------------------------------------------------
657  */
658 static char *
659 VarSortWords(const char *str, int (*cmp)(const void *, const void *))
660 {
661         char    **av;
662         int     ac;
663         Buffer  *buf;
664         int     i;
665         char    *result;
666
667         av = brk_string(str, &ac, FALSE);
668         qsort(av + 1, ac - 1, sizeof(char *), cmp);
669
670         buf = Buf_Init(0);
671         for (i = 1; i < ac; i++) {
672                 Buf_Append(buf, av[i]);
673                 Buf_AddByte(buf, (Byte)((i < ac - 1) ? ' ' : '\0'));
674         }
675
676         result = (char *)Buf_GetAll(buf, (size_t *)NULL);
677         Buf_Destroy(buf, FALSE);
678         return (result);
679 }
680
681 static int
682 SortIncreasing(const void *l, const void *r)
683 {
684
685         return (strcmp(*(const char* const*)l, *(const char* const*)r));
686 }
687
688 /*-
689  *-----------------------------------------------------------------------
690  * VarGetPattern --
691  *      Pass through the tstr looking for 1) escaped delimiters,
692  *      '$'s and backslashes (place the escaped character in
693  *      uninterpreted) and 2) unescaped $'s that aren't before
694  *      the delimiter (expand the variable substitution unless flags
695  *      has VAR_NOSUBST set).
696  *      Return the expanded string or NULL if the delimiter was missing
697  *      If pattern is specified, handle escaped ampersands, and replace
698  *      unescaped ampersands with the lhs of the pattern.
699  *
700  * Results:
701  *      A string of all the words modified appropriately.
702  *      If length is specified, return the string length of the buffer
703  *      If flags is specified and the last character of the pattern is a
704  *      $ set the VAR_MATCH_END bit of flags.
705  *
706  * Side Effects:
707  *      None.
708  *-----------------------------------------------------------------------
709  */
710 static char *
711 VarGetPattern(GNode *ctxt, int err, const char **tstr, int delim, int *flags,
712     size_t *length, VarPattern *pattern)
713 {
714     const char *cp;
715     Buffer *buf = Buf_Init(0);
716     size_t junk;
717
718     if (length == NULL)
719         length = &junk;
720
721 #define IS_A_MATCH(cp, delim) \
722     ((cp[0] == '\\') && ((cp[1] == delim) ||  \
723      (cp[1] == '\\') || (cp[1] == '$') || (pattern && (cp[1] == '&'))))
724
725     /*
726      * Skim through until the matching delimiter is found;
727      * pick up variable substitutions on the way. Also allow
728      * backslashes to quote the delimiter, $, and \, but don't
729      * touch other backslashes.
730      */
731     for (cp = *tstr; *cp && (*cp != delim); cp++) {
732         if (IS_A_MATCH(cp, delim)) {
733             Buf_AddByte(buf, (Byte)cp[1]);
734             cp++;
735         } else if (*cp == '$') {
736             if (cp[1] == delim) {
737                 if (flags == NULL)
738                     Buf_AddByte(buf, (Byte)*cp);
739                 else
740                     /*
741                      * Unescaped $ at end of pattern => anchor
742                      * pattern at end.
743                      */
744                     *flags |= VAR_MATCH_END;
745             } else {
746                 if (flags == NULL || (*flags & VAR_NOSUBST) == 0) {
747                     char   *cp2;
748                     size_t len;
749                     Boolean freeIt;
750
751                     /*
752                      * If unescaped dollar sign not before the
753                      * delimiter, assume it's a variable
754                      * substitution and recurse.
755                      */
756                     len = 0;
757                     cp2 = Var_Parse(cp, ctxt, err, &len, &freeIt);
758                     Buf_Append(buf, cp2);
759                     if (freeIt)
760                         free(cp2);
761                     cp += len - 1;
762                 } else {
763                     const char *cp2 = &cp[1];
764
765                     if (*cp2 == OPEN_PAREN || *cp2 == OPEN_BRACE) {
766                         /*
767                          * Find the end of this variable reference
768                          * and suck it in without further ado.
769                          * It will be interperated later.
770                          */
771                         int have = *cp2;
772                         int want = (*cp2 == OPEN_PAREN) ? CLOSE_PAREN : CLOSE_BRACE;
773                         int depth = 1;
774
775                         for (++cp2; *cp2 != '\0' && depth > 0; ++cp2) {
776                             if (cp2[-1] != '\\') {
777                                 if (*cp2 == have)
778                                     ++depth;
779                                 if (*cp2 == want)
780                                     --depth;
781                             }
782                         }
783                         Buf_AppendRange(buf, cp, cp2);
784                         cp = --cp2;
785                     } else
786                         Buf_AddByte(buf, (Byte)*cp);
787                 }
788             }
789         }
790         else if (pattern && *cp == '&')
791             Buf_AddBytes(buf, pattern->leftLen, (Byte *)pattern->lhs);
792         else
793             Buf_AddByte(buf, (Byte)*cp);
794     }
795
796     Buf_AddByte(buf, (Byte)'\0');
797
798     if (*cp != delim) {
799         *tstr = cp;
800         *length = 0;
801         return (NULL);
802     } else {
803         char *result;
804         *tstr = ++cp;
805         result = (char *)Buf_GetAll(buf, length);
806         *length -= 1;   /* Don't count the NULL */
807         Buf_Destroy(buf, FALSE);
808         return (result);
809     }
810 }
811
812 /*-
813  *-----------------------------------------------------------------------
814  * Var_Quote --
815  *      Quote shell meta-characters in the string
816  *
817  * Results:
818  *      The quoted string
819  *
820  * Side Effects:
821  *      None.
822  *
823  *-----------------------------------------------------------------------
824  */
825 char *
826 Var_Quote(const char *str)
827 {
828     Buffer       *buf;
829     /* This should cover most shells :-( */
830     static char meta[] = "\n \t'`\";&<>()|*?{}[]\\$!#^~";
831     char          *ret;
832
833     buf = Buf_Init(MAKE_BSIZE);
834     for (; *str; str++) {
835         if (strchr(meta, *str) != NULL)
836             Buf_AddByte(buf, (Byte)'\\');
837         Buf_AddByte(buf, (Byte)*str);
838     }
839     Buf_AddByte(buf, (Byte)'\0');
840     ret = Buf_GetAll(buf, NULL);
841     Buf_Destroy(buf, FALSE);
842     return (ret);
843 }
844
845 /*-
846  *-----------------------------------------------------------------------
847  * VarREError --
848  *      Print the error caused by a regcomp or regexec call.
849  *
850  * Results:
851  *      None.
852  *
853  * Side Effects:
854  *      An error gets printed.
855  *
856  *-----------------------------------------------------------------------
857  */
858 void
859 VarREError(int err, regex_t *pat, const char *str)
860 {
861     char *errbuf;
862     int errlen;
863
864     errlen = regerror(err, pat, 0, 0);
865     errbuf = emalloc(errlen);
866     regerror(err, pat, errbuf, errlen);
867     Error("%s: %s", str, errbuf);
868     free(errbuf);
869 }
870
871 /*
872  * Make sure this variable is fully expanded.
873  */
874 static char *
875 VarExpand(Var *v, GNode *ctxt, Boolean err)
876 {
877         char    *value;
878         char    *result;
879
880         if (v->flags & VAR_IN_USE) {
881                 Fatal("Variable %s is recursive.", v->name);
882                 /* NOTREACHED */
883         }
884
885         v->flags |= VAR_IN_USE;
886
887         /*
888          * Before doing any modification, we have to make sure the
889          * value has been fully expanded. If it looks like recursion
890          * might be necessary (there's a dollar sign somewhere in the
891          * variable's value) we just call Var_Subst to do any other
892          * substitutions that are necessary. Note that the value
893          * returned by Var_Subst will have been
894          * dynamically-allocated, so it will need freeing when we
895          * return.
896          */
897         value = (char *)Buf_GetAll(v->val, (size_t *)NULL);
898         if (strchr(value, '$') == NULL) {
899                 result = strdup(value);
900         } else {
901                 Buffer  *buf;
902
903                 buf = Var_Subst(NULL, value, ctxt, err);
904                 result = Buf_GetAll(buf, NULL);
905                 Buf_Destroy(buf, FALSE);
906         }
907
908         v->flags &= ~VAR_IN_USE;
909
910         return (result);
911 }
912
913 /**
914  * Select only those words that match the modifier.
915  */
916 static char *
917 modifier_M(const char mod[], const char value[], char endc, size_t *consumed)
918 {
919         const char      *cur;
920         const char      *end;
921         char            *patt;
922         char            *ptr;
923         char            *newValue;
924
925         for (cur = mod + 1; *cur != '\0'; cur++) {
926                 if (cur[0] == endc) {
927                         break;
928                 } else if (cur[0] == ':') {
929                         break;
930                 } else if ((cur[0] == '\\') &&
931                            (cur[1] == ':' || cur[1] == endc)) {
932                         cur++;
933                 }
934         }
935         end = cur;
936
937         /*
938          * Compress the \:'s out of the pattern, so allocate enough
939          * room to hold the uncompressed pattern and compress the
940          * pattern into the space. (note that cur started at mod+1
941          * so cur-mod takes the null byte into account)
942          */
943         patt = emalloc(cur - mod);
944         ptr = patt;
945         for (cur = mod + 1; cur != end; cur++) {
946                 if ((cur[0] == '\\') &&
947                     (cur[1] == ':' || cur[1] == endc)) {
948                         cur++;
949                 }
950                 *ptr = *cur;
951                 ptr++;
952         }
953         *ptr = '\0';
954
955         if (*mod == 'M' || *mod == 'm') {
956                 newValue = VarModify(value, VarMatch, patt);
957         } else {
958                 newValue = VarModify(value, VarNoMatch, patt);
959         }
960         free(patt);
961
962         *consumed += (end - mod);
963
964         if (*end == ':') {
965                 *consumed += 1; /* include colin as part of modifier */
966         }
967
968         return (newValue);
969 }
970
971 static char *
972 modifier_S(const char mod[], const char value[], Var *v, GNode *ctxt, Boolean err, size_t *consumed)
973 {
974         VarPattern      pattern;
975         Buffer          *buf;           /* Buffer for patterns */
976         char            delim;
977         const char      *cur;
978         char            *newValue;
979
980         pattern.flags = 0;
981         buf = Buf_Init(0);
982
983         delim = mod[1]; /* used to find end of pattern */
984
985         /*
986          * If pattern begins with '^', it is anchored to the start of the
987          * word -- skip over it and flag pattern.
988          */
989         if (mod[2] == '^') {
990                 pattern.flags |= VAR_MATCH_START;
991                 cur = mod + 3;
992         } else {
993                 cur = mod + 2;
994         }
995
996         /*
997          * Pass through the lhs looking for 1) escaped delimiters, '$'s and
998          * backslashes (place the escaped character in uninterpreted) and 2)
999          * unescaped $'s that aren't before the delimiter (expand the
1000          * variable substitution). The result is left in the Buffer buf.
1001          */
1002         while (cur[0] != delim) {
1003                 if (cur[0] == '\0') {
1004                         /*
1005                          * LHS didn't end with the delim, complain and exit.
1006                          */
1007                         Fatal("Unclosed substitution for %s (%c missing)",
1008                               v->name, delim);
1009
1010                 } else if ((cur[0] == '\\') &&
1011                            ((cur[1] == delim) ||
1012                             (cur[1] == '$') ||
1013                             (cur[1] == '\\'))) {
1014                         cur++;  /* skip backslash */
1015                         Buf_AddByte(buf, (Byte) cur[0]);
1016                         cur++;
1017
1018                 } else if (cur[0] == '$') {
1019                         if (cur[1] == delim) {
1020                                 /*
1021                                  * Unescaped $ at end of pattern => anchor
1022                                  * pattern at end.
1023                                  */
1024                                 pattern.flags |= VAR_MATCH_END;
1025                                 cur++;
1026                         } else {
1027                                 /*
1028                                  * If unescaped dollar sign not before the
1029                                  * delimiter, assume it's a variable
1030                                  * substitution and recurse.
1031                                  */
1032                                 char   *cp2;
1033                                 size_t  len;
1034                                 Boolean freeIt;
1035
1036                                 len = 0;
1037                                 cp2 = Var_Parse(cur, ctxt, err, &len, &freeIt);
1038                                 cur += len;
1039                                 Buf_Append(buf, cp2);
1040                                 if (freeIt) {
1041                                         free(cp2);
1042                                 }
1043                         }
1044                 } else {
1045                         Buf_AddByte(buf, (Byte)cur[0]);
1046                         cur++;
1047                 }
1048         }
1049         cur++;  /* skip over delim */
1050
1051         /*
1052          * Fetch pattern and destroy buffer, but preserve the data in it,
1053          * since that's our lhs.
1054          */
1055         pattern.lhs = (char *)Buf_GetAll(buf, &pattern.leftLen);
1056         Buf_Destroy(buf, FALSE);
1057
1058         /*
1059          * Now comes the replacement string. Three things need to be done
1060          * here: 1) need to compress escaped delimiters and ampersands and 2)
1061          * need to replace unescaped ampersands with the l.h.s. (since this
1062          * isn't regexp, we can do it right here) and 3) expand any variable
1063          * substitutions.
1064          */
1065         buf = Buf_Init(0);
1066
1067         while (cur[0] != delim) {
1068                 if (cur[0] == '\0') {
1069                         /*
1070                          * Didn't end with delim character, complain
1071                          */
1072                         Fatal("Unclosed substitution for %s (%c missing)",
1073                               v->name, delim);
1074
1075                 } else if ((cur[0] == '\\') &&
1076                     ((cur[1] == delim) ||
1077                      (cur[1] == '&') ||
1078                      (cur[1] == '\\') ||
1079                      (cur[1] == '$'))) {
1080                         cur++;  /* skip backslash */
1081                         Buf_AddByte(buf, (Byte) cur[0]);
1082                         cur++;
1083
1084                 } else if (cur[0] == '$') {
1085                          if (cur[1] == delim) {
1086                                 Buf_AddByte(buf, (Byte) cur[0]);
1087                                 cur++;
1088                         } else {
1089                                 char   *cp2;
1090                                 size_t  len;
1091                                 Boolean freeIt;
1092
1093                                 len = 0;
1094                                 cp2 = Var_Parse(cur, ctxt, err, &len, &freeIt);
1095                                 cur += len;
1096                                 Buf_Append(buf, cp2);
1097                                 if (freeIt) {
1098                                         free(cp2);
1099                                 }
1100                         }
1101                 } else if (cur[0] == '&') {
1102                         Buf_AddBytes(buf, pattern.leftLen, (Byte *)pattern.lhs);
1103                         cur++;
1104                 } else {
1105                         Buf_AddByte(buf, (Byte) cur[0]);
1106                         cur++;
1107                 }
1108         }
1109         cur++;  /* skip over delim */
1110
1111         pattern.rhs = (char *)Buf_GetAll(buf, &pattern.rightLen);
1112         Buf_Destroy(buf, FALSE);
1113
1114         /*
1115          * Check for global substitution. If 'g' after the final delimiter,
1116          * substitution is global and is marked that way.
1117          */
1118         if (cur[0] == 'g') {
1119                 pattern.flags |= VAR_SUB_GLOBAL;
1120                 cur++;
1121         }
1122
1123         /*
1124          * Global substitution of the empty string causes an infinite number
1125          * of matches, unless anchored by '^' (start of string) or '$' (end
1126          * of string). Catch the infinite substitution here. Note that flags
1127          * can only contain the 3 bits we're interested in so we don't have
1128          * to mask unrelated bits. We can test for equality.
1129          */
1130         if (!pattern.leftLen && pattern.flags == VAR_SUB_GLOBAL)
1131                 Fatal("Global substitution of the empty string");
1132
1133         newValue = VarModify(value, VarSubstitute, &pattern);
1134
1135         /*
1136          * Free the two strings.
1137          */
1138         free(pattern.lhs);
1139         free(pattern.rhs);
1140
1141         *consumed += (cur - mod);
1142
1143         if (cur[0] == ':') {
1144                 *consumed += 1; /* include colin as part of modifier */
1145         }
1146
1147         return (newValue);
1148 }
1149
1150 /*
1151  * Now we need to apply any modifiers the user wants applied.
1152  * These are:
1153  *      :M<pattern>
1154  *              words which match the given <pattern>.
1155  *              <pattern> is of the standard file
1156  *              wildcarding form.
1157  *      :S<d><pat1><d><pat2><d>[g]
1158  *              Substitute <pat2> for <pat1> in the value
1159  *      :C<d><pat1><d><pat2><d>[g]
1160  *              Substitute <pat2> for regex <pat1> in the value
1161  *      :H      Substitute the head of each word
1162  *      :T      Substitute the tail of each word
1163  *      :E      Substitute the extension (minus '.') of
1164  *              each word
1165  *      :R      Substitute the root of each word
1166  *              (pathname minus the suffix).
1167  *      :lhs=rhs
1168  *              Like :S, but the rhs goes to the end of
1169  *              the invocation.
1170  *      :U      Converts variable to upper-case.
1171  *      :L      Converts variable to lower-case.
1172  *
1173  * XXXHB update this comment or remove it and point to the man page.
1174  */
1175 static char *
1176 ParseModifier(const char input[], const char tstr[],
1177         char startc, char endc, Boolean dynamic, Var *v,
1178         GNode *ctxt, Boolean err, size_t *lengthPtr, Boolean *freePtr)
1179 {
1180         char            *rw_str;
1181         const char      *cp;
1182
1183         rw_str = VarExpand(v, ctxt, err);
1184         *freePtr = TRUE;
1185
1186         tstr++;
1187         while (*tstr != endc) {
1188             char        *newStr;    /* New value to return */
1189             char        termc;      /* Character which terminated scan */
1190             Boolean     readonly = FALSE;
1191             size_t      consumed = 0;
1192
1193             DEBUGF(VAR, ("Applying :%c to \"%s\"\n", *tstr, rw_str));
1194             switch (*tstr) {
1195                 case 'N':
1196                 case 'M':
1197                         readonly = TRUE; /* tstr isn't modified here */
1198
1199                         newStr = modifier_M(tstr, rw_str, endc, &consumed);
1200                         tstr += consumed;
1201                         break;
1202                 case 'S':
1203
1204                         readonly = TRUE; /* tstr isn't modified here */
1205
1206                         newStr = modifier_S(tstr, rw_str, v, ctxt, err, &consumed);
1207                         tstr += consumed;
1208                         break;
1209                 case 'C':
1210                 {
1211                     int         delim;
1212                     VarREPattern    pattern;
1213                     char           *re;
1214                     int             error;
1215
1216                     pattern.flags = 0;
1217                     delim = tstr[1];
1218                     tstr += 2;
1219
1220                     cp = tstr;
1221
1222                     if ((re = VarGetPattern(ctxt, err, &cp, delim, NULL,
1223                         NULL, NULL)) == NULL) {
1224                         /* was: goto cleanup */
1225                         *lengthPtr = cp - input + 1;
1226                         if (*freePtr)
1227                             free(rw_str);
1228                         if (delim != '\0')
1229                             Fatal("Unclosed substitution for %s (%c missing)",
1230                                   v->name, delim);
1231                         return (var_Error);
1232                     }
1233
1234                     if ((pattern.replace = VarGetPattern(ctxt, err, &cp,
1235                         delim, NULL, NULL, NULL)) == NULL){
1236                         free(re);
1237
1238                         /* was: goto cleanup */
1239                         *lengthPtr = cp - input + 1;
1240                         if (*freePtr)
1241                             free(rw_str);
1242                         if (delim != '\0')
1243                             Fatal("Unclosed substitution for %s (%c missing)",
1244                                   v->name, delim);
1245                         return (var_Error);
1246                     }
1247
1248                     for (;; cp++) {
1249                         switch (*cp) {
1250                         case 'g':
1251                             pattern.flags |= VAR_SUB_GLOBAL;
1252                             continue;
1253                         case '1':
1254                             pattern.flags |= VAR_SUB_ONE;
1255                             continue;
1256                         default:
1257                             break;
1258                         }
1259                         break;
1260                     }
1261
1262                     termc = *cp;
1263
1264                     error = regcomp(&pattern.re, re, REG_EXTENDED);
1265                     free(re);
1266                     if (error)  {
1267                         *lengthPtr = cp - input + 1;
1268                         VarREError(error, &pattern.re, "RE substitution error");
1269                         free(pattern.replace);
1270                         return (var_Error);
1271                     }
1272
1273                     pattern.nsub = pattern.re.re_nsub + 1;
1274                     if (pattern.nsub < 1)
1275                         pattern.nsub = 1;
1276                     if (pattern.nsub > 10)
1277                         pattern.nsub = 10;
1278                     pattern.matches = emalloc(pattern.nsub *
1279                                               sizeof(regmatch_t));
1280                     newStr = VarModify(rw_str, VarRESubstitute, &pattern);
1281                     regfree(&pattern.re);
1282                     free(pattern.replace);
1283                     free(pattern.matches);
1284                     break;
1285                 }
1286                 case 'L':
1287                     if (tstr[1] == endc || tstr[1] == ':') {
1288                         Buffer *buf;
1289                         buf = Buf_Init(MAKE_BSIZE);
1290                         for (cp = rw_str; *cp ; cp++)
1291                             Buf_AddByte(buf, (Byte)tolower(*cp));
1292
1293                         Buf_AddByte(buf, (Byte)'\0');
1294                         newStr = (char *)Buf_GetAll(buf, (size_t *)NULL);
1295                         Buf_Destroy(buf, FALSE);
1296
1297                         cp = tstr + 1;
1298                         termc = *cp;
1299                         break;
1300                     }
1301                     /* FALLTHROUGH */
1302                 case 'O':
1303                     if (tstr[1] == endc || tstr[1] == ':') {
1304                         newStr = VarSortWords(rw_str, SortIncreasing);
1305                         cp = tstr + 1;
1306                         termc = *cp;
1307                         break;
1308                     }
1309                     /* FALLTHROUGH */
1310                 case 'Q':
1311                     if (tstr[1] == endc || tstr[1] == ':') {
1312                         newStr = Var_Quote(rw_str);
1313                         cp = tstr + 1;
1314                         termc = *cp;
1315                         break;
1316                     }
1317                     /*FALLTHRU*/
1318                 case 'T':
1319                     if (tstr[1] == endc || tstr[1] == ':') {
1320                         newStr = VarModify(rw_str, VarTail, (void *)NULL);
1321                         cp = tstr + 1;
1322                         termc = *cp;
1323                         break;
1324                     }
1325                     /*FALLTHRU*/
1326                 case 'U':
1327                     if (tstr[1] == endc || tstr[1] == ':') {
1328                         Buffer *buf;
1329                         buf = Buf_Init(MAKE_BSIZE);
1330                         for (cp = rw_str; *cp ; cp++)
1331                             Buf_AddByte(buf, (Byte)toupper(*cp));
1332
1333                         Buf_AddByte(buf, (Byte)'\0');
1334                         newStr = (char *)Buf_GetAll(buf, (size_t *)NULL);
1335                         Buf_Destroy(buf, FALSE);
1336
1337                         cp = tstr + 1;
1338                         termc = *cp;
1339                         break;
1340                     }
1341                     /* FALLTHROUGH */
1342                 case 'H':
1343                     if (tstr[1] == endc || tstr[1] == ':') {
1344                         newStr = VarModify(rw_str, VarHead, (void *)NULL);
1345                         cp = tstr + 1;
1346                         termc = *cp;
1347                         break;
1348                     }
1349                     /*FALLTHRU*/
1350                 case 'E':
1351                     if (tstr[1] == endc || tstr[1] == ':') {
1352                         newStr = VarModify(rw_str, VarSuffix, (void *)NULL);
1353                         cp = tstr + 1;
1354                         termc = *cp;
1355                         break;
1356                     }
1357                     /*FALLTHRU*/
1358                 case 'R':
1359                     if (tstr[1] == endc || tstr[1] == ':') {
1360                         newStr = VarModify(rw_str, VarRoot, (void *)NULL);
1361                         cp = tstr + 1;
1362                         termc = *cp;
1363                         break;
1364                     }
1365                     /*FALLTHRU*/
1366 #ifdef SUNSHCMD
1367                 case 's':
1368                     if (tstr[1] == 'h' && (tstr[2] == endc || tstr[2] == ':')) {
1369                         const char *error;
1370                         Buffer *buf;
1371
1372                         buf = Cmd_Exec(rw_str, &error);
1373                         newStr = Buf_GetAll(buf, NULL);
1374                         Buf_Destroy(buf, FALSE);
1375
1376                         if (error)
1377                             Error(error, rw_str);
1378                         cp = tstr + 2;
1379                         termc = *cp;
1380                         break;
1381                     }
1382                     /*FALLTHRU*/
1383 #endif
1384                 default:
1385                 {
1386 #ifdef SYSVVARSUB
1387                     /*
1388                      * This can either be a bogus modifier or a System-V
1389                      * substitution command.
1390                      */
1391                     VarPattern  pattern;
1392                     Boolean     eqFound;
1393                     int         cnt;
1394
1395                     pattern.flags = 0;
1396                     eqFound = FALSE;
1397                     /*
1398                      * First we make a pass through the string trying
1399                      * to verify it is a SYSV-make-style translation:
1400                      * it must be: <string1>=<string2>)
1401                      */
1402                     cp = tstr;
1403                     cnt = 1;
1404                     while (*cp != '\0' && cnt) {
1405                         if (*cp == '=') {
1406                             eqFound = TRUE;
1407                             /* continue looking for endc */
1408                         }
1409                         else if (*cp == endc)
1410                             cnt--;
1411                         else if (*cp == startc)
1412                             cnt++;
1413                         if (cnt)
1414                             cp++;
1415                     }
1416                     if (*cp == endc && eqFound) {
1417                         int delim;
1418
1419                         /*
1420                          * Now we break this sucker into the lhs and
1421                          * rhs. We must null terminate them of course.
1422                          */
1423                         cp = tstr;
1424
1425                         delim = '=';
1426                         if ((pattern.lhs = VarGetPattern(ctxt,
1427                             err, &cp, delim, &pattern.flags, &pattern.leftLen,
1428                             NULL)) == NULL) {
1429                                 /* was: goto cleanup */
1430                                 *lengthPtr = cp - input + 1;
1431                                 if (*freePtr)
1432                                     free(rw_str);
1433                                 if (delim != '\0')
1434                                     Fatal("Unclosed substitution for %s (%c missing)",
1435                                           v->name, delim);
1436                                 return (var_Error);
1437                         }
1438
1439                         delim = endc;
1440                         if ((pattern.rhs = VarGetPattern(ctxt,
1441                             err, &cp, delim, NULL, &pattern.rightLen,
1442                             &pattern)) == NULL) {
1443                                 /* was: goto cleanup */
1444                                 *lengthPtr = cp - input + 1;
1445                                 if (*freePtr)
1446                                     free(rw_str);
1447                                 if (delim != '\0')
1448                                     Fatal("Unclosed substitution for %s (%c missing)",
1449                                           v->name, delim);
1450                                 return (var_Error);
1451                         }
1452
1453                         /*
1454                          * SYSV modifications happen through the whole
1455                          * string. Note the pattern is anchored at the end.
1456                          */
1457                         termc = *--cp;
1458                         delim = '\0';
1459                         newStr = VarModify(rw_str, VarSYSVMatch, &pattern);
1460
1461                         free(pattern.lhs);
1462                         free(pattern.rhs);
1463
1464                         termc = endc;
1465                     } else
1466 #endif
1467                     {
1468                         Error("Unknown modifier '%c'\n", *tstr);
1469                         for (cp = tstr+1;
1470                              *cp != ':' && *cp != endc && *cp != '\0';
1471                              cp++)
1472                                  continue;
1473                         termc = *cp;
1474                         newStr = var_Error;
1475                     }
1476                 }
1477             }
1478
1479             DEBUGF(VAR, ("Result is \"%s\"\n", newStr));
1480             if (*freePtr) {
1481                     free(rw_str);
1482             }
1483             rw_str = newStr;
1484             if (rw_str != var_Error) {
1485                     *freePtr = TRUE;
1486             } else {
1487                     *freePtr = FALSE;
1488             }
1489
1490             if (readonly == FALSE) {
1491                     if (termc == '\0') {
1492                             Error("Unclosed variable specification for %s",
1493                                   v->name);
1494                     } else if (termc == ':') {
1495                             cp++;
1496                     } else {
1497                     }
1498                     tstr = cp;
1499             }
1500         }
1501
1502         if (v->flags & VAR_FROM_ENV) {
1503             if (rw_str == (char *)Buf_GetAll(v->val, (size_t *)NULL)) {
1504                 /*
1505                  * Returning the value unmodified, so tell the caller to free
1506                  * the thing.
1507                  */
1508                 *freePtr = TRUE;
1509                 *lengthPtr = tstr - input + 1;
1510                 VarDestroy(v, FALSE);
1511                 return (rw_str);
1512             } else {
1513                 *lengthPtr = tstr - input + 1;
1514                 VarDestroy(v, TRUE);
1515                 return (rw_str);
1516             }
1517         } else if (v->flags & VAR_JUNK) {
1518             /*
1519              * Perform any free'ing needed and set *freePtr to FALSE so the caller
1520              * doesn't try to free a static pointer.
1521              */
1522             if (*freePtr) {
1523                 free(rw_str);
1524             }
1525             if (dynamic) {
1526                 *freePtr = FALSE;
1527                 *lengthPtr = tstr - input + 1;
1528                 VarDestroy(v, TRUE);
1529                 rw_str = emalloc(*lengthPtr + 1);
1530                 strncpy(rw_str, input, *lengthPtr);
1531                 rw_str[*lengthPtr] = '\0';
1532                 *freePtr = TRUE;
1533                 return (rw_str);
1534             } else {
1535                 *freePtr = FALSE;
1536                 *lengthPtr = tstr - input + 1;
1537                 VarDestroy(v, TRUE);
1538                 return (err ? var_Error : varNoError);
1539             }
1540         } else {
1541             *lengthPtr = tstr - input + 1;
1542             return (rw_str);
1543         }
1544 }
1545
1546 /*
1547  * Check if brackets contain a variable name.
1548  */
1549 static char *
1550 VarParseLong(const char input[], GNode *ctxt, Boolean err, size_t *lengthPtr,
1551         Boolean *freePtr)
1552 {
1553         Buffer          *buf;
1554         char            endc;   /* Ending character when variable in parens
1555                                  * or braces */
1556         char            startc; /* Starting character when variable in parens
1557                                  * or braces */
1558         const char      *ptr;
1559         const char      *vname;
1560         size_t          vlen;   /* length of variable name, after embedded
1561                                  * variable expansion */
1562
1563         buf = Buf_Init(MAKE_BSIZE);
1564
1565         /*
1566          * Skip to the end character or a colon, whichever comes first,
1567          * replacing embedded variables as we go.
1568          */
1569         startc = input[0];
1570         endc = (startc == OPEN_PAREN) ? CLOSE_PAREN : CLOSE_BRACE;
1571         ptr = input + 1;
1572
1573         while (*ptr != endc && *ptr != ':') {
1574                 if (*ptr == '\0') {
1575                         /*
1576                          * If we did not find the end character,
1577                          * return var_Error right now, setting the
1578                          * length to be the distance to the end of
1579                          * the string, since that's what make does.
1580                          */
1581                         *freePtr = FALSE;
1582                         *lengthPtr += ptr - input;
1583                         Buf_Destroy(buf, TRUE);
1584                         return (var_Error);
1585
1586                 } else if (*ptr == '$') {
1587                         size_t  rlen;
1588                         Boolean rfree;
1589                         char    *rval;
1590
1591                         rlen = 0;
1592                         rval = Var_Parse(ptr, ctxt, err, &rlen, &rfree);
1593                         if (rval == var_Error) {
1594                                 Fatal("Error expanding embedded variable.");
1595                         }
1596                         Buf_Append(buf, rval);
1597                         if (rfree)
1598                                 free(rval);
1599                         ptr += rlen - 1;
1600                 } else {
1601                         Buf_AddByte(buf, (Byte)*ptr);
1602                 }
1603                 ptr++;
1604         }
1605
1606         vname = Buf_GetAll(buf, &vlen);
1607     {
1608         const char      *const tstr = ptr;
1609         size_t  consumed = tstr - (input - 1) + 1;
1610
1611         Var     *v;             /* Variable in invocation */
1612         Boolean haveModifier;   /* TRUE if have modifiers for the variable */
1613         Boolean dynamic;        /* TRUE if the variable is local and we're
1614                                  * expanding it in a non-local context. This
1615                                  * is done to support dynamic sources. The
1616                                  * result is just the invocation, unaltered */
1617
1618         input--;
1619         haveModifier = (*tstr == ':');
1620         dynamic = FALSE;
1621
1622         v = VarFind(vname, ctxt, FIND_ENV | FIND_GLOBAL | FIND_CMD);
1623         if (v != NULL) {
1624                 Buf_Destroy(buf, TRUE);
1625
1626                 if (haveModifier) {
1627                         return (ParseModifier(input, tstr,
1628                                         startc, endc, dynamic, v,
1629                                         ctxt, err, lengthPtr, freePtr));
1630                 } else {
1631                         char    *result;
1632
1633                         result = VarExpand(v, ctxt, err);
1634
1635                         if (v->flags & VAR_FROM_ENV) {
1636                                 VarDestroy(v, TRUE);
1637                         }
1638
1639                         *freePtr = TRUE;
1640                         *lengthPtr = consumed;
1641                         return (result);
1642                 }
1643         }
1644
1645         if ((ctxt != VAR_CMD) && (ctxt != VAR_GLOBAL)) {
1646                 /*
1647                  * Check for D and F forms of local variables since we're in
1648                  * a local context and the name is the right length.
1649                  */
1650                 if ((vlen == 2) &&
1651                     (vname[1] == 'F' || vname[1] == 'D') &&
1652                     (strchr("!%*<>@", vname[0]) != NULL)) {
1653                         char    name[2];
1654                         char    *val;
1655
1656                         /*
1657                          * Well, it's local -- go look for it.
1658                          */
1659                         name[0] = vname[0];
1660                         name[1] = '\0';
1661
1662                         v = VarFind(name, ctxt, 0);
1663                         if (v != NULL) {
1664                                 if (haveModifier) {
1665                                         Buf_Destroy(buf, TRUE);
1666                                         return (ParseModifier(input, tstr,
1667                                                         startc, endc, dynamic, v,
1668                                                         ctxt, err, lengthPtr, freePtr));
1669                                 } else {
1670                                         /*
1671                                          * No need for nested expansion or
1672                                          * anything, as we're the only one
1673                                          * who sets these things and we sure
1674                                          * don't put nested invocations in
1675                                          * them...
1676                                          */
1677                                         val = (char *)Buf_GetAll(v->val, (size_t *) NULL);
1678
1679                                         if (vname[1] == 'D') {
1680                                                 val = VarModify(val, VarHead, (void *)NULL);
1681                                         } else {
1682                                                 val = VarModify(val, VarTail, (void *)NULL);
1683                                         }
1684                                         /*
1685                                          * Resulting string is dynamically
1686                                          * allocated, so tell caller to free
1687                                          * it.
1688                                          */
1689                                         *freePtr = TRUE;
1690                                         *lengthPtr = consumed;
1691                                         Buf_Destroy(buf, TRUE);
1692                                         return (val);
1693                                 }
1694                         }
1695                 }
1696         } else {
1697                 if (((vlen == 1)) ||
1698                     ((vlen == 2) && (vname[1] == 'F' || vname[1] == 'D'))) {
1699                         /*
1700                          * If substituting a local variable in a non-local
1701                          * context, assume it's for dynamic source stuff. We
1702                          * have to handle this specially and return the
1703                          * longhand for the variable with the dollar sign
1704                          * escaped so it makes it back to the caller. Only
1705                          * four of the local variables are treated specially
1706                          * as they are the only four that will be set when
1707                          * dynamic sources are expanded.
1708                          */
1709                         if (strchr("!%*@", vname[0]) != NULL) {
1710                                 dynamic = TRUE;
1711                         }
1712                 }
1713                 if ((vlen > 2) &&
1714                     (vname[0] == '.') &&
1715                     isupper((unsigned char)vname[1])) {
1716                         if ((strncmp(vname, ".TARGET", vlen - 1) == 0) ||
1717                             (strncmp(vname, ".ARCHIVE", vlen - 1) == 0) ||
1718                             (strncmp(vname, ".PREFIX", vlen - 1) == 0) ||
1719                             (strncmp(vname, ".MEMBER", vlen - 1) == 0)) {
1720                                 dynamic = TRUE;
1721                         }
1722                 }
1723         }
1724
1725         if (haveModifier) {
1726                 /*
1727                  * Still need to get to the end of the variable
1728                  * specification, so kludge up a Var structure for
1729                  * the modifications
1730                  */
1731                 v = VarCreate(vname, NULL, VAR_JUNK);
1732
1733                 Buf_Destroy(buf, TRUE);
1734                 return (ParseModifier(input, tstr,
1735                                       startc, endc, dynamic, v,
1736                                     ctxt, err, lengthPtr, freePtr));
1737         } else {
1738                 /*
1739                  * No modifiers -- have specification length so we
1740                  * can return now.
1741                  */
1742                 if (dynamic) {
1743                         char   *result;
1744
1745                         result = emalloc(consumed + 1);
1746                         strncpy(result, input, consumed);
1747                         result[consumed] = '\0';
1748
1749                         *freePtr = TRUE;
1750                         *lengthPtr = consumed;
1751
1752                         Buf_Destroy(buf, TRUE);
1753                         return (result);
1754                 } else {
1755                         *freePtr = FALSE;
1756                         *lengthPtr = consumed;
1757
1758                         Buf_Destroy(buf, TRUE);
1759                         return (err ? var_Error : varNoError);
1760                 }
1761         }
1762     }
1763 }
1764
1765 /**
1766  * If it's not bounded by braces of some sort, life is much simpler.
1767  * We just need to check for the first character and return the value
1768  * if it exists.
1769  */
1770 static char *
1771 VarParseShort(const char input[], GNode *ctxt, Boolean err,
1772         size_t *lengthPtr, Boolean *freePtr)
1773 {
1774         char    name[2];
1775         Var     *v;
1776
1777         name[0] = input[0];
1778         name[1] = '\0';
1779
1780         /* consume character */
1781         *lengthPtr += 1;
1782
1783         v = VarFind(name, ctxt, FIND_ENV | FIND_GLOBAL | FIND_CMD);
1784         if (v != NULL) {
1785                 char   *result;
1786
1787                 result = VarExpand(v, ctxt, err);
1788
1789                 if (v->flags & VAR_FROM_ENV) {
1790                         VarDestroy(v, TRUE);
1791                 }
1792
1793                 *freePtr = TRUE;
1794                 return (result);
1795         }
1796
1797         /*
1798          * If substituting a local variable in a non-local context, assume
1799          * it's for dynamic source stuff. We have to handle this specially
1800          * and return the longhand for the variable with the dollar sign
1801          * escaped so it makes it back to the caller. Only four of the local
1802          * variables are treated specially as they are the only four that
1803          * will be set when dynamic sources are expanded.
1804          */
1805         if ((ctxt == VAR_CMD) || (ctxt == VAR_GLOBAL)) {
1806
1807                 /* XXX: It looks like $% and $! are reversed here */
1808                 switch (name[0]) {
1809                 case '@':
1810                         *freePtr = TRUE;
1811                         return (estrdup("$(.TARGET)"));
1812                 case '%':
1813                         *freePtr = TRUE;
1814                         return (estrdup("$(.ARCHIVE)"));
1815                 case '*':
1816                         *freePtr = TRUE;
1817                         return (estrdup("$(.PREFIX)"));
1818                 case '!':
1819                         *freePtr = TRUE;
1820                         return (estrdup("$(.MEMBER)"));
1821                 default:
1822                         *freePtr = FALSE;
1823                         return (err ? var_Error : varNoError);
1824                 }
1825         }
1826
1827         *freePtr = FALSE;
1828         return (err ? var_Error : varNoError);
1829 }
1830
1831 /*-
1832  *-----------------------------------------------------------------------
1833  * Var_Parse --
1834  *      Given the start of a variable invocation, extract the variable
1835  *      name and find its value, then modify it according to the
1836  *      specification.
1837  *
1838  * Results:
1839  *      The value of the variable or var_Error if the specification
1840  *      is invalid.  The length of the specification is placed in
1841  *      *lengthPtr (for invalid specifications, this is just 2 to
1842  *      skip the '$' and the following letter, or 1 if '$' was the
1843  *      last character in the string).  A Boolean in *freePtr telling
1844  *      whether the returned string should be freed by the caller.
1845  *
1846  * Side Effects:
1847  *      None.
1848  *
1849  * Assumption:
1850  *      It is assumed that Var_Parse() is called with input[0] == '$'.
1851  *
1852  *-----------------------------------------------------------------------
1853  */
1854 char *
1855 Var_Parse(const char input[], GNode *ctxt, Boolean err,
1856         size_t *lengthPtr, Boolean *freePtr)
1857 {
1858         /* assert(input[0] == '$'); */
1859
1860         /* consume '$' */
1861         input += 1;
1862         *lengthPtr += 1;
1863
1864         if (input[0] == '\0') {
1865                 /* Error, there is only a dollar sign in the input string. */
1866                 *freePtr = FALSE;
1867                 return (err ? var_Error : varNoError);
1868
1869         } else if (input[0] == OPEN_PAREN || input[0] == OPEN_BRACE) {
1870                 /* multi letter variable name */
1871                 return (VarParseLong(input, ctxt, err, lengthPtr, freePtr));
1872
1873         } else {
1874                 /* single letter variable name */
1875                 return (VarParseShort(input, ctxt, err, lengthPtr, freePtr));
1876         }
1877 }
1878
1879 /*-
1880  *-----------------------------------------------------------------------
1881  * Var_Subst  --
1882  *      Substitute for all variables in the given string in the given context
1883  *      If undefErr is TRUE, Parse_Error will be called when an undefined
1884  *      variable is encountered.
1885  *
1886  * Results:
1887  *      The resulting string.
1888  *
1889  * Side Effects:
1890  *      None. The old string must be freed by the caller
1891  *-----------------------------------------------------------------------
1892  */
1893 Buffer *
1894 Var_Subst(const char *var, const char *str, GNode *ctxt, Boolean undefErr)
1895 {
1896     Boolean     errorReported;
1897     Buffer      *buf;           /* Buffer for forming things */
1898
1899     /*
1900      * Set TRUE if an error has already been reported to prevent a
1901      * plethora of messages when recursing.
1902      * XXXHB this comment sounds wrong.
1903      */
1904     errorReported = FALSE;
1905
1906     buf = Buf_Init(0);
1907     while (*str) {
1908         if (var == NULL && (str[0] == '$') && (str[1] == '$')) {
1909             /*
1910              * A dollar sign may be escaped either with another dollar sign.
1911              * In such a case, we skip over the escape character and store the
1912              * dollar sign into the buffer directly.
1913              */
1914             Buf_AddByte(buf, (Byte)str[0]);
1915             str += 2;
1916
1917         } else if (str[0] == '$') {
1918             char        *val;   /* Value to substitute for a variable */
1919             size_t      length; /* Length of the variable invocation */
1920             Boolean     doFree; /* Set true if val should be freed */
1921
1922             /*
1923              * Variable invocation.
1924              */
1925             if (var != NULL) {
1926                 int expand;
1927                 for (;;) {
1928                     if (str[1] == OPEN_PAREN || str[1] == OPEN_BRACE) {
1929                         size_t          ln;
1930                         const char      *p = str + 2;
1931
1932                         /*
1933                          * Scan up to the end of the variable name.
1934                          */
1935                         while (*p != '\0' &&
1936                                *p != ':' &&
1937                                *p != CLOSE_PAREN &&
1938                                *p != CLOSE_BRACE &&
1939                                *p != '$') {
1940                             ++p;
1941                         }
1942
1943                         /*
1944                          * A variable inside the variable. We cannot expand
1945                          * the external variable yet, so we try again with
1946                          * the nested one
1947                          */
1948                         if (*p == '$') {
1949                             Buf_AppendRange(buf, str, p);
1950                             str = p;
1951                             continue;
1952                         }
1953
1954                         ln = p - (str + 2);
1955                         if (var[ln] == '\0' && strncmp(var, str + 2, ln) == 0) {
1956                             expand = TRUE;
1957                         } else {
1958                             /*
1959                              * Not the variable we want to expand, scan
1960                              * until the next variable
1961                              */
1962                             while (*p != '$' && *p != '\0')
1963                                 p++;
1964
1965                             Buf_AppendRange(buf, str, p);
1966                             str = p;
1967                             expand = FALSE;
1968                         }
1969                     } else {
1970                         /*
1971                          * Single letter variable name
1972                          */
1973                         if (var[1] == '\0' && var[0] == str[1]) {
1974                             expand = TRUE;
1975                         } else {
1976                             Buf_AddBytes(buf, 2, (const Byte *)str);
1977                             str += 2;
1978                             expand = FALSE;
1979                         }
1980                     }
1981                     break;
1982                 }
1983                 if (!expand)
1984                     continue;
1985             }
1986
1987             length = 0;
1988             val = Var_Parse(str, ctxt, undefErr, &length, &doFree);
1989
1990             /*
1991              * When we come down here, val should either point to the
1992              * value of this variable, suitably modified, or be NULL.
1993              * Length should be the total length of the potential
1994              * variable invocation (from $ to end character...)
1995              */
1996             if (val == var_Error || val == varNoError) {
1997                 /*
1998                  * If performing old-time variable substitution, skip over
1999                  * the variable and continue with the substitution. Otherwise,
2000                  * store the dollar sign and advance str so we continue with
2001                  * the string...
2002                  */
2003                 if (oldVars) {
2004                     str += length;
2005                 } else if (undefErr) {
2006                     /*
2007                      * If variable is undefined, complain and skip the
2008                      * variable. The complaint will stop us from doing anything
2009                      * when the file is parsed.
2010                      */
2011                     if (!errorReported) {
2012                         Parse_Error(PARSE_FATAL,
2013                                      "Undefined variable \"%.*s\"",length,str);
2014                     }
2015                     str += length;
2016                     errorReported = TRUE;
2017                 } else {
2018                     Buf_AddByte(buf, (Byte)*str);
2019                     str += 1;
2020                 }
2021             } else {
2022                 /*
2023                  * We've now got a variable structure to store in. But first,
2024                  * advance the string pointer.
2025                  */
2026                 str += length;
2027
2028                 /*
2029                  * Copy all the characters from the variable value straight
2030                  * into the new string.
2031                  */
2032                 Buf_Append(buf, val);
2033                 if (doFree) {
2034                     free(val);
2035                 }
2036             }
2037         } else {
2038             /*
2039              * Skip as many characters as possible -- either to the end of
2040              * the string or to the next dollar sign (variable invocation).
2041              */
2042             const char *cp = str;
2043
2044             do {
2045                 str++;
2046             } while (str[0] != '$' && str[0] != '\0');
2047
2048             Buf_AppendRange(buf, cp, str);
2049         }
2050     }
2051
2052     return (buf);
2053 }
2054
2055 /*-
2056  *-----------------------------------------------------------------------
2057  * Var_GetTail --
2058  *      Return the tail from each of a list of words. Used to set the
2059  *      System V local variables.
2060  *
2061  * Results:
2062  *      The resulting string.
2063  *
2064  * Side Effects:
2065  *      None.
2066  *
2067  *-----------------------------------------------------------------------
2068  */
2069 char *
2070 Var_GetTail(char *file)
2071 {
2072
2073     return (VarModify(file, VarTail, (void *)NULL));
2074 }
2075
2076 /*-
2077  *-----------------------------------------------------------------------
2078  * Var_GetHead --
2079  *      Find the leading components of a (list of) filename(s).
2080  *      XXX: VarHead does not replace foo by ., as (sun) System V make
2081  *      does.
2082  *
2083  * Results:
2084  *      The leading components.
2085  *
2086  * Side Effects:
2087  *      None.
2088  *
2089  *-----------------------------------------------------------------------
2090  */
2091 char *
2092 Var_GetHead(char *file)
2093 {
2094
2095     return (VarModify(file, VarHead, (void *)NULL));
2096 }
2097
2098 /*-
2099  *-----------------------------------------------------------------------
2100  * Var_Init --
2101  *      Initialize the module
2102  *
2103  * Results:
2104  *      None
2105  *
2106  * Side Effects:
2107  *      The VAR_CMD and VAR_GLOBAL contexts are created
2108  *-----------------------------------------------------------------------
2109  */
2110 void
2111 Var_Init(void)
2112 {
2113
2114     VAR_GLOBAL = Targ_NewGN("Global");
2115     VAR_CMD = Targ_NewGN("Command");
2116 }
2117
2118 /****************** PRINT DEBUGGING INFO *****************/
2119 static int
2120 VarPrintVar(void *vp, void *dummy __unused)
2121 {
2122     Var    *v = (Var *) vp;
2123
2124     printf("%-16s = %s\n", v->name, (char *)Buf_GetAll(v->val, (size_t *)NULL));
2125     return (0);
2126 }
2127
2128 /*-
2129  *-----------------------------------------------------------------------
2130  * Var_Dump --
2131  *      print all variables in a context
2132  *-----------------------------------------------------------------------
2133  */
2134 void
2135 Var_Dump(GNode *ctxt)
2136 {
2137
2138     Lst_ForEach(&ctxt->context, VarPrintVar, (void *)NULL);
2139 }