1 /* Helper routines for C++ support in GDB.
2 Copyright (C) 2002-2015 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"
37 #include "safe-ctype.h"
39 #define d_left(dc) (dc)->u.s_binary.left
40 #define d_right(dc) (dc)->u.s_binary.right
42 /* Functions related to demangled name parsing. */
44 static unsigned int cp_find_first_component_aux (const char *name,
47 static void demangled_name_complaint (const char *name);
49 /* Functions/variables related to overload resolution. */
51 static int sym_return_val_size = -1;
52 static int sym_return_val_index;
53 static struct symbol **sym_return_val;
55 static void overload_list_add_symbol (struct symbol *sym,
56 const char *oload_name);
58 static void make_symbol_overload_list_using (const char *func_name,
59 const char *the_namespace);
61 static void make_symbol_overload_list_qualified (const char *func_name);
63 /* The list of "maint cplus" commands. */
65 struct cmd_list_element *maint_cplus_cmd_list = NULL;
67 /* The actual commands. */
69 static void maint_cplus_command (char *arg, int from_tty);
70 static void first_component_command (char *arg, int from_tty);
72 /* A list of typedefs which should not be substituted by replace_typedefs. */
73 static const char * const ignore_typedefs[] =
75 "std::istream", "std::iostream", "std::ostream", "std::string"
79 replace_typedefs (struct demangle_parse_info *info,
80 struct demangle_component *ret_comp,
81 canonicalization_ftype *finder,
84 /* A convenience function to copy STRING into OBSTACK, returning a pointer
85 to the newly allocated string and saving the number of bytes saved in LEN.
87 It does not copy the terminating '\0' byte! */
90 copy_string_to_obstack (struct obstack *obstack, const char *string,
93 *len = strlen (string);
94 return obstack_copy (obstack, string, *len);
97 /* A cleanup wrapper for cp_demangled_name_parse_free. */
100 do_demangled_name_parse_free_cleanup (void *data)
102 struct demangle_parse_info *info = (struct demangle_parse_info *) data;
104 cp_demangled_name_parse_free (info);
107 /* Create a cleanup for C++ name parsing. */
110 make_cleanup_cp_demangled_name_parse_free (struct demangle_parse_info *info)
112 return make_cleanup (do_demangled_name_parse_free_cleanup, info);
115 /* Return 1 if STRING is clearly already in canonical form. This
116 function is conservative; things which it does not recognize are
117 assumed to be non-canonical, and the parser will sort them out
118 afterwards. This speeds up the critical path for alphanumeric
122 cp_already_canonical (const char *string)
124 /* Identifier start character [a-zA-Z_]. */
125 if (!ISIDST (string[0]))
128 /* These are the only two identifiers which canonicalize to other
129 than themselves or an error: unsigned -> unsigned int and
131 if (string[0] == 'u' && strcmp (&string[1], "nsigned") == 0)
133 else if (string[0] == 's' && strcmp (&string[1], "igned") == 0)
136 /* Identifier character [a-zA-Z0-9_]. */
137 while (ISIDNUM (string[1]))
140 if (string[1] == '\0')
146 /* Inspect the given RET_COMP for its type. If it is a typedef,
147 replace the node with the typedef's tree.
149 Returns 1 if any typedef substitutions were made, 0 otherwise. */
152 inspect_type (struct demangle_parse_info *info,
153 struct demangle_component *ret_comp,
154 canonicalization_ftype *finder,
161 /* Copy the symbol's name from RET_COMP and look it up
162 in the symbol table. */
163 name = (char *) alloca (ret_comp->u.s_name.len + 1);
164 memcpy (name, ret_comp->u.s_name.s, ret_comp->u.s_name.len);
165 name[ret_comp->u.s_name.len] = '\0';
167 /* Ignore any typedefs that should not be substituted. */
168 for (i = 0; i < ARRAY_SIZE (ignore_typedefs); ++i)
170 if (strcmp (name, ignore_typedefs[i]) == 0)
178 sym = lookup_symbol (name, 0, VAR_DOMAIN, 0).symbol;
180 CATCH (except, RETURN_MASK_ALL)
188 struct type *otype = SYMBOL_TYPE (sym);
192 const char *new_name = (*finder) (otype, data);
194 if (new_name != NULL)
196 ret_comp->u.s_name.s = new_name;
197 ret_comp->u.s_name.len = strlen (new_name);
204 /* If the type is a typedef or namespace alias, replace it. */
205 if (TYPE_CODE (otype) == TYPE_CODE_TYPEDEF
206 || TYPE_CODE (otype) == TYPE_CODE_NAMESPACE)
211 struct demangle_parse_info *i;
214 /* Get the real type of the typedef. */
215 type = check_typedef (otype);
217 /* If the symbol is a namespace and its type name is no different
218 than the name we looked up, this symbol is not a namespace
219 alias and does not need to be substituted. */
220 if (TYPE_CODE (otype) == TYPE_CODE_NAMESPACE
221 && strcmp (TYPE_NAME (type), name) == 0)
224 is_anon = (TYPE_TAG_NAME (type) == NULL
225 && (TYPE_CODE (type) == TYPE_CODE_ENUM
226 || TYPE_CODE (type) == TYPE_CODE_STRUCT
227 || TYPE_CODE (type) == TYPE_CODE_UNION));
230 struct type *last = otype;
232 /* Find the last typedef for the type. */
233 while (TYPE_TARGET_TYPE (last) != NULL
234 && (TYPE_CODE (TYPE_TARGET_TYPE (last))
235 == TYPE_CODE_TYPEDEF))
236 last = TYPE_TARGET_TYPE (last);
238 /* If there is only one typedef for this anonymous type,
239 do not substitute it. */
243 /* Use the last typedef seen as the type for this
248 buf = mem_fileopen ();
251 type_print (type, "", buf, -1);
254 /* If type_print threw an exception, there is little point
255 in continuing, so just bow out gracefully. */
256 CATCH (except, RETURN_MASK_ERROR)
258 ui_file_delete (buf);
263 name = ui_file_obsavestring (buf, &info->obstack, &len);
264 ui_file_delete (buf);
266 /* Turn the result into a new tree. Note that this
267 tree will contain pointers into NAME, so NAME cannot
268 be free'd until all typedef conversion is done and
269 the final result is converted into a string. */
270 i = cp_demangled_name_to_comp (name, NULL);
273 /* Merge the two trees. */
274 cp_merge_demangle_parse_infos (info, ret_comp, i);
276 /* Replace any newly introduced typedefs -- but not
277 if the type is anonymous (that would lead to infinite
280 replace_typedefs (info, ret_comp, finder, data);
284 /* This shouldn't happen unless the type printer has
285 output something that the name parser cannot grok.
286 Nonetheless, an ounce of prevention...
288 Canonicalize the name again, and store it in the
289 current node (RET_COMP). */
290 char *canon = cp_canonicalize_string_no_typedefs (name);
294 /* Copy the canonicalization into the obstack and
296 name = copy_string_to_obstack (&info->obstack, canon, &len);
300 ret_comp->u.s_name.s = name;
301 ret_comp->u.s_name.len = len;
311 /* Replace any typedefs appearing in the qualified name
312 (DEMANGLE_COMPONENT_QUAL_NAME) represented in RET_COMP for the name parse
316 replace_typedefs_qualified_name (struct demangle_parse_info *info,
317 struct demangle_component *ret_comp,
318 canonicalization_ftype *finder,
323 struct ui_file *buf = mem_fileopen ();
324 struct demangle_component *comp = ret_comp;
326 /* Walk each node of the qualified name, reconstructing the name of
327 this element. With every node, check for any typedef substitutions.
328 If a substitution has occurred, replace the qualified name node
329 with a DEMANGLE_COMPONENT_NAME node representing the new, typedef-
331 while (comp->type == DEMANGLE_COMPONENT_QUAL_NAME)
333 if (d_left (comp)->type == DEMANGLE_COMPONENT_NAME)
335 struct demangle_component newobj;
337 ui_file_write (buf, d_left (comp)->u.s_name.s,
338 d_left (comp)->u.s_name.len);
339 name = ui_file_obsavestring (buf, &info->obstack, &len);
340 newobj.type = DEMANGLE_COMPONENT_NAME;
341 newobj.u.s_name.s = name;
342 newobj.u.s_name.len = len;
343 if (inspect_type (info, &newobj, finder, data))
348 /* A typedef was substituted in NEW. Convert it to a
349 string and replace the top DEMANGLE_COMPONENT_QUAL_NAME
352 ui_file_rewind (buf);
353 n = cp_comp_to_string (&newobj, 100);
356 /* If something went astray, abort typedef substitutions. */
357 ui_file_delete (buf);
361 s = copy_string_to_obstack (&info->obstack, n, &slen);
364 d_left (ret_comp)->type = DEMANGLE_COMPONENT_NAME;
365 d_left (ret_comp)->u.s_name.s = s;
366 d_left (ret_comp)->u.s_name.len = slen;
367 d_right (ret_comp) = d_right (comp);
374 /* The current node is not a name, so simply replace any
375 typedefs in it. Then print it to the stream to continue
376 checking for more typedefs in the tree. */
377 replace_typedefs (info, d_left (comp), finder, data);
378 name = cp_comp_to_string (d_left (comp), 100);
381 /* If something went astray, abort typedef substitutions. */
382 ui_file_delete (buf);
385 fputs_unfiltered (name, buf);
389 ui_file_write (buf, "::", 2);
390 comp = d_right (comp);
393 /* If the next component is DEMANGLE_COMPONENT_NAME, save the qualified
394 name assembled above and append the name given by COMP. Then use this
395 reassembled name to check for a typedef. */
397 if (comp->type == DEMANGLE_COMPONENT_NAME)
399 ui_file_write (buf, comp->u.s_name.s, comp->u.s_name.len);
400 name = ui_file_obsavestring (buf, &info->obstack, &len);
402 /* Replace the top (DEMANGLE_COMPONENT_QUAL_NAME) node
403 with a DEMANGLE_COMPONENT_NAME node containing the whole
405 ret_comp->type = DEMANGLE_COMPONENT_NAME;
406 ret_comp->u.s_name.s = name;
407 ret_comp->u.s_name.len = len;
408 inspect_type (info, ret_comp, finder, data);
411 replace_typedefs (info, comp, finder, data);
413 ui_file_delete (buf);
417 /* A function to check const and volatile qualifiers for argument types.
419 "Parameter declarations that differ only in the presence
420 or absence of `const' and/or `volatile' are equivalent."
421 C++ Standard N3290, clause 13.1.3 #4. */
424 check_cv_qualifiers (struct demangle_component *ret_comp)
426 while (d_left (ret_comp) != NULL
427 && (d_left (ret_comp)->type == DEMANGLE_COMPONENT_CONST
428 || d_left (ret_comp)->type == DEMANGLE_COMPONENT_VOLATILE))
430 d_left (ret_comp) = d_left (d_left (ret_comp));
434 /* Walk the parse tree given by RET_COMP, replacing any typedefs with
435 their basic types. */
438 replace_typedefs (struct demangle_parse_info *info,
439 struct demangle_component *ret_comp,
440 canonicalization_ftype *finder,
446 && (ret_comp->type == DEMANGLE_COMPONENT_NAME
447 || ret_comp->type == DEMANGLE_COMPONENT_QUAL_NAME
448 || ret_comp->type == DEMANGLE_COMPONENT_TEMPLATE
449 || ret_comp->type == DEMANGLE_COMPONENT_BUILTIN_TYPE))
451 char *local_name = cp_comp_to_string (ret_comp, 10);
453 if (local_name != NULL)
455 struct symbol *sym = NULL;
460 sym = lookup_symbol (local_name, 0, VAR_DOMAIN, 0).symbol;
462 CATCH (except, RETURN_MASK_ALL)
471 struct type *otype = SYMBOL_TYPE (sym);
472 const char *new_name = (*finder) (otype, data);
474 if (new_name != NULL)
476 ret_comp->type = DEMANGLE_COMPONENT_NAME;
477 ret_comp->u.s_name.s = new_name;
478 ret_comp->u.s_name.len = strlen (new_name);
485 switch (ret_comp->type)
487 case DEMANGLE_COMPONENT_ARGLIST:
488 check_cv_qualifiers (ret_comp);
491 case DEMANGLE_COMPONENT_FUNCTION_TYPE:
492 case DEMANGLE_COMPONENT_TEMPLATE:
493 case DEMANGLE_COMPONENT_TEMPLATE_ARGLIST:
494 case DEMANGLE_COMPONENT_TYPED_NAME:
495 replace_typedefs (info, d_left (ret_comp), finder, data);
496 replace_typedefs (info, d_right (ret_comp), finder, data);
499 case DEMANGLE_COMPONENT_NAME:
500 inspect_type (info, ret_comp, finder, data);
503 case DEMANGLE_COMPONENT_QUAL_NAME:
504 replace_typedefs_qualified_name (info, ret_comp, finder, data);
507 case DEMANGLE_COMPONENT_LOCAL_NAME:
508 case DEMANGLE_COMPONENT_CTOR:
509 case DEMANGLE_COMPONENT_ARRAY_TYPE:
510 case DEMANGLE_COMPONENT_PTRMEM_TYPE:
511 replace_typedefs (info, d_right (ret_comp), finder, data);
514 case DEMANGLE_COMPONENT_CONST:
515 case DEMANGLE_COMPONENT_RESTRICT:
516 case DEMANGLE_COMPONENT_VOLATILE:
517 case DEMANGLE_COMPONENT_VOLATILE_THIS:
518 case DEMANGLE_COMPONENT_CONST_THIS:
519 case DEMANGLE_COMPONENT_RESTRICT_THIS:
520 case DEMANGLE_COMPONENT_POINTER:
521 case DEMANGLE_COMPONENT_REFERENCE:
522 replace_typedefs (info, d_left (ret_comp), finder, data);
531 /* Parse STRING and convert it to canonical form, resolving any typedefs.
532 If parsing fails, or if STRING is already canonical, return NULL.
533 Otherwise return the canonical form. The return value is allocated via
534 xmalloc. If FINDER is not NULL, then type components are passed to
535 FINDER to be looked up. DATA is passed verbatim to FINDER. */
538 cp_canonicalize_string_full (const char *string,
539 canonicalization_ftype *finder,
543 unsigned int estimated_len;
544 struct demangle_parse_info *info;
547 estimated_len = strlen (string) * 2;
548 info = cp_demangled_name_to_comp (string, NULL);
551 /* Replace all the typedefs in the tree. */
552 replace_typedefs (info, info->tree, finder, data);
554 /* Convert the tree back into a string. */
555 ret = cp_comp_to_string (info->tree, estimated_len);
556 gdb_assert (ret != NULL);
558 /* Free the parse information. */
559 cp_demangled_name_parse_free (info);
561 /* Finally, compare the original string with the computed
562 name, returning NULL if they are the same. */
563 if (strcmp (string, ret) == 0)
573 /* Like cp_canonicalize_string_full, but always passes NULL for
577 cp_canonicalize_string_no_typedefs (const char *string)
579 return cp_canonicalize_string_full (string, NULL, NULL);
582 /* Parse STRING and convert it to canonical form. If parsing fails,
583 or if STRING is already canonical, return NULL. Otherwise return
584 the canonical form. The return value is allocated via xmalloc. */
587 cp_canonicalize_string (const char *string)
589 struct demangle_parse_info *info;
590 unsigned int estimated_len;
593 if (cp_already_canonical (string))
596 info = cp_demangled_name_to_comp (string, NULL);
600 estimated_len = strlen (string) * 2;
601 ret = cp_comp_to_string (info->tree, estimated_len);
602 cp_demangled_name_parse_free (info);
606 warning (_("internal error: string \"%s\" failed to be canonicalized"),
611 if (strcmp (string, ret) == 0)
620 /* Convert a mangled name to a demangle_component tree. *MEMORY is
621 set to the block of used memory that should be freed when finished
622 with the tree. DEMANGLED_P is set to the char * that should be
623 freed when finished with the tree, or NULL if none was needed.
624 OPTIONS will be passed to the demangler. */
626 static struct demangle_parse_info *
627 mangled_name_to_comp (const char *mangled_name, int options,
628 void **memory, char **demangled_p)
630 char *demangled_name;
631 struct demangle_parse_info *info;
633 /* If it looks like a v3 mangled name, then try to go directly
635 if (mangled_name[0] == '_' && mangled_name[1] == 'Z')
637 struct demangle_component *ret;
639 ret = cplus_demangle_v3_components (mangled_name,
643 info = cp_new_demangle_parse_info ();
650 /* If it doesn't, or if that failed, then try to demangle the
652 demangled_name = gdb_demangle (mangled_name, options);
653 if (demangled_name == NULL)
656 /* If we could demangle the name, parse it to build the component
658 info = cp_demangled_name_to_comp (demangled_name, NULL);
662 xfree (demangled_name);
666 *demangled_p = demangled_name;
670 /* Return the name of the class containing method PHYSNAME. */
673 cp_class_name_from_physname (const char *physname)
675 void *storage = NULL;
676 char *demangled_name = NULL, *ret;
677 struct demangle_component *ret_comp, *prev_comp, *cur_comp;
678 struct demangle_parse_info *info;
681 info = mangled_name_to_comp (physname, DMGL_ANSI,
682 &storage, &demangled_name);
687 ret_comp = info->tree;
689 /* First strip off any qualifiers, if we have a function or
692 switch (ret_comp->type)
694 case DEMANGLE_COMPONENT_CONST:
695 case DEMANGLE_COMPONENT_RESTRICT:
696 case DEMANGLE_COMPONENT_VOLATILE:
697 case DEMANGLE_COMPONENT_CONST_THIS:
698 case DEMANGLE_COMPONENT_RESTRICT_THIS:
699 case DEMANGLE_COMPONENT_VOLATILE_THIS:
700 case DEMANGLE_COMPONENT_VENDOR_TYPE_QUAL:
701 ret_comp = d_left (ret_comp);
708 /* If what we have now is a function, discard the argument list. */
709 if (ret_comp->type == DEMANGLE_COMPONENT_TYPED_NAME)
710 ret_comp = d_left (ret_comp);
712 /* If what we have now is a template, strip off the template
713 arguments. The left subtree may be a qualified name. */
714 if (ret_comp->type == DEMANGLE_COMPONENT_TEMPLATE)
715 ret_comp = d_left (ret_comp);
717 /* What we have now should be a name, possibly qualified.
718 Additional qualifiers could live in the left subtree or the right
719 subtree. Find the last piece. */
724 switch (cur_comp->type)
726 case DEMANGLE_COMPONENT_QUAL_NAME:
727 case DEMANGLE_COMPONENT_LOCAL_NAME:
728 prev_comp = cur_comp;
729 cur_comp = d_right (cur_comp);
731 case DEMANGLE_COMPONENT_TEMPLATE:
732 case DEMANGLE_COMPONENT_NAME:
733 case DEMANGLE_COMPONENT_CTOR:
734 case DEMANGLE_COMPONENT_DTOR:
735 case DEMANGLE_COMPONENT_OPERATOR:
736 case DEMANGLE_COMPONENT_EXTENDED_OPERATOR:
746 if (cur_comp != NULL && prev_comp != NULL)
748 /* We want to discard the rightmost child of PREV_COMP. */
749 *prev_comp = *d_left (prev_comp);
750 /* The ten is completely arbitrary; we don't have a good
752 ret = cp_comp_to_string (ret_comp, 10);
756 xfree (demangled_name);
757 cp_demangled_name_parse_free (info);
761 /* Return the child of COMP which is the basename of a method,
762 variable, et cetera. All scope qualifiers are discarded, but
763 template arguments will be included. The component tree may be
766 static struct demangle_component *
767 unqualified_name_from_comp (struct demangle_component *comp)
769 struct demangle_component *ret_comp = comp, *last_template;
773 last_template = NULL;
775 switch (ret_comp->type)
777 case DEMANGLE_COMPONENT_QUAL_NAME:
778 case DEMANGLE_COMPONENT_LOCAL_NAME:
779 ret_comp = d_right (ret_comp);
781 case DEMANGLE_COMPONENT_TYPED_NAME:
782 ret_comp = d_left (ret_comp);
784 case DEMANGLE_COMPONENT_TEMPLATE:
785 gdb_assert (last_template == NULL);
786 last_template = ret_comp;
787 ret_comp = d_left (ret_comp);
789 case DEMANGLE_COMPONENT_CONST:
790 case DEMANGLE_COMPONENT_RESTRICT:
791 case DEMANGLE_COMPONENT_VOLATILE:
792 case DEMANGLE_COMPONENT_CONST_THIS:
793 case DEMANGLE_COMPONENT_RESTRICT_THIS:
794 case DEMANGLE_COMPONENT_VOLATILE_THIS:
795 case DEMANGLE_COMPONENT_VENDOR_TYPE_QUAL:
796 ret_comp = d_left (ret_comp);
798 case DEMANGLE_COMPONENT_NAME:
799 case DEMANGLE_COMPONENT_CTOR:
800 case DEMANGLE_COMPONENT_DTOR:
801 case DEMANGLE_COMPONENT_OPERATOR:
802 case DEMANGLE_COMPONENT_EXTENDED_OPERATOR:
812 d_left (last_template) = ret_comp;
813 return last_template;
819 /* Return the name of the method whose linkage name is PHYSNAME. */
822 method_name_from_physname (const char *physname)
824 void *storage = NULL;
825 char *demangled_name = NULL, *ret;
826 struct demangle_component *ret_comp;
827 struct demangle_parse_info *info;
829 info = mangled_name_to_comp (physname, DMGL_ANSI,
830 &storage, &demangled_name);
834 ret_comp = unqualified_name_from_comp (info->tree);
837 if (ret_comp != NULL)
838 /* The ten is completely arbitrary; we don't have a good
840 ret = cp_comp_to_string (ret_comp, 10);
843 xfree (demangled_name);
844 cp_demangled_name_parse_free (info);
848 /* If FULL_NAME is the demangled name of a C++ function (including an
849 arg list, possibly including namespace/class qualifications),
850 return a new string containing only the function name (without the
851 arg list/class qualifications). Otherwise, return NULL. The
852 caller is responsible for freeing the memory in question. */
855 cp_func_name (const char *full_name)
858 struct demangle_component *ret_comp;
859 struct demangle_parse_info *info;
861 info = cp_demangled_name_to_comp (full_name, NULL);
865 ret_comp = unqualified_name_from_comp (info->tree);
868 if (ret_comp != NULL)
869 ret = cp_comp_to_string (ret_comp, 10);
871 cp_demangled_name_parse_free (info);
875 /* DEMANGLED_NAME is the name of a function, including parameters and
876 (optionally) a return type. Return the name of the function without
877 parameters or return type, or NULL if we can not parse the name. */
880 cp_remove_params (const char *demangled_name)
883 struct demangle_component *ret_comp;
884 struct demangle_parse_info *info;
887 if (demangled_name == NULL)
890 info = cp_demangled_name_to_comp (demangled_name, NULL);
894 /* First strip off any qualifiers, if we have a function or method. */
895 ret_comp = info->tree;
897 switch (ret_comp->type)
899 case DEMANGLE_COMPONENT_CONST:
900 case DEMANGLE_COMPONENT_RESTRICT:
901 case DEMANGLE_COMPONENT_VOLATILE:
902 case DEMANGLE_COMPONENT_CONST_THIS:
903 case DEMANGLE_COMPONENT_RESTRICT_THIS:
904 case DEMANGLE_COMPONENT_VOLATILE_THIS:
905 case DEMANGLE_COMPONENT_VENDOR_TYPE_QUAL:
906 ret_comp = d_left (ret_comp);
913 /* What we have now should be a function. Return its name. */
914 if (ret_comp->type == DEMANGLE_COMPONENT_TYPED_NAME)
915 ret = cp_comp_to_string (d_left (ret_comp), 10);
917 cp_demangled_name_parse_free (info);
921 /* Here are some random pieces of trivia to keep in mind while trying
922 to take apart demangled names:
924 - Names can contain function arguments or templates, so the process
925 has to be, to some extent recursive: maybe keep track of your
926 depth based on encountering <> and ().
928 - Parentheses don't just have to happen at the end of a name: they
929 can occur even if the name in question isn't a function, because
930 a template argument might be a type that's a function.
932 - Conversely, even if you're trying to deal with a function, its
933 demangled name might not end with ')': it could be a const or
934 volatile class method, in which case it ends with "const" or
937 - Parentheses are also used in anonymous namespaces: a variable
938 'foo' in an anonymous namespace gets demangled as "(anonymous
941 - And operator names can contain parentheses or angle brackets. */
943 /* FIXME: carlton/2003-03-13: We have several functions here with
944 overlapping functionality; can we combine them? Also, do they
945 handle all the above considerations correctly? */
948 /* This returns the length of first component of NAME, which should be
949 the demangled name of a C++ variable/function/method/etc.
950 Specifically, it returns the index of the first colon forming the
951 boundary of the first component: so, given 'A::foo' or 'A::B::foo'
952 it returns the 1, and given 'foo', it returns 0. */
954 /* The character in NAME indexed by the return value is guaranteed to
955 always be either ':' or '\0'. */
957 /* NOTE: carlton/2003-03-13: This function is currently only intended
958 for internal use: it's probably not entirely safe when called on
959 user-generated input, because some of the 'index += 2' lines in
960 cp_find_first_component_aux might go past the end of malformed
964 cp_find_first_component (const char *name)
966 return cp_find_first_component_aux (name, 0);
969 /* Helper function for cp_find_first_component. Like that function,
970 it returns the length of the first component of NAME, but to make
971 the recursion easier, it also stops if it reaches an unexpected ')'
972 or '>' if the value of PERMISSIVE is nonzero. */
974 /* Let's optimize away calls to strlen("operator"). */
976 #define LENGTH_OF_OPERATOR 8
979 cp_find_first_component_aux (const char *name, int permissive)
981 unsigned int index = 0;
982 /* Operator names can show up in unexpected places. Since these can
983 contain parentheses or angle brackets, they can screw up the
984 recursion. But not every string 'operator' is part of an
985 operater name: e.g. you could have a variable 'cooperator'. So
986 this variable tells us whether or not we should treat the string
987 'operator' as starting an operator. */
988 int operator_possible = 1;
995 /* Template; eat it up. The calls to cp_first_component
996 should only return (I hope!) when they reach the '>'
997 terminating the component or a '::' between two
998 components. (Hence the '+ 2'.) */
1000 for (index += cp_find_first_component_aux (name + index, 1);
1002 index += cp_find_first_component_aux (name + index, 1))
1004 if (name[index] != ':')
1006 demangled_name_complaint (name);
1007 return strlen (name);
1011 operator_possible = 1;
1014 /* Similar comment as to '<'. */
1016 for (index += cp_find_first_component_aux (name + index, 1);
1018 index += cp_find_first_component_aux (name + index, 1))
1020 if (name[index] != ':')
1022 demangled_name_complaint (name);
1023 return strlen (name);
1027 operator_possible = 1;
1035 demangled_name_complaint (name);
1036 return strlen (name);
1042 /* Operator names can screw up the recursion. */
1043 if (operator_possible
1044 && strncmp (name + index, "operator",
1045 LENGTH_OF_OPERATOR) == 0)
1047 index += LENGTH_OF_OPERATOR;
1048 while (ISSPACE(name[index]))
1050 switch (name[index])
1052 /* Skip over one less than the appropriate number of
1053 characters: the for loop will skip over the last
1056 if (name[index + 1] == '<')
1063 if (name[index + 1] == '>')
1076 operator_possible = 0;
1083 /* NOTE: carlton/2003-04-18: I'm not sure what the precise
1084 set of relevant characters are here: it's necessary to
1085 include any character that can show up before 'operator'
1086 in a demangled name, and it's safe to include any
1087 character that can't be part of an identifier's name. */
1088 operator_possible = 1;
1091 operator_possible = 0;
1097 /* Complain about a demangled name that we don't know how to parse.
1098 NAME is the demangled name in question. */
1101 demangled_name_complaint (const char *name)
1103 complaint (&symfile_complaints,
1104 "unexpected demangled name '%s'", name);
1107 /* If NAME is the fully-qualified name of a C++
1108 function/variable/method/etc., this returns the length of its
1109 entire prefix: all of the namespaces and classes that make up its
1110 name. Given 'A::foo', it returns 1, given 'A::B::foo', it returns
1111 4, given 'foo', it returns 0. */
1114 cp_entire_prefix_len (const char *name)
1116 unsigned int current_len = cp_find_first_component (name);
1117 unsigned int previous_len = 0;
1119 while (name[current_len] != '\0')
1121 gdb_assert (name[current_len] == ':');
1122 previous_len = current_len;
1123 /* Skip the '::'. */
1125 current_len += cp_find_first_component (name + current_len);
1128 return previous_len;
1131 /* Overload resolution functions. */
1133 /* Test to see if SYM is a symbol that we haven't seen corresponding
1134 to a function named OLOAD_NAME. If so, add it to the current
1138 overload_list_add_symbol (struct symbol *sym,
1139 const char *oload_name)
1145 /* If there is no type information, we can't do anything, so
1147 if (SYMBOL_TYPE (sym) == NULL)
1150 /* skip any symbols that we've already considered. */
1151 for (i = 0; i < sym_return_val_index; ++i)
1152 if (strcmp (SYMBOL_LINKAGE_NAME (sym),
1153 SYMBOL_LINKAGE_NAME (sym_return_val[i])) == 0)
1156 /* Get the demangled name without parameters */
1157 sym_name = cp_remove_params (SYMBOL_NATURAL_NAME (sym));
1161 /* skip symbols that cannot match */
1162 if (strcmp (sym_name, oload_name) != 0)
1170 /* We have a match for an overload instance, so add SYM to the
1171 current list of overload instances */
1172 if (sym_return_val_index + 3 > sym_return_val_size)
1174 newsize = (sym_return_val_size *= 2) * sizeof (struct symbol *);
1175 sym_return_val = (struct symbol **)
1176 xrealloc ((char *) sym_return_val, newsize);
1178 sym_return_val[sym_return_val_index++] = sym;
1179 sym_return_val[sym_return_val_index] = NULL;
1182 /* Return a null-terminated list of pointers to function symbols that
1183 are named FUNC_NAME and are visible within NAMESPACE. */
1186 make_symbol_overload_list (const char *func_name,
1187 const char *the_namespace)
1189 struct cleanup *old_cleanups;
1192 sym_return_val_size = 100;
1193 sym_return_val_index = 0;
1194 sym_return_val = xmalloc ((sym_return_val_size + 1) *
1195 sizeof (struct symbol *));
1196 sym_return_val[0] = NULL;
1198 old_cleanups = make_cleanup (xfree, sym_return_val);
1200 make_symbol_overload_list_using (func_name, the_namespace);
1202 if (the_namespace[0] == '\0')
1206 char *concatenated_name
1207 = alloca (strlen (the_namespace) + 2 + strlen (func_name) + 1);
1208 strcpy (concatenated_name, the_namespace);
1209 strcat (concatenated_name, "::");
1210 strcat (concatenated_name, func_name);
1211 name = concatenated_name;
1214 make_symbol_overload_list_qualified (name);
1216 discard_cleanups (old_cleanups);
1218 return sym_return_val;
1221 /* Add all symbols with a name matching NAME in BLOCK to the overload
1225 make_symbol_overload_list_block (const char *name,
1226 const struct block *block)
1228 struct block_iterator iter;
1231 ALL_BLOCK_SYMBOLS_WITH_NAME (block, name, iter, sym)
1232 overload_list_add_symbol (sym, name);
1235 /* Adds the function FUNC_NAME from NAMESPACE to the overload set. */
1238 make_symbol_overload_list_namespace (const char *func_name,
1239 const char *the_namespace)
1242 const struct block *block = NULL;
1244 if (the_namespace[0] == '\0')
1248 char *concatenated_name
1249 = alloca (strlen (the_namespace) + 2 + strlen (func_name) + 1);
1251 strcpy (concatenated_name, the_namespace);
1252 strcat (concatenated_name, "::");
1253 strcat (concatenated_name, func_name);
1254 name = concatenated_name;
1257 /* Look in the static block. */
1258 block = block_static_block (get_selected_block (0));
1260 make_symbol_overload_list_block (name, block);
1262 /* Look in the global block. */
1263 block = block_global_block (block);
1265 make_symbol_overload_list_block (name, block);
1269 /* Search the namespace of the given type and namespace of and public
1273 make_symbol_overload_list_adl_namespace (struct type *type,
1274 const char *func_name)
1276 char *the_namespace;
1277 const char *type_name;
1280 while (TYPE_CODE (type) == TYPE_CODE_PTR
1281 || TYPE_CODE (type) == TYPE_CODE_REF
1282 || TYPE_CODE (type) == TYPE_CODE_ARRAY
1283 || TYPE_CODE (type) == TYPE_CODE_TYPEDEF)
1285 if (TYPE_CODE (type) == TYPE_CODE_TYPEDEF)
1286 type = check_typedef(type);
1288 type = TYPE_TARGET_TYPE (type);
1291 type_name = TYPE_NAME (type);
1293 if (type_name == NULL)
1296 prefix_len = cp_entire_prefix_len (type_name);
1298 if (prefix_len != 0)
1300 the_namespace = alloca (prefix_len + 1);
1301 strncpy (the_namespace, type_name, prefix_len);
1302 the_namespace[prefix_len] = '\0';
1304 make_symbol_overload_list_namespace (func_name, the_namespace);
1307 /* Check public base type */
1308 if (TYPE_CODE (type) == TYPE_CODE_STRUCT)
1309 for (i = 0; i < TYPE_N_BASECLASSES (type); i++)
1311 if (BASETYPE_VIA_PUBLIC (type, i))
1312 make_symbol_overload_list_adl_namespace (TYPE_BASECLASS (type,
1318 /* Adds the overload list overload candidates for FUNC_NAME found
1319 through argument dependent lookup. */
1322 make_symbol_overload_list_adl (struct type **arg_types, int nargs,
1323 const char *func_name)
1327 gdb_assert (sym_return_val_size != -1);
1329 for (i = 1; i <= nargs; i++)
1330 make_symbol_overload_list_adl_namespace (arg_types[i - 1],
1333 return sym_return_val;
1336 /* Used for cleanups to reset the "searched" flag in case of an
1340 reset_directive_searched (void *data)
1342 struct using_direct *direct = data;
1343 direct->searched = 0;
1346 /* This applies the using directives to add namespaces to search in,
1347 and then searches for overloads in all of those namespaces. It
1348 adds the symbols found to sym_return_val. Arguments are as in
1349 make_symbol_overload_list. */
1352 make_symbol_overload_list_using (const char *func_name,
1353 const char *the_namespace)
1355 struct using_direct *current;
1356 const struct block *block;
1358 /* First, go through the using directives. If any of them apply,
1359 look in the appropriate namespaces for new functions to match
1362 for (block = get_selected_block (0);
1364 block = BLOCK_SUPERBLOCK (block))
1365 for (current = block_using (block);
1367 current = current->next)
1369 /* Prevent recursive calls. */
1370 if (current->searched)
1373 /* If this is a namespace alias or imported declaration ignore
1375 if (current->alias != NULL || current->declaration != NULL)
1378 if (strcmp (the_namespace, current->import_dest) == 0)
1380 /* Mark this import as searched so that the recursive call
1381 does not search it again. */
1382 struct cleanup *old_chain;
1383 current->searched = 1;
1384 old_chain = make_cleanup (reset_directive_searched,
1387 make_symbol_overload_list_using (func_name,
1388 current->import_src);
1390 current->searched = 0;
1391 discard_cleanups (old_chain);
1395 /* Now, add names for this namespace. */
1396 make_symbol_overload_list_namespace (func_name, the_namespace);
1399 /* This does the bulk of the work of finding overloaded symbols.
1400 FUNC_NAME is the name of the overloaded function we're looking for
1401 (possibly including namespace info). */
1404 make_symbol_overload_list_qualified (const char *func_name)
1406 struct compunit_symtab *cust;
1407 struct objfile *objfile;
1408 const struct block *b, *surrounding_static_block = 0;
1410 /* Look through the partial symtabs for all symbols which begin by
1411 matching FUNC_NAME. Make sure we read that symbol table in. */
1413 ALL_OBJFILES (objfile)
1416 objfile->sf->qf->expand_symtabs_for_function (objfile, func_name);
1419 /* Search upwards from currently selected frame (so that we can
1420 complete on local vars. */
1422 for (b = get_selected_block (0); b != NULL; b = BLOCK_SUPERBLOCK (b))
1423 make_symbol_overload_list_block (func_name, b);
1425 surrounding_static_block = block_static_block (get_selected_block (0));
1427 /* Go through the symtabs and check the externs and statics for
1428 symbols which match. */
1430 ALL_COMPUNITS (objfile, cust)
1433 b = BLOCKVECTOR_BLOCK (COMPUNIT_BLOCKVECTOR (cust), GLOBAL_BLOCK);
1434 make_symbol_overload_list_block (func_name, b);
1437 ALL_COMPUNITS (objfile, cust)
1440 b = BLOCKVECTOR_BLOCK (COMPUNIT_BLOCKVECTOR (cust), STATIC_BLOCK);
1441 /* Don't do this block twice. */
1442 if (b == surrounding_static_block)
1444 make_symbol_overload_list_block (func_name, b);
1448 /* Lookup the rtti type for a class name. */
1451 cp_lookup_rtti_type (const char *name, struct block *block)
1453 struct symbol * rtti_sym;
1454 struct type * rtti_type;
1456 /* Use VAR_DOMAIN here as NAME may be a typedef. PR 18141, 18417.
1457 Classes "live" in both STRUCT_DOMAIN and VAR_DOMAIN. */
1458 rtti_sym = lookup_symbol (name, block, VAR_DOMAIN, NULL).symbol;
1460 if (rtti_sym == NULL)
1462 warning (_("RTTI symbol not found for class '%s'"), name);
1466 if (SYMBOL_CLASS (rtti_sym) != LOC_TYPEDEF)
1468 warning (_("RTTI symbol for class '%s' is not a type"), name);
1472 rtti_type = check_typedef (SYMBOL_TYPE (rtti_sym));
1474 switch (TYPE_CODE (rtti_type))
1476 case TYPE_CODE_STRUCT:
1478 case TYPE_CODE_NAMESPACE:
1479 /* chastain/2003-11-26: the symbol tables often contain fake
1480 symbols for namespaces with the same name as the struct.
1481 This warning is an indication of a bug in the lookup order
1482 or a bug in the way that the symbol tables are populated. */
1483 warning (_("RTTI symbol for class '%s' is a namespace"), name);
1486 warning (_("RTTI symbol for class '%s' has bad type"), name);
1493 #ifdef HAVE_WORKING_FORK
1495 /* If nonzero, attempt to catch crashes in the demangler and print
1496 useful debugging information. */
1498 static int catch_demangler_crashes = 1;
1500 /* Stack context and environment for demangler crash recovery. */
1502 static SIGJMP_BUF gdb_demangle_jmp_buf;
1504 /* If nonzero, attempt to dump core from the signal handler. */
1506 static int gdb_demangle_attempt_core_dump = 1;
1508 /* Signal handler for gdb_demangle. */
1511 gdb_demangle_signal_handler (int signo)
1513 if (gdb_demangle_attempt_core_dump)
1518 gdb_demangle_attempt_core_dump = 0;
1521 SIGLONGJMP (gdb_demangle_jmp_buf, signo);
1526 /* A wrapper for bfd_demangle. */
1529 gdb_demangle (const char *name, int options)
1531 char *result = NULL;
1532 int crash_signal = 0;
1534 #ifdef HAVE_WORKING_FORK
1535 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
1536 struct sigaction sa, old_sa;
1540 static int core_dump_allowed = -1;
1542 if (core_dump_allowed == -1)
1544 core_dump_allowed = can_dump_core (LIMIT_CUR);
1546 if (!core_dump_allowed)
1547 gdb_demangle_attempt_core_dump = 0;
1550 if (catch_demangler_crashes)
1552 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
1553 sa.sa_handler = gdb_demangle_signal_handler;
1554 sigemptyset (&sa.sa_mask);
1555 #ifdef HAVE_SIGALTSTACK
1556 sa.sa_flags = SA_ONSTACK;
1560 sigaction (SIGSEGV, &sa, &old_sa);
1562 ofunc = (void (*)()) signal (SIGSEGV, gdb_demangle_signal_handler);
1565 crash_signal = SIGSETJMP (gdb_demangle_jmp_buf);
1569 if (crash_signal == 0)
1570 result = bfd_demangle (NULL, name, options);
1572 #ifdef HAVE_WORKING_FORK
1573 if (catch_demangler_crashes)
1575 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
1576 sigaction (SIGSEGV, &old_sa, NULL);
1578 signal (SIGSEGV, ofunc);
1581 if (crash_signal != 0)
1583 static int error_reported = 0;
1585 if (!error_reported)
1587 char *short_msg, *long_msg;
1588 struct cleanup *back_to;
1590 short_msg = xstrprintf (_("unable to demangle '%s' "
1591 "(demangler failed with signal %d)"),
1592 name, crash_signal);
1593 back_to = make_cleanup (xfree, short_msg);
1595 long_msg = xstrprintf ("%s:%d: %s: %s", __FILE__, __LINE__,
1596 "demangler-warning", short_msg);
1597 make_cleanup (xfree, long_msg);
1599 target_terminal_ours ();
1601 if (core_dump_allowed)
1602 fprintf_unfiltered (gdb_stderr,
1603 _("%s\nAttempting to dump core.\n"),
1606 warn_cant_dump_core (long_msg);
1608 demangler_warning (__FILE__, __LINE__, "%s", short_msg);
1610 do_cleanups (back_to);
1623 /* Don't allow just "maintenance cplus". */
1626 maint_cplus_command (char *arg, int from_tty)
1628 printf_unfiltered (_("\"maintenance cplus\" must be followed "
1629 "by the name of a command.\n"));
1630 help_list (maint_cplus_cmd_list,
1631 "maintenance cplus ",
1632 all_commands, gdb_stdout);
1635 /* This is a front end for cp_find_first_component, for unit testing.
1636 Be careful when using it: see the NOTE above
1637 cp_find_first_component. */
1640 first_component_command (char *arg, int from_tty)
1648 len = cp_find_first_component (arg);
1649 prefix = alloca (len + 1);
1651 memcpy (prefix, arg, len);
1654 printf_unfiltered ("%s\n", prefix);
1657 extern initialize_file_ftype _initialize_cp_support; /* -Wmissing-prototypes */
1660 /* Implement "info vtbl". */
1663 info_vtbl_command (char *arg, int from_tty)
1665 struct value *value;
1667 value = parse_and_eval (arg);
1668 cplus_print_vtable (value);
1672 _initialize_cp_support (void)
1674 add_prefix_cmd ("cplus", class_maintenance,
1675 maint_cplus_command,
1676 _("C++ maintenance commands."),
1677 &maint_cplus_cmd_list,
1678 "maintenance cplus ",
1679 0, &maintenancelist);
1680 add_alias_cmd ("cp", "cplus",
1681 class_maintenance, 1,
1684 add_cmd ("first_component",
1686 first_component_command,
1687 _("Print the first class/namespace component of NAME."),
1688 &maint_cplus_cmd_list);
1690 add_info ("vtbl", info_vtbl_command,
1691 _("Show the virtual function table for a C++ object.\n\
1692 Usage: info vtbl EXPRESSION\n\
1693 Evaluate EXPRESSION and display the virtual function table for the\n\
1694 resulting object."));
1696 #ifdef HAVE_WORKING_FORK
1697 add_setshow_boolean_cmd ("catch-demangler-crashes", class_maintenance,
1698 &catch_demangler_crashes, _("\
1699 Set whether to attempt to catch demangler crashes."), _("\
1700 Show whether to attempt to catch demangler crashes."), _("\
1701 If enabled GDB will attempt to catch demangler crashes and\n\
1702 display the offending symbol."),
1705 &maintenance_set_cmdlist,
1706 &maintenance_show_cmdlist);