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 /* A list of typedefs which should not be substituted by replace_typedefs. */
69 static const char * const ignore_typedefs[] =
71 "std::istream", "std::iostream", "std::ostream", "std::string"
75 replace_typedefs (struct demangle_parse_info *info,
76 struct demangle_component *ret_comp,
77 canonicalization_ftype *finder,
80 /* A convenience function to copy STRING into OBSTACK, returning a pointer
81 to the newly allocated string and saving the number of bytes saved in LEN.
83 It does not copy the terminating '\0' byte! */
86 copy_string_to_obstack (struct obstack *obstack, const char *string,
89 *len = strlen (string);
90 return (char *) obstack_copy (obstack, string, *len);
93 /* Return 1 if STRING is clearly already in canonical form. This
94 function is conservative; things which it does not recognize are
95 assumed to be non-canonical, and the parser will sort them out
96 afterwards. This speeds up the critical path for alphanumeric
100 cp_already_canonical (const char *string)
102 /* Identifier start character [a-zA-Z_]. */
103 if (!ISIDST (string[0]))
106 /* These are the only two identifiers which canonicalize to other
107 than themselves or an error: unsigned -> unsigned int and
109 if (string[0] == 'u' && strcmp (&string[1], "nsigned") == 0)
111 else if (string[0] == 's' && strcmp (&string[1], "igned") == 0)
114 /* Identifier character [a-zA-Z0-9_]. */
115 while (ISIDNUM (string[1]))
118 if (string[1] == '\0')
124 /* Inspect the given RET_COMP for its type. If it is a typedef,
125 replace the node with the typedef's tree.
127 Returns 1 if any typedef substitutions were made, 0 otherwise. */
130 inspect_type (struct demangle_parse_info *info,
131 struct demangle_component *ret_comp,
132 canonicalization_ftype *finder,
139 /* Copy the symbol's name from RET_COMP and look it up
140 in the symbol table. */
141 name = (char *) alloca (ret_comp->u.s_name.len + 1);
142 memcpy (name, ret_comp->u.s_name.s, ret_comp->u.s_name.len);
143 name[ret_comp->u.s_name.len] = '\0';
145 /* Ignore any typedefs that should not be substituted. */
146 for (i = 0; i < ARRAY_SIZE (ignore_typedefs); ++i)
148 if (strcmp (name, ignore_typedefs[i]) == 0)
156 sym = lookup_symbol (name, 0, VAR_DOMAIN, 0).symbol;
158 CATCH (except, RETURN_MASK_ALL)
166 struct type *otype = SYMBOL_TYPE (sym);
170 const char *new_name = (*finder) (otype, data);
172 if (new_name != NULL)
174 ret_comp->u.s_name.s = new_name;
175 ret_comp->u.s_name.len = strlen (new_name);
182 /* If the type is a typedef or namespace alias, replace it. */
183 if (TYPE_CODE (otype) == TYPE_CODE_TYPEDEF
184 || TYPE_CODE (otype) == TYPE_CODE_NAMESPACE)
189 std::unique_ptr<demangle_parse_info> i;
191 /* Get the real type of the typedef. */
192 type = check_typedef (otype);
194 /* If the symbol is a namespace and its type name is no different
195 than the name we looked up, this symbol is not a namespace
196 alias and does not need to be substituted. */
197 if (TYPE_CODE (otype) == TYPE_CODE_NAMESPACE
198 && strcmp (TYPE_NAME (type), name) == 0)
201 is_anon = (TYPE_TAG_NAME (type) == NULL
202 && (TYPE_CODE (type) == TYPE_CODE_ENUM
203 || TYPE_CODE (type) == TYPE_CODE_STRUCT
204 || TYPE_CODE (type) == TYPE_CODE_UNION));
207 struct type *last = otype;
209 /* Find the last typedef for the type. */
210 while (TYPE_TARGET_TYPE (last) != NULL
211 && (TYPE_CODE (TYPE_TARGET_TYPE (last))
212 == TYPE_CODE_TYPEDEF))
213 last = TYPE_TARGET_TYPE (last);
215 /* If there is only one typedef for this anonymous type,
216 do not substitute it. */
220 /* Use the last typedef seen as the type for this
228 type_print (type, "", &buf, -1);
230 /* If type_print threw an exception, there is little point
231 in continuing, so just bow out gracefully. */
232 CATCH (except, RETURN_MASK_ERROR)
239 name = (char *) obstack_copy0 (&info->obstack, buf.c_str (), len);
241 /* Turn the result into a new tree. Note that this
242 tree will contain pointers into NAME, so NAME cannot
243 be free'd until all typedef conversion is done and
244 the final result is converted into a string. */
245 i = cp_demangled_name_to_comp (name, NULL);
248 /* Merge the two trees. */
249 cp_merge_demangle_parse_infos (info, ret_comp, i.get ());
251 /* Replace any newly introduced typedefs -- but not
252 if the type is anonymous (that would lead to infinite
255 replace_typedefs (info, ret_comp, finder, data);
259 /* This shouldn't happen unless the type printer has
260 output something that the name parser cannot grok.
261 Nonetheless, an ounce of prevention...
263 Canonicalize the name again, and store it in the
264 current node (RET_COMP). */
265 std::string canon = cp_canonicalize_string_no_typedefs (name);
269 /* Copy the canonicalization into the obstack. */
270 name = copy_string_to_obstack (&info->obstack, canon.c_str (), &len);
273 ret_comp->u.s_name.s = name;
274 ret_comp->u.s_name.len = len;
284 /* Replace any typedefs appearing in the qualified name
285 (DEMANGLE_COMPONENT_QUAL_NAME) represented in RET_COMP for the name parse
289 replace_typedefs_qualified_name (struct demangle_parse_info *info,
290 struct demangle_component *ret_comp,
291 canonicalization_ftype *finder,
295 struct demangle_component *comp = ret_comp;
297 /* Walk each node of the qualified name, reconstructing the name of
298 this element. With every node, check for any typedef substitutions.
299 If a substitution has occurred, replace the qualified name node
300 with a DEMANGLE_COMPONENT_NAME node representing the new, typedef-
302 while (comp->type == DEMANGLE_COMPONENT_QUAL_NAME)
304 if (d_left (comp)->type == DEMANGLE_COMPONENT_NAME)
306 struct demangle_component newobj;
308 buf.write (d_left (comp)->u.s_name.s, d_left (comp)->u.s_name.len);
309 newobj.type = DEMANGLE_COMPONENT_NAME;
311 = (char *) obstack_copy0 (&info->obstack,
312 buf.c_str (), buf.size ());
313 newobj.u.s_name.len = buf.size ();
314 if (inspect_type (info, &newobj, finder, data))
319 /* A typedef was substituted in NEW. Convert it to a
320 string and replace the top DEMANGLE_COMPONENT_QUAL_NAME
324 gdb::unique_xmalloc_ptr<char> n
325 = cp_comp_to_string (&newobj, 100);
328 /* If something went astray, abort typedef substitutions. */
332 s = copy_string_to_obstack (&info->obstack, n.get (), &slen);
334 d_left (ret_comp)->type = DEMANGLE_COMPONENT_NAME;
335 d_left (ret_comp)->u.s_name.s = s;
336 d_left (ret_comp)->u.s_name.len = slen;
337 d_right (ret_comp) = d_right (comp);
344 /* The current node is not a name, so simply replace any
345 typedefs in it. Then print it to the stream to continue
346 checking for more typedefs in the tree. */
347 replace_typedefs (info, d_left (comp), finder, data);
348 gdb::unique_xmalloc_ptr<char> name
349 = cp_comp_to_string (d_left (comp), 100);
352 /* If something went astray, abort typedef substitutions. */
355 buf.puts (name.get ());
359 comp = d_right (comp);
362 /* If the next component is DEMANGLE_COMPONENT_NAME, save the qualified
363 name assembled above and append the name given by COMP. Then use this
364 reassembled name to check for a typedef. */
366 if (comp->type == DEMANGLE_COMPONENT_NAME)
368 buf.write (comp->u.s_name.s, comp->u.s_name.len);
370 /* Replace the top (DEMANGLE_COMPONENT_QUAL_NAME) node
371 with a DEMANGLE_COMPONENT_NAME node containing the whole
373 ret_comp->type = DEMANGLE_COMPONENT_NAME;
375 = (char *) obstack_copy0 (&info->obstack,
376 buf.c_str (), buf.size ());
377 ret_comp->u.s_name.len = buf.size ();
378 inspect_type (info, ret_comp, finder, data);
381 replace_typedefs (info, comp, finder, data);
385 /* A function to check const and volatile qualifiers for argument types.
387 "Parameter declarations that differ only in the presence
388 or absence of `const' and/or `volatile' are equivalent."
389 C++ Standard N3290, clause 13.1.3 #4. */
392 check_cv_qualifiers (struct demangle_component *ret_comp)
394 while (d_left (ret_comp) != NULL
395 && (d_left (ret_comp)->type == DEMANGLE_COMPONENT_CONST
396 || d_left (ret_comp)->type == DEMANGLE_COMPONENT_VOLATILE))
398 d_left (ret_comp) = d_left (d_left (ret_comp));
402 /* Walk the parse tree given by RET_COMP, replacing any typedefs with
403 their basic types. */
406 replace_typedefs (struct demangle_parse_info *info,
407 struct demangle_component *ret_comp,
408 canonicalization_ftype *finder,
414 && (ret_comp->type == DEMANGLE_COMPONENT_NAME
415 || ret_comp->type == DEMANGLE_COMPONENT_QUAL_NAME
416 || ret_comp->type == DEMANGLE_COMPONENT_TEMPLATE
417 || ret_comp->type == DEMANGLE_COMPONENT_BUILTIN_TYPE))
419 gdb::unique_xmalloc_ptr<char> local_name
420 = cp_comp_to_string (ret_comp, 10);
422 if (local_name != NULL)
424 struct symbol *sym = NULL;
429 sym = lookup_symbol (local_name.get (), 0,
430 VAR_DOMAIN, 0).symbol;
432 CATCH (except, RETURN_MASK_ALL)
439 struct type *otype = SYMBOL_TYPE (sym);
440 const char *new_name = (*finder) (otype, data);
442 if (new_name != NULL)
444 ret_comp->type = DEMANGLE_COMPONENT_NAME;
445 ret_comp->u.s_name.s = new_name;
446 ret_comp->u.s_name.len = strlen (new_name);
453 switch (ret_comp->type)
455 case DEMANGLE_COMPONENT_ARGLIST:
456 check_cv_qualifiers (ret_comp);
459 case DEMANGLE_COMPONENT_FUNCTION_TYPE:
460 case DEMANGLE_COMPONENT_TEMPLATE:
461 case DEMANGLE_COMPONENT_TEMPLATE_ARGLIST:
462 case DEMANGLE_COMPONENT_TYPED_NAME:
463 replace_typedefs (info, d_left (ret_comp), finder, data);
464 replace_typedefs (info, d_right (ret_comp), finder, data);
467 case DEMANGLE_COMPONENT_NAME:
468 inspect_type (info, ret_comp, finder, data);
471 case DEMANGLE_COMPONENT_QUAL_NAME:
472 replace_typedefs_qualified_name (info, ret_comp, finder, data);
475 case DEMANGLE_COMPONENT_LOCAL_NAME:
476 case DEMANGLE_COMPONENT_CTOR:
477 case DEMANGLE_COMPONENT_ARRAY_TYPE:
478 case DEMANGLE_COMPONENT_PTRMEM_TYPE:
479 replace_typedefs (info, d_right (ret_comp), finder, data);
482 case DEMANGLE_COMPONENT_CONST:
483 case DEMANGLE_COMPONENT_RESTRICT:
484 case DEMANGLE_COMPONENT_VOLATILE:
485 case DEMANGLE_COMPONENT_VOLATILE_THIS:
486 case DEMANGLE_COMPONENT_CONST_THIS:
487 case DEMANGLE_COMPONENT_RESTRICT_THIS:
488 case DEMANGLE_COMPONENT_POINTER:
489 case DEMANGLE_COMPONENT_REFERENCE:
490 case DEMANGLE_COMPONENT_RVALUE_REFERENCE:
491 replace_typedefs (info, d_left (ret_comp), finder, data);
500 /* Parse STRING and convert it to canonical form, resolving any
501 typedefs. If parsing fails, or if STRING is already canonical,
502 return the empty string. Otherwise return the canonical form. If
503 FINDER is not NULL, then type components are passed to FINDER to be
504 looked up. DATA is passed verbatim to FINDER. */
507 cp_canonicalize_string_full (const char *string,
508 canonicalization_ftype *finder,
512 unsigned int estimated_len;
513 std::unique_ptr<demangle_parse_info> info;
515 estimated_len = strlen (string) * 2;
516 info = cp_demangled_name_to_comp (string, NULL);
519 /* Replace all the typedefs in the tree. */
520 replace_typedefs (info.get (), info->tree, finder, data);
522 /* Convert the tree back into a string. */
523 gdb::unique_xmalloc_ptr<char> us = cp_comp_to_string (info->tree,
528 /* Finally, compare the original string with the computed
529 name, returning NULL if they are the same. */
531 return std::string ();
537 /* Like cp_canonicalize_string_full, but always passes NULL for
541 cp_canonicalize_string_no_typedefs (const char *string)
543 return cp_canonicalize_string_full (string, NULL, NULL);
546 /* Parse STRING and convert it to canonical form. If parsing fails,
547 or if STRING is already canonical, return the empty string.
548 Otherwise return the canonical form. */
551 cp_canonicalize_string (const char *string)
553 std::unique_ptr<demangle_parse_info> info;
554 unsigned int estimated_len;
556 if (cp_already_canonical (string))
557 return std::string ();
559 info = cp_demangled_name_to_comp (string, NULL);
561 return std::string ();
563 estimated_len = strlen (string) * 2;
564 gdb::unique_xmalloc_ptr<char> us (cp_comp_to_string (info->tree,
569 warning (_("internal error: string \"%s\" failed to be canonicalized"),
571 return std::string ();
574 std::string ret (us.get ());
577 return std::string ();
582 /* Convert a mangled name to a demangle_component tree. *MEMORY is
583 set to the block of used memory that should be freed when finished
584 with the tree. DEMANGLED_P is set to the char * that should be
585 freed when finished with the tree, or NULL if none was needed.
586 OPTIONS will be passed to the demangler. */
588 static std::unique_ptr<demangle_parse_info>
589 mangled_name_to_comp (const char *mangled_name, int options,
590 void **memory, char **demangled_p)
592 char *demangled_name;
594 /* If it looks like a v3 mangled name, then try to go directly
596 if (mangled_name[0] == '_' && mangled_name[1] == 'Z')
598 struct demangle_component *ret;
600 ret = cplus_demangle_v3_components (mangled_name,
604 std::unique_ptr<demangle_parse_info> info (new demangle_parse_info);
611 /* If it doesn't, or if that failed, then try to demangle the
613 demangled_name = gdb_demangle (mangled_name, options);
614 if (demangled_name == NULL)
617 /* If we could demangle the name, parse it to build the component
619 std::unique_ptr<demangle_parse_info> info
620 = cp_demangled_name_to_comp (demangled_name, NULL);
624 xfree (demangled_name);
628 *demangled_p = demangled_name;
632 /* Return the name of the class containing method PHYSNAME. */
635 cp_class_name_from_physname (const char *physname)
637 void *storage = NULL;
638 char *demangled_name = NULL;
639 gdb::unique_xmalloc_ptr<char> ret;
640 struct demangle_component *ret_comp, *prev_comp, *cur_comp;
641 std::unique_ptr<demangle_parse_info> info;
644 info = mangled_name_to_comp (physname, DMGL_ANSI,
645 &storage, &demangled_name);
650 ret_comp = info->tree;
652 /* First strip off any qualifiers, if we have a function or
655 switch (ret_comp->type)
657 case DEMANGLE_COMPONENT_CONST:
658 case DEMANGLE_COMPONENT_RESTRICT:
659 case DEMANGLE_COMPONENT_VOLATILE:
660 case DEMANGLE_COMPONENT_CONST_THIS:
661 case DEMANGLE_COMPONENT_RESTRICT_THIS:
662 case DEMANGLE_COMPONENT_VOLATILE_THIS:
663 case DEMANGLE_COMPONENT_VENDOR_TYPE_QUAL:
664 ret_comp = d_left (ret_comp);
671 /* If what we have now is a function, discard the argument list. */
672 if (ret_comp->type == DEMANGLE_COMPONENT_TYPED_NAME)
673 ret_comp = d_left (ret_comp);
675 /* If what we have now is a template, strip off the template
676 arguments. The left subtree may be a qualified name. */
677 if (ret_comp->type == DEMANGLE_COMPONENT_TEMPLATE)
678 ret_comp = d_left (ret_comp);
680 /* What we have now should be a name, possibly qualified.
681 Additional qualifiers could live in the left subtree or the right
682 subtree. Find the last piece. */
687 switch (cur_comp->type)
689 case DEMANGLE_COMPONENT_QUAL_NAME:
690 case DEMANGLE_COMPONENT_LOCAL_NAME:
691 prev_comp = cur_comp;
692 cur_comp = d_right (cur_comp);
694 case DEMANGLE_COMPONENT_TEMPLATE:
695 case DEMANGLE_COMPONENT_NAME:
696 case DEMANGLE_COMPONENT_CTOR:
697 case DEMANGLE_COMPONENT_DTOR:
698 case DEMANGLE_COMPONENT_OPERATOR:
699 case DEMANGLE_COMPONENT_EXTENDED_OPERATOR:
708 if (cur_comp != NULL && prev_comp != NULL)
710 /* We want to discard the rightmost child of PREV_COMP. */
711 *prev_comp = *d_left (prev_comp);
712 /* The ten is completely arbitrary; we don't have a good
714 ret = cp_comp_to_string (ret_comp, 10);
718 xfree (demangled_name);
719 return ret.release ();
722 /* Return the child of COMP which is the basename of a method,
723 variable, et cetera. All scope qualifiers are discarded, but
724 template arguments will be included. The component tree may be
727 static struct demangle_component *
728 unqualified_name_from_comp (struct demangle_component *comp)
730 struct demangle_component *ret_comp = comp, *last_template;
734 last_template = NULL;
736 switch (ret_comp->type)
738 case DEMANGLE_COMPONENT_QUAL_NAME:
739 case DEMANGLE_COMPONENT_LOCAL_NAME:
740 ret_comp = d_right (ret_comp);
742 case DEMANGLE_COMPONENT_TYPED_NAME:
743 ret_comp = d_left (ret_comp);
745 case DEMANGLE_COMPONENT_TEMPLATE:
746 gdb_assert (last_template == NULL);
747 last_template = ret_comp;
748 ret_comp = d_left (ret_comp);
750 case DEMANGLE_COMPONENT_CONST:
751 case DEMANGLE_COMPONENT_RESTRICT:
752 case DEMANGLE_COMPONENT_VOLATILE:
753 case DEMANGLE_COMPONENT_CONST_THIS:
754 case DEMANGLE_COMPONENT_RESTRICT_THIS:
755 case DEMANGLE_COMPONENT_VOLATILE_THIS:
756 case DEMANGLE_COMPONENT_VENDOR_TYPE_QUAL:
757 ret_comp = d_left (ret_comp);
759 case DEMANGLE_COMPONENT_NAME:
760 case DEMANGLE_COMPONENT_CTOR:
761 case DEMANGLE_COMPONENT_DTOR:
762 case DEMANGLE_COMPONENT_OPERATOR:
763 case DEMANGLE_COMPONENT_EXTENDED_OPERATOR:
773 d_left (last_template) = ret_comp;
774 return last_template;
780 /* Return the name of the method whose linkage name is PHYSNAME. */
783 method_name_from_physname (const char *physname)
785 void *storage = NULL;
786 char *demangled_name = NULL;
787 gdb::unique_xmalloc_ptr<char> ret;
788 struct demangle_component *ret_comp;
789 std::unique_ptr<demangle_parse_info> info;
791 info = mangled_name_to_comp (physname, DMGL_ANSI,
792 &storage, &demangled_name);
796 ret_comp = unqualified_name_from_comp (info->tree);
798 if (ret_comp != NULL)
799 /* The ten is completely arbitrary; we don't have a good
801 ret = cp_comp_to_string (ret_comp, 10);
804 xfree (demangled_name);
805 return ret.release ();
808 /* If FULL_NAME is the demangled name of a C++ function (including an
809 arg list, possibly including namespace/class qualifications),
810 return a new string containing only the function name (without the
811 arg list/class qualifications). Otherwise, return NULL. The
812 caller is responsible for freeing the memory in question. */
815 cp_func_name (const char *full_name)
817 gdb::unique_xmalloc_ptr<char> ret;
818 struct demangle_component *ret_comp;
819 std::unique_ptr<demangle_parse_info> info;
821 info = cp_demangled_name_to_comp (full_name, NULL);
825 ret_comp = unqualified_name_from_comp (info->tree);
827 if (ret_comp != NULL)
828 ret = cp_comp_to_string (ret_comp, 10);
830 return ret.release ();
833 /* DEMANGLED_NAME is the name of a function, including parameters and
834 (optionally) a return type. Return the name of the function without
835 parameters or return type, or NULL if we can not parse the name. */
837 gdb::unique_xmalloc_ptr<char>
838 cp_remove_params (const char *demangled_name)
841 struct demangle_component *ret_comp;
842 std::unique_ptr<demangle_parse_info> info;
843 gdb::unique_xmalloc_ptr<char> ret;
845 if (demangled_name == NULL)
848 info = cp_demangled_name_to_comp (demangled_name, NULL);
852 /* First strip off any qualifiers, if we have a function or method. */
853 ret_comp = info->tree;
855 switch (ret_comp->type)
857 case DEMANGLE_COMPONENT_CONST:
858 case DEMANGLE_COMPONENT_RESTRICT:
859 case DEMANGLE_COMPONENT_VOLATILE:
860 case DEMANGLE_COMPONENT_CONST_THIS:
861 case DEMANGLE_COMPONENT_RESTRICT_THIS:
862 case DEMANGLE_COMPONENT_VOLATILE_THIS:
863 case DEMANGLE_COMPONENT_VENDOR_TYPE_QUAL:
864 ret_comp = d_left (ret_comp);
871 /* What we have now should be a function. Return its name. */
872 if (ret_comp->type == DEMANGLE_COMPONENT_TYPED_NAME)
873 ret = cp_comp_to_string (d_left (ret_comp), 10);
878 /* Here are some random pieces of trivia to keep in mind while trying
879 to take apart demangled names:
881 - Names can contain function arguments or templates, so the process
882 has to be, to some extent recursive: maybe keep track of your
883 depth based on encountering <> and ().
885 - Parentheses don't just have to happen at the end of a name: they
886 can occur even if the name in question isn't a function, because
887 a template argument might be a type that's a function.
889 - Conversely, even if you're trying to deal with a function, its
890 demangled name might not end with ')': it could be a const or
891 volatile class method, in which case it ends with "const" or
894 - Parentheses are also used in anonymous namespaces: a variable
895 'foo' in an anonymous namespace gets demangled as "(anonymous
898 - And operator names can contain parentheses or angle brackets. */
900 /* FIXME: carlton/2003-03-13: We have several functions here with
901 overlapping functionality; can we combine them? Also, do they
902 handle all the above considerations correctly? */
905 /* This returns the length of first component of NAME, which should be
906 the demangled name of a C++ variable/function/method/etc.
907 Specifically, it returns the index of the first colon forming the
908 boundary of the first component: so, given 'A::foo' or 'A::B::foo'
909 it returns the 1, and given 'foo', it returns 0. */
911 /* The character in NAME indexed by the return value is guaranteed to
912 always be either ':' or '\0'. */
914 /* NOTE: carlton/2003-03-13: This function is currently only intended
915 for internal use: it's probably not entirely safe when called on
916 user-generated input, because some of the 'index += 2' lines in
917 cp_find_first_component_aux might go past the end of malformed
921 cp_find_first_component (const char *name)
923 return cp_find_first_component_aux (name, 0);
926 /* Helper function for cp_find_first_component. Like that function,
927 it returns the length of the first component of NAME, but to make
928 the recursion easier, it also stops if it reaches an unexpected ')'
929 or '>' if the value of PERMISSIVE is nonzero. */
932 cp_find_first_component_aux (const char *name, int permissive)
934 unsigned int index = 0;
935 /* Operator names can show up in unexpected places. Since these can
936 contain parentheses or angle brackets, they can screw up the
937 recursion. But not every string 'operator' is part of an
938 operater name: e.g. you could have a variable 'cooperator'. So
939 this variable tells us whether or not we should treat the string
940 'operator' as starting an operator. */
941 int operator_possible = 1;
948 /* Template; eat it up. The calls to cp_first_component
949 should only return (I hope!) when they reach the '>'
950 terminating the component or a '::' between two
951 components. (Hence the '+ 2'.) */
953 for (index += cp_find_first_component_aux (name + index, 1);
955 index += cp_find_first_component_aux (name + index, 1))
957 if (name[index] != ':')
959 demangled_name_complaint (name);
960 return strlen (name);
964 operator_possible = 1;
967 /* Similar comment as to '<'. */
969 for (index += cp_find_first_component_aux (name + index, 1);
971 index += cp_find_first_component_aux (name + index, 1))
973 if (name[index] != ':')
975 demangled_name_complaint (name);
976 return strlen (name);
980 operator_possible = 1;
988 demangled_name_complaint (name);
989 return strlen (name);
994 /* ':' marks a component iff the next character is also a ':'.
995 Otherwise it is probably malformed input. */
996 if (name[index + 1] == ':')
1000 /* Operator names can screw up the recursion. */
1001 if (operator_possible
1002 && startswith (name + index, CP_OPERATOR_STR))
1004 index += CP_OPERATOR_LEN;
1005 while (ISSPACE(name[index]))
1007 switch (name[index])
1011 /* Skip over one less than the appropriate number of
1012 characters: the for loop will skip over the last
1015 if (name[index + 1] == '<')
1022 if (name[index + 1] == '>')
1035 operator_possible = 0;
1042 /* NOTE: carlton/2003-04-18: I'm not sure what the precise
1043 set of relevant characters are here: it's necessary to
1044 include any character that can show up before 'operator'
1045 in a demangled name, and it's safe to include any
1046 character that can't be part of an identifier's name. */
1047 operator_possible = 1;
1050 operator_possible = 0;
1056 /* Complain about a demangled name that we don't know how to parse.
1057 NAME is the demangled name in question. */
1060 demangled_name_complaint (const char *name)
1062 complaint (&symfile_complaints,
1063 "unexpected demangled name '%s'", name);
1066 /* If NAME is the fully-qualified name of a C++
1067 function/variable/method/etc., this returns the length of its
1068 entire prefix: all of the namespaces and classes that make up its
1069 name. Given 'A::foo', it returns 1, given 'A::B::foo', it returns
1070 4, given 'foo', it returns 0. */
1073 cp_entire_prefix_len (const char *name)
1075 unsigned int current_len = cp_find_first_component (name);
1076 unsigned int previous_len = 0;
1078 while (name[current_len] != '\0')
1080 gdb_assert (name[current_len] == ':');
1081 previous_len = current_len;
1082 /* Skip the '::'. */
1084 current_len += cp_find_first_component (name + current_len);
1087 return previous_len;
1090 /* Overload resolution functions. */
1092 /* Test to see if SYM is a symbol that we haven't seen corresponding
1093 to a function named OLOAD_NAME. If so, add it to the current
1097 overload_list_add_symbol (struct symbol *sym,
1098 const char *oload_name)
1102 gdb::unique_xmalloc_ptr<char> sym_name;
1104 /* If there is no type information, we can't do anything, so
1106 if (SYMBOL_TYPE (sym) == NULL)
1109 /* skip any symbols that we've already considered. */
1110 for (i = 0; i < sym_return_val_index; ++i)
1111 if (strcmp (SYMBOL_LINKAGE_NAME (sym),
1112 SYMBOL_LINKAGE_NAME (sym_return_val[i])) == 0)
1115 /* Get the demangled name without parameters */
1116 sym_name = cp_remove_params (SYMBOL_NATURAL_NAME (sym));
1120 /* skip symbols that cannot match */
1121 if (strcmp (sym_name.get (), oload_name) != 0)
1124 /* We have a match for an overload instance, so add SYM to the
1125 current list of overload instances */
1126 if (sym_return_val_index + 3 > sym_return_val_size)
1128 newsize = (sym_return_val_size *= 2) * sizeof (struct symbol *);
1129 sym_return_val = (struct symbol **)
1130 xrealloc ((char *) sym_return_val, newsize);
1132 sym_return_val[sym_return_val_index++] = sym;
1133 sym_return_val[sym_return_val_index] = NULL;
1136 /* Return a null-terminated list of pointers to function symbols that
1137 are named FUNC_NAME and are visible within NAMESPACE. */
1140 make_symbol_overload_list (const char *func_name,
1141 const char *the_namespace)
1143 struct cleanup *old_cleanups;
1146 sym_return_val_size = 100;
1147 sym_return_val_index = 0;
1148 sym_return_val = XNEWVEC (struct symbol *, sym_return_val_size + 1);
1149 sym_return_val[0] = NULL;
1151 old_cleanups = make_cleanup (xfree, sym_return_val);
1153 make_symbol_overload_list_using (func_name, the_namespace);
1155 if (the_namespace[0] == '\0')
1159 char *concatenated_name
1160 = (char *) alloca (strlen (the_namespace) + 2 + strlen (func_name) + 1);
1161 strcpy (concatenated_name, the_namespace);
1162 strcat (concatenated_name, "::");
1163 strcat (concatenated_name, func_name);
1164 name = concatenated_name;
1167 make_symbol_overload_list_qualified (name);
1169 discard_cleanups (old_cleanups);
1171 return sym_return_val;
1174 /* Add all symbols with a name matching NAME in BLOCK to the overload
1178 make_symbol_overload_list_block (const char *name,
1179 const struct block *block)
1181 struct block_iterator iter;
1184 ALL_BLOCK_SYMBOLS_WITH_NAME (block, name, iter, sym)
1185 overload_list_add_symbol (sym, name);
1188 /* Adds the function FUNC_NAME from NAMESPACE to the overload set. */
1191 make_symbol_overload_list_namespace (const char *func_name,
1192 const char *the_namespace)
1195 const struct block *block = NULL;
1197 if (the_namespace[0] == '\0')
1201 char *concatenated_name
1202 = (char *) alloca (strlen (the_namespace) + 2 + strlen (func_name) + 1);
1204 strcpy (concatenated_name, the_namespace);
1205 strcat (concatenated_name, "::");
1206 strcat (concatenated_name, func_name);
1207 name = concatenated_name;
1210 /* Look in the static block. */
1211 block = block_static_block (get_selected_block (0));
1213 make_symbol_overload_list_block (name, block);
1215 /* Look in the global block. */
1216 block = block_global_block (block);
1218 make_symbol_overload_list_block (name, block);
1222 /* Search the namespace of the given type and namespace of and public
1226 make_symbol_overload_list_adl_namespace (struct type *type,
1227 const char *func_name)
1229 char *the_namespace;
1230 const char *type_name;
1233 while (TYPE_CODE (type) == TYPE_CODE_PTR
1234 || TYPE_IS_REFERENCE (type)
1235 || TYPE_CODE (type) == TYPE_CODE_ARRAY
1236 || TYPE_CODE (type) == TYPE_CODE_TYPEDEF)
1238 if (TYPE_CODE (type) == TYPE_CODE_TYPEDEF)
1239 type = check_typedef(type);
1241 type = TYPE_TARGET_TYPE (type);
1244 type_name = TYPE_NAME (type);
1246 if (type_name == NULL)
1249 prefix_len = cp_entire_prefix_len (type_name);
1251 if (prefix_len != 0)
1253 the_namespace = (char *) alloca (prefix_len + 1);
1254 strncpy (the_namespace, type_name, prefix_len);
1255 the_namespace[prefix_len] = '\0';
1257 make_symbol_overload_list_namespace (func_name, the_namespace);
1260 /* Check public base type */
1261 if (TYPE_CODE (type) == TYPE_CODE_STRUCT)
1262 for (i = 0; i < TYPE_N_BASECLASSES (type); i++)
1264 if (BASETYPE_VIA_PUBLIC (type, i))
1265 make_symbol_overload_list_adl_namespace (TYPE_BASECLASS (type,
1271 /* Adds the overload list overload candidates for FUNC_NAME found
1272 through argument dependent lookup. */
1275 make_symbol_overload_list_adl (struct type **arg_types, int nargs,
1276 const char *func_name)
1280 gdb_assert (sym_return_val_size != -1);
1282 for (i = 1; i <= nargs; i++)
1283 make_symbol_overload_list_adl_namespace (arg_types[i - 1],
1286 return sym_return_val;
1289 /* This applies the using directives to add namespaces to search in,
1290 and then searches for overloads in all of those namespaces. It
1291 adds the symbols found to sym_return_val. Arguments are as in
1292 make_symbol_overload_list. */
1295 make_symbol_overload_list_using (const char *func_name,
1296 const char *the_namespace)
1298 struct using_direct *current;
1299 const struct block *block;
1301 /* First, go through the using directives. If any of them apply,
1302 look in the appropriate namespaces for new functions to match
1305 for (block = get_selected_block (0);
1307 block = BLOCK_SUPERBLOCK (block))
1308 for (current = block_using (block);
1310 current = current->next)
1312 /* Prevent recursive calls. */
1313 if (current->searched)
1316 /* If this is a namespace alias or imported declaration ignore
1318 if (current->alias != NULL || current->declaration != NULL)
1321 if (strcmp (the_namespace, current->import_dest) == 0)
1323 /* Mark this import as searched so that the recursive call
1324 does not search it again. */
1325 scoped_restore reset_directive_searched
1326 = make_scoped_restore (¤t->searched, 1);
1328 make_symbol_overload_list_using (func_name,
1329 current->import_src);
1333 /* Now, add names for this namespace. */
1334 make_symbol_overload_list_namespace (func_name, the_namespace);
1337 /* This does the bulk of the work of finding overloaded symbols.
1338 FUNC_NAME is the name of the overloaded function we're looking for
1339 (possibly including namespace info). */
1342 make_symbol_overload_list_qualified (const char *func_name)
1344 struct compunit_symtab *cust;
1345 struct objfile *objfile;
1346 const struct block *b, *surrounding_static_block = 0;
1348 /* Look through the partial symtabs for all symbols which begin by
1349 matching FUNC_NAME. Make sure we read that symbol table in. */
1351 ALL_OBJFILES (objfile)
1354 objfile->sf->qf->expand_symtabs_for_function (objfile, func_name);
1357 /* Search upwards from currently selected frame (so that we can
1358 complete on local vars. */
1360 for (b = get_selected_block (0); b != NULL; b = BLOCK_SUPERBLOCK (b))
1361 make_symbol_overload_list_block (func_name, b);
1363 surrounding_static_block = block_static_block (get_selected_block (0));
1365 /* Go through the symtabs and check the externs and statics for
1366 symbols which match. */
1368 ALL_COMPUNITS (objfile, cust)
1371 b = BLOCKVECTOR_BLOCK (COMPUNIT_BLOCKVECTOR (cust), GLOBAL_BLOCK);
1372 make_symbol_overload_list_block (func_name, b);
1375 ALL_COMPUNITS (objfile, cust)
1378 b = BLOCKVECTOR_BLOCK (COMPUNIT_BLOCKVECTOR (cust), STATIC_BLOCK);
1379 /* Don't do this block twice. */
1380 if (b == surrounding_static_block)
1382 make_symbol_overload_list_block (func_name, b);
1386 /* Lookup the rtti type for a class name. */
1389 cp_lookup_rtti_type (const char *name, struct block *block)
1391 struct symbol * rtti_sym;
1392 struct type * rtti_type;
1394 /* Use VAR_DOMAIN here as NAME may be a typedef. PR 18141, 18417.
1395 Classes "live" in both STRUCT_DOMAIN and VAR_DOMAIN. */
1396 rtti_sym = lookup_symbol (name, block, VAR_DOMAIN, NULL).symbol;
1398 if (rtti_sym == NULL)
1400 warning (_("RTTI symbol not found for class '%s'"), name);
1404 if (SYMBOL_CLASS (rtti_sym) != LOC_TYPEDEF)
1406 warning (_("RTTI symbol for class '%s' is not a type"), name);
1410 rtti_type = check_typedef (SYMBOL_TYPE (rtti_sym));
1412 switch (TYPE_CODE (rtti_type))
1414 case TYPE_CODE_STRUCT:
1416 case TYPE_CODE_NAMESPACE:
1417 /* chastain/2003-11-26: the symbol tables often contain fake
1418 symbols for namespaces with the same name as the struct.
1419 This warning is an indication of a bug in the lookup order
1420 or a bug in the way that the symbol tables are populated. */
1421 warning (_("RTTI symbol for class '%s' is a namespace"), name);
1424 warning (_("RTTI symbol for class '%s' has bad type"), name);
1431 #ifdef HAVE_WORKING_FORK
1433 /* If nonzero, attempt to catch crashes in the demangler and print
1434 useful debugging information. */
1436 static int catch_demangler_crashes = 1;
1438 /* Stack context and environment for demangler crash recovery. */
1440 static SIGJMP_BUF gdb_demangle_jmp_buf;
1442 /* If nonzero, attempt to dump core from the signal handler. */
1444 static int gdb_demangle_attempt_core_dump = 1;
1446 /* Signal handler for gdb_demangle. */
1449 gdb_demangle_signal_handler (int signo)
1451 if (gdb_demangle_attempt_core_dump)
1456 gdb_demangle_attempt_core_dump = 0;
1459 SIGLONGJMP (gdb_demangle_jmp_buf, signo);
1464 /* A wrapper for bfd_demangle. */
1467 gdb_demangle (const char *name, int options)
1469 char *result = NULL;
1470 int crash_signal = 0;
1472 #ifdef HAVE_WORKING_FORK
1473 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
1474 struct sigaction sa, old_sa;
1478 static int core_dump_allowed = -1;
1480 if (core_dump_allowed == -1)
1482 core_dump_allowed = can_dump_core (LIMIT_CUR);
1484 if (!core_dump_allowed)
1485 gdb_demangle_attempt_core_dump = 0;
1488 if (catch_demangler_crashes)
1490 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
1491 sa.sa_handler = gdb_demangle_signal_handler;
1492 sigemptyset (&sa.sa_mask);
1493 #ifdef HAVE_SIGALTSTACK
1494 sa.sa_flags = SA_ONSTACK;
1498 sigaction (SIGSEGV, &sa, &old_sa);
1500 ofunc = signal (SIGSEGV, gdb_demangle_signal_handler);
1503 crash_signal = SIGSETJMP (gdb_demangle_jmp_buf);
1507 if (crash_signal == 0)
1508 result = bfd_demangle (NULL, name, options);
1510 #ifdef HAVE_WORKING_FORK
1511 if (catch_demangler_crashes)
1513 #if defined (HAVE_SIGACTION) && defined (SA_RESTART)
1514 sigaction (SIGSEGV, &old_sa, NULL);
1516 signal (SIGSEGV, ofunc);
1519 if (crash_signal != 0)
1521 static int error_reported = 0;
1523 if (!error_reported)
1525 std::string short_msg
1526 = string_printf (_("unable to demangle '%s' "
1527 "(demangler failed with signal %d)"),
1528 name, crash_signal);
1530 std::string long_msg
1531 = string_printf ("%s:%d: %s: %s", __FILE__, __LINE__,
1532 "demangler-warning", short_msg.c_str ());
1534 target_terminal::scoped_restore_terminal_state term_state;
1535 target_terminal::ours_for_output ();
1538 if (core_dump_allowed)
1539 fprintf_unfiltered (gdb_stderr,
1540 _("%s\nAttempting to dump core.\n"),
1543 warn_cant_dump_core (long_msg.c_str ());
1545 demangler_warning (__FILE__, __LINE__, "%s", short_msg.c_str ());
1558 /* See cp-support.h. */
1561 gdb_sniff_from_mangled_name (const char *mangled, char **demangled)
1563 *demangled = gdb_demangle (mangled, DMGL_PARAMS | DMGL_ANSI);
1564 return *demangled != NULL;
1567 /* Don't allow just "maintenance cplus". */
1570 maint_cplus_command (const char *arg, int from_tty)
1572 printf_unfiltered (_("\"maintenance cplus\" must be followed "
1573 "by the name of a command.\n"));
1574 help_list (maint_cplus_cmd_list,
1575 "maintenance cplus ",
1576 all_commands, gdb_stdout);
1579 /* This is a front end for cp_find_first_component, for unit testing.
1580 Be careful when using it: see the NOTE above
1581 cp_find_first_component. */
1584 first_component_command (const char *arg, int from_tty)
1592 len = cp_find_first_component (arg);
1593 prefix = (char *) alloca (len + 1);
1595 memcpy (prefix, arg, len);
1598 printf_unfiltered ("%s\n", prefix);
1601 /* Implement "info vtbl". */
1604 info_vtbl_command (const char *arg, int from_tty)
1606 struct value *value;
1608 value = parse_and_eval (arg);
1609 cplus_print_vtable (value);
1613 _initialize_cp_support (void)
1615 add_prefix_cmd ("cplus", class_maintenance,
1616 maint_cplus_command,
1617 _("C++ maintenance commands."),
1618 &maint_cplus_cmd_list,
1619 "maintenance cplus ",
1620 0, &maintenancelist);
1621 add_alias_cmd ("cp", "cplus",
1622 class_maintenance, 1,
1625 add_cmd ("first_component",
1627 first_component_command,
1628 _("Print the first class/namespace component of NAME."),
1629 &maint_cplus_cmd_list);
1631 add_info ("vtbl", info_vtbl_command,
1632 _("Show the virtual function table for a C++ object.\n\
1633 Usage: info vtbl EXPRESSION\n\
1634 Evaluate EXPRESSION and display the virtual function table for the\n\
1635 resulting object."));
1637 #ifdef HAVE_WORKING_FORK
1638 add_setshow_boolean_cmd ("catch-demangler-crashes", class_maintenance,
1639 &catch_demangler_crashes, _("\
1640 Set whether to attempt to catch demangler crashes."), _("\
1641 Show whether to attempt to catch demangler crashes."), _("\
1642 If enabled GDB will attempt to catch demangler crashes and\n\
1643 display the offending symbol."),
1646 &maintenance_set_cmdlist,
1647 &maintenance_show_cmdlist);