Merge branch 'vendor/GCC44'
[dragonfly.git] / contrib / gcc-4.4 / gcc / cp / name-lookup.h
CommitLineData
c251ad9e
SS
1/* Declarations for C++ name lookup routines.
2 Copyright (C) 2003, 2004, 2005, 2007, 2008 Free Software Foundation, Inc.
3 Contributed by Gabriel Dos Reis <gdr@integrable-solutions.net>
4
5This file is part of GCC.
6
7GCC is free software; you can redistribute it and/or modify
8it under the terms of the GNU General Public License as published by
9the Free Software Foundation; either version 3, or (at your option)
10any later version.
11
12GCC is distributed in the hope that it will be useful,
13but WITHOUT ANY WARRANTY; without even the implied warranty of
14MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15GNU General Public License for more details.
16
17You should have received a copy of the GNU General Public License
18along with GCC; see the file COPYING3. If not see
19<http://www.gnu.org/licenses/>. */
20
21#ifndef GCC_CP_NAME_LOOKUP_H
22#define GCC_CP_NAME_LOOKUP_H
23
24#include "c-common.h"
25
26/* The type of dictionary used to map names to types declared at
27 a given scope. */
28typedef struct binding_table_s *binding_table;
29typedef struct binding_entry_s *binding_entry;
30
31/* The type of a routine repeatedly called by binding_table_foreach. */
32typedef void (*bt_foreach_proc) (binding_entry, void *);
33
34struct binding_entry_s GTY(())
35{
36 binding_entry chain;
37 tree name;
38 tree type;
39};
40
41/* These macros indicate the initial chains count for binding_table. */
42#define SCOPE_DEFAULT_HT_SIZE (1 << 3)
43#define CLASS_SCOPE_HT_SIZE (1 << 3)
44#define NAMESPACE_ORDINARY_HT_SIZE (1 << 5)
45#define NAMESPACE_STD_HT_SIZE (1 << 8)
46#define GLOBAL_SCOPE_HT_SIZE (1 << 8)
47
48extern void binding_table_foreach (binding_table, bt_foreach_proc, void *);
49extern binding_entry binding_table_find (binding_table, tree);
50\f
51/* Datatype that represents binding established by a declaration between
52 a name and a C++ entity. */
53typedef struct cxx_binding cxx_binding;
54
55/* The datatype used to implement C++ scope. */
56typedef struct cp_binding_level cxx_scope;
57
58/* Nonzero if this binding is for a local scope, as opposed to a class
59 or namespace scope. */
60#define LOCAL_BINDING_P(NODE) ((NODE)->is_local)
61
62/* True if NODE->value is from a base class of the class which is
63 currently being defined. */
64#define INHERITED_VALUE_BINDING_P(NODE) ((NODE)->value_is_inherited)
65
66struct cxx_binding GTY(())
67{
68 /* Link to chain together various bindings for this name. */
69 cxx_binding *previous;
70 /* The non-type entity this name is bound to. */
71 tree value;
72 /* The type entity this name is bound to. */
73 tree type;
74 /* The scope at which this binding was made. */
75 cxx_scope *scope;
76 unsigned value_is_inherited : 1;
77 unsigned is_local : 1;
78};
79
80/* Datatype used to temporarily save C++ bindings (for implicit
81 instantiations purposes and like). Implemented in decl.c. */
82typedef struct cxx_saved_binding GTY(())
83{
84 /* The name of the current binding. */
85 tree identifier;
86 /* The binding we're saving. */
87 cxx_binding *binding;
88 tree real_type_value;
89} cxx_saved_binding;
90
91DEF_VEC_O(cxx_saved_binding);
92DEF_VEC_ALLOC_O(cxx_saved_binding,gc);
93
94extern tree identifier_type_value (tree);
95extern void set_identifier_type_value (tree, tree);
96extern void pop_binding (tree, tree);
97extern tree constructor_name (tree);
98extern bool constructor_name_p (tree, tree);
99\f
100/* The kinds of scopes we recognize. */
101typedef enum scope_kind {
102 sk_block = 0, /* An ordinary block scope. This enumerator must
103 have the value zero because "cp_binding_level"
104 is initialized by using "memset" to set the
105 contents to zero, and the default scope kind
106 is "sk_block". */
107 sk_cleanup, /* A scope for (pseudo-)scope for cleanup. It is
108 pseudo in that it is transparent to name lookup
109 activities. */
110 sk_try, /* A try-block. */
111 sk_catch, /* A catch-block. */
112 sk_for, /* The scope of the variable declared in a
113 for-init-statement. */
114 sk_function_parms, /* The scope containing function parameters. */
115 sk_class, /* The scope containing the members of a class. */
116 sk_scoped_enum, /* The scope containing the enumertors of a C++0x
117 scoped enumeration. */
118 sk_namespace, /* The scope containing the members of a
119 namespace, including the global scope. */
120 sk_template_parms, /* A scope for template parameters. */
121 sk_template_spec, /* Like sk_template_parms, but for an explicit
122 specialization. Since, by definition, an
123 explicit specialization is introduced by
124 "template <>", this scope is always empty. */
125 sk_omp /* An OpenMP structured block. */
126} scope_kind;
127
128/* The scope where the class/struct/union/enum tag applies. */
129typedef enum tag_scope {
130 ts_current = 0, /* Current scope only. This is for the
131 class-key identifier;
132 case mentioned in [basic.lookup.elab]/2,
133 or the class/enum definition
134 class-key identifier { ... }; */
135 ts_global = 1, /* All scopes. This is the 3.4.1
136 [basic.lookup.unqual] lookup mentioned
137 in [basic.lookup.elab]/2. */
138 ts_within_enclosing_non_class = 2 /* Search within enclosing non-class
139 only, for friend class lookup
140 according to [namespace.memdef]/3
141 and [class.friend]/9. */
142} tag_scope;
143
144typedef struct cp_class_binding GTY(())
145{
146 cxx_binding base;
147 /* The bound name. */
148 tree identifier;
149} cp_class_binding;
150
151DEF_VEC_O(cp_class_binding);
152DEF_VEC_ALLOC_O(cp_class_binding,gc);
153
154/* For each binding contour we allocate a binding_level structure
155 which records the names defined in that contour.
156 Contours include:
157 0) the global one
158 1) one for each function definition,
159 where internal declarations of the parameters appear.
160 2) one for each compound statement,
161 to record its declarations.
162
163 The current meaning of a name can be found by searching the levels
164 from the current one out to the global one.
165
166 Off to the side, may be the class_binding_level. This exists only
167 to catch class-local declarations. It is otherwise nonexistent.
168
169 Also there may be binding levels that catch cleanups that must be
170 run when exceptions occur. Thus, to see whether a name is bound in
171 the current scope, it is not enough to look in the
172 CURRENT_BINDING_LEVEL. You should use lookup_name_current_level
173 instead. */
174
175/* Note that the information in the `names' component of the global contour
176 is duplicated in the IDENTIFIER_GLOBAL_VALUEs of all identifiers. */
177
178struct cp_binding_level GTY(())
179 {
180 /* A chain of _DECL nodes for all variables, constants, functions,
181 and typedef types. These are in the reverse of the order
182 supplied. There may be OVERLOADs on this list, too, but they
183 are wrapped in TREE_LISTs; the TREE_VALUE is the OVERLOAD. */
184 tree names;
185
186 /* Count of elements in names chain. */
187 size_t names_size;
188
189 /* A chain of NAMESPACE_DECL nodes. */
190 tree namespaces;
191
192 /* An array of static functions and variables (for namespaces only) */
193 VEC(tree,gc) *static_decls;
194
195 /* A list of USING_DECL nodes. */
196 tree usings;
197
198 /* A list of used namespaces. PURPOSE is the namespace,
199 VALUE the common ancestor with this binding_level's namespace. */
200 tree using_directives;
201
202 /* For the binding level corresponding to a class, the entities
203 declared in the class or its base classes. */
204 VEC(cp_class_binding,gc) *class_shadowed;
205
206 /* Similar to class_shadowed, but for IDENTIFIER_TYPE_VALUE, and
207 is used for all binding levels. The TREE_PURPOSE is the name of
208 the entity, the TREE_TYPE is the associated type. In addition
209 the TREE_VALUE is the IDENTIFIER_TYPE_VALUE before we entered
210 the class. */
211 tree type_shadowed;
212
213 /* A TREE_LIST. Each TREE_VALUE is the LABEL_DECL for a local
214 label in this scope. The TREE_PURPOSE is the previous value of
215 the IDENTIFIER_LABEL VALUE. */
216 tree shadowed_labels;
217
218 /* For each level (except not the global one),
219 a chain of BLOCK nodes for all the levels
220 that were entered and exited one level down. */
221 tree blocks;
222
223 /* The entity (namespace, class, function) the scope of which this
224 binding contour corresponds to. Otherwise NULL. */
225 tree this_entity;
226
227 /* The binding level which this one is contained in (inherits from). */
228 struct cp_binding_level *level_chain;
229
230 /* List of VAR_DECLS saved from a previous for statement.
231 These would be dead in ISO-conforming code, but might
232 be referenced in ARM-era code. These are stored in a
233 TREE_LIST; the TREE_VALUE is the actual declaration. */
234 tree dead_vars_from_for;
235
236 /* STATEMENT_LIST for statements in this binding contour.
237 Only used at present for SK_CLEANUP temporary bindings. */
238 tree statement_list;
239
240 /* Binding depth at which this level began. */
241 int binding_depth;
242
243 /* The kind of scope that this object represents. However, a
244 SK_TEMPLATE_SPEC scope is represented with KIND set to
245 SK_TEMPLATE_PARMS and EXPLICIT_SPEC_P set to true. */
246 ENUM_BITFIELD (scope_kind) kind : 4;
247
248 /* True if this scope is an SK_TEMPLATE_SPEC scope. This field is
249 only valid if KIND == SK_TEMPLATE_PARMS. */
250 BOOL_BITFIELD explicit_spec_p : 1;
251
252 /* true means make a BLOCK for this level regardless of all else. */
253 unsigned keep : 1;
254
255 /* Nonzero if this level can safely have additional
256 cleanup-needing variables added to it. */
257 unsigned more_cleanups_ok : 1;
258 unsigned have_cleanups : 1;
259
260 /* 24 bits left to fill a 32-bit word. */
261 };
262
263/* The binding level currently in effect. */
264
265#define current_binding_level \
4b1e227d 266 (*(cfun && cp_function_chain && cp_function_chain->bindings \
c251ad9e
SS
267 ? &cp_function_chain->bindings \
268 : &scope_chain->bindings))
269
270/* The binding level of the current class, if any. */
271
272#define class_binding_level scope_chain->class_bindings
273
274/* The tree node representing the global scope. */
275extern GTY(()) tree global_namespace;
276extern GTY(()) tree global_scope_name;
277
278/* Indicates that there is a type value in some namespace, although
279 that is not necessarily in scope at the moment. */
280
281extern GTY(()) tree global_type_node;
282
283/* True if SCOPE designates the global scope binding contour. */
284#define global_scope_p(SCOPE) \
285 ((SCOPE) == NAMESPACE_LEVEL (global_namespace))
286
287extern cxx_scope *leave_scope (void);
288extern bool kept_level_p (void);
289extern int global_bindings_p (void);
290extern bool toplevel_bindings_p (void);
291extern bool namespace_bindings_p (void);
292extern bool template_parm_scope_p (void);
293extern scope_kind innermost_scope_kind (void);
294extern cxx_scope *begin_scope (scope_kind, tree);
295extern void print_binding_stack (void);
296extern void push_to_top_level (void);
297extern void pop_from_top_level (void);
298extern void pop_everything (void);
299extern void keep_next_level (bool);
300extern bool is_ancestor (tree, tree);
301extern tree push_scope (tree);
302extern void pop_scope (tree);
303extern tree push_inner_scope (tree);
304extern void pop_inner_scope (tree, tree);
305extern void push_binding_level (struct cp_binding_level *);
306\f
307extern void push_namespace (tree);
308extern void pop_namespace (void);
309extern void push_nested_namespace (tree);
310extern void pop_nested_namespace (tree);
311extern bool handle_namespace_attrs (tree, tree);
312extern void pushlevel_class (void);
313extern void poplevel_class (void);
314extern tree pushdecl_with_scope (tree, cxx_scope *, bool);
315extern tree lookup_name_prefer_type (tree, int);
316extern tree lookup_name_real (tree, int, int, bool, int, int);
317extern tree lookup_type_scope (tree, tag_scope);
318extern tree namespace_binding (tree, tree);
319extern void set_namespace_binding (tree, tree, tree);
320extern bool hidden_name_p (tree);
321extern tree remove_hidden_names (tree);
322extern tree lookup_qualified_name (tree, tree, bool, bool);
323extern tree lookup_name_nonclass (tree);
324extern tree lookup_name_innermost_nonclass_level (tree);
325extern tree lookup_function_nonclass (tree, tree, bool);
326extern void push_local_binding (tree, tree, int);
327extern bool pushdecl_class_level (tree);
328extern tree pushdecl_namespace_level (tree, bool);
329extern bool push_class_level_binding (tree, tree);
330extern tree getdecls (void);
331extern tree cp_namespace_decls (tree);
332extern void set_decl_namespace (tree, tree, bool);
333extern void push_decl_namespace (tree);
334extern void pop_decl_namespace (void);
335extern void do_namespace_alias (tree, tree);
336extern void do_toplevel_using_decl (tree, tree, tree);
337extern void do_local_using_decl (tree, tree, tree);
338extern tree do_class_using_decl (tree, tree);
339extern void do_using_directive (tree);
340extern tree lookup_arg_dependent (tree, tree, tree);
341extern bool is_associated_namespace (tree, tree);
342extern void parse_using_directive (tree, tree);
343extern tree innermost_non_namespace_value (tree);
344extern cxx_binding *outer_binding (tree, cxx_binding *, bool);
345extern void cp_emit_debug_info_for_using (tree, tree);
346
347/* Set *DECL to the (non-hidden) declaration for ID at global scope,
348 if present and return true; otherwise return false. */
349
350static inline bool
351get_global_value_if_present (tree id, tree *decl)
352{
353 tree global_value = namespace_binding (id, global_namespace);
354 if (global_value)
355 *decl = global_value;
356 return global_value != NULL;
357}
358
359/* True is the binding of IDENTIFIER at global scope names a type. */
360
361static inline bool
362is_typename_at_global_scope (tree id)
363{
364 tree global_value = namespace_binding (id, global_namespace);
365
366 return global_value && TREE_CODE (global_value) == TYPE_DECL;
367}
368
369#endif /* GCC_CP_NAME_LOOKUP_H */