1 /* Implementation of the GDB variable objects API.
3 Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007
4 Free Software Foundation, Inc.
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 3 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program. If not, see <http://www.gnu.org/licenses/>. */
20 #include "exceptions.h"
22 #include "expression.h"
29 #include "gdb_assert.h"
30 #include "gdb_string.h"
35 /* Non-zero if we want to see trace of varobj level stuff. */
39 show_varobjdebug (struct ui_file
*file
, int from_tty
,
40 struct cmd_list_element
*c
, const char *value
)
42 fprintf_filtered (file
, _("Varobj debugging is %s.\n"), value
);
45 /* String representations of gdb's format codes */
46 char *varobj_format_string
[] =
47 { "natural", "binary", "decimal", "hexadecimal", "octal" };
49 /* String representations of gdb's known languages */
50 char *varobj_language_string
[] = { "unknown", "C", "C++", "Java" };
54 /* Every root variable has one of these structures saved in its
55 varobj. Members which must be free'd are noted. */
59 /* Alloc'd expression for this parent. */
60 struct expression
*exp
;
62 /* Block for which this expression is valid */
63 struct block
*valid_block
;
65 /* The frame for this expression */
66 struct frame_id frame
;
68 /* If 1, "update" always recomputes the frame & valid block
69 using the currently selected frame. */
70 int use_selected_frame
;
72 /* Flag that indicates validity: set to 0 when this varobj_root refers
73 to symbols that do not exist anymore. */
76 /* Language info for this variable and its children */
77 struct language_specific
*lang
;
79 /* The varobj for this root node. */
80 struct varobj
*rootvar
;
82 /* Next root variable */
83 struct varobj_root
*next
;
86 typedef struct varobj
*varobj_p
;
90 /* Every variable in the system has a structure of this type defined
91 for it. This structure holds all information necessary to manipulate
92 a particular object variable. Members which must be freed are noted. */
96 /* Alloc'd name of the variable for this object.. If this variable is a
97 child, then this name will be the child's source name.
99 /* NOTE: This is the "expression" */
102 /* Alloc'd expression for this child. Can be used to create a
103 root variable corresponding to this child. */
106 /* The alloc'd name for this variable's object. This is here for
107 convenience when constructing this object's children. */
110 /* Index of this variable in its parent or -1 */
113 /* The type of this variable. This can be NULL
114 for artifial variable objects -- currently, the "accessibility"
115 variable objects in C++. */
118 /* The value of this expression or subexpression. A NULL value
119 indicates there was an error getting this value.
120 Invariant: if varobj_value_is_changeable_p (this) is non-zero,
121 the value is either NULL, or not lazy. */
124 /* The number of (immediate) children this variable has */
127 /* If this object is a child, this points to its immediate parent. */
128 struct varobj
*parent
;
130 /* Children of this object. */
131 VEC (varobj_p
) *children
;
133 /* Description of the root variable. Points to root variable for children. */
134 struct varobj_root
*root
;
136 /* The format of the output for this object */
137 enum varobj_display_formats format
;
139 /* Was this variable updated via a varobj_set_value operation */
142 /* Last print value. */
145 /* Is this variable frozen. Frozen variables are never implicitly
146 updated by -var-update *
147 or -var-update <direct-or-indirect-parent>. */
150 /* Is the value of this variable intentionally not fetched? It is
151 not fetched if either the variable is frozen, or any parents is
159 struct cpstack
*next
;
162 /* A list of varobjs */
170 /* Private function prototypes */
172 /* Helper functions for the above subcommands. */
174 static int delete_variable (struct cpstack
**, struct varobj
*, int);
176 static void delete_variable_1 (struct cpstack
**, int *,
177 struct varobj
*, int, int);
179 static int install_variable (struct varobj
*);
181 static void uninstall_variable (struct varobj
*);
183 static struct varobj
*create_child (struct varobj
*, int, char *);
185 /* Utility routines */
187 static struct varobj
*new_variable (void);
189 static struct varobj
*new_root_variable (void);
191 static void free_variable (struct varobj
*var
);
193 static struct cleanup
*make_cleanup_free_variable (struct varobj
*var
);
195 static struct type
*get_type (struct varobj
*var
);
197 static struct type
*get_value_type (struct varobj
*var
);
199 static struct type
*get_target_type (struct type
*);
201 static enum varobj_display_formats
variable_default_display (struct varobj
*);
203 static void cppush (struct cpstack
**pstack
, char *name
);
205 static char *cppop (struct cpstack
**pstack
);
207 static int install_new_value (struct varobj
*var
, struct value
*value
,
210 /* Language-specific routines. */
212 static enum varobj_languages
variable_language (struct varobj
*var
);
214 static int number_of_children (struct varobj
*);
216 static char *name_of_variable (struct varobj
*);
218 static char *name_of_child (struct varobj
*, int);
220 static struct value
*value_of_root (struct varobj
**var_handle
, int *);
222 static struct value
*value_of_child (struct varobj
*parent
, int index
);
224 static int variable_editable (struct varobj
*var
);
226 static char *my_value_of_variable (struct varobj
*var
);
228 static char *value_get_print_value (struct value
*value
,
229 enum varobj_display_formats format
);
231 static int varobj_value_is_changeable_p (struct varobj
*var
);
233 static int is_root_p (struct varobj
*var
);
235 /* C implementation */
237 static int c_number_of_children (struct varobj
*var
);
239 static char *c_name_of_variable (struct varobj
*parent
);
241 static char *c_name_of_child (struct varobj
*parent
, int index
);
243 static char *c_path_expr_of_child (struct varobj
*child
);
245 static struct value
*c_value_of_root (struct varobj
**var_handle
);
247 static struct value
*c_value_of_child (struct varobj
*parent
, int index
);
249 static struct type
*c_type_of_child (struct varobj
*parent
, int index
);
251 static int c_variable_editable (struct varobj
*var
);
253 static char *c_value_of_variable (struct varobj
*var
);
255 /* C++ implementation */
257 static int cplus_number_of_children (struct varobj
*var
);
259 static void cplus_class_num_children (struct type
*type
, int children
[3]);
261 static char *cplus_name_of_variable (struct varobj
*parent
);
263 static char *cplus_name_of_child (struct varobj
*parent
, int index
);
265 static char *cplus_path_expr_of_child (struct varobj
*child
);
267 static struct value
*cplus_value_of_root (struct varobj
**var_handle
);
269 static struct value
*cplus_value_of_child (struct varobj
*parent
, int index
);
271 static struct type
*cplus_type_of_child (struct varobj
*parent
, int index
);
273 static int cplus_variable_editable (struct varobj
*var
);
275 static char *cplus_value_of_variable (struct varobj
*var
);
277 /* Java implementation */
279 static int java_number_of_children (struct varobj
*var
);
281 static char *java_name_of_variable (struct varobj
*parent
);
283 static char *java_name_of_child (struct varobj
*parent
, int index
);
285 static char *java_path_expr_of_child (struct varobj
*child
);
287 static struct value
*java_value_of_root (struct varobj
**var_handle
);
289 static struct value
*java_value_of_child (struct varobj
*parent
, int index
);
291 static struct type
*java_type_of_child (struct varobj
*parent
, int index
);
293 static int java_variable_editable (struct varobj
*var
);
295 static char *java_value_of_variable (struct varobj
*var
);
297 /* The language specific vector */
299 struct language_specific
302 /* The language of this variable */
303 enum varobj_languages language
;
305 /* The number of children of PARENT. */
306 int (*number_of_children
) (struct varobj
* parent
);
308 /* The name (expression) of a root varobj. */
309 char *(*name_of_variable
) (struct varobj
* parent
);
311 /* The name of the INDEX'th child of PARENT. */
312 char *(*name_of_child
) (struct varobj
* parent
, int index
);
314 /* Returns the rooted expression of CHILD, which is a variable
315 obtain that has some parent. */
316 char *(*path_expr_of_child
) (struct varobj
* child
);
318 /* The ``struct value *'' of the root variable ROOT. */
319 struct value
*(*value_of_root
) (struct varobj
** root_handle
);
321 /* The ``struct value *'' of the INDEX'th child of PARENT. */
322 struct value
*(*value_of_child
) (struct varobj
* parent
, int index
);
324 /* The type of the INDEX'th child of PARENT. */
325 struct type
*(*type_of_child
) (struct varobj
* parent
, int index
);
327 /* Is VAR editable? */
328 int (*variable_editable
) (struct varobj
* var
);
330 /* The current value of VAR. */
331 char *(*value_of_variable
) (struct varobj
* var
);
334 /* Array of known source language routines. */
335 static struct language_specific languages
[vlang_end
] = {
336 /* Unknown (try treating as C */
339 c_number_of_children
,
342 c_path_expr_of_child
,
352 c_number_of_children
,
355 c_path_expr_of_child
,
365 cplus_number_of_children
,
366 cplus_name_of_variable
,
368 cplus_path_expr_of_child
,
370 cplus_value_of_child
,
372 cplus_variable_editable
,
373 cplus_value_of_variable
}
378 java_number_of_children
,
379 java_name_of_variable
,
381 java_path_expr_of_child
,
385 java_variable_editable
,
386 java_value_of_variable
}
389 /* A little convenience enum for dealing with C++/Java */
392 v_public
= 0, v_private
, v_protected
397 /* Mappings of varobj_display_formats enums to gdb's format codes */
398 static int format_code
[] = { 0, 't', 'd', 'x', 'o' };
400 /* Header of the list of root variable objects */
401 static struct varobj_root
*rootlist
;
402 static int rootcount
= 0; /* number of root varobjs in the list */
404 /* Prime number indicating the number of buckets in the hash table */
405 /* A prime large enough to avoid too many colisions */
406 #define VAROBJ_TABLE_SIZE 227
408 /* Pointer to the varobj hash table (built at run time) */
409 static struct vlist
**varobj_table
;
411 /* Is the variable X one of our "fake" children? */
412 #define CPLUS_FAKE_CHILD(x) \
413 ((x) != NULL && (x)->type == NULL && (x)->value == NULL)
416 /* API Implementation */
418 is_root_p (struct varobj
*var
)
420 return (var
->root
->rootvar
== var
);
423 /* Creates a varobj (not its children) */
425 /* Return the full FRAME which corresponds to the given CORE_ADDR
426 or NULL if no FRAME on the chain corresponds to CORE_ADDR. */
428 static struct frame_info
*
429 find_frame_addr_in_frame_chain (CORE_ADDR frame_addr
)
431 struct frame_info
*frame
= NULL
;
433 if (frame_addr
== (CORE_ADDR
) 0)
438 frame
= get_prev_frame (frame
);
441 if (get_frame_base_address (frame
) == frame_addr
)
447 varobj_create (char *objname
,
448 char *expression
, CORE_ADDR frame
, enum varobj_type type
)
451 struct frame_info
*fi
;
452 struct frame_info
*old_fi
= NULL
;
454 struct cleanup
*old_chain
;
456 /* Fill out a varobj structure for the (root) variable being constructed. */
457 var
= new_root_variable ();
458 old_chain
= make_cleanup_free_variable (var
);
460 if (expression
!= NULL
)
463 enum varobj_languages lang
;
464 struct value
*value
= NULL
;
467 /* Parse and evaluate the expression, filling in as much
468 of the variable's data as possible */
470 /* Allow creator to specify context of variable */
471 if ((type
== USE_CURRENT_FRAME
) || (type
== USE_SELECTED_FRAME
))
472 fi
= deprecated_safe_get_selected_frame ();
474 /* FIXME: cagney/2002-11-23: This code should be doing a
475 lookup using the frame ID and not just the frame's
476 ``address''. This, of course, means an interface change.
477 However, with out that interface change ISAs, such as the
478 ia64 with its two stacks, won't work. Similar goes for the
479 case where there is a frameless function. */
480 fi
= find_frame_addr_in_frame_chain (frame
);
482 /* frame = -2 means always use selected frame */
483 if (type
== USE_SELECTED_FRAME
)
484 var
->root
->use_selected_frame
= 1;
488 block
= get_frame_block (fi
, 0);
491 innermost_block
= NULL
;
492 /* Wrap the call to parse expression, so we can
493 return a sensible error. */
494 if (!gdb_parse_exp_1 (&p
, block
, 0, &var
->root
->exp
))
499 /* Don't allow variables to be created for types. */
500 if (var
->root
->exp
->elts
[0].opcode
== OP_TYPE
)
502 do_cleanups (old_chain
);
503 fprintf_unfiltered (gdb_stderr
, "Attempt to use a type name"
504 " as an expression.\n");
508 var
->format
= variable_default_display (var
);
509 var
->root
->valid_block
= innermost_block
;
510 expr_len
= strlen (expression
);
511 var
->name
= savestring (expression
, expr_len
);
512 /* For a root var, the name and the expr are the same. */
513 var
->path_expr
= savestring (expression
, expr_len
);
515 /* When the frame is different from the current frame,
516 we must select the appropriate frame before parsing
517 the expression, otherwise the value will not be current.
518 Since select_frame is so benign, just call it for all cases. */
521 var
->root
->frame
= get_frame_id (fi
);
522 old_fi
= get_selected_frame (NULL
);
526 /* We definitively need to catch errors here.
527 If evaluate_expression succeeds we got the value we wanted.
528 But if it fails, we still go on with a call to evaluate_type() */
529 if (!gdb_evaluate_expression (var
->root
->exp
, &value
))
531 /* Error getting the value. Try to at least get the
533 struct value
*type_only_value
= evaluate_type (var
->root
->exp
);
534 var
->type
= value_type (type_only_value
);
537 var
->type
= value_type (value
);
539 install_new_value (var
, value
, 1 /* Initial assignment */);
541 /* Set language info */
542 lang
= variable_language (var
);
543 var
->root
->lang
= &languages
[lang
];
545 /* Set ourselves as our root */
546 var
->root
->rootvar
= var
;
548 /* Reset the selected frame */
550 select_frame (old_fi
);
553 /* If the variable object name is null, that means this
554 is a temporary variable, so don't install it. */
556 if ((var
!= NULL
) && (objname
!= NULL
))
558 var
->obj_name
= savestring (objname
, strlen (objname
));
560 /* If a varobj name is duplicated, the install will fail so
562 if (!install_variable (var
))
564 do_cleanups (old_chain
);
569 discard_cleanups (old_chain
);
573 /* Generates an unique name that can be used for a varobj */
576 varobj_gen_name (void)
581 /* generate a name for this object */
583 obj_name
= xstrprintf ("var%d", id
);
588 /* Given an "objname", returns the pointer to the corresponding varobj
589 or NULL if not found */
592 varobj_get_handle (char *objname
)
596 unsigned int index
= 0;
599 for (chp
= objname
; *chp
; chp
++)
601 index
= (index
+ (i
++ * (unsigned int) *chp
)) % VAROBJ_TABLE_SIZE
;
604 cv
= *(varobj_table
+ index
);
605 while ((cv
!= NULL
) && (strcmp (cv
->var
->obj_name
, objname
) != 0))
609 error (_("Variable object not found"));
614 /* Given the handle, return the name of the object */
617 varobj_get_objname (struct varobj
*var
)
619 return var
->obj_name
;
622 /* Given the handle, return the expression represented by the object */
625 varobj_get_expression (struct varobj
*var
)
627 return name_of_variable (var
);
630 /* Deletes a varobj and all its children if only_children == 0,
631 otherwise deletes only the children; returns a malloc'ed list of all the
632 (malloc'ed) names of the variables that have been deleted (NULL terminated) */
635 varobj_delete (struct varobj
*var
, char ***dellist
, int only_children
)
639 struct cpstack
*result
= NULL
;
642 /* Initialize a stack for temporary results */
643 cppush (&result
, NULL
);
646 /* Delete only the variable children */
647 delcount
= delete_variable (&result
, var
, 1 /* only the children */ );
649 /* Delete the variable and all its children */
650 delcount
= delete_variable (&result
, var
, 0 /* parent+children */ );
652 /* We may have been asked to return a list of what has been deleted */
655 *dellist
= xmalloc ((delcount
+ 1) * sizeof (char *));
659 *cp
= cppop (&result
);
660 while ((*cp
!= NULL
) && (mycount
> 0))
664 *cp
= cppop (&result
);
667 if (mycount
|| (*cp
!= NULL
))
668 warning (_("varobj_delete: assertion failed - mycount(=%d) <> 0"),
675 /* Set/Get variable object display format */
677 enum varobj_display_formats
678 varobj_set_display_format (struct varobj
*var
,
679 enum varobj_display_formats format
)
686 case FORMAT_HEXADECIMAL
:
688 var
->format
= format
;
692 var
->format
= variable_default_display (var
);
698 enum varobj_display_formats
699 varobj_get_display_format (struct varobj
*var
)
705 varobj_set_frozen (struct varobj
*var
, int frozen
)
707 /* When a variable is unfrozen, we don't fetch its value.
708 The 'not_fetched' flag remains set, so next -var-update
711 We don't fetch the value, because for structures the client
712 should do -var-update anyway. It would be bad to have different
713 client-size logic for structure and other types. */
714 var
->frozen
= frozen
;
718 varobj_get_frozen (struct varobj
*var
)
725 varobj_get_num_children (struct varobj
*var
)
727 if (var
->num_children
== -1)
728 var
->num_children
= number_of_children (var
);
730 return var
->num_children
;
733 /* Creates a list of the immediate children of a variable object;
734 the return code is the number of such children or -1 on error */
737 varobj_list_children (struct varobj
*var
, struct varobj
***childlist
)
739 struct varobj
*child
;
743 /* sanity check: have we been passed a pointer? */
744 if (childlist
== NULL
)
749 if (var
->num_children
== -1)
750 var
->num_children
= number_of_children (var
);
752 /* If that failed, give up. */
753 if (var
->num_children
== -1)
756 /* If we're called when the list of children is not yet initialized,
757 allocate enough elements in it. */
758 while (VEC_length (varobj_p
, var
->children
) < var
->num_children
)
759 VEC_safe_push (varobj_p
, var
->children
, NULL
);
761 /* List of children */
762 *childlist
= xmalloc ((var
->num_children
+ 1) * sizeof (struct varobj
*));
764 for (i
= 0; i
< var
->num_children
; i
++)
768 /* Mark as the end in case we bail out */
769 *((*childlist
) + i
) = NULL
;
771 existing
= VEC_index (varobj_p
, var
->children
, i
);
773 if (existing
== NULL
)
775 /* Either it's the first call to varobj_list_children for
776 this variable object, and the child was never created,
777 or it was explicitly deleted by the client. */
778 name
= name_of_child (var
, i
);
779 existing
= create_child (var
, i
, name
);
780 VEC_replace (varobj_p
, var
->children
, i
, existing
);
783 *((*childlist
) + i
) = existing
;
786 /* End of list is marked by a NULL pointer */
787 *((*childlist
) + i
) = NULL
;
789 return var
->num_children
;
792 /* Obtain the type of an object Variable as a string similar to the one gdb
793 prints on the console */
796 varobj_get_type (struct varobj
*var
)
799 struct cleanup
*old_chain
;
804 /* For the "fake" variables, do not return a type. (It's type is
806 Do not return a type for invalid variables as well. */
807 if (CPLUS_FAKE_CHILD (var
) || !var
->root
->is_valid
)
810 stb
= mem_fileopen ();
811 old_chain
= make_cleanup_ui_file_delete (stb
);
813 /* To print the type, we simply create a zero ``struct value *'' and
814 cast it to our type. We then typeprint this variable. */
815 val
= value_zero (var
->type
, not_lval
);
816 type_print (value_type (val
), "", stb
, -1);
818 thetype
= ui_file_xstrdup (stb
, &length
);
819 do_cleanups (old_chain
);
823 /* Obtain the type of an object variable. */
826 varobj_get_gdb_type (struct varobj
*var
)
831 /* Return a pointer to the full rooted expression of varobj VAR.
832 If it has not been computed yet, compute it. */
834 varobj_get_path_expr (struct varobj
*var
)
836 if (var
->path_expr
!= NULL
)
837 return var
->path_expr
;
840 /* For root varobjs, we initialize path_expr
841 when creating varobj, so here it should be
843 gdb_assert (!is_root_p (var
));
844 return (*var
->root
->lang
->path_expr_of_child
) (var
);
848 enum varobj_languages
849 varobj_get_language (struct varobj
*var
)
851 return variable_language (var
);
855 varobj_get_attributes (struct varobj
*var
)
859 if (var
->root
->is_valid
&& variable_editable (var
))
860 /* FIXME: define masks for attributes */
861 attributes
|= 0x00000001; /* Editable */
867 varobj_get_value (struct varobj
*var
)
869 return my_value_of_variable (var
);
872 /* Set the value of an object variable (if it is editable) to the
873 value of the given expression */
874 /* Note: Invokes functions that can call error() */
877 varobj_set_value (struct varobj
*var
, char *expression
)
883 /* The argument "expression" contains the variable's new value.
884 We need to first construct a legal expression for this -- ugh! */
885 /* Does this cover all the bases? */
886 struct expression
*exp
;
888 int saved_input_radix
= input_radix
;
890 if (var
->value
!= NULL
&& variable_editable (var
))
892 char *s
= expression
;
895 input_radix
= 10; /* ALWAYS reset to decimal temporarily */
896 exp
= parse_exp_1 (&s
, 0, 0);
897 if (!gdb_evaluate_expression (exp
, &value
))
899 /* We cannot proceed without a valid expression. */
904 /* All types that are editable must also be changeable. */
905 gdb_assert (varobj_value_is_changeable_p (var
));
907 /* The value of a changeable variable object must not be lazy. */
908 gdb_assert (!value_lazy (var
->value
));
910 /* Need to coerce the input. We want to check if the
911 value of the variable object will be different
912 after assignment, and the first thing value_assign
913 does is coerce the input.
914 For example, if we are assigning an array to a pointer variable we
915 should compare the pointer with the the array's address, not with the
917 value
= coerce_array (value
);
919 /* The new value may be lazy. gdb_value_assign, or
920 rather value_contents, will take care of this.
921 If fetching of the new value will fail, gdb_value_assign
922 with catch the exception. */
923 if (!gdb_value_assign (var
->value
, value
, &val
))
926 /* If the value has changed, record it, so that next -var-update can
927 report this change. If a variable had a value of '1', we've set it
928 to '333' and then set again to '1', when -var-update will report this
929 variable as changed -- because the first assignment has set the
930 'updated' flag. There's no need to optimize that, because return value
931 of -var-update should be considered an approximation. */
932 var
->updated
= install_new_value (var
, val
, 0 /* Compare values. */);
933 input_radix
= saved_input_radix
;
940 /* Returns a malloc'ed list with all root variable objects */
942 varobj_list (struct varobj
***varlist
)
945 struct varobj_root
*croot
;
946 int mycount
= rootcount
;
948 /* Alloc (rootcount + 1) entries for the result */
949 *varlist
= xmalloc ((rootcount
+ 1) * sizeof (struct varobj
*));
953 while ((croot
!= NULL
) && (mycount
> 0))
955 *cv
= croot
->rootvar
;
960 /* Mark the end of the list */
963 if (mycount
|| (croot
!= NULL
))
965 ("varobj_list: assertion failed - wrong tally of root vars (%d:%d)",
971 /* Assign a new value to a variable object. If INITIAL is non-zero,
972 this is the first assignement after the variable object was just
973 created, or changed type. In that case, just assign the value
975 Otherwise, assign the value and if type_changeable returns non-zero,
976 find if the new value is different from the current value.
977 Return 1 if so, and 0 if the values are equal.
979 The VALUE parameter should not be released -- the function will
980 take care of releasing it when needed. */
982 install_new_value (struct varobj
*var
, struct value
*value
, int initial
)
987 int intentionally_not_fetched
= 0;
988 char *print_value
= NULL
;
990 /* We need to know the varobj's type to decide if the value should
991 be fetched or not. C++ fake children (public/protected/private) don't have
993 gdb_assert (var
->type
|| CPLUS_FAKE_CHILD (var
));
994 changeable
= varobj_value_is_changeable_p (var
);
995 need_to_fetch
= changeable
;
997 /* We are not interested in the address of references, and given
998 that in C++ a reference is not rebindable, it cannot
999 meaningfully change. So, get hold of the real value. */
1002 value
= coerce_ref (value
);
1003 release_value (value
);
1006 if (var
->type
&& TYPE_CODE (var
->type
) == TYPE_CODE_UNION
)
1007 /* For unions, we need to fetch the value implicitly because
1008 of implementation of union member fetch. When gdb
1009 creates a value for a field and the value of the enclosing
1010 structure is not lazy, it immediately copies the necessary
1011 bytes from the enclosing values. If the enclosing value is
1012 lazy, the call to value_fetch_lazy on the field will read
1013 the data from memory. For unions, that means we'll read the
1014 same memory more than once, which is not desirable. So
1018 /* The new value might be lazy. If the type is changeable,
1019 that is we'll be comparing values of this type, fetch the
1020 value now. Otherwise, on the next update the old value
1021 will be lazy, which means we've lost that old value. */
1022 if (need_to_fetch
&& value
&& value_lazy (value
))
1024 struct varobj
*parent
= var
->parent
;
1025 int frozen
= var
->frozen
;
1026 for (; !frozen
&& parent
; parent
= parent
->parent
)
1027 frozen
|= parent
->frozen
;
1029 if (frozen
&& initial
)
1031 /* For variables that are frozen, or are children of frozen
1032 variables, we don't do fetch on initial assignment.
1033 For non-initial assignemnt we do the fetch, since it means we're
1034 explicitly asked to compare the new value with the old one. */
1035 intentionally_not_fetched
= 1;
1037 else if (!gdb_value_fetch_lazy (value
))
1039 /* Set the value to NULL, so that for the next -var-update,
1040 we don't try to compare the new value with this value,
1041 that we couldn't even read. */
1046 /* Below, we'll be comparing string rendering of old and new
1047 values. Don't get string rendering if the value is
1048 lazy -- if it is, the code above has decided that the value
1049 should not be fetched. */
1050 if (value
&& !value_lazy (value
))
1051 print_value
= value_get_print_value (value
, var
->format
);
1053 /* If the type is changeable, compare the old and the new values.
1054 If this is the initial assignment, we don't have any old value
1056 if (!initial
&& changeable
)
1058 /* If the value of the varobj was changed by -var-set-value, then the
1059 value in the varobj and in the target is the same. However, that value
1060 is different from the value that the varobj had after the previous
1061 -var-update. So need to the varobj as changed. */
1068 /* Try to compare the values. That requires that both
1069 values are non-lazy. */
1070 if (var
->not_fetched
&& value_lazy (var
->value
))
1072 /* This is a frozen varobj and the value was never read.
1073 Presumably, UI shows some "never read" indicator.
1074 Now that we've fetched the real value, we need to report
1075 this varobj as changed so that UI can show the real
1079 else if (var
->value
== NULL
&& value
== NULL
)
1082 else if (var
->value
== NULL
|| value
== NULL
)
1088 gdb_assert (!value_lazy (var
->value
));
1089 gdb_assert (!value_lazy (value
));
1091 gdb_assert (var
->print_value
!= NULL
&& print_value
!= NULL
);
1092 if (strcmp (var
->print_value
, print_value
) != 0)
1098 /* We must always keep the new value, since children depend on it. */
1099 if (var
->value
!= NULL
&& var
->value
!= value
)
1100 value_free (var
->value
);
1102 if (var
->print_value
)
1103 xfree (var
->print_value
);
1104 var
->print_value
= print_value
;
1105 if (value
&& value_lazy (value
) && intentionally_not_fetched
)
1106 var
->not_fetched
= 1;
1108 var
->not_fetched
= 0;
1111 gdb_assert (!var
->value
|| value_type (var
->value
));
1116 /* Update the values for a variable and its children. This is a
1117 two-pronged attack. First, re-parse the value for the root's
1118 expression to see if it's changed. Then go all the way
1119 through its children, reconstructing them and noting if they've
1122 < 0 for error values, see varobj.h.
1123 Otherwise it is the number of children + parent changed.
1125 The EXPLICIT parameter specifies if this call is result
1126 of MI request to update this specific variable, or
1127 result of implicit -var-update *. For implicit request, we don't
1128 update frozen variables.
1130 NOTE: This function may delete the caller's varobj. If it
1131 returns TYPE_CHANGED, then it has done this and VARP will be modified
1132 to point to the new varobj. */
1135 varobj_update (struct varobj
**varp
, struct varobj
***changelist
,
1139 int type_changed
= 0;
1144 struct varobj
**templist
= NULL
;
1146 VEC (varobj_p
) *stack
= NULL
;
1147 VEC (varobj_p
) *result
= NULL
;
1148 struct frame_id old_fid
;
1149 struct frame_info
*fi
;
1151 /* sanity check: have we been passed a pointer? */
1152 gdb_assert (changelist
);
1154 /* Frozen means frozen -- we don't check for any change in
1155 this varobj, including its going out of scope, or
1156 changing type. One use case for frozen varobjs is
1157 retaining previously evaluated expressions, and we don't
1158 want them to be reevaluated at all. */
1159 if (!explicit && (*varp
)->frozen
)
1162 if (!(*varp
)->root
->is_valid
)
1165 if ((*varp
)->root
->rootvar
== *varp
)
1167 /* Save the selected stack frame, since we will need to change it
1168 in order to evaluate expressions. */
1169 old_fid
= get_frame_id (deprecated_safe_get_selected_frame ());
1171 /* Update the root variable. value_of_root can return NULL
1172 if the variable is no longer around, i.e. we stepped out of
1173 the frame in which a local existed. We are letting the
1174 value_of_root variable dispose of the varobj if the type
1177 new = value_of_root (varp
, &type_changed
);
1179 /* Restore selected frame. */
1180 fi
= frame_find_by_id (old_fid
);
1184 /* If this is a "use_selected_frame" varobj, and its type has changed,
1185 them note that it's changed. */
1187 VEC_safe_push (varobj_p
, result
, *varp
);
1189 if (install_new_value ((*varp
), new, type_changed
))
1191 /* If type_changed is 1, install_new_value will never return
1192 non-zero, so we'll never report the same variable twice. */
1193 gdb_assert (!type_changed
);
1194 VEC_safe_push (varobj_p
, result
, *varp
);
1199 /* This means the varobj itself is out of scope.
1201 VEC_free (varobj_p
, result
);
1202 return NOT_IN_SCOPE
;
1206 VEC_safe_push (varobj_p
, stack
, *varp
);
1208 /* Walk through the children, reconstructing them all. */
1209 while (!VEC_empty (varobj_p
, stack
))
1211 v
= VEC_pop (varobj_p
, stack
);
1213 /* Push any children. Use reverse order so that the first
1214 child is popped from the work stack first, and so
1215 will be added to result first. This does not
1216 affect correctness, just "nicer". */
1217 for (i
= VEC_length (varobj_p
, v
->children
)-1; i
>= 0; --i
)
1219 varobj_p c
= VEC_index (varobj_p
, v
->children
, i
);
1220 /* Child may be NULL if explicitly deleted by -var-delete. */
1221 if (c
!= NULL
&& !c
->frozen
)
1222 VEC_safe_push (varobj_p
, stack
, c
);
1225 /* Update this variable, unless it's a root, which is already
1227 if (v
->root
->rootvar
!= v
)
1229 new = value_of_child (v
->parent
, v
->index
);
1230 if (install_new_value (v
, new, 0 /* type not changed */))
1232 /* Note that it's changed */
1233 VEC_safe_push (varobj_p
, result
, v
);
1239 /* Alloc (changed + 1) list entries. */
1240 changed
= VEC_length (varobj_p
, result
);
1241 *changelist
= xmalloc ((changed
+ 1) * sizeof (struct varobj
*));
1244 for (i
= 0; i
< changed
; ++i
)
1246 *cv
= VEC_index (varobj_p
, result
, i
);
1247 gdb_assert (*cv
!= NULL
);
1252 VEC_free (varobj_p
, stack
);
1253 VEC_free (varobj_p
, result
);
1256 return TYPE_CHANGED
;
1262 /* Helper functions */
1265 * Variable object construction/destruction
1269 delete_variable (struct cpstack
**resultp
, struct varobj
*var
,
1270 int only_children_p
)
1274 delete_variable_1 (resultp
, &delcount
, var
,
1275 only_children_p
, 1 /* remove_from_parent_p */ );
1280 /* Delete the variable object VAR and its children */
1281 /* IMPORTANT NOTE: If we delete a variable which is a child
1282 and the parent is not removed we dump core. It must be always
1283 initially called with remove_from_parent_p set */
1285 delete_variable_1 (struct cpstack
**resultp
, int *delcountp
,
1286 struct varobj
*var
, int only_children_p
,
1287 int remove_from_parent_p
)
1291 /* Delete any children of this variable, too. */
1292 for (i
= 0; i
< VEC_length (varobj_p
, var
->children
); ++i
)
1294 varobj_p child
= VEC_index (varobj_p
, var
->children
, i
);
1297 if (!remove_from_parent_p
)
1298 child
->parent
= NULL
;
1299 delete_variable_1 (resultp
, delcountp
, child
, 0, only_children_p
);
1301 VEC_free (varobj_p
, var
->children
);
1303 /* if we were called to delete only the children we are done here */
1304 if (only_children_p
)
1307 /* Otherwise, add it to the list of deleted ones and proceed to do so */
1308 /* If the name is null, this is a temporary variable, that has not
1309 yet been installed, don't report it, it belongs to the caller... */
1310 if (var
->obj_name
!= NULL
)
1312 cppush (resultp
, xstrdup (var
->obj_name
));
1313 *delcountp
= *delcountp
+ 1;
1316 /* If this variable has a parent, remove it from its parent's list */
1317 /* OPTIMIZATION: if the parent of this variable is also being deleted,
1318 (as indicated by remove_from_parent_p) we don't bother doing an
1319 expensive list search to find the element to remove when we are
1320 discarding the list afterwards */
1321 if ((remove_from_parent_p
) && (var
->parent
!= NULL
))
1323 VEC_replace (varobj_p
, var
->parent
->children
, var
->index
, NULL
);
1326 if (var
->obj_name
!= NULL
)
1327 uninstall_variable (var
);
1329 /* Free memory associated with this variable */
1330 free_variable (var
);
1333 /* Install the given variable VAR with the object name VAR->OBJ_NAME. */
1335 install_variable (struct varobj
*var
)
1338 struct vlist
*newvl
;
1340 unsigned int index
= 0;
1343 for (chp
= var
->obj_name
; *chp
; chp
++)
1345 index
= (index
+ (i
++ * (unsigned int) *chp
)) % VAROBJ_TABLE_SIZE
;
1348 cv
= *(varobj_table
+ index
);
1349 while ((cv
!= NULL
) && (strcmp (cv
->var
->obj_name
, var
->obj_name
) != 0))
1353 error (_("Duplicate variable object name"));
1355 /* Add varobj to hash table */
1356 newvl
= xmalloc (sizeof (struct vlist
));
1357 newvl
->next
= *(varobj_table
+ index
);
1359 *(varobj_table
+ index
) = newvl
;
1361 /* If root, add varobj to root list */
1362 if (is_root_p (var
))
1364 /* Add to list of root variables */
1365 if (rootlist
== NULL
)
1366 var
->root
->next
= NULL
;
1368 var
->root
->next
= rootlist
;
1369 rootlist
= var
->root
;
1376 /* Unistall the object VAR. */
1378 uninstall_variable (struct varobj
*var
)
1382 struct varobj_root
*cr
;
1383 struct varobj_root
*prer
;
1385 unsigned int index
= 0;
1388 /* Remove varobj from hash table */
1389 for (chp
= var
->obj_name
; *chp
; chp
++)
1391 index
= (index
+ (i
++ * (unsigned int) *chp
)) % VAROBJ_TABLE_SIZE
;
1394 cv
= *(varobj_table
+ index
);
1396 while ((cv
!= NULL
) && (strcmp (cv
->var
->obj_name
, var
->obj_name
) != 0))
1403 fprintf_unfiltered (gdb_stdlog
, "Deleting %s\n", var
->obj_name
);
1408 ("Assertion failed: Could not find variable object \"%s\" to delete",
1414 *(varobj_table
+ index
) = cv
->next
;
1416 prev
->next
= cv
->next
;
1420 /* If root, remove varobj from root list */
1421 if (is_root_p (var
))
1423 /* Remove from list of root variables */
1424 if (rootlist
== var
->root
)
1425 rootlist
= var
->root
->next
;
1430 while ((cr
!= NULL
) && (cr
->rootvar
!= var
))
1438 ("Assertion failed: Could not find varobj \"%s\" in root list",
1445 prer
->next
= cr
->next
;
1452 /* Create and install a child of the parent of the given name */
1453 static struct varobj
*
1454 create_child (struct varobj
*parent
, int index
, char *name
)
1456 struct varobj
*child
;
1458 struct value
*value
;
1460 child
= new_variable ();
1462 /* name is allocated by name_of_child */
1464 child
->index
= index
;
1465 value
= value_of_child (parent
, index
);
1466 child
->parent
= parent
;
1467 child
->root
= parent
->root
;
1468 childs_name
= xstrprintf ("%s.%s", parent
->obj_name
, name
);
1469 child
->obj_name
= childs_name
;
1470 install_variable (child
);
1472 /* Compute the type of the child. Must do this before
1473 calling install_new_value. */
1475 /* If the child had no evaluation errors, var->value
1476 will be non-NULL and contain a valid type. */
1477 child
->type
= value_type (value
);
1479 /* Otherwise, we must compute the type. */
1480 child
->type
= (*child
->root
->lang
->type_of_child
) (child
->parent
,
1482 install_new_value (child
, value
, 1);
1489 * Miscellaneous utility functions.
1492 /* Allocate memory and initialize a new variable */
1493 static struct varobj
*
1498 var
= (struct varobj
*) xmalloc (sizeof (struct varobj
));
1500 var
->path_expr
= NULL
;
1501 var
->obj_name
= NULL
;
1505 var
->num_children
= -1;
1507 var
->children
= NULL
;
1511 var
->print_value
= NULL
;
1513 var
->not_fetched
= 0;
1518 /* Allocate memory and initialize a new root variable */
1519 static struct varobj
*
1520 new_root_variable (void)
1522 struct varobj
*var
= new_variable ();
1523 var
->root
= (struct varobj_root
*) xmalloc (sizeof (struct varobj_root
));;
1524 var
->root
->lang
= NULL
;
1525 var
->root
->exp
= NULL
;
1526 var
->root
->valid_block
= NULL
;
1527 var
->root
->frame
= null_frame_id
;
1528 var
->root
->use_selected_frame
= 0;
1529 var
->root
->rootvar
= NULL
;
1530 var
->root
->is_valid
= 1;
1535 /* Free any allocated memory associated with VAR. */
1537 free_variable (struct varobj
*var
)
1539 /* Free the expression if this is a root variable. */
1540 if (is_root_p (var
))
1542 free_current_contents (&var
->root
->exp
);
1547 xfree (var
->obj_name
);
1548 xfree (var
->print_value
);
1549 xfree (var
->path_expr
);
1554 do_free_variable_cleanup (void *var
)
1556 free_variable (var
);
1559 static struct cleanup
*
1560 make_cleanup_free_variable (struct varobj
*var
)
1562 return make_cleanup (do_free_variable_cleanup
, var
);
1565 /* This returns the type of the variable. It also skips past typedefs
1566 to return the real type of the variable.
1568 NOTE: TYPE_TARGET_TYPE should NOT be used anywhere in this file
1569 except within get_target_type and get_type. */
1570 static struct type
*
1571 get_type (struct varobj
*var
)
1577 type
= check_typedef (type
);
1582 /* Return the type of the value that's stored in VAR,
1583 or that would have being stored there if the
1584 value were accessible.
1586 This differs from VAR->type in that VAR->type is always
1587 the true type of the expession in the source language.
1588 The return value of this function is the type we're
1589 actually storing in varobj, and using for displaying
1590 the values and for comparing previous and new values.
1592 For example, top-level references are always stripped. */
1593 static struct type
*
1594 get_value_type (struct varobj
*var
)
1599 type
= value_type (var
->value
);
1603 type
= check_typedef (type
);
1605 if (TYPE_CODE (type
) == TYPE_CODE_REF
)
1606 type
= get_target_type (type
);
1608 type
= check_typedef (type
);
1613 /* This returns the target type (or NULL) of TYPE, also skipping
1614 past typedefs, just like get_type ().
1616 NOTE: TYPE_TARGET_TYPE should NOT be used anywhere in this file
1617 except within get_target_type and get_type. */
1618 static struct type
*
1619 get_target_type (struct type
*type
)
1623 type
= TYPE_TARGET_TYPE (type
);
1625 type
= check_typedef (type
);
1631 /* What is the default display for this variable? We assume that
1632 everything is "natural". Any exceptions? */
1633 static enum varobj_display_formats
1634 variable_default_display (struct varobj
*var
)
1636 return FORMAT_NATURAL
;
1639 /* FIXME: The following should be generic for any pointer */
1641 cppush (struct cpstack
**pstack
, char *name
)
1645 s
= (struct cpstack
*) xmalloc (sizeof (struct cpstack
));
1651 /* FIXME: The following should be generic for any pointer */
1653 cppop (struct cpstack
**pstack
)
1658 if ((*pstack
)->name
== NULL
&& (*pstack
)->next
== NULL
)
1663 *pstack
= (*pstack
)->next
;
1670 * Language-dependencies
1673 /* Common entry points */
1675 /* Get the language of variable VAR. */
1676 static enum varobj_languages
1677 variable_language (struct varobj
*var
)
1679 enum varobj_languages lang
;
1681 switch (var
->root
->exp
->language_defn
->la_language
)
1687 case language_cplus
:
1698 /* Return the number of children for a given variable.
1699 The result of this function is defined by the language
1700 implementation. The number of children returned by this function
1701 is the number of children that the user will see in the variable
1704 number_of_children (struct varobj
*var
)
1706 return (*var
->root
->lang
->number_of_children
) (var
);;
1709 /* What is the expression for the root varobj VAR? Returns a malloc'd string. */
1711 name_of_variable (struct varobj
*var
)
1713 return (*var
->root
->lang
->name_of_variable
) (var
);
1716 /* What is the name of the INDEX'th child of VAR? Returns a malloc'd string. */
1718 name_of_child (struct varobj
*var
, int index
)
1720 return (*var
->root
->lang
->name_of_child
) (var
, index
);
1723 /* What is the ``struct value *'' of the root variable VAR?
1724 TYPE_CHANGED controls what to do if the type of a
1725 use_selected_frame = 1 variable changes. On input,
1726 TYPE_CHANGED = 1 means discard the old varobj, and replace
1727 it with this one. TYPE_CHANGED = 0 means leave it around.
1728 NB: In both cases, var_handle will point to the new varobj,
1729 so if you use TYPE_CHANGED = 0, you will have to stash the
1730 old varobj pointer away somewhere before calling this.
1731 On return, TYPE_CHANGED will be 1 if the type has changed, and
1733 static struct value
*
1734 value_of_root (struct varobj
**var_handle
, int *type_changed
)
1738 if (var_handle
== NULL
)
1743 /* This should really be an exception, since this should
1744 only get called with a root variable. */
1746 if (!is_root_p (var
))
1749 if (var
->root
->use_selected_frame
)
1751 struct varobj
*tmp_var
;
1752 char *old_type
, *new_type
;
1754 tmp_var
= varobj_create (NULL
, var
->name
, (CORE_ADDR
) 0,
1755 USE_SELECTED_FRAME
);
1756 if (tmp_var
== NULL
)
1760 old_type
= varobj_get_type (var
);
1761 new_type
= varobj_get_type (tmp_var
);
1762 if (strcmp (old_type
, new_type
) == 0)
1764 varobj_delete (tmp_var
, NULL
, 0);
1772 savestring (var
->obj_name
, strlen (var
->obj_name
));
1773 varobj_delete (var
, NULL
, 0);
1777 tmp_var
->obj_name
= varobj_gen_name ();
1779 install_variable (tmp_var
);
1780 *var_handle
= tmp_var
;
1792 return (*var
->root
->lang
->value_of_root
) (var_handle
);
1795 /* What is the ``struct value *'' for the INDEX'th child of PARENT? */
1796 static struct value
*
1797 value_of_child (struct varobj
*parent
, int index
)
1799 struct value
*value
;
1801 value
= (*parent
->root
->lang
->value_of_child
) (parent
, index
);
1806 /* Is this variable editable? Use the variable's type to make
1807 this determination. */
1809 variable_editable (struct varobj
*var
)
1811 return (*var
->root
->lang
->variable_editable
) (var
);
1814 /* GDB already has a command called "value_of_variable". Sigh. */
1816 my_value_of_variable (struct varobj
*var
)
1818 if (var
->root
->is_valid
)
1819 return (*var
->root
->lang
->value_of_variable
) (var
);
1825 value_get_print_value (struct value
*value
, enum varobj_display_formats format
)
1828 struct ui_file
*stb
;
1829 struct cleanup
*old_chain
;
1835 stb
= mem_fileopen ();
1836 old_chain
= make_cleanup_ui_file_delete (stb
);
1838 common_val_print (value
, stb
, format_code
[(int) format
], 1, 0, 0);
1839 thevalue
= ui_file_xstrdup (stb
, &dummy
);
1841 do_cleanups (old_chain
);
1845 /* Return non-zero if changes in value of VAR
1846 must be detected and reported by -var-update.
1847 Return zero is -var-update should never report
1848 changes of such values. This makes sense for structures
1849 (since the changes in children values will be reported separately),
1850 or for artifical objects (like 'public' pseudo-field in C++).
1852 Return value of 0 means that gdb need not call value_fetch_lazy
1853 for the value of this variable object. */
1855 varobj_value_is_changeable_p (struct varobj
*var
)
1860 if (CPLUS_FAKE_CHILD (var
))
1863 type
= get_value_type (var
);
1865 switch (TYPE_CODE (type
))
1867 case TYPE_CODE_STRUCT
:
1868 case TYPE_CODE_UNION
:
1869 case TYPE_CODE_ARRAY
:
1880 /* Given the value and the type of a variable object,
1881 adjust the value and type to those necessary
1882 for getting children of the variable object.
1883 This includes dereferencing top-level references
1884 to all types and dereferencing pointers to
1887 Both TYPE and *TYPE should be non-null. VALUE
1888 can be null if we want to only translate type.
1889 *VALUE can be null as well -- if the parent
1892 If WAS_PTR is not NULL, set *WAS_PTR to 0 or 1
1893 depending on whether pointer was deferenced
1894 in this function. */
1896 adjust_value_for_child_access (struct value
**value
,
1900 gdb_assert (type
&& *type
);
1905 *type
= check_typedef (*type
);
1907 /* The type of value stored in varobj, that is passed
1908 to us, is already supposed to be
1909 reference-stripped. */
1911 gdb_assert (TYPE_CODE (*type
) != TYPE_CODE_REF
);
1913 /* Pointers to structures are treated just like
1914 structures when accessing children. Don't
1915 dererences pointers to other types. */
1916 if (TYPE_CODE (*type
) == TYPE_CODE_PTR
)
1918 struct type
*target_type
= get_target_type (*type
);
1919 if (TYPE_CODE (target_type
) == TYPE_CODE_STRUCT
1920 || TYPE_CODE (target_type
) == TYPE_CODE_UNION
)
1922 if (value
&& *value
)
1923 gdb_value_ind (*value
, value
);
1924 *type
= target_type
;
1930 /* The 'get_target_type' function calls check_typedef on
1931 result, so we can immediately check type code. No
1932 need to call check_typedef here. */
1937 c_number_of_children (struct varobj
*var
)
1939 struct type
*type
= get_value_type (var
);
1941 struct type
*target
;
1943 adjust_value_for_child_access (NULL
, &type
, NULL
);
1944 target
= get_target_type (type
);
1946 switch (TYPE_CODE (type
))
1948 case TYPE_CODE_ARRAY
:
1949 if (TYPE_LENGTH (type
) > 0 && TYPE_LENGTH (target
) > 0
1950 && TYPE_ARRAY_UPPER_BOUND_TYPE (type
) != BOUND_CANNOT_BE_DETERMINED
)
1951 children
= TYPE_LENGTH (type
) / TYPE_LENGTH (target
);
1953 /* If we don't know how many elements there are, don't display
1958 case TYPE_CODE_STRUCT
:
1959 case TYPE_CODE_UNION
:
1960 children
= TYPE_NFIELDS (type
);
1964 /* The type here is a pointer to non-struct. Typically, pointers
1965 have one child, except for function ptrs, which have no children,
1966 and except for void*, as we don't know what to show.
1968 We can show char* so we allow it to be dereferenced. If you decide
1969 to test for it, please mind that a little magic is necessary to
1970 properly identify it: char* has TYPE_CODE == TYPE_CODE_INT and
1971 TYPE_NAME == "char" */
1972 if (TYPE_CODE (target
) == TYPE_CODE_FUNC
1973 || TYPE_CODE (target
) == TYPE_CODE_VOID
)
1980 /* Other types have no children */
1988 c_name_of_variable (struct varobj
*parent
)
1990 return savestring (parent
->name
, strlen (parent
->name
));
1993 /* Return the value of element TYPE_INDEX of a structure
1994 value VALUE. VALUE's type should be a structure,
1995 or union, or a typedef to struct/union.
1997 Returns NULL if getting the value fails. Never throws. */
1998 static struct value
*
1999 value_struct_element_index (struct value
*value
, int type_index
)
2001 struct value
*result
= NULL
;
2002 volatile struct gdb_exception e
;
2004 struct type
*type
= value_type (value
);
2005 type
= check_typedef (type
);
2007 gdb_assert (TYPE_CODE (type
) == TYPE_CODE_STRUCT
2008 || TYPE_CODE (type
) == TYPE_CODE_UNION
);
2010 TRY_CATCH (e
, RETURN_MASK_ERROR
)
2012 if (TYPE_FIELD_STATIC (type
, type_index
))
2013 result
= value_static_field (type
, type_index
);
2015 result
= value_primitive_field (value
, 0, type_index
, type
);
2027 /* Obtain the information about child INDEX of the variable
2029 If CNAME is not null, sets *CNAME to the name of the child relative
2031 If CVALUE is not null, sets *CVALUE to the value of the child.
2032 If CTYPE is not null, sets *CTYPE to the type of the child.
2034 If any of CNAME, CVALUE, or CTYPE is not null, but the corresponding
2035 information cannot be determined, set *CNAME, *CVALUE, or *CTYPE
2038 c_describe_child (struct varobj
*parent
, int index
,
2039 char **cname
, struct value
**cvalue
, struct type
**ctype
,
2040 char **cfull_expression
)
2042 struct value
*value
= parent
->value
;
2043 struct type
*type
= get_value_type (parent
);
2044 char *parent_expression
= NULL
;
2053 if (cfull_expression
)
2055 *cfull_expression
= NULL
;
2056 parent_expression
= varobj_get_path_expr (parent
);
2058 adjust_value_for_child_access (&value
, &type
, &was_ptr
);
2060 switch (TYPE_CODE (type
))
2062 case TYPE_CODE_ARRAY
:
2064 *cname
= xstrprintf ("%d", index
2065 + TYPE_LOW_BOUND (TYPE_INDEX_TYPE (type
)));
2067 if (cvalue
&& value
)
2069 int real_index
= index
+ TYPE_LOW_BOUND (TYPE_INDEX_TYPE (type
));
2070 struct value
*indval
=
2071 value_from_longest (builtin_type_int
, (LONGEST
) real_index
);
2072 gdb_value_subscript (value
, indval
, cvalue
);
2076 *ctype
= get_target_type (type
);
2078 if (cfull_expression
)
2079 *cfull_expression
= xstrprintf ("(%s)[%d]", parent_expression
,
2081 + TYPE_LOW_BOUND (TYPE_INDEX_TYPE (type
)));
2086 case TYPE_CODE_STRUCT
:
2087 case TYPE_CODE_UNION
:
2090 char *string
= TYPE_FIELD_NAME (type
, index
);
2091 *cname
= savestring (string
, strlen (string
));
2094 if (cvalue
&& value
)
2096 /* For C, varobj index is the same as type index. */
2097 *cvalue
= value_struct_element_index (value
, index
);
2101 *ctype
= TYPE_FIELD_TYPE (type
, index
);
2103 if (cfull_expression
)
2105 char *join
= was_ptr
? "->" : ".";
2106 *cfull_expression
= xstrprintf ("(%s)%s%s", parent_expression
, join
,
2107 TYPE_FIELD_NAME (type
, index
));
2114 *cname
= xstrprintf ("*%s", parent
->name
);
2116 if (cvalue
&& value
)
2117 gdb_value_ind (value
, cvalue
);
2119 /* Don't use get_target_type because it calls
2120 check_typedef and here, we want to show the true
2121 declared type of the variable. */
2123 *ctype
= TYPE_TARGET_TYPE (type
);
2125 if (cfull_expression
)
2126 *cfull_expression
= xstrprintf ("*(%s)", parent_expression
);
2131 /* This should not happen */
2133 *cname
= xstrdup ("???");
2134 if (cfull_expression
)
2135 *cfull_expression
= xstrdup ("???");
2136 /* Don't set value and type, we don't know then. */
2141 c_name_of_child (struct varobj
*parent
, int index
)
2144 c_describe_child (parent
, index
, &name
, NULL
, NULL
, NULL
);
2149 c_path_expr_of_child (struct varobj
*child
)
2151 c_describe_child (child
->parent
, child
->index
, NULL
, NULL
, NULL
,
2153 return child
->path_expr
;
2156 static struct value
*
2157 c_value_of_root (struct varobj
**var_handle
)
2159 struct value
*new_val
= NULL
;
2160 struct varobj
*var
= *var_handle
;
2161 struct frame_info
*fi
;
2164 /* Only root variables can be updated... */
2165 if (!is_root_p (var
))
2166 /* Not a root var */
2170 /* Determine whether the variable is still around. */
2171 if (var
->root
->valid_block
== NULL
|| var
->root
->use_selected_frame
)
2175 fi
= frame_find_by_id (var
->root
->frame
);
2176 within_scope
= fi
!= NULL
;
2177 /* FIXME: select_frame could fail */
2180 CORE_ADDR pc
= get_frame_pc (fi
);
2181 if (pc
< BLOCK_START (var
->root
->valid_block
) ||
2182 pc
>= BLOCK_END (var
->root
->valid_block
))
2191 /* We need to catch errors here, because if evaluate
2192 expression fails we want to just return NULL. */
2193 gdb_evaluate_expression (var
->root
->exp
, &new_val
);
2200 static struct value
*
2201 c_value_of_child (struct varobj
*parent
, int index
)
2203 struct value
*value
= NULL
;
2204 c_describe_child (parent
, index
, NULL
, &value
, NULL
, NULL
);
2209 static struct type
*
2210 c_type_of_child (struct varobj
*parent
, int index
)
2212 struct type
*type
= NULL
;
2213 c_describe_child (parent
, index
, NULL
, NULL
, &type
, NULL
);
2218 c_variable_editable (struct varobj
*var
)
2220 switch (TYPE_CODE (get_value_type (var
)))
2222 case TYPE_CODE_STRUCT
:
2223 case TYPE_CODE_UNION
:
2224 case TYPE_CODE_ARRAY
:
2225 case TYPE_CODE_FUNC
:
2226 case TYPE_CODE_METHOD
:
2237 c_value_of_variable (struct varobj
*var
)
2239 /* BOGUS: if val_print sees a struct/class, or a reference to one,
2240 it will print out its children instead of "{...}". So we need to
2241 catch that case explicitly. */
2242 struct type
*type
= get_type (var
);
2244 /* Strip top-level references. */
2245 while (TYPE_CODE (type
) == TYPE_CODE_REF
)
2246 type
= check_typedef (TYPE_TARGET_TYPE (type
));
2248 switch (TYPE_CODE (type
))
2250 case TYPE_CODE_STRUCT
:
2251 case TYPE_CODE_UNION
:
2252 return xstrdup ("{...}");
2255 case TYPE_CODE_ARRAY
:
2258 number
= xstrprintf ("[%d]", var
->num_children
);
2265 if (var
->value
== NULL
)
2267 /* This can happen if we attempt to get the value of a struct
2268 member when the parent is an invalid pointer. This is an
2269 error condition, so we should tell the caller. */
2274 if (var
->not_fetched
&& value_lazy (var
->value
))
2275 /* Frozen variable and no value yet. We don't
2276 implicitly fetch the value. MI response will
2277 use empty string for the value, which is OK. */
2280 gdb_assert (varobj_value_is_changeable_p (var
));
2281 gdb_assert (!value_lazy (var
->value
));
2282 return value_get_print_value (var
->value
, var
->format
);
2292 cplus_number_of_children (struct varobj
*var
)
2295 int children
, dont_know
;
2300 if (!CPLUS_FAKE_CHILD (var
))
2302 type
= get_value_type (var
);
2303 adjust_value_for_child_access (NULL
, &type
, NULL
);
2305 if (((TYPE_CODE (type
)) == TYPE_CODE_STRUCT
) ||
2306 ((TYPE_CODE (type
)) == TYPE_CODE_UNION
))
2310 cplus_class_num_children (type
, kids
);
2311 if (kids
[v_public
] != 0)
2313 if (kids
[v_private
] != 0)
2315 if (kids
[v_protected
] != 0)
2318 /* Add any baseclasses */
2319 children
+= TYPE_N_BASECLASSES (type
);
2322 /* FIXME: save children in var */
2329 type
= get_value_type (var
->parent
);
2330 adjust_value_for_child_access (NULL
, &type
, NULL
);
2332 cplus_class_num_children (type
, kids
);
2333 if (strcmp (var
->name
, "public") == 0)
2334 children
= kids
[v_public
];
2335 else if (strcmp (var
->name
, "private") == 0)
2336 children
= kids
[v_private
];
2338 children
= kids
[v_protected
];
2343 children
= c_number_of_children (var
);
2348 /* Compute # of public, private, and protected variables in this class.
2349 That means we need to descend into all baseclasses and find out
2350 how many are there, too. */
2352 cplus_class_num_children (struct type
*type
, int children
[3])
2356 children
[v_public
] = 0;
2357 children
[v_private
] = 0;
2358 children
[v_protected
] = 0;
2360 for (i
= TYPE_N_BASECLASSES (type
); i
< TYPE_NFIELDS (type
); i
++)
2362 /* If we have a virtual table pointer, omit it. */
2363 if (TYPE_VPTR_BASETYPE (type
) == type
&& TYPE_VPTR_FIELDNO (type
) == i
)
2366 if (TYPE_FIELD_PROTECTED (type
, i
))
2367 children
[v_protected
]++;
2368 else if (TYPE_FIELD_PRIVATE (type
, i
))
2369 children
[v_private
]++;
2371 children
[v_public
]++;
2376 cplus_name_of_variable (struct varobj
*parent
)
2378 return c_name_of_variable (parent
);
2381 enum accessibility
{ private_field
, protected_field
, public_field
};
2383 /* Check if field INDEX of TYPE has the specified accessibility.
2384 Return 0 if so and 1 otherwise. */
2386 match_accessibility (struct type
*type
, int index
, enum accessibility acc
)
2388 if (acc
== private_field
&& TYPE_FIELD_PRIVATE (type
, index
))
2390 else if (acc
== protected_field
&& TYPE_FIELD_PROTECTED (type
, index
))
2392 else if (acc
== public_field
&& !TYPE_FIELD_PRIVATE (type
, index
)
2393 && !TYPE_FIELD_PROTECTED (type
, index
))
2400 cplus_describe_child (struct varobj
*parent
, int index
,
2401 char **cname
, struct value
**cvalue
, struct type
**ctype
,
2402 char **cfull_expression
)
2405 struct value
*value
;
2408 char *parent_expression
= NULL
;
2416 if (cfull_expression
)
2417 *cfull_expression
= NULL
;
2419 if (CPLUS_FAKE_CHILD (parent
))
2421 value
= parent
->parent
->value
;
2422 type
= get_value_type (parent
->parent
);
2423 if (cfull_expression
)
2424 parent_expression
= varobj_get_path_expr (parent
->parent
);
2428 value
= parent
->value
;
2429 type
= get_value_type (parent
);
2430 if (cfull_expression
)
2431 parent_expression
= varobj_get_path_expr (parent
);
2434 adjust_value_for_child_access (&value
, &type
, &was_ptr
);
2436 if (TYPE_CODE (type
) == TYPE_CODE_STRUCT
2437 || TYPE_CODE (type
) == TYPE_CODE_STRUCT
)
2439 char *join
= was_ptr
? "->" : ".";
2440 if (CPLUS_FAKE_CHILD (parent
))
2442 /* The fields of the class type are ordered as they
2443 appear in the class. We are given an index for a
2444 particular access control type ("public","protected",
2445 or "private"). We must skip over fields that don't
2446 have the access control we are looking for to properly
2447 find the indexed field. */
2448 int type_index
= TYPE_N_BASECLASSES (type
);
2449 enum accessibility acc
= public_field
;
2450 if (strcmp (parent
->name
, "private") == 0)
2451 acc
= private_field
;
2452 else if (strcmp (parent
->name
, "protected") == 0)
2453 acc
= protected_field
;
2457 if (TYPE_VPTR_BASETYPE (type
) == type
2458 && type_index
== TYPE_VPTR_FIELDNO (type
))
2460 else if (match_accessibility (type
, type_index
, acc
))
2467 *cname
= xstrdup (TYPE_FIELD_NAME (type
, type_index
));
2469 if (cvalue
&& value
)
2470 *cvalue
= value_struct_element_index (value
, type_index
);
2473 *ctype
= TYPE_FIELD_TYPE (type
, type_index
);
2475 if (cfull_expression
)
2476 *cfull_expression
= xstrprintf ("((%s)%s%s)", parent_expression
,
2478 TYPE_FIELD_NAME (type
, type_index
));
2480 else if (index
< TYPE_N_BASECLASSES (type
))
2482 /* This is a baseclass. */
2484 *cname
= xstrdup (TYPE_FIELD_NAME (type
, index
));
2486 if (cvalue
&& value
)
2488 *cvalue
= value_cast (TYPE_FIELD_TYPE (type
, index
), value
);
2489 release_value (*cvalue
);
2494 *ctype
= TYPE_FIELD_TYPE (type
, index
);
2497 if (cfull_expression
)
2499 char *ptr
= was_ptr
? "*" : "";
2500 /* Cast the parent to the base' type. Note that in gdb,
2503 will create an lvalue, for all appearences, so we don't
2504 need to use more fancy:
2507 *cfull_expression
= xstrprintf ("(%s(%s%s) %s)",
2509 TYPE_FIELD_NAME (type
, index
),
2516 char *access
= NULL
;
2518 cplus_class_num_children (type
, children
);
2520 /* Everything beyond the baseclasses can
2521 only be "public", "private", or "protected"
2523 The special "fake" children are always output by varobj in
2524 this order. So if INDEX == 2, it MUST be "protected". */
2525 index
-= TYPE_N_BASECLASSES (type
);
2529 if (children
[v_public
] > 0)
2531 else if (children
[v_private
] > 0)
2534 access
= "protected";
2537 if (children
[v_public
] > 0)
2539 if (children
[v_private
] > 0)
2542 access
= "protected";
2544 else if (children
[v_private
] > 0)
2545 access
= "protected";
2548 /* Must be protected */
2549 access
= "protected";
2556 gdb_assert (access
);
2558 *cname
= xstrdup (access
);
2560 /* Value and type and full expression are null here. */
2565 c_describe_child (parent
, index
, cname
, cvalue
, ctype
, cfull_expression
);
2570 cplus_name_of_child (struct varobj
*parent
, int index
)
2573 cplus_describe_child (parent
, index
, &name
, NULL
, NULL
, NULL
);
2578 cplus_path_expr_of_child (struct varobj
*child
)
2580 cplus_describe_child (child
->parent
, child
->index
, NULL
, NULL
, NULL
,
2582 return child
->path_expr
;
2585 static struct value
*
2586 cplus_value_of_root (struct varobj
**var_handle
)
2588 return c_value_of_root (var_handle
);
2591 static struct value
*
2592 cplus_value_of_child (struct varobj
*parent
, int index
)
2594 struct value
*value
= NULL
;
2595 cplus_describe_child (parent
, index
, NULL
, &value
, NULL
, NULL
);
2599 static struct type
*
2600 cplus_type_of_child (struct varobj
*parent
, int index
)
2602 struct type
*type
= NULL
;
2603 cplus_describe_child (parent
, index
, NULL
, NULL
, &type
, NULL
);
2608 cplus_variable_editable (struct varobj
*var
)
2610 if (CPLUS_FAKE_CHILD (var
))
2613 return c_variable_editable (var
);
2617 cplus_value_of_variable (struct varobj
*var
)
2620 /* If we have one of our special types, don't print out
2622 if (CPLUS_FAKE_CHILD (var
))
2623 return xstrdup ("");
2625 return c_value_of_variable (var
);
2631 java_number_of_children (struct varobj
*var
)
2633 return cplus_number_of_children (var
);
2637 java_name_of_variable (struct varobj
*parent
)
2641 name
= cplus_name_of_variable (parent
);
2642 /* If the name has "-" in it, it is because we
2643 needed to escape periods in the name... */
2646 while (*p
!= '\000')
2657 java_name_of_child (struct varobj
*parent
, int index
)
2661 name
= cplus_name_of_child (parent
, index
);
2662 /* Escape any periods in the name... */
2665 while (*p
!= '\000')
2676 java_path_expr_of_child (struct varobj
*child
)
2681 static struct value
*
2682 java_value_of_root (struct varobj
**var_handle
)
2684 return cplus_value_of_root (var_handle
);
2687 static struct value
*
2688 java_value_of_child (struct varobj
*parent
, int index
)
2690 return cplus_value_of_child (parent
, index
);
2693 static struct type
*
2694 java_type_of_child (struct varobj
*parent
, int index
)
2696 return cplus_type_of_child (parent
, index
);
2700 java_variable_editable (struct varobj
*var
)
2702 return cplus_variable_editable (var
);
2706 java_value_of_variable (struct varobj
*var
)
2708 return cplus_value_of_variable (var
);
2711 extern void _initialize_varobj (void);
2713 _initialize_varobj (void)
2715 int sizeof_table
= sizeof (struct vlist
*) * VAROBJ_TABLE_SIZE
;
2717 varobj_table
= xmalloc (sizeof_table
);
2718 memset (varobj_table
, 0, sizeof_table
);
2720 add_setshow_zinteger_cmd ("debugvarobj", class_maintenance
,
2722 Set varobj debugging."), _("\
2723 Show varobj debugging."), _("\
2724 When non-zero, varobj debugging is enabled."),
2727 &setlist
, &showlist
);
2730 /* Invalidate the varobjs that are tied to locals and re-create the ones that
2731 are defined on globals.
2732 Invalidated varobjs will be always printed in_scope="invalid". */
2734 varobj_invalidate (void)
2736 struct varobj
**all_rootvarobj
;
2737 struct varobj
**varp
;
2739 if (varobj_list (&all_rootvarobj
) > 0)
2741 varp
= all_rootvarobj
;
2742 while (*varp
!= NULL
)
2744 /* global var must be re-evaluated. */
2745 if ((*varp
)->root
->valid_block
== NULL
)
2747 struct varobj
*tmp_var
;
2749 /* Try to create a varobj with same expression. If we succeed replace
2750 the old varobj, otherwise invalidate it. */
2751 tmp_var
= varobj_create (NULL
, (*varp
)->name
, (CORE_ADDR
) 0, USE_CURRENT_FRAME
);
2752 if (tmp_var
!= NULL
)
2754 tmp_var
->obj_name
= xstrdup ((*varp
)->obj_name
);
2755 varobj_delete (*varp
, NULL
, 0);
2756 install_variable (tmp_var
);
2759 (*varp
)->root
->is_valid
= 0;
2761 else /* locals must be invalidated. */
2762 (*varp
)->root
->is_valid
= 0;
2766 xfree (all_rootvarobj
);