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

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

kmk: more length optimizations.

  • Property svn:eol-style set to native
File size: 14.3 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 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#ifndef CONFIG_WITH_VALUE_LENGTH
139#define allocated_variable_expand(line) \
140 allocated_variable_expand_for_file (line, (struct file *) 0)
141#else /* CONFIG_WITH_VALUE_LENGTH */
142# define allocated_variable_expand(line) \
143 allocated_variable_expand_2 (line, -1, NULL)
144char *allocated_variable_expand_2(const char *line, unsigned int length, unsigned int *value_lenp);
145#endif /* CONFIG_WITH_VALUE_LENGTH */
146char *expand_argument (const char *str, const char *end);
147#ifndef CONFIG_WITH_VALUE_LENGTH
148char *variable_expand_string (char *line, const char *string, long length);
149#else /* CONFIG_WITH_VALUE_LENGTH */
150char *variable_expand_string_2 (char *line, const char *string, long length, char **eol);
151__inline static char *
152variable_expand_string (char *line, const char *string, long length)
153{
154 char *ignored;
155 return variable_expand_string_2 (line, string, length, &ignored);
156}
157#endif /* CONFIG_WITH_VALUE_LENGTH */
158void install_variable_buffer (char **bufp, unsigned int *lenp);
159void restore_variable_buffer (char *buf, unsigned int len);
160#ifdef CONFIG_WITH_VALUE_LENGTH
161void append_expanded_string_to_variable (struct variable *v, const char *value,
162 unsigned int value_len, int append);
163#endif
164
165/* function.c */
166#ifndef CONFIG_WITH_VALUE_LENGTH
167int handle_function (char **op, const char **stringp);
168#else
169int handle_function (char **op, const char **stringp, const char *eol);
170#endif
171int pattern_matches (const char *pattern, const char *percent, const char *str);
172char *subst_expand (char *o, const char *text, const char *subst,
173 const char *replace, unsigned int slen, unsigned int rlen,
174 int by_word);
175char *patsubst_expand_pat (char *o, const char *text, const char *pattern,
176 const char *replace, const char *pattern_percent,
177 const char *replace_percent);
178char *patsubst_expand (char *o, const char *text, char *pattern, char *replace);
179#ifdef CONFIG_WITH_COMMANDS_FUNC
180char *func_commands (char *o, char **argv, const char *funcname);
181#endif
182
183/* expand.c */
184#ifndef CONFIG_WITH_VALUE_LENGTH
185char *recursively_expand_for_file (struct variable *v, struct file *file);
186#define recursively_expand(v) recursively_expand_for_file (v, NULL)
187#else
188char *recursively_expand_for_file (struct variable *v, struct file *file,
189 unsigned int *value_lenp);
190#define recursively_expand(v) recursively_expand_for_file (v, NULL, NULL)
191#endif
192
193/* variable.c */
194struct variable_set_list *create_new_variable_set (void);
195void free_variable_set (struct variable_set_list *);
196struct variable_set_list *push_new_variable_scope (void);
197void pop_variable_scope (void);
198void define_automatic_variables (void);
199void initialize_file_variables (struct file *file, int reading);
200void print_file_variables (const struct file *file);
201void print_variable_set (struct variable_set *set, char *prefix);
202void merge_variable_set_lists (struct variable_set_list **to_list,
203 struct variable_set_list *from_list);
204#ifndef CONFIG_WITH_VALUE_LENGTH
205struct variable *do_variable_definition (const struct floc *flocp,
206 const char *name, const char *value,
207 enum variable_origin origin,
208 enum variable_flavor flavor,
209 int target_var);
210struct variable *parse_variable_definition (struct variable *v, char *line);
211struct variable *try_variable_definition (const struct floc *flocp, char *line,
212 enum variable_origin origin,
213 int target_var);
214#else /* CONFIG_WITH_VALUE_LENGTH */
215# define do_variable_definition(flocp, varname, value, origin, flavor, target_var) \
216 do_variable_definition_2 ((flocp), (varname), (value), ~0U, 0, NULL, \
217 (origin), (flavor), (target_var))
218
219struct variable *do_variable_definition_2 (const struct floc *flocp,
220 const char *varname,
221 const char *value,
222 unsigned int value_len,
223 int simple_value, char *free_value,
224 enum variable_origin origin,
225 enum variable_flavor flavor,
226 int target_var);
227struct variable *parse_variable_definition (struct variable *v, char *line,
228 char *eos);
229struct variable *try_variable_definition (const struct floc *flocp, char *line,
230 char *eos,
231 enum variable_origin origin,
232 int target_var);
233#endif /* CONFIG_WITH_VALUE_LENGTH */
234void init_hash_global_variable_set (void);
235void hash_init_function_table (void);
236struct variable *lookup_variable (const char *name, unsigned int length);
237struct variable *lookup_variable_in_set (const char *name, unsigned int length,
238 const struct variable_set *set);
239
240#ifdef CONFIG_WITH_VALUE_LENGTH
241void append_string_to_variable (struct variable *v, const char *value,
242 unsigned int value_len, int append);
243
244struct variable *define_variable_in_set (const char *name, unsigned int length,
245 const char *value,
246 unsigned int value_length,
247 int duplicate_value,
248 enum variable_origin origin,
249 int recursive,
250 struct variable_set *set,
251 const struct floc *flocp);
252
253/* Define a variable in the current variable set. */
254
255#define define_variable(n,l,v,o,r) \
256 define_variable_in_set((n),(l),(v),~0U,1,(o),(r),\
257 current_variable_set_list->set,NILF)
258
259#define define_variable_vl(n,l,v,vl,dv,o,r) \
260 define_variable_in_set((n),(l),(v),(vl),(dv),(o),(r),\
261 current_variable_set_list->set,NILF)
262
263/* Define a variable with a location in the current variable set. */
264
265#define define_variable_loc(n,l,v,o,r,f) \
266 define_variable_in_set((n),(l),(v),~0U,1,(o),(r),\
267 current_variable_set_list->set,(f))
268
269/* Define a variable with a location in the global variable set. */
270
271#define define_variable_global(n,l,v,o,r,f) \
272 define_variable_in_set((n),(l),(v),~0U,1,(o),(r),NULL,(f))
273
274#define define_variable_vl_global(n,l,v,vl,dv,o,r,f) \
275 define_variable_in_set((n),(l),(v),(vl),(dv),(o),(r),NULL,(f))
276
277/* Define a variable in FILE's variable set. */
278
279#define define_variable_for_file(n,l,v,o,r,f) \
280 define_variable_in_set((n),(l),(v),~0U,1,(o),(r),(f)->variables->set,NILF)
281
282#else /* !CONFIG_WITH_VALUE_LENGTH */
283
284struct variable *define_variable_in_set (const char *name, unsigned int length,
285 const char *value,
286 enum variable_origin origin,
287 int recursive,
288 struct variable_set *set,
289 const struct floc *flocp);
290
291/* Define a variable in the current variable set. */
292
293#define define_variable(n,l,v,o,r) \
294 define_variable_in_set((n),(l),(v),(o),(r),\
295 current_variable_set_list->set,NILF) /* force merge conflict */
296
297/* Define a variable with a location in the current variable set. */
298
299#define define_variable_loc(n,l,v,o,r,f) \
300 define_variable_in_set((n),(l),(v),(o),(r),\
301 current_variable_set_list->set,(f)) /* force merge conflict */
302
303/* Define a variable with a location in the global variable set. */
304
305#define define_variable_global(n,l,v,o,r,f) \
306 define_variable_in_set((n),(l),(v),(o),(r),NULL,(f)) /* force merge conflict */
307
308/* Define a variable in FILE's variable set. */
309
310#define define_variable_for_file(n,l,v,o,r,f) \
311 define_variable_in_set((n),(l),(v),(o),(r),(f)->variables->set,NILF) /* force merge conflict */
312
313#endif /* !CONFIG_WITH_VALUE_LENGTH */
314
315/* Warn that NAME is an undefined variable. */
316
317#define warn_undefined(n,l) do{\
318 if (warn_undefined_variables_flag) \
319 error (reading_file, \
320 _("warning: undefined variable `%.*s'"), \
321 (int)(l), (n)); \
322 }while(0)
323
324char **target_environment (struct file *file);
325
326struct pattern_var *create_pattern_var (const char *target,
327 const char *suffix);
328
329extern int export_all_variables;
330
331#ifdef KMK
332# define MAKELEVEL_NAME "KMK_LEVEL"
333#else
334#define MAKELEVEL_NAME "MAKELEVEL"
335#endif
336#define MAKELEVEL_LENGTH (sizeof (MAKELEVEL_NAME) - 1)
Note: See TracBrowser for help on using the repository browser.