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