patch-7.110 var.c
[dragonfly.git] / 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.16 2005/03/04 23:51:28 okumoto Exp $
41  */
42
43 #ifndef var_h_9cccafce
44 #define var_h_9cccafce
45
46 #include <regex.h>
47
48 #include "config.h"
49
50 struct GNode;
51 struct Buffer;
52
53 typedef struct Var {
54     char                *name;  /* the variable's name */
55     struct Buffer       *val;   /* its value */
56     int                 flags;  /* miscellaneous status flags */
57
58 #define VAR_IN_USE      1       /* Variable's value currently being used.
59                                  * Used to avoid recursion */
60
61 #define VAR_FROM_ENV    2       /* Variable comes from the environment */
62
63 #define VAR_JUNK        4       /* Variable is a junk variable that
64                                  * should be destroyed when done with
65                                  * it. Used by Var_Parse for undefined,
66                                  * modified variables */
67
68 #define VAR_TO_ENV      8       /* Place variable in environment */
69 } Var;
70
71 /* Var*Pattern flags */
72 #define VAR_SUB_GLOBAL  0x01    /* Apply substitution globally */
73 #define VAR_SUB_ONE     0x02    /* Apply substitution to one word */
74 #define VAR_SUB_MATCHED 0x04    /* There was a match */
75 #define VAR_MATCH_START 0x08    /* Match at start of word */
76 #define VAR_MATCH_END   0x10    /* Match at end of word */
77 #define VAR_NOSUBST     0x20    /* don't expand vars in VarGetPattern */
78
79 typedef struct {
80     char        *lhs;           /* String to match */
81     size_t      leftLen;        /* Length of string */
82     char        *rhs;           /* Replacement string (w/ &'s removed) */
83     size_t      rightLen;       /* Length of replacement */
84     int         flags;
85 } VarPattern;
86
87 typedef struct {
88     regex_t     re;
89     int         nsub;
90     regmatch_t  *matches;
91     char        *replace;
92     int         flags;
93 } VarREPattern;
94
95 typedef Boolean VarModifyProc(const char *, Boolean, struct Buffer *, void *);
96
97 /*
98  * var.c
99  */
100 void VarREError(int, regex_t *, const char *);
101
102 /*
103  * var_modify.c
104  */
105 VarModifyProc VarHead;
106 VarModifyProc VarTail;
107 VarModifyProc VarSuffix;
108 VarModifyProc VarRoot;
109 VarModifyProc VarMatch;
110 #ifdef SYSVVARSUB
111 VarModifyProc VarSYSVMatch;
112 #endif
113 VarModifyProc VarNoMatch;
114 VarModifyProc VarRESubstitute;
115 VarModifyProc VarSubstitute;
116
117 void Var_Delete(const char *, struct GNode *);
118 void Var_Set(const char *, const char *, struct GNode *);
119 void Var_SetEnv(const char *, struct GNode *);
120 void Var_Append(const char *, const char *, struct GNode *);
121 Boolean Var_Exists(const char *, struct GNode *);
122 char *Var_Value(const char *, struct GNode *, char **);
123 char *Var_Quote(const char *);
124 char *Var_Parse(const char *, struct GNode *, Boolean, size_t *, Boolean *);
125 struct Buffer *Var_Subst(const char *, const char *, struct GNode *, Boolean);
126 char *Var_GetTail(char *);
127 char *Var_GetHead(char *);
128 void Var_Init(void);
129 void Var_Dump(struct GNode *);
130
131 #endif /* var_h_9cccafce */