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 used to temporarily save C++ bindings (for implicit
  55    instantiations purposes and like).  Implemented in decl.c.  */
  56 typedef struct cxx_saved_binding cxx_saved_binding;
  57
  58 /* Datatype that represents binding established by a declaration between
  59    a name and a C++ entity.  */
  60 typedef struct cxx_binding cxx_binding;
  61
  62 /* The datatype used to implement C++ scope.  */
  63 typedef struct cp_binding_level cxx_scope;
  64
  65 /* Nonzero if this binding is for a local scope, as opposed to a class
  66    or namespace scope.  */
  67 #define LOCAL_BINDING_P(NODE) ((NODE)->is_local)
  68
  69 /* True if NODE->value is from a base class of the class which is
  70    currently being defined.  */
  71 #define INHERITED_VALUE_BINDING_P(NODE) ((NODE)->value_is_inherited)
  72
  73 struct cxx_binding GTY(())
  74 {
  75   /* Link to chain together various bindings for this name.  */
  76   cxx_binding *previous;
  77   /* The non-type entity this name is bound to.  */
  78   tree value;
  79   /* The type entity this name is bound to.  */
  80   tree type;
  81   /* The scope at which this binding was made.  */
  82   cxx_scope *scope;
  83   unsigned value_is_inherited : 1;
  84   unsigned is_local : 1;
  85 };
  86
  87 extern tree identifier_type_value (tree);
  88 extern void set_identifier_type_value (tree, tree);
  89 extern void pop_binding (tree, tree);
  90 extern void clear_identifier_class_values (void);
  91 extern tree constructor_name_full (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                         peusdo 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_function_parms, /* The scope containing function parameters.  */
 110   sk_class,          /* The scope containing the members of a class.  */
 111   sk_namespace,      /* The scope containing the members of a
 112                         namespace, including the global scope.  */
 113   sk_template_parms, /* A scope for template parameters.  */
 114   sk_template_spec   /* Like sk_template_parms, but for an explicit
 115                         specialization.  Since, by definition, an
 116                         explicit specialization is introduced by
 117                         "template <>", this scope is always empty.  */
 118 } scope_kind;
 119
 120 typedef struct cp_class_binding GTY(())
 121 {
 122   cxx_binding base;
 123   /* The bound name.  */
 124   tree identifier;
 125 } cp_class_binding;
 126
 127 DEF_VEC_O(cp_class_binding);
 128
 129 /* For each binding contour we allocate a binding_level structure
 130    which records the names defined in that contour.
 131    Contours include:
 132     0) the global one
 133     1) one for each function definition,
 134        where internal declarations of the parameters appear.
 135     2) one for each compound statement,
 136        to record its declarations.
 137
 138    The current meaning of a name can be found by searching the levels
 139    from the current one out to the global one.
 140
 141    Off to the side, may be the class_binding_level.  This exists only
 142    to catch class-local declarations.  It is otherwise nonexistent.
 143
 144    Also there may be binding levels that catch cleanups that must be
 145    run when exceptions occur.  Thus, to see whether a name is bound in
 146    the current scope, it is not enough to look in the
 147    CURRENT_BINDING_LEVEL.  You should use lookup_name_current_level
 148    instead.  */
 149
 150 /* Note that the information in the `names' component of the global contour
 151    is duplicated in the IDENTIFIER_GLOBAL_VALUEs of all identifiers.  */
 152
 153 struct cp_binding_level GTY(())
 154   {
 155     /* A chain of _DECL nodes for all variables, constants, functions,
 156        and typedef types.  These are in the reverse of the order
 157        supplied.  There may be OVERLOADs on this list, too, but they
 158        are wrapped in TREE_LISTs; the TREE_VALUE is the OVERLOAD.  */
 159     tree names;
 160
 161     /* Count of elements in names chain.  */
 162     size_t names_size;
 163
 164     /* A chain of NAMESPACE_DECL nodes.  */
 165     tree namespaces;
 166
 167     /* An array of static functions and variables (for namespaces only) */
 168     varray_type static_decls;
 169
 170     /* A chain of VTABLE_DECL nodes.  */
 171     tree vtables;
 172
 173     /* A dictionary for looking up user-defined-types.  */
 174     binding_table type_decls;
 175
 176     /* A list of USING_DECL nodes.  */
 177     tree usings;
 178
 179     /* A list of used namespaces. PURPOSE is the namespace,
 180        VALUE the common ancestor with this binding_level's namespace.  */
 181     tree using_directives;
 182
 183     /* For the binding level corresponding to a class, the entities
 184        declared in the class or its base classes.  */
 185     VEC(cp_class_binding) *class_shadowed;
 186
 187     /* Similar to class_shadowed, but for IDENTIFIER_TYPE_VALUE, and
 188        is used for all binding levels. The TREE_PURPOSE is the name of
 189        the entity, the TREE_TYPE is the associated type.  In addition
 190        the TREE_VALUE is the IDENTIFIER_TYPE_VALUE before we entered
 191        the class.  */
 192     tree type_shadowed;
 193
 194     /* A TREE_LIST.  Each TREE_VALUE is the LABEL_DECL for a local
 195        label in this scope.  The TREE_PURPOSE is the previous value of
 196        the IDENTIFIER_LABEL VALUE.  */
 197     tree shadowed_labels;
 198
 199     /* For each level (except not the global one),
 200        a chain of BLOCK nodes for all the levels
 201        that were entered and exited one level down.  */
 202     tree blocks;
 203
 204     /* The entity (namespace, class, function) the scope of which this
 205        binding contour corresponds to.  Otherwise NULL.  */
 206     tree this_entity;
 207
 208     /* The binding level which this one is contained in (inherits from).  */
 209     struct cp_binding_level *level_chain;
 210
 211     /* List of VAR_DECLS saved from a previous for statement.
 212        These would be dead in ISO-conforming code, but might
 213        be referenced in ARM-era code.  These are stored in a
 214        TREE_LIST; the TREE_VALUE is the actual declaration.  */
 215     tree dead_vars_from_for;
 216
 217     /* STATEMENT_LIST for statements in this binding contour.
 218        Only used at present for SK_CLEANUP temporary bindings.  */
 219     tree statement_list;
 220
 221     /* Binding depth at which this level began.  */
 222     int binding_depth;
 223
 224     /* The kind of scope that this object represents.  However, a
 225        SK_TEMPLATE_SPEC scope is represented with KIND set to
 226        SK_TEMPALTE_PARMS and EXPLICIT_SPEC_P set to true.  */
 227     ENUM_BITFIELD (scope_kind) kind : 4;
 228
 229     /* True if this scope is an SK_TEMPLATE_SPEC scope.  This field is
 230        only valid if KIND == SK_TEMPLATE_PARMS.  */
 231     BOOL_BITFIELD explicit_spec_p : 1;
 232
 233     /* true means make a BLOCK for this level regardless of all else.  */
 234     unsigned keep : 1;
 235
 236     /* Nonzero if this level can safely have additional
 237        cleanup-needing variables added to it.  */
 238     unsigned more_cleanups_ok : 1;
 239     unsigned have_cleanups : 1;
 240
 241     /* 22 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->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 /* The tree node representing the global scope.  */
 256 extern GTY(()) tree global_namespace;
 257 extern GTY(()) tree global_scope_name;
 258
 259 /* Indicates that there is a type value in some namespace, although
 260    that is not necessarily in scope at the moment.  */
 261
 262 extern GTY(()) tree global_type_node;
 263
 264 /* True if SCOPE designates the global scope binding contour.  */
 265 #define global_scope_p(SCOPE) \
 266   ((SCOPE) == NAMESPACE_LEVEL (global_namespace))
 267
 268 extern cxx_scope *leave_scope (void);
 269 extern bool kept_level_p (void);
 270 extern int global_bindings_p (void);
 271 extern bool toplevel_bindings_p (void);
 272 extern bool namespace_bindings_p (void);
 273 extern bool template_parm_scope_p (void);
 274 extern scope_kind innermost_scope_kind (void);
 275 extern cxx_scope *begin_scope (scope_kind, tree);
 276 extern void print_binding_stack (void);
 277 extern void print_binding_level (cxx_scope *);
 278 extern void push_to_top_level (void);
 279 extern void pop_from_top_level (void);
 280 extern void pop_everything (void);
 281 extern void keep_next_level (bool);
 282 extern bool is_ancestor (tree, tree);
 283 extern bool push_scope (tree);
 284 extern void pop_scope (tree);
 285 extern void push_binding_level (struct cp_binding_level *);
 286 \f
 287 extern void push_namespace (tree);
 288 extern void pop_namespace (void);
 289 extern void push_nested_namespace (tree);
 290 extern void pop_nested_namespace (tree);
 291 extern void pushlevel_class (void);
 292 extern void poplevel_class (void);
 293 extern tree pushdecl_with_scope (tree, cxx_scope *);
 294 extern tree lookup_tag (enum tree_code, tree, cxx_scope *, int);
 295 extern tree lookup_tag_reverse (tree, tree);
 296 extern tree lookup_name (tree, int);
 297 extern tree lookup_name_real (tree, int, int, int, int);
 298 extern tree namespace_binding (tree, tree);
 299 extern void set_namespace_binding (tree, tree, tree);
 300 extern tree lookup_namespace_name (tree, tree);
 301 extern tree lookup_qualified_name (tree, tree, bool, bool);
 302 extern tree lookup_name_nonclass (tree);
 303 extern tree lookup_function_nonclass (tree, tree);
 304 extern void push_local_binding (tree, tree, int);
 305 extern int push_class_binding (tree, tree);
 306 extern bool pushdecl_class_level (tree);
 307 extern tree pushdecl_namespace_level (tree);
 308 extern bool push_class_level_binding (tree, tree);
 309 extern void storetags (tree);
 310 extern tree getdecls (void);
 311 extern tree cp_namespace_decls (tree);
 312 extern void set_decl_namespace (tree, tree, bool);
 313 extern tree current_decl_namespace (void);
 314 extern void push_decl_namespace (tree);
 315 extern void pop_decl_namespace (void);
 316 extern void do_namespace_alias (tree, tree);
 317 extern void do_toplevel_using_decl (tree, tree, tree);
 318 extern void do_local_using_decl (tree, tree, tree);
 319 extern tree do_class_using_decl (tree);
 320 extern void do_using_directive (tree);
 321 extern tree lookup_arg_dependent (tree, tree, tree);
 322 extern bool is_associated_namespace (tree, tree);
 323 extern void parse_using_directive (tree, tree);
 324
 325
 326 /* Set *DECL to the (non-hidden) declaration for ID at global scope,
 327    if present and return true; otherwise return false.  */
 328
 329 static inline bool
 330 get_global_value_if_present (tree id, tree *decl)
 331 {
 332   tree global_value = namespace_binding (id, global_namespace);
 333   if (global_value)
 334     *decl = global_value;
 335   return global_value != NULL;
 336 }
 337
 338 /* True is the binding of IDENTIFIER at global scope names a type.  */
 339
 340 static inline bool
 341 is_typename_at_global_scope (tree id)
 342 {
 343   tree global_value = namespace_binding (id, global_namespace);
 344
 345   return global_value && TREE_CODE (global_value) == TYPE_DECL;
 346 }
 347
 348 #endif /* GCC_CP_NAME_LOOKUP_H */