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