VirtualBox

source: kBuild/trunk/src/kmk/variable.h@ 1610

Last change on this file since 1610 was 1610, checked in by bird, 17 years ago

Fixed prepend w/ expansion (would append instead of prepend). Optimized append_expanded_string_to_variable().

  • Property svn:eol-style set to native
File size: 11.9 KB
Line 
1/* Definitions for using variables in GNU Make.
2Copyright (C) 1988, 1989, 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997,
31998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006 Free Software
4Foundation, Inc.
5This file is part of GNU Make.
6
7GNU Make is free software; you can redistribute it and/or modify it under the
8terms of the GNU General Public License as published by the Free Software
9Foundation; either version 2, or (at your option) any later version.
10
11GNU Make is distributed in the hope that it will be useful, but WITHOUT ANY
12WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
13A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14
15You should have received a copy of the GNU General Public License along with
16GNU Make; see the file COPYING. If not, write to the Free Software
17Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. */
18
19#include "hash.h"
20
21/* Codes in a variable definition saying where the definition came from.
22 Increasing numeric values signify less-overridable definitions. */
23enum variable_origin
24 {
25 o_default, /* Variable from the default set. */
26 o_env, /* Variable from environment. */
27#ifdef CONFIG_WITH_LOCAL_VARIABLES /** @todo Correct priority? */
28 o_local, /* Variable from an 'local' directive. */
29#endif
30 o_file, /* Variable given in a makefile. */
31 o_env_override, /* Variable from environment, if -e. */
32 o_command, /* Variable given by user. */
33 o_override, /* Variable from an `override' directive. */
34 o_automatic, /* Automatic variable -- cannot be set. */
35 o_invalid /* Core dump time. */
36 };
37
38enum variable_flavor
39 {
40 f_bogus, /* Bogus (error) */
41 f_simple, /* Simple definition (:=) */
42 f_recursive, /* Recursive definition (=) */
43 f_append, /* Appending definition (+=) */
44#ifdef CONFIG_WITH_PREPEND_ASSIGNMENT
45 f_prepend, /* Prepending definition (>=) */
46#endif
47 f_conditional /* Conditional definition (?=) */
48 };
49
50/* Structure that represents one variable definition.
51 Each bucket of the hash table is a chain of these,
52 chained through `next'. */
53
54#define EXP_COUNT_BITS 15 /* This gets all the bitfields into 32 bits */
55#define EXP_COUNT_MAX ((1<<EXP_COUNT_BITS)-1)
56
57struct variable
58 {
59 char *name; /* Variable name. */
60 int length; /* strlen (name) */
61#ifdef VARIABLE_HASH /* bird */
62 int hash1; /* the primary hash */
63 int hash2; /* the secondary hash */
64#endif
65#ifdef CONFIG_WITH_VALUE_LENGTH
66 int value_length; /* The length of the value, usually unused. */
67 int value_alloc_len; /* The amount of memory we've actually allocated. */
68 /* FIXME: make lengths unsigned! */
69#endif
70 char *value; /* Variable value. */
71 struct floc fileinfo; /* Where the variable was defined. */
72 unsigned int recursive:1; /* Gets recursively re-evaluated. */
73 unsigned int append:1; /* Nonzero if an appending target-specific
74 variable. */
75 unsigned int conditional:1; /* Nonzero if set with a ?=. */
76 unsigned int per_target:1; /* Nonzero if a target-specific variable. */
77 unsigned int special:1; /* Nonzero if this is a special variable. */
78 unsigned int exportable:1; /* Nonzero if the variable _could_ be
79 exported. */
80 unsigned int expanding:1; /* Nonzero if currently being expanded. */
81 unsigned int exp_count:EXP_COUNT_BITS;
82 /* If >1, allow this many self-referential
83 expansions. */
84 enum variable_flavor
85 flavor ENUM_BITFIELD (3); /* Variable flavor. */
86 enum variable_origin
87#ifdef CONFIG_WITH_LOCAL_VARIABLES
88 origin ENUM_BITFIELD (4); /* Variable origin. */
89#else
90 origin ENUM_BITFIELD (3); /* Variable origin. */
91#endif
92 enum variable_export
93 {
94 v_export, /* Export this variable. */
95 v_noexport, /* Don't export this variable. */
96 v_ifset, /* Export it if it has a non-default value. */
97 v_default /* Decide in target_environment. */
98 } export ENUM_BITFIELD (2);
99 };
100
101/* Structure that represents a variable set. */
102
103struct variable_set
104 {
105 struct hash_table table; /* Hash table of variables. */
106 };
107
108/* Structure that represents a list of variable sets. */
109
110struct variable_set_list
111 {
112 struct variable_set_list *next; /* Link in the chain. */
113 struct variable_set *set; /* Variable set. */
114 };
115
116/* Structure used for pattern-specific variables. */
117
118struct pattern_var
119 {
120 struct pattern_var *next;
121 const char *suffix;
122 const char *target;
123 unsigned int len;
124 struct variable variable;
125 };
126
127extern char *variable_buffer;
128extern struct variable_set_list *current_variable_set_list;
129
130/* expand.c */
131char *variable_buffer_output (char *ptr, const char *string, unsigned int length);
132char *variable_expand (const char *line);
133char *variable_expand_for_file (const char *line, struct file *file);
134#ifdef CONFIG_WITH_COMMANDS_FUNC
135char *variable_expand_for_file_2 (char *o, const char *line, struct file *file);
136#endif
137char *allocated_variable_expand_for_file (const char *line, struct file *file);
138#define allocated_variable_expand(line) \
139 allocated_variable_expand_for_file (line, (struct file *) 0)
140char *expand_argument (const char *str, const char *end);
141char *variable_expand_string (char *line, const char *string, long length);
142void install_variable_buffer (char **bufp, unsigned int *lenp);
143void restore_variable_buffer (char *buf, unsigned int len);
144#ifdef CONFIG_WITH_VALUE_LENGTH
145extern void append_expanded_string_to_variable (struct variable *v, const char *value, int append);
146#endif
147
148/* function.c */
149int handle_function (char **op, const char **stringp);
150int pattern_matches (const char *pattern, const char *percent, const char *str);
151char *subst_expand (char *o, const char *text, const char *subst,
152 const char *replace, unsigned int slen, unsigned int rlen,
153 int by_word);
154char *patsubst_expand_pat (char *o, const char *text, const char *pattern,
155 const char *replace, const char *pattern_percent,
156 const char *replace_percent);
157char *patsubst_expand (char *o, const char *text, char *pattern, char *replace);
158#ifdef CONFIG_WITH_COMMANDS_FUNC
159char *func_commands (char *o, char **argv, const char *funcname);
160#endif
161
162/* expand.c */
163char *recursively_expand_for_file (struct variable *v, struct file *file);
164#define recursively_expand(v) recursively_expand_for_file (v, NULL)
165
166/* variable.c */
167struct variable_set_list *create_new_variable_set (void);
168void free_variable_set (struct variable_set_list *);
169struct variable_set_list *push_new_variable_scope (void);
170void pop_variable_scope (void);
171void define_automatic_variables (void);
172void initialize_file_variables (struct file *file, int reading);
173void print_file_variables (const struct file *file);
174void print_variable_set (struct variable_set *set, char *prefix);
175void merge_variable_set_lists (struct variable_set_list **to_list,
176 struct variable_set_list *from_list);
177struct variable *do_variable_definition (const struct floc *flocp,
178 const char *name, const char *value,
179 enum variable_origin origin,
180 enum variable_flavor flavor,
181 int target_var);
182struct variable *parse_variable_definition (struct variable *v, char *line);
183struct variable *try_variable_definition (const struct floc *flocp, char *line,
184 enum variable_origin origin,
185 int target_var);
186void init_hash_global_variable_set (void);
187void hash_init_function_table (void);
188struct variable *lookup_variable (const char *name, unsigned int length);
189struct variable *lookup_variable_in_set (const char *name, unsigned int length,
190 const struct variable_set *set);
191
192#ifdef CONFIG_WITH_VALUE_LENGTH
193void append_string_to_variable (struct variable *v, const char *value,
194 unsigned int value_len, int append);
195
196struct variable *define_variable_in_set (const char *name, unsigned int length,
197 const char *value,
198 unsigned int value_length,
199 int duplicate_value,
200 enum variable_origin origin,
201 int recursive,
202 struct variable_set *set,
203 const struct floc *flocp);
204
205/* Define a variable in the current variable set. */
206
207#define define_variable(n,l,v,o,r) \
208 define_variable_in_set((n),(l),(v),~0U,1,(o),(r),\
209 current_variable_set_list->set,NILF)
210
211#define define_variable_vl(n,l,v,vl,dv,o,r) \
212 define_variable_in_set((n),(l),(v),(vl),(dv),(o),(r),\
213 current_variable_set_list->set,NILF)
214
215/* Define a variable with a location in the current variable set. */
216
217#define define_variable_loc(n,l,v,o,r,f) \
218 define_variable_in_set((n),(l),(v),~0U,1,(o),(r),\
219 current_variable_set_list->set,(f))
220
221/* Define a variable with a location in the global variable set. */
222
223#define define_variable_global(n,l,v,o,r,f) \
224 define_variable_in_set((n),(l),(v),~0U,1,(o),(r),NULL,(f))
225
226#define define_variable_vl_global(n,l,v,vl,dv,o,r,f) \
227 define_variable_in_set((n),(l),(v),(vl),(dv),(o),(r),NULL,(f))
228
229/* Define a variable in FILE's variable set. */
230
231#define define_variable_for_file(n,l,v,o,r,f) \
232 define_variable_in_set((n),(l),(v),~0U,1,(o),(r),(f)->variables->set,NILF)
233
234#else /* !CONFIG_WITH_VALUE_LENGTH */
235
236struct variable *define_variable_in_set (const char *name, unsigned int length,
237 const char *value,
238 enum variable_origin origin,
239 int recursive,
240 struct variable_set *set,
241 const struct floc *flocp);
242
243/* Define a variable in the current variable set. */
244
245#define define_variable(n,l,v,o,r) \
246 define_variable_in_set((n),(l),(v),(o),(r),\
247 current_variable_set_list->set,NILF) /* force merge conflict */
248
249/* Define a variable with a location in the current variable set. */
250
251#define define_variable_loc(n,l,v,o,r,f) \
252 define_variable_in_set((n),(l),(v),(o),(r),\
253 current_variable_set_list->set,(f)) /* force merge conflict */
254
255/* Define a variable with a location in the global variable set. */
256
257#define define_variable_global(n,l,v,o,r,f) \
258 define_variable_in_set((n),(l),(v),(o),(r),NULL,(f)) /* force merge conflict */
259
260/* Define a variable in FILE's variable set. */
261
262#define define_variable_for_file(n,l,v,o,r,f) \
263 define_variable_in_set((n),(l),(v),(o),(r),(f)->variables->set,NILF) /* force merge conflict */
264
265#endif /* !CONFIG_WITH_VALUE_LENGTH */
266
267/* Warn that NAME is an undefined variable. */
268
269#define warn_undefined(n,l) do{\
270 if (warn_undefined_variables_flag) \
271 error (reading_file, \
272 _("warning: undefined variable `%.*s'"), \
273 (int)(l), (n)); \
274 }while(0)
275
276char **target_environment (struct file *file);
277
278struct pattern_var *create_pattern_var (const char *target,
279 const char *suffix);
280
281extern int export_all_variables;
282
283#ifdef KMK
284# define MAKELEVEL_NAME "KMK_LEVEL"
285#else
286#define MAKELEVEL_NAME "MAKELEVEL"
287#endif
288#define MAKELEVEL_LENGTH (sizeof (MAKELEVEL_NAME) - 1)
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette