gcc/cp/name-lookup.h

   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>
   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 2, 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 COPYING.  If not, write to
  19 the Free Software Foundation, 59 Temple Place - Suite 330,
  20 Boston, MA 02111-1307, USA.  */
  21
  22 #ifndef GCC_CP_NAME_LOOKUP_H
  23 #define GCC_CP_NAME_LOOKUP_H
  24
  25 #include "c-common.h"
  26
  27 /* The type of dictionary used to map names to types declared at
  28    a given scope.  */
  29 typedef struct binding_table_s *binding_table;
  30 typedef struct binding_entry_s *binding_entry;
  31
  32 /* The type of a routine repeatedly called by binding_table_foreach.  */
  33 typedef void (*bt_foreach_proc) (binding_entry, void *);
  34
  35 struct binding_entry_s GTY(())
  36 {
  37   binding_entry chain;
  38   tree name;
  39   tree type;
  40 };
  41
  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)
  48
  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);
  53 \f
  54 /* Datatype that represents binding established by a declaration between
  55    a name and a C++ entity.  */
  56 typedef struct cxx_binding cxx_binding;
  57
  58 /* The datatype used to implement C++ scope.  */
  59 typedef struct cp_binding_level cxx_scope;
  60
  61 /* Nonzero if this binding is for a local scope, as opposed to a class
  62    or namespace scope.  */
  63 #define LOCAL_BINDING_P(NODE) ((NODE)->is_local)
  64
  65 /* True if NODE->value is from a base class of the class which is
  66    currently being defined.  */
  67 #define INHERITED_VALUE_BINDING_P(NODE) ((NODE)->value_is_inherited)
  68
  69 struct cxx_binding GTY(())
  70 {
  71   /* Link to chain together various bindings for this name.  */
  72   cxx_binding *previous;
  73   /* The non-type entity this name is bound to.  */
  74   tree value;
  75   /* The type entity this name is bound to.  */
  76   tree type;
  77   /* The scope at which this binding was made.  */
  78   cxx_scope *scope;
  79   unsigned value_is_inherited : 1;
  80   unsigned is_local : 1;
  81 };
  82
  83 /* Datatype used to temporarily save C++ bindings (for implicit
  84    instantiations purposes and like).  Implemented in decl.c.  */
  85 typedef struct cxx_saved_binding GTY(())
  86 {
  87   /* The name of the current binding.  */
  88   tree identifier;
  89   /* The binding we're saving.  */
  90   cxx_binding *binding;
  91   tree real_type_value;
  92 } cxx_saved_binding;
  93
  94 DEF_VEC_GC_O(cxx_saved_binding);
  95
  96 extern tree identifier_type_value (tree);
  97 extern void set_identifier_type_value (tree, tree);
  98 extern void pop_binding (tree, tree);
  99 extern tree constructor_name_full (tree);
 100 extern tree constructor_name (tree);
 101 extern bool constructor_name_p (tree, tree);
 102 \f
 103 /* The kinds of scopes we recognize.  */
 104 typedef enum scope_kind {
 105   sk_block = 0,      /* An ordinary block scope.  This enumerator must
 106                         have the value zero because "cp_binding_level"
 107                         is initialized by using "memset" to set the
 108                         contents to zero, and the default scope kind
 109                         is "sk_block".  */
 110   sk_cleanup,        /* A scope for (pseudo-)scope for cleanup.  It is
 111                         peusdo in that it is transparent to name lookup
 112                         activities.  */
 113   sk_try,            /* A try-block.  */
 114   sk_catch,          /* A catch-block.  */
 115   sk_for,            /* The scope of the variable declared in a
 116                         for-init-statement.  */
 117   sk_function_parms, /* The scope containing function parameters.  */
 118   sk_class,          /* The scope containing the members of a class.  */
 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 } scope_kind;
 127
 128 /* The scope where the class/struct/union/enum tag applies.  */
 129 typedef enum tag_scope {
 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.  */
 138   ts_within_enclosing_non_class = 2     /* Search within enclosing non-class
 139                                            only, for friend class lookup
 140                                            according to [namespace.memdef]/3
 141                                            and [class.friend]/9.  */
 142 } tag_scope;
 143
 144 typedef struct cp_class_binding GTY(())
 145 {
 146   cxx_binding base;
 147   /* The bound name.  */
 148   tree identifier;
 149 } cp_class_binding;
 150
 151 DEF_VEC_GC_O(cp_class_binding);
 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 /* Note that the information in the `names' component of the global contour
 175    is duplicated in the IDENTIFIER_GLOBAL_VALUEs of all identifiers.  */
 176
 177 struct cp_binding_level GTY(())
 178   {
 179     /* A chain of _DECL nodes for all variables, constants, functions,
 180        and typedef types.  These are in the reverse of the order
 181        supplied.  There may be OVERLOADs on this list, too, but they
 182        are wrapped in TREE_LISTs; the TREE_VALUE is the OVERLOAD.  */
 183     tree names;
 184
 185     /* Count of elements in names chain.  */
 186     size_t names_size;
 187
 188     /* A chain of NAMESPACE_DECL nodes.  */
 189     tree namespaces;
 190
 191     /* An array of static functions and variables (for namespaces only) */
 192     varray_type static_decls;
 193
 194     /* A chain of VTABLE_DECL nodes.  */
 195     tree vtables;
 196
 197     /* A dictionary for looking up user-defined-types.  */
 198     binding_table type_decls;
 199
 200     /* A list of USING_DECL nodes.  */
 201     tree usings;
 202
 203     /* A list of used namespaces. PURPOSE is the namespace,
 204        VALUE the common ancestor with this binding_level's namespace.  */
 205     tree using_directives;
 206
 207     /* For the binding level corresponding to a class, the entities
 208        declared in the class or its base classes.  */
 209     VEC(cp_class_binding) *class_shadowed;
 210
 211     /* Similar to class_shadowed, but for IDENTIFIER_TYPE_VALUE, and
 212        is used for all binding levels. The TREE_PURPOSE is the name of
 213        the entity, the TREE_TYPE is the associated type.  In addition
 214        the TREE_VALUE is the IDENTIFIER_TYPE_VALUE before we entered
 215        the class.  */
 216     tree type_shadowed;
 217
 218     /* A TREE_LIST.  Each TREE_VALUE is the LABEL_DECL for a local
 219        label in this scope.  The TREE_PURPOSE is the previous value of
 220        the IDENTIFIER_LABEL VALUE.  */
 221     tree shadowed_labels;
 222
 223     /* For each level (except not the global one),
 224        a chain of BLOCK nodes for all the levels
 225        that were entered and exited one level down.  */
 226     tree blocks;
 227
 228     /* The entity (namespace, class, function) the scope of which this
 229        binding contour corresponds to.  Otherwise NULL.  */
 230     tree this_entity;
 231
 232     /* The binding level which this one is contained in (inherits from).  */
 233     struct cp_binding_level *level_chain;
 234
 235     /* List of VAR_DECLS saved from a previous for statement.
 236        These would be dead in ISO-conforming code, but might
 237        be referenced in ARM-era code.  These are stored in a
 238        TREE_LIST; the TREE_VALUE is the actual declaration.  */
 239     tree dead_vars_from_for;
 240
 241     /* STATEMENT_LIST for statements in this binding contour.
 242        Only used at present for SK_CLEANUP temporary bindings.  */
 243     tree statement_list;
 244
 245     /* Binding depth at which this level began.  */
 246     int binding_depth;
 247
 248     /* The kind of scope that this object represents.  However, a
 249        SK_TEMPLATE_SPEC scope is represented with KIND set to
 250        SK_TEMPLATE_PARMS and EXPLICIT_SPEC_P set to true.  */
 251     ENUM_BITFIELD (scope_kind) kind : 4;
 252
 253     /* True if this scope is an SK_TEMPLATE_SPEC scope.  This field is
 254        only valid if KIND == SK_TEMPLATE_PARMS.  */
 255     BOOL_BITFIELD explicit_spec_p : 1;
 256
 257     /* true means make a BLOCK for this level regardless of all else.  */
 258     unsigned keep : 1;
 259
 260     /* Nonzero if this level can safely have additional
 261        cleanup-needing variables added to it.  */
 262     unsigned more_cleanups_ok : 1;
 263     unsigned have_cleanups : 1;
 264
 265     /* 22 bits left to fill a 32-bit word.  */
 266   };
 267
 268 /* The binding level currently in effect.  */
 269
 270 #define current_binding_level                   \
 271   (*(cfun && cp_function_chain->bindings        \
 272    ? &cp_function_chain->bindings               \
 273    : &scope_chain->bindings))
 274
 275 /* The binding level of the current class, if any.  */
 276
 277 #define class_binding_level scope_chain->class_bindings
 278
 279 /* The tree node representing the global scope.  */
 280 extern GTY(()) tree global_namespace;
 281 extern GTY(()) tree global_scope_name;
 282
 283 /* Indicates that there is a type value in some namespace, although
 284    that is not necessarily in scope at the moment.  */
 285
 286 extern GTY(()) tree global_type_node;
 287
 288 /* True if SCOPE designates the global scope binding contour.  */
 289 #define global_scope_p(SCOPE) \
 290   ((SCOPE) == NAMESPACE_LEVEL (global_namespace))
 291
 292 extern cxx_scope *leave_scope (void);
 293 extern bool kept_level_p (void);
 294 extern int global_bindings_p (void);
 295 extern bool toplevel_bindings_p (void);
 296 extern bool namespace_bindings_p (void);
 297 extern bool template_parm_scope_p (void);
 298 extern scope_kind innermost_scope_kind (void);
 299 extern cxx_scope *begin_scope (scope_kind, tree);
 300 extern void print_binding_stack (void);
 301 extern void print_binding_level (cxx_scope *);
 302 extern void push_to_top_level (void);
 303 extern void pop_from_top_level (void);
 304 extern void pop_everything (void);
 305 extern void keep_next_level (bool);
 306 extern bool is_ancestor (tree, tree);
 307 extern bool push_scope (tree);
 308 extern void pop_scope (tree);
 309 extern tree push_inner_scope (tree);
 310 extern void pop_inner_scope (tree, tree);
 311 extern void push_binding_level (struct cp_binding_level *);
 312 \f
 313 extern void push_namespace (tree);
 314 extern void pop_namespace (void);
 315 extern void push_nested_namespace (tree);
 316 extern void pop_nested_namespace (tree);
 317 extern void pushlevel_class (void);
 318 extern void poplevel_class (void);
 319 extern tree pushdecl_with_scope (tree, cxx_scope *);
 320 extern tree lookup_tag (enum tree_code, tree, cxx_scope *, int);
 321 extern tree lookup_tag_reverse (tree, tree);
 322 extern tree lookup_name (tree, int);
 323 extern tree lookup_name_real (tree, int, int, bool, int, int);
 324 extern tree lookup_type_scope (tree, tag_scope);
 325 extern tree namespace_binding (tree, tree);
 326 extern void set_namespace_binding (tree, tree, tree);
 327 extern tree lookup_namespace_name (tree, tree);
 328 extern tree lookup_qualified_name (tree, tree, bool, bool);
 329 extern tree lookup_name_nonclass (tree);
 330 extern tree lookup_function_nonclass (tree, tree, bool);
 331 extern void push_local_binding (tree, tree, int);
 332 extern bool pushdecl_class_level (tree);
 333 extern tree pushdecl_namespace_level (tree);
 334 extern bool push_class_level_binding (tree, tree);
 335 extern void storetags (tree);
 336 extern tree getdecls (void);
 337 extern tree cp_namespace_decls (tree);
 338 extern void set_decl_namespace (tree, tree, bool);
 339 extern tree current_decl_namespace (void);
 340 extern void push_decl_namespace (tree);
 341 extern void pop_decl_namespace (void);
 342 extern void do_namespace_alias (tree, tree);
 343 extern void do_toplevel_using_decl (tree, tree, tree);
 344 extern void do_local_using_decl (tree, tree, tree);
 345 extern tree do_class_using_decl (tree);
 346 extern void do_using_directive (tree);
 347 extern tree lookup_arg_dependent (tree, tree, tree);
 348 extern bool is_associated_namespace (tree, tree);
 349 extern void parse_using_directive (tree, tree);
 350 extern tree innermost_non_namespace_value (tree);
 351 extern cxx_binding *outer_binding (tree, cxx_binding *, bool);
 352
 353 /* Set *DECL to the (non-hidden) declaration for ID at global scope,
 354    if present and return true; otherwise return false.  */
 355
 356 static inline bool
 357 get_global_value_if_present (tree id, tree *decl)
 358 {
 359   tree global_value = namespace_binding (id, global_namespace);
 360   if (global_value)
 361     *decl = global_value;
 362   return global_value != NULL;
 363 }
 364
 365 /* True is the binding of IDENTIFIER at global scope names a type.  */
 366
 367 static inline bool
 368 is_typename_at_global_scope (tree id)
 369 {
 370   tree global_value = namespace_binding (id, global_namespace);
 371
 372   return global_value && TREE_CODE (global_value) == TYPE_DECL;
 373 }
 374
 375 #endif /* GCC_CP_NAME_LOOKUP_H */