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