1 /* Demangler for IA64 / g++ standard C++ ABI.
2 Copyright (C) 2000 CodeSourcery LLC.
3 Written by Alex Samuel <samuel@codesourcery.com>.
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 2 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
20 /* This file implements demangling of C++ names mangled according to
21 the IA64 / g++ standard C++ ABI. Use the cp_demangle function to
22 demangle a mangled name, or compile with the preprocessor macro
23 STANDALONE_DEMANGLER defined to create a demangling filter
41 #include "libiberty.h"
42 #include "dyn-string.h"
45 /* If CP_DEMANGLE_DEBUG is defined, a trace of the grammar evaluation,
46 and other debugging output, will be generated. */
47 #ifdef CP_DEMANGLE_DEBUG
48 #define DEMANGLE_TRACE(PRODUCTION, DM) \
49 fprintf (stderr, " -> %-24s at position %3d\n", \
50 (PRODUCTION), current_position (DM));
52 #define DEMANGLE_TRACE(PRODUCTION, DM)
55 /* Don't include <ctype.h>, to prevent additional unresolved symbols
56 from being dragged into the C++ runtime library. */
57 #define IS_DIGIT(CHAR) ((CHAR) >= '0' && (CHAR) <= '9')
58 #define IS_ALPHA(CHAR) \
59 (((CHAR) >= 'a' && (CHAR) <= 'z') \
60 || ((CHAR) >= 'A' && (CHAR) <= 'Z'))
62 /* If flag_verbose is zero, some simplifications will be made to the
63 output to make it easier to read and supress details that are
64 generally not of interest to the average C++ programmer.
65 Otherwise, the demangled representation will attempt to convey as
66 much information as the mangled form. */
67 static int flag_verbose
;
69 /* If flag_strict is non-zero, demangle strictly according to the
70 specification -- don't demangle special g++ manglings. */
71 static int flag_strict
;
73 /* String_list_t is an extended form of dyn_string_t which provides a link
74 field. A string_list_t may safely be cast to and used as a
77 struct string_list_def
79 struct dyn_string string
;
80 struct string_list_def
*next
;
83 typedef struct string_list_def
*string_list_t
;
85 /* Data structure representing a potential substitution. */
87 struct substitution_def
89 /* The demangled text of the substitution. */
92 /* The template parameter that this represents, indexed from zero.
93 If this is not a template paramter number, the value is
95 int template_parm_number
;
97 /* Whether this substitution represents a template item. */
101 #define NOT_TEMPLATE_PARM (-1)
103 /* Data structure representing a template argument list. */
105 struct template_arg_list_def
107 /* The next (lower) template argument list in the stack of currently
108 active template arguments. */
109 struct template_arg_list_def
*next
;
111 /* The first element in the list of template arguments in
112 left-to-right order. */
113 string_list_t first_argument
;
115 /* The last element in the arguments lists. */
116 string_list_t last_argument
;
119 typedef struct template_arg_list_def
*template_arg_list_t
;
121 /* Data structure to maintain the state of the current demangling. */
123 struct demangling_def
125 /* The full mangled name being mangled. */
128 /* Pointer into name at the current position. */
131 /* Stack for strings containing demangled result generated so far.
132 Text is emitted to the topmost (first) string. */
133 string_list_t result
;
135 /* The number of presently available substitutions. */
136 int num_substitutions
;
138 /* The allocated size of the substitutions array. */
139 int substitutions_allocated
;
141 /* An array of available substitutions. The number of elements in
142 the array is given by num_substitions, and the allocated array
143 size in substitutions_size.
145 The most recent substition is at the end, so
147 - `S_' corresponds to substititutions[num_substitutions - 1]
148 - `S0_' corresponds to substititutions[num_substitutions - 2]
151 struct substitution_def
*substitutions
;
153 /* The stack of template argument lists. */
154 template_arg_list_t template_arg_lists
;
156 /* The most recently demangled source-name. */
157 dyn_string_t last_source_name
;
160 typedef struct demangling_def
*demangling_t
;
162 /* This type is the standard return code from most functions. Values
163 other than STATUS_OK contain descriptive messages. */
164 typedef const char *status_t
;
166 /* Special values that can be used as a status_t. */
167 #define STATUS_OK NULL
168 #define STATUS_ERROR "Error."
169 #define STATUS_UNIMPLEMENTED "Unimplemented."
170 #define STATUS_INTERNAL_ERROR "Internal error."
172 /* This status code indicates a failure in malloc or realloc. */
173 static const char* const status_allocation_failed
= "Allocation failed.";
174 #define STATUS_ALLOCATION_FAILED status_allocation_failed
176 /* Non-zero if STATUS indicates that no error has occurred. */
177 #define STATUS_NO_ERROR(STATUS) ((STATUS) == STATUS_OK)
179 /* Evaluate EXPR, which must produce a status_t. If the status code
180 indicates an error, return from the current function with that
182 #define RETURN_IF_ERROR(EXPR) \
186 if (!STATUS_NO_ERROR (s)) \
191 static status_t int_to_dyn_string
192 PARAMS ((int, dyn_string_t
));
193 static string_list_t string_list_new
195 static void string_list_delete
196 PARAMS ((string_list_t
));
197 static status_t result_close_template_list
198 PARAMS ((demangling_t
));
199 static status_t result_push
200 PARAMS ((demangling_t
));
201 static string_list_t result_pop
202 PARAMS ((demangling_t
));
203 static int substitution_start
204 PARAMS ((demangling_t
));
205 static status_t substitution_add
206 PARAMS ((demangling_t
, int, int, int));
207 static dyn_string_t substitution_get
208 PARAMS ((demangling_t
, int, int *));
209 #ifdef CP_DEMANGLE_DEBUG
210 static void substitutions_print
211 PARAMS ((demangling_t
, FILE *));
213 static template_arg_list_t template_arg_list_new
215 static void template_arg_list_delete
216 PARAMS ((template_arg_list_t
));
217 static void template_arg_list_add_arg
218 PARAMS ((template_arg_list_t
, string_list_t
));
219 static string_list_t template_arg_list_get_arg
220 PARAMS ((template_arg_list_t
, int));
221 static void push_template_arg_list
222 PARAMS ((demangling_t
, template_arg_list_t
));
223 static void pop_to_template_arg_list
224 PARAMS ((demangling_t
, template_arg_list_t
));
225 #ifdef CP_DEMANGLE_DEBUG
226 static void template_arg_list_print
227 PARAMS ((template_arg_list_t
, FILE *));
229 static template_arg_list_t current_template_arg_list
230 PARAMS ((demangling_t
));
231 static demangling_t demangling_new
232 PARAMS ((const char *));
233 static void demangling_delete
234 PARAMS ((demangling_t
));
236 /* The last character of DS. Warning: DS is evaluated twice. */
237 #define dyn_string_last_char(DS) \
238 (dyn_string_buf (DS)[dyn_string_length (DS) - 1])
240 /* Append a space character (` ') to DS if it does not already end
241 with one. Evaluates to 1 on success, or 0 on allocation failure. */
242 #define dyn_string_append_space(DS) \
243 ((dyn_string_length (DS) > 0 \
244 && dyn_string_last_char (DS) != ' ') \
245 ? dyn_string_append_char ((DS), ' ') \
248 /* Returns the index of the current position in the mangled name. */
249 #define current_position(DM) ((DM)->next - (DM)->name)
251 /* Returns the character at the current position of the mangled name. */
252 #define peek_char(DM) (*((DM)->next))
254 /* Returns the character one past the current position of the mangled
256 #define peek_char_next(DM) \
257 (peek_char (DM) == '\0' ? '\0' : (*((DM)->next + 1)))
259 /* Returns the character at the current position, and advances the
260 current position to the next character. */
261 #define next_char(DM) (*((DM)->next)++)
263 /* Returns non-zero if the current position is the end of the mangled
264 name, i.e. one past the last character. */
265 #define end_of_name_p(DM) (peek_char (DM) == '\0')
267 /* Advances the current position by one character. */
268 #define advance_char(DM) (++(DM)->next)
270 /* Returns the string containing the current demangled result. */
271 #define result_string(DM) (&(DM)->result->string)
273 /* Appends a dyn_string_t to the demangled result. */
274 #define result_append_string(DM, STRING) \
275 (dyn_string_append (&(DM)->result->string, (STRING)) \
276 ? STATUS_OK : STATUS_ALLOCATION_FAILED)
278 /* Appends NUL-terminated string CSTR to the demangled result. */
279 #define result_append(DM, CSTR) \
280 (dyn_string_append_cstr (&(DM)->result->string, (CSTR)) \
281 ? STATUS_OK : STATUS_ALLOCATION_FAILED)
283 /* Appends character CHAR to the demangled result. */
284 #define result_append_char(DM, CHAR) \
285 (dyn_string_append_char (&(DM)->result->string, (CHAR)) \
286 ? STATUS_OK : STATUS_ALLOCATION_FAILED)
288 /* The length of the current demangled result. */
289 #define result_length(DM) \
290 dyn_string_length (&(DM)->result->string)
292 /* Appends a space to the demangled result if the last character is
294 #define result_append_space(DM) \
295 (dyn_string_append_space (&(DM)->result->string) \
296 ? STATUS_OK : STATUS_ALLOCATION_FAILED)
298 /* Appends a base 10 representation of VALUE to DS. STATUS_OK on
299 success. On failure, deletes DS and returns an error code. */
302 int_to_dyn_string (value
, ds
)
309 /* Handle zero up front. */
312 if (!dyn_string_append_char (ds
, '0'))
313 return STATUS_ALLOCATION_FAILED
;
317 /* For negative numbers, emit a minus sign. */
320 if (!dyn_string_append_char (ds
, '-'))
321 return STATUS_ALLOCATION_FAILED
;
325 /* Find the power of 10 of the first digit. */
333 /* Write the digits. */
336 int digit
= value
/ mask
;
338 if (!dyn_string_append_char (ds
, '0' + digit
))
339 return STATUS_ALLOCATION_FAILED
;
341 value
-= digit
* mask
;
348 /* Creates a new string list node. The contents of the string are
349 empty, but the initial buffer allocation is LENGTH. The string
350 list node should be deleted with string_list_delete. Returns NULL
351 if allocation fails. */
354 string_list_new (length
)
357 string_list_t s
= (string_list_t
) malloc (sizeof (struct string_list_def
));
360 if (!dyn_string_init ((dyn_string_t
) s
, length
))
365 /* Deletes the entire string list starting at NODE. */
368 string_list_delete (node
)
373 string_list_t next
= node
->next
;
379 /* Appends a greater-than character to the demangled result. If the
380 last character is a greater-than character, a space is inserted
381 first, so that the two greater-than characters don't look like a
382 right shift token. */
385 result_close_template_list (dm
)
388 dyn_string_t s
= &dm
->result
->string
;
390 /* Add a space if the last character is already a closing angle
391 bracket, so that a nested template arg list doesn't look like
392 it's closed with a right-shift operator. */
393 if (dyn_string_last_char (s
) == '>')
395 if (!dyn_string_append_char (s
, ' '))
396 return STATUS_ALLOCATION_FAILED
;
399 /* Add closing angle brackets. */
400 if (!dyn_string_append_char (s
, '>'))
401 return STATUS_ALLOCATION_FAILED
;
406 /* Allocates and pushes a new string onto the demangled results stack
407 for DM. Subsequent demangling with DM will emit to the new string.
408 Returns STATUS_OK on success, STATUS_ALLOCATION_FAILED on
409 allocation failure. */
415 string_list_t new_string
= string_list_new (0);
416 if (new_string
== NULL
)
417 /* Allocation failed. */
418 return STATUS_ALLOCATION_FAILED
;
420 /* Link the new string to the front of the list of result strings. */
421 new_string
->next
= (string_list_t
) dm
->result
;
422 dm
->result
= new_string
;
426 /* Removes and returns the topmost element on the demangled results
427 stack for DM. The caller assumes ownership for the returned
434 string_list_t top
= dm
->result
;
435 dm
->result
= top
->next
;
439 /* Returns the start position of a fragment of the demangled result
440 that will be a substitution candidate. Should be called at the
441 start of productions that can add substitutions. */
444 substitution_start (dm
)
447 return result_length (dm
);
450 /* Adds the suffix of the current demangled result of DM starting at
451 START_POSITION as a potential substitution. If TEMPLATE_P is
452 non-zero, this potential substitution is a template-id.
454 If TEMPLATE_PARM_NUMBER is not NOT_TEMPLATE_PARM, the substitution
455 is for that particular <template-param>, and is distinct from other
456 otherwise-identical types and other <template-param>s with
457 different indices. */
460 substitution_add (dm
, start_position
, template_p
, template_parm_number
)
464 int template_parm_number
;
466 dyn_string_t result
= result_string (dm
);
467 dyn_string_t substitution
= dyn_string_new (0);
470 if (substitution
== NULL
)
471 return STATUS_ALLOCATION_FAILED
;
473 /* Extract the substring of the current demangling result that
474 represents the subsitution candidate. */
475 if (!dyn_string_substring (substitution
,
476 result
, start_position
, result_length (dm
)))
478 dyn_string_delete (substitution
);
479 return STATUS_ALLOCATION_FAILED
;
482 /* Check whether SUBSTITUTION already occurs. */
483 for (i
= 0; i
< dm
->num_substitutions
; ++i
)
484 if (dyn_string_eq (dm
->substitutions
[i
].text
, substitution
)
485 && dm
->substitutions
[i
].template_parm_number
== template_parm_number
)
486 /* Found SUBSTITUTION already present. */
488 /* Callers expect this function to take ownership of
489 SUBSTITUTION, so delete it. */
490 dyn_string_delete (substitution
);
494 /* If there's no room for the new entry, grow the array. */
495 if (dm
->substitutions_allocated
== dm
->num_substitutions
)
497 size_t new_array_size
;
498 dm
->substitutions_allocated
*= 2;
500 sizeof (struct substitution_def
) * dm
->substitutions_allocated
;
502 dm
->substitutions
= (struct substitution_def
*)
503 realloc (dm
->substitutions
, new_array_size
);
504 if (dm
->substitutions
== NULL
)
505 /* Realloc failed. */
507 dyn_string_delete (substitution
);
508 return STATUS_ALLOCATION_FAILED
;
512 /* Add the substitution to the array. */
513 dm
->substitutions
[i
].text
= substitution
;
514 dm
->substitutions
[i
].template_p
= template_p
;
515 dm
->substitutions
[i
].template_parm_number
= template_parm_number
;
516 ++dm
->num_substitutions
;
518 #ifdef CP_DEMANGLE_DEBUG
519 substitutions_print (dm
, stderr
);
525 /* Returns the Nth-most-recent substitution. Sets *TEMPLATE_P to
526 non-zero if the substitution is a template-id, zero otherwise.
527 N is numbered from zero. DM retains ownership of the returned
528 string. If N is negative, or equal to or greater than the current
529 number of substitution candidates, returns NULL. */
532 substitution_get (dm
, n
, template_p
)
537 struct substitution_def
*sub
;
539 /* Make sure N is in the valid range. */
540 if (n
< 0 || n
>= dm
->num_substitutions
)
543 sub
= &(dm
->substitutions
[n
]);
544 *template_p
= sub
->template_p
;
548 #ifdef CP_DEMANGLE_DEBUG
549 /* Debugging routine to print the current substitutions to FP. */
552 substitutions_print (dm
, fp
)
557 int num
= dm
->num_substitutions
;
559 fprintf (fp
, "SUBSTITUTIONS:\n");
560 for (seq_id
= -1; seq_id
< num
- 1; ++seq_id
)
563 dyn_string_t text
= substitution_get (dm
, seq_id
+ 1, &template_p
);
566 fprintf (fp
, " S_ ");
568 fprintf (fp
, " S%d_", seq_id
);
569 fprintf (fp
, " %c: %s\n", template_p
? '*' : ' ', dyn_string_buf (text
));
573 #endif /* CP_DEMANGLE_DEBUG */
575 /* Creates a new template argument list. Returns NULL if allocation
578 static template_arg_list_t
579 template_arg_list_new ()
581 template_arg_list_t new_list
=
582 (template_arg_list_t
) malloc (sizeof (struct template_arg_list_def
));
583 if (new_list
== NULL
)
585 /* Initialize the new list to have no arguments. */
586 new_list
->first_argument
= NULL
;
587 new_list
->last_argument
= NULL
;
588 /* Return the new list. */
592 /* Deletes a template argument list and the template arguments it
596 template_arg_list_delete (list
)
597 template_arg_list_t list
;
599 /* If there are any arguments on LIST, delete them. */
600 if (list
->first_argument
!= NULL
)
601 string_list_delete (list
->first_argument
);
606 /* Adds ARG to the template argument list ARG_LIST. */
609 template_arg_list_add_arg (arg_list
, arg
)
610 template_arg_list_t arg_list
;
613 if (arg_list
->first_argument
== NULL
)
614 /* If there were no arguments before, ARG is the first one. */
615 arg_list
->first_argument
= arg
;
617 /* Make ARG the last argument on the list. */
618 arg_list
->last_argument
->next
= arg
;
619 /* Make ARG the last on the list. */
620 arg_list
->last_argument
= arg
;
624 /* Returns the template arugment at position INDEX in template
625 argument list ARG_LIST. */
628 template_arg_list_get_arg (arg_list
, index
)
629 template_arg_list_t arg_list
;
632 string_list_t arg
= arg_list
->first_argument
;
633 /* Scan down the list of arguments to find the one at position
639 /* Ran out of arguments before INDEX hit zero. That's an
643 /* Return the argument at position INDEX. */
647 /* Pushes ARG_LIST onto the top of the template argument list stack. */
650 push_template_arg_list (dm
, arg_list
)
652 template_arg_list_t arg_list
;
654 arg_list
->next
= dm
->template_arg_lists
;
655 dm
->template_arg_lists
= arg_list
;
656 #ifdef CP_DEMANGLE_DEBUG
657 fprintf (stderr
, " ** pushing template arg list\n");
658 template_arg_list_print (arg_list
, stderr
);
662 /* Pops and deletes elements on the template argument list stack until
663 arg_list is the topmost element. If arg_list is NULL, all elements
664 are popped and deleted. */
667 pop_to_template_arg_list (dm
, arg_list
)
669 template_arg_list_t arg_list
;
671 while (dm
->template_arg_lists
!= arg_list
)
673 template_arg_list_t top
= dm
->template_arg_lists
;
674 /* Disconnect the topmost element from the list. */
675 dm
->template_arg_lists
= top
->next
;
676 /* Delete the popped element. */
677 template_arg_list_delete (top
);
678 #ifdef CP_DEMANGLE_DEBUG
679 fprintf (stderr
, " ** removing template arg list\n");
684 #ifdef CP_DEMANGLE_DEBUG
686 /* Prints the contents of ARG_LIST to FP. */
689 template_arg_list_print (arg_list
, fp
)
690 template_arg_list_t arg_list
;
696 fprintf (fp
, "TEMPLATE ARGUMENT LIST:\n");
697 for (arg
= arg_list
->first_argument
; arg
!= NULL
; arg
= arg
->next
)
700 fprintf (fp
, " T_ : ");
702 fprintf (fp
, " T%d_ : ", index
);
704 fprintf (fp
, "%s\n", dyn_string_buf ((dyn_string_t
) arg
));
708 #endif /* CP_DEMANGLE_DEBUG */
710 /* Returns the topmost element on the stack of template argument
711 lists. If there is no list of template arguments, returns NULL. */
713 static template_arg_list_t
714 current_template_arg_list (dm
)
717 return dm
->template_arg_lists
;
720 /* Allocates a demangling_t object for demangling mangled NAME. A new
721 result must be pushed before the returned object can be used.
722 Returns NULL if allocation fails. */
725 demangling_new (name
)
729 dm
= (demangling_t
) malloc (sizeof (struct demangling_def
));
736 dm
->num_substitutions
= 0;
737 dm
->substitutions_allocated
= 10;
738 dm
->template_arg_lists
= NULL
;
739 dm
->last_source_name
= dyn_string_new (0);
740 if (dm
->last_source_name
== NULL
)
742 dm
->substitutions
= (struct substitution_def
*)
743 malloc (dm
->substitutions_allocated
* sizeof (struct substitution_def
));
744 if (dm
->substitutions
== NULL
)
746 dyn_string_delete (dm
->last_source_name
);
753 /* Deallocates a demangling_t object and all memory associated with
757 demangling_delete (dm
)
761 template_arg_list_t arg_list
= dm
->template_arg_lists
;
763 /* Delete the stack of template argument lists. */
764 while (arg_list
!= NULL
)
766 template_arg_list_t next
= arg_list
->next
;
767 template_arg_list_delete (arg_list
);
770 /* Delete the list of substitutions. */
771 for (i
= dm
->num_substitutions
; --i
>= 0; )
772 dyn_string_delete (dm
->substitutions
[i
].text
);
773 free (dm
->substitutions
);
774 /* Delete the demangled result. */
775 string_list_delete (dm
->result
);
776 /* Delete the stored identifier name. */
777 dyn_string_delete (dm
->last_source_name
);
778 /* Delete the context object itself. */
782 /* These functions demangle an alternative of the corresponding
783 production in the mangling spec. The first argument of each is a
784 demangling context structure for the current demangling
785 operation. Most emit demangled text directly to the topmost result
786 string on the result string stack in the demangling context
789 static status_t demangle_char
790 PARAMS ((demangling_t
, int));
791 static status_t demangle_mangled_name
792 PARAMS ((demangling_t
));
793 static status_t demangle_encoding
794 PARAMS ((demangling_t
));
795 static status_t demangle_name
796 PARAMS ((demangling_t
, int *));
797 static status_t demangle_nested_name
798 PARAMS ((demangling_t
, int *));
799 static status_t demangle_prefix
800 PARAMS ((demangling_t
, int *));
801 static status_t demangle_unqualified_name
802 PARAMS ((demangling_t
));
803 static status_t demangle_source_name
804 PARAMS ((demangling_t
));
805 static status_t demangle_number
806 PARAMS ((demangling_t
, int *, int, int));
807 static status_t demangle_number_literally
808 PARAMS ((demangling_t
, dyn_string_t
, int, int));
809 static status_t demangle_identifier
810 PARAMS ((demangling_t
, int, dyn_string_t
));
811 static status_t demangle_operator_name
812 PARAMS ((demangling_t
, int, int *));
813 static status_t demangle_special_name
814 PARAMS ((demangling_t
));
815 static status_t demangle_ctor_dtor_name
816 PARAMS ((demangling_t
));
817 static status_t demangle_type_ptr
818 PARAMS ((demangling_t
));
819 static status_t demangle_type
820 PARAMS ((demangling_t
));
821 static status_t demangle_CV_qualifiers
822 PARAMS ((demangling_t
, dyn_string_t
));
823 static status_t demangle_builtin_type
824 PARAMS ((demangling_t
));
825 static status_t demangle_function_type
826 PARAMS ((demangling_t
, int));
827 static status_t demangle_bare_function_type
828 PARAMS ((demangling_t
, int));
829 static status_t demangle_class_enum_type
830 PARAMS ((demangling_t
, int *));
831 static status_t demangle_array_type
832 PARAMS ((demangling_t
));
833 static status_t demangle_template_param
834 PARAMS ((demangling_t
, int *));
835 static status_t demangle_template_args
836 PARAMS ((demangling_t
));
837 static status_t demangle_literal
838 PARAMS ((demangling_t
));
839 static status_t demangle_template_arg
840 PARAMS ((demangling_t
));
841 static status_t demangle_expression
842 PARAMS ((demangling_t
));
843 static status_t demangle_scope_expression
844 PARAMS ((demangling_t
));
845 static status_t demangle_expr_primary
846 PARAMS ((demangling_t
));
847 static status_t demangle_substitution
848 PARAMS ((demangling_t
, int *, int *));
849 static status_t demangle_local_name
850 PARAMS ((demangling_t
));
851 static status_t demangle_discriminator
852 PARAMS ((demangling_t
, int));
853 static status_t cp_demangle
854 PARAMS ((const char *, dyn_string_t
));
856 static status_t cp_demangle_type
857 PARAMS ((const char*, dyn_string_t
));
860 /* When passed to demangle_bare_function_type, indicates that the
861 function's return type is not encoded before its parameter types. */
862 #define BFT_NO_RETURN_TYPE -1
864 /* Check that the next character is C. If so, consume it. If not,
868 demangle_char (dm
, c
)
872 static char *error_message
= NULL
;
874 if (peek_char (dm
) == c
)
881 if (error_message
== NULL
)
882 error_message
= strdup ("Expected ?");
883 error_message
[9] = c
;
884 return error_message
;
888 /* Demangles and emits a <mangled-name>.
890 <mangled-name> ::= _Z <encoding> */
893 demangle_mangled_name (dm
)
896 DEMANGLE_TRACE ("mangled-name", dm
);
897 RETURN_IF_ERROR (demangle_char (dm
, '_'));
898 RETURN_IF_ERROR (demangle_char (dm
, 'Z'));
899 RETURN_IF_ERROR (demangle_encoding (dm
));
903 /* Demangles and emits an <encoding>.
905 <encoding> ::= <function name> <bare-function-type>
907 ::= <special-name> */
910 demangle_encoding (dm
)
915 template_arg_list_t old_arg_list
= current_template_arg_list (dm
);
916 char peek
= peek_char (dm
);
918 DEMANGLE_TRACE ("encoding", dm
);
920 /* Remember where the name starts. If it turns out to be a template
921 function, we'll have to insert the return type here. */
922 start_position
= result_length (dm
);
924 if (peek
== 'G' || peek
== 'T')
925 RETURN_IF_ERROR (demangle_special_name (dm
));
928 /* Now demangle the name. */
929 RETURN_IF_ERROR (demangle_name (dm
, &template_p
));
931 /* If there's anything left, the name was a function name, with
932 maybe its return type, and its parameters types, following. */
933 if (!end_of_name_p (dm
)
934 && peek_char (dm
) != 'E')
937 /* Template functions have their return type encoded. The
938 return type should be inserted at start_position. */
940 (demangle_bare_function_type (dm
, start_position
));
942 /* Non-template functions don't have their return type
945 (demangle_bare_function_type (dm
, BFT_NO_RETURN_TYPE
));
949 /* Pop off template argument lists that were built during the
950 mangling of this name, to restore the old template context. */
951 pop_to_template_arg_list (dm
, old_arg_list
);
956 /* Demangles and emits a <name>.
958 <name> ::= <unscoped-name>
959 ::= <unscoped-template-name> <template-args>
963 <unscoped-name> ::= <unqualified-name>
964 ::= St <unqualified-name> # ::std::
966 <unscoped-template-name>
968 ::= <substitution> */
971 demangle_name (dm
, template_p
)
975 int special_std_substitution
;
976 int start
= substitution_start (dm
);
978 DEMANGLE_TRACE ("name", dm
);
980 switch (peek_char (dm
))
983 /* This is a <nested-name>. */
984 RETURN_IF_ERROR (demangle_nested_name (dm
, template_p
));
988 RETURN_IF_ERROR (demangle_local_name (dm
));
992 /* The `St' substitution allows a name nested in std:: to appear
993 without being enclosed in a nested name. */
994 if (peek_char_next (dm
) == 't')
996 (void) next_char (dm
);
997 (void) next_char (dm
);
998 RETURN_IF_ERROR (result_append (dm
, "std::"));
999 RETURN_IF_ERROR (demangle_unqualified_name (dm
));
1003 RETURN_IF_ERROR (demangle_substitution (dm
, template_p
,
1004 &special_std_substitution
));
1005 if (special_std_substitution
)
1007 /* This was the magic `std::' substitution. We can have
1008 a <nested-name> or one of the unscoped names
1010 RETURN_IF_ERROR (result_append (dm
, "::"));
1011 RETURN_IF_ERROR (demangle_name (dm
, template_p
));
1014 /* Check if a template argument list immediately follows.
1015 If so, then we just demangled an <unqualified-template-name>. */
1016 if (peek_char (dm
) == 'I')
1018 RETURN_IF_ERROR (substitution_add (dm
, start
, 0,
1019 NOT_TEMPLATE_PARM
));
1020 RETURN_IF_ERROR (demangle_template_args (dm
));
1025 /* This is an <unscoped-name> or <unscoped-template-name>. */
1026 RETURN_IF_ERROR (demangle_unqualified_name (dm
));
1028 /* If the <unqualified-name> is followed by template args, this
1029 is an <unscoped-template-name>. */
1030 if (peek_char (dm
) == 'I')
1032 /* Add a substitution for the unqualified template name. */
1033 RETURN_IF_ERROR (substitution_add (dm
, start
, 0,
1034 NOT_TEMPLATE_PARM
));
1036 RETURN_IF_ERROR (demangle_template_args (dm
));
1048 /* Demangles and emits a <nested-name>.
1050 <nested-name> ::= N [<CV-qualifiers>] <prefix> <component> E */
1053 demangle_nested_name (dm
, template_p
)
1059 DEMANGLE_TRACE ("nested-name", dm
);
1061 RETURN_IF_ERROR (demangle_char (dm
, 'N'));
1063 peek
= peek_char (dm
);
1064 if (peek
== 'r' || peek
== 'V' || peek
== 'K')
1068 /* Snarf up and emit CV qualifiers. */
1069 dyn_string_t cv_qualifiers
= dyn_string_new (24);
1070 if (cv_qualifiers
== NULL
)
1071 return STATUS_ALLOCATION_FAILED
;
1073 demangle_CV_qualifiers (dm
, cv_qualifiers
);
1074 status
= result_append_string (dm
, cv_qualifiers
);
1075 dyn_string_delete (cv_qualifiers
);
1076 RETURN_IF_ERROR (status
);
1077 RETURN_IF_ERROR (result_append_space (dm
));
1080 RETURN_IF_ERROR (demangle_prefix (dm
, template_p
));
1081 /* No need to demangle the final <component>; demangle_prefix will
1083 RETURN_IF_ERROR (demangle_char (dm
, 'E'));
1088 /* Demangles and emits a <prefix>.
1090 <prefix> ::= <prefix> <component>
1091 ::= <template-prefix> <template-args>
1095 <template-prefix> ::= <prefix>
1098 <component> ::= <unqualified-name>
1102 demangle_prefix (dm
, template_p
)
1106 int start
= substitution_start (dm
);
1109 /* TEMPLATE_P is updated as we decend the nesting chain. After
1110 <template-args>, it is set to non-zero; after everything else it
1113 DEMANGLE_TRACE ("prefix", dm
);
1120 if (end_of_name_p (dm
))
1121 return "Unexpected end of name in <compound-name>.";
1123 peek
= peek_char (dm
);
1125 if (IS_DIGIT ((unsigned char) peek
)
1126 || (peek
>= 'a' && peek
<= 'z')
1127 || peek
== 'C' || peek
== 'D'
1130 /* We have another level of scope qualification. */
1132 RETURN_IF_ERROR (result_append (dm
, "::"));
1137 /* The substitution determines whether this is a
1139 RETURN_IF_ERROR (demangle_substitution (dm
, template_p
,
1143 RETURN_IF_ERROR (demangle_unqualified_name (dm
));
1147 else if (peek
== 'Z')
1148 RETURN_IF_ERROR (demangle_local_name (dm
));
1149 else if (peek
== 'I')
1152 return STATUS_INTERNAL_ERROR
;
1153 /* The template name is a substitution candidate. */
1154 RETURN_IF_ERROR (substitution_add (dm
, start
, 0, NOT_TEMPLATE_PARM
));
1155 RETURN_IF_ERROR (demangle_template_args (dm
));
1158 else if (peek
== 'E')
1162 return "Unexpected character in <compound-name>.";
1164 /* Add a new substitution for the prefix thus far. */
1165 RETURN_IF_ERROR (substitution_add (dm
, start
, *template_p
,
1166 NOT_TEMPLATE_PARM
));
1170 /* Demangles and emits an <unqualified-name>. If the
1171 <unqualified-name> is a function and the first element in the
1172 argument list should be taken to be its return type,
1173 ENCODE_RETURN_TYPE is non-zero.
1175 <unqualified-name> ::= <operator-name>
1177 ::= <source-name> */
1180 demangle_unqualified_name (dm
)
1183 char peek
= peek_char (dm
);
1185 DEMANGLE_TRACE ("unqualified-name", dm
);
1187 if (IS_DIGIT ((unsigned char) peek
))
1188 RETURN_IF_ERROR (demangle_source_name (dm
));
1189 else if (peek
>= 'a' && peek
<= 'z')
1192 RETURN_IF_ERROR (demangle_operator_name (dm
, 0, &num_args
));
1194 else if (peek
== 'C' || peek
== 'D')
1195 RETURN_IF_ERROR (demangle_ctor_dtor_name (dm
));
1197 return "Unexpected character in <unqualified-name>.";
1202 /* Demangles and emits <source-name>.
1204 <source-name> ::= <length number> <identifier> */
1207 demangle_source_name (dm
)
1212 DEMANGLE_TRACE ("source-name", dm
);
1214 /* Decode the length of the identifier. */
1215 RETURN_IF_ERROR (demangle_number (dm
, &length
, 10, 0));
1217 return "Zero length in <source-name>.";
1219 /* Now the identifier itself. It's placed into last_source_name,
1220 where it can be used to build a constructor or destructor name. */
1221 RETURN_IF_ERROR (demangle_identifier (dm
, length
,
1222 dm
->last_source_name
));
1225 RETURN_IF_ERROR (result_append_string (dm
, dm
->last_source_name
));
1230 /* Demangles a number, either a <number> or a <positive-number> at the
1231 current position, consuming all consecutive digit characters. Sets
1232 *VALUE to the resulting numberand returns STATUS_OK. The number is
1233 interpreted as BASE, which must be either 10 or 36. If IS_SIGNED
1234 is non-zero, negative numbers -- prefixed with `n' -- are accepted.
1236 <number> ::= [n] <positive-number>
1238 <positive-number> ::= <decimal integer> */
1241 demangle_number (dm
, value
, base
, is_signed
)
1247 dyn_string_t number
= dyn_string_new (10);
1249 DEMANGLE_TRACE ("number", dm
);
1252 return STATUS_ALLOCATION_FAILED
;
1254 demangle_number_literally (dm
, number
, base
, is_signed
);
1255 *value
= strtol (dyn_string_buf (number
), NULL
, base
);
1256 dyn_string_delete (number
);
1261 /* Demangles a number at the current position. The digits (and minus
1262 sign, if present) that make up the number are appended to STR.
1263 Only base-BASE digits are accepted; BASE must be either 10 or 36.
1264 If IS_SIGNED, negative numbers -- prefixed with `n' -- are
1265 accepted. Does not consume a trailing underscore or other
1266 terminating character. */
1269 demangle_number_literally (dm
, str
, base
, is_signed
)
1275 DEMANGLE_TRACE ("number*", dm
);
1277 if (base
!= 10 && base
!= 36)
1278 return STATUS_INTERNAL_ERROR
;
1280 /* An `n' denotes a negative number. */
1281 if (is_signed
&& peek_char (dm
) == 'n')
1283 /* Skip past the n. */
1285 /* The normal way to write a negative number is with a minus
1287 if (!dyn_string_append_char (str
, '-'))
1288 return STATUS_ALLOCATION_FAILED
;
1291 /* Loop until we hit a non-digit. */
1294 char peek
= peek_char (dm
);
1295 if (IS_DIGIT ((unsigned char) peek
)
1296 || (base
== 36 && peek
>= 'A' && peek
<= 'Z'))
1298 /* Accumulate digits. */
1299 if (!dyn_string_append_char (str
, next_char (dm
)))
1300 return STATUS_ALLOCATION_FAILED
;
1303 /* Not a digit? All done. */
1310 /* Demangles an identifier at the current position of LENGTH
1311 characters and places it in IDENTIFIER. */
1314 demangle_identifier (dm
, length
, identifier
)
1317 dyn_string_t identifier
;
1319 DEMANGLE_TRACE ("identifier", dm
);
1321 dyn_string_clear (identifier
);
1322 if (!dyn_string_resize (identifier
, length
))
1323 return STATUS_ALLOCATION_FAILED
;
1325 while (length
-- > 0)
1327 if (end_of_name_p (dm
))
1328 return "Unexpected end of name in <identifier>.";
1329 if (!dyn_string_append_char (identifier
, next_char (dm
)))
1330 return STATUS_ALLOCATION_FAILED
;
1336 /* Demangles and emits an <operator-name>. If SHORT_NAME is non-zero,
1337 the short form is emitted; otherwise the full source form
1338 (`operator +' etc.) is emitted. *NUM_ARGS is set to the number of
1339 operands that the operator takes.
1390 ::= cv <type> # cast
1391 ::= vx <source-name> # vendor extended operator */
1394 demangle_operator_name (dm
, short_name
, num_args
)
1399 struct operator_code
1401 /* The mangled code for this operator. */
1403 /* The source name of this operator. */
1405 /* The number of arguments this operator takes. */
1409 static const struct operator_code operators
[] =
1420 { "da", " delete[]", 1 },
1422 { "dl", " delete" , 1 },
1430 { "lS", "<<=" , 2 },
1439 { "na", " new[]" , 1 },
1443 { "nw", " new" , 1 },
1449 { "pm", "->*" , 2 },
1454 { "rS", ">>=" , 2 },
1457 { "sz", " sizeof" , 1 }
1460 const int num_operators
=
1461 sizeof (operators
) / sizeof (struct operator_code
);
1463 int c0
= next_char (dm
);
1464 int c1
= next_char (dm
);
1465 const struct operator_code
* p1
= operators
;
1466 const struct operator_code
* p2
= operators
+ num_operators
;
1468 DEMANGLE_TRACE ("operator-name", dm
);
1470 /* Is this a vendor extended operator? */
1471 if (c0
== 'v' && c1
== 'x')
1473 RETURN_IF_ERROR (result_append (dm
, "operator"));
1474 RETURN_IF_ERROR (demangle_source_name (dm
));
1479 /* Is this a conversion operator? */
1480 if (c0
== 'c' && c1
== 'v')
1482 RETURN_IF_ERROR (result_append (dm
, "operator "));
1483 /* Demangle the converted-to type. */
1484 RETURN_IF_ERROR (demangle_type (dm
));
1489 /* Perform a binary search for the operator code. */
1492 const struct operator_code
* p
= p1
+ (p2
- p1
) / 2;
1493 char match0
= p
->code
[0];
1494 char match1
= p
->code
[1];
1496 if (c0
== match0
&& c1
== match1
)
1500 RETURN_IF_ERROR (result_append (dm
, "operator"));
1501 RETURN_IF_ERROR (result_append (dm
, p
->name
));
1502 *num_args
= p
->num_args
;
1508 /* Couldn't find it. */
1509 return "Unknown code in <operator-name>.";
1512 if (c0
< match0
|| (c0
== match0
&& c1
< match1
))
1519 /* Demangles and emits a <special-name>.
1521 <special-name> ::= GV <object name> # Guard variable
1522 ::= Th[n] <offset number> _ <base name> <base encoding>
1523 # non-virtual base override thunk
1524 ::= Tv[n] <offset number> _ <vcall offset number>
1526 # virtual base override thunk
1527 ::= TV <type> # virtual table
1529 ::= TI <type> # typeinfo structure
1530 ::= TS <type> # typeinfo name
1532 Also demangles the special g++ manglings,
1534 <special-name> ::= CT <type> <offset number> _ <base type>
1535 # construction vtable
1536 ::= TF <type> # typeinfo function (old ABI only)
1537 ::= TJ <type> # java Class structure */
1540 demangle_special_name (dm
)
1543 dyn_string_t number
;
1545 char peek
= peek_char (dm
);
1547 DEMANGLE_TRACE ("special-name", dm
);
1551 /* A guard variable name. Consume the G. */
1553 RETURN_IF_ERROR (demangle_char (dm
, 'V'));
1554 RETURN_IF_ERROR (result_append (dm
, "guard variable for "));
1555 RETURN_IF_ERROR (demangle_name (dm
, &unused
));
1557 else if (peek
== 'T')
1559 status_t status
= STATUS_OK
;
1561 /* Other C++ implementation miscellania. Consume the T. */
1564 switch (peek_char (dm
))
1567 /* Virtual table. */
1569 RETURN_IF_ERROR (result_append (dm
, "vtable for "));
1570 RETURN_IF_ERROR (demangle_type (dm
));
1574 /* VTT structure. */
1576 RETURN_IF_ERROR (result_append (dm
, "VTT for "));
1577 RETURN_IF_ERROR (demangle_type (dm
));
1581 /* Typeinfo structure. */
1583 RETURN_IF_ERROR (result_append (dm
, "typeinfo for "));
1584 RETURN_IF_ERROR (demangle_type (dm
));
1588 /* Typeinfo function. Used only in old ABI with new mangling. */
1590 RETURN_IF_ERROR (result_append (dm
, "typeinfo fn for "));
1591 RETURN_IF_ERROR (demangle_type (dm
));
1595 /* Character string containing type name, used in typeinfo. */
1597 RETURN_IF_ERROR (result_append (dm
, "typeinfo name for "));
1598 RETURN_IF_ERROR (demangle_type (dm
));
1602 /* The java Class variable corresponding to a C++ class. */
1604 RETURN_IF_ERROR (result_append (dm
, "java Class for "));
1605 RETURN_IF_ERROR (demangle_type (dm
));
1609 /* Non-virtual thunk. */
1611 RETURN_IF_ERROR (result_append (dm
, "non-virtual thunk"));
1612 /* Demangle and emit the offset. */
1613 number
= dyn_string_new (4);
1615 return STATUS_ALLOCATION_FAILED
;
1616 demangle_number_literally (dm
, number
, 10, 1);
1617 /* Don't display the offset unless in verbose mode. */
1620 status
= result_append_char (dm
, ' ');
1621 if (STATUS_NO_ERROR (status
))
1622 status
= result_append_string (dm
, number
);
1624 dyn_string_delete (number
);
1625 RETURN_IF_ERROR (status
);
1626 /* Demangle the separator. */
1627 RETURN_IF_ERROR (demangle_char (dm
, '_'));
1628 /* Demangle and emit the target name and function type. */
1629 RETURN_IF_ERROR (result_append (dm
, " to "));
1630 RETURN_IF_ERROR (demangle_encoding (dm
));
1634 /* Virtual thunk. */
1636 RETURN_IF_ERROR (result_append (dm
, "virtual thunk "));
1637 /* Demangle and emit the offset. */
1638 number
= dyn_string_new (4);
1640 return STATUS_ALLOCATION_FAILED
;
1641 demangle_number_literally (dm
, number
, 10, 1);
1642 /* Don't display the offset unless in verbose mode. */
1645 status
= result_append_string (dm
, number
);
1646 if (STATUS_NO_ERROR (status
))
1647 result_append_char (dm
, ' ');
1649 dyn_string_delete (number
);
1650 RETURN_IF_ERROR (status
);
1651 /* Demangle the separator. */
1652 RETURN_IF_ERROR (demangle_char (dm
, '_'));
1653 /* Demangle and emit the vcall offset. */
1654 number
= dyn_string_new (4);
1656 return STATUS_ALLOCATION_FAILED
;
1657 demangle_number_literally (dm
, number
, 10, 1);
1658 /* Don't display the vcall offset unless in verbose mode. */
1661 status
= result_append_string (dm
, number
);
1662 if (STATUS_NO_ERROR (status
))
1663 status
= result_append_char (dm
, ' ');
1665 dyn_string_delete (number
);
1666 RETURN_IF_ERROR (status
);
1667 /* Demangle the separator. */
1668 RETURN_IF_ERROR (demangle_char (dm
, '_'));
1669 /* Demangle and emit the target function. */
1670 RETURN_IF_ERROR (result_append (dm
, "to "));
1671 RETURN_IF_ERROR (demangle_encoding (dm
));
1675 /* TC is a special g++ mangling for a construction vtable. */
1678 dyn_string_t derived_type
;
1681 RETURN_IF_ERROR (result_append (dm
, "construction vtable for "));
1683 /* Demangle the derived type off to the side. */
1684 RETURN_IF_ERROR (result_push (dm
));
1685 RETURN_IF_ERROR (demangle_type (dm
));
1686 derived_type
= (dyn_string_t
) result_pop (dm
);
1688 /* Demangle the offset. */
1689 number
= dyn_string_new (4);
1692 dyn_string_delete (derived_type
);
1693 return STATUS_ALLOCATION_FAILED
;
1695 demangle_number_literally (dm
, number
, 10, 1);
1696 /* Demangle the underscore separator. */
1697 status
= demangle_char (dm
, '_');
1699 /* Demangle the base type. */
1700 if (STATUS_NO_ERROR (status
))
1701 status
= demangle_type (dm
);
1703 /* Emit the derived type. */
1704 if (STATUS_NO_ERROR (status
))
1705 status
= result_append (dm
, "-in-");
1706 if (STATUS_NO_ERROR (status
))
1707 status
= result_append_string (dm
, derived_type
);
1708 dyn_string_delete (derived_type
);
1710 /* Don't display the offset unless in verbose mode. */
1713 status
= result_append_char (dm
, ' ');
1714 if (STATUS_NO_ERROR (status
))
1715 result_append_string (dm
, number
);
1717 dyn_string_delete (number
);
1718 RETURN_IF_ERROR (status
);
1721 /* If flag_strict, fall through. */
1724 return "Unrecognized <special-name>.";
1728 return STATUS_ERROR
;
1733 /* Demangles and emits a <ctor-dtor-name>.
1736 ::= C1 # complete object (in-charge) ctor
1737 ::= C2 # base object (not-in-charge) ctor
1738 ::= C3 # complete object (in-charge) allocating ctor
1739 ::= C4 # base object (not-in-charge) allocating ctor
1740 ::= D0 # deleting (in-charge) dtor
1741 ::= D1 # complete object (in-charge) dtor
1742 ::= D2 # base object (not-in-charge) dtor */
1745 demangle_ctor_dtor_name (dm
)
1748 static const char *const ctor_flavors
[] =
1752 "in-charge allocating",
1753 "not-in-charge allocating"
1755 static const char *const dtor_flavors
[] =
1757 "in-charge deleting",
1763 char peek
= peek_char (dm
);
1765 DEMANGLE_TRACE ("ctor-dtor-name", dm
);
1769 /* A constructor name. Consume the C. */
1771 if (peek_char (dm
) < '1' || peek_char (dm
) > '4')
1772 return "Unrecognized constructor.";
1773 RETURN_IF_ERROR (result_append_string (dm
, dm
->last_source_name
));
1774 /* Print the flavor of the constructor if in verbose mode. */
1775 flavor
= next_char (dm
) - '1';
1778 RETURN_IF_ERROR (result_append (dm
, "["));
1779 RETURN_IF_ERROR (result_append (dm
, ctor_flavors
[flavor
]));
1780 RETURN_IF_ERROR (result_append_char (dm
, ']'));
1783 else if (peek
== 'D')
1785 /* A destructor name. Consume the D. */
1787 if (peek_char (dm
) < '0' || peek_char (dm
) > '2')
1788 return "Unrecognized destructor.";
1789 RETURN_IF_ERROR (result_append_char (dm
, '~'));
1790 RETURN_IF_ERROR (result_append_string (dm
, dm
->last_source_name
));
1791 /* Print the flavor of the destructor if in verbose mode. */
1792 flavor
= next_char (dm
) - '0';
1795 RETURN_IF_ERROR (result_append (dm
, " ["));
1796 RETURN_IF_ERROR (result_append (dm
, dtor_flavors
[flavor
]));
1797 RETURN_IF_ERROR (result_append_char (dm
, ']'));
1801 return STATUS_ERROR
;
1806 /* Handle pointer, reference, and pointer-to-member cases for
1807 demangle_type. All consecutive `P's, `R's, and 'M's are joined to
1808 build a pointer/reference type. We snarf all these, plus the
1809 following <type>, all at once since we need to know whether we have
1810 a pointer to data or pointer to function to construct the right
1811 output syntax. C++'s pointer syntax is hairy.
1815 ::= <pointer-to-member-type>
1817 <pointer-to-member-type> ::= M </class/ type> </member/ type> */
1820 demangle_type_ptr (dm
)
1826 /* Collect pointer symbols into this string. */
1827 dyn_string_t symbols
= dyn_string_new (10);
1829 DEMANGLE_TRACE ("type*", dm
);
1831 if (symbols
== NULL
)
1832 return STATUS_ALLOCATION_FAILED
;
1834 /* Scan forward, collecting pointers and references into symbols,
1835 until we hit something else. Then emit the type. */
1838 next
= peek_char (dm
);
1841 if (!dyn_string_append_char (symbols
, '*'))
1842 return STATUS_ALLOCATION_FAILED
;
1845 else if (next
== 'R')
1847 if (!dyn_string_append_char (symbols
, '&'))
1848 return STATUS_ALLOCATION_FAILED
;
1851 else if (next
== 'M')
1853 /* Pointer-to-member. */
1854 dyn_string_t class_type
;
1859 /* Capture the type of which this is a pointer-to-member. */
1860 RETURN_IF_ERROR (result_push (dm
));
1861 RETURN_IF_ERROR (demangle_type (dm
));
1862 class_type
= (dyn_string_t
) result_pop (dm
);
1864 /* Build the pointer-to-member notation. It comes before
1865 other pointer and reference qualifiers -- */
1866 if (!dyn_string_prepend_cstr (symbols
, "::*"))
1867 return STATUS_ALLOCATION_FAILED
;
1868 if (!dyn_string_prepend (symbols
, class_type
))
1869 return STATUS_ALLOCATION_FAILED
;
1870 dyn_string_delete (class_type
);
1872 if (peek_char (dm
) == 'F')
1875 /* Demangle the type of the pointed-to member. */
1876 status
= demangle_type (dm
);
1877 /* Make it pretty. */
1878 if (STATUS_NO_ERROR (status
))
1879 status
= result_append_space (dm
);
1880 /* Add the pointer-to-member syntax, and other pointer and
1881 reference symbols. */
1882 if (STATUS_NO_ERROR (status
))
1883 status
= result_append_string (dm
, symbols
);
1885 dyn_string_delete (symbols
);
1887 RETURN_IF_ERROR (status
);
1890 else if (next
== 'F')
1892 /* Ooh, tricky, a pointer-to-function. */
1893 int position
= result_length (dm
);
1894 status
= result_append_char (dm
, '(');
1895 if (STATUS_NO_ERROR (status
))
1896 status
= result_append_string (dm
, symbols
);
1897 if (STATUS_NO_ERROR (status
))
1898 status
= result_append_char (dm
, ')');
1899 dyn_string_delete (symbols
);
1900 RETURN_IF_ERROR (status
);
1902 RETURN_IF_ERROR (demangle_function_type (dm
, position
));
1907 /* No more pointe or reference tokens. Finish up. */
1908 status
= demangle_type (dm
);
1910 if (STATUS_NO_ERROR (status
))
1911 status
= result_append_string (dm
, symbols
);
1912 dyn_string_delete (symbols
);
1913 RETURN_IF_ERROR (status
);
1915 RETURN_IF_ERROR (status
);
1921 /* Demangles and emits a <type>.
1923 <type> ::= <builtin-type>
1925 ::= <class-enum-type>
1927 ::= <pointer-to-member-type>
1928 ::= <template-param>
1929 ::= <CV-qualifiers> <type>
1930 ::= P <type> # pointer-to
1931 ::= R <type> # reference-to
1932 ::= C <type> # complex pair (C 2000)
1933 ::= G <type> # imaginary (C 2000)
1934 ::= U <source-name> <type> # vendor extended type qualifier
1935 ::= <substitution> */
1941 int start
= substitution_start (dm
);
1942 char peek
= peek_char (dm
);
1945 int special_std_substitution
;
1946 int is_builtin_type
= 0;
1947 template_arg_list_t old_arg_list
= current_template_arg_list (dm
);
1948 int template_parm
= NOT_TEMPLATE_PARM
;
1950 DEMANGLE_TRACE ("type", dm
);
1952 /* A <class-enum-type> can start with a digit (a <source-name>), an
1953 N (a <nested-name>), or a Z (a <local-name>). */
1954 if (IS_DIGIT ((unsigned char) peek
) || peek
== 'N' || peek
== 'Z')
1955 RETURN_IF_ERROR (demangle_class_enum_type (dm
, &template_p
));
1956 else if (peek
>= 'a' && peek
<= 'z')
1958 RETURN_IF_ERROR (demangle_builtin_type (dm
));
1959 is_builtin_type
= 1;
1969 dyn_string_t cv_qualifiers
= dyn_string_new (24);
1971 if (cv_qualifiers
== NULL
)
1972 return STATUS_ALLOCATION_FAILED
;
1974 demangle_CV_qualifiers (dm
, cv_qualifiers
);
1976 /* If the qualifiers apply to a pointer or reference, they
1977 need to come after the whole qualified type. */
1978 if (peek_char (dm
) == 'P' || peek_char (dm
) == 'R')
1980 status
= demangle_type (dm
);
1981 if (STATUS_NO_ERROR (status
))
1982 status
= result_append_space (dm
);
1983 if (STATUS_NO_ERROR (status
))
1984 status
= result_append_string (dm
, cv_qualifiers
);
1986 /* Otherwise, the qualifiers come first. */
1989 status
= result_append_string (dm
, cv_qualifiers
);
1990 if (STATUS_NO_ERROR (status
))
1991 status
= result_append_space (dm
);
1992 if (STATUS_NO_ERROR (status
))
1993 status
= demangle_type (dm
);
1996 dyn_string_delete (cv_qualifiers
);
1997 RETURN_IF_ERROR (status
);
2002 return "Non-pointer or -reference function type.";
2005 RETURN_IF_ERROR (demangle_array_type (dm
));
2009 RETURN_IF_ERROR (demangle_template_param (dm
, &template_parm
));
2013 /* First check if this is a special substitution. If it is,
2014 this is a <class-enum-type>. Special substitutions have a
2015 letter following the `S'; other substitutions have a digit
2017 peek_next
= peek_char_next (dm
);
2018 if (IS_DIGIT (peek_next
) || peek_next
== '_')
2019 RETURN_IF_ERROR (demangle_substitution (dm
, &template_p
,
2020 &special_std_substitution
));
2022 demangle_class_enum_type (dm
, &template_p
);
2028 RETURN_IF_ERROR (demangle_type_ptr (dm
));
2032 /* A C99 complex type. */
2033 RETURN_IF_ERROR (result_append (dm
, "complex "));
2035 RETURN_IF_ERROR (demangle_type (dm
));
2039 /* A C99 imaginary type. */
2040 RETURN_IF_ERROR (result_append (dm
, "imaginary "));
2042 RETURN_IF_ERROR (demangle_type (dm
));
2046 /* Vendor extended type qualifier. */
2048 RETURN_IF_ERROR (demangle_source_name (dm
));
2049 RETURN_IF_ERROR (result_append_char (dm
, ' '));
2050 RETURN_IF_ERROR (demangle_type (dm
));
2054 return "Unexpected character in <type>.";
2057 /* Unqualified builin types are not substitution candidates. */
2058 if (!is_builtin_type
)
2059 /* Add a new substitution for the type. If this type was a
2060 <template-param>, pass its index since from the point of
2061 substitutions, a <template-param> token is a substitution
2062 candidate distinct from the type that is substituted for it. */
2063 RETURN_IF_ERROR (substitution_add (dm
, start
, template_p
, template_parm
));
2065 /* Pop off template argument lists added during mangling of this
2067 pop_to_template_arg_list (dm
, old_arg_list
);
2072 /* C++ source names of builtin types, indexed by the mangled code
2073 letter's position in the alphabet ('a' -> 0, 'b' -> 1, etc). */
2074 static const char *const builtin_type_names
[26] =
2076 "signed char", /* a */
2080 "long double", /* e */
2082 "__float128", /* g */
2083 "unsigned char", /* h */
2088 "unsigned long", /* m */
2090 "unsigned __int128", /* o */
2095 "unsigned short", /* t */
2099 "long long", /* x */
2100 "unsigned long long", /* y */
2104 /* Demangles and emits a <builtin-type>.
2106 <builtin-type> ::= v # void
2111 ::= h # unsigned char
2113 ::= t # unsigned short
2115 ::= j # unsigned int
2117 ::= m # unsigned long
2118 ::= x # long long, __int64
2119 ::= y # unsigned long long, __int64
2121 ::= o # unsigned __int128
2124 ::= e # long double, __float80
2127 ::= u <source-name> # vendor extended type */
2130 demangle_builtin_type (dm
)
2134 char code
= peek_char (dm
);
2136 DEMANGLE_TRACE ("builtin-type", dm
);
2141 RETURN_IF_ERROR (demangle_source_name (dm
));
2144 else if (code
>= 'a' && code
<= 'z')
2146 const char *type_name
= builtin_type_names
[code
- 'a'];
2147 if (type_name
== NULL
)
2148 return "Unrecognized <builtin-type> code.";
2150 RETURN_IF_ERROR (result_append (dm
, type_name
));
2155 return "Non-alphabetic <builtin-type> code.";
2158 /* Demangles all consecutive CV-qualifiers (const, volatile, and
2159 restrict) at the current position. The qualifiers are appended to
2160 QUALIFIERS. Returns STATUS_OK. */
2163 demangle_CV_qualifiers (dm
, qualifiers
)
2165 dyn_string_t qualifiers
;
2167 DEMANGLE_TRACE ("CV-qualifiers", dm
);
2171 switch (peek_char (dm
))
2174 if (!dyn_string_append_space (qualifiers
))
2175 return STATUS_ALLOCATION_FAILED
;
2176 if (!dyn_string_append_cstr (qualifiers
, "restrict"))
2177 return STATUS_ALLOCATION_FAILED
;
2181 if (!dyn_string_append_space (qualifiers
))
2182 return STATUS_ALLOCATION_FAILED
;
2183 if (!dyn_string_append_cstr (qualifiers
, "volatile"))
2184 return STATUS_ALLOCATION_FAILED
;
2188 if (!dyn_string_append_space (qualifiers
))
2189 return STATUS_ALLOCATION_FAILED
;
2190 if (!dyn_string_append_cstr (qualifiers
, "const"))
2191 return STATUS_ALLOCATION_FAILED
;
2202 /* Demangles and emits a <function-type> FUNCTION_NAME_POS is the
2203 position in the result string of the start of the function
2204 identifier, at which the function's return type will be inserted.
2206 <function-type> ::= F [Y] <bare-function-type> E */
2209 demangle_function_type (dm
, function_name_pos
)
2211 int function_name_pos
;
2213 DEMANGLE_TRACE ("function-type", dm
);
2214 RETURN_IF_ERROR (demangle_char (dm
, 'F'));
2215 if (peek_char (dm
) == 'Y')
2217 /* Indicate this function has C linkage if in verbose mode. */
2219 RETURN_IF_ERROR (result_append (dm
, " [extern \"C\"] "));
2222 RETURN_IF_ERROR (demangle_bare_function_type (dm
, function_name_pos
));
2223 RETURN_IF_ERROR (demangle_char (dm
, 'E'));
2227 /* Demangles and emits a <bare-function-type>. RETURN_TYPE_POS is the
2228 position in the result string at which the function return type
2229 should be inserted. If RETURN_TYPE_POS is BFT_NO_RETURN_TYPE, the
2230 function's return type is assumed not to be encoded.
2232 <bare-function-type> ::= <signature type>+ */
2235 demangle_bare_function_type (dm
, return_type_pos
)
2237 int return_type_pos
;
2239 /* Sequence is the index of the current function parameter, counting
2240 from zero. The value -1 denotes the return type. */
2242 (return_type_pos
== BFT_NO_RETURN_TYPE
? 0 : -1);
2244 DEMANGLE_TRACE ("bare-function-type", dm
);
2246 RETURN_IF_ERROR (result_append_char (dm
, '('));
2247 while (!end_of_name_p (dm
) && peek_char (dm
) != 'E')
2250 /* We're decoding the function's return type. */
2252 dyn_string_t return_type
;
2253 status_t status
= STATUS_OK
;
2255 /* Decode the return type off to the side. */
2256 RETURN_IF_ERROR (result_push (dm
));
2257 RETURN_IF_ERROR (demangle_type (dm
));
2258 return_type
= (dyn_string_t
) result_pop (dm
);
2260 /* Add a space to the end of the type. Insert the return
2261 type where we've been asked to. */
2262 if (!dyn_string_append_space (return_type
)
2263 || !dyn_string_insert (result_string (dm
), return_type_pos
,
2265 status
= STATUS_ALLOCATION_FAILED
;
2267 dyn_string_delete (return_type
);
2268 RETURN_IF_ERROR (status
);
2272 /* Skip `void' parameter types. One should only occur as
2273 the only type in a parameter list; in that case, we want
2274 to print `foo ()' instead of `foo (void)'. */
2275 if (peek_char (dm
) == 'v')
2277 /* Consume the v. */
2281 /* Separate parameter types by commas. */
2283 RETURN_IF_ERROR (result_append (dm
, ", "));
2284 /* Demangle the type. */
2285 RETURN_IF_ERROR (demangle_type (dm
));
2290 RETURN_IF_ERROR (result_append_char (dm
, ')'));
2295 /* Demangles and emits a <class-enum-type>. *TEMPLATE_P is set to
2296 non-zero if the type is a template-id, zero otherwise.
2298 <class-enum-type> ::= <name> */
2301 demangle_class_enum_type (dm
, template_p
)
2305 DEMANGLE_TRACE ("class-enum-type", dm
);
2307 RETURN_IF_ERROR (demangle_name (dm
, template_p
));
2311 /* Demangles and emits an <array-type>.
2313 <array-type> ::= A [<dimension number>] _ <element type> */
2316 demangle_array_type (dm
)
2320 dyn_string_t array_size
= dyn_string_new (10);
2322 if (array_size
== NULL
)
2323 return STATUS_ALLOCATION_FAILED
;
2325 status
= demangle_char (dm
, 'A');
2327 /* Demangle the array size into array_size. */
2328 if (STATUS_NO_ERROR (status
))
2329 status
= demangle_number_literally (dm
, array_size
, 10, 0);
2331 /* Demangle the base type of the array. */
2332 if (STATUS_NO_ERROR (status
))
2333 status
= demangle_char (dm
, '_');
2334 if (STATUS_NO_ERROR (status
))
2335 status
= demangle_type (dm
);
2337 /* Emit the array dimension syntax. */
2338 if (STATUS_NO_ERROR (status
))
2339 status
= result_append_char (dm
, '[');
2340 if (STATUS_NO_ERROR (status
))
2341 status
= result_append_string (dm
, array_size
);
2342 if (STATUS_NO_ERROR (status
))
2343 status
= result_append_char (dm
, ']');
2344 dyn_string_delete (array_size
);
2346 RETURN_IF_ERROR (status
);
2351 /* Demangles and emits a <template-param>. The zero-indexed position
2352 in the parameter list is placed in *TEMPLATE_PARM_NUMBER.
2354 <template-param> ::= T_ # first template parameter
2355 ::= T <parameter-2 number> _ */
2358 demangle_template_param (dm
, template_parm_number
)
2360 int *template_parm_number
;
2363 template_arg_list_t current_arg_list
= current_template_arg_list (dm
);
2366 DEMANGLE_TRACE ("template-param", dm
);
2368 /* Make sure there is a template argmust list in which to look up
2369 this parameter reference. */
2370 if (current_arg_list
== NULL
)
2371 return "Template parameter outside of template.";
2373 RETURN_IF_ERROR (demangle_char (dm
, 'T'));
2374 if (peek_char (dm
) == '_')
2378 RETURN_IF_ERROR (demangle_number (dm
, &parm_number
, 10, 0));
2381 RETURN_IF_ERROR (demangle_char (dm
, '_'));
2383 arg
= template_arg_list_get_arg (current_arg_list
, parm_number
);
2385 /* parm_number exceeded the number of arguments in the current
2386 template argument list. */
2387 return "Template parameter number out of bounds.";
2388 RETURN_IF_ERROR (result_append_string (dm
, (dyn_string_t
) arg
));
2390 if (peek_char (dm
) == 'I')
2391 RETURN_IF_ERROR (demangle_template_args (dm
));
2393 *template_parm_number
= parm_number
;
2397 /* Demangles and emits a <template-args>.
2399 <template-args> ::= I <template-arg>+ E */
2402 demangle_template_args (dm
)
2406 dyn_string_t old_last_source_name
;
2407 template_arg_list_t arg_list
= template_arg_list_new ();
2409 if (arg_list
== NULL
)
2410 return STATUS_ALLOCATION_FAILED
;
2412 /* Preserve the most recently demangled source name. */
2413 old_last_source_name
= dm
->last_source_name
;
2414 dm
->last_source_name
= dyn_string_new (0);
2416 DEMANGLE_TRACE ("template-args", dm
);
2418 if (dm
->last_source_name
== NULL
)
2419 return STATUS_ALLOCATION_FAILED
;
2421 RETURN_IF_ERROR (demangle_char (dm
, 'I'));
2422 RETURN_IF_ERROR (result_append_char (dm
, '<'));
2430 RETURN_IF_ERROR (result_append (dm
, ", "));
2432 /* Capture the template arg. */
2433 RETURN_IF_ERROR (result_push (dm
));
2434 RETURN_IF_ERROR (demangle_template_arg (dm
));
2435 arg
= result_pop (dm
);
2437 /* Emit it in the demangled name. */
2438 RETURN_IF_ERROR (result_append_string (dm
, (dyn_string_t
) arg
));
2440 /* Save it for use in expanding <template-param>s. */
2441 template_arg_list_add_arg (arg_list
, arg
);
2443 while (peek_char (dm
) != 'E');
2444 /* Append the '>'. */
2445 RETURN_IF_ERROR (result_close_template_list (dm
));
2447 /* Consume the 'E'. */
2450 /* Restore the most recent demangled source name. */
2451 dyn_string_delete (dm
->last_source_name
);
2452 dm
->last_source_name
= old_last_source_name
;
2454 /* Push the list onto the top of the stack of template argument
2455 lists, so that arguments from it are used from now on when
2456 expanding <template-param>s. */
2457 push_template_arg_list (dm
, arg_list
);
2462 /* This function, which does not correspond to a production in the
2463 mangling spec, handles the `literal' production for both
2464 <template-arg> and <expr-primary>. It does not expect or consume
2465 the initial `L' or final `E'. The demangling is given by:
2467 <literal> ::= <type> </value/ number>
2469 and the emitted output is `(type)number'. */
2472 demangle_literal (dm
)
2475 char peek
= peek_char (dm
);
2476 dyn_string_t value_string
;
2479 DEMANGLE_TRACE ("literal", dm
);
2481 if (!flag_verbose
&& peek
>= 'a' && peek
<= 'z')
2483 /* If not in verbose mode and this is a builtin type, see if we
2484 can produce simpler numerical output. In particular, for
2485 integer types shorter than `long', just write the number
2486 without type information; for bools, write `true' or `false'.
2487 Other refinements could be made here too. */
2489 /* This constant string is used to map from <builtin-type> codes
2490 (26 letters of the alphabet) to codes that determine how the
2491 value will be displayed. The codes are:
2495 A space means the value will be represented using cast
2497 static const char *const code_map
= "ibi iii ll ii i ";
2499 char code
= code_map
[peek
- 'a'];
2500 /* FIXME: Implement demangling of floats and doubles. */
2502 return STATUS_UNIMPLEMENTED
;
2505 /* It's a boolean. */
2508 /* Consume the b. */
2510 /* Look at the next character. It should be 0 or 1,
2511 corresponding to false or true, respectively. */
2512 value
= peek_char (dm
);
2514 RETURN_IF_ERROR (result_append (dm
, "false"));
2515 else if (value
== '1')
2516 RETURN_IF_ERROR (result_append (dm
, "true"));
2518 return "Unrecognized bool constant.";
2519 /* Consume the 0 or 1. */
2523 else if (code
== 'i' || code
== 'l')
2525 /* It's an integer or long. */
2527 /* Consume the type character. */
2530 /* Demangle the number and write it out. */
2531 value_string
= dyn_string_new (0);
2532 status
= demangle_number_literally (dm
, value_string
, 10, 1);
2533 if (STATUS_NO_ERROR (status
))
2534 status
= result_append_string (dm
, value_string
);
2535 /* For long integers, append an l. */
2536 if (code
== 'l' && STATUS_NO_ERROR (status
))
2537 status
= result_append_char (dm
, code
);
2538 dyn_string_delete (value_string
);
2540 RETURN_IF_ERROR (status
);
2543 /* ...else code == ' ', so fall through to represent this
2544 literal's type explicitly using cast syntax. */
2547 RETURN_IF_ERROR (result_append_char (dm
, '('));
2548 RETURN_IF_ERROR (demangle_type (dm
));
2549 RETURN_IF_ERROR (result_append_char (dm
, ')'));
2551 value_string
= dyn_string_new (0);
2552 if (value_string
== NULL
)
2553 return STATUS_ALLOCATION_FAILED
;
2555 status
= demangle_number_literally (dm
, value_string
, 10, 1);
2556 if (STATUS_NO_ERROR (status
))
2557 status
= result_append_string (dm
, value_string
);
2558 dyn_string_delete (value_string
);
2559 RETURN_IF_ERROR (status
);
2564 /* Demangles and emits a <template-arg>.
2566 <template-arg> ::= <type> # type
2567 ::= L <type> <value number> E # literal
2568 ::= LZ <encoding> E # external name
2569 ::= X <expression> E # expression */
2572 demangle_template_arg (dm
)
2575 DEMANGLE_TRACE ("template-arg", dm
);
2577 switch (peek_char (dm
))
2582 if (peek_char (dm
) == 'Z')
2584 /* External name. */
2586 /* FIXME: Standard is contradictory here. */
2587 RETURN_IF_ERROR (demangle_encoding (dm
));
2590 RETURN_IF_ERROR (demangle_literal (dm
));
2591 RETURN_IF_ERROR (demangle_char (dm
, 'E'));
2597 RETURN_IF_ERROR (demangle_expression (dm
));
2601 RETURN_IF_ERROR (demangle_type (dm
));
2608 /* Demangles and emits an <expression>.
2610 <expression> ::= <unary operator-name> <expression>
2611 ::= <binary operator-name> <expression> <expression>
2613 ::= <scope-expression> */
2616 demangle_expression (dm
)
2619 char peek
= peek_char (dm
);
2621 DEMANGLE_TRACE ("expression", dm
);
2623 if (peek
== 'L' || peek
== 'T')
2624 RETURN_IF_ERROR (demangle_expr_primary (dm
));
2625 else if (peek
== 's' && peek_char_next (dm
) == 'r')
2626 RETURN_IF_ERROR (demangle_scope_expression (dm
));
2628 /* An operator expression. */
2631 status_t status
= STATUS_OK
;
2632 dyn_string_t operator_name
;
2634 /* We have an operator name. Since we want to output binary
2635 operations in infix notation, capture the operator name
2637 RETURN_IF_ERROR (result_push (dm
));
2638 RETURN_IF_ERROR (demangle_operator_name (dm
, 1, &num_args
));
2639 operator_name
= (dyn_string_t
) result_pop (dm
);
2641 /* If it's binary, do an operand first. */
2644 status
= result_append_char (dm
, '(');
2645 if (STATUS_NO_ERROR (status
))
2646 status
= demangle_expression (dm
);
2647 if (STATUS_NO_ERROR (status
))
2648 status
= result_append_char (dm
, ')');
2651 /* Emit the operator. */
2652 if (STATUS_NO_ERROR (status
))
2653 status
= result_append_string (dm
, operator_name
);
2654 dyn_string_delete (operator_name
);
2655 RETURN_IF_ERROR (status
);
2657 /* Emit its second (if binary) or only (if unary) operand. */
2658 RETURN_IF_ERROR (result_append_char (dm
, '('));
2659 RETURN_IF_ERROR (demangle_expression (dm
));
2660 RETURN_IF_ERROR (result_append_char (dm
, ')'));
2662 /* The ternary operator takes a third operand. */
2665 RETURN_IF_ERROR (result_append (dm
, ":("));
2666 RETURN_IF_ERROR (demangle_expression (dm
));
2667 RETURN_IF_ERROR (result_append_char (dm
, ')'));
2674 /* Demangles and emits a <scope-expression>.
2676 <scope-expression> ::= sr <qualifying type> <source-name>
2677 ::= sr <qualifying type> <encoding> */
2680 demangle_scope_expression (dm
)
2683 RETURN_IF_ERROR (demangle_char (dm
, 's'));
2684 RETURN_IF_ERROR (demangle_char (dm
, 'r'));
2685 RETURN_IF_ERROR (demangle_type (dm
));
2686 RETURN_IF_ERROR (result_append (dm
, "::"));
2687 RETURN_IF_ERROR (demangle_encoding (dm
));
2691 /* Demangles and emits an <expr-primary>.
2693 <expr-primary> ::= <template-param>
2694 ::= L <type> <value number> E # literal
2695 ::= L <mangled-name> E # external name */
2698 demangle_expr_primary (dm
)
2701 char peek
= peek_char (dm
);
2704 DEMANGLE_TRACE ("expr-primary", dm
);
2707 RETURN_IF_ERROR (demangle_template_param (dm
, &unused
));
2708 else if (peek
== 'L')
2710 /* Consume the `L'. */
2712 peek
= peek_char (dm
);
2715 RETURN_IF_ERROR (demangle_mangled_name (dm
));
2717 RETURN_IF_ERROR (demangle_literal (dm
));
2719 RETURN_IF_ERROR (demangle_char (dm
, 'E'));
2722 return STATUS_ERROR
;
2727 /* Demangles and emits a <substitution>. Sets *TEMPLATE_P to non-zero
2728 if the substitution is the name of a template, zero otherwise. If
2729 the substitution token is St, which corresponds to the `::std::'
2730 namespace and can appear in a non-nested name, sets
2731 *SPECIAL_STD_SUBSTITUTION to non-zero; zero otherwise.
2733 <substitution> ::= S <seq-id> _
2737 ::= Sa # ::std::allocator
2738 ::= Sb # ::std::basic_string
2739 ::= Ss # ::std::basic_string<char,
2740 ::std::char_traits<char>,
2741 ::std::allocator<char> >
2742 ::= Si # ::std::basic_istream<char,
2743 std::char_traits<char> >
2744 ::= So # ::std::basic_ostream<char,
2745 std::char_traits<char> >
2746 ::= Sd # ::std::basic_iostream<char,
2747 std::char_traits<char> >
2751 demangle_substitution (dm
, template_p
, special_std_substitution
)
2754 int *special_std_substitution
;
2760 DEMANGLE_TRACE ("substitution", dm
);
2762 RETURN_IF_ERROR (demangle_char (dm
, 'S'));
2763 *special_std_substitution
= 0;
2765 /* Scan the substitution sequence index. A missing number denotes
2767 peek
= peek_char (dm
);
2770 /* If the following character is 0-9 or a capital letter, interpret
2771 the sequence up to the next underscore as a base-36 substitution
2773 else if (IS_DIGIT ((unsigned char) peek
)
2774 || (peek
>= 'A' && peek
<= 'Z'))
2775 RETURN_IF_ERROR (demangle_number (dm
, &seq_id
, 36, 0));
2778 const char *new_last_source_name
= NULL
;
2783 RETURN_IF_ERROR (result_append (dm
, "std"));
2784 *special_std_substitution
= 1;
2788 RETURN_IF_ERROR (result_append (dm
, "std::allocator"));
2789 new_last_source_name
= "allocator";
2794 RETURN_IF_ERROR (result_append (dm
, "std::basic_string"));
2795 new_last_source_name
= "basic_string";
2802 RETURN_IF_ERROR (result_append (dm
, "std::string"));
2803 new_last_source_name
= "string";
2807 RETURN_IF_ERROR (result_append (dm
, "std::basic_string<char, std::char_traits<char>, std::allocator<char> >"));
2808 new_last_source_name
= "basic_string";
2816 RETURN_IF_ERROR (result_append (dm
, "std::istream"));
2817 new_last_source_name
= "istream";
2821 RETURN_IF_ERROR (result_append (dm
, "std::basic_istream<char, std::char_traints<char> >"));
2822 new_last_source_name
= "basic_istream";
2830 RETURN_IF_ERROR (result_append (dm
, "std::ostream"));
2831 new_last_source_name
= "ostream";
2835 RETURN_IF_ERROR (result_append (dm
, "std::basic_ostream<char, std::char_traits<char> >"));
2836 new_last_source_name
= "basic_ostream";
2844 RETURN_IF_ERROR (result_append (dm
, "std::iostream"));
2845 new_last_source_name
= "iostream";
2849 RETURN_IF_ERROR (result_append (dm
, "std::basic_iostream<char, std::char_traits<char> >"));
2850 new_last_source_name
= "basic_iostream";
2856 return "Unrecognized <substitution>.";
2859 /* Consume the character we just processed. */
2862 if (new_last_source_name
!= NULL
)
2864 if (!dyn_string_copy_cstr (dm
->last_source_name
,
2865 new_last_source_name
))
2866 return STATUS_ALLOCATION_FAILED
;
2872 /* Look up the substitution text. Since `S_' is the most recent
2873 substitution, `S0_' is the second-most-recent, etc., shift the
2874 numbering by one. */
2875 text
= substitution_get (dm
, seq_id
+ 1, template_p
);
2877 return "Substitution number out of range.";
2879 /* Emit the substitution text. */
2880 RETURN_IF_ERROR (result_append_string (dm
, text
));
2882 RETURN_IF_ERROR (demangle_char (dm
, '_'));
2886 /* Demangles and emits a <local-name>.
2888 <local-name> := Z <function encoding> E <entity name> [<discriminator>]
2889 := Z <function encoding> E s [<discriminator>] */
2892 demangle_local_name (dm
)
2895 DEMANGLE_TRACE ("local-name", dm
);
2897 RETURN_IF_ERROR (demangle_char (dm
, 'Z'));
2898 RETURN_IF_ERROR (demangle_encoding (dm
));
2899 RETURN_IF_ERROR (demangle_char (dm
, 'E'));
2900 RETURN_IF_ERROR (result_append (dm
, "'s "));
2902 if (peek_char (dm
) == 's')
2904 /* Local character string literal. */
2905 RETURN_IF_ERROR (result_append (dm
, "string literal"));
2906 /* Consume the s. */
2908 RETURN_IF_ERROR (demangle_discriminator (dm
, 0));
2913 RETURN_IF_ERROR (result_append (dm
, "local "));
2914 /* Local name for some other entity. Demangle its name. */
2915 RETURN_IF_ERROR (demangle_name (dm
, &unused
));
2916 RETURN_IF_ERROR (demangle_discriminator (dm
, 1));
2922 /* Optimonally demangles and emits a <discriminator>. If there is no
2923 <discriminator> at the current position in the mangled string, the
2924 descriminator is assumed to be zero. Emit the discriminator number
2925 in parentheses, unless SUPPRESS_FIRST is non-zero and the
2926 discriminator is zero.
2928 <discriminator> ::= _ <number> */
2931 demangle_discriminator (dm
, suppress_first
)
2935 /* Output for <discriminator>s to the demangled name is completely
2936 supressed if not in verbose mode. */
2938 if (peek_char (dm
) == '_')
2940 /* Consume the underscore. */
2943 RETURN_IF_ERROR (result_append (dm
, " [#"));
2944 /* Check if there's a number following the underscore. */
2945 if (IS_DIGIT ((unsigned char) peek_char (dm
)))
2948 /* Demangle the number. */
2949 RETURN_IF_ERROR (demangle_number (dm
, &discriminator
, 10, 0));
2951 /* Write the discriminator. The mangled number is two
2952 less than the discriminator ordinal, counting from
2954 RETURN_IF_ERROR (int_to_dyn_string (discriminator
+ 2,
2955 (dyn_string_t
) dm
->result
));
2960 /* A missing digit correspond to one. */
2961 RETURN_IF_ERROR (result_append_char (dm
, '1'));
2964 RETURN_IF_ERROR (result_append_char (dm
, ']'));
2966 else if (!suppress_first
)
2969 RETURN_IF_ERROR (result_append (dm
, " [#0]"));
2975 /* Demangle NAME into RESULT, which must be an initialized
2976 dyn_string_t. On success, returns STATUS_OK. On failure, returns
2977 an error message, and the contents of RESULT are unchanged. */
2980 cp_demangle (name
, result
)
2982 dyn_string_t result
;
2985 int length
= strlen (name
);
2987 if (length
> 2 && name
[0] == '_' && name
[1] == 'Z')
2989 demangling_t dm
= demangling_new (name
);
2991 return STATUS_ALLOCATION_FAILED
;
2993 status
= result_push (dm
);
2994 if (status
!= STATUS_OK
)
2996 demangling_delete (dm
);
3000 status
= demangle_mangled_name (dm
);
3001 if (STATUS_NO_ERROR (status
))
3003 dyn_string_t demangled
= (dyn_string_t
) result_pop (dm
);
3004 if (!dyn_string_copy (result
, demangled
))
3005 return STATUS_ALLOCATION_FAILED
;
3006 dyn_string_delete (demangled
);
3009 demangling_delete (dm
);
3013 /* It's evidently not a mangled C++ name. It could be the name
3014 of something with C linkage, though, so just copy NAME into
3016 if (!dyn_string_copy_cstr (result
, name
))
3017 return STATUS_ALLOCATION_FAILED
;
3024 /* Demangle TYPE_NAME into RESULT, which must be an initialized
3025 dyn_string_t. On success, returns STATUS_OK. On failiure, returns
3026 an error message, and the contents of RESULT are unchanged. */
3030 cp_demangle_type (type_name
, result
)
3031 const char* type_name
;
3032 dyn_string_t result
;
3035 demangling_t dm
= demangling_new (type_name
);
3038 return STATUS_ALLOCATION_FAILED
;
3040 /* Demangle the type name. The demangled name is stored in dm. */
3041 status
= result_push (dm
);
3042 if (status
!= STATUS_OK
)
3044 demangling_delete (dm
);
3048 status
= demangle_type (dm
);
3050 if (STATUS_NO_ERROR (status
))
3052 /* The demangling succeeded. Pop the result out of dm and copy
3054 dyn_string_t demangled
= (dyn_string_t
) result_pop (dm
);
3055 if (!dyn_string_copy (result
, demangled
))
3056 return STATUS_ALLOCATION_FAILED
;
3057 dyn_string_delete (demangled
);
3061 demangling_delete (dm
);
3066 extern char *__cxa_demangle
PARAMS ((const char *, char *, size_t *, int *));
3068 /* ABI-mandated entry point in the C++ runtime library for performing
3069 demangling. MANGLED_NAME is a NUL-terminated character string
3070 containing the name to be demangled.
3072 OUTPUT_BUFFER is a region of memory, allocated with malloc, of
3073 *LENGTH bytes, into which the demangled name is stored. If
3074 OUTPUT_BUFFER is not long enough, it is expanded using realloc.
3075 OUTPUT_BUFFER may instead be NULL; in that case, the demangled name
3076 is placed in a region of memory allocated with malloc.
3078 If LENGTH is non-NULL, the length of the buffer conaining the
3079 demangled name, is placed in *LENGTH.
3081 The return value is a pointer to the start of the NUL-terminated
3082 demangled name, or NULL if the demangling fails. The caller is
3083 responsible for deallocating this memory using free.
3085 *STATUS is set to one of the following values:
3086 0: The demangling operation succeeded.
3087 -1: A memory allocation failiure occurred.
3088 -2: MANGLED_NAME is not a valid name under the C++ ABI mangling rules.
3089 -3: One of the arguments is invalid.
3091 The demagling is performed using the C++ ABI mangling rules, with
3095 __cxa_demangle (mangled_name
, output_buffer
, length
, status
)
3096 const char *mangled_name
;
3097 char *output_buffer
;
3101 struct dyn_string demangled_name
;
3107 if (mangled_name
== NULL
) {
3112 /* Did the caller provide a buffer for the demangled name? */
3113 if (output_buffer
== NULL
) {
3114 /* No; dyn_string will malloc a buffer for us. */
3115 if (!dyn_string_init (&demangled_name
, 0))
3122 /* Yes. Check that the length was provided. */
3123 if (length
== NULL
) {
3127 /* Install the buffer into a dyn_string. */
3128 demangled_name
.allocated
= *length
;
3129 demangled_name
.length
= 0;
3130 demangled_name
.s
= output_buffer
;
3133 if (mangled_name
[0] == '_' && mangled_name
[1] == 'Z')
3134 /* MANGLED_NAME apprears to be a function or variable name.
3135 Demangle it accordingly. */
3136 result
= cp_demangle (mangled_name
, &demangled_name
);
3138 /* Try to demangled MANGLED_NAME as the name of a type. */
3139 result
= cp_demangle_type (mangled_name
, &demangled_name
);
3141 if (result
== STATUS_OK
)
3142 /* The demangling succeeded. */
3144 /* If LENGTH isn't NULL, store the allocated buffer length
3145 there; the buffer may have been realloced by dyn_string
3148 *length
= demangled_name
.allocated
;
3149 /* The operation was a success. */
3151 return dyn_string_buf (&demangled_name
);
3153 else if (result
== STATUS_ALLOCATION_FAILED
)
3154 /* A call to malloc or realloc failed during the demangling
3161 /* The demangling failed for another reason, most probably because
3162 MANGLED_NAME isn't a valid mangled name. */
3164 /* If the buffer containing the demangled name wasn't provided
3165 by the caller, free it. */
3166 if (output_buffer
== NULL
)
3167 free (dyn_string_buf (&demangled_name
));
3173 #else /* !IN_LIBGCC2 */
3175 /* Variant entry point for integration with the existing cplus-dem
3176 demangler. Attempts to demangle MANGLED. If the demangling
3177 succeeds, returns a buffer, allocated with malloc, containing the
3178 demangled name. The caller must deallocate the buffer using free.
3179 If the demangling failes, returns NULL. */
3182 cplus_demangle_new_abi (mangled
)
3183 const char* mangled
;
3185 /* Create a dyn_string to hold the demangled name. */
3186 dyn_string_t demangled
= dyn_string_new (0);
3187 /* Attempt the demangling. */
3188 status_t status
= cp_demangle ((char *) mangled
, demangled
);
3189 if (STATUS_NO_ERROR (status
))
3190 /* Demangling succeeded. */
3192 /* Grab the demangled result from the dyn_string. It was
3193 allocated with malloc, so we can return it directly. */
3194 char *return_value
= dyn_string_release (demangled
);
3195 /* Hand back the demangled name. */
3196 return return_value
;
3198 else if (status
== STATUS_ALLOCATION_FAILED
)
3200 fprintf (stderr
, "Memory allocation failed.\n");
3204 /* Demangling failed. */
3206 dyn_string_delete (demangled
);
3211 #endif /* IN_LIBGCC2 */
3213 #ifdef STANDALONE_DEMANGLER
3217 static void print_usage
3218 PARAMS ((FILE* fp
, int exit_value
));
3220 /* Non-zero if CHAR is a character than can occur in a mangled name. */
3221 #define is_mangled_char(CHAR) \
3222 (IS_ALPHA (CHAR) || IS_DIGIT (CHAR) || (CHAR) == '_')
3224 /* The name of this program, as invoked. */
3225 const char* program_name
;
3227 /* Prints usage summary to FP and then exits with EXIT_VALUE. */
3230 print_usage (fp
, exit_value
)
3234 fprintf (fp
, "Usage: %s [options] [names ...]\n", program_name
);
3235 fprintf (fp
, "Options:\n", program_name
);
3236 fprintf (fp
, " -h,--help Display this message.\n");
3237 fprintf (fp
, " -s,--strict Demangle standard names only.\n");
3238 fprintf (fp
, " -v,--verbose Produce verbose demanglings.\n");
3239 fprintf (fp
, "If names are provided, they are demangled. Otherwise filters standard input.\n");
3244 /* Option specification for getopt_long. */
3245 static struct option long_options
[] =
3247 { "help", no_argument
, NULL
, 'h' },
3248 { "strict", no_argument
, NULL
, 's' },
3249 { "verbose", no_argument
, NULL
, 'v' },
3250 { NULL
, no_argument
, NULL
, 0 },
3253 /* Main entry for a demangling filter executable. It will demangle
3254 its command line arguments, if any. If none are provided, it will
3255 filter stdin to stdout, replacing any recognized mangled C++ names
3256 with their demangled equivalents. */
3267 /* Use the program name of this program, as invoked. */
3268 program_name
= argv
[0];
3270 /* Parse options. */
3273 opt_char
= getopt_long (argc
, argv
, "hsv", long_options
, NULL
);
3276 case '?': /* Unrecognized option. */
3277 print_usage (stderr
, 1);
3281 print_usage (stdout
, 0);
3293 while (opt_char
!= -1);
3296 /* No command line arguments were provided. Filter stdin. */
3298 dyn_string_t mangled
= dyn_string_new (3);
3299 dyn_string_t demangled
= dyn_string_new (0);
3302 /* Read all of input. */
3303 while (!feof (stdin
))
3305 char c
= getchar ();
3307 /* The first character of a mangled name is an underscore. */
3312 /* It's not a mangled name. Print the character and go
3319 /* The second character of a mangled name is a capital `Z'. */
3324 /* It's not a mangled name. Print the previous
3325 underscore, the `Z', and go on. */
3331 /* Start keeping track of the candidate mangled name. */
3332 dyn_string_append_char (mangled
, '_');
3333 dyn_string_append_char (mangled
, 'Z');
3335 /* Pile characters into mangled until we hit one that can't
3336 occur in a mangled name. */
3338 while (!feof (stdin
) && is_mangled_char (c
))
3340 dyn_string_append_char (mangled
, c
);
3346 /* Attempt to demangle the name. */
3347 status
= cp_demangle (dyn_string_buf (mangled
), demangled
);
3349 /* If the demangling succeeded, great! Print out the
3350 demangled version. */
3351 if (STATUS_NO_ERROR (status
))
3352 fputs (dyn_string_buf (demangled
), stdout
);
3353 /* Abort on allocation failures. */
3354 else if (status
== STATUS_ALLOCATION_FAILED
)
3356 fprintf (stderr
, "Memory allocation failed.\n");
3359 /* Otherwise, it might not have been a mangled name. Just
3360 print out the original text. */
3362 fputs (dyn_string_buf (mangled
), stdout
);
3364 /* If we haven't hit EOF yet, we've read one character that
3365 can't occur in a mangled name, so print it out. */
3369 /* Clear the candidate mangled name, to start afresh next
3370 time we hit a `_Z'. */
3371 dyn_string_clear (mangled
);
3374 dyn_string_delete (mangled
);
3375 dyn_string_delete (demangled
);
3378 /* Demangle command line arguments. */
3380 dyn_string_t result
= dyn_string_new (0);
3382 /* Loop over command line arguments. */
3383 for (i
= optind
; i
< argc
; ++i
)
3385 /* Attempt to demangle. */
3386 status
= cp_demangle (argv
[i
], result
);
3388 /* If it worked, print the demangled name. */
3389 if (STATUS_NO_ERROR (status
))
3390 printf ("%s\n", dyn_string_buf (result
));
3391 /* Abort on allocaiton failures. */
3392 else if (status
== STATUS_ALLOCATION_FAILED
)
3394 fprintf (stderr
, "Memory allocaiton failed.\n");
3397 /* If not, print the error message to stderr instead. */
3399 fprintf (stderr
, "%s\n", status
);
3401 dyn_string_delete (result
);
3407 #endif /* STANDALONE_DEMANGLER */