usr.bin/make/var.h

   1 /*-
   2  * Copyright (c) 2002 Juli Mallett.
   3  * Copyright (c) 1988, 1989, 1990, 1993
   4  *      The Regents of the University of California.  All rights reserved.
   5  * Copyright (c) 1989 by Berkeley Softworks
   6  * All rights reserved.
   7  *
   8  * This code is derived from software contributed to Berkeley by
   9  * Adam de Boor.
  10  *
  11  * Redistribution and use in source and binary forms, with or without
  12  * modification, are permitted provided that the following conditions
  13  * are met:
  14  * 1. Redistributions of source code must retain the above copyright
  15  *    notice, this list of conditions and the following disclaimer.
  16  * 2. Redistributions in binary form must reproduce the above copyright
  17  *    notice, this list of conditions and the following disclaimer in the
  18  *    documentation and/or other materials provided with the distribution.
  19  * 3. All advertising materials mentioning features or use of this software
  20  *    must display the following acknowledgement:
  21  *      This product includes software developed by the University of
  22  *      California, Berkeley and its contributors.
  23  * 4. Neither the name of the University nor the names of its contributors
  24  *    may be used to endorse or promote products derived from this software
  25  *    without specific prior written permission.
  26  *
  27  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  28  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  29  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  30  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  31  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  32  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  33  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  34  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  35  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  36  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  37  * SUCH DAMAGE.
  38  *
  39  * $FreeBSD: src/usr.bin/make/var.h,v 1.8 2005/02/07 16:27:19 harti Exp $
  40  * $DragonFly: src/usr.bin/make/var.h,v 1.43 2005/09/24 07:27:26 okumoto Exp $
  41  */
  42
  43 #ifndef var_h_9cccafce
  44 #define var_h_9cccafce
  45
  46 #include <stdbool.h>
  47
  48 struct Buffer;
  49 struct GNode;
  50
  51 /* Variables defined in a global context, e.g in the Makefile itself */
  52 extern struct GNode     *VAR_GLOBAL;
  53
  54 /* Variables defined on the command line */
  55 extern struct GNode     *VAR_CMD;
  56
  57 /*
  58  * Value returned by Var_Parse when an error is encountered.  It actually
  59  * points to an empty string, so naive callers needn't worry about it.
  60  */
  61 extern char             var_Error[];
  62
  63 /*
  64  * true if environment should be searched for all variables before
  65  * the global context
  66  */
  67 extern bool             checkEnvFirst;
  68
  69 /* Do old-style variable substitution */
  70 extern bool             oldVars;
  71
  72 void Var_Append(const char [], const char [], struct GNode *);
  73 void Var_Delete(const char [], struct GNode *);
  74 void Var_Dump(void);
  75 void Var_Init(char **);
  76 size_t Var_Match(const char [], struct GNode *);
  77 char *Var_Parse(const char [], struct GNode *, bool, size_t *, bool *);
  78 void Var_Print(struct Lst *, bool);
  79 void Var_Set(const char [], const char [], struct GNode *);
  80 void Var_SetGlobal(const char [], const char []);
  81 void Var_SetEnv(const char [], struct GNode *);
  82 struct Buffer *Var_Subst(const char [], struct GNode *, bool);
  83 struct Buffer *Var_SubstOnly(const char [], const char [], bool);
  84 const char *Var_Value(const char [], struct GNode *);
  85
  86 #endif /* var_h_9cccafce */