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