1 /* Helper routines for C++ support in GDB.
2 Copyright (C) 2002-2017 Free Software Foundation, Inc.
4 Contributed by MontaVista Software.
6 This file is part of GDB.
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 3 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program. If not, see <http://www.gnu.org/licenses/>. */
22 #include "cp-support.h"
25 #include "dictionary.h"
30 #include "complaints.h"
32 #include "expression.h"
35 #include "namespace.h"
37 #include "gdb_setjmp.h"
38 #include "safe-ctype.h"
40 #define d_left(dc) (dc)->u.s_binary.left
41 #define d_right(dc) (dc)->u.s_binary.right
43 /* Functions related to demangled name parsing. */
45 static unsigned int cp_find_first_component_aux (const char *name
,
48 static void demangled_name_complaint (const char *name
);
50 /* Functions/variables related to overload resolution. */
52 static int sym_return_val_size
= -1;
53 static int sym_return_val_index
;
54 static struct symbol
**sym_return_val
;
56 static void overload_list_add_symbol (struct symbol
*sym
,
57 const char *oload_name
);
59 static void make_symbol_overload_list_using (const char *func_name
,
60 const char *the_namespace
);
62 static void make_symbol_overload_list_qualified (const char *func_name
);
64 /* The list of "maint cplus" commands. */
66 struct cmd_list_element
*maint_cplus_cmd_list
= NULL
;
68 /* The actual commands. */
70 static void maint_cplus_command (char *arg
, int from_tty
);
71 static void first_component_command (char *arg
, int from_tty
);
73 /* A list of typedefs which should not be substituted by replace_typedefs. */
74 static const char * const ignore_typedefs
[] =
76 "std::istream", "std::iostream", "std::ostream", "std::string"
80 replace_typedefs (struct demangle_parse_info
*info
,
81 struct demangle_component
*ret_comp
,
82 canonicalization_ftype
*finder
,
85 /* A convenience function to copy STRING into OBSTACK, returning a pointer
86 to the newly allocated string and saving the number of bytes saved in LEN.
88 It does not copy the terminating '\0' byte! */
91 copy_string_to_obstack (struct obstack
*obstack
, const char *string
,
94 *len
= strlen (string
);
95 return (char *) obstack_copy (obstack
, string
, *len
);
98 /* Return 1 if STRING is clearly already in canonical form. This
99 function is conservative; things which it does not recognize are
100 assumed to be non-canonical, and the parser will sort them out
101 afterwards. This speeds up the critical path for alphanumeric
105 cp_already_canonical (const char *string
)
107 /* Identifier start character [a-zA-Z_]. */
108 if (!ISIDST (string
[0]))
111 /* These are the only two identifiers which canonicalize to other
112 than themselves or an error: unsigned -> unsigned int and
114 if (string
[0] == 'u' && strcmp (&string
[1], "nsigned") == 0)
116 else if (string
[0] == 's' && strcmp (&string
[1], "igned") == 0)
119 /* Identifier character [a-zA-Z0-9_]. */
120 while (ISIDNUM (string
[1]))
123 if (string
[1] == '\0')
129 /* Inspect the given RET_COMP for its type. If it is a typedef,
130 replace the node with the typedef's tree.
132 Returns 1 if any typedef substitutions were made, 0 otherwise. */
135 inspect_type (struct demangle_parse_info
*info
,
136 struct demangle_component
*ret_comp
,
137 canonicalization_ftype
*finder
,
144 /* Copy the symbol's name from RET_COMP and look it up
145 in the symbol table. */
146 name
= (char *) alloca (ret_comp
->u
.s_name
.len
+ 1);
147 memcpy (name
, ret_comp
->u
.s_name
.s
, ret_comp
->u
.s_name
.len
);
148 name
[ret_comp
->u
.s_name
.len
] = '\0';
150 /* Ignore any typedefs that should not be substituted. */
151 for (i
= 0; i
< ARRAY_SIZE (ignore_typedefs
); ++i
)
153 if (strcmp (name
, ignore_typedefs
[i
]) == 0)
161 sym
= lookup_symbol (name
, 0, VAR_DOMAIN
, 0).symbol
;
163 CATCH (except
, RETURN_MASK_ALL
)
171 struct type
*otype
= SYMBOL_TYPE (sym
);
175 const char *new_name
= (*finder
) (otype
, data
);
177 if (new_name
!= NULL
)
179 ret_comp
->u
.s_name
.s
= new_name
;
180 ret_comp
->u
.s_name
.len
= strlen (new_name
);
187 /* If the type is a typedef or namespace alias, replace it. */
188 if (TYPE_CODE (otype
) == TYPE_CODE_TYPEDEF
189 || TYPE_CODE (otype
) == TYPE_CODE_NAMESPACE
)
194 std::unique_ptr
<demangle_parse_info
> i
;
196 /* Get the real type of the typedef. */
197 type
= check_typedef (otype
);
199 /* If the symbol is a namespace and its type name is no different
200 than the name we looked up, this symbol is not a namespace
201 alias and does not need to be substituted. */
202 if (TYPE_CODE (otype
) == TYPE_CODE_NAMESPACE
203 && strcmp (TYPE_NAME (type
), name
) == 0)
206 is_anon
= (TYPE_TAG_NAME (type
) == NULL
207 && (TYPE_CODE (type
) == TYPE_CODE_ENUM
208 || TYPE_CODE (type
) == TYPE_CODE_STRUCT
209 || TYPE_CODE (type
) == TYPE_CODE_UNION
));
212 struct type
*last
= otype
;
214 /* Find the last typedef for the type. */
215 while (TYPE_TARGET_TYPE (last
) != NULL
216 && (TYPE_CODE (TYPE_TARGET_TYPE (last
))
217 == TYPE_CODE_TYPEDEF
))
218 last
= TYPE_TARGET_TYPE (last
);
220 /* If there is only one typedef for this anonymous type,
221 do not substitute it. */
225 /* Use the last typedef seen as the type for this
233 type_print (type
, "", &buf
, -1);
235 /* If type_print threw an exception, there is little point
236 in continuing, so just bow out gracefully. */
237 CATCH (except
, RETURN_MASK_ERROR
)
244 name
= (char *) obstack_copy0 (&info
->obstack
, buf
.c_str (), len
);
246 /* Turn the result into a new tree. Note that this
247 tree will contain pointers into NAME, so NAME cannot
248 be free'd until all typedef conversion is done and
249 the final result is converted into a string. */
250 i
= cp_demangled_name_to_comp (name
, NULL
);
253 /* Merge the two trees. */
254 cp_merge_demangle_parse_infos (info
, ret_comp
, i
.get ());
256 /* Replace any newly introduced typedefs -- but not
257 if the type is anonymous (that would lead to infinite
260 replace_typedefs (info
, ret_comp
, finder
, data
);
264 /* This shouldn't happen unless the type printer has
265 output something that the name parser cannot grok.
266 Nonetheless, an ounce of prevention...
268 Canonicalize the name again, and store it in the
269 current node (RET_COMP). */
270 std::string canon
= cp_canonicalize_string_no_typedefs (name
);
274 /* Copy the canonicalization into the obstack. */
275 name
= copy_string_to_obstack (&info
->obstack
, canon
.c_str (), &len
);
278 ret_comp
->u
.s_name
.s
= name
;
279 ret_comp
->u
.s_name
.len
= len
;
289 /* Replace any typedefs appearing in the qualified name
290 (DEMANGLE_COMPONENT_QUAL_NAME) represented in RET_COMP for the name parse
294 replace_typedefs_qualified_name (struct demangle_parse_info
*info
,
295 struct demangle_component
*ret_comp
,
296 canonicalization_ftype
*finder
,
302 struct demangle_component
*comp
= ret_comp
;
304 /* Walk each node of the qualified name, reconstructing the name of
305 this element. With every node, check for any typedef substitutions.
306 If a substitution has occurred, replace the qualified name node
307 with a DEMANGLE_COMPONENT_NAME node representing the new, typedef-
309 while (comp
->type
== DEMANGLE_COMPONENT_QUAL_NAME
)
311 if (d_left (comp
)->type
== DEMANGLE_COMPONENT_NAME
)
313 struct demangle_component newobj
;
315 buf
.write (d_left (comp
)->u
.s_name
.s
, d_left (comp
)->u
.s_name
.len
);
317 name
= (char *) obstack_copy0 (&info
->obstack
, buf
.c_str (), len
);
318 newobj
.type
= DEMANGLE_COMPONENT_NAME
;
319 newobj
.u
.s_name
.s
= name
;
320 newobj
.u
.s_name
.len
= len
;
321 if (inspect_type (info
, &newobj
, finder
, data
))
326 /* A typedef was substituted in NEW. Convert it to a
327 string and replace the top DEMANGLE_COMPONENT_QUAL_NAME
331 n
= cp_comp_to_string (&newobj
, 100);
334 /* If something went astray, abort typedef substitutions. */
338 s
= copy_string_to_obstack (&info
->obstack
, n
, &slen
);
341 d_left (ret_comp
)->type
= DEMANGLE_COMPONENT_NAME
;
342 d_left (ret_comp
)->u
.s_name
.s
= s
;
343 d_left (ret_comp
)->u
.s_name
.len
= slen
;
344 d_right (ret_comp
) = d_right (comp
);
351 /* The current node is not a name, so simply replace any
352 typedefs in it. Then print it to the stream to continue
353 checking for more typedefs in the tree. */
354 replace_typedefs (info
, d_left (comp
), finder
, data
);
355 name
= cp_comp_to_string (d_left (comp
), 100);
358 /* If something went astray, abort typedef substitutions. */
366 comp
= d_right (comp
);
369 /* If the next component is DEMANGLE_COMPONENT_NAME, save the qualified
370 name assembled above and append the name given by COMP. Then use this
371 reassembled name to check for a typedef. */
373 if (comp
->type
== DEMANGLE_COMPONENT_NAME
)
375 buf
.write (comp
->u
.s_name
.s
, comp
->u
.s_name
.len
);
377 name
= (char *) obstack_copy0 (&info
->obstack
, buf
.c_str (), len
);
379 /* Replace the top (DEMANGLE_COMPONENT_QUAL_NAME) node
380 with a DEMANGLE_COMPONENT_NAME node containing the whole
382 ret_comp
->type
= DEMANGLE_COMPONENT_NAME
;
383 ret_comp
->u
.s_name
.s
= name
;
384 ret_comp
->u
.s_name
.len
= len
;
385 inspect_type (info
, ret_comp
, finder
, data
);
388 replace_typedefs (info
, comp
, finder
, data
);
392 /* A function to check const and volatile qualifiers for argument types.
394 "Parameter declarations that differ only in the presence
395 or absence of `const' and/or `volatile' are equivalent."
396 C++ Standard N3290, clause 13.1.3 #4. */
399 check_cv_qualifiers (struct demangle_component
*ret_comp
)
401 while (d_left (ret_comp
) != NULL
402 && (d_left (ret_comp
)->type
== DEMANGLE_COMPONENT_CONST
403 || d_left (ret_comp
)->type
== DEMANGLE_COMPONENT_VOLATILE
))
405 d_left (ret_comp
) = d_left (d_left (ret_comp
));
409 /* Walk the parse tree given by RET_COMP, replacing any typedefs with
410 their basic types. */
413 replace_typedefs (struct demangle_parse_info
*info
,
414 struct demangle_component
*ret_comp
,
415 canonicalization_ftype
*finder
,
421 && (ret_comp
->type
== DEMANGLE_COMPONENT_NAME
422 || ret_comp
->type
== DEMANGLE_COMPONENT_QUAL_NAME
423 || ret_comp
->type
== DEMANGLE_COMPONENT_TEMPLATE
424 || ret_comp
->type
== DEMANGLE_COMPONENT_BUILTIN_TYPE
))
426 char *local_name
= cp_comp_to_string (ret_comp
, 10);
428 if (local_name
!= NULL
)
430 struct symbol
*sym
= NULL
;
435 sym
= lookup_symbol (local_name
, 0, VAR_DOMAIN
, 0).symbol
;
437 CATCH (except
, RETURN_MASK_ALL
)
446 struct type
*otype
= SYMBOL_TYPE (sym
);
447 const char *new_name
= (*finder
) (otype
, data
);
449 if (new_name
!= NULL
)
451 ret_comp
->type
= DEMANGLE_COMPONENT_NAME
;
452 ret_comp
->u
.s_name
.s
= new_name
;
453 ret_comp
->u
.s_name
.len
= strlen (new_name
);
460 switch (ret_comp
->type
)
462 case DEMANGLE_COMPONENT_ARGLIST
:
463 check_cv_qualifiers (ret_comp
);
466 case DEMANGLE_COMPONENT_FUNCTION_TYPE
:
467 case DEMANGLE_COMPONENT_TEMPLATE
:
468 case DEMANGLE_COMPONENT_TEMPLATE_ARGLIST
:
469 case DEMANGLE_COMPONENT_TYPED_NAME
:
470 replace_typedefs (info
, d_left (ret_comp
), finder
, data
);
471 replace_typedefs (info
, d_right (ret_comp
), finder
, data
);
474 case DEMANGLE_COMPONENT_NAME
:
475 inspect_type (info
, ret_comp
, finder
, data
);
478 case DEMANGLE_COMPONENT_QUAL_NAME
:
479 replace_typedefs_qualified_name (info
, ret_comp
, finder
, data
);
482 case DEMANGLE_COMPONENT_LOCAL_NAME
:
483 case DEMANGLE_COMPONENT_CTOR
:
484 case DEMANGLE_COMPONENT_ARRAY_TYPE
:
485 case DEMANGLE_COMPONENT_PTRMEM_TYPE
:
486 replace_typedefs (info
, d_right (ret_comp
), finder
, data
);
489 case DEMANGLE_COMPONENT_CONST
:
490 case DEMANGLE_COMPONENT_RESTRICT
:
491 case DEMANGLE_COMPONENT_VOLATILE
:
492 case DEMANGLE_COMPONENT_VOLATILE_THIS
:
493 case DEMANGLE_COMPONENT_CONST_THIS
:
494 case DEMANGLE_COMPONENT_RESTRICT_THIS
:
495 case DEMANGLE_COMPONENT_POINTER
:
496 case DEMANGLE_COMPONENT_REFERENCE
:
497 case DEMANGLE_COMPONENT_RVALUE_REFERENCE
:
498 replace_typedefs (info
, d_left (ret_comp
), finder
, data
);
507 /* Parse STRING and convert it to canonical form, resolving any
508 typedefs. If parsing fails, or if STRING is already canonical,
509 return the empty string. Otherwise return the canonical form. If
510 FINDER is not NULL, then type components are passed to FINDER to be
511 looked up. DATA is passed verbatim to FINDER. */
514 cp_canonicalize_string_full (const char *string
,
515 canonicalization_ftype
*finder
,
519 unsigned int estimated_len
;
520 std::unique_ptr
<demangle_parse_info
> info
;
522 estimated_len
= strlen (string
) * 2;
523 info
= cp_demangled_name_to_comp (string
, NULL
);
526 /* Replace all the typedefs in the tree. */
527 replace_typedefs (info
.get (), info
->tree
, finder
, data
);
529 /* Convert the tree back into a string. */
530 gdb::unique_xmalloc_ptr
<char> us (cp_comp_to_string (info
->tree
,
535 /* Finally, compare the original string with the computed
536 name, returning NULL if they are the same. */
538 return std::string ();
544 /* Like cp_canonicalize_string_full, but always passes NULL for
548 cp_canonicalize_string_no_typedefs (const char *string
)
550 return cp_canonicalize_string_full (string
, NULL
, NULL
);
553 /* Parse STRING and convert it to canonical form. If parsing fails,
554 or if STRING is already canonical, return the empty string.
555 Otherwise return the canonical form. */
558 cp_canonicalize_string (const char *string
)
560 std::unique_ptr
<demangle_parse_info
> info
;
561 unsigned int estimated_len
;
563 if (cp_already_canonical (string
))
564 return std::string ();
566 info
= cp_demangled_name_to_comp (string
, NULL
);
568 return std::string ();
570 estimated_len
= strlen (string
) * 2;
571 gdb::unique_xmalloc_ptr
<char> us (cp_comp_to_string (info
->tree
,
576 warning (_("internal error: string \"%s\" failed to be canonicalized"),
578 return std::string ();
581 std::string
ret (us
.get ());
584 return std::string ();
589 /* Convert a mangled name to a demangle_component tree. *MEMORY is
590 set to the block of used memory that should be freed when finished
591 with the tree. DEMANGLED_P is set to the char * that should be
592 freed when finished with the tree, or NULL if none was needed.
593 OPTIONS will be passed to the demangler. */
595 static std::unique_ptr
<demangle_parse_info
>
596 mangled_name_to_comp (const char *mangled_name
, int options
,
597 void **memory
, char **demangled_p
)
599 char *demangled_name
;
601 /* If it looks like a v3 mangled name, then try to go directly
603 if (mangled_name
[0] == '_' && mangled_name
[1] == 'Z')
605 struct demangle_component
*ret
;
607 ret
= cplus_demangle_v3_components (mangled_name
,
611 std::unique_ptr
<demangle_parse_info
> info (new demangle_parse_info
);
618 /* If it doesn't, or if that failed, then try to demangle the
620 demangled_name
= gdb_demangle (mangled_name
, options
);
621 if (demangled_name
== NULL
)
624 /* If we could demangle the name, parse it to build the component
626 std::unique_ptr
<demangle_parse_info
> info
627 = cp_demangled_name_to_comp (demangled_name
, NULL
);
631 xfree (demangled_name
);
635 *demangled_p
= demangled_name
;
639 /* Return the name of the class containing method PHYSNAME. */
642 cp_class_name_from_physname (const char *physname
)
644 void *storage
= NULL
;
645 char *demangled_name
= NULL
, *ret
;
646 struct demangle_component
*ret_comp
, *prev_comp
, *cur_comp
;
647 std::unique_ptr
<demangle_parse_info
> info
;
650 info
= mangled_name_to_comp (physname
, DMGL_ANSI
,
651 &storage
, &demangled_name
);
656 ret_comp
= info
->tree
;
658 /* First strip off any qualifiers, if we have a function or
661 switch (ret_comp
->type
)
663 case DEMANGLE_COMPONENT_CONST
:
664 case DEMANGLE_COMPONENT_RESTRICT
:
665 case DEMANGLE_COMPONENT_VOLATILE
:
666 case DEMANGLE_COMPONENT_CONST_THIS
:
667 case DEMANGLE_COMPONENT_RESTRICT_THIS
:
668 case DEMANGLE_COMPONENT_VOLATILE_THIS
:
669 case DEMANGLE_COMPONENT_VENDOR_TYPE_QUAL
:
670 ret_comp
= d_left (ret_comp
);
677 /* If what we have now is a function, discard the argument list. */
678 if (ret_comp
->type
== DEMANGLE_COMPONENT_TYPED_NAME
)
679 ret_comp
= d_left (ret_comp
);
681 /* If what we have now is a template, strip off the template
682 arguments. The left subtree may be a qualified name. */
683 if (ret_comp
->type
== DEMANGLE_COMPONENT_TEMPLATE
)
684 ret_comp
= d_left (ret_comp
);
686 /* What we have now should be a name, possibly qualified.
687 Additional qualifiers could live in the left subtree or the right
688 subtree. Find the last piece. */
693 switch (cur_comp
->type
)
695 case DEMANGLE_COMPONENT_QUAL_NAME
:
696 case DEMANGLE_COMPONENT_LOCAL_NAME
:
697 prev_comp
= cur_comp
;
698 cur_comp
= d_right (cur_comp
);
700 case DEMANGLE_COMPONENT_TEMPLATE
:
701 case DEMANGLE_COMPONENT_NAME
:
702 case DEMANGLE_COMPONENT_CTOR
:
703 case DEMANGLE_COMPONENT_DTOR
:
704 case DEMANGLE_COMPONENT_OPERATOR
:
705 case DEMANGLE_COMPONENT_EXTENDED_OPERATOR
:
715 if (cur_comp
!= NULL
&& prev_comp
!= NULL
)
717 /* We want to discard the rightmost child of PREV_COMP. */
718 *prev_comp
= *d_left (prev_comp
);
719 /* The ten is completely arbitrary; we don't have a good
721 ret
= cp_comp_to_string (ret_comp
, 10);
725 xfree (demangled_name
);
729 /* Return the child of COMP which is the basename of a method,
730 variable, et cetera. All scope qualifiers are discarded, but
731 template arguments will be included. The component tree may be
734 static struct demangle_component
*
735 unqualified_name_from_comp (struct demangle_component
*comp
)
737 struct demangle_component
*ret_comp
= comp
, *last_template
;
741 last_template
= NULL
;
743 switch (ret_comp
->type
)
745 case DEMANGLE_COMPONENT_QUAL_NAME
:
746 case DEMANGLE_COMPONENT_LOCAL_NAME
:
747 ret_comp
= d_right (ret_comp
);
749 case DEMANGLE_COMPONENT_TYPED_NAME
:
750 ret_comp
= d_left (ret_comp
);
752 case DEMANGLE_COMPONENT_TEMPLATE
:
753 gdb_assert (last_template
== NULL
);
754 last_template
= ret_comp
;
755 ret_comp
= d_left (ret_comp
);
757 case DEMANGLE_COMPONENT_CONST
:
758 case DEMANGLE_COMPONENT_RESTRICT
:
759 case DEMANGLE_COMPONENT_VOLATILE
:
760 case DEMANGLE_COMPONENT_CONST_THIS
:
761 case DEMANGLE_COMPONENT_RESTRICT_THIS
:
762 case DEMANGLE_COMPONENT_VOLATILE_THIS
:
763 case DEMANGLE_COMPONENT_VENDOR_TYPE_QUAL
:
764 ret_comp
= d_left (ret_comp
);
766 case DEMANGLE_COMPONENT_NAME
:
767 case DEMANGLE_COMPONENT_CTOR
:
768 case DEMANGLE_COMPONENT_DTOR
:
769 case DEMANGLE_COMPONENT_OPERATOR
:
770 case DEMANGLE_COMPONENT_EXTENDED_OPERATOR
:
780 d_left (last_template
) = ret_comp
;
781 return last_template
;
787 /* Return the name of the method whose linkage name is PHYSNAME. */
790 method_name_from_physname (const char *physname
)
792 void *storage
= NULL
;
793 char *demangled_name
= NULL
, *ret
;
794 struct demangle_component
*ret_comp
;
795 std::unique_ptr
<demangle_parse_info
> info
;
797 info
= mangled_name_to_comp (physname
, DMGL_ANSI
,
798 &storage
, &demangled_name
);
802 ret_comp
= unqualified_name_from_comp (info
->tree
);
805 if (ret_comp
!= NULL
)
806 /* The ten is completely arbitrary; we don't have a good
808 ret
= cp_comp_to_string (ret_comp
, 10);
811 xfree (demangled_name
);
815 /* If FULL_NAME is the demangled name of a C++ function (including an
816 arg list, possibly including namespace/class qualifications),
817 return a new string containing only the function name (without the
818 arg list/class qualifications). Otherwise, return NULL. The
819 caller is responsible for freeing the memory in question. */
822 cp_func_name (const char *full_name
)
825 struct demangle_component
*ret_comp
;
826 std::unique_ptr
<demangle_parse_info
> info
;
828 info
= cp_demangled_name_to_comp (full_name
, NULL
);
832 ret_comp
= unqualified_name_from_comp (info
->tree
);
835 if (ret_comp
!= NULL
)
836 ret
= cp_comp_to_string (ret_comp
, 10);
841 /* DEMANGLED_NAME is the name of a function, including parameters and
842 (optionally) a return type. Return the name of the function without
843 parameters or return type, or NULL if we can not parse the name. */
846 cp_remove_params (const char *demangled_name
)
849 struct demangle_component
*ret_comp
;
850 std::unique_ptr
<demangle_parse_info
> info
;
853 if (demangled_name
== NULL
)
856 info
= cp_demangled_name_to_comp (demangled_name
, NULL
);
860 /* First strip off any qualifiers, if we have a function or method. */
861 ret_comp
= info
->tree
;
863 switch (ret_comp
->type
)
865 case DEMANGLE_COMPONENT_CONST
:
866 case DEMANGLE_COMPONENT_RESTRICT
:
867 case DEMANGLE_COMPONENT_VOLATILE
:
868 case DEMANGLE_COMPONENT_CONST_THIS
:
869 case DEMANGLE_COMPONENT_RESTRICT_THIS
:
870 case DEMANGLE_COMPONENT_VOLATILE_THIS
:
871 case DEMANGLE_COMPONENT_VENDOR_TYPE_QUAL
:
872 ret_comp
= d_left (ret_comp
);
879 /* What we have now should be a function. Return its name. */
880 if (ret_comp
->type
== DEMANGLE_COMPONENT_TYPED_NAME
)
881 ret
= cp_comp_to_string (d_left (ret_comp
), 10);
886 /* Here are some random pieces of trivia to keep in mind while trying
887 to take apart demangled names:
889 - Names can contain function arguments or templates, so the process
890 has to be, to some extent recursive: maybe keep track of your
891 depth based on encountering <> and ().
893 - Parentheses don't just have to happen at the end of a name: they
894 can occur even if the name in question isn't a function, because
895 a template argument might be a type that's a function.
897 - Conversely, even if you're trying to deal with a function, its
898 demangled name might not end with ')': it could be a const or
899 volatile class method, in which case it ends with "const" or
902 - Parentheses are also used in anonymous namespaces: a variable
903 'foo' in an anonymous namespace gets demangled as "(anonymous
906 - And operator names can contain parentheses or angle brackets. */
908 /* FIXME: carlton/2003-03-13: We have several functions here with
909 overlapping functionality; can we combine them? Also, do they
910 handle all the above considerations correctly? */
913 /* This returns the length of first component of NAME, which should be
914 the demangled name of a C++ variable/function/method/etc.
915 Specifically, it returns the index of the first colon forming the
916 boundary of the first component: so, given 'A::foo' or 'A::B::foo'
917 it returns the 1, and given 'foo', it returns 0. */
919 /* The character in NAME indexed by the return value is guaranteed to
920 always be either ':' or '\0'. */
922 /* NOTE: carlton/2003-03-13: This function is currently only intended
923 for internal use: it's probably not entirely safe when called on
924 user-generated input, because some of the 'index += 2' lines in
925 cp_find_first_component_aux might go past the end of malformed
929 cp_find_first_component (const char *name
)
931 return cp_find_first_component_aux (name
, 0);
934 /* Helper function for cp_find_first_component. Like that function,
935 it returns the length of the first component of NAME, but to make
936 the recursion easier, it also stops if it reaches an unexpected ')'
937 or '>' if the value of PERMISSIVE is nonzero. */
940 cp_find_first_component_aux (const char *name
, int permissive
)
942 unsigned int index
= 0;
943 /* Operator names can show up in unexpected places. Since these can
944 contain parentheses or angle brackets, they can screw up the
945 recursion. But not every string 'operator' is part of an
946 operater name: e.g. you could have a variable 'cooperator'. So
947 this variable tells us whether or not we should treat the string
948 'operator' as starting an operator. */
949 int operator_possible
= 1;
956 /* Template; eat it up. The calls to cp_first_component
957 should only return (I hope!) when they reach the '>'
958 terminating the component or a '::' between two
959 components. (Hence the '+ 2'.) */
961 for (index
+= cp_find_first_component_aux (name
+ index
, 1);
963 index
+= cp_find_first_component_aux (name
+ index
, 1))
965 if (name
[index
] != ':')
967 demangled_name_complaint (name
);
968 return strlen (name
);
972 operator_possible
= 1;
975 /* Similar comment as to '<'. */
977 for (index
+= cp_find_first_component_aux (name
+ index
, 1);
979 index
+= cp_find_first_component_aux (name
+ index
, 1))
981 if (name
[index
] != ':')
983 demangled_name_complaint (name
);
984 return strlen (name
);
988 operator_possible
= 1;
996 demangled_name_complaint (name
);
997 return strlen (name
);
1002 /* ':' marks a component iff the next character is also a ':'.
1003 Otherwise it is probably malformed input. */
1004 if (name
[index
+ 1] == ':')
1008 /* Operator names can screw up the recursion. */
1009 if (operator_possible
1010 && startswith (name
+ index
, CP_OPERATOR_STR
))
1012 index
+= CP_OPERATOR_LEN
;
1013 while (ISSPACE(name
[index
]))
1015 switch (name
[index
])
1019 /* Skip over one less than the appropriate number of
1020 characters: the for loop will skip over the last
1023 if (name
[index
+ 1] == '<')
1030 if (name
[index
+ 1] == '>')
1043 operator_possible
= 0;
1050 /* NOTE: carlton/2003-04-18: I'm not sure what the precise
1051 set of relevant characters are here: it's necessary to
1052 include any character that can show up before 'operator'
1053 in a demangled name, and it's safe to include any
1054 character that can't be part of an identifier's name. */
1055 operator_possible
= 1;
1058 operator_possible
= 0;
1064 /* Complain about a demangled name that we don't know how to parse.
1065 NAME is the demangled name in question. */
1068 demangled_name_complaint (const char *name
)
1070 complaint (&symfile_complaints
,
1071 "unexpected demangled name '%s'", name
);
1074 /* If NAME is the fully-qualified name of a C++
1075 function/variable/method/etc., this returns the length of its
1076 entire prefix: all of the namespaces and classes that make up its
1077 name. Given 'A::foo', it returns 1, given 'A::B::foo', it returns
1078 4, given 'foo', it returns 0. */
1081 cp_entire_prefix_len (const char *name
)
1083 unsigned int current_len
= cp_find_first_component (name
);
1084 unsigned int previous_len
= 0;
1086 while (name
[current_len
] != '\0')
1088 gdb_assert (name
[current_len
] == ':');
1089 previous_len
= current_len
;
1090 /* Skip the '::'. */
1092 current_len
+= cp_find_first_component (name
+ current_len
);
1095 return previous_len
;
1098 /* Overload resolution functions. */
1100 /* Test to see if SYM is a symbol that we haven't seen corresponding
1101 to a function named OLOAD_NAME. If so, add it to the current
1105 overload_list_add_symbol (struct symbol
*sym
,
1106 const char *oload_name
)
1112 /* If there is no type information, we can't do anything, so
1114 if (SYMBOL_TYPE (sym
) == NULL
)
1117 /* skip any symbols that we've already considered. */
1118 for (i
= 0; i
< sym_return_val_index
; ++i
)
1119 if (strcmp (SYMBOL_LINKAGE_NAME (sym
),
1120 SYMBOL_LINKAGE_NAME (sym_return_val
[i
])) == 0)
1123 /* Get the demangled name without parameters */
1124 sym_name
= cp_remove_params (SYMBOL_NATURAL_NAME (sym
));
1128 /* skip symbols that cannot match */
1129 if (strcmp (sym_name
, oload_name
) != 0)
1137 /* We have a match for an overload instance, so add SYM to the
1138 current list of overload instances */
1139 if (sym_return_val_index
+ 3 > sym_return_val_size
)
1141 newsize
= (sym_return_val_size
*= 2) * sizeof (struct symbol
*);
1142 sym_return_val
= (struct symbol
**)
1143 xrealloc ((char *) sym_return_val
, newsize
);
1145 sym_return_val
[sym_return_val_index
++] = sym
;
1146 sym_return_val
[sym_return_val_index
] = NULL
;
1149 /* Return a null-terminated list of pointers to function symbols that
1150 are named FUNC_NAME and are visible within NAMESPACE. */
1153 make_symbol_overload_list (const char *func_name
,
1154 const char *the_namespace
)
1156 struct cleanup
*old_cleanups
;
1159 sym_return_val_size
= 100;
1160 sym_return_val_index
= 0;
1161 sym_return_val
= XNEWVEC (struct symbol
*, sym_return_val_size
+ 1);
1162 sym_return_val
[0] = NULL
;
1164 old_cleanups
= make_cleanup (xfree
, sym_return_val
);
1166 make_symbol_overload_list_using (func_name
, the_namespace
);
1168 if (the_namespace
[0] == '\0')
1172 char *concatenated_name
1173 = (char *) alloca (strlen (the_namespace
) + 2 + strlen (func_name
) + 1);
1174 strcpy (concatenated_name
, the_namespace
);
1175 strcat (concatenated_name
, "::");
1176 strcat (concatenated_name
, func_name
);
1177 name
= concatenated_name
;
1180 make_symbol_overload_list_qualified (name
);
1182 discard_cleanups (old_cleanups
);
1184 return sym_return_val
;
1187 /* Add all symbols with a name matching NAME in BLOCK to the overload
1191 make_symbol_overload_list_block (const char *name
,
1192 const struct block
*block
)
1194 struct block_iterator iter
;
1197 ALL_BLOCK_SYMBOLS_WITH_NAME (block
, name
, iter
, sym
)
1198 overload_list_add_symbol (sym
, name
);
1201 /* Adds the function FUNC_NAME from NAMESPACE to the overload set. */
1204 make_symbol_overload_list_namespace (const char *func_name
,
1205 const char *the_namespace
)
1208 const struct block
*block
= NULL
;
1210 if (the_namespace
[0] == '\0')
1214 char *concatenated_name
1215 = (char *) alloca (strlen (the_namespace
) + 2 + strlen (func_name
) + 1);
1217 strcpy (concatenated_name
, the_namespace
);
1218 strcat (concatenated_name
, "::");
1219 strcat (concatenated_name
, func_name
);
1220 name
= concatenated_name
;
1223 /* Look in the static block. */
1224 block
= block_static_block (get_selected_block (0));
1226 make_symbol_overload_list_block (name
, block
);
1228 /* Look in the global block. */
1229 block
= block_global_block (block
);
1231 make_symbol_overload_list_block (name
, block
);
1235 /* Search the namespace of the given type and namespace of and public
1239 make_symbol_overload_list_adl_namespace (struct type
*type
,
1240 const char *func_name
)
1242 char *the_namespace
;
1243 const char *type_name
;
1246 while (TYPE_CODE (type
) == TYPE_CODE_PTR
1247 || TYPE_IS_REFERENCE (type
)
1248 || TYPE_CODE (type
) == TYPE_CODE_ARRAY
1249 || TYPE_CODE (type
) == TYPE_CODE_TYPEDEF
)
1251 if (TYPE_CODE (type
) == TYPE_CODE_TYPEDEF
)
1252 type
= check_typedef(type
);
1254 type
= TYPE_TARGET_TYPE (type
);
1257 type_name
= TYPE_NAME (type
);
1259 if (type_name
== NULL
)
1262 prefix_len
= cp_entire_prefix_len (type_name
);
1264 if (prefix_len
!= 0)
1266 the_namespace
= (char *) alloca (prefix_len
+ 1);
1267 strncpy (the_namespace
, type_name
, prefix_len
);
1268 the_namespace
[prefix_len
] = '\0';
1270 make_symbol_overload_list_namespace (func_name
, the_namespace
);
1273 /* Check public base type */
1274 if (TYPE_CODE (type
) == TYPE_CODE_STRUCT
)
1275 for (i
= 0; i
< TYPE_N_BASECLASSES (type
); i
++)
1277 if (BASETYPE_VIA_PUBLIC (type
, i
))
1278 make_symbol_overload_list_adl_namespace (TYPE_BASECLASS (type
,
1284 /* Adds the overload list overload candidates for FUNC_NAME found
1285 through argument dependent lookup. */
1288 make_symbol_overload_list_adl (struct type
**arg_types
, int nargs
,
1289 const char *func_name
)
1293 gdb_assert (sym_return_val_size
!= -1);
1295 for (i
= 1; i
<= nargs
; i
++)
1296 make_symbol_overload_list_adl_namespace (arg_types
[i
- 1],
1299 return sym_return_val
;
1302 /* Used for cleanups to reset the "searched" flag in case of an
1306 reset_directive_searched (void *data
)
1308 struct using_direct
*direct
= (struct using_direct
*) data
;
1309 direct
->searched
= 0;
1312 /* This applies the using directives to add namespaces to search in,
1313 and then searches for overloads in all of those namespaces. It
1314 adds the symbols found to sym_return_val. Arguments are as in
1315 make_symbol_overload_list. */
1318 make_symbol_overload_list_using (const char *func_name
,
1319 const char *the_namespace
)
1321 struct using_direct
*current
;
1322 const struct block
*block
;
1324 /* First, go through the using directives. If any of them apply,
1325 look in the appropriate namespaces for new functions to match
1328 for (block
= get_selected_block (0);
1330 block
= BLOCK_SUPERBLOCK (block
))
1331 for (current
= block_using (block
);
1333 current
= current
->next
)
1335 /* Prevent recursive calls. */
1336 if (current
->searched
)
1339 /* If this is a namespace alias or imported declaration ignore
1341 if (current
->alias
!= NULL
|| current
->declaration
!= NULL
)
1344 if (strcmp (the_namespace
, current
->import_dest
) == 0)
1346 /* Mark this import as searched so that the recursive call
1347 does not search it again. */
1348 struct cleanup
*old_chain
;
1349 current
->searched
= 1;
1350 old_chain
= make_cleanup (reset_directive_searched
,
1353 make_symbol_overload_list_using (func_name
,
1354 current
->import_src
);
1356 current
->searched
= 0;
1357 discard_cleanups (old_chain
);
1361 /* Now, add names for this namespace. */
1362 make_symbol_overload_list_namespace (func_name
, the_namespace
);
1365 /* This does the bulk of the work of finding overloaded symbols.
1366 FUNC_NAME is the name of the overloaded function we're looking for
1367 (possibly including namespace info). */
1370 make_symbol_overload_list_qualified (const char *func_name
)
1372 struct compunit_symtab
*cust
;
1373 struct objfile
*objfile
;
1374 const struct block
*b
, *surrounding_static_block
= 0;
1376 /* Look through the partial symtabs for all symbols which begin by
1377 matching FUNC_NAME. Make sure we read that symbol table in. */
1379 ALL_OBJFILES (objfile
)
1382 objfile
->sf
->qf
->expand_symtabs_for_function (objfile
, func_name
);
1385 /* Search upwards from currently selected frame (so that we can
1386 complete on local vars. */
1388 for (b
= get_selected_block (0); b
!= NULL
; b
= BLOCK_SUPERBLOCK (b
))
1389 make_symbol_overload_list_block (func_name
, b
);
1391 surrounding_static_block
= block_static_block (get_selected_block (0));
1393 /* Go through the symtabs and check the externs and statics for
1394 symbols which match. */
1396 ALL_COMPUNITS (objfile
, cust
)
1399 b
= BLOCKVECTOR_BLOCK (COMPUNIT_BLOCKVECTOR (cust
), GLOBAL_BLOCK
);
1400 make_symbol_overload_list_block (func_name
, b
);
1403 ALL_COMPUNITS (objfile
, cust
)
1406 b
= BLOCKVECTOR_BLOCK (COMPUNIT_BLOCKVECTOR (cust
), STATIC_BLOCK
);
1407 /* Don't do this block twice. */
1408 if (b
== surrounding_static_block
)
1410 make_symbol_overload_list_block (func_name
, b
);
1414 /* Lookup the rtti type for a class name. */
1417 cp_lookup_rtti_type (const char *name
, struct block
*block
)
1419 struct symbol
* rtti_sym
;
1420 struct type
* rtti_type
;
1422 /* Use VAR_DOMAIN here as NAME may be a typedef. PR 18141, 18417.
1423 Classes "live" in both STRUCT_DOMAIN and VAR_DOMAIN. */
1424 rtti_sym
= lookup_symbol (name
, block
, VAR_DOMAIN
, NULL
).symbol
;
1426 if (rtti_sym
== NULL
)
1428 warning (_("RTTI symbol not found for class '%s'"), name
);
1432 if (SYMBOL_CLASS (rtti_sym
) != LOC_TYPEDEF
)
1434 warning (_("RTTI symbol for class '%s' is not a type"), name
);
1438 rtti_type
= check_typedef (SYMBOL_TYPE (rtti_sym
));
1440 switch (TYPE_CODE (rtti_type
))
1442 case TYPE_CODE_STRUCT
:
1444 case TYPE_CODE_NAMESPACE
:
1445 /* chastain/2003-11-26: the symbol tables often contain fake
1446 symbols for namespaces with the same name as the struct.
1447 This warning is an indication of a bug in the lookup order
1448 or a bug in the way that the symbol tables are populated. */
1449 warning (_("RTTI symbol for class '%s' is a namespace"), name
);
1452 warning (_("RTTI symbol for class '%s' has bad type"), name
);
1459 #ifdef HAVE_WORKING_FORK
1461 /* If nonzero, attempt to catch crashes in the demangler and print
1462 useful debugging information. */
1464 static int catch_demangler_crashes
= 1;
1466 /* Stack context and environment for demangler crash recovery. */
1468 static SIGJMP_BUF gdb_demangle_jmp_buf
;
1470 /* If nonzero, attempt to dump core from the signal handler. */
1472 static int gdb_demangle_attempt_core_dump
= 1;
1474 /* Signal handler for gdb_demangle. */
1477 gdb_demangle_signal_handler (int signo
)
1479 if (gdb_demangle_attempt_core_dump
)
1484 gdb_demangle_attempt_core_dump
= 0;
1487 SIGLONGJMP (gdb_demangle_jmp_buf
, signo
);
1492 /* A wrapper for bfd_demangle. */
1495 gdb_demangle (const char *name
, int options
)
1497 char *result
= NULL
;
1498 int crash_signal
= 0;
1500 #ifdef HAVE_WORKING_FORK
1501 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
1502 struct sigaction sa
, old_sa
;
1506 static int core_dump_allowed
= -1;
1508 if (core_dump_allowed
== -1)
1510 core_dump_allowed
= can_dump_core (LIMIT_CUR
);
1512 if (!core_dump_allowed
)
1513 gdb_demangle_attempt_core_dump
= 0;
1516 if (catch_demangler_crashes
)
1518 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
1519 sa
.sa_handler
= gdb_demangle_signal_handler
;
1520 sigemptyset (&sa
.sa_mask
);
1521 #ifdef HAVE_SIGALTSTACK
1522 sa
.sa_flags
= SA_ONSTACK
;
1526 sigaction (SIGSEGV
, &sa
, &old_sa
);
1528 ofunc
= signal (SIGSEGV
, gdb_demangle_signal_handler
);
1531 crash_signal
= SIGSETJMP (gdb_demangle_jmp_buf
);
1535 if (crash_signal
== 0)
1536 result
= bfd_demangle (NULL
, name
, options
);
1538 #ifdef HAVE_WORKING_FORK
1539 if (catch_demangler_crashes
)
1541 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
1542 sigaction (SIGSEGV
, &old_sa
, NULL
);
1544 signal (SIGSEGV
, ofunc
);
1547 if (crash_signal
!= 0)
1549 static int error_reported
= 0;
1551 if (!error_reported
)
1553 char *short_msg
, *long_msg
;
1554 struct cleanup
*back_to
;
1556 short_msg
= xstrprintf (_("unable to demangle '%s' "
1557 "(demangler failed with signal %d)"),
1558 name
, crash_signal
);
1559 back_to
= make_cleanup (xfree
, short_msg
);
1561 long_msg
= xstrprintf ("%s:%d: %s: %s", __FILE__
, __LINE__
,
1562 "demangler-warning", short_msg
);
1563 make_cleanup (xfree
, long_msg
);
1565 make_cleanup_restore_target_terminal ();
1566 target_terminal_ours_for_output ();
1569 if (core_dump_allowed
)
1570 fprintf_unfiltered (gdb_stderr
,
1571 _("%s\nAttempting to dump core.\n"),
1574 warn_cant_dump_core (long_msg
);
1576 demangler_warning (__FILE__
, __LINE__
, "%s", short_msg
);
1578 do_cleanups (back_to
);
1591 /* See cp-support.h. */
1594 gdb_sniff_from_mangled_name (const char *mangled
, char **demangled
)
1596 *demangled
= gdb_demangle (mangled
, DMGL_PARAMS
| DMGL_ANSI
);
1597 return *demangled
!= NULL
;
1600 /* Don't allow just "maintenance cplus". */
1603 maint_cplus_command (char *arg
, int from_tty
)
1605 printf_unfiltered (_("\"maintenance cplus\" must be followed "
1606 "by the name of a command.\n"));
1607 help_list (maint_cplus_cmd_list
,
1608 "maintenance cplus ",
1609 all_commands
, gdb_stdout
);
1612 /* This is a front end for cp_find_first_component, for unit testing.
1613 Be careful when using it: see the NOTE above
1614 cp_find_first_component. */
1617 first_component_command (char *arg
, int from_tty
)
1625 len
= cp_find_first_component (arg
);
1626 prefix
= (char *) alloca (len
+ 1);
1628 memcpy (prefix
, arg
, len
);
1631 printf_unfiltered ("%s\n", prefix
);
1634 extern initialize_file_ftype _initialize_cp_support
; /* -Wmissing-prototypes */
1637 /* Implement "info vtbl". */
1640 info_vtbl_command (char *arg
, int from_tty
)
1642 struct value
*value
;
1644 value
= parse_and_eval (arg
);
1645 cplus_print_vtable (value
);
1649 _initialize_cp_support (void)
1651 add_prefix_cmd ("cplus", class_maintenance
,
1652 maint_cplus_command
,
1653 _("C++ maintenance commands."),
1654 &maint_cplus_cmd_list
,
1655 "maintenance cplus ",
1656 0, &maintenancelist
);
1657 add_alias_cmd ("cp", "cplus",
1658 class_maintenance
, 1,
1661 add_cmd ("first_component",
1663 first_component_command
,
1664 _("Print the first class/namespace component of NAME."),
1665 &maint_cplus_cmd_list
);
1667 add_info ("vtbl", info_vtbl_command
,
1668 _("Show the virtual function table for a C++ object.\n\
1669 Usage: info vtbl EXPRESSION\n\
1670 Evaluate EXPRESSION and display the virtual function table for the\n\
1671 resulting object."));
1673 #ifdef HAVE_WORKING_FORK
1674 add_setshow_boolean_cmd ("catch-demangler-crashes", class_maintenance
,
1675 &catch_demangler_crashes
, _("\
1676 Set whether to attempt to catch demangler crashes."), _("\
1677 Show whether to attempt to catch demangler crashes."), _("\
1678 If enabled GDB will attempt to catch demangler crashes and\n\
1679 display the offending symbol."),
1682 &maintenance_set_cmdlist
,
1683 &maintenance_show_cmdlist
);