1 /* Helper routines for C++ support in GDB.
2 Copyright (C) 2002-2024 Free Software Foundation, Inc.
4 Contributed by MontaVista Software.
5 Namespace support contributed by David Carlton.
7 This file is part of GDB.
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.
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.
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/>. */
26 #include "gdbsupport/gdb_vecs.h"
27 #include "gdbsupport/gdb_obstack.h"
28 #include "gdbsupport/array-view.h"
31 /* Opaque declarations. */
35 struct buildsym_compunit
;
38 struct demangle_component
;
41 /* A string representing the name of the anonymous namespace used in GDB. */
43 #define CP_ANONYMOUS_NAMESPACE_STR "(anonymous namespace)"
45 /* The length of the string representing the anonymous namespace. */
47 #define CP_ANONYMOUS_NAMESPACE_LEN 21
49 /* A string representing the start of an operator name. */
51 #define CP_OPERATOR_STR "operator"
53 /* The length of CP_OPERATOR_STR. */
55 #define CP_OPERATOR_LEN 8
57 /* The result of parsing a name. */
59 struct demangle_parse_info
61 demangle_parse_info ();
63 ~demangle_parse_info ();
65 /* The memory used during the parse. */
66 struct demangle_info
*info
;
68 /* The result of the parse. */
69 struct demangle_component
*tree
;
71 /* Any temporary memory used during typedef replacement. */
72 struct obstack obstack
;
76 /* Functions from cp-support.c. */
78 extern gdb::unique_xmalloc_ptr
<char> cp_canonicalize_string
81 extern gdb::unique_xmalloc_ptr
<char> cp_canonicalize_string_no_typedefs
84 typedef const char *(canonicalization_ftype
) (struct type
*, void *);
86 extern gdb::unique_xmalloc_ptr
<char> cp_canonicalize_string_full
87 (const char *string
, canonicalization_ftype
*finder
, void *data
);
89 extern char *cp_class_name_from_physname (const char *physname
);
91 extern char *method_name_from_physname (const char *physname
);
93 extern unsigned int cp_find_first_component (const char *name
);
95 extern unsigned int cp_entire_prefix_len (const char *name
);
97 extern gdb::unique_xmalloc_ptr
<char> cp_func_name (const char *full_name
);
99 extern gdb::unique_xmalloc_ptr
<char> cp_remove_params
100 (const char *demangled_name
);
102 /* DEMANGLED_NAME is the name of a function, (optionally) including
103 parameters and (optionally) a return type. Return the name of the
104 function without parameters or return type, or NULL if we can not
105 parse the name. If COMPLETION_MODE is true, then tolerate a
106 non-existing or unbalanced parameter list. */
107 extern gdb::unique_xmalloc_ptr
<char> cp_remove_params_if_any
108 (const char *demangled_name
, bool completion_mode
);
110 extern std::vector
<symbol
*> make_symbol_overload_list (const char *,
113 extern void add_symbol_overload_list_adl
114 (gdb::array_view
<type
*> arg_types
,
115 const char *func_name
,
116 std::vector
<symbol
*> *overload_list
);
118 extern struct type
*cp_lookup_rtti_type (const char *name
,
119 const struct block
*block
);
121 /* Produce an unsigned hash value from SEARCH_NAME that is compatible
122 with cp_symbol_name_matches. Only the last component in
123 "foo::bar::function()" is considered for hashing purposes (i.e.,
124 the entire prefix is skipped), so that later on looking up for
125 "function" or "bar::function" in all namespaces is possible. */
126 extern unsigned int cp_search_name_hash (const char *search_name
);
128 /* Implement the "get_symbol_name_matcher" language_defn method for C++. */
129 extern symbol_name_matcher_ftype
*cp_get_symbol_name_matcher
130 (const lookup_name_info
&lookup_name
);
132 /* Functions/variables from cp-namespace.c. */
134 extern int cp_is_in_anonymous (const char *symbol_name
);
136 extern void cp_scan_for_anonymous_namespaces (struct buildsym_compunit
*,
137 const struct symbol
*symbol
,
138 struct objfile
*objfile
);
140 extern struct block_symbol cp_lookup_symbol_nonlocal
141 (const struct language_defn
*langdef
,
143 const struct block
*block
,
144 const domain_search_flags domain
);
146 extern struct block_symbol
147 cp_lookup_symbol_namespace (const char *the_namespace
,
149 const struct block
*block
,
150 const domain_search_flags domain
);
152 extern struct block_symbol cp_lookup_symbol_imports_or_template
155 const struct block
*block
,
156 const domain_search_flags domain
);
158 extern struct block_symbol
159 cp_lookup_nested_symbol (struct type
*parent_type
,
160 const char *nested_name
,
161 const struct block
*block
,
162 const domain_search_flags domain
);
164 struct type
*cp_lookup_transparent_type (const char *name
,
165 domain_search_flags flags
);
167 /* See description in cp-namespace.c. */
169 struct type
*cp_find_type_baseclass_by_name (struct type
*parent_type
,
172 /* Functions from cp-name-parser.y. */
174 extern std::unique_ptr
<demangle_parse_info
> cp_demangled_name_to_comp
175 (const char *demangled_name
, std::string
*errmsg
);
177 /* Convert RESULT to a string. ESTIMATED_LEN is used only as a guide
178 to the length of the result. */
180 extern gdb::unique_xmalloc_ptr
<char> cp_comp_to_string
181 (struct demangle_component
*result
, int estimated_len
);
183 extern void cp_merge_demangle_parse_infos (struct demangle_parse_info
*,
184 struct demangle_component
*,
185 struct demangle_parse_info
*);
187 /* The list of "maint cplus" commands. */
189 extern struct cmd_list_element
*maint_cplus_cmd_list
;
191 /* Wrappers for bfd and libiberty demangling entry points. Note they
192 all force DMGL_VERBOSE so that callers don't need to. This is so
193 that GDB consistently uses DMGL_VERBOSE throughout -- we want
194 libiberty's demangler to expand standard substitutions to their
195 full template name. */
197 /* A wrapper for bfd_demangle. */
199 gdb::unique_xmalloc_ptr
<char> gdb_demangle (const char *name
, int options
);
201 /* A wrapper for cplus_demangle_print. */
203 extern char *gdb_cplus_demangle_print (int options
,
204 struct demangle_component
*tree
,
205 int estimated_length
,
206 size_t *p_allocated_size
);
208 /* Find an instance of the character C in the string S that is outside
209 of all parenthesis pairs, single-quoted strings, and double-quoted
210 strings. Also, ignore the char within a template name, like a ','
211 within foo<int, int>. */
213 extern const char *find_toplevel_char (const char *s
, char c
);
215 #endif /* CP_SUPPORT_H */