gdb/cp-support.h

   1 /* Helper routines for C++ support in GDB.
   2    Copyright (C) 2002, 2003, 2004, 2005, 2007, 2008, 2009, 2010, 2011
   3    Free Software Foundation, Inc.
   4
   5    Contributed by MontaVista Software.
   6    Namespace support contributed by David Carlton.
   7
   8    This file is part of GDB.
   9
  10    This program is free software; you can redistribute it and/or modify
  11    it under the terms of the GNU General Public License as published by
  12    the Free Software Foundation; either version 3 of the License, or
  13    (at your option) any later version.
  14
  15    This program is distributed in the hope that it will be useful,
  16    but WITHOUT ANY WARRANTY; without even the implied warranty of
  17    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18    GNU General Public License for more details.
  19
  20    You should have received a copy of the GNU General Public License
  21    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  22
  23 #ifndef CP_SUPPORT_H
  24 #define CP_SUPPORT_H
  25
  26 /* We need this for 'domain_enum', alas...  */
  27
  28 #include "symtab.h"
  29
  30 #include "vec.h"
  31
  32 /* Opaque declarations.  */
  33
  34 struct symbol;
  35 struct obstack;
  36 struct block;
  37 struct objfile;
  38 struct type;
  39 struct demangle_component;
  40
  41 /* A string representing the name of the anonymous namespace used in GDB.  */
  42
  43 #define CP_ANONYMOUS_NAMESPACE_STR "(anonymous namespace)"
  44
  45 /* The length of the string representing the anonymous namespace.  */
  46
  47 #define CP_ANONYMOUS_NAMESPACE_LEN 21
  48
  49 /* This struct is designed to store data from using directives.  It
  50    says that names from namespace IMPORT_SRC should be visible within
  51    namespace IMPORT_DEST.  These form a linked list; NEXT is the next
  52    element of the list.  If the imported namespace or declaration has
  53    been aliased within the IMPORT_DEST namespace, ALIAS is set to a
  54    string representing the alias.  Otherwise, ALIAS is NULL.
  55    DECLARATION is the name of the imported declaration, if this import
  56    statement represents one.  Otherwise DECLARATION is NULL and this
  57    import statement represents a namespace.
  58
  59    C++:      using namespace A;
  60    Fortran:  use A
  61    import_src = "A"
  62    import_dest = local scope of the import statement even such as ""
  63    alias = NULL
  64    declaration = NULL
  65    excludes = NULL
  66
  67    C++:      using A::x;
  68    Fortran:  use A, only: x
  69    import_src = "A"
  70    import_dest = local scope of the import statement even such as ""
  71    alias = NULL
  72    declaration = "x"
  73    excludes = NULL
  74    The declaration will get imported as import_dest::x.
  75
  76    C++ has no way to import all names except those listed ones.
  77    Fortran:  use A, localname => x
  78    import_src = "A"
  79    import_dest = local scope of the import statement even such as ""
  80    alias = "localname"
  81    declaration = "x"
  82    excludes = NULL
  83    +
  84    import_src = "A"
  85    import_dest = local scope of the import statement even such as ""
  86    alias = NULL
  87    declaration = NULL
  88    excludes = ["x"]
  89    All the entries of A get imported except of "x".  "x" gets imported as
  90    "localname".  "x" is not defined as a local name by this statement.
  91
  92    C++:      namespace LOCALNS = A;
  93    Fortran has no way to address non-local namespace/module.
  94    import_src = "A"
  95    import_dest = local scope of the import statement even such as ""
  96    alias = "LOCALNS"
  97    declaration = NULL
  98    excludes = NULL
  99    The namespace will get imported as the import_dest::LOCALNS
 100    namespace.
 101
 102    C++ cannot express it, it would be something like: using localname
 103    = A::x;
 104    Fortran:  use A, only localname => x
 105    import_src = "A"
 106    import_dest = local scope of the import statement even such as ""
 107    alias = "localname"
 108    declaration = "x"
 109    excludes = NULL
 110    The declaration will get imported as localname or
 111    `import_dest`localname.  */
 112
 113 struct using_direct
 114 {
 115   char *import_src;
 116   char *import_dest;
 117
 118   char *alias;
 119   char *declaration;
 120
 121   struct using_direct *next;
 122
 123   /* Used during import search to temporarily mark this node as
 124      searched.  */
 125   int searched;
 126
 127   /* USING_DIRECT has variable allocation size according to the number of
 128      EXCLUDES entries, the last entry is NULL.  */
 129   const char *excludes[1];
 130 };
 131
 132
 133 /* Functions from cp-support.c.  */
 134
 135 extern char *cp_canonicalize_string (const char *string);
 136
 137 extern char *cp_class_name_from_physname (const char *physname);
 138
 139 extern char *method_name_from_physname (const char *physname);
 140
 141 extern unsigned int cp_find_first_component (const char *name);
 142
 143 extern unsigned int cp_entire_prefix_len (const char *name);
 144
 145 extern char *cp_func_name (const char *full_name);
 146
 147 extern char *cp_remove_params (const char *demangled_name);
 148
 149 extern struct symbol **make_symbol_overload_list (const char *,
 150                                                   const char *);
 151
 152 extern struct symbol **make_symbol_overload_list_adl (struct type **arg_types,
 153                                                       int nargs,
 154                                                       const char *func_name);
 155
 156 extern struct type *cp_lookup_rtti_type (const char *name,
 157                                          struct block *block);
 158
 159 extern int cp_validate_operator (const char *input);
 160
 161 /* Functions/variables from cp-namespace.c.  */
 162
 163 extern int cp_is_anonymous (const char *namespace);
 164
 165 DEF_VEC_P (const_char_ptr);
 166
 167 extern void cp_add_using_directive (const char *dest,
 168                                     const char *src,
 169                                     const char *alias,
 170                                     const char *declaration,
 171                                     VEC (const_char_ptr) *excludes,
 172                                     struct obstack *obstack);
 173
 174 extern void cp_initialize_namespace (void);
 175
 176 extern void cp_finalize_namespace (struct block *static_block,
 177                                    struct obstack *obstack);
 178
 179 extern void cp_set_block_scope (const struct symbol *symbol,
 180                                 struct block *block,
 181                                 struct obstack *obstack,
 182                                 const char *processing_current_prefix,
 183                                 int processing_has_namespace_info);
 184
 185 extern void cp_scan_for_anonymous_namespaces (const struct symbol *symbol);
 186
 187 extern struct symbol *cp_lookup_symbol_nonlocal (const char *name,
 188                                                  const struct block *block,
 189                                                  const domain_enum domain);
 190
 191 extern struct symbol *cp_lookup_symbol_namespace (const char *namespace,
 192                                                   const char *name,
 193                                                   const struct block *block,
 194                                                   const domain_enum domain);
 195
 196 extern struct symbol *cp_lookup_symbol_imports (const char *scope,
 197                                                 const char *name,
 198                                                 const struct block *block,
 199                                                 const domain_enum domain,
 200                                                 const int declaration_only,
 201                                                 const int search_parents);
 202
 203 extern struct symbol *cp_lookup_symbol_imports_or_template
 204      (const char *scope,
 205       const char *name,
 206       const struct block *block,
 207       const domain_enum domain);
 208
 209 extern struct type *cp_lookup_nested_type (struct type *parent_type,
 210                                            const char *nested_name,
 211                                            const struct block *block);
 212
 213 struct type *cp_lookup_transparent_type (const char *name);
 214
 215 /* Functions from cp-name-parser.y.  */
 216
 217 extern struct demangle_component *cp_demangled_name_to_comp
 218   (const char *demangled_name, const char **errmsg);
 219
 220 extern char *cp_comp_to_string (struct demangle_component *result,
 221                                 int estimated_len);
 222
 223 /* The list of "maint cplus" commands.  */
 224
 225 extern struct cmd_list_element *maint_cplus_cmd_list;
 226
 227 #endif /* CP_SUPPORT_H */