VirtualBox

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

Last change on this file since 1889 was 1889, checked in by bird, 16 years ago

kmk: cleaned out the VARIABLE_HASH code (was removed in favor of the a variable strcache).

  • Property svn:eol-style set to native
File size: 15.8 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 o_file, /* Variable given in a makefile. */
28 o_env_override, /* Variable from environment, if -e. */
29 o_command, /* Variable given by user. */
30 o_override, /* Variable from an `override' directive. */
31#ifdef CONFIG_WITH_LOCAL_VARIABLES
32 o_local, /* Variable from an 'local' directive. */
33#endif
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#ifndef CONFIG_WITH_STRCACHE2
60 char *name; /* Variable name. */
61#else
62 const char *name; /* Variable name (in varaible_strcache). */
63#endif
64 int length; /* strlen (name) */
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#ifdef KMK
130extern unsigned int variable_buffer_length;
131#define VARIABLE_BUFFER_ZONE 5
132#endif
133
134/* expand.c */
135#ifndef KMK
136char *variable_buffer_output (char *ptr, const char *string, unsigned int length);
137#else /* KMK */
138/* Subroutine of variable_expand and friends:
139 The text to add is LENGTH chars starting at STRING to the variable_buffer.
140 The text is added to the buffer at PTR, and the updated pointer into
141 the buffer is returned as the value. Thus, the value returned by
142 each call to variable_buffer_output should be the first argument to
143 the following call. */
144
145__inline static char *
146variable_buffer_output (char *ptr, const char *string, unsigned int length)
147{
148 register unsigned int newlen = length + (ptr - variable_buffer);
149
150 if ((newlen + VARIABLE_BUFFER_ZONE) > variable_buffer_length)
151 {
152 unsigned int offset = ptr - variable_buffer;
153 variable_buffer_length = variable_buffer_length <= 1024
154 ? 2048 : variable_buffer_length * 4;
155 if (variable_buffer_length < newlen + 100)
156 variable_buffer_length = (newlen + 100 + 1023) & ~1023U;
157 variable_buffer = xrealloc (variable_buffer, variable_buffer_length);
158 ptr = variable_buffer + offset;
159 }
160
161# ifndef _MSC_VER
162 switch (length)
163 {
164 case 4: ptr[3] = string[3];
165 case 3: ptr[2] = string[2];
166 case 2: ptr[1] = string[1];
167 case 1: ptr[0] = string[0];
168 case 0:
169 break;
170 default:
171 memcpy (ptr, string, length);
172 break;
173 }
174# else
175 memcpy (ptr, string, length);
176# endif
177 return ptr + length;
178}
179
180#endif /* KMK */
181char *variable_expand (const char *line);
182char *variable_expand_for_file (const char *line, struct file *file);
183#ifdef CONFIG_WITH_COMMANDS_FUNC
184char *variable_expand_for_file_2 (char *o, const char *line, unsigned int lenght,
185 struct file *file, unsigned int *value_lenp);
186#endif
187char *allocated_variable_expand_for_file (const char *line, struct file *file);
188#ifndef CONFIG_WITH_VALUE_LENGTH
189#define allocated_variable_expand(line) \
190 allocated_variable_expand_for_file (line, (struct file *) 0)
191#else /* CONFIG_WITH_VALUE_LENGTH */
192# define allocated_variable_expand(line) \
193 allocated_variable_expand_2 (line, -1, NULL)
194char *allocated_variable_expand_2(const char *line, unsigned int length, unsigned int *value_lenp);
195#endif /* CONFIG_WITH_VALUE_LENGTH */
196char *expand_argument (const char *str, const char *end);
197#ifndef CONFIG_WITH_VALUE_LENGTH
198char *variable_expand_string (char *line, const char *string, long length);
199#else /* CONFIG_WITH_VALUE_LENGTH */
200char *variable_expand_string_2 (char *line, const char *string, long length, char **eol);
201__inline static char *
202variable_expand_string (char *line, const char *string, long length)
203{
204 char *ignored;
205 return variable_expand_string_2 (line, string, length, &ignored);
206}
207#endif /* CONFIG_WITH_VALUE_LENGTH */
208void install_variable_buffer (char **bufp, unsigned int *lenp);
209void restore_variable_buffer (char *buf, unsigned int len);
210#ifdef CONFIG_WITH_VALUE_LENGTH
211void append_expanded_string_to_variable (struct variable *v, const char *value,
212 unsigned int value_len, int append);
213#endif
214
215/* function.c */
216#ifndef CONFIG_WITH_VALUE_LENGTH
217int handle_function (char **op, const char **stringp);
218#else
219int handle_function (char **op, const char **stringp, const char *eol);
220#endif
221int pattern_matches (const char *pattern, const char *percent, const char *str);
222char *subst_expand (char *o, const char *text, const char *subst,
223 const char *replace, unsigned int slen, unsigned int rlen,
224 int by_word);
225char *patsubst_expand_pat (char *o, const char *text, const char *pattern,
226 const char *replace, const char *pattern_percent,
227 const char *replace_percent);
228char *patsubst_expand (char *o, const char *text, char *pattern, char *replace);
229#ifdef CONFIG_WITH_COMMANDS_FUNC
230char *func_commands (char *o, char **argv, const char *funcname);
231#endif
232
233/* expand.c */
234#ifndef CONFIG_WITH_VALUE_LENGTH
235char *recursively_expand_for_file (struct variable *v, struct file *file);
236#define recursively_expand(v) recursively_expand_for_file (v, NULL)
237#else
238char *recursively_expand_for_file (struct variable *v, struct file *file,
239 unsigned int *value_lenp);
240#define recursively_expand(v) recursively_expand_for_file (v, NULL, NULL)
241#endif
242
243/* variable.c */
244struct variable_set_list *create_new_variable_set (void);
245void free_variable_set (struct variable_set_list *);
246struct variable_set_list *push_new_variable_scope (void);
247void pop_variable_scope (void);
248void define_automatic_variables (void);
249void initialize_file_variables (struct file *file, int reading);
250void print_file_variables (const struct file *file);
251void print_variable_set (struct variable_set *set, char *prefix);
252void merge_variable_set_lists (struct variable_set_list **to_list,
253 struct variable_set_list *from_list);
254#ifndef CONFIG_WITH_VALUE_LENGTH
255struct variable *do_variable_definition (const struct floc *flocp,
256 const char *name, const char *value,
257 enum variable_origin origin,
258 enum variable_flavor flavor,
259 int target_var);
260struct variable *parse_variable_definition (struct variable *v, char *line);
261struct variable *try_variable_definition (const struct floc *flocp, char *line,
262 enum variable_origin origin,
263 int target_var);
264#else /* CONFIG_WITH_VALUE_LENGTH */
265# define do_variable_definition(flocp, varname, value, origin, flavor, target_var) \
266 do_variable_definition_2 ((flocp), (varname), (value), ~0U, 0, NULL, \
267 (origin), (flavor), (target_var))
268
269struct variable *do_variable_definition_2 (const struct floc *flocp,
270 const char *varname,
271 const char *value,
272 unsigned int value_len,
273 int simple_value, char *free_value,
274 enum variable_origin origin,
275 enum variable_flavor flavor,
276 int target_var);
277struct variable *parse_variable_definition (struct variable *v, char *line,
278 char *eos);
279struct variable *try_variable_definition (const struct floc *flocp, char *line,
280 char *eos,
281 enum variable_origin origin,
282 int target_var);
283#endif /* CONFIG_WITH_VALUE_LENGTH */
284void init_hash_global_variable_set (void);
285void hash_init_function_table (void);
286struct variable *lookup_variable (const char *name, unsigned int length);
287struct variable *lookup_variable_in_set (const char *name, unsigned int length,
288 const struct variable_set *set);
289
290#ifdef CONFIG_WITH_VALUE_LENGTH
291void append_string_to_variable (struct variable *v, const char *value,
292 unsigned int value_len, int append);
293
294struct variable *define_variable_in_set (const char *name, unsigned int length,
295 const char *value,
296 unsigned int value_length,
297 int duplicate_value,
298 enum variable_origin origin,
299 int recursive,
300 struct variable_set *set,
301 const struct floc *flocp);
302
303/* Define a variable in the current variable set. */
304
305#define define_variable(n,l,v,o,r) \
306 define_variable_in_set((n),(l),(v),~0U,1,(o),(r),\
307 current_variable_set_list->set,NILF)
308
309#define define_variable_vl(n,l,v,vl,dv,o,r) \
310 define_variable_in_set((n),(l),(v),(vl),(dv),(o),(r),\
311 current_variable_set_list->set,NILF)
312
313/* Define a variable with a location in the current variable set. */
314
315#define define_variable_loc(n,l,v,o,r,f) \
316 define_variable_in_set((n),(l),(v),~0U,1,(o),(r),\
317 current_variable_set_list->set,(f))
318
319/* Define a variable with a location in the global variable set. */
320
321#define define_variable_global(n,l,v,o,r,f) \
322 define_variable_in_set((n),(l),(v),~0U,1,(o),(r),NULL,(f))
323
324#define define_variable_vl_global(n,l,v,vl,dv,o,r,f) \
325 define_variable_in_set((n),(l),(v),(vl),(dv),(o),(r),NULL,(f))
326
327/* Define a variable in FILE's variable set. */
328
329#define define_variable_for_file(n,l,v,o,r,f) \
330 define_variable_in_set((n),(l),(v),~0U,1,(o),(r),(f)->variables->set,NILF)
331
332#else /* !CONFIG_WITH_VALUE_LENGTH */
333
334struct variable *define_variable_in_set (const char *name, unsigned int length,
335 const char *value,
336 enum variable_origin origin,
337 int recursive,
338 struct variable_set *set,
339 const struct floc *flocp);
340
341/* Define a variable in the current variable set. */
342
343#define define_variable(n,l,v,o,r) \
344 define_variable_in_set((n),(l),(v),(o),(r),\
345 current_variable_set_list->set,NILF) /* force merge conflict */
346
347/* Define a variable with a location in the current variable set. */
348
349#define define_variable_loc(n,l,v,o,r,f) \
350 define_variable_in_set((n),(l),(v),(o),(r),\
351 current_variable_set_list->set,(f)) /* force merge conflict */
352
353/* Define a variable with a location in the global variable set. */
354
355#define define_variable_global(n,l,v,o,r,f) \
356 define_variable_in_set((n),(l),(v),(o),(r),NULL,(f)) /* force merge conflict */
357
358/* Define a variable in FILE's variable set. */
359
360#define define_variable_for_file(n,l,v,o,r,f) \
361 define_variable_in_set((n),(l),(v),(o),(r),(f)->variables->set,NILF) /* force merge conflict */
362
363#endif /* !CONFIG_WITH_VALUE_LENGTH */
364
365/* Warn that NAME is an undefined variable. */
366
367#define warn_undefined(n,l) do{\
368 if (warn_undefined_variables_flag) \
369 error (reading_file, \
370 _("warning: undefined variable `%.*s'"), \
371 (int)(l), (n)); \
372 }while(0)
373
374char **target_environment (struct file *file);
375
376struct pattern_var *create_pattern_var (const char *target,
377 const char *suffix);
378
379extern int export_all_variables;
380
381#ifdef KMK
382# define MAKELEVEL_NAME "KMK_LEVEL"
383#else
384#define MAKELEVEL_NAME "MAKELEVEL"
385#endif
386#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