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