gcc/cp/name-lookup.h

   1 /* Declarations for C++ name lookup routines.
   2    Copyright (C) 2003-2013 Free Software Foundation, Inc.
   3    Contributed by Gabriel Dos Reis <gdr@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 \f
  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
  54 /* The datatype used to implement C++ scope.  */
  55 typedef struct cp_binding_level cp_binding_level;
  56
  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
  61 /* True if NODE->value is from a base class of the class which is
  62    currently being defined.  */
  63 #define INHERITED_VALUE_BINDING_P(NODE) ((NODE)->value_is_inherited)
  64
  65 struct GTY(()) cxx_binding {
  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;
  72   /* The scope at which this binding was made.  */
  73   cp_binding_level *scope;
  74   unsigned value_is_inherited : 1;
  75   unsigned is_local : 1;
  76 };
  77
  78 /* Datatype used to temporarily save C++ bindings (for implicit
  79    instantiations purposes and like).  Implemented in decl.c.  */
  80 typedef struct GTY(()) cxx_saved_binding {
  81   /* The name of the current binding.  */
  82   tree identifier;
  83   /* The binding we're saving.  */
  84   cxx_binding *binding;
  85   tree real_type_value;
  86 } cxx_saved_binding;
  87
  88
  89 extern tree identifier_type_value (tree);
  90 extern void set_identifier_type_value (tree, tree);
  91 extern void pop_binding (tree, tree);
  92 extern tree constructor_name (tree);
  93 extern bool constructor_name_p (tree, tree);
  94 \f
  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
 101                         is "sk_block".  */
 102   sk_cleanup,        /* A scope for (pseudo-)scope for cleanup.  It is
 103                         pseudo in that it is transparent to name lookup
 104                         activities.  */
 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_cond,           /* The scope of the variable declared in the condition
 110                         of an if or switch statement.  */
 111   sk_function_parms, /* The scope containing function parameters.  */
 112   sk_class,          /* The scope containing the members of a class.  */
 113   sk_scoped_enum,    /* The scope containing the enumertors of a C++0x
 114                         scoped enumeration.  */
 115   sk_namespace,      /* The scope containing the members of a
 116                         namespace, including the global scope.  */
 117   sk_template_parms, /* A scope for template parameters.  */
 118   sk_template_spec,  /* Like sk_template_parms, but for an explicit
 119                         specialization.  Since, by definition, an
 120                         explicit specialization is introduced by
 121                         "template <>", this scope is always empty.  */
 122   sk_omp             /* An OpenMP structured block.  */
 123 } scope_kind;
 124
 125 /* The scope where the class/struct/union/enum tag applies.  */
 126 typedef enum tag_scope {
 127   ts_current = 0,       /* Current scope only.  This is for the
 128                              class-key identifier;
 129                            case mentioned in [basic.lookup.elab]/2,
 130                            or the class/enum definition
 131                              class-key identifier { ... };  */
 132   ts_global = 1,        /* All scopes.  This is the 3.4.1
 133                            [basic.lookup.unqual] lookup mentioned
 134                            in [basic.lookup.elab]/2.  */
 135   ts_within_enclosing_non_class = 2,    /* Search within enclosing non-class
 136                                            only, for friend class lookup
 137                                            according to [namespace.memdef]/3
 138                                            and [class.friend]/9.  */
 139   ts_lambda = 3                 /* Declaring a lambda closure.  */
 140 } tag_scope;
 141
 142 typedef struct GTY(()) cp_class_binding {
 143   cxx_binding *base;
 144   /* The bound name.  */
 145   tree identifier;
 146 } cp_class_binding;
 147
 148
 149 typedef struct GTY(()) cp_label_binding {
 150   /* The bound LABEL_DECL.  */
 151   tree label;
 152   /* The previous IDENTIFIER_LABEL_VALUE.  */
 153   tree prev_value;
 154 } cp_label_binding;
 155
 156
 157 /* For each binding contour we allocate a binding_level structure
 158    which records the names defined in that contour.
 159    Contours include:
 160     0) the global one
 161     1) one for each function definition,
 162        where internal declarations of the parameters appear.
 163     2) one for each compound statement,
 164        to record its declarations.
 165
 166    The current meaning of a name can be found by searching the levels
 167    from the current one out to the global one.
 168
 169    Off to the side, may be the class_binding_level.  This exists only
 170    to catch class-local declarations.  It is otherwise nonexistent.
 171
 172    Also there may be binding levels that catch cleanups that must be
 173    run when exceptions occur.  Thus, to see whether a name is bound in
 174    the current scope, it is not enough to look in the
 175    CURRENT_BINDING_LEVEL.  You should use lookup_name_current_level
 176    instead.  */
 177
 178 /* Note that the information in the `names' component of the global contour
 179    is duplicated in the IDENTIFIER_GLOBAL_VALUEs of all identifiers.  */
 180
 181 struct GTY(()) cp_binding_level {
 182   /* A chain of _DECL nodes for all variables, constants, functions,
 183       and typedef types.  These are in the reverse of the order
 184       supplied.  There may be OVERLOADs on this list, too, but they
 185       are wrapped in TREE_LISTs; the TREE_VALUE is the OVERLOAD.  */
 186   tree names;
 187
 188   /* A chain of NAMESPACE_DECL nodes.  */
 189   tree namespaces;
 190
 191   /* An array of static functions and variables (for namespaces only) */
 192   vec<tree, va_gc> *static_decls;
 193
 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.  */
 203   vec<cp_class_binding, va_gc> *class_shadowed;
 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.  */
 214   vec<cp_label_binding, va_gc> *shadowed_labels;
 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.  */
 231   vec<tree, va_gc> *dead_vars_from_for;
 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
 257   /* 24 bits left to fill a 32-bit word.  */
 258 };
 259
 260 /* The binding level currently in effect.  */
 261
 262 #define current_binding_level                   \
 263   (*(cfun && cp_function_chain && cp_function_chain->bindings \
 264    ? &cp_function_chain->bindings               \
 265    : &scope_chain->bindings))
 266
 267 /* The binding level of the current class, if any.  */
 268
 269 #define class_binding_level scope_chain->class_bindings
 270
 271 /* The tree node representing the global scope.  */
 272 extern GTY(()) tree global_namespace;
 273 extern GTY(()) tree global_scope_name;
 274
 275 /* Indicates that there is a type value in some namespace, although
 276    that is not necessarily in scope at the moment.  */
 277
 278 extern GTY(()) tree global_type_node;
 279
 280 /* True if SCOPE designates the global scope binding contour.  */
 281 #define global_scope_p(SCOPE) \
 282   ((SCOPE) == NAMESPACE_LEVEL (global_namespace))
 283
 284 extern cp_binding_level *leave_scope (void);
 285 extern bool kept_level_p (void);
 286 extern bool global_bindings_p (void);
 287 extern bool toplevel_bindings_p (void);
 288 extern bool namespace_bindings_p (void);
 289 extern bool local_bindings_p (void);
 290 extern bool template_parm_scope_p (void);
 291 extern scope_kind innermost_scope_kind (void);
 292 extern cp_binding_level *begin_scope (scope_kind, tree);
 293 extern void print_binding_stack (void);
 294 extern void push_to_top_level (void);
 295 extern void pop_from_top_level (void);
 296 extern void pop_everything (void);
 297 extern void keep_next_level (bool);
 298 extern bool is_ancestor (tree, tree);
 299 extern tree push_scope (tree);
 300 extern void pop_scope (tree);
 301 extern tree push_inner_scope (tree);
 302 extern void pop_inner_scope (tree, tree);
 303 extern void push_binding_level (cp_binding_level *);
 304 \f
 305 extern void push_namespace (tree);
 306 extern void pop_namespace (void);
 307 extern void push_nested_namespace (tree);
 308 extern void pop_nested_namespace (tree);
 309 extern bool handle_namespace_attrs (tree, tree);
 310 extern void pushlevel_class (void);
 311 extern void poplevel_class (void);
 312 extern tree pushdecl_with_scope (tree, cp_binding_level *, bool);
 313 extern tree lookup_name_prefer_type (tree, int);
 314 extern tree lookup_name_real (tree, int, int, bool, int, int);
 315 extern tree lookup_type_scope (tree, tag_scope);
 316 extern tree namespace_binding (tree, tree);
 317 extern void set_namespace_binding (tree, tree, tree);
 318 extern bool hidden_name_p (tree);
 319 extern tree remove_hidden_names (tree);
 320 extern tree lookup_qualified_name (tree, tree, bool, bool);
 321 extern tree lookup_name_nonclass (tree);
 322 extern tree lookup_name_innermost_nonclass_level (tree);
 323 extern bool is_local_extern (tree);
 324 extern tree lookup_function_nonclass (tree, vec<tree, va_gc> *, bool);
 325 extern void push_local_binding (tree, tree, int);
 326 extern bool pushdecl_class_level (tree);
 327 extern tree pushdecl_namespace_level (tree, bool);
 328 extern bool push_class_level_binding (tree, tree);
 329 extern tree getdecls (void);
 330 extern int function_parm_depth (void);
 331 extern tree cp_namespace_decls (tree);
 332 extern void set_decl_namespace (tree, tree, bool);
 333 extern void push_decl_namespace (tree);
 334 extern void pop_decl_namespace (void);
 335 extern void do_namespace_alias (tree, tree);
 336 extern void do_toplevel_using_decl (tree, tree, tree);
 337 extern void do_local_using_decl (tree, tree, tree);
 338 extern tree do_class_using_decl (tree, tree);
 339 extern void do_using_directive (tree);
 340 extern tree lookup_arg_dependent (tree, tree, vec<tree, va_gc> *, bool);
 341 extern bool is_associated_namespace (tree, tree);
 342 extern void parse_using_directive (tree, tree);
 343 extern tree innermost_non_namespace_value (tree);
 344 extern cxx_binding *outer_binding (tree, cxx_binding *, bool);
 345 extern 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
 350 static inline bool
 351 get_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
 361 static inline bool
 362 is_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 */