Hiding pointer in typedefs is evil. 'Buffer *' -> 'Buffer'
[dragonfly.git] / usr.bin / make / var.h
CommitLineData
9863ce62
MO
1#ifndef var_h_9cccafce
2#define var_h_9cccafce
953a35a5
MD
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 $
6a3d9147 42 * $DragonFly: src/usr.bin/make/var.h,v 1.6 2005/01/06 13:18:58 okumoto Exp $
953a35a5
MD
43 */
44
9863ce62
MO
45#include <regex.h>
46
9863ce62
MO
47#include "config.h"
48
49struct GNode;
6a3d9147 50struct Buffer;
9863ce62 51
953a35a5 52typedef struct Var {
6a3d9147
MO
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 */
953a35a5
MD
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
78typedef struct {
6a3d9147
MO
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;
953a35a5
MD
84} VarPattern;
85
fbfaa208 86typedef struct {
6a3d9147
MO
87 regex_t re;
88 int nsub;
89 regmatch_t *matches;
90 char *replace;
91 int flags;
953a35a5
MD
92} VarREPattern;
93
94/*
95 * var.c
96 */
97void VarREError(int, regex_t *, const char *);
98
99/*
100 * var_modify.c
101 */
6a3d9147
MO
102Boolean VarHead(const char *, Boolean, struct Buffer *, void *);
103Boolean VarTail(const char *, Boolean, struct Buffer *, void *);
104Boolean VarSuffix(const char *, Boolean, struct Buffer *, void *);
105Boolean VarRoot(const char *, Boolean, struct Buffer *, void *);
106Boolean VarMatch(const char *, Boolean, struct Buffer *, void *);
953a35a5 107#ifdef SYSVVARSUB
6a3d9147 108Boolean VarSYSVMatch(const char *, Boolean, struct Buffer *, void *);
953a35a5 109#endif
6a3d9147
MO
110Boolean VarNoMatch(const char *, Boolean, struct Buffer *, void *);
111Boolean VarRESubstitute(const char *, Boolean, struct Buffer *, void *);
112Boolean VarSubstitute(const char *, Boolean, struct Buffer *, void *);
9863ce62
MO
113
114void Var_Delete(char *, struct GNode *);
115void Var_Set(char *, char *, struct GNode *);
116void Var_Append(char *, char *, struct GNode *);
117Boolean Var_Exists(char *, struct GNode *);
118char *Var_Value(char *, struct GNode *, char **);
119char *Var_Quote(const char *);
120char *Var_Parse(char *, struct GNode *, Boolean, size_t *, Boolean *);
121char *Var_Subst(char *, char *, struct GNode *, Boolean);
122char *Var_GetTail(char *);
123char *Var_GetHead(char *);
124void Var_Init(void);
125void Var_Dump(struct GNode *);
126
127#endif /* var_h_9cccafce */