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 ret
= cp_comp_to_string (info
->tree
, estimated_len
);
531 gdb_assert (!ret
.empty ());
533 /* Finally, compare the original string with the computed
534 name, returning NULL if they are the same. */
536 return std::string ();
542 /* Like cp_canonicalize_string_full, but always passes NULL for
546 cp_canonicalize_string_no_typedefs (const char *string
)
548 return cp_canonicalize_string_full (string
, NULL
, NULL
);
551 /* Parse STRING and convert it to canonical form. If parsing fails,
552 or if STRING is already canonical, return the empty string.
553 Otherwise return the canonical form. */
556 cp_canonicalize_string (const char *string
)
558 std::unique_ptr
<demangle_parse_info
> info
;
559 unsigned int estimated_len
;
561 if (cp_already_canonical (string
))
562 return std::string ();
564 info
= cp_demangled_name_to_comp (string
, NULL
);
566 return std::string ();
568 estimated_len
= strlen (string
) * 2;
569 std::string ret
= cp_comp_to_string (info
->tree
, estimated_len
);
573 warning (_("internal error: string \"%s\" failed to be canonicalized"),
575 return std::string ();
579 return std::string ();
584 /* Convert a mangled name to a demangle_component tree. *MEMORY is
585 set to the block of used memory that should be freed when finished
586 with the tree. DEMANGLED_P is set to the char * that should be
587 freed when finished with the tree, or NULL if none was needed.
588 OPTIONS will be passed to the demangler. */
590 static std::unique_ptr
<demangle_parse_info
>
591 mangled_name_to_comp (const char *mangled_name
, int options
,
592 void **memory
, char **demangled_p
)
594 char *demangled_name
;
596 /* If it looks like a v3 mangled name, then try to go directly
598 if (mangled_name
[0] == '_' && mangled_name
[1] == 'Z')
600 struct demangle_component
*ret
;
602 ret
= cplus_demangle_v3_components (mangled_name
,
606 std::unique_ptr
<demangle_parse_info
> info (new demangle_parse_info
);
613 /* If it doesn't, or if that failed, then try to demangle the
615 demangled_name
= gdb_demangle (mangled_name
, options
);
616 if (demangled_name
== NULL
)
619 /* If we could demangle the name, parse it to build the component
621 std::unique_ptr
<demangle_parse_info
> info
622 = cp_demangled_name_to_comp (demangled_name
, NULL
);
626 xfree (demangled_name
);
630 *demangled_p
= demangled_name
;
634 /* Return the name of the class containing method PHYSNAME. */
637 cp_class_name_from_physname (const char *physname
)
639 void *storage
= NULL
;
640 char *demangled_name
= NULL
, *ret
;
641 struct demangle_component
*ret_comp
, *prev_comp
, *cur_comp
;
642 std::unique_ptr
<demangle_parse_info
> info
;
645 info
= mangled_name_to_comp (physname
, DMGL_ANSI
,
646 &storage
, &demangled_name
);
651 ret_comp
= info
->tree
;
653 /* First strip off any qualifiers, if we have a function or
656 switch (ret_comp
->type
)
658 case DEMANGLE_COMPONENT_CONST
:
659 case DEMANGLE_COMPONENT_RESTRICT
:
660 case DEMANGLE_COMPONENT_VOLATILE
:
661 case DEMANGLE_COMPONENT_CONST_THIS
:
662 case DEMANGLE_COMPONENT_RESTRICT_THIS
:
663 case DEMANGLE_COMPONENT_VOLATILE_THIS
:
664 case DEMANGLE_COMPONENT_VENDOR_TYPE_QUAL
:
665 ret_comp
= d_left (ret_comp
);
672 /* If what we have now is a function, discard the argument list. */
673 if (ret_comp
->type
== DEMANGLE_COMPONENT_TYPED_NAME
)
674 ret_comp
= d_left (ret_comp
);
676 /* If what we have now is a template, strip off the template
677 arguments. The left subtree may be a qualified name. */
678 if (ret_comp
->type
== DEMANGLE_COMPONENT_TEMPLATE
)
679 ret_comp
= d_left (ret_comp
);
681 /* What we have now should be a name, possibly qualified.
682 Additional qualifiers could live in the left subtree or the right
683 subtree. Find the last piece. */
688 switch (cur_comp
->type
)
690 case DEMANGLE_COMPONENT_QUAL_NAME
:
691 case DEMANGLE_COMPONENT_LOCAL_NAME
:
692 prev_comp
= cur_comp
;
693 cur_comp
= d_right (cur_comp
);
695 case DEMANGLE_COMPONENT_TEMPLATE
:
696 case DEMANGLE_COMPONENT_NAME
:
697 case DEMANGLE_COMPONENT_CTOR
:
698 case DEMANGLE_COMPONENT_DTOR
:
699 case DEMANGLE_COMPONENT_OPERATOR
:
700 case DEMANGLE_COMPONENT_EXTENDED_OPERATOR
:
710 if (cur_comp
!= NULL
&& prev_comp
!= NULL
)
712 /* We want to discard the rightmost child of PREV_COMP. */
713 *prev_comp
= *d_left (prev_comp
);
714 /* The ten is completely arbitrary; we don't have a good
716 ret
= cp_comp_to_string (ret_comp
, 10);
720 xfree (demangled_name
);
724 /* Return the child of COMP which is the basename of a method,
725 variable, et cetera. All scope qualifiers are discarded, but
726 template arguments will be included. The component tree may be
729 static struct demangle_component
*
730 unqualified_name_from_comp (struct demangle_component
*comp
)
732 struct demangle_component
*ret_comp
= comp
, *last_template
;
736 last_template
= NULL
;
738 switch (ret_comp
->type
)
740 case DEMANGLE_COMPONENT_QUAL_NAME
:
741 case DEMANGLE_COMPONENT_LOCAL_NAME
:
742 ret_comp
= d_right (ret_comp
);
744 case DEMANGLE_COMPONENT_TYPED_NAME
:
745 ret_comp
= d_left (ret_comp
);
747 case DEMANGLE_COMPONENT_TEMPLATE
:
748 gdb_assert (last_template
== NULL
);
749 last_template
= ret_comp
;
750 ret_comp
= d_left (ret_comp
);
752 case DEMANGLE_COMPONENT_CONST
:
753 case DEMANGLE_COMPONENT_RESTRICT
:
754 case DEMANGLE_COMPONENT_VOLATILE
:
755 case DEMANGLE_COMPONENT_CONST_THIS
:
756 case DEMANGLE_COMPONENT_RESTRICT_THIS
:
757 case DEMANGLE_COMPONENT_VOLATILE_THIS
:
758 case DEMANGLE_COMPONENT_VENDOR_TYPE_QUAL
:
759 ret_comp
= d_left (ret_comp
);
761 case DEMANGLE_COMPONENT_NAME
:
762 case DEMANGLE_COMPONENT_CTOR
:
763 case DEMANGLE_COMPONENT_DTOR
:
764 case DEMANGLE_COMPONENT_OPERATOR
:
765 case DEMANGLE_COMPONENT_EXTENDED_OPERATOR
:
775 d_left (last_template
) = ret_comp
;
776 return last_template
;
782 /* Return the name of the method whose linkage name is PHYSNAME. */
785 method_name_from_physname (const char *physname
)
787 void *storage
= NULL
;
788 char *demangled_name
= NULL
, *ret
;
789 struct demangle_component
*ret_comp
;
790 std::unique_ptr
<demangle_parse_info
> info
;
792 info
= mangled_name_to_comp (physname
, DMGL_ANSI
,
793 &storage
, &demangled_name
);
797 ret_comp
= unqualified_name_from_comp (info
->tree
);
800 if (ret_comp
!= NULL
)
801 /* The ten is completely arbitrary; we don't have a good
803 ret
= cp_comp_to_string (ret_comp
, 10);
806 xfree (demangled_name
);
810 /* If FULL_NAME is the demangled name of a C++ function (including an
811 arg list, possibly including namespace/class qualifications),
812 return a new string containing only the function name (without the
813 arg list/class qualifications). Otherwise, return NULL. The
814 caller is responsible for freeing the memory in question. */
817 cp_func_name (const char *full_name
)
820 struct demangle_component
*ret_comp
;
821 std::unique_ptr
<demangle_parse_info
> info
;
823 info
= cp_demangled_name_to_comp (full_name
, NULL
);
827 ret_comp
= unqualified_name_from_comp (info
->tree
);
830 if (ret_comp
!= NULL
)
831 ret
= cp_comp_to_string (ret_comp
, 10);
836 /* DEMANGLED_NAME is the name of a function, including parameters and
837 (optionally) a return type. Return the name of the function without
838 parameters or return type, or NULL if we can not parse the name. */
841 cp_remove_params (const char *demangled_name
)
844 struct demangle_component
*ret_comp
;
845 std::unique_ptr
<demangle_parse_info
> info
;
848 if (demangled_name
== NULL
)
851 info
= cp_demangled_name_to_comp (demangled_name
, NULL
);
855 /* First strip off any qualifiers, if we have a function or method. */
856 ret_comp
= info
->tree
;
858 switch (ret_comp
->type
)
860 case DEMANGLE_COMPONENT_CONST
:
861 case DEMANGLE_COMPONENT_RESTRICT
:
862 case DEMANGLE_COMPONENT_VOLATILE
:
863 case DEMANGLE_COMPONENT_CONST_THIS
:
864 case DEMANGLE_COMPONENT_RESTRICT_THIS
:
865 case DEMANGLE_COMPONENT_VOLATILE_THIS
:
866 case DEMANGLE_COMPONENT_VENDOR_TYPE_QUAL
:
867 ret_comp
= d_left (ret_comp
);
874 /* What we have now should be a function. Return its name. */
875 if (ret_comp
->type
== DEMANGLE_COMPONENT_TYPED_NAME
)
876 ret
= cp_comp_to_string (d_left (ret_comp
), 10);
881 /* Here are some random pieces of trivia to keep in mind while trying
882 to take apart demangled names:
884 - Names can contain function arguments or templates, so the process
885 has to be, to some extent recursive: maybe keep track of your
886 depth based on encountering <> and ().
888 - Parentheses don't just have to happen at the end of a name: they
889 can occur even if the name in question isn't a function, because
890 a template argument might be a type that's a function.
892 - Conversely, even if you're trying to deal with a function, its
893 demangled name might not end with ')': it could be a const or
894 volatile class method, in which case it ends with "const" or
897 - Parentheses are also used in anonymous namespaces: a variable
898 'foo' in an anonymous namespace gets demangled as "(anonymous
901 - And operator names can contain parentheses or angle brackets. */
903 /* FIXME: carlton/2003-03-13: We have several functions here with
904 overlapping functionality; can we combine them? Also, do they
905 handle all the above considerations correctly? */
908 /* This returns the length of first component of NAME, which should be
909 the demangled name of a C++ variable/function/method/etc.
910 Specifically, it returns the index of the first colon forming the
911 boundary of the first component: so, given 'A::foo' or 'A::B::foo'
912 it returns the 1, and given 'foo', it returns 0. */
914 /* The character in NAME indexed by the return value is guaranteed to
915 always be either ':' or '\0'. */
917 /* NOTE: carlton/2003-03-13: This function is currently only intended
918 for internal use: it's probably not entirely safe when called on
919 user-generated input, because some of the 'index += 2' lines in
920 cp_find_first_component_aux might go past the end of malformed
924 cp_find_first_component (const char *name
)
926 return cp_find_first_component_aux (name
, 0);
929 /* Helper function for cp_find_first_component. Like that function,
930 it returns the length of the first component of NAME, but to make
931 the recursion easier, it also stops if it reaches an unexpected ')'
932 or '>' if the value of PERMISSIVE is nonzero. */
935 cp_find_first_component_aux (const char *name
, int permissive
)
937 unsigned int index
= 0;
938 /* Operator names can show up in unexpected places. Since these can
939 contain parentheses or angle brackets, they can screw up the
940 recursion. But not every string 'operator' is part of an
941 operater name: e.g. you could have a variable 'cooperator'. So
942 this variable tells us whether or not we should treat the string
943 'operator' as starting an operator. */
944 int operator_possible
= 1;
951 /* Template; eat it up. The calls to cp_first_component
952 should only return (I hope!) when they reach the '>'
953 terminating the component or a '::' between two
954 components. (Hence the '+ 2'.) */
956 for (index
+= cp_find_first_component_aux (name
+ index
, 1);
958 index
+= cp_find_first_component_aux (name
+ index
, 1))
960 if (name
[index
] != ':')
962 demangled_name_complaint (name
);
963 return strlen (name
);
967 operator_possible
= 1;
970 /* Similar comment as to '<'. */
972 for (index
+= cp_find_first_component_aux (name
+ index
, 1);
974 index
+= cp_find_first_component_aux (name
+ index
, 1))
976 if (name
[index
] != ':')
978 demangled_name_complaint (name
);
979 return strlen (name
);
983 operator_possible
= 1;
991 demangled_name_complaint (name
);
992 return strlen (name
);
997 /* ':' marks a component iff the next character is also a ':'.
998 Otherwise it is probably malformed input. */
999 if (name
[index
+ 1] == ':')
1003 /* Operator names can screw up the recursion. */
1004 if (operator_possible
1005 && startswith (name
+ index
, CP_OPERATOR_STR
))
1007 index
+= CP_OPERATOR_LEN
;
1008 while (ISSPACE(name
[index
]))
1010 switch (name
[index
])
1014 /* Skip over one less than the appropriate number of
1015 characters: the for loop will skip over the last
1018 if (name
[index
+ 1] == '<')
1025 if (name
[index
+ 1] == '>')
1038 operator_possible
= 0;
1045 /* NOTE: carlton/2003-04-18: I'm not sure what the precise
1046 set of relevant characters are here: it's necessary to
1047 include any character that can show up before 'operator'
1048 in a demangled name, and it's safe to include any
1049 character that can't be part of an identifier's name. */
1050 operator_possible
= 1;
1053 operator_possible
= 0;
1059 /* Complain about a demangled name that we don't know how to parse.
1060 NAME is the demangled name in question. */
1063 demangled_name_complaint (const char *name
)
1065 complaint (&symfile_complaints
,
1066 "unexpected demangled name '%s'", name
);
1069 /* If NAME is the fully-qualified name of a C++
1070 function/variable/method/etc., this returns the length of its
1071 entire prefix: all of the namespaces and classes that make up its
1072 name. Given 'A::foo', it returns 1, given 'A::B::foo', it returns
1073 4, given 'foo', it returns 0. */
1076 cp_entire_prefix_len (const char *name
)
1078 unsigned int current_len
= cp_find_first_component (name
);
1079 unsigned int previous_len
= 0;
1081 while (name
[current_len
] != '\0')
1083 gdb_assert (name
[current_len
] == ':');
1084 previous_len
= current_len
;
1085 /* Skip the '::'. */
1087 current_len
+= cp_find_first_component (name
+ current_len
);
1090 return previous_len
;
1093 /* Overload resolution functions. */
1095 /* Test to see if SYM is a symbol that we haven't seen corresponding
1096 to a function named OLOAD_NAME. If so, add it to the current
1100 overload_list_add_symbol (struct symbol
*sym
,
1101 const char *oload_name
)
1107 /* If there is no type information, we can't do anything, so
1109 if (SYMBOL_TYPE (sym
) == NULL
)
1112 /* skip any symbols that we've already considered. */
1113 for (i
= 0; i
< sym_return_val_index
; ++i
)
1114 if (strcmp (SYMBOL_LINKAGE_NAME (sym
),
1115 SYMBOL_LINKAGE_NAME (sym_return_val
[i
])) == 0)
1118 /* Get the demangled name without parameters */
1119 sym_name
= cp_remove_params (SYMBOL_NATURAL_NAME (sym
));
1123 /* skip symbols that cannot match */
1124 if (strcmp (sym_name
, oload_name
) != 0)
1132 /* We have a match for an overload instance, so add SYM to the
1133 current list of overload instances */
1134 if (sym_return_val_index
+ 3 > sym_return_val_size
)
1136 newsize
= (sym_return_val_size
*= 2) * sizeof (struct symbol
*);
1137 sym_return_val
= (struct symbol
**)
1138 xrealloc ((char *) sym_return_val
, newsize
);
1140 sym_return_val
[sym_return_val_index
++] = sym
;
1141 sym_return_val
[sym_return_val_index
] = NULL
;
1144 /* Return a null-terminated list of pointers to function symbols that
1145 are named FUNC_NAME and are visible within NAMESPACE. */
1148 make_symbol_overload_list (const char *func_name
,
1149 const char *the_namespace
)
1151 struct cleanup
*old_cleanups
;
1154 sym_return_val_size
= 100;
1155 sym_return_val_index
= 0;
1156 sym_return_val
= XNEWVEC (struct symbol
*, sym_return_val_size
+ 1);
1157 sym_return_val
[0] = NULL
;
1159 old_cleanups
= make_cleanup (xfree
, sym_return_val
);
1161 make_symbol_overload_list_using (func_name
, the_namespace
);
1163 if (the_namespace
[0] == '\0')
1167 char *concatenated_name
1168 = (char *) alloca (strlen (the_namespace
) + 2 + strlen (func_name
) + 1);
1169 strcpy (concatenated_name
, the_namespace
);
1170 strcat (concatenated_name
, "::");
1171 strcat (concatenated_name
, func_name
);
1172 name
= concatenated_name
;
1175 make_symbol_overload_list_qualified (name
);
1177 discard_cleanups (old_cleanups
);
1179 return sym_return_val
;
1182 /* Add all symbols with a name matching NAME in BLOCK to the overload
1186 make_symbol_overload_list_block (const char *name
,
1187 const struct block
*block
)
1189 struct block_iterator iter
;
1192 ALL_BLOCK_SYMBOLS_WITH_NAME (block
, name
, iter
, sym
)
1193 overload_list_add_symbol (sym
, name
);
1196 /* Adds the function FUNC_NAME from NAMESPACE to the overload set. */
1199 make_symbol_overload_list_namespace (const char *func_name
,
1200 const char *the_namespace
)
1203 const struct block
*block
= NULL
;
1205 if (the_namespace
[0] == '\0')
1209 char *concatenated_name
1210 = (char *) alloca (strlen (the_namespace
) + 2 + strlen (func_name
) + 1);
1212 strcpy (concatenated_name
, the_namespace
);
1213 strcat (concatenated_name
, "::");
1214 strcat (concatenated_name
, func_name
);
1215 name
= concatenated_name
;
1218 /* Look in the static block. */
1219 block
= block_static_block (get_selected_block (0));
1221 make_symbol_overload_list_block (name
, block
);
1223 /* Look in the global block. */
1224 block
= block_global_block (block
);
1226 make_symbol_overload_list_block (name
, block
);
1230 /* Search the namespace of the given type and namespace of and public
1234 make_symbol_overload_list_adl_namespace (struct type
*type
,
1235 const char *func_name
)
1237 char *the_namespace
;
1238 const char *type_name
;
1241 while (TYPE_CODE (type
) == TYPE_CODE_PTR
1242 || TYPE_IS_REFERENCE (type
)
1243 || TYPE_CODE (type
) == TYPE_CODE_ARRAY
1244 || TYPE_CODE (type
) == TYPE_CODE_TYPEDEF
)
1246 if (TYPE_CODE (type
) == TYPE_CODE_TYPEDEF
)
1247 type
= check_typedef(type
);
1249 type
= TYPE_TARGET_TYPE (type
);
1252 type_name
= TYPE_NAME (type
);
1254 if (type_name
== NULL
)
1257 prefix_len
= cp_entire_prefix_len (type_name
);
1259 if (prefix_len
!= 0)
1261 the_namespace
= (char *) alloca (prefix_len
+ 1);
1262 strncpy (the_namespace
, type_name
, prefix_len
);
1263 the_namespace
[prefix_len
] = '\0';
1265 make_symbol_overload_list_namespace (func_name
, the_namespace
);
1268 /* Check public base type */
1269 if (TYPE_CODE (type
) == TYPE_CODE_STRUCT
)
1270 for (i
= 0; i
< TYPE_N_BASECLASSES (type
); i
++)
1272 if (BASETYPE_VIA_PUBLIC (type
, i
))
1273 make_symbol_overload_list_adl_namespace (TYPE_BASECLASS (type
,
1279 /* Adds the overload list overload candidates for FUNC_NAME found
1280 through argument dependent lookup. */
1283 make_symbol_overload_list_adl (struct type
**arg_types
, int nargs
,
1284 const char *func_name
)
1288 gdb_assert (sym_return_val_size
!= -1);
1290 for (i
= 1; i
<= nargs
; i
++)
1291 make_symbol_overload_list_adl_namespace (arg_types
[i
- 1],
1294 return sym_return_val
;
1297 /* Used for cleanups to reset the "searched" flag in case of an
1301 reset_directive_searched (void *data
)
1303 struct using_direct
*direct
= (struct using_direct
*) data
;
1304 direct
->searched
= 0;
1307 /* This applies the using directives to add namespaces to search in,
1308 and then searches for overloads in all of those namespaces. It
1309 adds the symbols found to sym_return_val. Arguments are as in
1310 make_symbol_overload_list. */
1313 make_symbol_overload_list_using (const char *func_name
,
1314 const char *the_namespace
)
1316 struct using_direct
*current
;
1317 const struct block
*block
;
1319 /* First, go through the using directives. If any of them apply,
1320 look in the appropriate namespaces for new functions to match
1323 for (block
= get_selected_block (0);
1325 block
= BLOCK_SUPERBLOCK (block
))
1326 for (current
= block_using (block
);
1328 current
= current
->next
)
1330 /* Prevent recursive calls. */
1331 if (current
->searched
)
1334 /* If this is a namespace alias or imported declaration ignore
1336 if (current
->alias
!= NULL
|| current
->declaration
!= NULL
)
1339 if (strcmp (the_namespace
, current
->import_dest
) == 0)
1341 /* Mark this import as searched so that the recursive call
1342 does not search it again. */
1343 struct cleanup
*old_chain
;
1344 current
->searched
= 1;
1345 old_chain
= make_cleanup (reset_directive_searched
,
1348 make_symbol_overload_list_using (func_name
,
1349 current
->import_src
);
1351 current
->searched
= 0;
1352 discard_cleanups (old_chain
);
1356 /* Now, add names for this namespace. */
1357 make_symbol_overload_list_namespace (func_name
, the_namespace
);
1360 /* This does the bulk of the work of finding overloaded symbols.
1361 FUNC_NAME is the name of the overloaded function we're looking for
1362 (possibly including namespace info). */
1365 make_symbol_overload_list_qualified (const char *func_name
)
1367 struct compunit_symtab
*cust
;
1368 struct objfile
*objfile
;
1369 const struct block
*b
, *surrounding_static_block
= 0;
1371 /* Look through the partial symtabs for all symbols which begin by
1372 matching FUNC_NAME. Make sure we read that symbol table in. */
1374 ALL_OBJFILES (objfile
)
1377 objfile
->sf
->qf
->expand_symtabs_for_function (objfile
, func_name
);
1380 /* Search upwards from currently selected frame (so that we can
1381 complete on local vars. */
1383 for (b
= get_selected_block (0); b
!= NULL
; b
= BLOCK_SUPERBLOCK (b
))
1384 make_symbol_overload_list_block (func_name
, b
);
1386 surrounding_static_block
= block_static_block (get_selected_block (0));
1388 /* Go through the symtabs and check the externs and statics for
1389 symbols which match. */
1391 ALL_COMPUNITS (objfile
, cust
)
1394 b
= BLOCKVECTOR_BLOCK (COMPUNIT_BLOCKVECTOR (cust
), GLOBAL_BLOCK
);
1395 make_symbol_overload_list_block (func_name
, b
);
1398 ALL_COMPUNITS (objfile
, cust
)
1401 b
= BLOCKVECTOR_BLOCK (COMPUNIT_BLOCKVECTOR (cust
), STATIC_BLOCK
);
1402 /* Don't do this block twice. */
1403 if (b
== surrounding_static_block
)
1405 make_symbol_overload_list_block (func_name
, b
);
1409 /* Lookup the rtti type for a class name. */
1412 cp_lookup_rtti_type (const char *name
, struct block
*block
)
1414 struct symbol
* rtti_sym
;
1415 struct type
* rtti_type
;
1417 /* Use VAR_DOMAIN here as NAME may be a typedef. PR 18141, 18417.
1418 Classes "live" in both STRUCT_DOMAIN and VAR_DOMAIN. */
1419 rtti_sym
= lookup_symbol (name
, block
, VAR_DOMAIN
, NULL
).symbol
;
1421 if (rtti_sym
== NULL
)
1423 warning (_("RTTI symbol not found for class '%s'"), name
);
1427 if (SYMBOL_CLASS (rtti_sym
) != LOC_TYPEDEF
)
1429 warning (_("RTTI symbol for class '%s' is not a type"), name
);
1433 rtti_type
= check_typedef (SYMBOL_TYPE (rtti_sym
));
1435 switch (TYPE_CODE (rtti_type
))
1437 case TYPE_CODE_STRUCT
:
1439 case TYPE_CODE_NAMESPACE
:
1440 /* chastain/2003-11-26: the symbol tables often contain fake
1441 symbols for namespaces with the same name as the struct.
1442 This warning is an indication of a bug in the lookup order
1443 or a bug in the way that the symbol tables are populated. */
1444 warning (_("RTTI symbol for class '%s' is a namespace"), name
);
1447 warning (_("RTTI symbol for class '%s' has bad type"), name
);
1454 #ifdef HAVE_WORKING_FORK
1456 /* If nonzero, attempt to catch crashes in the demangler and print
1457 useful debugging information. */
1459 static int catch_demangler_crashes
= 1;
1461 /* Stack context and environment for demangler crash recovery. */
1463 static SIGJMP_BUF gdb_demangle_jmp_buf
;
1465 /* If nonzero, attempt to dump core from the signal handler. */
1467 static int gdb_demangle_attempt_core_dump
= 1;
1469 /* Signal handler for gdb_demangle. */
1472 gdb_demangle_signal_handler (int signo
)
1474 if (gdb_demangle_attempt_core_dump
)
1479 gdb_demangle_attempt_core_dump
= 0;
1482 SIGLONGJMP (gdb_demangle_jmp_buf
, signo
);
1487 /* A wrapper for bfd_demangle. */
1490 gdb_demangle (const char *name
, int options
)
1492 char *result
= NULL
;
1493 int crash_signal
= 0;
1495 #ifdef HAVE_WORKING_FORK
1496 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
1497 struct sigaction sa
, old_sa
;
1501 static int core_dump_allowed
= -1;
1503 if (core_dump_allowed
== -1)
1505 core_dump_allowed
= can_dump_core (LIMIT_CUR
);
1507 if (!core_dump_allowed
)
1508 gdb_demangle_attempt_core_dump
= 0;
1511 if (catch_demangler_crashes
)
1513 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
1514 sa
.sa_handler
= gdb_demangle_signal_handler
;
1515 sigemptyset (&sa
.sa_mask
);
1516 #ifdef HAVE_SIGALTSTACK
1517 sa
.sa_flags
= SA_ONSTACK
;
1521 sigaction (SIGSEGV
, &sa
, &old_sa
);
1523 ofunc
= signal (SIGSEGV
, gdb_demangle_signal_handler
);
1526 crash_signal
= SIGSETJMP (gdb_demangle_jmp_buf
);
1530 if (crash_signal
== 0)
1531 result
= bfd_demangle (NULL
, name
, options
);
1533 #ifdef HAVE_WORKING_FORK
1534 if (catch_demangler_crashes
)
1536 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
1537 sigaction (SIGSEGV
, &old_sa
, NULL
);
1539 signal (SIGSEGV
, ofunc
);
1542 if (crash_signal
!= 0)
1544 static int error_reported
= 0;
1546 if (!error_reported
)
1548 char *short_msg
, *long_msg
;
1549 struct cleanup
*back_to
;
1551 short_msg
= xstrprintf (_("unable to demangle '%s' "
1552 "(demangler failed with signal %d)"),
1553 name
, crash_signal
);
1554 back_to
= make_cleanup (xfree
, short_msg
);
1556 long_msg
= xstrprintf ("%s:%d: %s: %s", __FILE__
, __LINE__
,
1557 "demangler-warning", short_msg
);
1558 make_cleanup (xfree
, long_msg
);
1560 make_cleanup_restore_target_terminal ();
1561 target_terminal_ours_for_output ();
1564 if (core_dump_allowed
)
1565 fprintf_unfiltered (gdb_stderr
,
1566 _("%s\nAttempting to dump core.\n"),
1569 warn_cant_dump_core (long_msg
);
1571 demangler_warning (__FILE__
, __LINE__
, "%s", short_msg
);
1573 do_cleanups (back_to
);
1586 /* See cp-support.h. */
1589 gdb_sniff_from_mangled_name (const char *mangled
, char **demangled
)
1591 *demangled
= gdb_demangle (mangled
, DMGL_PARAMS
| DMGL_ANSI
);
1592 return *demangled
!= NULL
;
1595 /* Don't allow just "maintenance cplus". */
1598 maint_cplus_command (char *arg
, int from_tty
)
1600 printf_unfiltered (_("\"maintenance cplus\" must be followed "
1601 "by the name of a command.\n"));
1602 help_list (maint_cplus_cmd_list
,
1603 "maintenance cplus ",
1604 all_commands
, gdb_stdout
);
1607 /* This is a front end for cp_find_first_component, for unit testing.
1608 Be careful when using it: see the NOTE above
1609 cp_find_first_component. */
1612 first_component_command (char *arg
, int from_tty
)
1620 len
= cp_find_first_component (arg
);
1621 prefix
= (char *) alloca (len
+ 1);
1623 memcpy (prefix
, arg
, len
);
1626 printf_unfiltered ("%s\n", prefix
);
1629 extern initialize_file_ftype _initialize_cp_support
; /* -Wmissing-prototypes */
1632 /* Implement "info vtbl". */
1635 info_vtbl_command (char *arg
, int from_tty
)
1637 struct value
*value
;
1639 value
= parse_and_eval (arg
);
1640 cplus_print_vtable (value
);
1644 _initialize_cp_support (void)
1646 add_prefix_cmd ("cplus", class_maintenance
,
1647 maint_cplus_command
,
1648 _("C++ maintenance commands."),
1649 &maint_cplus_cmd_list
,
1650 "maintenance cplus ",
1651 0, &maintenancelist
);
1652 add_alias_cmd ("cp", "cplus",
1653 class_maintenance
, 1,
1656 add_cmd ("first_component",
1658 first_component_command
,
1659 _("Print the first class/namespace component of NAME."),
1660 &maint_cplus_cmd_list
);
1662 add_info ("vtbl", info_vtbl_command
,
1663 _("Show the virtual function table for a C++ object.\n\
1664 Usage: info vtbl EXPRESSION\n\
1665 Evaluate EXPRESSION and display the virtual function table for the\n\
1666 resulting object."));
1668 #ifdef HAVE_WORKING_FORK
1669 add_setshow_boolean_cmd ("catch-demangler-crashes", class_maintenance
,
1670 &catch_demangler_crashes
, _("\
1671 Set whether to attempt to catch demangler crashes."), _("\
1672 Show whether to attempt to catch demangler crashes."), _("\
1673 If enabled GDB will attempt to catch demangler crashes and\n\
1674 display the offending symbol."),
1677 &maintenance_set_cmdlist
,
1678 &maintenance_show_cmdlist
);