1 /* Helper routines for C++ support in GDB.
2 Copyright (C) 2003-2014 Free Software Foundation, Inc.
4 Contributed by David Carlton and by Kealia, Inc.
6 This file is part of GDB.
8 This program is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 3 of the License, or
11 (at your option) any later version.
13 This program is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program. If not, see <http://www.gnu.org/licenses/>. */
22 #include "cp-support.h"
23 #include "gdb_obstack.h"
29 #include "dictionary.h"
35 static struct symbol *lookup_namespace_scope (const char *name,
36 const struct block *block,
37 const domain_enum domain,
41 static struct symbol *lookup_symbol_file (const char *name,
42 const struct block *block,
43 const domain_enum domain,
44 int anonymous_namespace,
47 static struct type *cp_lookup_transparent_type_loop (const char *name,
51 /* Check to see if SYMBOL refers to an object contained within an
52 anonymous namespace; if so, add an appropriate using directive. */
55 cp_scan_for_anonymous_namespaces (const struct symbol *const symbol,
56 struct objfile *const objfile)
58 if (SYMBOL_DEMANGLED_NAME (symbol) != NULL)
60 const char *name = SYMBOL_DEMANGLED_NAME (symbol);
61 unsigned int previous_component;
62 unsigned int next_component;
64 /* Start with a quick-and-dirty check for mention of "(anonymous
67 if (!cp_is_anonymous (name))
70 previous_component = 0;
71 next_component = cp_find_first_component (name + previous_component);
73 while (name[next_component] == ':')
75 if (((next_component - previous_component)
76 == CP_ANONYMOUS_NAMESPACE_LEN)
77 && strncmp (name + previous_component,
78 CP_ANONYMOUS_NAMESPACE_STR,
79 CP_ANONYMOUS_NAMESPACE_LEN) == 0)
81 int dest_len = (previous_component == 0
82 ? 0 : previous_component - 2);
83 int src_len = next_component;
85 char *dest = alloca (dest_len + 1);
86 char *src = alloca (src_len + 1);
88 memcpy (dest, name, dest_len);
89 memcpy (src, name, src_len);
91 dest[dest_len] = '\0';
94 /* We've found a component of the name that's an
95 anonymous namespace. So add symbols in it to the
96 namespace given by the previous component if there is
97 one, or to the global namespace if there isn't. */
98 cp_add_using_directive (dest, src, NULL, NULL, NULL, 1,
99 &objfile->objfile_obstack);
101 /* The "+ 2" is for the "::". */
102 previous_component = next_component + 2;
103 next_component = (previous_component
104 + cp_find_first_component (name
105 + previous_component));
111 /* Add a using directive to using_directives. If the using directive
112 in question has already been added, don't add it twice.
114 Create a new struct using_direct which imports the namespace SRC
115 into the scope DEST. ALIAS is the name of the imported namespace
116 in the current scope. If ALIAS is NULL then the namespace is known
117 by its original name. DECLARATION is the name if the imported
118 varable if this is a declaration import (Eg. using A::x), otherwise
119 it is NULL. EXCLUDES is a list of names not to import from an
120 imported module or NULL. If COPY_NAMES is non-zero, then the
121 arguments are copied into newly allocated memory so they can be
122 temporaries. For EXCLUDES the VEC pointers are copied but the
123 pointed to characters are not copied. */
126 cp_add_using_directive (const char *dest,
129 const char *declaration,
130 VEC (const_char_ptr) *excludes,
132 struct obstack *obstack)
134 struct using_direct *current;
135 struct using_direct *new;
137 /* Has it already been added? */
139 for (current = using_directives; current != NULL; current = current->next)
144 if (strcmp (current->import_src, src) != 0)
146 if (strcmp (current->import_dest, dest) != 0)
148 if ((alias == NULL && current->alias != NULL)
149 || (alias != NULL && current->alias == NULL)
150 || (alias != NULL && current->alias != NULL
151 && strcmp (alias, current->alias) != 0))
153 if ((declaration == NULL && current->declaration != NULL)
154 || (declaration != NULL && current->declaration == NULL)
155 || (declaration != NULL && current->declaration != NULL
156 && strcmp (declaration, current->declaration) != 0))
159 /* Compare the contents of EXCLUDES. */
160 for (ix = 0; VEC_iterate (const_char_ptr, excludes, ix, param); ix++)
161 if (current->excludes[ix] == NULL
162 || strcmp (param, current->excludes[ix]) != 0)
164 if (ix < VEC_length (const_char_ptr, excludes)
165 || current->excludes[ix] != NULL)
168 /* Parameters exactly match CURRENT. */
172 new = obstack_alloc (obstack, (sizeof (*new)
173 + (VEC_length (const_char_ptr, excludes)
174 * sizeof (*new->excludes))));
175 memset (new, 0, sizeof (*new));
179 new->import_src = obstack_copy0 (obstack, src, strlen (src));
180 new->import_dest = obstack_copy0 (obstack, dest, strlen (dest));
184 new->import_src = src;
185 new->import_dest = dest;
188 if (alias != NULL && copy_names)
189 new->alias = obstack_copy0 (obstack, alias, strlen (alias));
193 if (declaration != NULL && copy_names)
194 new->declaration = obstack_copy0 (obstack,
195 declaration, strlen (declaration));
197 new->declaration = declaration;
199 memcpy (new->excludes, VEC_address (const_char_ptr, excludes),
200 VEC_length (const_char_ptr, excludes) * sizeof (*new->excludes));
201 new->excludes[VEC_length (const_char_ptr, excludes)] = NULL;
203 new->next = using_directives;
204 using_directives = new;
207 /* Test whether or not NAMESPACE looks like it mentions an anonymous
208 namespace; return nonzero if so. */
211 cp_is_anonymous (const char *namespace)
213 return (strstr (namespace, CP_ANONYMOUS_NAMESPACE_STR)
217 /* The C++-specific version of name lookup for static and global
218 names. This makes sure that names get looked for in all namespaces
219 that are in scope. NAME is the natural name of the symbol that
220 we're looking for, BLOCK is the block that we're searching within,
221 DOMAIN says what kind of symbols we're looking for, and if SYMTAB
222 is non-NULL, we should store the symtab where we found the symbol
226 cp_lookup_symbol_nonlocal (const char *name,
227 const struct block *block,
228 const domain_enum domain)
231 const char *scope = block_scope (block);
233 sym = lookup_namespace_scope (name, block,
238 return cp_lookup_symbol_namespace (scope, name,
242 /* Look up NAME in the C++ namespace NAMESPACE. Other arguments are
243 as in cp_lookup_symbol_nonlocal. If SEARCH is non-zero, search
244 through base classes for a matching symbol. */
246 static struct symbol *
247 cp_lookup_symbol_in_namespace (const char *namespace,
249 const struct block *block,
250 const domain_enum domain, int search)
252 if (namespace[0] == '\0')
254 return lookup_symbol_file (name, block, domain, 0, search);
258 char *concatenated_name = alloca (strlen (namespace) + 2
259 + strlen (name) + 1);
261 strcpy (concatenated_name, namespace);
262 strcat (concatenated_name, "::");
263 strcat (concatenated_name, name);
264 return lookup_symbol_file (concatenated_name, block, domain,
265 cp_is_anonymous (namespace), search);
269 /* Used for cleanups to reset the "searched" flag incase
273 reset_directive_searched (void *data)
275 struct using_direct *direct = data;
276 direct->searched = 0;
279 /* Search for NAME by applying all import statements belonging to
280 BLOCK which are applicable in SCOPE. If DECLARATION_ONLY the
281 search is restricted to using declarations.
289 If SEARCH_PARENTS the search will include imports which are
290 applicable in parents of SCOPE.
300 If SCOPE is "A::B" and SEARCH_PARENTS is true the imports of
301 namespaces X and Y will be considered. If SEARCH_PARENTS is false
302 only the import of Y is considered. */
305 cp_lookup_symbol_imports (const char *scope,
307 const struct block *block,
308 const domain_enum domain,
309 const int declaration_only,
310 const int search_parents)
312 struct using_direct *current;
313 struct symbol *sym = NULL;
316 struct cleanup *searched_cleanup;
318 /* First, try to find the symbol in the given namespace. */
319 if (!declaration_only)
320 sym = cp_lookup_symbol_in_namespace (scope, name,
326 /* Go through the using directives. If any of them add new names to
327 the namespace we're searching in, see if we can find a match by
330 for (current = block_using (block);
332 current = current->next)
334 const char **excludep;
336 len = strlen (current->import_dest);
337 directive_match = (search_parents
338 ? (strncmp (scope, current->import_dest,
339 strlen (current->import_dest)) == 0
342 || scope[len] == '\0'))
343 : strcmp (scope, current->import_dest) == 0);
345 /* If the import destination is the current scope or one of its
346 ancestors then it is applicable. */
347 if (directive_match && !current->searched)
349 /* Mark this import as searched so that the recursive call
350 does not search it again. */
351 current->searched = 1;
352 searched_cleanup = make_cleanup (reset_directive_searched,
355 /* If there is an import of a single declaration, compare the
356 imported declaration (after optional renaming by its alias)
357 with the sought out name. If there is a match pass
358 current->import_src as NAMESPACE to direct the search
359 towards the imported namespace. */
360 if (current->declaration
361 && strcmp (name, current->alias
362 ? current->alias : current->declaration) == 0)
363 sym = cp_lookup_symbol_in_namespace (current->import_src,
364 current->declaration,
367 /* If this is a DECLARATION_ONLY search or a symbol was found
368 or this import statement was an import declaration, the
369 search of this import is complete. */
370 if (declaration_only || sym != NULL || current->declaration)
372 current->searched = 0;
373 discard_cleanups (searched_cleanup);
381 /* Do not follow CURRENT if NAME matches its EXCLUDES. */
382 for (excludep = current->excludes; *excludep; excludep++)
383 if (strcmp (name, *excludep) == 0)
387 discard_cleanups (searched_cleanup);
391 if (current->alias != NULL
392 && strcmp (name, current->alias) == 0)
393 /* If the import is creating an alias and the alias matches
394 the sought name. Pass current->import_src as the NAME to
395 direct the search towards the aliased namespace. */
397 sym = cp_lookup_symbol_in_namespace (scope,
401 else if (current->alias == NULL)
403 /* If this import statement creates no alias, pass
404 current->inner as NAMESPACE to direct the search
405 towards the imported namespace. */
406 sym = cp_lookup_symbol_imports (current->import_src,
410 current->searched = 0;
411 discard_cleanups (searched_cleanup);
421 /* Helper function that searches an array of symbols for one named
424 static struct symbol *
425 search_symbol_list (const char *name, int num,
426 struct symbol **syms)
430 /* Maybe we should store a dictionary in here instead. */
431 for (i = 0; i < num; ++i)
433 if (strcmp (name, SYMBOL_NATURAL_NAME (syms[i])) == 0)
439 /* Like cp_lookup_symbol_imports, but if BLOCK is a function, it
440 searches through the template parameters of the function and the
444 cp_lookup_symbol_imports_or_template (const char *scope,
446 const struct block *block,
447 const domain_enum domain)
449 struct symbol *function = BLOCK_FUNCTION (block);
451 if (function != NULL && SYMBOL_LANGUAGE (function) == language_cplus)
453 /* Search the function's template parameters. */
454 if (SYMBOL_IS_CPLUS_TEMPLATE_FUNCTION (function))
456 struct template_symbol *templ
457 = (struct template_symbol *) function;
458 struct symbol *result;
460 result = search_symbol_list (name,
461 templ->n_template_arguments,
462 templ->template_arguments);
467 /* Search the template parameters of the function's defining
469 if (SYMBOL_NATURAL_NAME (function))
471 struct type *context;
472 char *name_copy = xstrdup (SYMBOL_NATURAL_NAME (function));
473 struct cleanup *cleanups = make_cleanup (xfree, name_copy);
474 const struct language_defn *lang = language_def (language_cplus);
476 = get_objfile_arch (SYMBOL_SYMTAB (function)->objfile);
477 const struct block *parent = BLOCK_SUPERBLOCK (block);
481 struct symbol *result;
482 unsigned int prefix_len = cp_entire_prefix_len (name_copy);
488 name_copy[prefix_len] = '\0';
489 context = lookup_typename (lang, arch,
498 = search_symbol_list (name,
499 TYPE_N_TEMPLATE_ARGUMENTS (context),
500 TYPE_TEMPLATE_ARGUMENTS (context));
503 do_cleanups (cleanups);
508 do_cleanups (cleanups);
512 return cp_lookup_symbol_imports (scope, name, block, domain, 1, 1);
515 /* Searches for NAME in the current namespace, and by applying
516 relevant import statements belonging to BLOCK and its parents.
517 SCOPE is the namespace scope of the context in which the search is
521 cp_lookup_symbol_namespace (const char *scope,
523 const struct block *block,
524 const domain_enum domain)
528 /* First, try to find the symbol in the given namespace. */
529 sym = cp_lookup_symbol_in_namespace (scope, name,
534 /* Search for name in namespaces imported to this and parent
536 while (block != NULL)
538 sym = cp_lookup_symbol_imports (scope, name, block,
544 block = BLOCK_SUPERBLOCK (block);
550 /* Lookup NAME at namespace scope (or, in C terms, in static and
551 global variables). SCOPE is the namespace that the current
552 function is defined within; only consider namespaces whose length
553 is at least SCOPE_LEN. Other arguments are as in
554 cp_lookup_symbol_nonlocal.
556 For example, if we're within a function A::B::f and looking for a
557 symbol x, this will get called with NAME = "x", SCOPE = "A::B", and
558 SCOPE_LEN = 0. It then calls itself with NAME and SCOPE the same,
559 but with SCOPE_LEN = 1. And then it calls itself with NAME and
560 SCOPE the same, but with SCOPE_LEN = 4. This third call looks for
561 "A::B::x"; if it doesn't find it, then the second call looks for
562 "A::x", and if that call fails, then the first call looks for
565 static struct symbol *
566 lookup_namespace_scope (const char *name,
567 const struct block *block,
568 const domain_enum domain,
574 if (scope[scope_len] != '\0')
576 /* Recursively search for names in child namespaces first. */
579 int new_scope_len = scope_len;
581 /* If the current scope is followed by "::", skip past that. */
582 if (new_scope_len != 0)
584 gdb_assert (scope[new_scope_len] == ':');
587 new_scope_len += cp_find_first_component (scope + new_scope_len);
588 sym = lookup_namespace_scope (name, block, domain,
589 scope, new_scope_len);
594 /* Okay, we didn't find a match in our children, so look for the
595 name in the current namespace. */
597 namespace = alloca (scope_len + 1);
598 strncpy (namespace, scope, scope_len);
599 namespace[scope_len] = '\0';
600 return cp_lookup_symbol_in_namespace (namespace, name,
604 /* Look up NAME in BLOCK's static block and in global blocks. If
605 ANONYMOUS_NAMESPACE is nonzero, the symbol in question is located
606 within an anonymous namespace. If SEARCH is non-zero, search through
607 base classes for a matching symbol. Other arguments are as in
608 cp_lookup_symbol_nonlocal. */
610 static struct symbol *
611 lookup_symbol_file (const char *name,
612 const struct block *block,
613 const domain_enum domain,
614 int anonymous_namespace, int search)
616 struct symbol *sym = NULL;
618 sym = lookup_symbol_static (name, block, domain);
622 if (anonymous_namespace)
624 /* Symbols defined in anonymous namespaces have external linkage
625 but should be treated as local to a single file nonetheless.
626 So we only search the current file's global block. */
628 const struct block *global_block = block_global_block (block);
630 if (global_block != NULL)
631 sym = lookup_symbol_aux_block (name, global_block, domain);
635 sym = lookup_symbol_global (name, block, domain);
643 char *klass, *nested;
644 unsigned int prefix_len;
645 struct cleanup *cleanup;
646 struct symbol *klass_sym;
648 /* A simple lookup failed. Check if the symbol was defined in
651 cleanup = make_cleanup (null_cleanup, NULL);
653 /* Find the name of the class and the name of the method,
655 prefix_len = cp_entire_prefix_len (name);
657 /* If no prefix was found, search "this". */
663 this = lookup_language_this (language_def (language_cplus), block);
666 do_cleanups (cleanup);
670 type = check_typedef (TYPE_TARGET_TYPE (SYMBOL_TYPE (this)));
671 /* If TYPE_NAME is NULL, abandon trying to find this symbol.
672 This can happen for lambda functions compiled with clang++,
673 which outputs no name for the container class. */
674 if (TYPE_NAME (type) == NULL)
676 klass = xstrdup (TYPE_NAME (type));
677 nested = xstrdup (name);
681 /* The class name is everything up to and including PREFIX_LEN. */
682 klass = savestring (name, prefix_len);
684 /* The rest of the name is everything else past the initial scope
686 nested = xstrdup (name + prefix_len + 2);
689 /* Add cleanups to free memory for these strings. */
690 make_cleanup (xfree, klass);
691 make_cleanup (xfree, nested);
693 /* Lookup a class named KLASS. If none is found, there is nothing
694 more that can be done. */
695 klass_sym = lookup_symbol_global (klass, block, domain);
696 if (klass_sym == NULL)
698 do_cleanups (cleanup);
702 /* Look for a symbol named NESTED in this class. */
703 sym = cp_lookup_nested_symbol (SYMBOL_TYPE (klass_sym), nested, block);
704 do_cleanups (cleanup);
710 /* Search through the base classes of PARENT_TYPE for a base class
711 named NAME and return its type. If not found, return NULL. */
714 find_type_baseclass_by_name (struct type *parent_type, const char *name)
718 CHECK_TYPEDEF (parent_type);
719 for (i = 0; i < TYPE_N_BASECLASSES (parent_type); ++i)
721 struct type *type = check_typedef (TYPE_BASECLASS (parent_type, i));
722 const char *base_name = TYPE_BASECLASS_NAME (parent_type, i);
724 if (base_name == NULL)
727 if (streq (base_name, name))
730 type = find_type_baseclass_by_name (type, name);
738 /* Search through the base classes of PARENT_TYPE for a symbol named
739 NAME in block BLOCK. */
741 static struct symbol *
742 find_symbol_in_baseclass (struct type *parent_type, const char *name,
743 const struct block *block)
747 struct cleanup *cleanup;
748 char *concatenated_name;
751 concatenated_name = NULL;
752 cleanup = make_cleanup (free_current_contents, &concatenated_name);
753 for (i = 0; i < TYPE_N_BASECLASSES (parent_type); ++i)
756 struct type *base_type = TYPE_BASECLASS (parent_type, i);
757 const char *base_name = TYPE_BASECLASS_NAME (parent_type, i);
759 if (base_name == NULL)
762 /* Search this particular base class. */
763 sym = cp_lookup_symbol_in_namespace (base_name, name, block,
768 /* Now search all static file-level symbols. We have to do this for
769 things like typedefs in the class. First search in this symtab,
770 what we want is possibly there. */
771 len = strlen (base_name) + 2 + strlen (name) + 1;
772 concatenated_name = xrealloc (concatenated_name, len);
773 xsnprintf (concatenated_name, len, "%s::%s", base_name, name);
774 sym = lookup_symbol_static (concatenated_name, block, VAR_DOMAIN);
778 /* Nope. We now have to search all static blocks in all objfiles,
779 even if block != NULL, because there's no guarantees as to which
780 symtab the symbol we want is in. */
781 sym = lookup_static_symbol_aux (concatenated_name, VAR_DOMAIN);
785 /* If this class has base classes, search them next. */
786 CHECK_TYPEDEF (base_type);
787 if (TYPE_N_BASECLASSES (base_type) > 0)
789 sym = find_symbol_in_baseclass (base_type, name, block);
795 do_cleanups (cleanup);
799 /* Look up a symbol named NESTED_NAME that is nested inside the C++
800 class or namespace given by PARENT_TYPE, from within the context
801 given by BLOCK. Return NULL if there is no such nested type. */
804 cp_lookup_nested_symbol (struct type *parent_type,
805 const char *nested_name,
806 const struct block *block)
808 /* type_name_no_tag_required provides better error reporting using the
810 struct type *saved_parent_type = parent_type;
812 CHECK_TYPEDEF (parent_type);
814 switch (TYPE_CODE (parent_type))
816 case TYPE_CODE_STRUCT:
817 case TYPE_CODE_NAMESPACE:
818 case TYPE_CODE_UNION:
820 /* NOTE: Handle modules here as well, because Fortran is re-using the C++
821 specific code to lookup nested symbols in modules, by calling the
822 function pointer la_lookup_symbol_nonlocal, which ends up here. */
823 case TYPE_CODE_MODULE:
825 /* NOTE: carlton/2003-11-10: We don't treat C++ class members
826 of classes like, say, data or function members. Instead,
827 they're just represented by symbols whose names are
828 qualified by the name of the surrounding class. This is
829 just like members of namespaces; in particular,
830 lookup_symbol_namespace works when looking them up. */
833 const char *parent_name = type_name_no_tag_or_error (saved_parent_type);
835 = cp_lookup_symbol_in_namespace (parent_name, nested_name,
836 block, VAR_DOMAIN, 0);
837 char *concatenated_name;
842 /* Now search all static file-level symbols. We have to do this
843 for things like typedefs in the class. We do not try to
844 guess any imported namespace as even the fully specified
845 namespace search is already not C++ compliant and more
846 assumptions could make it too magic. */
848 size = strlen (parent_name) + 2 + strlen (nested_name) + 1;
849 concatenated_name = alloca (size);
850 xsnprintf (concatenated_name, size, "%s::%s",
851 parent_name, nested_name);
852 sym = lookup_static_symbol_aux (concatenated_name, VAR_DOMAIN);
856 /* If no matching symbols were found, try searching any
858 return find_symbol_in_baseclass (parent_type, nested_name, block);
862 case TYPE_CODE_METHOD:
866 internal_error (__FILE__, __LINE__,
867 _("cp_lookup_nested_symbol called "
868 "on a non-aggregate type."));
872 /* The C++-version of lookup_transparent_type. */
874 /* FIXME: carlton/2004-01-16: The problem that this is trying to
875 address is that, unfortunately, sometimes NAME is wrong: it may not
876 include the name of namespaces enclosing the type in question.
877 lookup_transparent_type gets called when the type in question
878 is a declaration, and we're trying to find its definition; but, for
879 declarations, our type name deduction mechanism doesn't work.
880 There's nothing we can do to fix this in general, I think, in the
881 absence of debug information about namespaces (I've filed PR
882 gdb/1511 about this); until such debug information becomes more
883 prevalent, one heuristic which sometimes looks is to search for the
884 definition in namespaces containing the current namespace.
886 We should delete this functions once the appropriate debug
887 information becomes more widespread. (GCC 3.4 will be the first
888 released version of GCC with such information.) */
891 cp_lookup_transparent_type (const char *name)
893 /* First, try the honest way of looking up the definition. */
894 struct type *t = basic_lookup_transparent_type (name);
900 /* If that doesn't work and we're within a namespace, look there
902 scope = block_scope (get_selected_block (0));
904 if (scope[0] == '\0')
907 return cp_lookup_transparent_type_loop (name, scope, 0);
910 /* Lookup the type definition associated to NAME in namespaces/classes
911 containing SCOPE whose name is strictly longer than LENGTH. LENGTH
912 must be the index of the start of a component of SCOPE. */
915 cp_lookup_transparent_type_loop (const char *name,
919 int scope_length = length + cp_find_first_component (scope + length);
922 /* If the current scope is followed by "::", look in the next
924 if (scope[scope_length] == ':')
927 = cp_lookup_transparent_type_loop (name, scope,
934 full_name = alloca (scope_length + 2 + strlen (name) + 1);
935 strncpy (full_name, scope, scope_length);
936 strncpy (full_name + scope_length, "::", 2);
937 strcpy (full_name + scope_length + 2, name);
939 return basic_lookup_transparent_type (full_name);
942 /* This used to do something but was removed when it became
946 maintenance_cplus_namespace (char *args, int from_tty)
948 printf_unfiltered (_("The `maint namespace' command was removed.\n"));
951 /* Provide a prototype to silence -Wmissing-prototypes. */
952 extern initialize_file_ftype _initialize_cp_namespace;
955 _initialize_cp_namespace (void)
957 struct cmd_list_element *cmd;
959 cmd = add_cmd ("namespace", class_maintenance,
960 maintenance_cplus_namespace,
961 _("Deprecated placeholder for removed functionality."),
962 &maint_cplus_cmd_list);
963 deprecate_cmd (cmd, NULL);