1 /* varobj support for C and C++.
3 Copyright (C) 1999-2019 Free Software Foundation, Inc.
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 3 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>. */
21 #include "gdbthread.h"
24 static void cplus_class_num_children (struct type
*type
, int children
[3]);
26 /* The names of varobjs representing anonymous structs or unions. */
27 #define ANONYMOUS_STRUCT_NAME _("<anonymous struct>")
28 #define ANONYMOUS_UNION_NAME _("<anonymous union>")
30 /* Does CHILD represent a child with no name? This happens when
31 the child is an anonymous struct or union and it has no field name
32 in its parent variable.
34 This has already been determined by *_describe_child. The easiest
35 thing to do is to compare the child's name with ANONYMOUS_*_NAME. */
38 varobj_is_anonymous_child (const struct varobj
*child
)
40 return (child
->name
== ANONYMOUS_STRUCT_NAME
41 || child
->name
== ANONYMOUS_UNION_NAME
);
44 /* Given the value and the type of a variable object,
45 adjust the value and type to those necessary
46 for getting children of the variable object.
47 This includes dereferencing top-level references
48 to all types and dereferencing pointers to
51 If LOOKUP_ACTUAL_TYPE is set the enclosing type of the
52 value will be fetched and if it differs from static type
53 the value will be casted to it.
55 Both TYPE and *TYPE should be non-null. VALUE
56 can be null if we want to only translate type.
57 *VALUE can be null as well -- if the parent
60 If WAS_PTR is not NULL, set *WAS_PTR to 0 or 1
61 depending on whether pointer was dereferenced
65 adjust_value_for_child_access (struct value
**value
,
68 int lookup_actual_type
)
70 gdb_assert (type
&& *type
);
75 *type
= check_typedef (*type
);
77 /* The type of value stored in varobj, that is passed
78 to us, is already supposed to be
79 reference-stripped. */
81 gdb_assert (!TYPE_IS_REFERENCE (*type
));
83 /* Pointers to structures are treated just like
84 structures when accessing children. Don't
85 dereference pointers to other types. */
86 if (TYPE_CODE (*type
) == TYPE_CODE_PTR
)
88 struct type
*target_type
= get_target_type (*type
);
89 if (TYPE_CODE (target_type
) == TYPE_CODE_STRUCT
90 || TYPE_CODE (target_type
) == TYPE_CODE_UNION
)
97 *value
= value_ind (*value
);
100 catch (const gdb_exception_error
&except
)
111 /* The 'get_target_type' function calls check_typedef on
112 result, so we can immediately check type code. No
113 need to call check_typedef here. */
115 /* Access a real type of the value (if necessary and possible). */
116 if (value
&& *value
&& lookup_actual_type
)
118 struct type
*enclosing_type
;
119 int real_type_found
= 0;
121 enclosing_type
= value_actual_type (*value
, 1, &real_type_found
);
124 *type
= enclosing_type
;
125 *value
= value_cast (enclosing_type
, *value
);
130 /* Is VAR a path expression parent, i.e., can it be used to construct
131 a valid path expression? */
134 c_is_path_expr_parent (const struct varobj
*var
)
138 /* "Fake" children are not path_expr parents. */
139 if (CPLUS_FAKE_CHILD (var
))
142 type
= varobj_get_gdb_type (var
);
144 /* Anonymous unions and structs are also not path_expr parents. */
145 if ((TYPE_CODE (type
) == TYPE_CODE_STRUCT
146 || TYPE_CODE (type
) == TYPE_CODE_UNION
)
147 && TYPE_NAME (type
) == NULL
)
149 const struct varobj
*parent
= var
->parent
;
151 while (parent
!= NULL
&& CPLUS_FAKE_CHILD (parent
))
152 parent
= parent
->parent
;
156 struct type
*parent_type
;
159 parent_type
= varobj_get_value_type (parent
);
160 adjust_value_for_child_access (NULL
, &parent_type
, &was_ptr
, 0);
162 if (TYPE_CODE (parent_type
) == TYPE_CODE_STRUCT
163 || TYPE_CODE (parent_type
) == TYPE_CODE_UNION
)
165 const char *field_name
;
167 gdb_assert (var
->index
< TYPE_NFIELDS (parent_type
));
168 field_name
= TYPE_FIELD_NAME (parent_type
, var
->index
);
169 return !(field_name
== NULL
|| *field_name
== '\0');
182 c_number_of_children (const struct varobj
*var
)
184 struct type
*type
= varobj_get_value_type (var
);
188 adjust_value_for_child_access (NULL
, &type
, NULL
, 0);
189 target
= get_target_type (type
);
191 switch (TYPE_CODE (type
))
193 case TYPE_CODE_ARRAY
:
194 if (TYPE_LENGTH (type
) > 0 && TYPE_LENGTH (target
) > 0
195 && !TYPE_ARRAY_UPPER_BOUND_IS_UNDEFINED (type
))
196 children
= TYPE_LENGTH (type
) / TYPE_LENGTH (target
);
198 /* If we don't know how many elements there are, don't display
203 case TYPE_CODE_STRUCT
:
204 case TYPE_CODE_UNION
:
205 children
= TYPE_NFIELDS (type
);
209 /* The type here is a pointer to non-struct. Typically, pointers
210 have one child, except for function ptrs, which have no children,
211 and except for void*, as we don't know what to show.
213 We can show char* so we allow it to be dereferenced. If you decide
214 to test for it, please mind that a little magic is necessary to
215 properly identify it: char* has TYPE_CODE == TYPE_CODE_INT and
216 TYPE_NAME == "char". */
217 if (TYPE_CODE (target
) == TYPE_CODE_FUNC
218 || TYPE_CODE (target
) == TYPE_CODE_VOID
)
225 /* Other types have no children. */
233 c_name_of_variable (const struct varobj
*parent
)
238 /* Return the value of element TYPE_INDEX of a structure
239 value VALUE. VALUE's type should be a structure,
240 or union, or a typedef to struct/union.
242 Returns NULL if getting the value fails. Never throws. */
244 static struct value
*
245 value_struct_element_index (struct value
*value
, int type_index
)
247 struct value
*result
= NULL
;
248 struct type
*type
= value_type (value
);
250 type
= check_typedef (type
);
252 gdb_assert (TYPE_CODE (type
) == TYPE_CODE_STRUCT
253 || TYPE_CODE (type
) == TYPE_CODE_UNION
);
257 if (field_is_static (&TYPE_FIELD (type
, type_index
)))
258 result
= value_static_field (type
, type_index
);
260 result
= value_primitive_field (value
, 0, type_index
, type
);
262 catch (const gdb_exception_error
&e
)
270 /* Obtain the information about child INDEX of the variable
272 If CNAME is not null, sets *CNAME to the name of the child relative
274 If CVALUE is not null, sets *CVALUE to the value of the child.
275 If CTYPE is not null, sets *CTYPE to the type of the child.
277 If any of CNAME, CVALUE, or CTYPE is not null, but the corresponding
278 information cannot be determined, set *CNAME, *CVALUE, or *CTYPE
282 c_describe_child (const struct varobj
*parent
, int index
,
283 std::string
*cname
, struct value
**cvalue
,
284 struct type
**ctype
, std::string
*cfull_expression
)
286 struct value
*value
= parent
->value
.get ();
287 struct type
*type
= varobj_get_value_type (parent
);
288 std::string parent_expression
;
292 *cname
= std::string ();
297 if (cfull_expression
)
299 *cfull_expression
= std::string ();
301 = varobj_get_path_expr (varobj_get_path_expr_parent (parent
));
303 adjust_value_for_child_access (&value
, &type
, &was_ptr
, 0);
305 switch (TYPE_CODE (type
))
307 case TYPE_CODE_ARRAY
:
309 *cname
= int_string (index
310 + TYPE_LOW_BOUND (TYPE_INDEX_TYPE (type
)),
315 int real_index
= index
+ TYPE_LOW_BOUND (TYPE_INDEX_TYPE (type
));
319 *cvalue
= value_subscript (value
, real_index
);
321 catch (const gdb_exception_error
&except
)
327 *ctype
= get_target_type (type
);
329 if (cfull_expression
)
331 string_printf ("(%s)[%s]", parent_expression
.c_str (),
333 + TYPE_LOW_BOUND (TYPE_INDEX_TYPE (type
)),
339 case TYPE_CODE_STRUCT
:
340 case TYPE_CODE_UNION
:
342 const char *field_name
;
344 /* If the type is anonymous and the field has no name,
345 set an appropriate name. */
346 field_name
= TYPE_FIELD_NAME (type
, index
);
347 if (field_name
== NULL
|| *field_name
== '\0')
351 if (TYPE_CODE (TYPE_FIELD_TYPE (type
, index
))
353 *cname
= ANONYMOUS_STRUCT_NAME
;
355 *cname
= ANONYMOUS_UNION_NAME
;
358 if (cfull_expression
)
359 *cfull_expression
= "";
366 if (cfull_expression
)
368 const char *join
= was_ptr
? "->" : ".";
370 *cfull_expression
= string_printf ("(%s)%s%s",
371 parent_expression
.c_str (),
378 /* For C, varobj index is the same as type index. */
379 *cvalue
= value_struct_element_index (value
, index
);
383 *ctype
= TYPE_FIELD_TYPE (type
, index
);
389 *cname
= string_printf ("*%s", parent
->name
.c_str ());
395 *cvalue
= value_ind (value
);
398 catch (const gdb_exception_error
&except
)
404 /* Don't use get_target_type because it calls
405 check_typedef and here, we want to show the true
406 declared type of the variable. */
408 *ctype
= TYPE_TARGET_TYPE (type
);
410 if (cfull_expression
)
411 *cfull_expression
= string_printf ("*(%s)", parent_expression
.c_str ());
415 /* This should not happen. */
418 if (cfull_expression
)
419 *cfull_expression
= "???";
420 /* Don't set value and type, we don't know then. */
425 c_name_of_child (const struct varobj
*parent
, int index
)
429 c_describe_child (parent
, index
, &name
, NULL
, NULL
, NULL
);
434 c_path_expr_of_child (const struct varobj
*child
)
436 std::string path_expr
;
438 c_describe_child (child
->parent
, child
->index
, NULL
, NULL
, NULL
,
443 static struct value
*
444 c_value_of_child (const struct varobj
*parent
, int index
)
446 struct value
*value
= NULL
;
448 c_describe_child (parent
, index
, NULL
, &value
, NULL
, NULL
);
453 c_type_of_child (const struct varobj
*parent
, int index
)
455 struct type
*type
= NULL
;
457 c_describe_child (parent
, index
, NULL
, NULL
, &type
, NULL
);
461 /* This returns the type of the variable. It also skips past typedefs
462 to return the real type of the variable. */
465 get_type (const struct varobj
*var
)
471 type
= check_typedef (type
);
477 c_value_of_variable (const struct varobj
*var
,
478 enum varobj_display_formats format
)
480 /* BOGUS: if val_print sees a struct/class, or a reference to one,
481 it will print out its children instead of "{...}". So we need to
482 catch that case explicitly. */
483 struct type
*type
= get_type (var
);
485 /* Strip top-level references. */
486 while (TYPE_IS_REFERENCE (type
))
487 type
= check_typedef (TYPE_TARGET_TYPE (type
));
489 switch (TYPE_CODE (type
))
491 case TYPE_CODE_STRUCT
:
492 case TYPE_CODE_UNION
:
496 case TYPE_CODE_ARRAY
:
497 return string_printf ("[%d]", var
->num_children
);
502 if (var
->value
== NULL
)
504 /* This can happen if we attempt to get the value of a struct
505 member when the parent is an invalid pointer. This is an
506 error condition, so we should tell the caller. */
507 return std::string ();
511 if (var
->not_fetched
&& value_lazy (var
->value
.get ()))
512 /* Frozen variable and no value yet. We don't
513 implicitly fetch the value. MI response will
514 use empty string for the value, which is OK. */
515 return std::string ();
517 gdb_assert (varobj_value_is_changeable_p (var
));
518 gdb_assert (!value_lazy (var
->value
.get ()));
520 /* If the specified format is the current one,
521 we can reuse print_value. */
522 if (format
== var
->format
)
523 return var
->print_value
;
525 return varobj_value_get_print_value (var
->value
.get (), format
,
533 /* varobj operations for c. */
535 const struct lang_varobj_ops c_varobj_ops
=
537 c_number_of_children
,
540 c_path_expr_of_child
,
544 varobj_default_value_is_changeable_p
,
545 NULL
, /* value_has_mutated */
546 c_is_path_expr_parent
/* is_path_expr_parent */
549 /* A little convenience enum for dealing with C++. */
552 v_public
= 0, v_private
, v_protected
558 cplus_number_of_children (const struct varobj
*var
)
560 struct value
*value
= NULL
;
562 int children
, dont_know
;
563 int lookup_actual_type
= 0;
564 struct value_print_options opts
;
569 get_user_print_options (&opts
);
571 if (!CPLUS_FAKE_CHILD (var
))
573 type
= varobj_get_value_type (var
);
575 /* It is necessary to access a real type (via RTTI). */
576 if (opts
.objectprint
)
578 value
= var
->value
.get ();
579 lookup_actual_type
= (TYPE_IS_REFERENCE (var
->type
)
580 || TYPE_CODE (var
->type
) == TYPE_CODE_PTR
);
582 adjust_value_for_child_access (&value
, &type
, NULL
, lookup_actual_type
);
584 if (((TYPE_CODE (type
)) == TYPE_CODE_STRUCT
)
585 || ((TYPE_CODE (type
)) == TYPE_CODE_UNION
))
589 cplus_class_num_children (type
, kids
);
590 if (kids
[v_public
] != 0)
592 if (kids
[v_private
] != 0)
594 if (kids
[v_protected
] != 0)
597 /* Add any baseclasses. */
598 children
+= TYPE_N_BASECLASSES (type
);
601 /* FIXME: save children in var. */
608 type
= varobj_get_value_type (var
->parent
);
610 /* It is necessary to access a real type (via RTTI). */
611 if (opts
.objectprint
)
613 const struct varobj
*parent
= var
->parent
;
615 value
= parent
->value
.get ();
616 lookup_actual_type
= (TYPE_IS_REFERENCE (parent
->type
)
617 || TYPE_CODE (parent
->type
) == TYPE_CODE_PTR
);
619 adjust_value_for_child_access (&value
, &type
, NULL
, lookup_actual_type
);
621 cplus_class_num_children (type
, kids
);
622 if (var
->name
== "public")
623 children
= kids
[v_public
];
624 else if (var
->name
== "private")
625 children
= kids
[v_private
];
627 children
= kids
[v_protected
];
632 children
= c_number_of_children (var
);
637 /* Compute # of public, private, and protected variables in this class.
638 That means we need to descend into all baseclasses and find out
639 how many are there, too. */
642 cplus_class_num_children (struct type
*type
, int children
[3])
645 struct type
*basetype
= NULL
;
647 children
[v_public
] = 0;
648 children
[v_private
] = 0;
649 children
[v_protected
] = 0;
651 vptr_fieldno
= get_vptr_fieldno (type
, &basetype
);
652 for (i
= TYPE_N_BASECLASSES (type
); i
< TYPE_NFIELDS (type
); i
++)
654 /* If we have a virtual table pointer, omit it. Even if virtual
655 table pointers are not specifically marked in the debug info,
656 they should be artificial. */
657 if ((type
== basetype
&& i
== vptr_fieldno
)
658 || TYPE_FIELD_ARTIFICIAL (type
, i
))
661 if (TYPE_FIELD_PROTECTED (type
, i
))
662 children
[v_protected
]++;
663 else if (TYPE_FIELD_PRIVATE (type
, i
))
664 children
[v_private
]++;
666 children
[v_public
]++;
671 cplus_name_of_variable (const struct varobj
*parent
)
673 return c_name_of_variable (parent
);
676 enum accessibility
{ private_field
, protected_field
, public_field
};
678 /* Check if field INDEX of TYPE has the specified accessibility.
679 Return 0 if so and 1 otherwise. */
682 match_accessibility (struct type
*type
, int index
, enum accessibility acc
)
684 if (acc
== private_field
&& TYPE_FIELD_PRIVATE (type
, index
))
686 else if (acc
== protected_field
&& TYPE_FIELD_PROTECTED (type
, index
))
688 else if (acc
== public_field
&& !TYPE_FIELD_PRIVATE (type
, index
)
689 && !TYPE_FIELD_PROTECTED (type
, index
))
696 cplus_describe_child (const struct varobj
*parent
, int index
,
697 std::string
*cname
, struct value
**cvalue
, struct type
**ctype
,
698 std::string
*cfull_expression
)
703 int lookup_actual_type
= 0;
704 const char *parent_expression
= NULL
;
705 const struct varobj
*var
;
706 struct value_print_options opts
;
709 *cname
= std::string ();
714 if (cfull_expression
)
715 *cfull_expression
= std::string ();
717 get_user_print_options (&opts
);
719 var
= (CPLUS_FAKE_CHILD (parent
)) ? parent
->parent
: parent
;
720 if (opts
.objectprint
)
721 lookup_actual_type
= (TYPE_IS_REFERENCE (var
->type
)
722 || TYPE_CODE (var
->type
) == TYPE_CODE_PTR
);
723 value
= var
->value
.get ();
724 type
= varobj_get_value_type (var
);
725 if (cfull_expression
)
727 = varobj_get_path_expr (varobj_get_path_expr_parent (var
));
729 adjust_value_for_child_access (&value
, &type
, &was_ptr
, lookup_actual_type
);
731 if (TYPE_CODE (type
) == TYPE_CODE_STRUCT
732 || TYPE_CODE (type
) == TYPE_CODE_UNION
)
734 const char *join
= was_ptr
? "->" : ".";
736 if (CPLUS_FAKE_CHILD (parent
))
738 /* The fields of the class type are ordered as they
739 appear in the class. We are given an index for a
740 particular access control type ("public","protected",
741 or "private"). We must skip over fields that don't
742 have the access control we are looking for to properly
743 find the indexed field. */
744 int type_index
= TYPE_N_BASECLASSES (type
);
745 enum accessibility acc
= public_field
;
747 struct type
*basetype
= NULL
;
748 const char *field_name
;
750 vptr_fieldno
= get_vptr_fieldno (type
, &basetype
);
751 if (parent
->name
== "private")
753 else if (parent
->name
== "protected")
754 acc
= protected_field
;
758 if ((type
== basetype
&& type_index
== vptr_fieldno
)
759 || TYPE_FIELD_ARTIFICIAL (type
, type_index
))
761 else if (match_accessibility (type
, type_index
, acc
))
767 /* If the type is anonymous and the field has no name,
768 set an appropriate name. */
769 field_name
= TYPE_FIELD_NAME (type
, type_index
);
770 if (field_name
== NULL
|| *field_name
== '\0')
774 if (TYPE_CODE (TYPE_FIELD_TYPE (type
, type_index
))
776 *cname
= ANONYMOUS_STRUCT_NAME
;
777 else if (TYPE_CODE (TYPE_FIELD_TYPE (type
, type_index
))
779 *cname
= ANONYMOUS_UNION_NAME
;
782 if (cfull_expression
)
783 *cfull_expression
= std::string ();
788 *cname
= TYPE_FIELD_NAME (type
, type_index
);
790 if (cfull_expression
)
792 = string_printf ("((%s)%s%s)", parent_expression
, join
,
797 *cvalue
= value_struct_element_index (value
, type_index
);
800 *ctype
= TYPE_FIELD_TYPE (type
, type_index
);
802 else if (index
< TYPE_N_BASECLASSES (type
))
804 /* This is a baseclass. */
806 *cname
= TYPE_FIELD_NAME (type
, index
);
809 *cvalue
= value_cast (TYPE_FIELD_TYPE (type
, index
), value
);
813 *ctype
= TYPE_FIELD_TYPE (type
, index
);
816 if (cfull_expression
)
818 const char *ptr
= was_ptr
? "*" : "";
820 /* Cast the parent to the base' type. Note that in gdb,
823 will create an lvalue, for all appearences, so we don't
824 need to use more fancy:
828 When we are in the scope of the base class or of one
829 of its children, the type field name will be interpreted
830 as a constructor, if it exists. Therefore, we must
831 indicate that the name is a class name by using the
832 'class' keyword. See PR mi/11912 */
833 *cfull_expression
= string_printf ("(%s(class %s%s) %s)",
835 TYPE_FIELD_NAME (type
, index
),
842 const char *access
= NULL
;
845 cplus_class_num_children (type
, children
);
847 /* Everything beyond the baseclasses can
848 only be "public", "private", or "protected"
850 The special "fake" children are always output by varobj in
851 this order. So if INDEX == 2, it MUST be "protected". */
852 index
-= TYPE_N_BASECLASSES (type
);
856 if (children
[v_public
] > 0)
858 else if (children
[v_private
] > 0)
861 access
= "protected";
864 if (children
[v_public
] > 0)
866 if (children
[v_private
] > 0)
869 access
= "protected";
871 else if (children
[v_private
] > 0)
872 access
= "protected";
875 /* Must be protected. */
876 access
= "protected";
887 /* Value and type and full expression are null here. */
892 c_describe_child (parent
, index
, cname
, cvalue
, ctype
, cfull_expression
);
897 cplus_name_of_child (const struct varobj
*parent
, int index
)
901 cplus_describe_child (parent
, index
, &name
, NULL
, NULL
, NULL
);
906 cplus_path_expr_of_child (const struct varobj
*child
)
908 std::string path_expr
;
910 cplus_describe_child (child
->parent
, child
->index
, NULL
, NULL
, NULL
,
915 static struct value
*
916 cplus_value_of_child (const struct varobj
*parent
, int index
)
918 struct value
*value
= NULL
;
920 cplus_describe_child (parent
, index
, NULL
, &value
, NULL
, NULL
);
925 cplus_type_of_child (const struct varobj
*parent
, int index
)
927 struct type
*type
= NULL
;
929 cplus_describe_child (parent
, index
, NULL
, NULL
, &type
, NULL
);
934 cplus_value_of_variable (const struct varobj
*var
,
935 enum varobj_display_formats format
)
938 /* If we have one of our special types, don't print out
940 if (CPLUS_FAKE_CHILD (var
))
941 return std::string ();
943 return c_value_of_variable (var
, format
);
947 /* varobj operations for c++. */
949 const struct lang_varobj_ops cplus_varobj_ops
=
951 cplus_number_of_children
,
952 cplus_name_of_variable
,
954 cplus_path_expr_of_child
,
955 cplus_value_of_child
,
957 cplus_value_of_variable
,
958 varobj_default_value_is_changeable_p
,
959 NULL
, /* value_has_mutated */
960 c_is_path_expr_parent
/* is_path_expr_parent */