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