gdb/cp-support.h

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