1 /* Declarations for C++ name lookup routines.
2 Copyright (C) 2003, 2004 Free Software Foundation, Inc.
3 Contributed by Gabriel Dos Reis <gdr@integrable-solutions.net>
5 This file is part of GCC.
7 GCC is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2, or (at your option)
12 GCC is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GCC; see the file COPYING. If not, write to
19 the Free Software Foundation, 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
22 #ifndef GCC_CP_NAME_LOOKUP_H
23 #define GCC_CP_NAME_LOOKUP_H
27 /* The type of dictionary used to map names to types declared at
29 typedef struct binding_table_s
*binding_table
;
30 typedef struct binding_entry_s
*binding_entry
;
32 /* The type of a routine repeatedly called by binding_table_foreach. */
33 typedef void (*bt_foreach_proc
) (binding_entry
, void *);
35 struct binding_entry_s
GTY(())
42 /* These macros indicate the initial chains count for binding_table. */
43 #define SCOPE_DEFAULT_HT_SIZE (1 << 3)
44 #define CLASS_SCOPE_HT_SIZE (1 << 3)
45 #define NAMESPACE_ORDINARY_HT_SIZE (1 << 5)
46 #define NAMESPACE_STD_HT_SIZE (1 << 8)
47 #define GLOBAL_SCOPE_HT_SIZE (1 << 8)
49 extern void binding_table_remove_anonymous_types (binding_table
);
50 extern void binding_table_foreach (binding_table
, bt_foreach_proc
, void *);
51 extern binding_entry
binding_table_find (binding_table
, tree
);
52 extern void cxx_remember_type_decls (binding_table
);
54 /* Datatype used to temporarily save C++ bindings (for implicit
55 instantiations purposes and like). Implemented in decl.c. */
56 typedef struct cxx_saved_binding cxx_saved_binding
;
58 /* Datatype that represents binding established by a declaration between
59 a name and a C++ entity. */
60 typedef struct cxx_binding cxx_binding
;
62 /* The datatype used to implement C++ scope. */
63 typedef struct cp_binding_level cxx_scope
;
65 /* Nonzero if this binding is for a local scope, as opposed to a class
66 or namespace scope. */
67 #define LOCAL_BINDING_P(NODE) ((NODE)->is_local)
69 /* True if NODE->value is from a base class of the class which is
70 currently being defined. */
71 #define INHERITED_VALUE_BINDING_P(NODE) ((NODE)->value_is_inherited)
73 struct cxx_binding
GTY(())
75 /* Link to chain together various bindings for this name. */
76 cxx_binding
*previous
;
77 /* The non-type entity this name is bound to. */
79 /* The type entity this name is bound to. */
81 /* The scope at which this binding was made. */
83 unsigned value_is_inherited
: 1;
84 unsigned is_local
: 1;
87 extern tree
identifier_type_value (tree
);
88 extern void set_identifier_type_value (tree
, tree
);
89 extern void pop_binding (tree
, tree
);
90 extern void clear_identifier_class_values (void);
91 extern tree
constructor_name_full (tree
);
92 extern tree
constructor_name (tree
);
93 extern bool constructor_name_p (tree
, tree
);
95 /* The kinds of scopes we recognize. */
96 typedef enum scope_kind
{
97 sk_block
= 0, /* An ordinary block scope. This enumerator must
98 have the value zero because "cp_binding_level"
99 is initialized by using "memset" to set the
100 contents to zero, and the default scope kind
102 sk_cleanup
, /* A scope for (pseudo-)scope for cleanup. It is
103 peusdo in that it is transparent to name lookup
105 sk_try
, /* A try-block. */
106 sk_catch
, /* A catch-block. */
107 sk_for
, /* The scope of the variable declared in a
108 for-init-statement. */
109 sk_function_parms
, /* The scope containing function parameters. */
110 sk_class
, /* The scope containing the members of a class. */
111 sk_namespace
, /* The scope containing the members of a
112 namespace, including the global scope. */
113 sk_template_parms
, /* A scope for template parameters. */
114 sk_template_spec
/* Like sk_template_parms, but for an explicit
115 specialization. Since, by definition, an
116 explicit specialization is introduced by
117 "template <>", this scope is always empty. */
120 /* For each binding contour we allocate a binding_level structure
121 which records the names defined in that contour.
124 1) one for each function definition,
125 where internal declarations of the parameters appear.
126 2) one for each compound statement,
127 to record its declarations.
129 The current meaning of a name can be found by searching the levels
130 from the current one out to the global one.
132 Off to the side, may be the class_binding_level. This exists only
133 to catch class-local declarations. It is otherwise nonexistent.
135 Also there may be binding levels that catch cleanups that must be
136 run when exceptions occur. Thus, to see whether a name is bound in
137 the current scope, it is not enough to look in the
138 CURRENT_BINDING_LEVEL. You should use lookup_name_current_level
141 /* Note that the information in the `names' component of the global contour
142 is duplicated in the IDENTIFIER_GLOBAL_VALUEs of all identifiers. */
144 struct cp_binding_level
GTY(())
146 /* A chain of _DECL nodes for all variables, constants, functions,
147 and typedef types. These are in the reverse of the order
148 supplied. There may be OVERLOADs on this list, too, but they
149 are wrapped in TREE_LISTs; the TREE_VALUE is the OVERLOAD. */
152 /* Count of elements in names chain. */
155 /* A chain of NAMESPACE_DECL nodes. */
158 /* An array of static functions and variables (for namespaces only) */
159 varray_type static_decls
;
161 /* A chain of VTABLE_DECL nodes. */
164 /* A dictionary for looking up user-defined-types. */
165 binding_table type_decls
;
167 /* A list of USING_DECL nodes. */
170 /* A list of used namespaces. PURPOSE is the namespace,
171 VALUE the common ancestor with this binding_level's namespace. */
172 tree using_directives
;
174 /* If this binding level is the binding level for a class, then
175 class_shadowed is a TREE_LIST. The TREE_PURPOSE of each node
176 is the name of an entity bound in the class. The TREE_TYPE is
177 the DECL bound by this name in the class. */
180 /* Similar to class_shadowed, but for IDENTIFIER_TYPE_VALUE, and
181 is used for all binding levels. In addition the TREE_VALUE is the
182 IDENTIFIER_TYPE_VALUE before we entered the class. */
185 /* A TREE_LIST. Each TREE_VALUE is the LABEL_DECL for a local
186 label in this scope. The TREE_PURPOSE is the previous value of
187 the IDENTIFIER_LABEL VALUE. */
188 tree shadowed_labels
;
190 /* For each level (except not the global one),
191 a chain of BLOCK nodes for all the levels
192 that were entered and exited one level down. */
195 /* The entity (namespace, class, function) the scope of which this
196 binding contour corresponds to. Otherwise NULL. */
199 /* The binding level which this one is contained in (inherits from). */
200 struct cp_binding_level
*level_chain
;
202 /* List of VAR_DECLS saved from a previous for statement.
203 These would be dead in ISO-conforming code, but might
204 be referenced in ARM-era code. These are stored in a
205 TREE_LIST; the TREE_VALUE is the actual declaration. */
206 tree dead_vars_from_for
;
208 /* Binding depth at which this level began. */
211 /* The kind of scope that this object represents. However, a
212 SK_TEMPLATE_SPEC scope is represented with KIND set to
213 SK_TEMPALTE_PARMS and EXPLICIT_SPEC_P set to true. */
214 ENUM_BITFIELD (scope_kind
) kind
: 4;
216 /* True if this scope is an SK_TEMPLATE_SPEC scope. This field is
217 only valid if KIND == SK_TEMPLATE_PARMS. */
218 bool explicit_spec_p
: 1;
220 /* true means make a BLOCK for this level regardless of all else. */
223 /* Nonzero if this level can safely have additional
224 cleanup-needing variables added to it. */
225 unsigned more_cleanups_ok
: 1;
226 unsigned have_cleanups
: 1;
228 /* 22 bits left to fill a 32-bit word. */
231 /* The binding level currently in effect. */
233 #define current_binding_level \
234 (*(cfun && cp_function_chain->bindings \
235 ? &cp_function_chain->bindings \
236 : &scope_chain->bindings))
238 /* The binding level of the current class, if any. */
240 #define class_binding_level scope_chain->class_bindings
242 /* The tree node representing the global scope. */
243 extern GTY(()) tree global_namespace
;
244 extern GTY(()) tree global_scope_name
;
246 /* Indicates that there is a type value in some namespace, although
247 that is not necessarily in scope at the moment. */
249 extern GTY(()) tree global_type_node
;
251 /* True if SCOPE designates the global scope binding contour. */
252 #define global_scope_p(SCOPE) \
253 ((SCOPE) == NAMESPACE_LEVEL (global_namespace))
255 extern cxx_scope
*leave_scope (void);
256 extern bool kept_level_p (void);
257 extern int global_bindings_p (void);
258 extern bool toplevel_bindings_p (void);
259 extern bool namespace_bindings_p (void);
260 extern bool template_parm_scope_p (void);
261 extern scope_kind
innermost_scope_kind (void);
262 extern cxx_scope
*begin_scope (scope_kind
, tree
);
263 extern void print_binding_stack (void);
264 extern void print_binding_level (cxx_scope
*);
265 extern void push_to_top_level (void);
266 extern void pop_from_top_level (void);
267 extern void pop_everything (void);
268 extern void keep_next_level (bool);
269 extern bool is_ancestor (tree
, tree
);
270 extern void push_scope (tree
);
271 extern void pop_scope (tree
);
273 extern void push_namespace (tree
);
274 extern void pop_namespace (void);
275 extern void push_nested_namespace (tree
);
276 extern void pop_nested_namespace (tree
);
277 extern void pushlevel_class (void);
278 extern void poplevel_class (void);
279 extern tree
pushdecl_with_scope (tree
, cxx_scope
*);
280 extern tree
lookup_tag (enum tree_code
, tree
, cxx_scope
*, int);
281 extern tree
lookup_tag_reverse (tree
, tree
);
282 extern tree
lookup_name (tree
, int);
283 extern tree
lookup_name_real (tree
, int, int, int, int);
284 extern tree
namespace_binding (tree
, tree
);
285 extern void set_namespace_binding (tree
, tree
, tree
);
286 extern tree
lookup_namespace_name (tree
, tree
);
287 extern tree
lookup_qualified_name (tree
, tree
, bool, bool);
288 extern tree
lookup_name_nonclass (tree
);
289 extern tree
lookup_function_nonclass (tree
, tree
);
290 extern int push_class_binding (tree
, tree
);
291 extern bool pushdecl_class_level (tree
);
292 extern tree
pushdecl_namespace_level (tree
);
293 extern bool push_class_level_binding (tree
, tree
);
294 extern void storetags (tree
);
295 extern tree
getdecls (void);
296 extern tree
cp_namespace_decls (tree
);
297 extern void set_class_shadows (tree
);
298 extern void set_decl_namespace (tree
, tree
, bool);
299 extern tree
current_decl_namespace (void);
300 extern void push_decl_namespace (tree
);
301 extern void pop_decl_namespace (void);
302 extern void do_namespace_alias (tree
, tree
);
303 extern void do_toplevel_using_decl (tree
, tree
, tree
);
304 extern void do_local_using_decl (tree
, tree
, tree
);
305 extern tree
do_class_using_decl (tree
);
306 extern void do_using_directive (tree
);
307 extern tree
lookup_arg_dependent (tree
, tree
, tree
);
308 extern bool is_associated_namespace (tree
, tree
);
309 extern void parse_using_directive (tree
, tree
);
312 /* Set *DECL to the (non-hidden) declaration for ID at global scope,
313 if present and return true; otherwise return false. */
316 get_global_value_if_present (tree id
, tree
*decl
)
318 tree global_value
= namespace_binding (id
, global_namespace
);
321 *decl
= global_value
;
322 return global_value
!= NULL
;
325 /* True is the binding of IDENTIFIER at global scope names a type. */
328 is_typename_at_global_scope (tree id
)
330 tree global_value
= namespace_binding (id
, global_namespace
);
332 return global_value
&& TREE_CODE (global_value
) == TYPE_DECL
;
335 #endif /* GCC_CP_NAME_LOOKUP_H */