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