VirtualBox

source: kBuild/trunk/src/gmake/variable.h@ 530

Last change on this file since 530 was 530, checked in by bird, 19 years ago

Added kBuild specific functions for speeding up source processing.

  • Property svn:eol-style set to native
File size: 8.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 o_automatic, /* Automatic variable -- cannot be set. */
32 o_invalid /* Core dump time. */
33 };
34
35enum variable_flavor
36 {
37 f_bogus, /* Bogus (error) */
38 f_simple, /* Simple definition (:=) */
39 f_recursive, /* Recursive definition (=) */
40 f_append, /* Appending definition (+=) */
41 f_conditional /* Conditional definition (?=) */
42 };
43
44/* Structure that represents one variable definition.
45 Each bucket of the hash table is a chain of these,
46 chained through `next'. */
47
48#define EXP_COUNT_BITS 15 /* This gets all the bitfields into 32 bits */
49#define EXP_COUNT_MAX ((1<<EXP_COUNT_BITS)-1)
50
51struct variable
52 {
53 char *name; /* Variable name. */
54 int length; /* strlen (name) */
55#ifdef VARIABLE_HASH /* bird */
56 int hash1; /* the primary hash */
57 int hash2; /* the secondary hash */
58#endif
59#ifdef CONFIG_WITH_VALUE_LENGTH
60 int value_length; /* The length of the value, usually unused. */
61#endif
62 char *value; /* Variable value. */
63 struct floc fileinfo; /* Where the variable was defined. */
64 unsigned int recursive:1; /* Gets recursively re-evaluated. */
65 unsigned int append:1; /* Nonzero if an appending target-specific
66 variable. */
67 unsigned int conditional:1; /* Nonzero if set with a ?=. */
68 unsigned int per_target:1; /* Nonzero if a target-specific variable. */
69 unsigned int special:1; /* Nonzero if this is a special variable. */
70 unsigned int exportable:1; /* Nonzero if the variable _could_ be
71 exported. */
72 unsigned int expanding:1; /* Nonzero if currently being expanded. */
73 unsigned int exp_count:EXP_COUNT_BITS;
74 /* If >1, allow this many self-referential
75 expansions. */
76 enum variable_flavor
77 flavor ENUM_BITFIELD (3); /* Variable flavor. */
78 enum variable_origin
79 origin ENUM_BITFIELD (3); /* Variable origin. */
80 enum variable_export
81 {
82 v_export, /* Export this variable. */
83 v_noexport, /* Don't export this variable. */
84 v_ifset, /* Export it if it has a non-default value. */
85 v_default /* Decide in target_environment. */
86 } export ENUM_BITFIELD (2);
87 };
88
89/* Structure that represents a variable set. */
90
91struct variable_set
92 {
93 struct hash_table table; /* Hash table of variables. */
94 };
95
96/* Structure that represents a list of variable sets. */
97
98struct variable_set_list
99 {
100 struct variable_set_list *next; /* Link in the chain. */
101 struct variable_set *set; /* Variable set. */
102 };
103
104/* Structure used for pattern-specific variables. */
105
106struct pattern_var
107 {
108 struct pattern_var *next;
109 char *target;
110 unsigned int len;
111 char *suffix;
112 struct variable variable;
113 };
114
115extern char *variable_buffer;
116extern struct variable_set_list *current_variable_set_list;
117
118/* expand.c */
119extern char *variable_buffer_output PARAMS ((char *ptr, char *string, unsigned int length));
120extern char *variable_expand PARAMS ((char *line));
121extern char *variable_expand_for_file PARAMS ((char *line, struct file *file));
122extern char *allocated_variable_expand_for_file PARAMS ((char *line, struct file *file));
123#define allocated_variable_expand(line) \
124 allocated_variable_expand_for_file (line, (struct file *) 0)
125extern char *expand_argument PARAMS ((const char *str, const char *end));
126extern char *variable_expand_string PARAMS ((char *line, char *string,
127 long length));
128extern void install_variable_buffer PARAMS ((char **bufp, unsigned int *lenp));
129extern void restore_variable_buffer PARAMS ((char *buf, unsigned int len));
130
131/* function.c */
132extern int handle_function PARAMS ((char **op, char **stringp));
133extern int pattern_matches PARAMS ((char *pattern, char *percent, char *str));
134extern char *subst_expand PARAMS ((char *o, char *text, char *subst, char *replace,
135 unsigned int slen, unsigned int rlen, int by_word));
136extern char *patsubst_expand PARAMS ((char *o, char *text, char *pattern, char *replace,
137 char *pattern_percent, char *replace_percent));
138
139/* expand.c */
140extern char *recursively_expand_for_file PARAMS ((struct variable *v,
141 struct file *file));
142#define recursively_expand(v) recursively_expand_for_file (v, NULL)
143
144/* variable.c */
145extern struct variable_set_list *create_new_variable_set PARAMS ((void));
146extern void free_variable_set PARAMS ((struct variable_set_list *));
147extern struct variable_set_list *push_new_variable_scope PARAMS ((void));
148extern void pop_variable_scope PARAMS ((void));
149extern void define_automatic_variables PARAMS ((void));
150extern void initialize_file_variables PARAMS ((struct file *file, int read));
151extern void print_file_variables PARAMS ((struct file *file));
152extern void print_variable_set PARAMS ((struct variable_set *set, char *prefix));
153extern void merge_variable_set_lists PARAMS ((struct variable_set_list **to_list, struct variable_set_list *from_list));
154extern struct variable *do_variable_definition PARAMS ((const struct floc *flocp, const char *name, char *value, enum variable_origin origin, enum variable_flavor flavor, int target_var));
155extern struct variable *parse_variable_definition PARAMS ((struct variable *v, char *line));
156extern struct variable *try_variable_definition PARAMS ((const struct floc *flocp, char *line, enum variable_origin origin, int target_var));
157extern void init_hash_global_variable_set PARAMS ((void));
158extern void hash_init_function_table PARAMS ((void));
159extern struct variable *lookup_variable PARAMS ((const char *name, unsigned int length));
160extern struct variable *lookup_variable_in_set PARAMS ((const char *name,
161 unsigned int length,
162 const struct variable_set *set));
163
164extern struct variable *define_variable_in_set
165 PARAMS ((const char *name, unsigned int length, char *value,
166 enum variable_origin origin, int recursive,
167 struct variable_set *set, const struct floc *flocp));
168
169/* Define a variable in the current variable set. */
170
171#define define_variable(n,l,v,o,r) \
172 define_variable_in_set((n),(l),(v),(o),(r),\
173 current_variable_set_list->set,NILF)
174
175/* Define a variable with a location in the current variable set. */
176
177#define define_variable_loc(n,l,v,o,r,f) \
178 define_variable_in_set((n),(l),(v),(o),(r),\
179 current_variable_set_list->set,(f))
180
181/* Define a variable with a location in the global variable set. */
182
183#define define_variable_global(n,l,v,o,r,f) \
184 define_variable_in_set((n),(l),(v),(o),(r),NULL,(f))
185
186/* Define a variable in FILE's variable set. */
187
188#define define_variable_for_file(n,l,v,o,r,f) \
189 define_variable_in_set((n),(l),(v),(o),(r),(f)->variables->set,NILF)
190
191/* Warn that NAME is an undefined variable. */
192
193#define warn_undefined(n,l) do{\
194 if (warn_undefined_variables_flag) \
195 error (reading_file, \
196 _("warning: undefined variable `%.*s'"), \
197 (int)(l), (n)); \
198 }while(0)
199
200extern char **target_environment PARAMS ((struct file *file));
201
202extern struct pattern_var *create_pattern_var PARAMS ((char *target, char *suffix));
203
204extern int export_all_variables;
205
206#define MAKELEVEL_NAME "MAKELEVEL"
207#define MAKELEVEL_LENGTH (sizeof (MAKELEVEL_NAME) - 1)
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