]>
Commit | Line | Data |
---|---|---|
aed81407 | 1 | /* Declarations for C++ name lookup routines. |
cbe34bb5 | 2 | Copyright (C) 2003-2017 Free Software Foundation, Inc. |
aed81407 GDR |
3 | Contributed by Gabriel Dos Reis <gdr@integrable-solutions.net> |
4 | ||
ed3cf953 | 5 | This file is part of GCC. |
aed81407 | 6 | |
ed3cf953 | 7 | GCC is free software; you can redistribute it and/or modify |
aed81407 | 8 | it under the terms of the GNU General Public License as published by |
e77f031d | 9 | the Free Software Foundation; either version 3, or (at your option) |
aed81407 GDR |
10 | any later version. |
11 | ||
ed3cf953 | 12 | GCC is distributed in the hope that it will be useful, |
aed81407 GDR |
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. | |
16 | ||
17 | You should have received a copy of the GNU General Public License | |
e77f031d NC |
18 | along with GCC; see the file COPYING3. If not see |
19 | <http://www.gnu.org/licenses/>. */ | |
aed81407 GDR |
20 | |
21 | #ifndef GCC_CP_NAME_LOOKUP_H | |
22 | #define GCC_CP_NAME_LOOKUP_H | |
23 | ||
39dabefd | 24 | #include "c-family/c-common.h" |
aed81407 | 25 | |
5e0c54e5 GDR |
26 | /* The type of dictionary used to map names to types declared at |
27 | a given scope. */ | |
28 | typedef struct binding_table_s *binding_table; | |
29 | typedef struct binding_entry_s *binding_entry; | |
30 | ||
31 | /* The type of a routine repeatedly called by binding_table_foreach. */ | |
32 | typedef void (*bt_foreach_proc) (binding_entry, void *); | |
33 | ||
d1b38208 | 34 | struct GTY(()) binding_entry_s { |
5e0c54e5 GDR |
35 | binding_entry chain; |
36 | tree name; | |
37 | tree type; | |
38 | }; | |
39 | ||
40 | /* These macros indicate the initial chains count for binding_table. */ | |
0cbd7506 MS |
41 | #define SCOPE_DEFAULT_HT_SIZE (1 << 3) |
42 | #define CLASS_SCOPE_HT_SIZE (1 << 3) | |
43 | #define NAMESPACE_ORDINARY_HT_SIZE (1 << 5) | |
44 | #define NAMESPACE_STD_HT_SIZE (1 << 8) | |
45 | #define GLOBAL_SCOPE_HT_SIZE (1 << 8) | |
5e0c54e5 | 46 | |
5e0c54e5 GDR |
47 | extern void binding_table_foreach (binding_table, bt_foreach_proc, void *); |
48 | extern binding_entry binding_table_find (binding_table, tree); | |
5e0c54e5 | 49 | \f |
aed81407 GDR |
50 | /* Datatype that represents binding established by a declaration between |
51 | a name and a C++ entity. */ | |
52 | typedef struct cxx_binding cxx_binding; | |
53 | ||
ed3cf953 | 54 | /* The datatype used to implement C++ scope. */ |
2c140474 | 55 | typedef struct cp_binding_level cp_binding_level; |
ed3cf953 | 56 | |
aed81407 GDR |
57 | /* Nonzero if this binding is for a local scope, as opposed to a class |
58 | or namespace scope. */ | |
59 | #define LOCAL_BINDING_P(NODE) ((NODE)->is_local) | |
60 | ||
147135cc | 61 | /* True if NODE->value is from a base class of the class which is |
aed81407 GDR |
62 | currently being defined. */ |
63 | #define INHERITED_VALUE_BINDING_P(NODE) ((NODE)->value_is_inherited) | |
64 | ||
d1b38208 | 65 | struct GTY(()) cxx_binding { |
aed81407 GDR |
66 | /* Link to chain together various bindings for this name. */ |
67 | cxx_binding *previous; | |
68 | /* The non-type entity this name is bound to. */ | |
69 | tree value; | |
70 | /* The type entity this name is bound to. */ | |
71 | tree type; | |
ed3cf953 | 72 | /* The scope at which this binding was made. */ |
2c140474 | 73 | cp_binding_level *scope; |
aed81407 GDR |
74 | unsigned value_is_inherited : 1; |
75 | unsigned is_local : 1; | |
76 | }; | |
77 | ||
f44b0c8e MM |
78 | /* Datatype used to temporarily save C++ bindings (for implicit |
79 | instantiations purposes and like). Implemented in decl.c. */ | |
a79683d5 | 80 | struct GTY(()) cxx_saved_binding { |
f44b0c8e MM |
81 | /* The name of the current binding. */ |
82 | tree identifier; | |
83 | /* The binding we're saving. */ | |
84 | cxx_binding *binding; | |
f44b0c8e | 85 | tree real_type_value; |
a79683d5 | 86 | }; |
f44b0c8e | 87 | |
f44b0c8e | 88 | |
00e8de68 GDR |
89 | extern tree identifier_type_value (tree); |
90 | extern void set_identifier_type_value (tree, tree); | |
55fec44d | 91 | extern void push_binding (tree, tree, cp_binding_level*); |
9c82d7b6 | 92 | extern void pop_local_binding (tree, tree); |
9485d254 | 93 | extern void pop_bindings_and_leave_scope (void); |
5a167978 GDR |
94 | extern tree constructor_name (tree); |
95 | extern bool constructor_name_p (tree, tree); | |
aed81407 | 96 | \f |
1ec57cf0 | 97 | /* The kinds of scopes we recognize. */ |
a79683d5 | 98 | enum scope_kind { |
1ec57cf0 GDR |
99 | sk_block = 0, /* An ordinary block scope. This enumerator must |
100 | have the value zero because "cp_binding_level" | |
101 | is initialized by using "memset" to set the | |
102 | contents to zero, and the default scope kind | |
103 | is "sk_block". */ | |
0cbd7506 | 104 | sk_cleanup, /* A scope for (pseudo-)scope for cleanup. It is |
1799e5d5 | 105 | pseudo in that it is transparent to name lookup |
0cbd7506 | 106 | activities. */ |
1ec57cf0 | 107 | sk_try, /* A try-block. */ |
0cbd7506 MS |
108 | sk_catch, /* A catch-block. */ |
109 | sk_for, /* The scope of the variable declared in a | |
17a9e380 | 110 | init-statement. */ |
1eb2a14d JJ |
111 | sk_cond, /* The scope of the variable declared in the condition |
112 | of an if or switch statement. */ | |
1ec57cf0 | 113 | sk_function_parms, /* The scope containing function parameters. */ |
0cbd7506 | 114 | sk_class, /* The scope containing the members of a class. */ |
adf2edec DG |
115 | sk_scoped_enum, /* The scope containing the enumertors of a C++0x |
116 | scoped enumeration. */ | |
0cbd7506 | 117 | sk_namespace, /* The scope containing the members of a |
1ec57cf0 GDR |
118 | namespace, including the global scope. */ |
119 | sk_template_parms, /* A scope for template parameters. */ | |
1799e5d5 | 120 | sk_template_spec, /* Like sk_template_parms, but for an explicit |
1ec57cf0 GDR |
121 | specialization. Since, by definition, an |
122 | explicit specialization is introduced by | |
123 | "template <>", this scope is always empty. */ | |
b8fd7909 | 124 | sk_transaction, /* A synchronized or atomic statement. */ |
3db45ab5 | 125 | sk_omp /* An OpenMP structured block. */ |
a79683d5 | 126 | }; |
1ec57cf0 | 127 | |
29ef83de | 128 | /* The scope where the class/struct/union/enum tag applies. */ |
a79683d5 | 129 | enum tag_scope { |
29ef83de KL |
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. */ | |
c7335680 | 138 | ts_within_enclosing_non_class = 2, /* Search within enclosing non-class |
29ef83de KL |
139 | only, for friend class lookup |
140 | according to [namespace.memdef]/3 | |
141 | and [class.friend]/9. */ | |
c7335680 | 142 | ts_lambda = 3 /* Declaring a lambda closure. */ |
a79683d5 | 143 | }; |
29ef83de | 144 | |
a79683d5 | 145 | struct GTY(()) cp_class_binding { |
f256f612 | 146 | cxx_binding *base; |
89b578be MM |
147 | /* The bound name. */ |
148 | tree identifier; | |
a79683d5 | 149 | }; |
89b578be | 150 | |
89b578be | 151 | |
a79683d5 | 152 | struct GTY(()) cp_label_binding { |
4d2fb769 NF |
153 | /* The bound LABEL_DECL. */ |
154 | tree label; | |
155 | /* The previous IDENTIFIER_LABEL_VALUE. */ | |
156 | tree prev_value; | |
a79683d5 | 157 | }; |
4d2fb769 | 158 | |
4d2fb769 | 159 | |
1ec57cf0 GDR |
160 | /* For each binding contour we allocate a binding_level structure |
161 | which records the names defined in that contour. | |
162 | Contours include: | |
163 | 0) the global one | |
164 | 1) one for each function definition, | |
165 | where internal declarations of the parameters appear. | |
166 | 2) one for each compound statement, | |
167 | to record its declarations. | |
168 | ||
169 | The current meaning of a name can be found by searching the levels | |
170 | from the current one out to the global one. | |
171 | ||
172 | Off to the side, may be the class_binding_level. This exists only | |
173 | to catch class-local declarations. It is otherwise nonexistent. | |
174 | ||
175 | Also there may be binding levels that catch cleanups that must be | |
176 | run when exceptions occur. Thus, to see whether a name is bound in | |
177 | the current scope, it is not enough to look in the | |
178 | CURRENT_BINDING_LEVEL. You should use lookup_name_current_level | |
179 | instead. */ | |
180 | ||
181 | /* Note that the information in the `names' component of the global contour | |
182 | is duplicated in the IDENTIFIER_GLOBAL_VALUEs of all identifiers. */ | |
183 | ||
d1b38208 | 184 | struct GTY(()) cp_binding_level { |
2c140474 DN |
185 | /* A chain of _DECL nodes for all variables, constants, functions, |
186 | and typedef types. These are in the reverse of the order | |
187 | supplied. There may be OVERLOADs on this list, too, but they | |
188 | are wrapped in TREE_LISTs; the TREE_VALUE is the OVERLOAD. */ | |
189 | tree names; | |
190 | ||
191 | /* A chain of NAMESPACE_DECL nodes. */ | |
192 | tree namespaces; | |
193 | ||
2c140474 DN |
194 | /* A list of USING_DECL nodes. */ |
195 | tree usings; | |
196 | ||
197 | /* A list of used namespaces. PURPOSE is the namespace, | |
198 | VALUE the common ancestor with this binding_level's namespace. */ | |
199 | tree using_directives; | |
200 | ||
201 | /* For the binding level corresponding to a class, the entities | |
202 | declared in the class or its base classes. */ | |
9771b263 | 203 | vec<cp_class_binding, va_gc> *class_shadowed; |
2c140474 DN |
204 | |
205 | /* Similar to class_shadowed, but for IDENTIFIER_TYPE_VALUE, and | |
206 | is used for all binding levels. The TREE_PURPOSE is the name of | |
207 | the entity, the TREE_TYPE is the associated type. In addition | |
208 | the TREE_VALUE is the IDENTIFIER_TYPE_VALUE before we entered | |
209 | the class. */ | |
210 | tree type_shadowed; | |
211 | ||
212 | /* Similar to class_shadowed, but for IDENTIFIER_LABEL_VALUE, and | |
213 | used for all binding levels. */ | |
9771b263 | 214 | vec<cp_label_binding, va_gc> *shadowed_labels; |
2c140474 DN |
215 | |
216 | /* For each level (except not the global one), | |
217 | a chain of BLOCK nodes for all the levels | |
218 | that were entered and exited one level down. */ | |
219 | tree blocks; | |
220 | ||
221 | /* The entity (namespace, class, function) the scope of which this | |
222 | binding contour corresponds to. Otherwise NULL. */ | |
223 | tree this_entity; | |
224 | ||
225 | /* The binding level which this one is contained in (inherits from). */ | |
226 | cp_binding_level *level_chain; | |
227 | ||
228 | /* List of VAR_DECLS saved from a previous for statement. | |
229 | These would be dead in ISO-conforming code, but might | |
230 | be referenced in ARM-era code. */ | |
9771b263 | 231 | vec<tree, va_gc> *dead_vars_from_for; |
2c140474 DN |
232 | |
233 | /* STATEMENT_LIST for statements in this binding contour. | |
234 | Only used at present for SK_CLEANUP temporary bindings. */ | |
235 | tree statement_list; | |
236 | ||
237 | /* Binding depth at which this level began. */ | |
238 | int binding_depth; | |
239 | ||
240 | /* The kind of scope that this object represents. However, a | |
241 | SK_TEMPLATE_SPEC scope is represented with KIND set to | |
242 | SK_TEMPLATE_PARMS and EXPLICIT_SPEC_P set to true. */ | |
243 | ENUM_BITFIELD (scope_kind) kind : 4; | |
244 | ||
245 | /* True if this scope is an SK_TEMPLATE_SPEC scope. This field is | |
246 | only valid if KIND == SK_TEMPLATE_PARMS. */ | |
247 | BOOL_BITFIELD explicit_spec_p : 1; | |
248 | ||
249 | /* true means make a BLOCK for this level regardless of all else. */ | |
250 | unsigned keep : 1; | |
251 | ||
252 | /* Nonzero if this level can safely have additional | |
253 | cleanup-needing variables added to it. */ | |
254 | unsigned more_cleanups_ok : 1; | |
255 | unsigned have_cleanups : 1; | |
256 | ||
5294e4c3 AB |
257 | /* Transient state set if this scope is of sk_class kind |
258 | and is in the process of defining 'this_entity'. Reset | |
259 | on leaving the class definition to allow for the scope | |
260 | to be subsequently re-used as a non-defining scope for | |
261 | 'this_entity'. */ | |
262 | unsigned defining_class_p : 1; | |
263 | ||
264 | /* 23 bits left to fill a 32-bit word. */ | |
2c140474 | 265 | }; |
1ec57cf0 GDR |
266 | |
267 | /* The binding level currently in effect. */ | |
268 | ||
269 | #define current_binding_level \ | |
da7d88bf | 270 | (*(cfun && cp_function_chain && cp_function_chain->bindings \ |
1ec57cf0 GDR |
271 | ? &cp_function_chain->bindings \ |
272 | : &scope_chain->bindings)) | |
273 | ||
274 | /* The binding level of the current class, if any. */ | |
275 | ||
276 | #define class_binding_level scope_chain->class_bindings | |
277 | ||
5f52c0e0 GDR |
278 | /* True if SCOPE designates the global scope binding contour. */ |
279 | #define global_scope_p(SCOPE) \ | |
280 | ((SCOPE) == NAMESPACE_LEVEL (global_namespace)) | |
aed81407 | 281 | |
2c140474 | 282 | extern cp_binding_level *leave_scope (void); |
00e8de68 | 283 | extern bool kept_level_p (void); |
c99c0026 | 284 | extern bool global_bindings_p (void); |
056a17ee | 285 | extern bool toplevel_bindings_p (void); |
00e8de68 | 286 | extern bool namespace_bindings_p (void); |
fdf03377 | 287 | extern bool local_bindings_p (void); |
00e8de68 GDR |
288 | extern bool template_parm_scope_p (void); |
289 | extern scope_kind innermost_scope_kind (void); | |
2c140474 | 290 | extern cp_binding_level *begin_scope (scope_kind, tree); |
00e8de68 | 291 | extern void print_binding_stack (void); |
00e8de68 GDR |
292 | extern void pop_everything (void); |
293 | extern void keep_next_level (bool); | |
056a17ee | 294 | extern bool is_ancestor (tree ancestor, tree descendant); |
4514aa8c | 295 | extern tree push_scope (tree); |
5a167978 | 296 | extern void pop_scope (tree); |
87c465f5 KL |
297 | extern tree push_inner_scope (tree); |
298 | extern void pop_inner_scope (tree, tree); | |
2c140474 | 299 | extern void push_binding_level (cp_binding_level *); |
00e8de68 | 300 | \f |
65567efa | 301 | extern bool handle_namespace_attrs (tree, tree); |
00e8de68 GDR |
302 | extern void pushlevel_class (void); |
303 | extern void poplevel_class (void); | |
10e6657a | 304 | extern tree lookup_name_prefer_type (tree, int); |
12cf89fa | 305 | extern tree lookup_name_real (tree, int, int, bool, int, int); |
29ef83de | 306 | extern tree lookup_type_scope (tree, tag_scope); |
06aa5490 NS |
307 | extern tree get_namespace_binding (tree ns, tree id); |
308 | extern void set_global_binding (tree id, tree val); | |
bd3d082e | 309 | extern bool hidden_name_p (tree); |
d63d5d0c | 310 | extern tree remove_hidden_names (tree); |
1b22fc54 | 311 | extern tree lookup_qualified_name (tree, tree, int, bool, /*hidden*/bool = false); |
00e8de68 | 312 | extern tree lookup_name_nonclass (tree); |
7655e009 | 313 | extern tree lookup_name_innermost_nonclass_level (tree); |
e8f43da6 | 314 | extern bool is_local_extern (tree); |
9771b263 | 315 | extern tree lookup_function_nonclass (tree, vec<tree, va_gc> *, bool); |
58ec3cc5 | 316 | extern void push_local_binding (tree, tree, int); |
00e8de68 | 317 | extern bool pushdecl_class_level (tree); |
d63d5d0c | 318 | extern tree pushdecl_namespace_level (tree, bool); |
00e8de68 | 319 | extern bool push_class_level_binding (tree, tree); |
9c82d7b6 | 320 | extern tree get_local_decls (); |
67e18edb | 321 | extern int function_parm_depth (void); |
00e8de68 | 322 | extern tree cp_namespace_decls (tree); |
5a167978 | 323 | extern void set_decl_namespace (tree, tree, bool); |
5a167978 GDR |
324 | extern void push_decl_namespace (tree); |
325 | extern void pop_decl_namespace (void); | |
326 | extern void do_namespace_alias (tree, tree); | |
ed5f054f AO |
327 | extern void do_toplevel_using_decl (tree, tree, tree); |
328 | extern void do_local_using_decl (tree, tree, tree); | |
1d786913 | 329 | extern tree do_class_using_decl (tree, tree); |
5a167978 | 330 | extern void do_using_directive (tree); |
e87eed2a | 331 | extern cp_expr lookup_arg_dependent (tree, tree, vec<tree, va_gc> *); |
86098eb8 JM |
332 | extern bool is_associated_namespace (tree, tree); |
333 | extern void parse_using_directive (tree, tree); | |
90ea9897 MM |
334 | extern tree innermost_non_namespace_value (tree); |
335 | extern cxx_binding *outer_binding (tree, cxx_binding *, bool); | |
98ed9dae | 336 | extern void cp_emit_debug_info_for_using (tree, tree); |
c003e212 | 337 | |
056a17ee NS |
338 | extern tree pushdecl_maybe_friend (tree, bool is_friend); |
339 | extern tree pushdecl (tree); | |
340 | extern tree pushdecl_outermost_localscope (tree); | |
341 | extern tree pushdecl_top_level_maybe_friend (tree, bool is_friend); | |
342 | extern tree pushdecl_top_level (tree); | |
343 | extern tree pushdecl_top_level_with_init (tree, tree); | |
344 | extern tree pushtag (tree, tree, tag_scope); | |
345 | extern bool push_namespace (tree); | |
346 | extern void pop_namespace (void); | |
347 | extern void push_nested_namespace (tree); | |
348 | extern void pop_nested_namespace (tree); | |
349 | extern void push_to_top_level (void); | |
350 | extern void pop_from_top_level (void); | |
641da50a | 351 | |
aed81407 | 352 | #endif /* GCC_CP_NAME_LOOKUP_H */ |