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