1 /* Helper routines for C++ support in GDB.
2 Copyright (C) 2003, 2004, 2007, 2008, 2009, 2010, 2011
3 Free Software Foundation, Inc.
5 Contributed by David Carlton and by Kealia, Inc.
7 This file is part of GDB.
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 3 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program. If not, see <http://www.gnu.org/licenses/>. */
23 #include "cp-support.h"
24 #include "gdb_obstack.h"
27 #include "gdb_assert.h"
31 #include "dictionary.h"
37 static struct symbol
*lookup_namespace_scope (const char *name
,
38 const struct block
*block
,
39 const domain_enum domain
,
43 static struct symbol
*lookup_symbol_file (const char *name
,
44 const struct block
*block
,
45 const domain_enum domain
,
46 int anonymous_namespace
);
48 static struct type
*cp_lookup_transparent_type_loop (const char *name
,
52 /* Check to see if SYMBOL refers to an object contained within an
53 anonymous namespace; if so, add an appropriate using directive. */
56 cp_scan_for_anonymous_namespaces (const struct symbol
*symbol
)
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
,
99 &SYMBOL_SYMTAB (symbol
)->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. The arguments are copied into newly allocated memory
120 so they can be temporaries. */
123 cp_add_using_directive (const char *dest
,
126 const char *declaration
,
127 struct obstack
*obstack
)
129 struct using_direct
*current
;
130 struct using_direct
*new;
132 /* Has it already been added? */
134 for (current
= using_directives
; current
!= NULL
; current
= current
->next
)
136 if (strcmp (current
->import_src
, src
) != 0)
138 if (strcmp (current
->import_dest
, dest
) != 0)
140 if ((alias
== NULL
&& current
->alias
!= NULL
)
141 || (alias
!= NULL
&& current
->alias
== NULL
)
142 || (alias
!= NULL
&& current
->alias
!= NULL
143 && strcmp (alias
, current
->alias
) != 0))
145 if ((declaration
== NULL
&& current
->declaration
!= NULL
)
146 || (declaration
!= NULL
&& current
->declaration
== NULL
)
147 || (declaration
!= NULL
&& current
->declaration
!= NULL
148 && strcmp (declaration
, current
->declaration
) != 0))
151 /* Parameters exactly match CURRENT. */
155 new = OBSTACK_ZALLOC (obstack
, struct using_direct
);
157 new->import_src
= obsavestring (src
, strlen (src
), obstack
);
158 new->import_dest
= obsavestring (dest
, strlen (dest
), obstack
);
161 new->alias
= obsavestring (alias
, strlen (alias
), obstack
);
163 if (declaration
!= NULL
)
164 new->declaration
= obsavestring (declaration
, strlen (declaration
),
167 new->next
= using_directives
;
168 using_directives
= new;
171 /* Record the namespace that the function defined by SYMBOL was
172 defined in, if necessary. BLOCK is the associated block; use
173 OBSTACK for allocation. */
176 cp_set_block_scope (const struct symbol
*symbol
,
178 struct obstack
*obstack
,
179 const char *processing_current_prefix
,
180 int processing_has_namespace_info
)
182 if (processing_has_namespace_info
)
185 (block
, obsavestring (processing_current_prefix
,
186 strlen (processing_current_prefix
),
190 else if (SYMBOL_DEMANGLED_NAME (symbol
) != NULL
)
192 /* Try to figure out the appropriate namespace from the
195 /* FIXME: carlton/2003-04-15: If the function in question is
196 a method of a class, the name will actually include the
197 name of the class as well. This should be harmless, but
198 is a little unfortunate. */
200 const char *name
= SYMBOL_DEMANGLED_NAME (symbol
);
201 unsigned int prefix_len
= cp_entire_prefix_len (name
);
203 block_set_scope (block
,
204 obsavestring (name
, prefix_len
, obstack
),
209 /* Test whether or not NAMESPACE looks like it mentions an anonymous
210 namespace; return nonzero if so. */
213 cp_is_anonymous (const char *namespace)
215 return (strstr (namespace, CP_ANONYMOUS_NAMESPACE_STR
)
219 /* The C++-specific version of name lookup for static and global
220 names. This makes sure that names get looked for in all namespaces
221 that are in scope. NAME is the natural name of the symbol that
222 we're looking for, BLOCK is the block that we're searching within,
223 DOMAIN says what kind of symbols we're looking for, and if SYMTAB
224 is non-NULL, we should store the symtab where we found the symbol
228 cp_lookup_symbol_nonlocal (const char *name
,
229 const struct block
*block
,
230 const domain_enum domain
)
233 const char *scope
= block_scope (block
);
235 sym
= lookup_namespace_scope (name
, block
,
240 return cp_lookup_symbol_namespace (scope
, name
,
244 /* Look up NAME in the C++ namespace NAMESPACE. Other arguments are
245 as in cp_lookup_symbol_nonlocal. */
247 static struct symbol
*
248 cp_lookup_symbol_in_namespace (const char *namespace,
250 const struct block
*block
,
251 const domain_enum domain
)
253 if (namespace[0] == '\0')
255 return lookup_symbol_file (name
, block
, domain
, 0);
259 char *concatenated_name
= alloca (strlen (namespace) + 2
260 + strlen (name
) + 1);
262 strcpy (concatenated_name
, namespace);
263 strcat (concatenated_name
, "::");
264 strcat (concatenated_name
, name
);
265 return lookup_symbol_file (concatenated_name
, block
, domain
,
266 cp_is_anonymous (namespace));
270 /* Used for cleanups to reset the "searched" flag incase
274 reset_directive_searched (void *data
)
276 struct using_direct
*direct
= data
;
277 direct
->searched
= 0;
280 /* Search for NAME by applying all import statements belonging to
281 BLOCK which are applicable in SCOPE. If DECLARATION_ONLY the
282 search is restricted to using declarations.
290 If SEARCH_PARENTS the search will include imports which are
291 applicable in parents of SCOPE.
301 If SCOPE is "A::B" and SEARCH_PARENTS is true the imports of
302 namespaces X and Y will be considered. If SEARCH_PARENTS is false
303 only the import of Y is considered. */
306 cp_lookup_symbol_imports (const char *scope
,
308 const struct block
*block
,
309 const domain_enum domain
,
310 const int declaration_only
,
311 const int search_parents
)
313 struct using_direct
*current
;
314 struct symbol
*sym
= NULL
;
317 struct cleanup
*searched_cleanup
;
319 /* First, try to find the symbol in the given namespace. */
320 if (!declaration_only
)
321 sym
= cp_lookup_symbol_in_namespace (scope
, name
,
327 /* Go through the using directives. If any of them add new names to
328 the namespace we're searching in, see if we can find a match by
331 for (current
= block_using (block
);
333 current
= current
->next
)
335 len
= strlen (current
->import_dest
);
336 directive_match
= (search_parents
337 ? (strncmp (scope
, current
->import_dest
,
338 strlen (current
->import_dest
)) == 0
341 || scope
[len
] == '\0'))
342 : strcmp (scope
, current
->import_dest
) == 0);
344 /* If the import destination is the current scope or one of its
345 ancestors then it is applicable. */
346 if (directive_match
&& !current
->searched
)
348 /* Mark this import as searched so that the recursive call
349 does not search it again. */
350 current
->searched
= 1;
351 searched_cleanup
= make_cleanup (reset_directive_searched
,
354 /* If there is an import of a single declaration, compare the
355 imported declaration (after optional renaming by its alias)
356 with the sought out name. If there is a match pass
357 current->import_src as NAMESPACE to direct the search
358 towards the imported namespace. */
359 if (current
->declaration
360 && strcmp (name
, current
->alias
361 ? current
->alias
: current
->declaration
) == 0)
362 sym
= cp_lookup_symbol_in_namespace (current
->import_src
,
363 current
->declaration
,
366 /* If this is a DECLARATION_ONLY search or a symbol was found
367 or this import statement was an import declaration, the
368 search of this import is complete. */
369 if (declaration_only
|| sym
!= NULL
|| current
->declaration
)
371 current
->searched
= 0;
372 discard_cleanups (searched_cleanup
);
380 if (current
->alias
!= NULL
381 && strcmp (name
, current
->alias
) == 0)
382 /* If the import is creating an alias and the alias matches
383 the sought name. Pass current->import_src as the NAME to
384 direct the search towards the aliased namespace. */
386 sym
= cp_lookup_symbol_in_namespace (scope
,
390 else if (current
->alias
== NULL
)
392 /* If this import statement creates no alias, pass
393 current->inner as NAMESPACE to direct the search
394 towards the imported namespace. */
395 sym
= cp_lookup_symbol_imports (current
->import_src
,
399 current
->searched
= 0;
400 discard_cleanups (searched_cleanup
);
410 /* Helper function that searches an array of symbols for one named
413 static struct symbol
*
414 search_symbol_list (const char *name
, int num
,
415 struct symbol
**syms
)
419 /* Maybe we should store a dictionary in here instead. */
420 for (i
= 0; i
< num
; ++i
)
422 if (strcmp (name
, SYMBOL_NATURAL_NAME (syms
[i
])) == 0)
428 /* Like cp_lookup_symbol_imports, but if BLOCK is a function, it
429 searches through the template parameters of the function and the
433 cp_lookup_symbol_imports_or_template (const char *scope
,
435 const struct block
*block
,
436 const domain_enum domain
)
438 struct symbol
*function
= BLOCK_FUNCTION (block
);
440 if (function
!= NULL
&& SYMBOL_LANGUAGE (function
) == language_cplus
)
443 struct cplus_specific
*cps
444 = function
->ginfo
.language_specific
.cplus_specific
;
446 /* Search the function's template parameters. */
447 if (SYMBOL_IS_CPLUS_TEMPLATE_FUNCTION (function
))
449 struct template_symbol
*templ
450 = (struct template_symbol
*) function
;
451 struct symbol
*result
;
453 result
= search_symbol_list (name
,
454 templ
->n_template_arguments
,
455 templ
->template_arguments
);
460 /* Search the template parameters of the function's defining
462 if (SYMBOL_NATURAL_NAME (function
))
464 struct type
*context
;
465 char *name_copy
= xstrdup (SYMBOL_NATURAL_NAME (function
));
466 struct cleanup
*cleanups
= make_cleanup (xfree
, name_copy
);
467 const struct language_defn
*lang
= language_def (language_cplus
);
468 struct gdbarch
*arch
= SYMBOL_SYMTAB (function
)->objfile
->gdbarch
;
469 const struct block
*parent
= BLOCK_SUPERBLOCK (block
);
473 struct symbol
*result
;
474 unsigned int prefix_len
= cp_entire_prefix_len (name_copy
);
480 name_copy
[prefix_len
] = '\0';
481 context
= lookup_typename (lang
, arch
,
490 = search_symbol_list (name
,
491 TYPE_N_TEMPLATE_ARGUMENTS (context
),
492 TYPE_TEMPLATE_ARGUMENTS (context
));
497 do_cleanups (cleanups
);
501 return cp_lookup_symbol_imports (scope
, name
, block
, domain
, 1, 1);
504 /* Searches for NAME in the current namespace, and by applying
505 relevant import statements belonging to BLOCK and its parents.
506 SCOPE is the namespace scope of the context in which the search is
510 cp_lookup_symbol_namespace (const char *scope
,
512 const struct block
*block
,
513 const domain_enum domain
)
517 /* First, try to find the symbol in the given namespace. */
518 sym
= cp_lookup_symbol_in_namespace (scope
, name
,
523 /* Search for name in namespaces imported to this and parent
525 while (block
!= NULL
)
527 sym
= cp_lookup_symbol_imports (scope
, name
, block
,
533 block
= BLOCK_SUPERBLOCK (block
);
539 /* Lookup NAME at namespace scope (or, in C terms, in static and
540 global variables). SCOPE is the namespace that the current
541 function is defined within; only consider namespaces whose length
542 is at least SCOPE_LEN. Other arguments are as in
543 cp_lookup_symbol_nonlocal.
545 For example, if we're within a function A::B::f and looking for a
546 symbol x, this will get called with NAME = "x", SCOPE = "A::B", and
547 SCOPE_LEN = 0. It then calls itself with NAME and SCOPE the same,
548 but with SCOPE_LEN = 1. And then it calls itself with NAME and
549 SCOPE the same, but with SCOPE_LEN = 4. This third call looks for
550 "A::B::x"; if it doesn't find it, then the second call looks for
551 "A::x", and if that call fails, then the first call looks for
554 static struct symbol
*
555 lookup_namespace_scope (const char *name
,
556 const struct block
*block
,
557 const domain_enum domain
,
563 if (scope
[scope_len
] != '\0')
565 /* Recursively search for names in child namespaces first. */
568 int new_scope_len
= scope_len
;
570 /* If the current scope is followed by "::", skip past that. */
571 if (new_scope_len
!= 0)
573 gdb_assert (scope
[new_scope_len
] == ':');
576 new_scope_len
+= cp_find_first_component (scope
+ new_scope_len
);
577 sym
= lookup_namespace_scope (name
, block
, domain
,
578 scope
, new_scope_len
);
583 /* Okay, we didn't find a match in our children, so look for the
584 name in the current namespace. */
586 namespace = alloca (scope_len
+ 1);
587 strncpy (namespace, scope
, scope_len
);
588 namespace[scope_len
] = '\0';
589 return cp_lookup_symbol_in_namespace (namespace, name
,
593 /* Look up NAME in BLOCK's static block and in global blocks. If
594 ANONYMOUS_NAMESPACE is nonzero, the symbol in question is located
595 within an anonymous namespace. Other arguments are as in
596 cp_lookup_symbol_nonlocal. */
598 static struct symbol
*
599 lookup_symbol_file (const char *name
,
600 const struct block
*block
,
601 const domain_enum domain
,
602 int anonymous_namespace
)
604 struct symbol
*sym
= NULL
;
606 sym
= lookup_symbol_static (name
, block
, domain
);
610 if (anonymous_namespace
)
612 /* Symbols defined in anonymous namespaces have external linkage
613 but should be treated as local to a single file nonetheless.
614 So we only search the current file's global block. */
616 const struct block
*global_block
= block_global_block (block
);
618 if (global_block
!= NULL
)
619 sym
= lookup_symbol_aux_block (name
, global_block
, domain
);
623 sym
= lookup_symbol_global (name
, block
, domain
);
629 /* Look up a type named NESTED_NAME that is nested inside the C++
630 class or namespace given by PARENT_TYPE, from within the context
631 given by BLOCK. Return NULL if there is no such nested type. */
634 cp_lookup_nested_type (struct type
*parent_type
,
635 const char *nested_name
,
636 const struct block
*block
)
638 /* type_name_no_tag_required provides better error reporting using the
640 struct type
*saved_parent_type
= parent_type
;
642 CHECK_TYPEDEF (parent_type
);
644 switch (TYPE_CODE (parent_type
))
646 case TYPE_CODE_STRUCT
:
647 case TYPE_CODE_NAMESPACE
:
648 case TYPE_CODE_UNION
:
650 /* NOTE: carlton/2003-11-10: We don't treat C++ class members
651 of classes like, say, data or function members. Instead,
652 they're just represented by symbols whose names are
653 qualified by the name of the surrounding class. This is
654 just like members of namespaces; in particular,
655 lookup_symbol_namespace works when looking them up. */
657 const char *parent_name
= type_name_no_tag_or_error (saved_parent_type
);
659 = cp_lookup_symbol_in_namespace (parent_name
, nested_name
,
661 char *concatenated_name
;
663 if (sym
!= NULL
&& SYMBOL_CLASS (sym
) == LOC_TYPEDEF
)
664 return SYMBOL_TYPE (sym
);
666 /* Now search all static file-level symbols. Not strictly
667 correct, but more useful than an error. We do not try to
668 guess any imported namespace as even the fully specified
669 namespace seach is is already not C++ compliant and more
670 assumptions could make it too magic. */
672 concatenated_name
= alloca (strlen (parent_name
) + 2
673 + strlen (nested_name
) + 1);
674 sprintf (concatenated_name
, "%s::%s",
675 parent_name
, nested_name
);
676 sym
= lookup_static_symbol_aux (concatenated_name
,
678 if (sym
!= NULL
&& SYMBOL_CLASS (sym
) == LOC_TYPEDEF
)
679 return SYMBOL_TYPE (sym
);
684 internal_error (__FILE__
, __LINE__
,
685 _("cp_lookup_nested_type called "
686 "on a non-aggregate type."));
690 /* The C++-version of lookup_transparent_type. */
692 /* FIXME: carlton/2004-01-16: The problem that this is trying to
693 address is that, unfortunately, sometimes NAME is wrong: it may not
694 include the name of namespaces enclosing the type in question.
695 lookup_transparent_type gets called when the type in question
696 is a declaration, and we're trying to find its definition; but, for
697 declarations, our type name deduction mechanism doesn't work.
698 There's nothing we can do to fix this in general, I think, in the
699 absence of debug information about namespaces (I've filed PR
700 gdb/1511 about this); until such debug information becomes more
701 prevalent, one heuristic which sometimes looks is to search for the
702 definition in namespaces containing the current namespace.
704 We should delete this functions once the appropriate debug
705 information becomes more widespread. (GCC 3.4 will be the first
706 released version of GCC with such information.) */
709 cp_lookup_transparent_type (const char *name
)
711 /* First, try the honest way of looking up the definition. */
712 struct type
*t
= basic_lookup_transparent_type (name
);
718 /* If that doesn't work and we're within a namespace, look there
720 scope
= block_scope (get_selected_block (0));
722 if (scope
[0] == '\0')
725 return cp_lookup_transparent_type_loop (name
, scope
, 0);
728 /* Lookup the type definition associated to NAME in namespaces/classes
729 containing SCOPE whose name is strictly longer than LENGTH. LENGTH
730 must be the index of the start of a component of SCOPE. */
733 cp_lookup_transparent_type_loop (const char *name
,
737 int scope_length
= length
+ cp_find_first_component (scope
+ length
);
740 /* If the current scope is followed by "::", look in the next
742 if (scope
[scope_length
] == ':')
745 = cp_lookup_transparent_type_loop (name
, scope
,
752 full_name
= alloca (scope_length
+ 2 + strlen (name
) + 1);
753 strncpy (full_name
, scope
, scope_length
);
754 strncpy (full_name
+ scope_length
, "::", 2);
755 strcpy (full_name
+ scope_length
+ 2, name
);
757 return basic_lookup_transparent_type (full_name
);
760 /* This used to do something but was removed when it became
764 maintenance_cplus_namespace (char *args
, int from_tty
)
766 printf_unfiltered (_("The `maint namespace' command was removed.\n"));
769 /* Provide a prototype to silence -Wmissing-prototypes. */
770 extern initialize_file_ftype _initialize_cp_namespace
;
773 _initialize_cp_namespace (void)
775 struct cmd_list_element
*cmd
;
777 cmd
= add_cmd ("namespace", class_maintenance
,
778 maintenance_cplus_namespace
,
779 _("Deprecated placeholder for removed functionality."),
780 &maint_cplus_cmd_list
);
781 deprecate_cmd (cmd
, NULL
);