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 /* Opaque declarations.  */
  31
  32 struct symbol;
  33 struct obstack;
  34 struct block;
  35 struct objfile;
  36 struct type;
  37 struct demangle_component;
  38
  39 /* This struct is designed to store data from using directives.  It
  40    says that names from namespace IMPORT_SRC should be visible within
  41    namespace IMPORT_DEST.  These form a linked list; NEXT is the next
  42    element of the list.  If the imported namespace or declaration has
  43    been aliased within the IMPORT_DEST namespace, ALIAS is set to a
  44    string representing the alias.  Otherwise, ALIAS is NULL.
  45    DECLARATION is the name of the imported declaration, if this import
  46    statement represents one.  Otherwise DECLARATION is NULL and this
  47    import statement represents a namespace.
  48
  49    C++:      using namespace A;
  50    Fortran:  use A
  51    import_src = "A"
  52    import_dest = local scope of the import statement even such as ""
  53    alias = NULL
  54    declaration = NULL
  55
  56    C++:      using A::x;
  57    Fortran:  use A, only: x
  58    import_src = "A"
  59    import_dest = local scope of the import statement even such as ""
  60    alias = NULL
  61    declaration = "x"
  62    The declaration will get imported as import_dest::x.
  63
  64    C++:      namespace LOCALNS = A;
  65    Fortran has no way to address non-local namespace/module.
  66    import_src = "A"
  67    import_dest = local scope of the import statement even such as ""
  68    alias = "LOCALNS"
  69    declaration = NULL
  70    The namespace will get imported as the import_dest::LOCALNS
  71    namespace.
  72
  73    C++ cannot express it, it would be something like: using localname
  74    = A::x;
  75    Fortran:  use A, only localname => x
  76    import_src = "A"
  77    import_dest = local scope of the import statement even such as ""
  78    alias = "localname"
  79    declaration = "x"
  80    The declaration will get imported as localname or
  81    `import_dest`localname.  */
  82
  83 struct using_direct
  84 {
  85   char *import_src;
  86   char *import_dest;
  87
  88   char *alias;
  89   char *declaration;
  90
  91   struct using_direct *next;
  92
  93   /* Used during import search to temporarily mark this node as
  94      searched.  */
  95   int searched;
  96 };
  97
  98
  99 /* Functions from cp-support.c.  */
 100
 101 extern char *cp_canonicalize_string (const char *string);
 102
 103 extern char *cp_class_name_from_physname (const char *physname);
 104
 105 extern char *method_name_from_physname (const char *physname);
 106
 107 extern unsigned int cp_find_first_component (const char *name);
 108
 109 extern unsigned int cp_entire_prefix_len (const char *name);
 110
 111 extern char *cp_func_name (const char *full_name);
 112
 113 extern char *cp_remove_params (const char *demangled_name);
 114
 115 extern struct symbol **make_symbol_overload_list (const char *,
 116                                                   const char *);
 117
 118 extern struct symbol **make_symbol_overload_list_adl (struct type **arg_types,
 119                                                       int nargs,
 120                                                       const char *func_name);
 121
 122 extern struct type *cp_lookup_rtti_type (const char *name,
 123                                          struct block *block);
 124
 125 extern int cp_validate_operator (const char *input);
 126
 127 /* Functions/variables from cp-namespace.c.  */
 128
 129 extern int cp_is_anonymous (const char *namespace);
 130
 131 extern void cp_add_using_directive (const char *dest,
 132                                     const char *src,
 133                                     const char *alias,
 134                                     const char *declaration,
 135                                     struct obstack *obstack);
 136
 137 extern void cp_initialize_namespace (void);
 138
 139 extern void cp_finalize_namespace (struct block *static_block,
 140                                    struct obstack *obstack);
 141
 142 extern void cp_set_block_scope (const struct symbol *symbol,
 143                                 struct block *block,
 144                                 struct obstack *obstack,
 145                                 const char *processing_current_prefix,
 146                                 int processing_has_namespace_info);
 147
 148 extern void cp_scan_for_anonymous_namespaces (const struct symbol *symbol);
 149
 150 extern struct symbol *cp_lookup_symbol_nonlocal (const char *name,
 151                                                  const struct block *block,
 152                                                  const domain_enum domain);
 153
 154 extern struct symbol *cp_lookup_symbol_namespace (const char *namespace,
 155                                                   const char *name,
 156                                                   const struct block *block,
 157                                                   const domain_enum domain);
 158
 159 extern struct symbol *cp_lookup_symbol_imports (const char *scope,
 160                                                 const char *name,
 161                                                 const struct block *block,
 162                                                 const domain_enum domain,
 163                                                 const int declaration_only,
 164                                                 const int search_parents);
 165
 166 extern struct symbol *cp_lookup_symbol_imports_or_template
 167      (const char *scope,
 168       const char *name,
 169       const struct block *block,
 170       const domain_enum domain);
 171
 172 extern struct type *cp_lookup_nested_type (struct type *parent_type,
 173                                            const char *nested_name,
 174                                            const struct block *block);
 175
 176 struct type *cp_lookup_transparent_type (const char *name);
 177
 178 /* Functions from cp-name-parser.y.  */
 179
 180 extern struct demangle_component *cp_demangled_name_to_comp
 181   (const char *demangled_name, const char **errmsg);
 182
 183 extern char *cp_comp_to_string (struct demangle_component *result,
 184                                 int estimated_len);
 185
 186 /* The list of "maint cplus" commands.  */
 187
 188 extern struct cmd_list_element *maint_cplus_cmd_list;
 189
 190 #endif /* CP_SUPPORT_H */