1 /* Helper routines for C++ support in GDB.
2 Copyright (C) 2002, 2003, 2004, 2005, 2007 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/>. */
23 #include "cp-support.h"
24 #include "gdb_string.h"
26 #include "gdb_assert.h"
28 #include "dictionary.h"
33 #include "complaints.h"
36 #define d_left(dc) (dc)->u.s_binary.left
37 #define d_right(dc) (dc)->u.s_binary.right
39 /* Functions related to demangled name parsing. */
41 static unsigned int cp_find_first_component_aux (const char *name
,
44 static void demangled_name_complaint (const char *name
);
46 /* Functions/variables related to overload resolution. */
48 static int sym_return_val_size
;
49 static int sym_return_val_index
;
50 static struct symbol
**sym_return_val
;
52 static void overload_list_add_symbol (struct symbol
*sym
,
53 const char *oload_name
);
55 static void make_symbol_overload_list_using (const char *func_name
,
56 const char *namespace);
58 static void make_symbol_overload_list_qualified (const char *func_name
);
60 static void read_in_psymtabs (const char *oload_name
);
62 /* The list of "maint cplus" commands. */
64 struct cmd_list_element
*maint_cplus_cmd_list
= NULL
;
66 /* The actual commands. */
68 static void maint_cplus_command (char *arg
, int from_tty
);
69 static void first_component_command (char *arg
, int from_tty
);
71 /* Return the canonicalized form of STRING, or NULL if STRING can not be
72 parsed. The return value is allocated via xmalloc.
74 drow/2005-03-07: Should we also return NULL for things that trivially do
75 not require any change? e.g. simple identifiers. This could be more
79 cp_canonicalize_string (const char *string
)
82 struct demangle_component
*ret_comp
;
84 int len
= strlen (string
);
88 ret_comp
= cp_demangled_name_to_comp (string
, &storage
, NULL
);
92 ret
= cp_comp_to_string (ret_comp
, len
);
99 /* Convert a mangled name to a demangle_component tree. *MEMORY is set to the
100 block of used memory that should be freed when finished with the tree.
101 DEMANGLED_P is set to the char * that should be freed when finished with
102 the tree, or NULL if none was needed. OPTIONS will be passed to the
105 static struct demangle_component
*
106 mangled_name_to_comp (const char *mangled_name
, int options
,
107 void **memory
, char **demangled_p
)
109 struct demangle_component
*ret
;
110 char *demangled_name
;
113 /* If it looks like a v3 mangled name, then try to go directly
115 if (mangled_name
[0] == '_' && mangled_name
[1] == 'Z')
117 ret
= cplus_demangle_v3_components (mangled_name
, options
, memory
);
125 /* If it doesn't, or if that failed, then try to demangle the name. */
126 demangled_name
= cplus_demangle (mangled_name
, options
);
127 if (demangled_name
== NULL
)
130 /* If we could demangle the name, parse it to build the component tree. */
131 ret
= cp_demangled_name_to_comp (demangled_name
, memory
, NULL
);
135 free (demangled_name
);
139 *demangled_p
= demangled_name
;
143 /* Return the name of the class containing method PHYSNAME. */
146 cp_class_name_from_physname (const char *physname
)
149 char *demangled_name
= NULL
, *ret
;
150 struct demangle_component
*ret_comp
, *prev_comp
, *cur_comp
;
153 ret_comp
= mangled_name_to_comp (physname
, DMGL_ANSI
, &storage
,
155 if (ret_comp
== NULL
)
160 /* First strip off any qualifiers, if we have a function or method. */
162 switch (ret_comp
->type
)
164 case DEMANGLE_COMPONENT_CONST
:
165 case DEMANGLE_COMPONENT_RESTRICT
:
166 case DEMANGLE_COMPONENT_VOLATILE
:
167 case DEMANGLE_COMPONENT_CONST_THIS
:
168 case DEMANGLE_COMPONENT_RESTRICT_THIS
:
169 case DEMANGLE_COMPONENT_VOLATILE_THIS
:
170 case DEMANGLE_COMPONENT_VENDOR_TYPE_QUAL
:
171 ret_comp
= d_left (ret_comp
);
178 /* If what we have now is a function, discard the argument list. */
179 if (ret_comp
->type
== DEMANGLE_COMPONENT_TYPED_NAME
)
180 ret_comp
= d_left (ret_comp
);
182 /* If what we have now is a template, strip off the template
183 arguments. The left subtree may be a qualified name. */
184 if (ret_comp
->type
== DEMANGLE_COMPONENT_TEMPLATE
)
185 ret_comp
= d_left (ret_comp
);
187 /* What we have now should be a name, possibly qualified. Additional
188 qualifiers could live in the left subtree or the right subtree. Find
194 switch (cur_comp
->type
)
196 case DEMANGLE_COMPONENT_QUAL_NAME
:
197 case DEMANGLE_COMPONENT_LOCAL_NAME
:
198 prev_comp
= cur_comp
;
199 cur_comp
= d_right (cur_comp
);
201 case DEMANGLE_COMPONENT_TEMPLATE
:
202 case DEMANGLE_COMPONENT_NAME
:
203 case DEMANGLE_COMPONENT_CTOR
:
204 case DEMANGLE_COMPONENT_DTOR
:
205 case DEMANGLE_COMPONENT_OPERATOR
:
206 case DEMANGLE_COMPONENT_EXTENDED_OPERATOR
:
216 if (cur_comp
!= NULL
&& prev_comp
!= NULL
)
218 /* We want to discard the rightmost child of PREV_COMP. */
219 *prev_comp
= *d_left (prev_comp
);
220 /* The ten is completely arbitrary; we don't have a good estimate. */
221 ret
= cp_comp_to_string (ret_comp
, 10);
226 xfree (demangled_name
);
230 /* Return the child of COMP which is the basename of a method, variable,
231 et cetera. All scope qualifiers are discarded, but template arguments
232 will be included. The component tree may be modified. */
234 static struct demangle_component
*
235 unqualified_name_from_comp (struct demangle_component
*comp
)
237 struct demangle_component
*ret_comp
= comp
, *last_template
;
241 last_template
= NULL
;
243 switch (ret_comp
->type
)
245 case DEMANGLE_COMPONENT_QUAL_NAME
:
246 case DEMANGLE_COMPONENT_LOCAL_NAME
:
247 ret_comp
= d_right (ret_comp
);
249 case DEMANGLE_COMPONENT_TYPED_NAME
:
250 ret_comp
= d_left (ret_comp
);
252 case DEMANGLE_COMPONENT_TEMPLATE
:
253 gdb_assert (last_template
== NULL
);
254 last_template
= ret_comp
;
255 ret_comp
= d_left (ret_comp
);
257 case DEMANGLE_COMPONENT_CONST
:
258 case DEMANGLE_COMPONENT_RESTRICT
:
259 case DEMANGLE_COMPONENT_VOLATILE
:
260 case DEMANGLE_COMPONENT_CONST_THIS
:
261 case DEMANGLE_COMPONENT_RESTRICT_THIS
:
262 case DEMANGLE_COMPONENT_VOLATILE_THIS
:
263 case DEMANGLE_COMPONENT_VENDOR_TYPE_QUAL
:
264 ret_comp
= d_left (ret_comp
);
266 case DEMANGLE_COMPONENT_NAME
:
267 case DEMANGLE_COMPONENT_CTOR
:
268 case DEMANGLE_COMPONENT_DTOR
:
269 case DEMANGLE_COMPONENT_OPERATOR
:
270 case DEMANGLE_COMPONENT_EXTENDED_OPERATOR
:
280 d_left (last_template
) = ret_comp
;
281 return last_template
;
287 /* Return the name of the method whose linkage name is PHYSNAME. */
290 method_name_from_physname (const char *physname
)
293 char *demangled_name
= NULL
, *ret
;
294 struct demangle_component
*ret_comp
;
297 ret_comp
= mangled_name_to_comp (physname
, DMGL_ANSI
, &storage
,
299 if (ret_comp
== NULL
)
302 ret_comp
= unqualified_name_from_comp (ret_comp
);
305 if (ret_comp
!= NULL
)
306 /* The ten is completely arbitrary; we don't have a good estimate. */
307 ret
= cp_comp_to_string (ret_comp
, 10);
311 xfree (demangled_name
);
315 /* If FULL_NAME is the demangled name of a C++ function (including an
316 arg list, possibly including namespace/class qualifications),
317 return a new string containing only the function name (without the
318 arg list/class qualifications). Otherwise, return NULL. The
319 caller is responsible for freeing the memory in question. */
322 cp_func_name (const char *full_name
)
326 struct demangle_component
*ret_comp
;
329 ret_comp
= cp_demangled_name_to_comp (full_name
, &storage
, NULL
);
333 ret_comp
= unqualified_name_from_comp (ret_comp
);
336 if (ret_comp
!= NULL
)
337 ret
= cp_comp_to_string (ret_comp
, 10);
343 /* DEMANGLED_NAME is the name of a function, including parameters and
344 (optionally) a return type. Return the name of the function without
345 parameters or return type, or NULL if we can not parse the name. */
348 remove_params (const char *demangled_name
)
351 struct demangle_component
*ret_comp
;
355 if (demangled_name
== NULL
)
358 ret_comp
= cp_demangled_name_to_comp (demangled_name
, &storage
, NULL
);
359 if (ret_comp
== NULL
)
362 /* First strip off any qualifiers, if we have a function or method. */
364 switch (ret_comp
->type
)
366 case DEMANGLE_COMPONENT_CONST
:
367 case DEMANGLE_COMPONENT_RESTRICT
:
368 case DEMANGLE_COMPONENT_VOLATILE
:
369 case DEMANGLE_COMPONENT_CONST_THIS
:
370 case DEMANGLE_COMPONENT_RESTRICT_THIS
:
371 case DEMANGLE_COMPONENT_VOLATILE_THIS
:
372 case DEMANGLE_COMPONENT_VENDOR_TYPE_QUAL
:
373 ret_comp
= d_left (ret_comp
);
380 /* What we have now should be a function. Return its name. */
381 if (ret_comp
->type
== DEMANGLE_COMPONENT_TYPED_NAME
)
382 ret
= cp_comp_to_string (d_left (ret_comp
), 10);
388 /* Here are some random pieces of trivia to keep in mind while trying
389 to take apart demangled names:
391 - Names can contain function arguments or templates, so the process
392 has to be, to some extent recursive: maybe keep track of your
393 depth based on encountering <> and ().
395 - Parentheses don't just have to happen at the end of a name: they
396 can occur even if the name in question isn't a function, because
397 a template argument might be a type that's a function.
399 - Conversely, even if you're trying to deal with a function, its
400 demangled name might not end with ')': it could be a const or
401 volatile class method, in which case it ends with "const" or
404 - Parentheses are also used in anonymous namespaces: a variable
405 'foo' in an anonymous namespace gets demangled as "(anonymous
408 - And operator names can contain parentheses or angle brackets. */
410 /* FIXME: carlton/2003-03-13: We have several functions here with
411 overlapping functionality; can we combine them? Also, do they
412 handle all the above considerations correctly? */
415 /* This returns the length of first component of NAME, which should be
416 the demangled name of a C++ variable/function/method/etc.
417 Specifically, it returns the index of the first colon forming the
418 boundary of the first component: so, given 'A::foo' or 'A::B::foo'
419 it returns the 1, and given 'foo', it returns 0. */
421 /* The character in NAME indexed by the return value is guaranteed to
422 always be either ':' or '\0'. */
424 /* NOTE: carlton/2003-03-13: This function is currently only intended
425 for internal use: it's probably not entirely safe when called on
426 user-generated input, because some of the 'index += 2' lines in
427 cp_find_first_component_aux might go past the end of malformed
431 cp_find_first_component (const char *name
)
433 return cp_find_first_component_aux (name
, 0);
436 /* Helper function for cp_find_first_component. Like that function,
437 it returns the length of the first component of NAME, but to make
438 the recursion easier, it also stops if it reaches an unexpected ')'
439 or '>' if the value of PERMISSIVE is nonzero. */
441 /* Let's optimize away calls to strlen("operator"). */
443 #define LENGTH_OF_OPERATOR 8
446 cp_find_first_component_aux (const char *name
, int permissive
)
448 unsigned int index
= 0;
449 /* Operator names can show up in unexpected places. Since these can
450 contain parentheses or angle brackets, they can screw up the
451 recursion. But not every string 'operator' is part of an
452 operater name: e.g. you could have a variable 'cooperator'. So
453 this variable tells us whether or not we should treat the string
454 'operator' as starting an operator. */
455 int operator_possible
= 1;
462 /* Template; eat it up. The calls to cp_first_component
463 should only return (I hope!) when they reach the '>'
464 terminating the component or a '::' between two
465 components. (Hence the '+ 2'.) */
467 for (index
+= cp_find_first_component_aux (name
+ index
, 1);
469 index
+= cp_find_first_component_aux (name
+ index
, 1))
471 if (name
[index
] != ':')
473 demangled_name_complaint (name
);
474 return strlen (name
);
478 operator_possible
= 1;
481 /* Similar comment as to '<'. */
483 for (index
+= cp_find_first_component_aux (name
+ index
, 1);
485 index
+= cp_find_first_component_aux (name
+ index
, 1))
487 if (name
[index
] != ':')
489 demangled_name_complaint (name
);
490 return strlen (name
);
494 operator_possible
= 1;
502 demangled_name_complaint (name
);
503 return strlen (name
);
509 /* Operator names can screw up the recursion. */
510 if (operator_possible
511 && strncmp (name
+ index
, "operator", LENGTH_OF_OPERATOR
) == 0)
513 index
+= LENGTH_OF_OPERATOR
;
514 while (isspace(name
[index
]))
518 /* Skip over one less than the appropriate number of
519 characters: the for loop will skip over the last
522 if (name
[index
+ 1] == '<')
529 if (name
[index
+ 1] == '>')
542 operator_possible
= 0;
549 /* NOTE: carlton/2003-04-18: I'm not sure what the precise
550 set of relevant characters are here: it's necessary to
551 include any character that can show up before 'operator'
552 in a demangled name, and it's safe to include any
553 character that can't be part of an identifier's name. */
554 operator_possible
= 1;
557 operator_possible
= 0;
563 /* Complain about a demangled name that we don't know how to parse.
564 NAME is the demangled name in question. */
567 demangled_name_complaint (const char *name
)
569 complaint (&symfile_complaints
,
570 "unexpected demangled name '%s'", name
);
573 /* If NAME is the fully-qualified name of a C++
574 function/variable/method/etc., this returns the length of its
575 entire prefix: all of the namespaces and classes that make up its
576 name. Given 'A::foo', it returns 1, given 'A::B::foo', it returns
577 4, given 'foo', it returns 0. */
580 cp_entire_prefix_len (const char *name
)
582 unsigned int current_len
= cp_find_first_component (name
);
583 unsigned int previous_len
= 0;
585 while (name
[current_len
] != '\0')
587 gdb_assert (name
[current_len
] == ':');
588 previous_len
= current_len
;
591 current_len
+= cp_find_first_component (name
+ current_len
);
597 /* Overload resolution functions. */
599 /* Test to see if SYM is a symbol that we haven't seen corresponding
600 to a function named OLOAD_NAME. If so, add it to the current
604 overload_list_add_symbol (struct symbol
*sym
, const char *oload_name
)
610 /* If there is no type information, we can't do anything, so skip */
611 if (SYMBOL_TYPE (sym
) == NULL
)
614 /* skip any symbols that we've already considered. */
615 for (i
= 0; i
< sym_return_val_index
; ++i
)
616 if (strcmp (SYMBOL_LINKAGE_NAME (sym
),
617 SYMBOL_LINKAGE_NAME (sym_return_val
[i
])) == 0)
620 /* Get the demangled name without parameters */
621 sym_name
= remove_params (SYMBOL_NATURAL_NAME (sym
));
625 /* skip symbols that cannot match */
626 if (strcmp (sym_name
, oload_name
) != 0)
634 /* We have a match for an overload instance, so add SYM to the current list
635 * of overload instances */
636 if (sym_return_val_index
+ 3 > sym_return_val_size
)
638 newsize
= (sym_return_val_size
*= 2) * sizeof (struct symbol
*);
639 sym_return_val
= (struct symbol
**) xrealloc ((char *) sym_return_val
, newsize
);
641 sym_return_val
[sym_return_val_index
++] = sym
;
642 sym_return_val
[sym_return_val_index
] = NULL
;
645 /* Return a null-terminated list of pointers to function symbols that
646 are named FUNC_NAME and are visible within NAMESPACE. */
649 make_symbol_overload_list (const char *func_name
,
650 const char *namespace)
652 struct cleanup
*old_cleanups
;
654 sym_return_val_size
= 100;
655 sym_return_val_index
= 0;
656 sym_return_val
= xmalloc ((sym_return_val_size
+ 1) *
657 sizeof (struct symbol
*));
658 sym_return_val
[0] = NULL
;
660 old_cleanups
= make_cleanup (xfree
, sym_return_val
);
662 make_symbol_overload_list_using (func_name
, namespace);
664 discard_cleanups (old_cleanups
);
666 return sym_return_val
;
669 /* This applies the using directives to add namespaces to search in,
670 and then searches for overloads in all of those namespaces. It
671 adds the symbols found to sym_return_val. Arguments are as in
672 make_symbol_overload_list. */
675 make_symbol_overload_list_using (const char *func_name
,
676 const char *namespace)
678 const struct using_direct
*current
;
680 /* First, go through the using directives. If any of them apply,
681 look in the appropriate namespaces for new functions to match
684 for (current
= block_using (get_selected_block (0));
686 current
= current
->next
)
688 if (strcmp (namespace, current
->outer
) == 0)
690 make_symbol_overload_list_using (func_name
,
695 /* Now, add names for this namespace. */
697 if (namespace[0] == '\0')
699 make_symbol_overload_list_qualified (func_name
);
703 char *concatenated_name
704 = alloca (strlen (namespace) + 2 + strlen (func_name
) + 1);
705 strcpy (concatenated_name
, namespace);
706 strcat (concatenated_name
, "::");
707 strcat (concatenated_name
, func_name
);
708 make_symbol_overload_list_qualified (concatenated_name
);
712 /* This does the bulk of the work of finding overloaded symbols.
713 FUNC_NAME is the name of the overloaded function we're looking for
714 (possibly including namespace info). */
717 make_symbol_overload_list_qualified (const char *func_name
)
721 struct objfile
*objfile
;
722 const struct block
*b
, *surrounding_static_block
= 0;
723 struct dict_iterator iter
;
724 const struct dictionary
*dict
;
726 /* Look through the partial symtabs for all symbols which begin
727 by matching FUNC_NAME. Make sure we read that symbol table in. */
729 read_in_psymtabs (func_name
);
731 /* Search upwards from currently selected frame (so that we can
732 complete on local vars. */
734 for (b
= get_selected_block (0); b
!= NULL
; b
= BLOCK_SUPERBLOCK (b
))
736 dict
= BLOCK_DICT (b
);
738 for (sym
= dict_iter_name_first (dict
, func_name
, &iter
);
740 sym
= dict_iter_name_next (func_name
, &iter
))
742 overload_list_add_symbol (sym
, func_name
);
746 surrounding_static_block
= block_static_block (get_selected_block (0));
748 /* Go through the symtabs and check the externs and statics for
749 symbols which match. */
751 ALL_PRIMARY_SYMTABS (objfile
, s
)
754 b
= BLOCKVECTOR_BLOCK (BLOCKVECTOR (s
), GLOBAL_BLOCK
);
755 dict
= BLOCK_DICT (b
);
757 for (sym
= dict_iter_name_first (dict
, func_name
, &iter
);
759 sym
= dict_iter_name_next (func_name
, &iter
))
761 overload_list_add_symbol (sym
, func_name
);
765 ALL_PRIMARY_SYMTABS (objfile
, s
)
768 b
= BLOCKVECTOR_BLOCK (BLOCKVECTOR (s
), STATIC_BLOCK
);
769 /* Don't do this block twice. */
770 if (b
== surrounding_static_block
)
772 dict
= BLOCK_DICT (b
);
774 for (sym
= dict_iter_name_first (dict
, func_name
, &iter
);
776 sym
= dict_iter_name_next (func_name
, &iter
))
778 overload_list_add_symbol (sym
, func_name
);
783 /* Look through the partial symtabs for all symbols which begin
784 by matching FUNC_NAME. Make sure we read that symbol table in. */
787 read_in_psymtabs (const char *func_name
)
789 struct partial_symtab
*ps
;
790 struct objfile
*objfile
;
792 ALL_PSYMTABS (objfile
, ps
)
797 if ((lookup_partial_symbol (ps
, func_name
, NULL
, 1, VAR_DOMAIN
)
799 || (lookup_partial_symbol (ps
, func_name
, NULL
, 0, VAR_DOMAIN
)
801 psymtab_to_symtab (ps
);
805 /* Lookup the rtti type for a class name. */
808 cp_lookup_rtti_type (const char *name
, struct block
*block
)
810 struct symbol
* rtti_sym
;
811 struct type
* rtti_type
;
813 rtti_sym
= lookup_symbol (name
, block
, STRUCT_DOMAIN
, NULL
, NULL
);
815 if (rtti_sym
== NULL
)
817 warning (_("RTTI symbol not found for class '%s'"), name
);
821 if (SYMBOL_CLASS (rtti_sym
) != LOC_TYPEDEF
)
823 warning (_("RTTI symbol for class '%s' is not a type"), name
);
827 rtti_type
= SYMBOL_TYPE (rtti_sym
);
829 switch (TYPE_CODE (rtti_type
))
831 case TYPE_CODE_CLASS
:
833 case TYPE_CODE_NAMESPACE
:
834 /* chastain/2003-11-26: the symbol tables often contain fake
835 symbols for namespaces with the same name as the struct.
836 This warning is an indication of a bug in the lookup order
837 or a bug in the way that the symbol tables are populated. */
838 warning (_("RTTI symbol for class '%s' is a namespace"), name
);
841 warning (_("RTTI symbol for class '%s' has bad type"), name
);
848 /* Don't allow just "maintenance cplus". */
851 maint_cplus_command (char *arg
, int from_tty
)
853 printf_unfiltered (_("\"maintenance cplus\" must be followed by the name of a command.\n"));
854 help_list (maint_cplus_cmd_list
, "maintenance cplus ", -1, gdb_stdout
);
857 /* This is a front end for cp_find_first_component, for unit testing.
858 Be careful when using it: see the NOTE above
859 cp_find_first_component. */
862 first_component_command (char *arg
, int from_tty
)
864 int len
= cp_find_first_component (arg
);
865 char *prefix
= alloca (len
+ 1);
867 memcpy (prefix
, arg
, len
);
870 printf_unfiltered ("%s\n", prefix
);
873 extern initialize_file_ftype _initialize_cp_support
; /* -Wmissing-prototypes */
876 _initialize_cp_support (void)
878 add_prefix_cmd ("cplus", class_maintenance
, maint_cplus_command
,
879 _("C++ maintenance commands."), &maint_cplus_cmd_list
,
880 "maintenance cplus ", 0, &maintenancelist
);
881 add_alias_cmd ("cp", "cplus", class_maintenance
, 1, &maintenancelist
);
883 add_cmd ("first_component", class_maintenance
, first_component_command
,
884 _("Print the first class/namespace component of NAME."),
885 &maint_cplus_cmd_list
);