coregrind/m_demangle/demangle.h

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