source: trunk/src/kmk/variable.h@ 1927

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

kmk: Inlined much of handle_function/lookup_function so variable_expand_string_2 can avoid having to make the call for every variable it encounters. Also fixed the func_char_map generation.
  • Property svn:eol-style set to native
File size: 16.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 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 *nameend, 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#if defined (CONFIG_WITH_VALUE_LENGTH)
233/* Avoid calling handle_function for every variable, do the
234 basic checks in variable_expand_string_2. */
235extern char func_char_map[256];
236# define MAX_FUNCTION_LENGTH 12
237# define MIN_FUNCTION_LENGTH 2
238MY_INLINE const char *
239may_be_function_name (const char *name, const char *eos)
240{
241 unsigned char ch;
242 unsigned int len = name - eos;
243
244 /* Minimum length is MIN + whitespace. Check this directly.
245 ASSUMES: MIN_FUNCTION_LENGTH == 2 */
246
247 if (MY_PREDICT_TRUE(len < MIN_FUNCTION_LENGTH + 1
248 || !func_char_map[(int)(name[0])]
249 || !func_char_map[(int)(name[1])]))
250 return 0;
251 if (MY_PREDICT_TRUE(!func_char_map[ch = name[2]]))
252 return isspace (ch) ? name + 2 : 0;
253
254 name += 3;
255 if (len > MAX_FUNCTION_LENGTH)
256 len = MAX_FUNCTION_LENGTH - 3;
257 else if (len == 3)
258 len -= 3;
259 if (!len)
260 return 0;
261
262 /* Loop over the remaining possiblities. */
263
264 while (func_char_map[ch = *name])
265 {
266 if (!len--)
267 return 0;
268 name++;
269 }
270 if (ch == '\0' || isblank (ch))
271 return name;
272 return 0;
273}
274#endif /* CONFIG_WITH_VALUE_LENGTH */
275
276/* expand.c */
277#ifndef CONFIG_WITH_VALUE_LENGTH
278char *recursively_expand_for_file (struct variable *v, struct file *file);
279#define recursively_expand(v) recursively_expand_for_file (v, NULL)
280#else
281char *recursively_expand_for_file (struct variable *v, struct file *file,
282 unsigned int *value_lenp);
283#define recursively_expand(v) recursively_expand_for_file (v, NULL, NULL)
284#endif
285
286/* variable.c */
287struct variable_set_list *create_new_variable_set (void);
288void free_variable_set (struct variable_set_list *);
289struct variable_set_list *push_new_variable_scope (void);
290void pop_variable_scope (void);
291void define_automatic_variables (void);
292void initialize_file_variables (struct file *file, int reading);
293void print_file_variables (const struct file *file);
294void print_variable_set (struct variable_set *set, char *prefix);
295void merge_variable_set_lists (struct variable_set_list **to_list,
296 struct variable_set_list *from_list);
297#ifndef CONFIG_WITH_VALUE_LENGTH
298struct variable *do_variable_definition (const struct floc *flocp,
299 const char *name, const char *value,
300 enum variable_origin origin,
301 enum variable_flavor flavor,
302 int target_var);
303struct variable *parse_variable_definition (struct variable *v, char *line);
304struct variable *try_variable_definition (const struct floc *flocp, char *line,
305 enum variable_origin origin,
306 int target_var);
307#else /* CONFIG_WITH_VALUE_LENGTH */
308# define do_variable_definition(flocp, varname, value, origin, flavor, target_var) \
309 do_variable_definition_2 ((flocp), (varname), (value), ~0U, 0, NULL, \
310 (origin), (flavor), (target_var))
311
312struct variable *do_variable_definition_2 (const struct floc *flocp,
313 const char *varname,
314 const char *value,
315 unsigned int value_len,
316 int simple_value, char *free_value,
317 enum variable_origin origin,
318 enum variable_flavor flavor,
319 int target_var);
320struct variable *parse_variable_definition (struct variable *v, char *line,
321 char *eos);
322struct variable *try_variable_definition (const struct floc *flocp, char *line,
323 char *eos,
324 enum variable_origin origin,
325 int target_var);
326#endif /* CONFIG_WITH_VALUE_LENGTH */
327void init_hash_global_variable_set (void);
328void hash_init_function_table (void);
329struct variable *lookup_variable (const char *name, unsigned int length);
330struct variable *lookup_variable_in_set (const char *name, unsigned int length,
331 const struct variable_set *set);
332
333#ifdef CONFIG_WITH_VALUE_LENGTH
334void append_string_to_variable (struct variable *v, const char *value,
335 unsigned int value_len, int append);
336
337struct variable *define_variable_in_set (const char *name, unsigned int length,
338 const char *value,
339 unsigned int value_length,
340 int duplicate_value,
341 enum variable_origin origin,
342 int recursive,
343 struct variable_set *set,
344 const struct floc *flocp);
345
346/* Define a variable in the current variable set. */
347
348#define define_variable(n,l,v,o,r) \
349 define_variable_in_set((n),(l),(v),~0U,1,(o),(r),\
350 current_variable_set_list->set,NILF)
351
352#define define_variable_vl(n,l,v,vl,dv,o,r) \
353 define_variable_in_set((n),(l),(v),(vl),(dv),(o),(r),\
354 current_variable_set_list->set,NILF)
355
356/* Define a variable with a location in the current variable set. */
357
358#define define_variable_loc(n,l,v,o,r,f) \
359 define_variable_in_set((n),(l),(v),~0U,1,(o),(r),\
360 current_variable_set_list->set,(f))
361
362/* Define a variable with a location in the global variable set. */
363
364#define define_variable_global(n,l,v,o,r,f) \
365 define_variable_in_set((n),(l),(v),~0U,1,(o),(r),NULL,(f))
366
367#define define_variable_vl_global(n,l,v,vl,dv,o,r,f) \
368 define_variable_in_set((n),(l),(v),(vl),(dv),(o),(r),NULL,(f))
369
370/* Define a variable in FILE's variable set. */
371
372#define define_variable_for_file(n,l,v,o,r,f) \
373 define_variable_in_set((n),(l),(v),~0U,1,(o),(r),(f)->variables->set,NILF)
374
375#else /* !CONFIG_WITH_VALUE_LENGTH */
376
377struct variable *define_variable_in_set (const char *name, unsigned int length,
378 const char *value,
379 enum variable_origin origin,
380 int recursive,
381 struct variable_set *set,
382 const struct floc *flocp);
383
384/* Define a variable in the current variable set. */
385
386#define define_variable(n,l,v,o,r) \
387 define_variable_in_set((n),(l),(v),(o),(r),\
388 current_variable_set_list->set,NILF) /* force merge conflict */
389
390/* Define a variable with a location in the current variable set. */
391
392#define define_variable_loc(n,l,v,o,r,f) \
393 define_variable_in_set((n),(l),(v),(o),(r),\
394 current_variable_set_list->set,(f)) /* force merge conflict */
395
396/* Define a variable with a location in the global variable set. */
397
398#define define_variable_global(n,l,v,o,r,f) \
399 define_variable_in_set((n),(l),(v),(o),(r),NULL,(f)) /* force merge conflict */
400
401/* Define a variable in FILE's variable set. */
402
403#define define_variable_for_file(n,l,v,o,r,f) \
404 define_variable_in_set((n),(l),(v),(o),(r),(f)->variables->set,NILF) /* force merge conflict */
405
406#endif /* !CONFIG_WITH_VALUE_LENGTH */
407
408/* Warn that NAME is an undefined variable. */
409
410#define warn_undefined(n,l) do{\
411 if (warn_undefined_variables_flag) \
412 error (reading_file, \
413 _("warning: undefined variable `%.*s'"), \
414 (int)(l), (n)); \
415 }while(0)
416
417char **target_environment (struct file *file);
418
419struct pattern_var *create_pattern_var (const char *target,
420 const char *suffix);
421
422extern int export_all_variables;
423
424#ifdef KMK
425# define MAKELEVEL_NAME "KMK_LEVEL"
426#else
427#define MAKELEVEL_NAME "MAKELEVEL"
428#endif
429#define MAKELEVEL_LENGTH (sizeof (MAKELEVEL_NAME) - 1)
Note: See TracBrowser for help on using the repository browser.