usr.bin/make/var.h

   1 #ifndef var_h_9cccafce
   2 #define var_h_9cccafce
   3 /*-
   4  * Copyright (c) 2002 Juli Mallett.
   5  * Copyright (c) 1988, 1989, 1990, 1993
   6  *      The Regents of the University of California.  All rights reserved.
   7  * Copyright (c) 1989 by Berkeley Softworks
   8  * All rights reserved.
   9  *
  10  * This code is derived from software contributed to Berkeley by
  11  * Adam de Boor.
  12  *
  13  * Redistribution and use in source and binary forms, with or without
  14  * modification, are permitted provided that the following conditions
  15  * are met:
  16  * 1. Redistributions of source code must retain the above copyright
  17  *    notice, this list of conditions and the following disclaimer.
  18  * 2. Redistributions in binary form must reproduce the above copyright
  19  *    notice, this list of conditions and the following disclaimer in the
  20  *    documentation and/or other materials provided with the distribution.
  21  * 3. All advertising materials mentioning features or use of this software
  22  *    must display the following acknowledgement:
  23  *      This product includes software developed by the University of
  24  *      California, Berkeley and its contributors.
  25  * 4. Neither the name of the University nor the names of its contributors
  26  *    may be used to endorse or promote products derived from this software
  27  *    without specific prior written permission.
  28  *
  29  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  30  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  31  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  32  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  33  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  34  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  35  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  36  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  37  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  38  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  39  * SUCH DAMAGE.
  40  *
  41  * $FreeBSD: src/usr.bin/make/var.h,v 1.1 2002/10/28 23:33:57 jmallett Exp $
  42  * $DragonFly: src/usr.bin/make/var.h,v 1.9 2005/01/08 12:38:32 okumoto Exp $
  43  */
  44
  45 #include <regex.h>
  46
  47 #include "config.h"
  48
  49 struct GNode;
  50 struct Buffer;
  51
  52 typedef struct Var {
  53     char                *name;  /* the variable's name */
  54     struct Buffer       *val;   /* its value */
  55     int                 flags;  /* miscellaneous status flags */
  56
  57 #define VAR_IN_USE      1       /* Variable's value currently being used.
  58                                  * Used to avoid recursion */
  59
  60 #define VAR_FROM_ENV    2       /* Variable comes from the environment */
  61
  62 #define VAR_JUNK        4       /* Variable is a junk variable that
  63                                  * should be destroyed when done with
  64                                  * it. Used by Var_Parse for undefined,
  65                                  * modified variables */
  66
  67 #define VAR_TO_ENV      8       /* Place variable in environment */
  68 } Var;
  69
  70 /* Var*Pattern flags */
  71 #define VAR_SUB_GLOBAL  0x01    /* Apply substitution globally */
  72 #define VAR_SUB_ONE     0x02    /* Apply substitution to one word */
  73 #define VAR_SUB_MATCHED 0x04    /* There was a match */
  74 #define VAR_MATCH_START 0x08    /* Match at start of word */
  75 #define VAR_MATCH_END   0x10    /* Match at end of word */
  76 #define VAR_NOSUBST     0x20    /* don't expand vars in VarGetPattern */
  77
  78 typedef struct {
  79     char        *lhs;           /* String to match */
  80     size_t      leftLen;        /* Length of string */
  81     char        *rhs;           /* Replacement string (w/ &'s removed) */
  82     size_t      rightLen;       /* Length of replacement */
  83     int         flags;
  84 } VarPattern;
  85
  86 typedef struct {
  87     regex_t     re;
  88     int         nsub;
  89     regmatch_t  *matches;
  90     char        *replace;
  91     int         flags;
  92 } VarREPattern;
  93
  94 /*
  95  * var.c
  96  */
  97 void VarREError(int, regex_t *, const char *);
  98
  99 /*
 100  * var_modify.c
 101  */
 102 Boolean VarHead(const char *, Boolean, struct Buffer *, void *);
 103 Boolean VarTail(const char *, Boolean, struct Buffer *, void *);
 104 Boolean VarSuffix(const char *, Boolean, struct Buffer *, void *);
 105 Boolean VarRoot(const char *, Boolean, struct Buffer *, void *);
 106 Boolean VarMatch(const char *, Boolean, struct Buffer *, void *);
 107 #ifdef SYSVVARSUB
 108 Boolean VarSYSVMatch(const char *, Boolean, struct Buffer *, void *);
 109 #endif
 110 Boolean VarNoMatch(const char *, Boolean, struct Buffer *, void *);
 111 Boolean VarRESubstitute(const char *, Boolean, struct Buffer *, void *);
 112 Boolean VarSubstitute(const char *, Boolean, struct Buffer *, void *);
 113
 114 void Var_Delete(char *, struct GNode *);
 115 void Var_Set(const char *, const char *, struct GNode *);
 116 void Var_SetEnv(const char *, struct GNode *);
 117 void Var_Append(const char *, const char *, struct GNode *);
 118 Boolean Var_Exists(const char *, struct GNode *);
 119 char *Var_Value(const char *, struct GNode *, char **);
 120 char *Var_Quote(const char *);
 121 char *Var_Parse(char *, struct GNode *, Boolean, size_t *, Boolean *);
 122 char *Var_Subst(const char *, const char *, struct GNode *, Boolean);
 123 char *Var_GetTail(char *);
 124 char *Var_GetHead(char *);
 125 void Var_Init(void);
 126 void Var_Dump(struct GNode *);
 127
 128 #endif /* var_h_9cccafce */