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