usr.bin/make/var.c

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