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