VirtualBox

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

Last change on this file since 2767 was 2765, checked in by bird, 10 years ago

Started on a make expression and string expansion 'compiler'.

  • Property svn:eol-style set to native
File size: 20.1 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, 2007 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 3 of the License, or (at your option) any later
10version.
11
12GNU Make is distributed in the hope that it will be useful, but WITHOUT ANY
13WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
14A PARTICULAR PURPOSE. See the GNU General Public License for more details.
15
16You should have received a copy of the GNU General Public License along with
17this program. If not, see <http://www.gnu.org/licenses/>. */
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#ifdef CONFIG_WITH_VALUE_LENGTH
57#define VAR_ALIGN_VALUE_ALLOC(len) ( ((len) + (unsigned int)15) & ~(unsigned int)15 )
58#endif
59
60struct variable
61 {
62#ifndef CONFIG_WITH_STRCACHE2
63 char *name; /* Variable name. */
64#else
65 const char *name; /* Variable name (in varaible_strcache). */
66#endif
67 int length; /* strlen (name) */
68#ifdef CONFIG_WITH_VALUE_LENGTH
69 unsigned int value_length; /* The length of the value. */
70 unsigned int value_alloc_len; /* The amount of memory we've actually allocated. */
71 /* FIXME: make lengths unsigned! */
72#endif
73 char *value; /* Variable value. */
74 struct floc fileinfo; /* Where the variable was defined. */
75 unsigned int recursive:1; /* Gets recursively re-evaluated. */
76 unsigned int append:1; /* Nonzero if an appending target-specific
77 variable. */
78 unsigned int conditional:1; /* Nonzero if set with a ?=. */
79 unsigned int per_target:1; /* Nonzero if a target-specific variable. */
80 unsigned int special:1; /* Nonzero if this is a special variable. */
81 unsigned int exportable:1; /* Nonzero if the variable _could_ be
82 exported. */
83 unsigned int expanding:1; /* Nonzero if currently being expanded. */
84 unsigned int private_var:1; /* Nonzero avoids inheritance of this
85 target-specific variable. */
86 unsigned int exp_count:EXP_COUNT_BITS;
87 /* If >1, allow this many self-referential
88 expansions. */
89#ifdef CONFIG_WITH_RDONLY_VARIABLE_VALUE
90 unsigned int rdonly_val:1; /* VALUE is read only (strcache/const). */
91#endif
92#ifdef KMK
93 unsigned int alias:1; /* Nonzero if alias. VALUE points to the real variable. */
94 unsigned int aliased:1; /* Nonzero if aliased. Cannot be undefined. */
95#endif
96 enum variable_flavor
97 flavor ENUM_BITFIELD (3); /* Variable flavor. */
98 enum variable_origin
99#ifdef CONFIG_WITH_LOCAL_VARIABLES
100 origin ENUM_BITFIELD (4); /* Variable origin. */
101#else
102 origin ENUM_BITFIELD (3); /* Variable origin. */
103#endif
104 enum variable_export
105 {
106 v_export, /* Export this variable. */
107 v_noexport, /* Don't export this variable. */
108 v_ifset, /* Export it if it has a non-default value. */
109 v_default /* Decide in target_environment. */
110 } export ENUM_BITFIELD (2);
111#ifdef CONFIG_WITH_MAKE_STATS
112 unsigned int changes; /* Variable modification count. */
113 unsigned int reallocs; /* Realloc on value count. */
114 unsigned int references; /* Lookup count. */
115 unsigned long long cTicksEvalVal; /* Number of ticks spend in cEvalVal. */
116#endif
117#if defined (CONFIG_WITH_COMPILER) || defined (CONFIG_WITH_MAKE_STATS)
118 unsigned int evalval_count; /* Times used with $(evalval ) or $(evalctx ). */
119 unsigned int expand_count; /* Times expanded (not to be confused with exp_count). */
120#endif
121#ifdef CONFIG_WITH_COMPILER
122 struct cceval *evalprog; /* Pointer to evalval/evalctx "program". */
123 struct ccexpand *expandprog; /* Pointer to variable expand "program". */
124#endif
125 };
126
127/* Structure that represents a variable set. */
128
129struct variable_set
130 {
131 struct hash_table table; /* Hash table of variables. */
132 };
133
134/* Structure that represents a list of variable sets. */
135
136struct variable_set_list
137 {
138 struct variable_set_list *next; /* Link in the chain. */
139 struct variable_set *set; /* Variable set. */
140 int next_is_parent; /* True if next is a parent target. */
141 };
142
143/* Structure used for pattern-specific variables. */
144
145struct pattern_var
146 {
147 struct pattern_var *next;
148 const char *suffix;
149 const char *target;
150 unsigned int len;
151 struct variable variable;
152 };
153
154extern char *variable_buffer;
155extern struct variable_set_list *current_variable_set_list;
156extern struct variable *default_goal_var;
157
158#ifdef KMK
159extern struct variable_set global_variable_set;
160extern struct variable_set_list global_setlist;
161extern unsigned int variable_buffer_length;
162# define VARIABLE_BUFFER_ZONE 5
163#endif
164
165/* expand.c */
166#ifndef KMK
167char *
168variable_buffer_output (char *ptr, const char *string, unsigned int length);
169#else /* KMK */
170/* Subroutine of variable_expand and friends:
171 The text to add is LENGTH chars starting at STRING to the variable_buffer.
172 The text is added to the buffer at PTR, and the updated pointer into
173 the buffer is returned as the value. Thus, the value returned by
174 each call to variable_buffer_output should be the first argument to
175 the following call. */
176
177__inline static char *
178variable_buffer_output (char *ptr, const char *string, unsigned int length)
179{
180 register unsigned int newlen = length + (ptr - variable_buffer);
181
182 if ((newlen + VARIABLE_BUFFER_ZONE) > variable_buffer_length)
183 {
184 unsigned int offset = ptr - variable_buffer;
185 variable_buffer_length = variable_buffer_length <= 1024
186 ? 2048 : variable_buffer_length * 4;
187 if (variable_buffer_length < newlen + 100)
188 variable_buffer_length = (newlen + 100 + 1023) & ~1023U;
189 variable_buffer = xrealloc (variable_buffer, variable_buffer_length);
190 ptr = variable_buffer + offset;
191 }
192
193# ifndef _MSC_VER
194 switch (length)
195 {
196 case 4: ptr[3] = string[3];
197 case 3: ptr[2] = string[2];
198 case 2: ptr[1] = string[1];
199 case 1: ptr[0] = string[0];
200 case 0:
201 break;
202 default:
203 memcpy (ptr, string, length);
204 break;
205 }
206# else
207 memcpy (ptr, string, length);
208# endif
209 return ptr + length;
210}
211
212#endif /* KMK */
213char *variable_expand (const char *line);
214char *variable_expand_for_file (const char *line, struct file *file);
215#if defined (CONFIG_WITH_VALUE_LENGTH) || defined (CONFIG_WITH_COMMANDS_FUNC)
216char *variable_expand_for_file_2 (char *o, const char *line, unsigned int lenght,
217 struct file *file, unsigned int *value_lenp);
218#endif
219char *allocated_variable_expand_for_file (const char *line, struct file *file);
220#ifndef CONFIG_WITH_VALUE_LENGTH
221#define allocated_variable_expand(line) \
222 allocated_variable_expand_for_file (line, (struct file *) 0)
223#else /* CONFIG_WITH_VALUE_LENGTH */
224# define allocated_variable_expand(line) \
225 allocated_variable_expand_2 (line, -1, NULL)
226char *allocated_variable_expand_2 (const char *line, unsigned int length, unsigned int *value_lenp);
227char *allocated_variable_expand_3 (const char *line, unsigned int length,
228 unsigned int *value_lenp, unsigned int *buffer_lengthp);
229void recycle_variable_buffer (char *buffer, unsigned int length);
230#endif /* CONFIG_WITH_VALUE_LENGTH */
231char *expand_argument (const char *str, const char *end);
232#ifndef CONFIG_WITH_VALUE_LENGTH
233char *
234variable_expand_string (char *line, const char *string, long length);
235#else /* CONFIG_WITH_VALUE_LENGTH */
236char *
237variable_expand_string_2 (char *line, const char *string, long length, char **eol);
238__inline static char *
239variable_expand_string (char *line, const char *string, long length)
240{
241 char *ignored;
242 return variable_expand_string_2 (line, string, length, &ignored);
243}
244#endif /* CONFIG_WITH_VALUE_LENGTH */
245void install_variable_buffer (char **bufp, unsigned int *lenp);
246void restore_variable_buffer (char *buf, unsigned int len);
247#ifdef CONFIG_WITH_VALUE_LENGTH
248void append_expanded_string_to_variable (struct variable *v, const char *value,
249 unsigned int value_len, int append);
250#endif
251
252/* function.c */
253#ifndef CONFIG_WITH_VALUE_LENGTH
254int handle_function (char **op, const char **stringp);
255#else
256int handle_function (char **op, const char **stringp, const char *nameend, const char *eol);
257#endif
258int pattern_matches (const char *pattern, const char *percent, const char *str);
259char *subst_expand (char *o, const char *text, const char *subst,
260 const char *replace, unsigned int slen, unsigned int rlen,
261 int by_word);
262char *patsubst_expand_pat (char *o, const char *text, const char *pattern,
263 const char *replace, const char *pattern_percent,
264 const char *replace_percent);
265char *patsubst_expand (char *o, const char *text, char *pattern, char *replace);
266#ifdef CONFIG_WITH_COMMANDS_FUNC
267char *func_commands (char *o, char **argv, const char *funcname);
268#endif
269#if defined (CONFIG_WITH_VALUE_LENGTH)
270/* Avoid calling handle_function for every variable, do the
271 basic checks in variable_expand_string_2. */
272extern char func_char_map[256];
273# define MAX_FUNCTION_LENGTH 12
274# define MIN_FUNCTION_LENGTH 2
275MY_INLINE const char *
276may_be_function_name (const char *name, const char *eos)
277{
278 unsigned char ch;
279 unsigned int len = name - eos;
280
281 /* Minimum length is MIN + whitespace. Check this directly.
282 ASSUMES: MIN_FUNCTION_LENGTH == 2 */
283
284 if (MY_PREDICT_TRUE(len < MIN_FUNCTION_LENGTH + 1
285 || !func_char_map[(int)(name[0])]
286 || !func_char_map[(int)(name[1])]))
287 return 0;
288 if (MY_PREDICT_TRUE(!func_char_map[ch = name[2]]))
289 return isspace (ch) ? name + 2 : 0;
290
291 name += 3;
292 if (len > MAX_FUNCTION_LENGTH)
293 len = MAX_FUNCTION_LENGTH - 3;
294 else if (len == 3)
295 len -= 3;
296 if (!len)
297 return 0;
298
299 /* Loop over the remaining possiblities. */
300
301 while (func_char_map[ch = *name])
302 {
303 if (!len--)
304 return 0;
305 name++;
306 }
307 if (ch == '\0' || isblank (ch))
308 return name;
309 return 0;
310}
311#endif /* CONFIG_WITH_VALUE_LENGTH */
312
313/* expand.c */
314#ifndef CONFIG_WITH_VALUE_LENGTH
315char *recursively_expand_for_file (struct variable *v, struct file *file);
316#define recursively_expand(v) recursively_expand_for_file (v, NULL)
317#else
318char *recursively_expand_for_file (struct variable *v, struct file *file,
319 unsigned int *value_lenp);
320#define recursively_expand(v) recursively_expand_for_file (v, NULL, NULL)
321#endif
322
323/* variable.c */
324struct variable_set_list *create_new_variable_set (void);
325void free_variable_set (struct variable_set_list *);
326struct variable_set_list *push_new_variable_scope (void);
327void pop_variable_scope (void);
328void define_automatic_variables (void);
329void initialize_file_variables (struct file *file, int reading);
330void print_file_variables (const struct file *file);
331void print_variable_set (struct variable_set *set, char *prefix);
332void merge_variable_set_lists (struct variable_set_list **to_list,
333 struct variable_set_list *from_list);
334#ifndef CONFIG_WITH_VALUE_LENGTH
335struct variable *do_variable_definition (const struct floc *flocp,
336 const char *name, const char *value,
337 enum variable_origin origin,
338 enum variable_flavor flavor,
339 int target_var);
340#else /* CONFIG_WITH_VALUE_LENGTH */
341# define do_variable_definition(flocp, varname, value, origin, flavor, target_var) \
342 do_variable_definition_2 ((flocp), (varname), (value), ~0U, 0, NULL, \
343 (origin), (flavor), (target_var))
344struct variable *do_variable_definition_2 (const struct floc *flocp,
345 const char *varname,
346 const char *value,
347 unsigned int value_len,
348 int simple_value, char *free_value,
349 enum variable_origin origin,
350 enum variable_flavor flavor,
351 int target_var);
352#endif /* CONFIG_WITH_VALUE_LENGTH */
353char *parse_variable_definition (const char *line,
354 enum variable_flavor *flavor);
355struct variable *assign_variable_definition (struct variable *v, char *line IF_WITH_VALUE_LENGTH_PARAM(char *eos));
356struct variable *try_variable_definition (const struct floc *flocp, char *line
357 IF_WITH_VALUE_LENGTH_PARAM(char *eos),
358 enum variable_origin origin,
359 int target_var);
360void init_hash_global_variable_set (void);
361void hash_init_function_table (void);
362struct variable *lookup_variable (const char *name, unsigned int length);
363struct variable *lookup_variable_in_set (const char *name, unsigned int length,
364 const struct variable_set *set);
365
366#ifdef CONFIG_WITH_VALUE_LENGTH
367void append_string_to_variable (struct variable *v, const char *value,
368 unsigned int value_len, int append);
369struct variable * do_variable_definition_append (const struct floc *flocp, struct variable *v,
370 const char *value, unsigned int value_len,
371 int simple_value, enum variable_origin origin,
372 int append);
373
374struct variable *define_variable_in_set (const char *name, unsigned int length,
375 const char *value,
376 unsigned int value_length,
377 int duplicate_value,
378 enum variable_origin origin,
379 int recursive,
380 struct variable_set *set,
381 const struct floc *flocp);
382
383/* Define a variable in the current variable set. */
384
385#define define_variable(n,l,v,o,r) \
386 define_variable_in_set((n),(l),(v),~0U,1,(o),(r),\
387 current_variable_set_list->set,NILF)
388
389#define define_variable_vl(n,l,v,vl,dv,o,r) \
390 define_variable_in_set((n),(l),(v),(vl),(dv),(o),(r),\
391 current_variable_set_list->set,NILF)
392
393/* Define a variable with a constant name in the current variable set. */
394
395#define define_variable_cname(n,v,o,r) \
396 define_variable_in_set((n),(sizeof (n) - 1),(v),~0U,1,(o),(r),\
397 current_variable_set_list->set,NILF)
398
399/* Define a variable with a location in the current variable set. */
400
401#define define_variable_loc(n,l,v,o,r,f) \
402 define_variable_in_set((n),(l),(v),~0U,1,(o),(r),\
403 current_variable_set_list->set,(f))
404
405/* Define a variable with a location in the global variable set. */
406
407#define define_variable_global(n,l,v,o,r,f) \
408 define_variable_in_set((n),(l),(v),~0U,1,(o),(r),NULL,(f))
409
410#define define_variable_vl_global(n,l,v,vl,dv,o,r,f) \
411 define_variable_in_set((n),(l),(v),(vl),(dv),(o),(r),NULL,(f))
412
413/* Define a variable in FILE's variable set. */
414
415#define define_variable_for_file(n,l,v,o,r,f) \
416 define_variable_in_set((n),(l),(v),~0U,1,(o),(r),(f)->variables->set,NILF)
417
418#else /* !CONFIG_WITH_VALUE_LENGTH */
419
420struct variable *define_variable_in_set (const char *name, unsigned int length,
421 const char *value,
422 enum variable_origin origin,
423 int recursive,
424 struct variable_set *set,
425 const struct floc *flocp);
426
427/* Define a variable in the current variable set. */
428
429#define define_variable(n,l,v,o,r) \
430 define_variable_in_set((n),(l),(v),(o),(r),\
431 current_variable_set_list->set,NILF) /* force merge conflict */
432
433/* Define a variable with a constant name in the current variable set. */
434
435#define define_variable_cname(n,v,o,r) \
436 define_variable_in_set((n),(sizeof (n) - 1),(v),(o),(r),\
437 current_variable_set_list->set,NILF) /* force merge conflict */
438
439/* Define a variable with a location in the current variable set. */
440
441#define define_variable_loc(n,l,v,o,r,f) \
442 define_variable_in_set((n),(l),(v),(o),(r),\
443 current_variable_set_list->set,(f)) /* force merge conflict */
444
445/* Define a variable with a location in the global variable set. */
446
447#define define_variable_global(n,l,v,o,r,f) \
448 define_variable_in_set((n),(l),(v),(o),(r),NULL,(f)) /* force merge conflict */
449
450/* Define a variable in FILE's variable set. */
451
452#define define_variable_for_file(n,l,v,o,r,f) \
453 define_variable_in_set((n),(l),(v),(o),(r),(f)->variables->set,NILF) /* force merge conflict */
454
455#endif /* !CONFIG_WITH_VALUE_LENGTH */
456
457void undefine_variable_in_set (const char *name, unsigned int length,
458 enum variable_origin origin,
459 struct variable_set *set);
460
461/* Remove variable from the current variable set. */
462
463#define undefine_variable_global(n,l,o) \
464 undefine_variable_in_set((n),(l),(o),NULL)
465
466#ifdef KMK
467struct variable *
468define_variable_alias_in_set (const char *name, unsigned int length,
469 struct variable *target, enum variable_origin origin,
470 struct variable_set *set, const struct floc *flocp);
471#endif
472
473/* Warn that NAME is an undefined variable. */
474
475#define warn_undefined(n,l) do{\
476 if (warn_undefined_variables_flag) \
477 error (reading_file, \
478 _("warning: undefined variable `%.*s'"), \
479 (int)(l), (n)); \
480 }while(0)
481
482char **target_environment (struct file *file);
483
484struct pattern_var *create_pattern_var (const char *target,
485 const char *suffix);
486
487extern int export_all_variables;
488#ifdef CONFIG_WITH_STRCACHE2
489extern struct strcache2 variable_strcache;
490#endif
491
492#ifdef KMK
493# define MAKELEVEL_NAME "KMK_LEVEL"
494#else
495#define MAKELEVEL_NAME "MAKELEVEL"
496#endif
497#define MAKELEVEL_LENGTH (sizeof (MAKELEVEL_NAME) - 1)
498
Note: See TracBrowser for help on using the repository browser.

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