xref: /dflybsd-src/contrib/gdb-7/gdb/cp-support.h (revision cf7f2e2d389e8012d562650bd94d7e433f449d6e)
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 symbol **make_symbol_overload_list_adl (struct type **arg_types,
114                                                       int nargs,
115                                                       const char *func_name);
116 
117 extern struct type *cp_lookup_rtti_type (const char *name,
118 					 struct block *block);
119 
120 extern int cp_validate_operator (const char *input);
121 
122 /* Functions/variables from cp-namespace.c.  */
123 
124 extern int cp_is_anonymous (const char *namespace);
125 
126 extern void cp_add_using_directive (const char *dest,
127                                     const char *src,
128                                     const char *alias,
129 				    const char *declaration,
130                                     struct obstack *obstack);
131 
132 extern void cp_initialize_namespace (void);
133 
134 extern void cp_finalize_namespace (struct block *static_block,
135 				   struct obstack *obstack);
136 
137 extern void cp_set_block_scope (const struct symbol *symbol,
138 				struct block *block,
139 				struct obstack *obstack,
140 				const char *processing_current_prefix,
141 				int processing_has_namespace_info);
142 
143 extern void cp_scan_for_anonymous_namespaces (const struct symbol *symbol);
144 
145 extern struct symbol *cp_lookup_symbol_nonlocal (const char *name,
146 						 const struct block *block,
147 						 const domain_enum domain);
148 
149 extern struct symbol *cp_lookup_symbol_namespace (const char *namespace,
150 						  const char *name,
151 						  const struct block *block,
152 						  const domain_enum domain);
153 
154 extern struct symbol *cp_lookup_symbol_imports (const char *scope,
155                                                 const char *name,
156                                                 const struct block *block,
157                                                 const domain_enum domain,
158                                                 const int declaration_only,
159                                                 const int search_parents);
160 
161 extern struct type *cp_lookup_nested_type (struct type *parent_type,
162 					   const char *nested_name,
163 					   const struct block *block);
164 
165 extern void cp_check_possible_namespace_symbols (const char *name,
166 						 struct objfile *objfile);
167 
168 struct type *cp_lookup_transparent_type (const char *name);
169 
170 /* Functions from cp-name-parser.y.  */
171 
172 extern struct demangle_component *cp_demangled_name_to_comp
173   (const char *demangled_name, const char **errmsg);
174 
175 extern char *cp_comp_to_string (struct demangle_component *result,
176 				int estimated_len);
177 
178 /* The list of "maint cplus" commands.  */
179 
180 extern struct cmd_list_element *maint_cplus_cmd_list;
181 
182 #endif /* CP_SUPPORT_H */
183