name-lookup.h revision 1.10
1 /* Declarations for C++ name lookup routines. 2 Copyright (C) 2003-2019 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_local_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 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 enumerators of a C++11 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 /* For each binding contour we allocate a binding_level structure 154 which records the names defined in that contour. 155 Contours include: 156 0) the global one 157 1) one for each function definition, 158 where internal declarations of the parameters appear. 159 2) one for each compound statement, 160 to record its declarations. 161 162 The current meaning of a name can be found by searching the levels 163 from the current one out to the global one. 164 165 Off to the side, may be the class_binding_level. This exists only 166 to catch class-local declarations. It is otherwise nonexistent. 167 168 Also there may be binding levels that catch cleanups that must be 169 run when exceptions occur. Thus, to see whether a name is bound in 170 the current scope, it is not enough to look in the 171 CURRENT_BINDING_LEVEL. You should use lookup_name_current_level 172 instead. */ 173 174 struct GTY(()) cp_binding_level { 175 /* A chain of _DECL nodes for all variables, constants, functions, 176 and typedef types. These are in the reverse of the order 177 supplied. There may be OVERLOADs on this list, too, but they 178 are wrapped in TREE_LISTs; the TREE_VALUE is the OVERLOAD. */ 179 tree names; 180 181 /* A list of USING_DECL nodes. */ 182 tree usings; 183 184 /* Using directives. */ 185 vec<tree, va_gc> *using_directives; 186 187 /* For the binding level corresponding to a class, the entities 188 declared in the class or its base classes. */ 189 vec<cp_class_binding, va_gc> *class_shadowed; 190 191 /* Similar to class_shadowed, but for IDENTIFIER_TYPE_VALUE, and 192 is used for all binding levels. The TREE_PURPOSE is the name of 193 the entity, the TREE_TYPE is the associated type. In addition 194 the TREE_VALUE is the IDENTIFIER_TYPE_VALUE before we entered 195 the class. */ 196 tree type_shadowed; 197 198 /* For each level (except not the global one), 199 a chain of BLOCK nodes for all the levels 200 that were entered and exited one level down. */ 201 tree blocks; 202 203 /* The entity (namespace, class, function) the scope of which this 204 binding contour corresponds to. Otherwise NULL. */ 205 tree this_entity; 206 207 /* The binding level which this one is contained in (inherits from). */ 208 cp_binding_level *level_chain; 209 210 /* STATEMENT_LIST for statements in this binding contour. 211 Only used at present for SK_CLEANUP temporary bindings. */ 212 tree statement_list; 213 214 /* Binding depth at which this level began. */ 215 int binding_depth; 216 217 /* The kind of scope that this object represents. However, a 218 SK_TEMPLATE_SPEC scope is represented with KIND set to 219 SK_TEMPLATE_PARMS and EXPLICIT_SPEC_P set to true. */ 220 ENUM_BITFIELD (scope_kind) kind : 4; 221 222 /* True if this scope is an SK_TEMPLATE_SPEC scope. This field is 223 only valid if KIND == SK_TEMPLATE_PARMS. */ 224 BOOL_BITFIELD explicit_spec_p : 1; 225 226 /* true means make a BLOCK for this level regardless of all else. */ 227 unsigned keep : 1; 228 229 /* Nonzero if this level can safely have additional 230 cleanup-needing variables added to it. */ 231 unsigned more_cleanups_ok : 1; 232 unsigned have_cleanups : 1; 233 234 /* Transient state set if this scope is of sk_class kind 235 and is in the process of defining 'this_entity'. Reset 236 on leaving the class definition to allow for the scope 237 to be subsequently re-used as a non-defining scope for 238 'this_entity'. */ 239 unsigned defining_class_p : 1; 240 241 /* 23 bits left to fill a 32-bit word. */ 242 }; 243 244 /* The binding level currently in effect. */ 245 246 #define current_binding_level \ 247 (*(cfun && cp_function_chain && cp_function_chain->bindings \ 248 ? &cp_function_chain->bindings \ 249 : &scope_chain->bindings)) 250 251 /* The binding level of the current class, if any. */ 252 253 #define class_binding_level scope_chain->class_bindings 254 255 /* True if SCOPE designates the global scope binding contour. */ 256 #define global_scope_p(SCOPE) \ 257 ((SCOPE) == NAMESPACE_LEVEL (global_namespace)) 258 259 extern cp_binding_level *leave_scope (void); 260 extern bool kept_level_p (void); 261 extern bool global_bindings_p (void); 262 extern bool toplevel_bindings_p (void); 263 extern bool namespace_bindings_p (void); 264 extern bool local_bindings_p (void); 265 extern bool template_parm_scope_p (void); 266 extern scope_kind innermost_scope_kind (void); 267 extern cp_binding_level *begin_scope (scope_kind, tree); 268 extern void print_binding_stack (void); 269 extern void pop_everything (void); 270 extern void keep_next_level (bool); 271 extern bool is_ancestor (tree ancestor, tree descendant); 272 extern bool is_nested_namespace (tree parent, tree descendant, 273 bool inline_only = false); 274 extern tree push_scope (tree); 275 extern void pop_scope (tree); 276 extern tree push_inner_scope (tree); 277 extern void pop_inner_scope (tree, tree); 278 extern void push_binding_level (cp_binding_level *); 279 280 extern bool handle_namespace_attrs (tree, tree); 282 extern void pushlevel_class (void); 283 extern void poplevel_class (void); 284 extern tree lookup_name_prefer_type (tree, int); 285 extern tree lookup_name_real (tree, int, int, bool, int, int); 286 extern tree lookup_type_scope (tree, tag_scope); 287 extern tree get_namespace_binding (tree ns, tree id); 288 extern void set_global_binding (tree decl); 289 inline tree get_global_binding (tree id) 290 { 291 return get_namespace_binding (NULL_TREE, id); 292 } 293 extern tree lookup_qualified_name (tree, tree, int, bool, /*hidden*/bool = false); 294 extern tree lookup_name_nonclass (tree); 295 extern bool is_local_extern (tree); 296 extern bool pushdecl_class_level (tree); 297 extern tree pushdecl_namespace_level (tree, bool); 298 extern bool push_class_level_binding (tree, tree); 299 extern tree get_local_decls (); 300 extern int function_parm_depth (void); 301 extern tree cp_namespace_decls (tree); 302 extern void set_decl_namespace (tree, tree, bool); 303 extern void push_decl_namespace (tree); 304 extern void pop_decl_namespace (void); 305 extern void do_namespace_alias (tree, tree); 306 extern tree do_class_using_decl (tree, tree); 307 extern tree lookup_arg_dependent (tree, tree, vec<tree, va_gc> *); 308 extern tree search_anon_aggr (tree, tree, bool = false); 309 extern tree get_class_binding_direct (tree, tree, int type_or_fns = -1); 310 extern tree get_class_binding (tree, tree, int type_or_fns = -1); 311 extern tree *find_member_slot (tree klass, tree name); 312 extern tree *add_member_slot (tree klass, tree name); 313 extern void resort_type_member_vec (void *, void *, 314 gt_pointer_operator, void *); 315 extern void set_class_bindings (tree, unsigned extra = 0); 316 extern void insert_late_enum_def_bindings (tree, tree); 317 extern tree innermost_non_namespace_value (tree); 318 extern cxx_binding *outer_binding (tree, cxx_binding *, bool); 319 extern void cp_emit_debug_info_for_using (tree, tree); 320 321 extern void finish_namespace_using_decl (tree, tree, tree); 322 extern void finish_local_using_decl (tree, tree, tree); 323 extern void finish_namespace_using_directive (tree, tree); 324 extern void finish_local_using_directive (tree, tree); 325 extern tree pushdecl (tree, bool is_friend = false); 326 extern tree pushdecl_outermost_localscope (tree); 327 extern tree pushdecl_top_level (tree, bool is_friend = false); 328 extern tree pushdecl_top_level_and_finish (tree, tree); 329 extern tree pushtag (tree, tree, tag_scope); 330 extern int push_namespace (tree, bool make_inline = false); 331 extern void pop_namespace (void); 332 extern void push_nested_namespace (tree); 333 extern void pop_nested_namespace (tree); 334 extern void push_to_top_level (void); 335 extern void pop_from_top_level (void); 336 extern void maybe_save_operator_binding (tree); 337 extern void push_operator_bindings (void); 338 extern void discard_operator_bindings (tree); 339 340 #endif /* GCC_CP_NAME_LOOKUP_H */ 341
Indexes created Thu Apr 30 00:23:01 UTC 2026