jcs.org
jcs's openbsd hax
openbsd
1#ifndef VAR_H
2#define VAR_H
3/* $OpenBSD: var.h,v 1.21 2024/05/21 05:00:48 jsg Exp $ */
4/*
5 * Copyright (c) 2001 Marc Espie.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE OPENBSD PROJECT AND CONTRIBUTORS
17 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
18 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
19 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE OPENBSD
20 * PROJECT OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28
29extern GNode *current_node;
30extern void Var_Init(void);
31extern void Var_setCheckEnvFirst(bool);
32
33/* Global variable handling. */
34/* value = Var_Valuei(name, end);
35 * Returns value of global variable name/end, or NULL if inexistent. */
36extern char *Var_Valuei(const char *, const char *);
37#define Var_Value(n) Var_Valuei(n, NULL)
38
39/* isDefined = Var_Definedi(name, end);
40 * Checks whether global variable name/end is defined. */
41extern bool Var_Definedi(const char *, const char *);
42
43/* Var_Seti_with_ctxt(name, end, val, ctxt);
44 * Sets value val of variable name/end. Copies val.
45 * ctxt can be VAR_CMD (command line) or VAR_GLOBAL (normal variable). */
46extern void Var_Seti_with_ctxt(const char *, const char *, const char *,
47 int);
48#define Var_Set(n, v) Var_Seti_with_ctxt(n, NULL, v, VAR_GLOBAL)
49#define Var_Seti(n, e, v) Var_Seti_with_ctxt(n, e, v, VAR_GLOBAL)
50/* Var_Appendi_with_ctxt(name, end, val, cxt);
51 * Appends value val to variable name/end in global context ctxt,
52 * defining it if it does not already exist, and inserting one
53 * space otherwise. */
54extern void Var_Appendi_with_ctxt(const char *, const char *,
55 const char *, int);
56#define Var_Append(n, v) Var_Appendi_with_ctxt(n, NULL, v, VAR_GLOBAL)
57#define Var_Appendi(n, e, v) Var_Appendi_with_ctxt(n, e, v, VAR_GLOBAL)
58
59/* Var_Deletei(name, end);
60 * Deletes a global variable. */
61extern void Var_Deletei(const char *, const char *);
62
63/* Dynamic variable indices */
64#define TARGET_INDEX 0
65#define PREFIX_INDEX 1
66#define ARCHIVE_INDEX 2
67#define MEMBER_INDEX 3
68#define IMPSRC_INDEX 4
69#define OODATE_INDEX 5
70#define ALLSRC_INDEX 6
71
72#define Var(idx, gn) ((gn)->localvars.locals[idx])
73
74
75/* SymTable_Init(t);
76 * Inits the local symtable in a GNode. */
77extern void SymTable_Init(SymTable *);
78
79/* Several ways to parse a variable specification. */
80/* value = Var_Parse(varspec, ctxt, undef_is_bad, &length, &freeit);
81 * Parses a variable specification varspec and evaluates it in context
82 * ctxt. Returns the resulting value, freeit indicates whether it's
83 * a copy that should be freed when no longer needed. If it's not a
84 * copy, it's only valid until the next time variables are set.
85 * The length of the spec is returned in length, e.g., varspec begins
86 * at the $ and ends at the closing } or ). Returns special value
87 * var_Error if a problem occurred. */
88extern char *Var_Parse(const char *, SymTable *, bool, size_t *,
89 bool *);
90/* Note that var_Error is an instance of the empty string "", so that
91 * callers who don't care don't need to. */
92extern char var_Error[];
93
94/* ok = Var_ParseSkip(&varspec, ctxt, &ok);
95 * Parses a variable specification and returns true if the varspec
96 * is correct. Advances pointer past specification. */
97extern bool Var_ParseSkip(const char **, SymTable *);
98
99/* ok = Var_ParseBuffer(buf, varspec, ctxt, undef_is_bad, &length);
100 * Similar to Var_Parse, except the value is directly appended to
101 * buffer buf. */
102extern bool Var_ParseBuffer(Buffer, const char *, SymTable *,
103 bool, size_t *);
104
105
106/* The substitution itself */
107/* subst = Var_Subst(str, ctxt, undef_is_bad);
108 * Substitutes all variable values in string str under context ctxt.
109 * Emit a PARSE_FATAL error if undef_is_bad and an undef variable is
110 * encountered. The result is always a copy that should be free. */
111extern char *Var_Subst(const char *, SymTable *, bool);
112/* subst = Var_Substi(str, estr, ctxt, undef_if_bad);
113 */
114extern char *Var_Substi(const char *, const char *, SymTable *, bool);
115
116/* has_target = Var_Check_for_target(s):
117 * specialized tweak on Var_Subst that reads through a command line
118 * and looks for stuff like $@.
119 * Use to desambiguate a list of targets into a target group.
120 */
121extern bool Var_Check_for_target(const char *);
122
123/* For loop handling.
124 * // Create handle for variable name.
125 * handle = Var_NewLoopVar(name, end);
126 * // set up buffer
127 * for (...)
128 * // Substitute val for variable in str, and accumulate in buffer
129 * Var_SubstVar(buffer, str, handle, val);
130 * // Free handle
131 * Var_DeleteLoopVar(handle);
132 */
133struct LoopVar; /* opaque handle */
134struct LoopVar *Var_NewLoopVar(const char *, const char *);
135void Var_DeleteLoopVar(struct LoopVar *);
136extern void Var_SubstVar(Buffer, const char *, struct LoopVar *, const char *);
137char *Var_LoopVarName(struct LoopVar *);
138
139
140/* Var_Dump();
141 * Print out all global variables. */
142extern void Var_Dump(void);
143
144/* Var_AddCmdline(name);
145 * Add all variable values from VAR_CMD to variable name.
146 * Used to propagate variable values to submakes through MAKEFLAGS. */
147extern void Var_AddCmdline(const char *);
148
149/* stuff common to var.c and varparse.c */
150extern bool errorIsOkay;
151
152#define VAR_GLOBAL 0
153 /* Variables defined in a global context, e.g in the Makefile itself */
154#define VAR_CMD 1
155 /* Variables defined on the command line */
156
157#define POISON_INVALID 0
158#define POISON_DEFINED 1
159#define POISON_NORMAL 64
160#define POISON_EMPTY 128
161#define POISON_NOT_DEFINED 256
162#define VAR_EXEC_LATER 512
163
164extern void Var_Mark(const char *, const char *, unsigned int);
165#endif