More updated translations
[binutils-gdb.git] / gdb / cp-support.c
blob3621d685a56c175a1348767d8a9bcd56e8aaf0e4
1 /* Helper routines for C++ support in GDB.
2 Copyright (C) 2002-2024 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/>. */
21 #include "cp-support.h"
22 #include "language.h"
23 #include "demangle.h"
24 #include "cli/cli-cmds.h"
25 #include "dictionary.h"
26 #include "objfiles.h"
27 #include "frame.h"
28 #include "symtab.h"
29 #include "block.h"
30 #include "complaints.h"
31 #include "gdbtypes.h"
32 #include "expression.h"
33 #include "value.h"
34 #include "cp-abi.h"
35 #include "namespace.h"
36 #include <signal.h>
37 #include "gdbsupport/gdb_setjmp.h"
38 #include "gdbsupport/gdb-safe-ctype.h"
39 #include "gdbsupport/selftest.h"
40 #include "gdbsupport/gdb-sigmask.h"
41 #include <atomic>
42 #include "event-top.h"
43 #include "run-on-main-thread.h"
44 #include "typeprint.h"
45 #include "inferior.h"
47 #define d_left(dc) (dc)->u.s_binary.left
48 #define d_right(dc) (dc)->u.s_binary.right
50 /* Functions related to demangled name parsing. */
52 static unsigned int cp_find_first_component_aux (const char *name,
53 int permissive);
55 static void demangled_name_complaint (const char *name);
57 /* Functions related to overload resolution. */
59 static void overload_list_add_symbol (struct symbol *sym,
60 const char *oload_name,
61 std::vector<symbol *> *overload_list);
63 static void add_symbol_overload_list_using
64 (const char *func_name, const char *the_namespace,
65 std::vector<symbol *> *overload_list);
67 static void add_symbol_overload_list_qualified
68 (const char *func_name,
69 std::vector<symbol *> *overload_list);
71 /* The list of "maint cplus" commands. */
73 struct cmd_list_element *maint_cplus_cmd_list = NULL;
75 static void
76 replace_typedefs (struct demangle_parse_info *info,
77 struct demangle_component *ret_comp,
78 canonicalization_ftype *finder,
79 void *data);
81 static struct demangle_component *
82 gdb_cplus_demangle_v3_components (const char *mangled,
83 int options, void **mem);
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! */
90 static char *
91 copy_string_to_obstack (struct obstack *obstack, const char *string,
92 long *len)
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
102 identifiers. */
104 static int
105 cp_already_canonical (const char *string)
107 /* Identifier start character [a-zA-Z_]. */
108 if (!ISIDST (string[0]))
109 return 0;
111 /* These are the only two identifiers which canonicalize to other
112 than themselves or an error: unsigned -> unsigned int and
113 signed -> int. */
114 if (string[0] == 'u' && strcmp (&string[1], "nsigned") == 0)
115 return 0;
116 else if (string[0] == 's' && strcmp (&string[1], "igned") == 0)
117 return 0;
119 /* Identifier character [a-zA-Z0-9_]. */
120 while (ISIDNUM (string[1]))
121 string++;
123 if (string[1] == '\0')
124 return 1;
125 else
126 return 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. */
134 static int
135 inspect_type (struct demangle_parse_info *info,
136 struct demangle_component *ret_comp,
137 canonicalization_ftype *finder,
138 void *data)
140 char *name;
141 struct symbol *sym;
143 /* Copy the symbol's name from RET_COMP and look it up
144 in the symbol table. */
145 name = (char *) alloca (ret_comp->u.s_name.len + 1);
146 memcpy (name, ret_comp->u.s_name.s, ret_comp->u.s_name.len);
147 name[ret_comp->u.s_name.len] = '\0';
149 sym = NULL;
153 sym = lookup_symbol (name, 0, SEARCH_VFT, 0).symbol;
155 catch (const gdb_exception &except)
157 return 0;
160 if (sym != NULL)
162 struct type *otype = sym->type ();
164 if (finder != NULL)
166 const char *new_name = (*finder) (otype, data);
168 if (new_name != NULL)
170 ret_comp->u.s_name.s = new_name;
171 ret_comp->u.s_name.len = strlen (new_name);
172 return 1;
175 return 0;
178 /* If the type is a typedef or namespace alias, replace it. */
179 if (otype->code () == TYPE_CODE_TYPEDEF
180 || otype->code () == TYPE_CODE_NAMESPACE)
182 long len;
183 int is_anon;
184 struct type *type;
185 std::unique_ptr<demangle_parse_info> i;
187 /* Get the real type of the typedef. */
188 type = check_typedef (otype);
190 /* If the symbol name is the same as the original type name,
191 don't substitute. That would cause infinite recursion in
192 symbol lookups, as the typedef symbol is often the first
193 found symbol in the symbol table.
195 However, this can happen in a number of situations, such as:
197 If the symbol is a namespace and its type name is no different
198 than the name we looked up, this symbol is not a namespace
199 alias and does not need to be substituted.
201 If the symbol is typedef and its type name is the same
202 as the symbol's name, e.g., "typedef struct foo foo;". */
203 if (type->name () != nullptr
204 && strcmp (type->name (), name) == 0)
205 return 0;
207 is_anon = (type->name () == NULL
208 && (type->code () == TYPE_CODE_ENUM
209 || type->code () == TYPE_CODE_STRUCT
210 || type->code () == TYPE_CODE_UNION));
211 if (is_anon)
213 struct type *last = otype;
215 /* Find the last typedef for the type. */
216 while (last->target_type () != NULL
217 && (last->target_type ()->code ()
218 == TYPE_CODE_TYPEDEF))
219 last = last->target_type ();
221 /* If there is only one typedef for this anonymous type,
222 do not substitute it. */
223 if (type == otype)
224 return 0;
225 else
226 /* Use the last typedef seen as the type for this
227 anonymous type. */
228 type = last;
231 string_file buf;
234 /* Avoid using the current language. If the language is
235 C, and TYPE is a struct/class, the printed type is
236 prefixed with "struct " or "class ", which we don't
237 want when we're expanding a C++ typedef. Print using
238 the type symbol's language to expand a C++ typedef
239 the C++ way even if the current language is C. */
240 const language_defn *lang = language_def (sym->language ());
241 lang->print_type (type, "", &buf, -1, 0, &type_print_raw_options);
243 /* If type_print threw an exception, there is little point
244 in continuing, so just bow out gracefully. */
245 catch (const gdb_exception_error &except)
247 return 0;
250 len = buf.size ();
251 name = obstack_strdup (&info->obstack, buf.string ());
253 /* Turn the result into a new tree. Note that this
254 tree will contain pointers into NAME, so NAME cannot
255 be free'd until all typedef conversion is done and
256 the final result is converted into a string. */
257 i = cp_demangled_name_to_comp (name, NULL);
258 if (i != NULL)
260 /* Merge the two trees. */
261 cp_merge_demangle_parse_infos (info, ret_comp, std::move (i));
263 /* Replace any newly introduced typedefs -- but not
264 if the type is anonymous (that would lead to infinite
265 looping). */
266 if (!is_anon)
267 replace_typedefs (info, ret_comp, finder, data);
269 else
271 /* This shouldn't happen unless the type printer has
272 output something that the name parser cannot grok.
273 Nonetheless, an ounce of prevention...
275 Canonicalize the name again, and store it in the
276 current node (RET_COMP). */
277 gdb::unique_xmalloc_ptr<char> canon
278 = cp_canonicalize_string_no_typedefs (name);
280 if (canon != nullptr)
282 /* Copy the canonicalization into the obstack. */
283 name = copy_string_to_obstack (&info->obstack, canon.get (), &len);
286 ret_comp->u.s_name.s = name;
287 ret_comp->u.s_name.len = len;
290 return 1;
294 return 0;
297 /* Helper for replace_typedefs_qualified_name to handle
298 DEMANGLE_COMPONENT_TEMPLATE. TMPL is the template node. BUF is
299 the buffer that holds the qualified name being built by
300 replace_typedefs_qualified_name. REPL is the node that will be
301 rewritten as a DEMANGLE_COMPONENT_NAME node holding the 'template
302 plus template arguments' name with typedefs replaced. */
304 static bool
305 replace_typedefs_template (struct demangle_parse_info *info,
306 string_file &buf,
307 struct demangle_component *tmpl,
308 struct demangle_component *repl,
309 canonicalization_ftype *finder,
310 void *data)
312 demangle_component *tmpl_arglist = d_right (tmpl);
314 /* Replace typedefs in the template argument list. */
315 replace_typedefs (info, tmpl_arglist, finder, data);
317 /* Convert 'template + replaced template argument list' to a string
318 and replace the REPL node. */
319 gdb::unique_xmalloc_ptr<char> tmpl_str = cp_comp_to_string (tmpl, 100);
320 if (tmpl_str == nullptr)
322 /* If something went astray, abort typedef substitutions. */
323 return false;
325 buf.puts (tmpl_str.get ());
327 repl->type = DEMANGLE_COMPONENT_NAME;
328 repl->u.s_name.s = obstack_strdup (&info->obstack, buf.string ());
329 repl->u.s_name.len = buf.size ();
330 return true;
333 /* Replace any typedefs appearing in the qualified name
334 (DEMANGLE_COMPONENT_QUAL_NAME) represented in RET_COMP for the name parse
335 given in INFO. */
337 static void
338 replace_typedefs_qualified_name (struct demangle_parse_info *info,
339 struct demangle_component *ret_comp,
340 canonicalization_ftype *finder,
341 void *data)
343 string_file buf;
344 struct demangle_component *comp = ret_comp;
346 /* Walk each node of the qualified name, reconstructing the name of
347 this element. With every node, check for any typedef substitutions.
348 If a substitution has occurred, replace the qualified name node
349 with a DEMANGLE_COMPONENT_NAME node representing the new, typedef-
350 substituted name. */
351 while (comp->type == DEMANGLE_COMPONENT_QUAL_NAME)
353 if (d_left (comp)->type == DEMANGLE_COMPONENT_TEMPLATE)
355 /* Convert 'template + replaced template argument list' to a
356 string and replace the top DEMANGLE_COMPONENT_QUAL_NAME
357 node. */
358 if (!replace_typedefs_template (info, buf,
359 d_left (comp), d_left (ret_comp),
360 finder, data))
361 return;
363 buf.clear ();
364 d_right (ret_comp) = d_right (comp);
365 comp = ret_comp;
367 /* Fallback to DEMANGLE_COMPONENT_NAME processing. We want
368 to call inspect_type for this template, in case we have a
369 template alias, like:
370 template<typename T> using alias = base<int, t>;
371 in which case we want inspect_type to do a replacement like:
372 alias<int> -> base<int, int>
376 if (d_left (comp)->type == DEMANGLE_COMPONENT_NAME)
378 struct demangle_component newobj;
380 buf.write (d_left (comp)->u.s_name.s, d_left (comp)->u.s_name.len);
381 newobj.type = DEMANGLE_COMPONENT_NAME;
382 newobj.u.s_name.s = obstack_strdup (&info->obstack, buf.string ());
383 newobj.u.s_name.len = buf.size ();
384 if (inspect_type (info, &newobj, finder, data))
386 char *s;
387 long slen;
389 /* A typedef was substituted in NEW. Convert it to a
390 string and replace the top DEMANGLE_COMPONENT_QUAL_NAME
391 node. */
393 buf.clear ();
394 gdb::unique_xmalloc_ptr<char> n
395 = cp_comp_to_string (&newobj, 100);
396 if (n == NULL)
398 /* If something went astray, abort typedef substitutions. */
399 return;
402 s = copy_string_to_obstack (&info->obstack, n.get (), &slen);
404 d_left (ret_comp)->type = DEMANGLE_COMPONENT_NAME;
405 d_left (ret_comp)->u.s_name.s = s;
406 d_left (ret_comp)->u.s_name.len = slen;
407 d_right (ret_comp) = d_right (comp);
408 comp = ret_comp;
409 continue;
412 else
414 /* The current node is not a name, so simply replace any
415 typedefs in it. Then print it to the stream to continue
416 checking for more typedefs in the tree. */
417 replace_typedefs (info, d_left (comp), finder, data);
418 gdb::unique_xmalloc_ptr<char> name
419 = cp_comp_to_string (d_left (comp), 100);
420 if (name == NULL)
422 /* If something went astray, abort typedef substitutions. */
423 return;
425 buf.puts (name.get ());
428 buf.write ("::", 2);
429 comp = d_right (comp);
432 /* If the next component is DEMANGLE_COMPONENT_TEMPLATE or
433 DEMANGLE_COMPONENT_NAME, save the qualified name assembled above
434 and append the name given by COMP. Then use this reassembled
435 name to check for a typedef. */
437 if (comp->type == DEMANGLE_COMPONENT_TEMPLATE)
439 /* Replace the top (DEMANGLE_COMPONENT_QUAL_NAME) node with a
440 DEMANGLE_COMPONENT_NAME node containing the whole name. */
441 if (!replace_typedefs_template (info, buf, comp, ret_comp, finder, data))
442 return;
443 inspect_type (info, ret_comp, finder, data);
445 else if (comp->type == DEMANGLE_COMPONENT_NAME)
447 buf.write (comp->u.s_name.s, comp->u.s_name.len);
449 /* Replace the top (DEMANGLE_COMPONENT_QUAL_NAME) node
450 with a DEMANGLE_COMPONENT_NAME node containing the whole
451 name. */
452 ret_comp->type = DEMANGLE_COMPONENT_NAME;
453 ret_comp->u.s_name.s = obstack_strdup (&info->obstack, buf.string ());
454 ret_comp->u.s_name.len = buf.size ();
455 inspect_type (info, ret_comp, finder, data);
457 else
458 replace_typedefs (info, comp, finder, data);
462 /* A function to check const and volatile qualifiers for argument types.
464 "Parameter declarations that differ only in the presence
465 or absence of `const' and/or `volatile' are equivalent."
466 C++ Standard N3290, clause 13.1.3 #4. */
468 static void
469 check_cv_qualifiers (struct demangle_component *ret_comp)
471 while (d_left (ret_comp) != NULL
472 && (d_left (ret_comp)->type == DEMANGLE_COMPONENT_CONST
473 || d_left (ret_comp)->type == DEMANGLE_COMPONENT_VOLATILE))
475 d_left (ret_comp) = d_left (d_left (ret_comp));
479 /* Walk the parse tree given by RET_COMP, replacing any typedefs with
480 their basic types. */
482 static void
483 replace_typedefs (struct demangle_parse_info *info,
484 struct demangle_component *ret_comp,
485 canonicalization_ftype *finder,
486 void *data)
488 if (ret_comp)
490 if (finder != NULL
491 && (ret_comp->type == DEMANGLE_COMPONENT_NAME
492 || ret_comp->type == DEMANGLE_COMPONENT_QUAL_NAME
493 || ret_comp->type == DEMANGLE_COMPONENT_TEMPLATE
494 || ret_comp->type == DEMANGLE_COMPONENT_BUILTIN_TYPE))
496 gdb::unique_xmalloc_ptr<char> local_name
497 = cp_comp_to_string (ret_comp, 10);
499 if (local_name != NULL)
501 struct symbol *sym = NULL;
503 sym = NULL;
506 sym = lookup_symbol (local_name.get (), 0,
507 SEARCH_VFT, 0).symbol;
509 catch (const gdb_exception &except)
513 if (sym != NULL)
515 struct type *otype = sym->type ();
516 const char *new_name = (*finder) (otype, data);
518 if (new_name != NULL)
520 ret_comp->type = DEMANGLE_COMPONENT_NAME;
521 ret_comp->u.s_name.s = new_name;
522 ret_comp->u.s_name.len = strlen (new_name);
523 return;
529 switch (ret_comp->type)
531 case DEMANGLE_COMPONENT_ARGLIST:
532 check_cv_qualifiers (ret_comp);
533 [[fallthrough]];
535 case DEMANGLE_COMPONENT_FUNCTION_TYPE:
536 case DEMANGLE_COMPONENT_TEMPLATE:
537 case DEMANGLE_COMPONENT_TEMPLATE_ARGLIST:
538 case DEMANGLE_COMPONENT_TYPED_NAME:
539 replace_typedefs (info, d_left (ret_comp), finder, data);
540 replace_typedefs (info, d_right (ret_comp), finder, data);
541 break;
543 case DEMANGLE_COMPONENT_NAME:
544 inspect_type (info, ret_comp, finder, data);
545 break;
547 case DEMANGLE_COMPONENT_QUAL_NAME:
548 replace_typedefs_qualified_name (info, ret_comp, finder, data);
549 break;
551 case DEMANGLE_COMPONENT_LOCAL_NAME:
552 case DEMANGLE_COMPONENT_CTOR:
553 case DEMANGLE_COMPONENT_ARRAY_TYPE:
554 case DEMANGLE_COMPONENT_PTRMEM_TYPE:
555 replace_typedefs (info, d_right (ret_comp), finder, data);
556 break;
558 case DEMANGLE_COMPONENT_CONST:
559 case DEMANGLE_COMPONENT_RESTRICT:
560 case DEMANGLE_COMPONENT_VOLATILE:
561 case DEMANGLE_COMPONENT_VOLATILE_THIS:
562 case DEMANGLE_COMPONENT_CONST_THIS:
563 case DEMANGLE_COMPONENT_RESTRICT_THIS:
564 case DEMANGLE_COMPONENT_POINTER:
565 case DEMANGLE_COMPONENT_REFERENCE:
566 case DEMANGLE_COMPONENT_RVALUE_REFERENCE:
567 replace_typedefs (info, d_left (ret_comp), finder, data);
568 break;
570 default:
571 break;
576 /* Parse STRING and convert it to canonical form, resolving any
577 typedefs. If parsing fails, or if STRING is already canonical,
578 return nullptr. Otherwise return the canonical form. If
579 FINDER is not NULL, then type components are passed to FINDER to be
580 looked up. DATA is passed verbatim to FINDER. */
582 gdb::unique_xmalloc_ptr<char>
583 cp_canonicalize_string_full (const char *string,
584 canonicalization_ftype *finder,
585 void *data)
587 unsigned int estimated_len;
588 std::unique_ptr<demangle_parse_info> info;
590 estimated_len = strlen (string) * 2;
591 info = cp_demangled_name_to_comp (string, NULL);
592 if (info != NULL)
594 /* Replace all the typedefs in the tree. */
595 replace_typedefs (info.get (), info->tree, finder, data);
597 /* Convert the tree back into a string. */
598 gdb::unique_xmalloc_ptr<char> us = cp_comp_to_string (info->tree,
599 estimated_len);
600 gdb_assert (us);
602 /* Finally, compare the original string with the computed
603 name, returning NULL if they are the same. */
604 if (strcmp (us.get (), string) == 0)
605 return nullptr;
607 return us;
610 return nullptr;
613 /* Like cp_canonicalize_string_full, but always passes NULL for
614 FINDER. */
616 gdb::unique_xmalloc_ptr<char>
617 cp_canonicalize_string_no_typedefs (const char *string)
619 return cp_canonicalize_string_full (string, NULL, NULL);
622 /* Parse STRING and convert it to canonical form. If parsing fails,
623 or if STRING is already canonical, return nullptr.
624 Otherwise return the canonical form. */
626 gdb::unique_xmalloc_ptr<char>
627 cp_canonicalize_string (const char *string)
629 std::unique_ptr<demangle_parse_info> info;
630 unsigned int estimated_len;
632 if (cp_already_canonical (string))
633 return nullptr;
635 info = cp_demangled_name_to_comp (string, NULL);
636 if (info == NULL)
637 return nullptr;
639 estimated_len = strlen (string) * 2;
640 gdb::unique_xmalloc_ptr<char> us (cp_comp_to_string (info->tree,
641 estimated_len));
643 if (!us)
645 warning (_("internal error: string \"%s\" failed to be canonicalized"),
646 string);
647 return nullptr;
650 if (strcmp (us.get (), string) == 0)
651 return nullptr;
653 return us;
656 /* Convert a mangled name to a demangle_component tree. *MEMORY is
657 set to the block of used memory that should be freed when finished
658 with the tree. DEMANGLED_P is set to the char * that should be
659 freed when finished with the tree, or NULL if none was needed.
660 OPTIONS will be passed to the demangler. */
662 static std::unique_ptr<demangle_parse_info>
663 mangled_name_to_comp (const char *mangled_name, int options,
664 void **memory,
665 gdb::unique_xmalloc_ptr<char> *demangled_p)
667 /* If it looks like a v3 mangled name, then try to go directly
668 to trees. */
669 if (mangled_name[0] == '_' && mangled_name[1] == 'Z')
671 struct demangle_component *ret;
673 ret = gdb_cplus_demangle_v3_components (mangled_name,
674 options, memory);
675 if (ret)
677 auto info = std::make_unique<demangle_parse_info> ();
678 info->tree = ret;
679 *demangled_p = NULL;
680 return info;
684 /* If it doesn't, or if that failed, then try to demangle the
685 name. */
686 gdb::unique_xmalloc_ptr<char> demangled_name = gdb_demangle (mangled_name,
687 options);
688 if (demangled_name == NULL)
689 return NULL;
691 /* If we could demangle the name, parse it to build the component
692 tree. */
693 std::unique_ptr<demangle_parse_info> info
694 = cp_demangled_name_to_comp (demangled_name.get (), NULL);
696 if (info == NULL)
697 return NULL;
699 *demangled_p = std::move (demangled_name);
700 return info;
703 /* Return the name of the class containing method PHYSNAME. */
705 char *
706 cp_class_name_from_physname (const char *physname)
708 void *storage = NULL;
709 gdb::unique_xmalloc_ptr<char> demangled_name;
710 gdb::unique_xmalloc_ptr<char> ret;
711 struct demangle_component *ret_comp, *prev_comp, *cur_comp;
712 std::unique_ptr<demangle_parse_info> info;
713 int done;
715 info = mangled_name_to_comp (physname, DMGL_ANSI,
716 &storage, &demangled_name);
717 if (info == NULL)
718 return NULL;
720 done = 0;
721 ret_comp = info->tree;
723 /* First strip off any qualifiers, if we have a function or
724 method. */
725 while (!done)
726 switch (ret_comp->type)
728 case DEMANGLE_COMPONENT_CONST:
729 case DEMANGLE_COMPONENT_RESTRICT:
730 case DEMANGLE_COMPONENT_VOLATILE:
731 case DEMANGLE_COMPONENT_CONST_THIS:
732 case DEMANGLE_COMPONENT_RESTRICT_THIS:
733 case DEMANGLE_COMPONENT_VOLATILE_THIS:
734 case DEMANGLE_COMPONENT_VENDOR_TYPE_QUAL:
735 ret_comp = d_left (ret_comp);
736 break;
737 default:
738 done = 1;
739 break;
742 /* If what we have now is a function, discard the argument list. */
743 if (ret_comp->type == DEMANGLE_COMPONENT_TYPED_NAME)
744 ret_comp = d_left (ret_comp);
746 /* If what we have now is a template, strip off the template
747 arguments. The left subtree may be a qualified name. */
748 if (ret_comp->type == DEMANGLE_COMPONENT_TEMPLATE)
749 ret_comp = d_left (ret_comp);
751 /* What we have now should be a name, possibly qualified.
752 Additional qualifiers could live in the left subtree or the right
753 subtree. Find the last piece. */
754 done = 0;
755 prev_comp = NULL;
756 cur_comp = ret_comp;
757 while (!done)
758 switch (cur_comp->type)
760 case DEMANGLE_COMPONENT_QUAL_NAME:
761 case DEMANGLE_COMPONENT_LOCAL_NAME:
762 prev_comp = cur_comp;
763 cur_comp = d_right (cur_comp);
764 break;
765 case DEMANGLE_COMPONENT_TEMPLATE:
766 case DEMANGLE_COMPONENT_NAME:
767 case DEMANGLE_COMPONENT_CTOR:
768 case DEMANGLE_COMPONENT_DTOR:
769 case DEMANGLE_COMPONENT_OPERATOR:
770 case DEMANGLE_COMPONENT_EXTENDED_OPERATOR:
771 done = 1;
772 break;
773 default:
774 done = 1;
775 cur_comp = NULL;
776 break;
779 if (cur_comp != NULL && prev_comp != NULL)
781 /* We want to discard the rightmost child of PREV_COMP. */
782 *prev_comp = *d_left (prev_comp);
783 /* The ten is completely arbitrary; we don't have a good
784 estimate. */
785 ret = cp_comp_to_string (ret_comp, 10);
788 xfree (storage);
789 return ret.release ();
792 /* Return the child of COMP which is the basename of a method,
793 variable, et cetera. All scope qualifiers are discarded, but
794 template arguments will be included. The component tree may be
795 modified. */
797 static struct demangle_component *
798 unqualified_name_from_comp (struct demangle_component *comp)
800 struct demangle_component *ret_comp = comp, *last_template;
801 int done;
803 done = 0;
804 last_template = NULL;
805 while (!done)
806 switch (ret_comp->type)
808 case DEMANGLE_COMPONENT_QUAL_NAME:
809 case DEMANGLE_COMPONENT_LOCAL_NAME:
810 ret_comp = d_right (ret_comp);
811 break;
812 case DEMANGLE_COMPONENT_TYPED_NAME:
813 ret_comp = d_left (ret_comp);
814 break;
815 case DEMANGLE_COMPONENT_TEMPLATE:
816 gdb_assert (last_template == NULL);
817 last_template = ret_comp;
818 ret_comp = d_left (ret_comp);
819 break;
820 case DEMANGLE_COMPONENT_CONST:
821 case DEMANGLE_COMPONENT_RESTRICT:
822 case DEMANGLE_COMPONENT_VOLATILE:
823 case DEMANGLE_COMPONENT_CONST_THIS:
824 case DEMANGLE_COMPONENT_RESTRICT_THIS:
825 case DEMANGLE_COMPONENT_VOLATILE_THIS:
826 case DEMANGLE_COMPONENT_VENDOR_TYPE_QUAL:
827 ret_comp = d_left (ret_comp);
828 break;
829 case DEMANGLE_COMPONENT_NAME:
830 case DEMANGLE_COMPONENT_CTOR:
831 case DEMANGLE_COMPONENT_DTOR:
832 case DEMANGLE_COMPONENT_OPERATOR:
833 case DEMANGLE_COMPONENT_EXTENDED_OPERATOR:
834 done = 1;
835 break;
836 default:
837 return NULL;
838 break;
841 if (last_template)
843 d_left (last_template) = ret_comp;
844 return last_template;
847 return ret_comp;
850 /* Return the name of the method whose linkage name is PHYSNAME. */
852 char *
853 method_name_from_physname (const char *physname)
855 void *storage = NULL;
856 gdb::unique_xmalloc_ptr<char> demangled_name;
857 gdb::unique_xmalloc_ptr<char> ret;
858 struct demangle_component *ret_comp;
859 std::unique_ptr<demangle_parse_info> info;
861 info = mangled_name_to_comp (physname, DMGL_ANSI,
862 &storage, &demangled_name);
863 if (info == NULL)
864 return NULL;
866 ret_comp = unqualified_name_from_comp (info->tree);
868 if (ret_comp != NULL)
869 /* The ten is completely arbitrary; we don't have a good
870 estimate. */
871 ret = cp_comp_to_string (ret_comp, 10);
873 xfree (storage);
874 return ret.release ();
877 /* If FULL_NAME is the demangled name of a C++ function (including an
878 arg list, possibly including namespace/class qualifications),
879 return a new string containing only the function name (without the
880 arg list/class qualifications). Otherwise, return NULL. */
882 gdb::unique_xmalloc_ptr<char>
883 cp_func_name (const char *full_name)
885 gdb::unique_xmalloc_ptr<char> ret;
886 struct demangle_component *ret_comp;
887 std::unique_ptr<demangle_parse_info> info;
889 info = cp_demangled_name_to_comp (full_name, NULL);
890 if (!info)
891 return nullptr;
893 ret_comp = unqualified_name_from_comp (info->tree);
895 if (ret_comp != NULL)
896 ret = cp_comp_to_string (ret_comp, 10);
898 return ret;
901 /* Helper for cp_remove_params. DEMANGLED_NAME is the name of a
902 function, including parameters and (optionally) a return type.
903 Return the name of the function without parameters or return type,
904 or NULL if we can not parse the name. If REQUIRE_PARAMS is false,
905 then tolerate a non-existing or unbalanced parameter list. */
907 static gdb::unique_xmalloc_ptr<char>
908 cp_remove_params_1 (const char *demangled_name, bool require_params)
910 bool done = false;
911 struct demangle_component *ret_comp;
912 std::unique_ptr<demangle_parse_info> info;
913 gdb::unique_xmalloc_ptr<char> ret;
915 if (demangled_name == NULL)
916 return NULL;
918 info = cp_demangled_name_to_comp (demangled_name, NULL);
919 if (info == NULL)
920 return NULL;
922 /* First strip off any qualifiers, if we have a function or method. */
923 ret_comp = info->tree;
924 while (!done)
925 switch (ret_comp->type)
927 case DEMANGLE_COMPONENT_CONST:
928 case DEMANGLE_COMPONENT_RESTRICT:
929 case DEMANGLE_COMPONENT_VOLATILE:
930 case DEMANGLE_COMPONENT_CONST_THIS:
931 case DEMANGLE_COMPONENT_RESTRICT_THIS:
932 case DEMANGLE_COMPONENT_VOLATILE_THIS:
933 case DEMANGLE_COMPONENT_VENDOR_TYPE_QUAL:
934 ret_comp = d_left (ret_comp);
935 break;
936 default:
937 done = true;
938 break;
941 /* What we have now should be a function. Return its name. */
942 if (ret_comp->type == DEMANGLE_COMPONENT_TYPED_NAME)
943 ret = cp_comp_to_string (d_left (ret_comp), 10);
944 else if (!require_params
945 && (ret_comp->type == DEMANGLE_COMPONENT_NAME
946 || ret_comp->type == DEMANGLE_COMPONENT_QUAL_NAME
947 || ret_comp->type == DEMANGLE_COMPONENT_TEMPLATE))
948 ret = cp_comp_to_string (ret_comp, 10);
950 return ret;
953 /* DEMANGLED_NAME is the name of a function, including parameters and
954 (optionally) a return type. Return the name of the function
955 without parameters or return type, or NULL if we can not parse the
956 name. */
958 gdb::unique_xmalloc_ptr<char>
959 cp_remove_params (const char *demangled_name)
961 return cp_remove_params_1 (demangled_name, true);
964 /* See cp-support.h. */
966 gdb::unique_xmalloc_ptr<char>
967 cp_remove_params_if_any (const char *demangled_name, bool completion_mode)
969 /* Trying to remove parameters from the empty string fails. If
970 we're completing / matching everything, avoid returning NULL
971 which would make callers interpret the result as an error. */
972 if (demangled_name[0] == '\0' && completion_mode)
973 return make_unique_xstrdup ("");
975 gdb::unique_xmalloc_ptr<char> without_params
976 = cp_remove_params_1 (demangled_name, false);
978 if (without_params == NULL && completion_mode)
980 std::string copy = demangled_name;
982 while (!copy.empty ())
984 copy.pop_back ();
985 without_params = cp_remove_params_1 (copy.c_str (), false);
986 if (without_params != NULL)
987 break;
991 return without_params;
994 /* Here are some random pieces of trivia to keep in mind while trying
995 to take apart demangled names:
997 - Names can contain function arguments or templates, so the process
998 has to be, to some extent recursive: maybe keep track of your
999 depth based on encountering <> and ().
1001 - Parentheses don't just have to happen at the end of a name: they
1002 can occur even if the name in question isn't a function, because
1003 a template argument might be a type that's a function.
1005 - Conversely, even if you're trying to deal with a function, its
1006 demangled name might not end with ')': it could be a const or
1007 volatile class method, in which case it ends with "const" or
1008 "volatile".
1010 - Parentheses are also used in anonymous namespaces: a variable
1011 'foo' in an anonymous namespace gets demangled as "(anonymous
1012 namespace)::foo".
1014 - And operator names can contain parentheses or angle brackets. */
1016 /* FIXME: carlton/2003-03-13: We have several functions here with
1017 overlapping functionality; can we combine them? Also, do they
1018 handle all the above considerations correctly? */
1021 /* This returns the length of first component of NAME, which should be
1022 the demangled name of a C++ variable/function/method/etc.
1023 Specifically, it returns the index of the first colon forming the
1024 boundary of the first component: so, given 'A::foo' or 'A::B::foo'
1025 it returns the 1, and given 'foo', it returns 0. */
1027 /* The character in NAME indexed by the return value is guaranteed to
1028 always be either ':' or '\0'. */
1030 /* NOTE: carlton/2003-03-13: This function is currently only intended
1031 for internal use: it's probably not entirely safe when called on
1032 user-generated input, because some of the 'index += 2' lines in
1033 cp_find_first_component_aux might go past the end of malformed
1034 input. */
1036 unsigned int
1037 cp_find_first_component (const char *name)
1039 return cp_find_first_component_aux (name, 0);
1042 /* Helper function for cp_find_first_component. Like that function,
1043 it returns the length of the first component of NAME, but to make
1044 the recursion easier, it also stops if it reaches an unexpected ')'
1045 or '>' if the value of PERMISSIVE is nonzero. */
1047 static unsigned int
1048 cp_find_first_component_aux (const char *name, int permissive)
1050 unsigned int index = 0;
1051 /* Operator names can show up in unexpected places. Since these can
1052 contain parentheses or angle brackets, they can screw up the
1053 recursion. But not every string 'operator' is part of an
1054 operator name: e.g. you could have a variable 'cooperator'. So
1055 this variable tells us whether or not we should treat the string
1056 'operator' as starting an operator. */
1057 int operator_possible = 1;
1059 for (;; ++index)
1061 switch (name[index])
1063 case '<':
1064 /* Template; eat it up. The calls to cp_first_component
1065 should only return (I hope!) when they reach the '>'
1066 terminating the component or a '::' between two
1067 components. (Hence the '+ 2'.) */
1068 index += 1;
1069 for (index += cp_find_first_component_aux (name + index, 1);
1070 name[index] != '>';
1071 index += cp_find_first_component_aux (name + index, 1))
1073 if (name[index] != ':')
1075 demangled_name_complaint (name);
1076 return strlen (name);
1078 index += 2;
1080 operator_possible = 1;
1081 break;
1082 case '(':
1083 /* Similar comment as to '<'. */
1084 index += 1;
1085 for (index += cp_find_first_component_aux (name + index, 1);
1086 name[index] != ')';
1087 index += cp_find_first_component_aux (name + index, 1))
1089 if (name[index] != ':')
1091 demangled_name_complaint (name);
1092 return strlen (name);
1094 index += 2;
1096 operator_possible = 1;
1097 break;
1098 case '>':
1099 case ')':
1100 if (permissive)
1101 return index;
1102 else
1104 demangled_name_complaint (name);
1105 return strlen (name);
1107 case '\0':
1108 return index;
1109 case ':':
1110 /* ':' marks a component iff the next character is also a ':'.
1111 Otherwise it is probably malformed input. */
1112 if (name[index + 1] == ':')
1113 return index;
1114 break;
1115 case 'o':
1116 /* Operator names can screw up the recursion. */
1117 if (operator_possible
1118 && startswith (name + index, CP_OPERATOR_STR))
1120 index += CP_OPERATOR_LEN;
1121 while (ISSPACE(name[index]))
1122 ++index;
1123 switch (name[index])
1125 case '\0':
1126 return index;
1127 /* Skip over one less than the appropriate number of
1128 characters: the for loop will skip over the last
1129 one. */
1130 case '<':
1131 if (name[index + 1] == '<')
1132 index += 1;
1133 else
1134 index += 0;
1135 break;
1136 case '>':
1137 case '-':
1138 if (name[index + 1] == '>')
1139 index += 1;
1140 else
1141 index += 0;
1142 break;
1143 case '(':
1144 index += 1;
1145 break;
1146 default:
1147 index += 0;
1148 break;
1151 operator_possible = 0;
1152 break;
1153 case ' ':
1154 case ',':
1155 case '.':
1156 case '&':
1157 case '*':
1158 /* NOTE: carlton/2003-04-18: I'm not sure what the precise
1159 set of relevant characters are here: it's necessary to
1160 include any character that can show up before 'operator'
1161 in a demangled name, and it's safe to include any
1162 character that can't be part of an identifier's name. */
1163 operator_possible = 1;
1164 break;
1165 default:
1166 operator_possible = 0;
1167 break;
1172 /* Complain about a demangled name that we don't know how to parse.
1173 NAME is the demangled name in question. */
1175 static void
1176 demangled_name_complaint (const char *name)
1178 complaint ("unexpected demangled name '%s'", name);
1181 /* If NAME is the fully-qualified name of a C++
1182 function/variable/method/etc., this returns the length of its
1183 entire prefix: all of the namespaces and classes that make up its
1184 name. Given 'A::foo', it returns 1, given 'A::B::foo', it returns
1185 4, given 'foo', it returns 0. */
1187 unsigned int
1188 cp_entire_prefix_len (const char *name)
1190 unsigned int current_len = cp_find_first_component (name);
1191 unsigned int previous_len = 0;
1193 while (name[current_len] != '\0')
1195 gdb_assert (name[current_len] == ':');
1196 previous_len = current_len;
1197 /* Skip the '::'. */
1198 current_len += 2;
1199 current_len += cp_find_first_component (name + current_len);
1202 return previous_len;
1205 /* Overload resolution functions. */
1207 /* Test to see if SYM is a symbol that we haven't seen corresponding
1208 to a function named OLOAD_NAME. If so, add it to
1209 OVERLOAD_LIST. */
1211 static void
1212 overload_list_add_symbol (struct symbol *sym,
1213 const char *oload_name,
1214 std::vector<symbol *> *overload_list)
1216 /* If there is no type information, we can't do anything, so
1217 skip. */
1218 if (sym->type () == NULL)
1219 return;
1221 /* skip any symbols that we've already considered. */
1222 for (symbol *listed_sym : *overload_list)
1223 if (strcmp (sym->linkage_name (), listed_sym->linkage_name ()) == 0)
1224 return;
1226 /* Get the demangled name without parameters */
1227 gdb::unique_xmalloc_ptr<char> sym_name
1228 = cp_remove_params (sym->natural_name ());
1229 if (!sym_name)
1230 return;
1232 /* skip symbols that cannot match */
1233 if (strcmp (sym_name.get (), oload_name) != 0)
1234 return;
1236 overload_list->push_back (sym);
1239 /* Return a null-terminated list of pointers to function symbols that
1240 are named FUNC_NAME and are visible within NAMESPACE. */
1242 struct std::vector<symbol *>
1243 make_symbol_overload_list (const char *func_name,
1244 const char *the_namespace)
1246 const char *name;
1247 std::vector<symbol *> overload_list;
1249 overload_list.reserve (100);
1251 add_symbol_overload_list_using (func_name, the_namespace, &overload_list);
1253 if (the_namespace[0] == '\0')
1254 name = func_name;
1255 else
1257 char *concatenated_name
1258 = (char *) alloca (strlen (the_namespace) + 2 + strlen (func_name) + 1);
1259 strcpy (concatenated_name, the_namespace);
1260 strcat (concatenated_name, "::");
1261 strcat (concatenated_name, func_name);
1262 name = concatenated_name;
1265 add_symbol_overload_list_qualified (name, &overload_list);
1266 return overload_list;
1269 /* Add all symbols with a name matching NAME in BLOCK to the overload
1270 list. */
1272 static void
1273 add_symbol_overload_list_block (const char *name,
1274 const struct block *block,
1275 std::vector<symbol *> *overload_list)
1277 lookup_name_info lookup_name (name, symbol_name_match_type::FULL);
1279 for (struct symbol *sym : block_iterator_range (block, &lookup_name))
1280 overload_list_add_symbol (sym, name, overload_list);
1283 /* Adds the function FUNC_NAME from NAMESPACE to the overload set. */
1285 static void
1286 add_symbol_overload_list_namespace (const char *func_name,
1287 const char *the_namespace,
1288 std::vector<symbol *> *overload_list)
1290 const char *name;
1291 const struct block *block = NULL;
1293 if (the_namespace[0] == '\0')
1294 name = func_name;
1295 else
1297 char *concatenated_name
1298 = (char *) alloca (strlen (the_namespace) + 2 + strlen (func_name) + 1);
1300 strcpy (concatenated_name, the_namespace);
1301 strcat (concatenated_name, "::");
1302 strcat (concatenated_name, func_name);
1303 name = concatenated_name;
1306 /* Look in the static block. */
1307 block = get_selected_block (0);
1308 block = block == nullptr ? nullptr : block->static_block ();
1309 if (block != nullptr)
1311 add_symbol_overload_list_block (name, block, overload_list);
1313 /* Look in the global block. */
1314 block = block->global_block ();
1315 if (block)
1316 add_symbol_overload_list_block (name, block, overload_list);
1320 /* Search the namespace of the given type and namespace of and public
1321 base types. */
1323 static void
1324 add_symbol_overload_list_adl_namespace (struct type *type,
1325 const char *func_name,
1326 std::vector<symbol *> *overload_list)
1328 char *the_namespace;
1329 const char *type_name;
1330 int i, prefix_len;
1332 while (type->is_pointer_or_reference ()
1333 || type->code () == TYPE_CODE_ARRAY
1334 || type->code () == TYPE_CODE_TYPEDEF)
1336 if (type->code () == TYPE_CODE_TYPEDEF)
1337 type = check_typedef (type);
1338 else
1339 type = type->target_type ();
1342 type_name = type->name ();
1344 if (type_name == NULL)
1345 return;
1347 prefix_len = cp_entire_prefix_len (type_name);
1349 if (prefix_len != 0)
1351 the_namespace = (char *) alloca (prefix_len + 1);
1352 strncpy (the_namespace, type_name, prefix_len);
1353 the_namespace[prefix_len] = '\0';
1355 add_symbol_overload_list_namespace (func_name, the_namespace,
1356 overload_list);
1359 /* Check public base type */
1360 if (type->code () == TYPE_CODE_STRUCT)
1361 for (i = 0; i < TYPE_N_BASECLASSES (type); i++)
1363 if (BASETYPE_VIA_PUBLIC (type, i))
1364 add_symbol_overload_list_adl_namespace (TYPE_BASECLASS (type, i),
1365 func_name,
1366 overload_list);
1370 /* Adds to OVERLOAD_LIST the overload list overload candidates for
1371 FUNC_NAME found through argument dependent lookup. */
1373 void
1374 add_symbol_overload_list_adl (gdb::array_view<type *> arg_types,
1375 const char *func_name,
1376 std::vector<symbol *> *overload_list)
1378 for (type *arg_type : arg_types)
1379 add_symbol_overload_list_adl_namespace (arg_type, func_name,
1380 overload_list);
1383 /* This applies the using directives to add namespaces to search in,
1384 and then searches for overloads in all of those namespaces. It
1385 adds the symbols found to sym_return_val. Arguments are as in
1386 make_symbol_overload_list. */
1388 static void
1389 add_symbol_overload_list_using (const char *func_name,
1390 const char *the_namespace,
1391 std::vector<symbol *> *overload_list)
1393 const struct block *block;
1395 /* First, go through the using directives. If any of them apply,
1396 look in the appropriate namespaces for new functions to match
1397 on. */
1399 for (block = get_selected_block (0);
1400 block != NULL;
1401 block = block->superblock ())
1402 for (using_direct *current : block->get_using ())
1404 /* Prevent recursive calls. */
1405 if (current->searched)
1406 continue;
1408 /* If this is a namespace alias or imported declaration ignore
1409 it. */
1410 if (current->alias != NULL || current->declaration != NULL)
1411 continue;
1413 if (strcmp (the_namespace, current->import_dest) == 0)
1415 /* Mark this import as searched so that the recursive call
1416 does not search it again. */
1417 scoped_restore reset_directive_searched
1418 = make_scoped_restore (&current->searched, 1);
1420 add_symbol_overload_list_using (func_name,
1421 current->import_src,
1422 overload_list);
1426 /* Now, add names for this namespace. */
1427 add_symbol_overload_list_namespace (func_name, the_namespace,
1428 overload_list);
1431 /* This does the bulk of the work of finding overloaded symbols.
1432 FUNC_NAME is the name of the overloaded function we're looking for
1433 (possibly including namespace info). */
1435 static void
1436 add_symbol_overload_list_qualified (const char *func_name,
1437 std::vector<symbol *> *overload_list)
1439 const block *selected_block = get_selected_block (0);
1441 /* Search upwards from currently selected frame (so that we can
1442 complete on local vars. */
1444 for (const block *b = selected_block; b != nullptr; b = b->superblock ())
1445 add_symbol_overload_list_block (func_name, b, overload_list);
1447 const block *surrounding_static_block = (selected_block == nullptr
1448 ? nullptr
1449 : selected_block->static_block ());
1451 /* Go through the symtabs and check the externs and statics for
1452 symbols which match. */
1454 struct objfile *current_objfile = (selected_block
1455 ? selected_block->objfile ()
1456 : nullptr);
1458 gdbarch_iterate_over_objfiles_in_search_order
1459 (current_objfile ? current_objfile->arch () : current_inferior ()->arch (),
1460 [func_name, surrounding_static_block, &overload_list]
1461 (struct objfile *obj)
1463 /* Look through the partial symtabs for all symbols which
1464 begin by matching FUNC_NAME. Make sure we read that
1465 symbol table in. */
1466 obj->expand_symtabs_for_function (func_name);
1468 for (compunit_symtab *cust : obj->compunits ())
1470 QUIT;
1471 const struct block *b = cust->blockvector ()->global_block ();
1472 add_symbol_overload_list_block (func_name, b, overload_list);
1474 b = cust->blockvector ()->static_block ();
1475 /* Don't do this block twice. */
1476 if (b == surrounding_static_block)
1477 continue;
1479 add_symbol_overload_list_block (func_name, b, overload_list);
1482 return 0;
1483 }, current_objfile);
1486 /* Lookup the rtti type for a class name. */
1488 struct type *
1489 cp_lookup_rtti_type (const char *name, const struct block *block)
1491 struct symbol * rtti_sym;
1492 struct type * rtti_type;
1494 rtti_sym = lookup_symbol (name, block,
1495 SEARCH_TYPE_DOMAIN | SEARCH_STRUCT_DOMAIN,
1496 nullptr).symbol;
1498 if (rtti_sym == NULL)
1500 warning (_("RTTI symbol not found for class '%s'"), name);
1501 return NULL;
1504 if (rtti_sym->aclass () != LOC_TYPEDEF)
1506 warning (_("RTTI symbol for class '%s' is not a type"), name);
1507 return NULL;
1510 rtti_type = check_typedef (rtti_sym->type ());
1512 switch (rtti_type->code ())
1514 case TYPE_CODE_STRUCT:
1515 break;
1516 case TYPE_CODE_NAMESPACE:
1517 /* chastain/2003-11-26: the symbol tables often contain fake
1518 symbols for namespaces with the same name as the struct.
1519 This warning is an indication of a bug in the lookup order
1520 or a bug in the way that the symbol tables are populated. */
1521 warning (_("RTTI symbol for class '%s' is a namespace"), name);
1522 return NULL;
1523 default:
1524 warning (_("RTTI symbol for class '%s' has bad type"), name);
1525 return NULL;
1528 return rtti_type;
1531 #ifdef HAVE_WORKING_FORK
1533 /* If true, attempt to catch crashes in the demangler and print
1534 useful debugging information. */
1536 static bool catch_demangler_crashes = true;
1538 /* Stack context and environment for demangler crash recovery. */
1540 static thread_local SIGJMP_BUF *gdb_demangle_jmp_buf;
1542 /* If true, attempt to dump core from the signal handler. */
1544 static std::atomic<bool> gdb_demangle_attempt_core_dump;
1546 /* Signal handler for gdb_demangle. */
1548 static void
1549 gdb_demangle_signal_handler (int signo)
1551 if (gdb_demangle_attempt_core_dump)
1553 if (fork () == 0)
1554 dump_core ();
1556 gdb_demangle_attempt_core_dump = false;
1559 SIGLONGJMP (*gdb_demangle_jmp_buf, signo);
1562 /* A helper for gdb_demangle that reports a demangling failure. */
1564 static void
1565 report_failed_demangle (const char *name, bool core_dump_allowed,
1566 int crash_signal)
1568 static bool error_reported = false;
1570 if (!error_reported)
1572 std::string short_msg
1573 = string_printf (_("unable to demangle '%s' "
1574 "(demangler failed with signal %d)"),
1575 name, crash_signal);
1577 std::string long_msg
1578 = string_printf ("%s:%d: %s: %s", __FILE__, __LINE__,
1579 "demangler-warning", short_msg.c_str ());
1581 target_terminal::scoped_restore_terminal_state term_state;
1582 target_terminal::ours_for_output ();
1584 begin_line ();
1585 if (core_dump_allowed)
1586 gdb_printf (gdb_stderr,
1587 _("%s\nAttempting to dump core.\n"),
1588 long_msg.c_str ());
1589 else
1590 warn_cant_dump_core (long_msg.c_str ());
1592 demangler_warning (__FILE__, __LINE__, "%s", short_msg.c_str ());
1594 error_reported = true;
1598 #endif
1600 /* A wrapper for bfd_demangle. */
1602 gdb::unique_xmalloc_ptr<char>
1603 gdb_demangle (const char *name, int options)
1605 gdb::unique_xmalloc_ptr<char> result;
1606 int crash_signal = 0;
1608 #ifdef HAVE_WORKING_FORK
1609 scoped_segv_handler_restore restore_segv
1610 (catch_demangler_crashes
1611 ? gdb_demangle_signal_handler
1612 : nullptr);
1614 bool core_dump_allowed = gdb_demangle_attempt_core_dump;
1615 SIGJMP_BUF jmp_buf;
1616 scoped_restore restore_jmp_buf
1617 = make_scoped_restore (&gdb_demangle_jmp_buf, &jmp_buf);
1618 if (catch_demangler_crashes)
1620 /* The signal handler may keep the signal blocked when we longjmp out
1621 of it. If we have sigprocmask, we can use it to unblock the signal
1622 afterwards and we can avoid the performance overhead of saving the
1623 signal mask just in case the signal gets triggered. Otherwise, just
1624 tell sigsetjmp to save the mask. */
1625 #ifdef HAVE_SIGPROCMASK
1626 crash_signal = SIGSETJMP (*gdb_demangle_jmp_buf, 0);
1627 #else
1628 crash_signal = SIGSETJMP (*gdb_demangle_jmp_buf, 1);
1629 #endif
1631 #endif
1633 if (crash_signal == 0)
1634 result.reset (bfd_demangle (NULL, name, options | DMGL_VERBOSE));
1636 #ifdef HAVE_WORKING_FORK
1637 if (catch_demangler_crashes)
1639 if (crash_signal != 0)
1641 #ifdef HAVE_SIGPROCMASK
1642 /* If we got the signal, SIGSEGV may still be blocked; restore it. */
1643 sigset_t segv_sig_set;
1644 sigemptyset (&segv_sig_set);
1645 sigaddset (&segv_sig_set, SIGSEGV);
1646 gdb_sigmask (SIG_UNBLOCK, &segv_sig_set, NULL);
1647 #endif
1649 /* If there was a failure, we can't report it here, because
1650 we might be in a background thread. Instead, arrange for
1651 the reporting to happen on the main thread. */
1652 std::string copy = name;
1653 run_on_main_thread ([=, copy = std::move (copy)] ()
1655 report_failed_demangle (copy.c_str (), core_dump_allowed,
1656 crash_signal);
1659 result = NULL;
1662 #endif
1664 return result;
1667 /* See cp-support.h. */
1669 char *
1670 gdb_cplus_demangle_print (int options,
1671 struct demangle_component *tree,
1672 int estimated_length,
1673 size_t *p_allocated_size)
1675 return cplus_demangle_print (options | DMGL_VERBOSE, tree,
1676 estimated_length, p_allocated_size);
1679 /* A wrapper for cplus_demangle_v3_components that forces
1680 DMGL_VERBOSE. */
1682 static struct demangle_component *
1683 gdb_cplus_demangle_v3_components (const char *mangled,
1684 int options, void **mem)
1686 return cplus_demangle_v3_components (mangled, options | DMGL_VERBOSE, mem);
1689 /* See cp-support.h. */
1691 unsigned int
1692 cp_search_name_hash (const char *search_name)
1694 /* cp_entire_prefix_len assumes a fully-qualified name with no
1695 leading "::". */
1696 if (startswith (search_name, "::"))
1697 search_name += 2;
1699 unsigned int prefix_len = cp_entire_prefix_len (search_name);
1700 if (prefix_len != 0)
1701 search_name += prefix_len + 2;
1703 unsigned int hash = 0;
1704 for (const char *string = search_name; *string != '\0'; ++string)
1706 const char *before_skip = string;
1707 string = skip_spaces (string);
1709 if (*string == '(')
1710 break;
1712 /* Could it be the beginning of a function name?
1713 If yes, does it begin with the keyword "operator"? */
1714 if ((string != before_skip || string == search_name)
1715 && (string[0] == 'o' && startswith (string, CP_OPERATOR_STR)))
1717 /* Hash the "operator" part. */
1718 for (size_t i = 0; i < CP_OPERATOR_LEN; ++i)
1719 hash = SYMBOL_HASH_NEXT (hash, *string++);
1721 string = skip_spaces (string);
1723 /* If no more data to process, stop right now. This is specially
1724 intended for SEARCH_NAMEs that end with "operator". In such
1725 cases, the whole string is processed and STRING is pointing to a
1726 null-byte. Letting the loop body resume naturally would lead to
1727 a "++string" that causes STRING to point past the null-byte. */
1728 if (string[0] == '\0')
1729 break;
1731 /* "<" and "<<" are sequences of interest here. This covers
1732 "operator{<,<<,<=,<=>}". In the last 2 cases, the "=" and "=>"
1733 parts are handled by the next iterations of the loop like other
1734 input chars. The goal is to process all the operator-related '<'
1735 chars, so that later if a '<' is visited it can be inferred for
1736 sure that it is the beginning of a template parameter list.
1738 STRING is a null-byte terminated string. If string[0] is not
1739 a null-byte, according to the previous check, string[1] is not
1740 past the end of the allocation and can be referenced safely. */
1741 if (string[0] == '<')
1743 hash = SYMBOL_HASH_NEXT (hash, *string);
1744 if (string[1] == '<')
1745 hash = SYMBOL_HASH_NEXT (hash, *++string);
1746 continue;
1750 /* Ignore ABI tags such as "[abi:cxx11]. */
1751 if (*string == '['
1752 && startswith (string + 1, "abi:")
1753 && string[5] != ':')
1754 break;
1756 /* Ignore template parameter lists. The likely "operator{<,<<,<=,<=>}"
1757 are already taken care of. Therefore, any encounter of '<' character
1758 at this point is related to template lists. */
1759 if (*string == '<')
1760 break;
1762 hash = SYMBOL_HASH_NEXT (hash, *string);
1764 return hash;
1767 #if GDB_SELF_TEST
1769 namespace selftests {
1771 static void
1772 test_cp_search_name_hash ()
1774 SELF_CHECK (cp_search_name_hash ("void func<(enum_test)0>(int*, int)")
1775 == cp_search_name_hash ("void func"));
1776 SELF_CHECK (cp_search_name_hash ("operator")
1777 != cp_search_name_hash ("operator<"));
1778 SELF_CHECK (cp_search_name_hash ("operator")
1779 != cp_search_name_hash ("operator<<"));
1780 SELF_CHECK (cp_search_name_hash ("operator<")
1781 != cp_search_name_hash ("operator<<"));
1782 SELF_CHECK (cp_search_name_hash ("operator<")
1783 == cp_search_name_hash ("operator <"));
1784 SELF_CHECK (cp_search_name_hash ("operator")
1785 != cp_search_name_hash ("foo_operator"));
1786 SELF_CHECK (cp_search_name_hash ("operator")
1787 != cp_search_name_hash ("operator_foo"));
1788 SELF_CHECK (cp_search_name_hash ("operator<")
1789 != cp_search_name_hash ("foo_operator"));
1790 SELF_CHECK (cp_search_name_hash ("operator<")
1791 != cp_search_name_hash ("operator_foo"));
1792 SELF_CHECK (cp_search_name_hash ("operator<<")
1793 != cp_search_name_hash ("foo_operator"));
1794 SELF_CHECK (cp_search_name_hash ("operator<<")
1795 != cp_search_name_hash ("operator_foo"));
1797 SELF_CHECK (cp_search_name_hash ("func")
1798 == cp_search_name_hash ("func[abi:cxx11]"));
1801 } /* namespace selftests */
1803 #endif /* GDB_SELF_TEST */
1805 /* Helper for cp_symbol_name_matches (i.e., symbol_name_matcher_ftype
1806 implementation for symbol_name_match_type::WILD matching). Split
1807 to a separate function for unit-testing convenience.
1809 If SYMBOL_SEARCH_NAME has more scopes than LOOKUP_NAME, we try to
1810 match ignoring the extra leading scopes of SYMBOL_SEARCH_NAME.
1811 This allows conveniently setting breakpoints on functions/methods
1812 inside any namespace/class without specifying the fully-qualified
1813 name.
1815 E.g., these match:
1817 [symbol search name] [lookup name]
1818 foo::bar::func foo::bar::func
1819 foo::bar::func bar::func
1820 foo::bar::func func
1822 While these don't:
1824 [symbol search name] [lookup name]
1825 foo::zbar::func bar::func
1826 foo::bar::func foo::func
1828 See more examples in the test_cp_symbol_name_matches selftest
1829 function below.
1831 See symbol_name_matcher_ftype for description of SYMBOL_SEARCH_NAME
1832 and COMP_MATCH_RES.
1834 LOOKUP_NAME/LOOKUP_NAME_LEN is the name we're looking up.
1836 See strncmp_iw_with_mode for description of MODE.
1839 static bool
1840 cp_symbol_name_matches_1 (const char *symbol_search_name,
1841 const char *lookup_name,
1842 size_t lookup_name_len,
1843 strncmp_iw_mode mode,
1844 completion_match_result *comp_match_res)
1846 const char *sname = symbol_search_name;
1847 completion_match_for_lcd *match_for_lcd
1848 = (comp_match_res != NULL ? &comp_match_res->match_for_lcd : NULL);
1850 gdb_assert (match_for_lcd == nullptr || match_for_lcd->empty ());
1852 while (true)
1854 if (strncmp_iw_with_mode (sname, lookup_name, lookup_name_len,
1855 mode, language_cplus, match_for_lcd, true) == 0)
1857 if (comp_match_res != NULL)
1859 /* Note here we set different MATCH and MATCH_FOR_LCD
1860 strings. This is because with
1862 (gdb) b push_bac[TAB]
1864 we want the completion matches to list
1866 std::vector<int>::push_back(...)
1867 std::vector<char>::push_back(...)
1869 etc., which are SYMBOL_SEARCH_NAMEs, while we want
1870 the input line to auto-complete to
1872 (gdb) push_back(...)
1874 which is SNAME, not to
1876 (gdb) std::vector<
1878 which would be the regular common prefix between all
1879 the matches otherwise. */
1880 comp_match_res->set_match (symbol_search_name, sname);
1882 return true;
1885 /* Clear match_for_lcd so the next strncmp_iw_with_mode call starts
1886 from scratch. */
1887 if (match_for_lcd != nullptr)
1888 match_for_lcd->clear ();
1890 unsigned int len = cp_find_first_component (sname);
1892 if (sname[len] == '\0')
1893 return false;
1895 gdb_assert (sname[len] == ':');
1896 /* Skip the '::'. */
1897 sname += len + 2;
1901 /* C++ symbol_name_matcher_ftype implementation. */
1903 static bool
1904 cp_fq_symbol_name_matches (const char *symbol_search_name,
1905 const lookup_name_info &lookup_name,
1906 completion_match_result *comp_match_res)
1908 /* Get the demangled name. */
1909 const std::string &name = lookup_name.cplus ().lookup_name ();
1910 completion_match_for_lcd *match_for_lcd
1911 = (comp_match_res != NULL ? &comp_match_res->match_for_lcd : NULL);
1912 strncmp_iw_mode mode = (lookup_name.completion_mode ()
1913 ? strncmp_iw_mode::NORMAL
1914 : strncmp_iw_mode::MATCH_PARAMS);
1916 if (strncmp_iw_with_mode (symbol_search_name,
1917 name.c_str (), name.size (),
1918 mode, language_cplus, match_for_lcd) == 0)
1920 if (comp_match_res != NULL)
1921 comp_match_res->set_match (symbol_search_name);
1922 return true;
1925 return false;
1928 /* C++ symbol_name_matcher_ftype implementation for wild matches.
1929 Defers work to cp_symbol_name_matches_1. */
1931 static bool
1932 cp_symbol_name_matches (const char *symbol_search_name,
1933 const lookup_name_info &lookup_name,
1934 completion_match_result *comp_match_res)
1936 /* Get the demangled name. */
1937 const std::string &name = lookup_name.cplus ().lookup_name ();
1939 strncmp_iw_mode mode = (lookup_name.completion_mode ()
1940 ? strncmp_iw_mode::NORMAL
1941 : strncmp_iw_mode::MATCH_PARAMS);
1943 return cp_symbol_name_matches_1 (symbol_search_name,
1944 name.c_str (), name.size (),
1945 mode, comp_match_res);
1948 /* See cp-support.h. */
1950 symbol_name_matcher_ftype *
1951 cp_get_symbol_name_matcher (const lookup_name_info &lookup_name)
1953 switch (lookup_name.match_type ())
1955 case symbol_name_match_type::FULL:
1956 case symbol_name_match_type::EXPRESSION:
1957 case symbol_name_match_type::SEARCH_NAME:
1958 return cp_fq_symbol_name_matches;
1959 case symbol_name_match_type::WILD:
1960 return cp_symbol_name_matches;
1963 gdb_assert_not_reached ("");
1966 #if GDB_SELF_TEST
1968 namespace selftests {
1970 static void
1971 test_cp_symbol_name_matches ()
1973 #define CHECK_MATCH(SYMBOL, INPUT) \
1974 SELF_CHECK (cp_symbol_name_matches_1 (SYMBOL, \
1975 INPUT, sizeof (INPUT) - 1, \
1976 strncmp_iw_mode::MATCH_PARAMS, \
1977 NULL))
1979 #define CHECK_NOT_MATCH(SYMBOL, INPUT) \
1980 SELF_CHECK (!cp_symbol_name_matches_1 (SYMBOL, \
1981 INPUT, sizeof (INPUT) - 1, \
1982 strncmp_iw_mode::MATCH_PARAMS, \
1983 NULL))
1985 /* Like CHECK_MATCH, and also check that INPUT (and all substrings
1986 that start at index 0) completes to SYMBOL. */
1987 #define CHECK_MATCH_C(SYMBOL, INPUT) \
1988 do \
1990 CHECK_MATCH (SYMBOL, INPUT); \
1991 for (size_t i = 0; i < sizeof (INPUT) - 1; i++) \
1992 SELF_CHECK (cp_symbol_name_matches_1 (SYMBOL, INPUT, i, \
1993 strncmp_iw_mode::NORMAL, \
1994 NULL)); \
1995 } while (0)
1997 /* Like CHECK_NOT_MATCH, and also check that INPUT does NOT complete
1998 to SYMBOL. */
1999 #define CHECK_NOT_MATCH_C(SYMBOL, INPUT) \
2000 do \
2002 CHECK_NOT_MATCH (SYMBOL, INPUT); \
2003 SELF_CHECK (!cp_symbol_name_matches_1 (SYMBOL, INPUT, \
2004 sizeof (INPUT) - 1, \
2005 strncmp_iw_mode::NORMAL, \
2006 NULL)); \
2007 } while (0)
2009 /* Lookup name without parens matches all overloads. */
2010 CHECK_MATCH_C ("function()", "function");
2011 CHECK_MATCH_C ("function(int)", "function");
2013 /* Check whitespace around parameters is ignored. */
2014 CHECK_MATCH_C ("function()", "function ()");
2015 CHECK_MATCH_C ("function ( )", "function()");
2016 CHECK_MATCH_C ("function ()", "function( )");
2017 CHECK_MATCH_C ("func(int)", "func( int )");
2018 CHECK_MATCH_C ("func(int)", "func ( int ) ");
2019 CHECK_MATCH_C ("func ( int )", "func( int )");
2020 CHECK_MATCH_C ("func ( int )", "func ( int ) ");
2022 /* Check symbol name prefixes aren't incorrectly matched. */
2023 CHECK_NOT_MATCH ("func", "function");
2024 CHECK_NOT_MATCH ("function", "func");
2025 CHECK_NOT_MATCH ("function()", "func");
2027 /* Check that if the lookup name includes parameters, only the right
2028 overload matches. */
2029 CHECK_MATCH_C ("function(int)", "function(int)");
2030 CHECK_NOT_MATCH_C ("function(int)", "function()");
2032 /* Check that whitespace within symbol names is not ignored. */
2033 CHECK_NOT_MATCH_C ("function", "func tion");
2034 CHECK_NOT_MATCH_C ("func__tion", "func_ _tion");
2035 CHECK_NOT_MATCH_C ("func11tion", "func1 1tion");
2037 /* Check the converse, which can happen with template function,
2038 where the return type is part of the demangled name. */
2039 CHECK_NOT_MATCH_C ("func tion", "function");
2040 CHECK_NOT_MATCH_C ("func1 1tion", "func11tion");
2041 CHECK_NOT_MATCH_C ("func_ _tion", "func__tion");
2043 /* Within parameters too. */
2044 CHECK_NOT_MATCH_C ("func(param)", "func(par am)");
2046 /* Check handling of whitespace around C++ operators. */
2047 CHECK_NOT_MATCH_C ("operator<<", "opera tor<<");
2048 CHECK_NOT_MATCH_C ("operator<<", "operator< <");
2049 CHECK_NOT_MATCH_C ("operator<<", "operator < <");
2050 CHECK_NOT_MATCH_C ("operator==", "operator= =");
2051 CHECK_NOT_MATCH_C ("operator==", "operator = =");
2052 CHECK_MATCH_C ("operator<<", "operator <<");
2053 CHECK_MATCH_C ("operator<<()", "operator <<");
2054 CHECK_NOT_MATCH_C ("operator<<()", "operator<<(int)");
2055 CHECK_NOT_MATCH_C ("operator<<(int)", "operator<<()");
2056 CHECK_MATCH_C ("operator==", "operator ==");
2057 CHECK_MATCH_C ("operator==()", "operator ==");
2058 CHECK_MATCH_C ("operator <<", "operator<<");
2059 CHECK_MATCH_C ("operator ==", "operator==");
2060 CHECK_MATCH_C ("operator bool", "operator bool");
2061 CHECK_MATCH_C ("operator bool ()", "operator bool");
2062 CHECK_MATCH_C ("operatorX<<", "operatorX < <");
2063 CHECK_MATCH_C ("Xoperator<<", "Xoperator < <");
2065 CHECK_MATCH_C ("operator()(int)", "operator()(int)");
2066 CHECK_MATCH_C ("operator()(int)", "operator ( ) ( int )");
2067 CHECK_MATCH_C ("operator()<long>(int)", "operator ( ) < long > ( int )");
2068 /* The first "()" is not the parameter list. */
2069 CHECK_NOT_MATCH ("operator()(int)", "operator");
2071 /* Misc user-defined operator tests. */
2073 CHECK_NOT_MATCH_C ("operator/=()", "operator ^=");
2074 /* Same length at end of input. */
2075 CHECK_NOT_MATCH_C ("operator>>", "operator[]");
2076 /* Same length but not at end of input. */
2077 CHECK_NOT_MATCH_C ("operator>>()", "operator[]()");
2079 CHECK_MATCH_C ("base::operator char*()", "base::operator char*()");
2080 CHECK_MATCH_C ("base::operator char*()", "base::operator char * ()");
2081 CHECK_MATCH_C ("base::operator char**()", "base::operator char * * ()");
2082 CHECK_MATCH ("base::operator char**()", "base::operator char * *");
2083 CHECK_MATCH_C ("base::operator*()", "base::operator*()");
2084 CHECK_NOT_MATCH_C ("base::operator char*()", "base::operatorc");
2085 CHECK_NOT_MATCH ("base::operator char*()", "base::operator char");
2086 CHECK_NOT_MATCH ("base::operator char*()", "base::operat");
2088 /* Check handling of whitespace around C++ scope operators. */
2089 CHECK_NOT_MATCH_C ("foo::bar", "foo: :bar");
2090 CHECK_MATCH_C ("foo::bar", "foo :: bar");
2091 CHECK_MATCH_C ("foo :: bar", "foo::bar");
2093 CHECK_MATCH_C ("abc::def::ghi()", "abc::def::ghi()");
2094 CHECK_MATCH_C ("abc::def::ghi ( )", "abc::def::ghi()");
2095 CHECK_MATCH_C ("abc::def::ghi()", "abc::def::ghi ( )");
2096 CHECK_MATCH_C ("function()", "function()");
2097 CHECK_MATCH_C ("bar::function()", "bar::function()");
2099 /* Wild matching tests follow. */
2101 /* Tests matching symbols in some scope. */
2102 CHECK_MATCH_C ("foo::function()", "function");
2103 CHECK_MATCH_C ("foo::function(int)", "function");
2104 CHECK_MATCH_C ("foo::bar::function()", "function");
2105 CHECK_MATCH_C ("bar::function()", "bar::function");
2106 CHECK_MATCH_C ("foo::bar::function()", "bar::function");
2107 CHECK_MATCH_C ("foo::bar::function(int)", "bar::function");
2109 /* Same, with parameters in the lookup name. */
2110 CHECK_MATCH_C ("foo::function()", "function()");
2111 CHECK_MATCH_C ("foo::bar::function()", "function()");
2112 CHECK_MATCH_C ("foo::function(int)", "function(int)");
2113 CHECK_MATCH_C ("foo::function()", "foo::function()");
2114 CHECK_MATCH_C ("foo::bar::function()", "bar::function()");
2115 CHECK_MATCH_C ("foo::bar::function(int)", "bar::function(int)");
2116 CHECK_MATCH_C ("bar::function()", "bar::function()");
2118 CHECK_NOT_MATCH_C ("foo::bar::function(int)", "bar::function()");
2120 CHECK_MATCH_C ("(anonymous namespace)::bar::function(int)",
2121 "bar::function(int)");
2122 CHECK_MATCH_C ("foo::(anonymous namespace)::bar::function(int)",
2123 "function(int)");
2125 /* Lookup scope wider than symbol scope, should not match. */
2126 CHECK_NOT_MATCH_C ("function()", "bar::function");
2127 CHECK_NOT_MATCH_C ("function()", "bar::function()");
2129 /* Explicit global scope doesn't match. */
2130 CHECK_NOT_MATCH_C ("foo::function()", "::function");
2131 CHECK_NOT_MATCH_C ("foo::function()", "::function()");
2132 CHECK_NOT_MATCH_C ("foo::function(int)", "::function()");
2133 CHECK_NOT_MATCH_C ("foo::function(int)", "::function(int)");
2135 /* Test ABI tag matching/ignoring. */
2137 /* If the symbol name has an ABI tag, but the lookup name doesn't,
2138 then the ABI tag in the symbol name is ignored. */
2139 CHECK_MATCH_C ("function[abi:foo]()", "function");
2140 CHECK_MATCH_C ("function[abi:foo](int)", "function");
2141 CHECK_MATCH_C ("function[abi:foo]()", "function ()");
2142 CHECK_NOT_MATCH_C ("function[abi:foo]()", "function (int)");
2144 CHECK_MATCH_C ("function[abi:foo]()", "function[abi:foo]");
2145 CHECK_MATCH_C ("function[abi:foo](int)", "function[abi:foo]");
2146 CHECK_MATCH_C ("function[abi:foo]()", "function[abi:foo] ()");
2147 CHECK_MATCH_C ("function[abi:foo][abi:bar]()", "function");
2148 CHECK_MATCH_C ("function[abi:foo][abi:bar](int)", "function");
2149 CHECK_MATCH_C ("function[abi:foo][abi:bar]()", "function[abi:foo]");
2150 CHECK_MATCH_C ("function[abi:foo][abi:bar](int)", "function[abi:foo]");
2151 CHECK_MATCH_C ("function[abi:foo][abi:bar]()", "function[abi:foo] ()");
2152 CHECK_NOT_MATCH_C ("function[abi:foo][abi:bar]()", "function[abi:foo] (int)");
2154 CHECK_MATCH_C ("function [abi:foo][abi:bar] ( )", "function [abi:foo]");
2156 /* If the symbol name does not have an ABI tag, while the lookup
2157 name has one, then there's no match. */
2158 CHECK_NOT_MATCH_C ("function()", "function[abi:foo]()");
2159 CHECK_NOT_MATCH_C ("function()", "function[abi:foo]");
2162 /* If non-NULL, return STR wrapped in quotes. Otherwise, return a
2163 "<null>" string (with no quotes). */
2165 static std::string
2166 quote (const char *str)
2168 if (str != NULL)
2169 return std::string (1, '"') + str + '"';
2170 else
2171 return "<null>";
2174 /* Check that removing parameter info out of NAME produces EXPECTED.
2175 COMPLETION_MODE indicates whether we're testing normal and
2176 completion mode. FILE and LINE are used to provide better test
2177 location information in case the check fails. */
2179 static void
2180 check_remove_params (const char *file, int line,
2181 const char *name, const char *expected,
2182 bool completion_mode)
2184 gdb::unique_xmalloc_ptr<char> result
2185 = cp_remove_params_if_any (name, completion_mode);
2187 if ((expected == NULL) != (result == NULL)
2188 || (expected != NULL
2189 && strcmp (result.get (), expected) != 0))
2191 error (_("%s:%d: make-paramless self-test failed: (completion=%d) "
2192 "\"%s\" -> %s, expected %s"),
2193 file, line, completion_mode, name,
2194 quote (result.get ()).c_str (), quote (expected).c_str ());
2198 /* Entry point for cp_remove_params unit tests. */
2200 static void
2201 test_cp_remove_params ()
2203 /* Check that removing parameter info out of NAME produces EXPECTED.
2204 Checks both normal and completion modes. */
2205 #define CHECK(NAME, EXPECTED) \
2206 do \
2208 check_remove_params (__FILE__, __LINE__, NAME, EXPECTED, false); \
2209 check_remove_params (__FILE__, __LINE__, NAME, EXPECTED, true); \
2211 while (0)
2213 /* Similar, but used when NAME is incomplete -- i.e., is has
2214 unbalanced parentheses. In this case, looking for the exact name
2215 should fail / return empty. */
2216 #define CHECK_INCOMPL(NAME, EXPECTED) \
2217 do \
2219 check_remove_params (__FILE__, __LINE__, NAME, NULL, false); \
2220 check_remove_params (__FILE__, __LINE__, NAME, EXPECTED, true); \
2222 while (0)
2224 CHECK ("function()", "function");
2225 CHECK_INCOMPL ("function(", "function");
2226 CHECK ("function() const", "function");
2228 CHECK ("(anonymous namespace)::A::B::C",
2229 "(anonymous namespace)::A::B::C");
2231 CHECK ("A::(anonymous namespace)",
2232 "A::(anonymous namespace)");
2234 CHECK_INCOMPL ("A::(anonymou", "A");
2236 CHECK ("A::foo<int>()",
2237 "A::foo<int>");
2239 CHECK_INCOMPL ("A::foo<int>(",
2240 "A::foo<int>");
2242 CHECK ("A::foo<(anonymous namespace)::B>::func(int)",
2243 "A::foo<(anonymous namespace)::B>::func");
2245 CHECK_INCOMPL ("A::foo<(anonymous namespace)::B>::func(in",
2246 "A::foo<(anonymous namespace)::B>::func");
2248 CHECK_INCOMPL ("A::foo<(anonymous namespace)::B>::",
2249 "A::foo<(anonymous namespace)::B>");
2251 CHECK_INCOMPL ("A::foo<(anonymous namespace)::B>:",
2252 "A::foo<(anonymous namespace)::B>");
2254 CHECK ("A::foo<(anonymous namespace)::B>",
2255 "A::foo<(anonymous namespace)::B>");
2257 CHECK_INCOMPL ("A::foo<(anonymous namespace)::B",
2258 "A::foo");
2260 CHECK ("A::foo<void(int)>::func(int)",
2261 "A::foo<void(int)>::func");
2263 CHECK_INCOMPL ("A::foo<void(int",
2264 "A::foo");
2266 #undef CHECK
2267 #undef CHECK_INCOMPL
2270 } // namespace selftests
2272 #endif /* GDB_SELF_CHECK */
2274 /* This is a front end for cp_find_first_component, for unit testing.
2275 Be careful when using it: see the NOTE above
2276 cp_find_first_component. */
2278 static void
2279 first_component_command (const char *arg, int from_tty)
2281 if (!arg)
2282 return;
2284 int len = cp_find_first_component (arg);
2285 gdb_printf ("%.*s\n", len, arg);
2288 /* Implement "info vtbl". */
2290 static void
2291 info_vtbl_command (const char *arg, int from_tty)
2293 struct value *value;
2295 value = parse_and_eval (arg);
2296 cplus_print_vtable (value);
2299 /* See description in cp-support.h. */
2301 const char *
2302 find_toplevel_char (const char *s, char c)
2304 int quoted = 0; /* zero if we're not in quotes;
2305 '"' if we're in a double-quoted string;
2306 '\'' if we're in a single-quoted string. */
2307 int depth = 0; /* Number of unclosed parens we've seen. */
2308 const char *scan;
2310 for (scan = s; *scan; scan++)
2312 if (quoted)
2314 if (*scan == quoted)
2315 quoted = 0;
2316 else if (*scan == '\\' && *(scan + 1))
2317 scan++;
2319 else if (*scan == c && ! quoted && depth == 0)
2320 return scan;
2321 else if (*scan == '"' || *scan == '\'')
2322 quoted = *scan;
2323 else if (*scan == '(' || *scan == '<')
2324 depth++;
2325 else if ((*scan == ')' || *scan == '>') && depth > 0)
2326 depth--;
2327 else if (*scan == 'o' && !quoted && depth == 0)
2329 /* Handle C++ operator names. */
2330 if (strncmp (scan, CP_OPERATOR_STR, CP_OPERATOR_LEN) == 0)
2332 scan += CP_OPERATOR_LEN;
2333 if (*scan == c)
2334 return scan;
2335 while (ISSPACE (*scan))
2337 ++scan;
2338 if (*scan == c)
2339 return scan;
2341 if (*scan == '\0')
2342 break;
2344 switch (*scan)
2346 /* Skip over one less than the appropriate number of
2347 characters: the for loop will skip over the last
2348 one. */
2349 case '<':
2350 if (scan[1] == '<')
2352 scan++;
2353 if (*scan == c)
2354 return scan;
2356 break;
2357 case '>':
2358 if (scan[1] == '>')
2360 scan++;
2361 if (*scan == c)
2362 return scan;
2364 break;
2370 return 0;
2373 void _initialize_cp_support ();
2374 void
2375 _initialize_cp_support ()
2377 cmd_list_element *maintenance_cplus
2378 = add_basic_prefix_cmd ("cplus", class_maintenance,
2379 _("C++ maintenance commands."),
2380 &maint_cplus_cmd_list,
2381 0, &maintenancelist);
2382 add_alias_cmd ("cp", maintenance_cplus, class_maintenance, 1,
2383 &maintenancelist);
2385 add_cmd ("first_component",
2386 class_maintenance,
2387 first_component_command,
2388 _("Print the first class/namespace component of NAME."),
2389 &maint_cplus_cmd_list);
2391 add_info ("vtbl", info_vtbl_command,
2392 _("Show the virtual function table for a C++ object.\n\
2393 Usage: info vtbl EXPRESSION\n\
2394 Evaluate EXPRESSION and display the virtual function table for the\n\
2395 resulting object."));
2397 #ifdef HAVE_WORKING_FORK
2398 add_setshow_boolean_cmd ("catch-demangler-crashes", class_maintenance,
2399 &catch_demangler_crashes, _("\
2400 Set whether to attempt to catch demangler crashes."), _("\
2401 Show whether to attempt to catch demangler crashes."), _("\
2402 If enabled GDB will attempt to catch demangler crashes and\n\
2403 display the offending symbol."),
2404 NULL,
2405 NULL,
2406 &maintenance_set_cmdlist,
2407 &maintenance_show_cmdlist);
2409 gdb_demangle_attempt_core_dump = can_dump_core (LIMIT_CUR);
2410 #endif
2412 #if GDB_SELF_TEST
2413 selftests::register_test ("cp_symbol_name_matches",
2414 selftests::test_cp_symbol_name_matches);
2415 selftests::register_test ("cp_remove_params",
2416 selftests::test_cp_remove_params);
2417 selftests::register_test ("cp_search_name_hash",
2418 selftests::test_cp_search_name_hash);
2419 #endif