]>
Commit | Line | Data |
---|---|---|
6599da04 | 1 | /* Defs for interface to demanglers. |
7adcbafe | 2 | Copyright (C) 1992-2022 Free Software Foundation, Inc. |
9cefc856 | 3 | |
289c40ed MM |
4 | This program is free software; you can redistribute it and/or |
5 | modify it under the terms of the GNU Library General Public License | |
6 | as published by the Free Software Foundation; either version 2, or | |
7 | (at your option) any later version. | |
8 | ||
9 | In addition to the permissions in the GNU Library General Public | |
10 | License, the Free Software Foundation gives you unlimited | |
11 | permission to link the compiled version of this file into | |
12 | combinations with other programs, and to distribute those | |
13 | combinations without any restriction coming from the use of this | |
14 | file. (The Library Public License restrictions do apply in other | |
15 | respects; for example, they cover modification of the file, and | |
16 | distribution when not linked into a combined executable.) | |
17 | ||
18 | This program is distributed in the hope that it will be useful, but | |
19 | WITHOUT ANY WARRANTY; without even the implied warranty of | |
20 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
21 | Library General Public License for more details. | |
22 | ||
23 | You should have received a copy of the GNU Library General Public | |
24 | License along with this program; if not, write to the Free Software | |
25 | Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston, MA | |
26 | 02110-1301, USA. */ | |
6599da04 JM |
27 | |
28 | ||
29 | #if !defined (DEMANGLE_H) | |
30 | #define DEMANGLE_H | |
31 | ||
d051dc88 | 32 | #include "libiberty.h" |
e4a32afb | 33 | |
513dab32 L |
34 | #ifdef __cplusplus |
35 | extern "C" { | |
36 | #endif /* __cplusplus */ | |
37 | ||
6599da04 JM |
38 | /* Options passed to cplus_demangle (in 2nd parameter). */ |
39 | ||
69afa80d AS |
40 | #define DMGL_NO_OPTS 0 /* For readability... */ |
41 | #define DMGL_PARAMS (1 << 0) /* Include function args */ | |
42 | #define DMGL_ANSI (1 << 1) /* Include const, volatile, etc */ | |
43 | #define DMGL_JAVA (1 << 2) /* Demangle as Java rather than C++. */ | |
c13db5d1 JM |
44 | #define DMGL_VERBOSE (1 << 3) /* Include implementation details. */ |
45 | #define DMGL_TYPES (1 << 4) /* Also try to demangle type encodings. */ | |
92aed1cb | 46 | #define DMGL_RET_POSTFIX (1 << 5) /* Print function return types (when |
f019462c JK |
47 | present) after function signature. |
48 | It applies only to the toplevel | |
49 | function type. */ | |
50 | #define DMGL_RET_DROP (1 << 6) /* Suppress printing function return | |
51 | types, even if present. It applies | |
52 | only to the toplevel function type. | |
53 | */ | |
69afa80d AS |
54 | |
55 | #define DMGL_AUTO (1 << 8) | |
675ad22c | 56 | #define DMGL_GNU_V3 (1 << 14) |
7ecdd10b | 57 | #define DMGL_GNAT (1 << 15) |
43b1b9ed | 58 | #define DMGL_DLANG (1 << 16) |
10d48c59 | 59 | #define DMGL_RUST (1 << 17) /* Rust wraps GNU_V3 style mangling. */ |
63684e63 | 60 | |
6599da04 | 61 | /* If none of these are set, use 'current_demangling_style' as the default. */ |
6c8120c5 | 62 | #define DMGL_STYLE_MASK (DMGL_AUTO|DMGL_GNU_V3|DMGL_JAVA|DMGL_GNAT|DMGL_DLANG|DMGL_RUST) |
6599da04 | 63 | |
e96d1d8c NC |
64 | /* Disable a limit on the depth of recursion in mangled strings. |
65 | Note if this limit is disabled then stack exhaustion is possible when | |
66 | demangling pathologically complicated strings. Bug reports about stack | |
67 | exhaustion when the option is enabled will be rejected. */ | |
68 | #define DMGL_NO_RECURSE_LIMIT (1 << 18) | |
69 | ||
70 | /* If DMGL_NO_RECURSE_LIMIT is not enabled, then this is the value used as | |
71 | the maximum depth of recursion allowed. It should be enough for any | |
72 | real-world mangled name. */ | |
921a4c30 | 73 | #define DEMANGLE_RECURSION_LIMIT 2048 |
e96d1d8c | 74 | |
6599da04 JM |
75 | /* Enumeration of possible demangling styles. |
76 | ||
77 | Lucid and ARM styles are still kept logically distinct, even though | |
78 | they now both behave identically. The resulting style is actual the | |
79 | union of both. I.E. either style recognizes both "__pt__" and "__rf__" | |
80 | for operator "->", even though the first is lucid style and the second | |
81 | is ARM style. (FIXME?) */ | |
82 | ||
83 | extern enum demangling_styles | |
84 | { | |
d06ba3c7 | 85 | no_demangling = -1, |
6599da04 JM |
86 | unknown_demangling = 0, |
87 | auto_demangling = DMGL_AUTO, | |
675ad22c | 88 | gnu_v3_demangling = DMGL_GNU_V3, |
7ecdd10b | 89 | java_demangling = DMGL_JAVA, |
43b1b9ed | 90 | gnat_demangling = DMGL_GNAT, |
10d48c59 DT |
91 | dlang_demangling = DMGL_DLANG, |
92 | rust_demangling = DMGL_RUST | |
6599da04 JM |
93 | } current_demangling_style; |
94 | ||
95 | /* Define string names for the various demangling styles. */ | |
96 | ||
d06ba3c7 | 97 | #define NO_DEMANGLING_STYLE_STRING "none" |
69afa80d | 98 | #define AUTO_DEMANGLING_STYLE_STRING "auto" |
675ad22c | 99 | #define GNU_V3_DEMANGLING_STYLE_STRING "gnu-v3" |
7ecdd10b KB |
100 | #define JAVA_DEMANGLING_STYLE_STRING "java" |
101 | #define GNAT_DEMANGLING_STYLE_STRING "gnat" | |
43b1b9ed | 102 | #define DLANG_DEMANGLING_STYLE_STRING "dlang" |
10d48c59 | 103 | #define RUST_DEMANGLING_STYLE_STRING "rust" |
6599da04 JM |
104 | |
105 | /* Some macros to test what demangling style is active. */ | |
106 | ||
107 | #define CURRENT_DEMANGLING_STYLE current_demangling_style | |
108 | #define AUTO_DEMANGLING (((int) CURRENT_DEMANGLING_STYLE) & DMGL_AUTO) | |
675ad22c | 109 | #define GNU_V3_DEMANGLING (((int) CURRENT_DEMANGLING_STYLE) & DMGL_GNU_V3) |
7ecdd10b KB |
110 | #define JAVA_DEMANGLING (((int) CURRENT_DEMANGLING_STYLE) & DMGL_JAVA) |
111 | #define GNAT_DEMANGLING (((int) CURRENT_DEMANGLING_STYLE) & DMGL_GNAT) | |
43b1b9ed | 112 | #define DLANG_DEMANGLING (((int) CURRENT_DEMANGLING_STYLE) & DMGL_DLANG) |
10d48c59 | 113 | #define RUST_DEMANGLING (((int) CURRENT_DEMANGLING_STYLE) & DMGL_RUST) |
6599da04 | 114 | |
24eaa47a KB |
115 | /* Provide information about the available demangle styles. This code is |
116 | pulled from gdb into libiberty because it is useful to binutils also. */ | |
117 | ||
0be6abca | 118 | extern const struct demangler_engine |
24eaa47a | 119 | { |
0be6abca KG |
120 | const char *const demangling_style_name; |
121 | const enum demangling_styles demangling_style; | |
122 | const char *const demangling_style_doc; | |
24eaa47a KB |
123 | } libiberty_demanglers[]; |
124 | ||
6599da04 | 125 | extern char * |
9486db4f | 126 | cplus_demangle (const char *mangled, int options); |
6599da04 | 127 | |
6599da04 JM |
128 | /* Note: This sets global state. FIXME if you care about multi-threading. */ |
129 | ||
721c8251 | 130 | extern enum demangling_styles |
9486db4f | 131 | cplus_demangle_set_style (enum demangling_styles style); |
24eaa47a | 132 | |
721c8251 | 133 | extern enum demangling_styles |
9486db4f | 134 | cplus_demangle_name_to_style (const char *name); |
69afa80d | 135 | |
456cc5cf SB |
136 | /* Callback typedef for allocation-less demangler interfaces. */ |
137 | typedef void (*demangle_callbackref) (const char *, size_t, void *); | |
138 | ||
139 | /* V3 ABI demangling entry points, defined in cp-demangle.c. Callback | |
140 | variants return non-zero on success, zero on error. char* variants | |
141 | return a string allocated by malloc on success, NULL on error. */ | |
142 | extern int | |
143 | cplus_demangle_v3_callback (const char *mangled, int options, | |
144 | demangle_callbackref callback, void *opaque); | |
4437e4d4 | 145 | |
3b60dd8e | 146 | extern char* |
456cc5cf | 147 | cplus_demangle_v3 (const char *mangled, int options); |
3b60dd8e | 148 | |
456cc5cf SB |
149 | extern int |
150 | java_demangle_v3_callback (const char *mangled, | |
151 | demangle_callbackref callback, void *opaque); | |
152 | ||
153 | extern char* | |
154 | java_demangle_v3 (const char *mangled); | |
2d32013f | 155 | |
5b40c067 TG |
156 | char * |
157 | ada_demangle (const char *mangled, int options); | |
158 | ||
43b1b9ed IB |
159 | extern char * |
160 | dlang_demangle (const char *mangled, int options); | |
161 | ||
32fc3719 EMB |
162 | extern int |
163 | rust_demangle_callback (const char *mangled, int options, | |
164 | demangle_callbackref callback, void *opaque); | |
165 | ||
166 | ||
10d48c59 DT |
167 | extern char * |
168 | rust_demangle (const char *mangled, int options); | |
169 | ||
2d32013f JB |
170 | enum gnu_v3_ctor_kinds { |
171 | gnu_v3_complete_object_ctor = 1, | |
172 | gnu_v3_base_object_ctor, | |
0a35513e | 173 | gnu_v3_complete_object_allocating_ctor, |
1f26ac87 JM |
174 | /* These are not part of the V3 ABI. Unified constructors are generated |
175 | as a speed-for-space optimization when the -fdeclone-ctor-dtor option | |
176 | is used, and are always internal symbols. */ | |
177 | gnu_v3_unified_ctor, | |
0a35513e | 178 | gnu_v3_object_ctor_group |
2d32013f JB |
179 | }; |
180 | ||
181 | /* Return non-zero iff NAME is the mangled form of a constructor name | |
182 | in the G++ V3 ABI demangling style. Specifically, return an `enum | |
183 | gnu_v3_ctor_kinds' value indicating what kind of constructor | |
184 | it is. */ | |
641b2721 | 185 | extern enum gnu_v3_ctor_kinds |
9486db4f | 186 | is_gnu_v3_mangled_ctor (const char *name); |
2d32013f JB |
187 | |
188 | ||
189 | enum gnu_v3_dtor_kinds { | |
190 | gnu_v3_deleting_dtor = 1, | |
191 | gnu_v3_complete_object_dtor, | |
0a35513e | 192 | gnu_v3_base_object_dtor, |
1f26ac87 JM |
193 | /* These are not part of the V3 ABI. Unified destructors are generated |
194 | as a speed-for-space optimization when the -fdeclone-ctor-dtor option | |
195 | is used, and are always internal symbols. */ | |
196 | gnu_v3_unified_dtor, | |
0a35513e | 197 | gnu_v3_object_dtor_group |
2d32013f JB |
198 | }; |
199 | ||
200 | /* Return non-zero iff NAME is the mangled form of a destructor name | |
201 | in the G++ V3 ABI demangling style. Specifically, return an `enum | |
202 | gnu_v3_dtor_kinds' value, indicating what kind of destructor | |
203 | it is. */ | |
641b2721 | 204 | extern enum gnu_v3_dtor_kinds |
9486db4f | 205 | is_gnu_v3_mangled_dtor (const char *name); |
2d32013f | 206 | |
5e777af5 ILT |
207 | /* The V3 demangler works in two passes. The first pass builds a tree |
208 | representation of the mangled name, and the second pass turns the | |
209 | tree representation into a demangled string. Here we define an | |
210 | interface to permit a caller to build their own tree | |
211 | representation, which they can pass to the demangler to get a | |
212 | demangled string. This can be used to canonicalize user input into | |
213 | something which the demangler might output. It could also be used | |
214 | by other demanglers in the future. */ | |
215 | ||
216 | /* These are the component types which may be found in the tree. Many | |
217 | component types have one or two subtrees, referred to as left and | |
218 | right (a component type with only one subtree puts it in the left | |
219 | subtree). */ | |
220 | ||
221 | enum demangle_component_type | |
222 | { | |
223 | /* A name, with a length and a pointer to a string. */ | |
224 | DEMANGLE_COMPONENT_NAME, | |
225 | /* A qualified name. The left subtree is a class or namespace or | |
226 | some such thing, and the right subtree is a name qualified by | |
227 | that class. */ | |
228 | DEMANGLE_COMPONENT_QUAL_NAME, | |
229 | /* A local name. The left subtree describes a function, and the | |
230 | right subtree is a name which is local to that function. */ | |
231 | DEMANGLE_COMPONENT_LOCAL_NAME, | |
232 | /* A typed name. The left subtree is a name, and the right subtree | |
233 | describes that name as a function. */ | |
234 | DEMANGLE_COMPONENT_TYPED_NAME, | |
235 | /* A template. The left subtree is a template name, and the right | |
236 | subtree is a template argument list. */ | |
237 | DEMANGLE_COMPONENT_TEMPLATE, | |
238 | /* A template parameter. This holds a number, which is the template | |
239 | parameter index. */ | |
240 | DEMANGLE_COMPONENT_TEMPLATE_PARAM, | |
448545cb JM |
241 | /* A function parameter. This holds a number, which is the index. */ |
242 | DEMANGLE_COMPONENT_FUNCTION_PARAM, | |
5e777af5 ILT |
243 | /* A constructor. This holds a name and the kind of |
244 | constructor. */ | |
245 | DEMANGLE_COMPONENT_CTOR, | |
246 | /* A destructor. This holds a name and the kind of destructor. */ | |
247 | DEMANGLE_COMPONENT_DTOR, | |
248 | /* A vtable. This has one subtree, the type for which this is a | |
249 | vtable. */ | |
250 | DEMANGLE_COMPONENT_VTABLE, | |
251 | /* A VTT structure. This has one subtree, the type for which this | |
252 | is a VTT. */ | |
253 | DEMANGLE_COMPONENT_VTT, | |
254 | /* A construction vtable. The left subtree is the type for which | |
255 | this is a vtable, and the right subtree is the derived type for | |
256 | which this vtable is built. */ | |
257 | DEMANGLE_COMPONENT_CONSTRUCTION_VTABLE, | |
258 | /* A typeinfo structure. This has one subtree, the type for which | |
259 | this is the tpeinfo structure. */ | |
260 | DEMANGLE_COMPONENT_TYPEINFO, | |
261 | /* A typeinfo name. This has one subtree, the type for which this | |
262 | is the typeinfo name. */ | |
263 | DEMANGLE_COMPONENT_TYPEINFO_NAME, | |
264 | /* A typeinfo function. This has one subtree, the type for which | |
265 | this is the tpyeinfo function. */ | |
266 | DEMANGLE_COMPONENT_TYPEINFO_FN, | |
267 | /* A thunk. This has one subtree, the name for which this is a | |
268 | thunk. */ | |
269 | DEMANGLE_COMPONENT_THUNK, | |
270 | /* A virtual thunk. This has one subtree, the name for which this | |
271 | is a virtual thunk. */ | |
272 | DEMANGLE_COMPONENT_VIRTUAL_THUNK, | |
273 | /* A covariant thunk. This has one subtree, the name for which this | |
274 | is a covariant thunk. */ | |
275 | DEMANGLE_COMPONENT_COVARIANT_THUNK, | |
276 | /* A Java class. This has one subtree, the type. */ | |
277 | DEMANGLE_COMPONENT_JAVA_CLASS, | |
278 | /* A guard variable. This has one subtree, the name for which this | |
279 | is a guard variable. */ | |
280 | DEMANGLE_COMPONENT_GUARD, | |
7c424acd JM |
281 | /* The init and wrapper functions for C++11 thread_local variables. */ |
282 | DEMANGLE_COMPONENT_TLS_INIT, | |
283 | DEMANGLE_COMPONENT_TLS_WRAPPER, | |
5e777af5 ILT |
284 | /* A reference temporary. This has one subtree, the name for which |
285 | this is a temporary. */ | |
286 | DEMANGLE_COMPONENT_REFTEMP, | |
15da2806 RH |
287 | /* A hidden alias. This has one subtree, the encoding for which it |
288 | is providing alternative linkage. */ | |
289 | DEMANGLE_COMPONENT_HIDDEN_ALIAS, | |
5e777af5 ILT |
290 | /* A standard substitution. This holds the name of the |
291 | substitution. */ | |
292 | DEMANGLE_COMPONENT_SUB_STD, | |
293 | /* The restrict qualifier. The one subtree is the type which is | |
294 | being qualified. */ | |
295 | DEMANGLE_COMPONENT_RESTRICT, | |
296 | /* The volatile qualifier. The one subtree is the type which is | |
297 | being qualified. */ | |
298 | DEMANGLE_COMPONENT_VOLATILE, | |
299 | /* The const qualifier. The one subtree is the type which is being | |
300 | qualified. */ | |
301 | DEMANGLE_COMPONENT_CONST, | |
302 | /* The restrict qualifier modifying a member function. The one | |
303 | subtree is the type which is being qualified. */ | |
304 | DEMANGLE_COMPONENT_RESTRICT_THIS, | |
305 | /* The volatile qualifier modifying a member function. The one | |
306 | subtree is the type which is being qualified. */ | |
307 | DEMANGLE_COMPONENT_VOLATILE_THIS, | |
308 | /* The const qualifier modifying a member function. The one subtree | |
309 | is the type which is being qualified. */ | |
310 | DEMANGLE_COMPONENT_CONST_THIS, | |
9eb85f27 JM |
311 | /* C++11 A reference modifying a member function. The one subtree is the |
312 | type which is being referenced. */ | |
313 | DEMANGLE_COMPONENT_REFERENCE_THIS, | |
314 | /* C++11: An rvalue reference modifying a member function. The one | |
315 | subtree is the type which is being referenced. */ | |
316 | DEMANGLE_COMPONENT_RVALUE_REFERENCE_THIS, | |
5e777af5 ILT |
317 | /* A vendor qualifier. The left subtree is the type which is being |
318 | qualified, and the right subtree is the name of the | |
319 | qualifier. */ | |
320 | DEMANGLE_COMPONENT_VENDOR_TYPE_QUAL, | |
321 | /* A pointer. The one subtree is the type which is being pointed | |
322 | to. */ | |
323 | DEMANGLE_COMPONENT_POINTER, | |
324 | /* A reference. The one subtree is the type which is being | |
325 | referenced. */ | |
326 | DEMANGLE_COMPONENT_REFERENCE, | |
1ab28be5 DG |
327 | /* C++0x: An rvalue reference. The one subtree is the type which is |
328 | being referenced. */ | |
329 | DEMANGLE_COMPONENT_RVALUE_REFERENCE, | |
5e777af5 ILT |
330 | /* A complex type. The one subtree is the base type. */ |
331 | DEMANGLE_COMPONENT_COMPLEX, | |
332 | /* An imaginary type. The one subtree is the base type. */ | |
333 | DEMANGLE_COMPONENT_IMAGINARY, | |
334 | /* A builtin type. This holds the builtin type information. */ | |
335 | DEMANGLE_COMPONENT_BUILTIN_TYPE, | |
336 | /* A vendor's builtin type. This holds the name of the type. */ | |
337 | DEMANGLE_COMPONENT_VENDOR_TYPE, | |
338 | /* A function type. The left subtree is the return type. The right | |
339 | subtree is a list of ARGLIST nodes. Either or both may be | |
340 | NULL. */ | |
341 | DEMANGLE_COMPONENT_FUNCTION_TYPE, | |
342 | /* An array type. The left subtree is the dimension, which may be | |
343 | NULL, or a string (represented as DEMANGLE_COMPONENT_NAME), or an | |
344 | expression. The right subtree is the element type. */ | |
345 | DEMANGLE_COMPONENT_ARRAY_TYPE, | |
346 | /* A pointer to member type. The left subtree is the class type, | |
347 | and the right subtree is the member type. CV-qualifiers appear | |
348 | on the latter. */ | |
349 | DEMANGLE_COMPONENT_PTRMEM_TYPE, | |
07523e7c JM |
350 | /* A fixed-point type. */ |
351 | DEMANGLE_COMPONENT_FIXED_TYPE, | |
abfe01ce JM |
352 | /* A vector type. The left subtree is the number of elements, |
353 | the right subtree is the element type. */ | |
354 | DEMANGLE_COMPONENT_VECTOR_TYPE, | |
5e777af5 ILT |
355 | /* An argument list. The left subtree is the current argument, and |
356 | the right subtree is either NULL or another ARGLIST node. */ | |
357 | DEMANGLE_COMPONENT_ARGLIST, | |
358 | /* A template argument list. The left subtree is the current | |
359 | template argument, and the right subtree is either NULL or | |
360 | another TEMPLATE_ARGLIST node. */ | |
361 | DEMANGLE_COMPONENT_TEMPLATE_ARGLIST, | |
4be5c72c JM |
362 | /* A template parameter object (C++20). The left subtree is the |
363 | corresponding template argument. */ | |
364 | DEMANGLE_COMPONENT_TPARM_OBJ, | |
4b6aaa99 JM |
365 | /* An initializer list. The left subtree is either an explicit type or |
366 | NULL, and the right subtree is a DEMANGLE_COMPONENT_ARGLIST. */ | |
367 | DEMANGLE_COMPONENT_INITIALIZER_LIST, | |
5e777af5 ILT |
368 | /* An operator. This holds information about a standard |
369 | operator. */ | |
370 | DEMANGLE_COMPONENT_OPERATOR, | |
371 | /* An extended operator. This holds the number of arguments, and | |
372 | the name of the extended operator. */ | |
373 | DEMANGLE_COMPONENT_EXTENDED_OPERATOR, | |
374 | /* A typecast, represented as a unary operator. The one subtree is | |
375 | the type to which the argument should be cast. */ | |
376 | DEMANGLE_COMPONENT_CAST, | |
921da198 PA |
377 | /* A conversion operator, represented as a unary operator. The one |
378 | subtree is the type to which the argument should be converted | |
379 | to. */ | |
380 | DEMANGLE_COMPONENT_CONVERSION, | |
4b6aaa99 JM |
381 | /* A nullary expression. The left subtree is the operator. */ |
382 | DEMANGLE_COMPONENT_NULLARY, | |
5e777af5 ILT |
383 | /* A unary expression. The left subtree is the operator, and the |
384 | right subtree is the single argument. */ | |
385 | DEMANGLE_COMPONENT_UNARY, | |
386 | /* A binary expression. The left subtree is the operator, and the | |
387 | right subtree is a BINARY_ARGS. */ | |
388 | DEMANGLE_COMPONENT_BINARY, | |
389 | /* Arguments to a binary expression. The left subtree is the first | |
390 | argument, and the right subtree is the second argument. */ | |
391 | DEMANGLE_COMPONENT_BINARY_ARGS, | |
392 | /* A trinary expression. The left subtree is the operator, and the | |
393 | right subtree is a TRINARY_ARG1. */ | |
394 | DEMANGLE_COMPONENT_TRINARY, | |
395 | /* Arguments to a trinary expression. The left subtree is the first | |
396 | argument, and the right subtree is a TRINARY_ARG2. */ | |
397 | DEMANGLE_COMPONENT_TRINARY_ARG1, | |
398 | /* More arguments to a trinary expression. The left subtree is the | |
399 | second argument, and the right subtree is the third argument. */ | |
400 | DEMANGLE_COMPONENT_TRINARY_ARG2, | |
401 | /* A literal. The left subtree is the type, and the right subtree | |
402 | is the value, represented as a DEMANGLE_COMPONENT_NAME. */ | |
403 | DEMANGLE_COMPONENT_LITERAL, | |
404 | /* A negative literal. Like LITERAL, but the value is negated. | |
405 | This is a minor hack: the NAME used for LITERAL points directly | |
406 | to the mangled string, but since negative numbers are mangled | |
407 | using 'n' instead of '-', we want a way to indicate a negative | |
408 | number which involves neither modifying the mangled string nor | |
409 | allocating a new copy of the literal in memory. */ | |
e5df4fb1 | 410 | DEMANGLE_COMPONENT_LITERAL_NEG, |
a3bf6ce7 PP |
411 | /* A vendor's builtin expression. The left subtree holds the |
412 | expression's name, and the right subtree is a argument list. */ | |
413 | DEMANGLE_COMPONENT_VENDOR_EXPR, | |
e5df4fb1 DD |
414 | /* A libgcj compiled resource. The left subtree is the name of the |
415 | resource. */ | |
416 | DEMANGLE_COMPONENT_JAVA_RESOURCE, | |
417 | /* A name formed by the concatenation of two parts. The left | |
418 | subtree is the first part and the right subtree the second. */ | |
419 | DEMANGLE_COMPONENT_COMPOUND_NAME, | |
420 | /* A name formed by a single character. */ | |
5a3d7e74 | 421 | DEMANGLE_COMPONENT_CHARACTER, |
abfe01ce JM |
422 | /* A number. */ |
423 | DEMANGLE_COMPONENT_NUMBER, | |
5a3d7e74 | 424 | /* A decltype type. */ |
38179091 | 425 | DEMANGLE_COMPONENT_DECLTYPE, |
23b1a789 JK |
426 | /* Global constructors keyed to name. */ |
427 | DEMANGLE_COMPONENT_GLOBAL_CONSTRUCTORS, | |
428 | /* Global destructors keyed to name. */ | |
429 | DEMANGLE_COMPONENT_GLOBAL_DESTRUCTORS, | |
d5f4eddd JM |
430 | /* A lambda closure type. */ |
431 | DEMANGLE_COMPONENT_LAMBDA, | |
432 | /* A default argument scope. */ | |
433 | DEMANGLE_COMPONENT_DEFAULT_ARG, | |
434 | /* An unnamed type. */ | |
435 | DEMANGLE_COMPONENT_UNNAMED_TYPE, | |
0a35513e AH |
436 | /* A transactional clone. This has one subtree, the encoding for |
437 | which it is providing alternative linkage. */ | |
438 | DEMANGLE_COMPONENT_TRANSACTION_CLONE, | |
439 | /* A non-transactional clone entry point. In the i386/x86_64 abi, | |
440 | the unmangled symbol of a tm_callable becomes a thunk and the | |
441 | non-transactional function version is mangled thus. */ | |
442 | DEMANGLE_COMPONENT_NONTRANSACTION_CLONE, | |
38179091 | 443 | /* A pack expansion. */ |
2d2b02c4 | 444 | DEMANGLE_COMPONENT_PACK_EXPANSION, |
7dbb85a7 JM |
445 | /* A name with an ABI tag. */ |
446 | DEMANGLE_COMPONENT_TAGGED_NAME, | |
b8fd7909 JM |
447 | /* A transaction-safe function type. */ |
448 | DEMANGLE_COMPONENT_TRANSACTION_SAFE, | |
2d2b02c4 | 449 | /* A cloned function. */ |
51dc6603 JM |
450 | DEMANGLE_COMPONENT_CLONE, |
451 | DEMANGLE_COMPONENT_NOEXCEPT, | |
451894ca NS |
452 | DEMANGLE_COMPONENT_THROW_SPEC, |
453 | ||
b7feb71d NS |
454 | DEMANGLE_COMPONENT_STRUCTURED_BINDING, |
455 | ||
456 | DEMANGLE_COMPONENT_MODULE_NAME, | |
457 | DEMANGLE_COMPONENT_MODULE_PARTITION, | |
458 | DEMANGLE_COMPONENT_MODULE_ENTITY, | |
459 | DEMANGLE_COMPONENT_MODULE_INIT, | |
5e777af5 ILT |
460 | }; |
461 | ||
462 | /* Types which are only used internally. */ | |
463 | ||
464 | struct demangle_operator_info; | |
465 | struct demangle_builtin_type_info; | |
466 | ||
467 | /* A node in the tree representation is an instance of a struct | |
468 | demangle_component. Note that the field names of the struct are | |
469 | not well protected against macros defined by the file including | |
470 | this one. We can fix this if it ever becomes a problem. */ | |
471 | ||
472 | struct demangle_component | |
473 | { | |
474 | /* The type of this component. */ | |
475 | enum demangle_component_type type; | |
476 | ||
a46586c3 MW |
477 | /* Guard against recursive component printing. |
478 | Initialize to zero. Private to d_print_comp. | |
479 | All other fields are final after initialization. */ | |
480 | int d_printing; | |
513e0aa0 | 481 | int d_counting; |
a46586c3 | 482 | |
5e777af5 ILT |
483 | union |
484 | { | |
485 | /* For DEMANGLE_COMPONENT_NAME. */ | |
486 | struct | |
487 | { | |
488 | /* A pointer to the name (which need not NULL terminated) and | |
489 | its length. */ | |
490 | const char *s; | |
491 | int len; | |
492 | } s_name; | |
493 | ||
494 | /* For DEMANGLE_COMPONENT_OPERATOR. */ | |
495 | struct | |
496 | { | |
497 | /* Operator. */ | |
498 | const struct demangle_operator_info *op; | |
499 | } s_operator; | |
500 | ||
501 | /* For DEMANGLE_COMPONENT_EXTENDED_OPERATOR. */ | |
502 | struct | |
503 | { | |
504 | /* Number of arguments. */ | |
505 | int args; | |
506 | /* Name. */ | |
507 | struct demangle_component *name; | |
508 | } s_extended_operator; | |
509 | ||
07523e7c JM |
510 | /* For DEMANGLE_COMPONENT_FIXED_TYPE. */ |
511 | struct | |
512 | { | |
513 | /* The length, indicated by a C integer type name. */ | |
514 | struct demangle_component *length; | |
515 | /* _Accum or _Fract? */ | |
516 | short accum; | |
517 | /* Saturating or not? */ | |
518 | short sat; | |
519 | } s_fixed; | |
520 | ||
5e777af5 ILT |
521 | /* For DEMANGLE_COMPONENT_CTOR. */ |
522 | struct | |
523 | { | |
524 | /* Kind of constructor. */ | |
525 | enum gnu_v3_ctor_kinds kind; | |
526 | /* Name. */ | |
527 | struct demangle_component *name; | |
528 | } s_ctor; | |
529 | ||
530 | /* For DEMANGLE_COMPONENT_DTOR. */ | |
531 | struct | |
532 | { | |
533 | /* Kind of destructor. */ | |
534 | enum gnu_v3_dtor_kinds kind; | |
535 | /* Name. */ | |
536 | struct demangle_component *name; | |
537 | } s_dtor; | |
538 | ||
539 | /* For DEMANGLE_COMPONENT_BUILTIN_TYPE. */ | |
540 | struct | |
541 | { | |
542 | /* Builtin type. */ | |
543 | const struct demangle_builtin_type_info *type; | |
544 | } s_builtin; | |
545 | ||
546 | /* For DEMANGLE_COMPONENT_SUB_STD. */ | |
547 | struct | |
548 | { | |
549 | /* Standard substitution string. */ | |
550 | const char* string; | |
551 | /* Length of string. */ | |
552 | int len; | |
553 | } s_string; | |
554 | ||
448545cb | 555 | /* For DEMANGLE_COMPONENT_*_PARAM. */ |
5e777af5 ILT |
556 | struct |
557 | { | |
448545cb | 558 | /* Parameter index. */ |
5e777af5 ILT |
559 | long number; |
560 | } s_number; | |
561 | ||
e5df4fb1 DD |
562 | /* For DEMANGLE_COMPONENT_CHARACTER. */ |
563 | struct | |
564 | { | |
565 | int character; | |
566 | } s_character; | |
567 | ||
5e777af5 ILT |
568 | /* For other types. */ |
569 | struct | |
570 | { | |
571 | /* Left (or only) subtree. */ | |
572 | struct demangle_component *left; | |
573 | /* Right subtree. */ | |
574 | struct demangle_component *right; | |
575 | } s_binary; | |
576 | ||
d5f4eddd JM |
577 | struct |
578 | { | |
579 | /* subtree, same place as d_left. */ | |
580 | struct demangle_component *sub; | |
581 | /* integer. */ | |
582 | int num; | |
583 | } s_unary_num; | |
584 | ||
5e777af5 ILT |
585 | } u; |
586 | }; | |
587 | ||
588 | /* People building mangled trees are expected to allocate instances of | |
589 | struct demangle_component themselves. They can then call one of | |
590 | the following functions to fill them in. */ | |
591 | ||
592 | /* Fill in most component types with a left subtree and a right | |
593 | subtree. Returns non-zero on success, zero on failure, such as an | |
594 | unrecognized or inappropriate component type. */ | |
595 | ||
596 | extern int | |
9486db4f GDR |
597 | cplus_demangle_fill_component (struct demangle_component *fill, |
598 | enum demangle_component_type, | |
599 | struct demangle_component *left, | |
600 | struct demangle_component *right); | |
5e777af5 ILT |
601 | |
602 | /* Fill in a DEMANGLE_COMPONENT_NAME. Returns non-zero on success, | |
603 | zero for bad arguments. */ | |
604 | ||
605 | extern int | |
9486db4f GDR |
606 | cplus_demangle_fill_name (struct demangle_component *fill, |
607 | const char *, int); | |
5e777af5 ILT |
608 | |
609 | /* Fill in a DEMANGLE_COMPONENT_BUILTIN_TYPE, using the name of the | |
610 | builtin type (e.g., "int", etc.). Returns non-zero on success, | |
611 | zero if the type is not recognized. */ | |
612 | ||
613 | extern int | |
9486db4f GDR |
614 | cplus_demangle_fill_builtin_type (struct demangle_component *fill, |
615 | const char *type_name); | |
5e777af5 ILT |
616 | |
617 | /* Fill in a DEMANGLE_COMPONENT_OPERATOR, using the name of the | |
618 | operator and the number of arguments which it takes (the latter is | |
619 | used to disambiguate operators which can be both binary and unary, | |
620 | such as '-'). Returns non-zero on success, zero if the operator is | |
621 | not recognized. */ | |
622 | ||
623 | extern int | |
9486db4f GDR |
624 | cplus_demangle_fill_operator (struct demangle_component *fill, |
625 | const char *opname, int args); | |
5e777af5 ILT |
626 | |
627 | /* Fill in a DEMANGLE_COMPONENT_EXTENDED_OPERATOR, providing the | |
628 | number of arguments and the name. Returns non-zero on success, | |
629 | zero for bad arguments. */ | |
630 | ||
631 | extern int | |
9486db4f GDR |
632 | cplus_demangle_fill_extended_operator (struct demangle_component *fill, |
633 | int numargs, | |
634 | struct demangle_component *nm); | |
5e777af5 ILT |
635 | |
636 | /* Fill in a DEMANGLE_COMPONENT_CTOR. Returns non-zero on success, | |
637 | zero for bad arguments. */ | |
638 | ||
639 | extern int | |
9486db4f GDR |
640 | cplus_demangle_fill_ctor (struct demangle_component *fill, |
641 | enum gnu_v3_ctor_kinds kind, | |
642 | struct demangle_component *name); | |
5e777af5 ILT |
643 | |
644 | /* Fill in a DEMANGLE_COMPONENT_DTOR. Returns non-zero on success, | |
645 | zero for bad arguments. */ | |
646 | ||
647 | extern int | |
9486db4f GDR |
648 | cplus_demangle_fill_dtor (struct demangle_component *fill, |
649 | enum gnu_v3_dtor_kinds kind, | |
650 | struct demangle_component *name); | |
5e777af5 ILT |
651 | |
652 | /* This function translates a mangled name into a struct | |
653 | demangle_component tree. The first argument is the mangled name. | |
654 | The second argument is DMGL_* options. This returns a pointer to a | |
655 | tree on success, or NULL on failure. On success, the third | |
656 | argument is set to a block of memory allocated by malloc. This | |
657 | block should be passed to free when the tree is no longer | |
658 | needed. */ | |
659 | ||
660 | extern struct demangle_component * | |
9486db4f | 661 | cplus_demangle_v3_components (const char *mangled, int options, void **mem); |
5e777af5 ILT |
662 | |
663 | /* This function takes a struct demangle_component tree and returns | |
664 | the corresponding demangled string. The first argument is DMGL_* | |
665 | options. The second is the tree to demangle. The third is a guess | |
666 | at the length of the demangled string, used to initially allocate | |
667 | the return buffer. The fourth is a pointer to a size_t. On | |
668 | success, this function returns a buffer allocated by malloc(), and | |
669 | sets the size_t pointed to by the fourth argument to the size of | |
670 | the allocated buffer (not the length of the returned string). On | |
671 | failure, this function returns NULL, and sets the size_t pointed to | |
672 | by the fourth argument to 0 for an invalid tree, or to 1 for a | |
673 | memory allocation error. */ | |
674 | ||
675 | extern char * | |
9486db4f | 676 | cplus_demangle_print (int options, |
a46586c3 | 677 | struct demangle_component *tree, |
9486db4f GDR |
678 | int estimated_length, |
679 | size_t *p_allocated_size); | |
5e777af5 | 680 | |
456cc5cf SB |
681 | /* This function takes a struct demangle_component tree and passes back |
682 | a demangled string in one or more calls to a callback function. | |
683 | The first argument is DMGL_* options. The second is the tree to | |
684 | demangle. The third is a pointer to a callback function; on each call | |
685 | this receives an element of the demangled string, its length, and an | |
686 | opaque value. The fourth is the opaque value passed to the callback. | |
687 | The callback is called once or more to return the full demangled | |
688 | string. The demangled element string is always nul-terminated, though | |
689 | its length is also provided for convenience. In contrast to | |
690 | cplus_demangle_print(), this function does not allocate heap memory | |
691 | to grow output strings (except perhaps where alloca() is implemented | |
692 | by malloc()), and so is normally safe for use where the heap has been | |
693 | corrupted. On success, this function returns 1; on failure, 0. */ | |
694 | ||
695 | extern int | |
696 | cplus_demangle_print_callback (int options, | |
a46586c3 | 697 | struct demangle_component *tree, |
456cc5cf SB |
698 | demangle_callbackref callback, void *opaque); |
699 | ||
513dab32 L |
700 | #ifdef __cplusplus |
701 | } | |
702 | #endif /* __cplusplus */ | |
703 | ||
6599da04 | 704 | #endif /* DEMANGLE_H */ |