1 /* Implementation of the GDB variable objects API.
3 Copyright (C) 1999-2015 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/>. */
20 #include "expression.h"
26 #include "gdb_regex.h"
30 #include "gdbthread.h"
32 #include "varobj-iter.h"
35 #include "python/python.h"
36 #include "python/python-internal.h"
41 /* Non-zero if we want to see trace of varobj level stuff. */
43 unsigned int varobjdebug = 0;
45 show_varobjdebug (struct ui_file *file, int from_tty,
46 struct cmd_list_element *c, const char *value)
48 fprintf_filtered (file, _("Varobj debugging is %s.\n"), value);
51 /* String representations of gdb's format codes. */
52 char *varobj_format_string[] =
53 { "natural", "binary", "decimal", "hexadecimal", "octal" };
55 /* True if we want to allow Python-based pretty-printing. */
56 static int pretty_printing = 0;
59 varobj_enable_pretty_printing (void)
66 /* Every root variable has one of these structures saved in its
67 varobj. Members which must be free'd are noted. */
71 /* Alloc'd expression for this parent. */
72 struct expression *exp;
74 /* Block for which this expression is valid. */
75 const struct block *valid_block;
77 /* The frame for this expression. This field is set iff valid_block is
79 struct frame_id frame;
81 /* The thread ID that this varobj_root belong to. This field
82 is only valid if valid_block is not NULL.
83 When not 0, indicates which thread 'frame' belongs to.
84 When 0, indicates that the thread list was empty when the varobj_root
88 /* If 1, the -var-update always recomputes the value in the
89 current thread and frame. Otherwise, variable object is
90 always updated in the specific scope/thread/frame. */
93 /* Flag that indicates validity: set to 0 when this varobj_root refers
94 to symbols that do not exist anymore. */
97 /* Language-related operations for this variable and its
99 const struct lang_varobj_ops *lang_ops;
101 /* The varobj for this root node. */
102 struct varobj *rootvar;
104 /* Next root variable */
105 struct varobj_root *next;
108 /* Dynamic part of varobj. */
110 struct varobj_dynamic
112 /* Whether the children of this varobj were requested. This field is
113 used to decide if dynamic varobj should recompute their children.
114 In the event that the frontend never asked for the children, we
116 int children_requested;
118 /* The pretty-printer constructor. If NULL, then the default
119 pretty-printer will be looked up. If None, then no
120 pretty-printer will be installed. */
121 PyObject *constructor;
123 /* The pretty-printer that has been constructed. If NULL, then a
124 new printer object is needed, and one will be constructed. */
125 PyObject *pretty_printer;
127 /* The iterator returned by the printer's 'children' method, or NULL
129 struct varobj_iter *child_iter;
131 /* We request one extra item from the iterator, so that we can
132 report to the caller whether there are more items than we have
133 already reported. However, we don't want to install this value
134 when we read it, because that will mess up future updates. So,
135 we stash it here instead. */
136 varobj_item *saved_item;
142 struct cpstack *next;
145 /* A list of varobjs */
153 /* Private function prototypes */
155 /* Helper functions for the above subcommands. */
157 static int delete_variable (struct cpstack **, struct varobj *, int);
159 static void delete_variable_1 (struct cpstack **, int *,
160 struct varobj *, int, int);
162 static int install_variable (struct varobj *);
164 static void uninstall_variable (struct varobj *);
166 static struct varobj *create_child (struct varobj *, int, char *);
168 static struct varobj *
169 create_child_with_value (struct varobj *parent, int index,
170 struct varobj_item *item);
172 /* Utility routines */
174 static struct varobj *new_variable (void);
176 static struct varobj *new_root_variable (void);
178 static void free_variable (struct varobj *var);
180 static struct cleanup *make_cleanup_free_variable (struct varobj *var);
182 static enum varobj_display_formats variable_default_display (struct varobj *);
184 static void cppush (struct cpstack **pstack, char *name);
186 static char *cppop (struct cpstack **pstack);
188 static int update_type_if_necessary (struct varobj *var,
189 struct value *new_value);
191 static int install_new_value (struct varobj *var, struct value *value,
194 /* Language-specific routines. */
196 static int number_of_children (const struct varobj *);
198 static char *name_of_variable (const struct varobj *);
200 static char *name_of_child (struct varobj *, int);
202 static struct value *value_of_root (struct varobj **var_handle, int *);
204 static struct value *value_of_child (struct varobj *parent, int index);
206 static char *my_value_of_variable (struct varobj *var,
207 enum varobj_display_formats format);
209 static int is_root_p (const struct varobj *var);
211 static struct varobj *varobj_add_child (struct varobj *var,
212 struct varobj_item *item);
216 /* Mappings of varobj_display_formats enums to gdb's format codes. */
217 static int format_code[] = { 0, 't', 'd', 'x', 'o' };
219 /* Header of the list of root variable objects. */
220 static struct varobj_root *rootlist;
222 /* Prime number indicating the number of buckets in the hash table. */
223 /* A prime large enough to avoid too many colisions. */
224 #define VAROBJ_TABLE_SIZE 227
226 /* Pointer to the varobj hash table (built at run time). */
227 static struct vlist **varobj_table;
231 /* API Implementation */
233 is_root_p (const struct varobj *var)
235 return (var->root->rootvar == var);
239 /* Helper function to install a Python environment suitable for
240 use during operations on VAR. */
242 varobj_ensure_python_env (const struct varobj *var)
244 return ensure_python_env (var->root->exp->gdbarch,
245 var->root->exp->language_defn);
249 /* Creates a varobj (not its children). */
251 /* Return the full FRAME which corresponds to the given CORE_ADDR
252 or NULL if no FRAME on the chain corresponds to CORE_ADDR. */
254 static struct frame_info *
255 find_frame_addr_in_frame_chain (CORE_ADDR frame_addr)
257 struct frame_info *frame = NULL;
259 if (frame_addr == (CORE_ADDR) 0)
262 for (frame = get_current_frame ();
264 frame = get_prev_frame (frame))
266 /* The CORE_ADDR we get as argument was parsed from a string GDB
267 output as $fp. This output got truncated to gdbarch_addr_bit.
268 Truncate the frame base address in the same manner before
269 comparing it against our argument. */
270 CORE_ADDR frame_base = get_frame_base_address (frame);
271 int addr_bit = gdbarch_addr_bit (get_frame_arch (frame));
273 if (addr_bit < (sizeof (CORE_ADDR) * HOST_CHAR_BIT))
274 frame_base &= ((CORE_ADDR) 1 << addr_bit) - 1;
276 if (frame_base == frame_addr)
284 varobj_create (char *objname,
285 char *expression, CORE_ADDR frame, enum varobj_type type)
288 struct cleanup *old_chain;
290 /* Fill out a varobj structure for the (root) variable being constructed. */
291 var = new_root_variable ();
292 old_chain = make_cleanup_free_variable (var);
294 if (expression != NULL)
296 struct frame_info *fi;
297 struct frame_id old_id = null_frame_id;
298 const struct block *block;
300 struct value *value = NULL;
301 volatile struct gdb_exception except;
304 /* Parse and evaluate the expression, filling in as much of the
305 variable's data as possible. */
307 if (has_stack_frames ())
309 /* Allow creator to specify context of variable. */
310 if ((type == USE_CURRENT_FRAME) || (type == USE_SELECTED_FRAME))
311 fi = get_selected_frame (NULL);
313 /* FIXME: cagney/2002-11-23: This code should be doing a
314 lookup using the frame ID and not just the frame's
315 ``address''. This, of course, means an interface
316 change. However, with out that interface change ISAs,
317 such as the ia64 with its two stacks, won't work.
318 Similar goes for the case where there is a frameless
320 fi = find_frame_addr_in_frame_chain (frame);
325 /* frame = -2 means always use selected frame. */
326 if (type == USE_SELECTED_FRAME)
327 var->root->floating = 1;
333 block = get_frame_block (fi, 0);
334 pc = get_frame_pc (fi);
338 innermost_block = NULL;
339 /* Wrap the call to parse expression, so we can
340 return a sensible error. */
341 TRY_CATCH (except, RETURN_MASK_ERROR)
343 var->root->exp = parse_exp_1 (&p, pc, block, 0);
346 if (except.reason < 0)
348 do_cleanups (old_chain);
352 /* Don't allow variables to be created for types. */
353 if (var->root->exp->elts[0].opcode == OP_TYPE
354 || var->root->exp->elts[0].opcode == OP_TYPEOF
355 || var->root->exp->elts[0].opcode == OP_DECLTYPE)
357 do_cleanups (old_chain);
358 fprintf_unfiltered (gdb_stderr, "Attempt to use a type name"
359 " as an expression.\n");
363 var->format = variable_default_display (var);
364 var->root->valid_block = innermost_block;
365 var->name = xstrdup (expression);
366 /* For a root var, the name and the expr are the same. */
367 var->path_expr = xstrdup (expression);
369 /* When the frame is different from the current frame,
370 we must select the appropriate frame before parsing
371 the expression, otherwise the value will not be current.
372 Since select_frame is so benign, just call it for all cases. */
375 /* User could specify explicit FRAME-ADDR which was not found but
376 EXPRESSION is frame specific and we would not be able to evaluate
377 it correctly next time. With VALID_BLOCK set we must also set
378 FRAME and THREAD_ID. */
380 error (_("Failed to find the specified frame"));
382 var->root->frame = get_frame_id (fi);
383 var->root->thread_id = pid_to_thread_id (inferior_ptid);
384 old_id = get_frame_id (get_selected_frame (NULL));
388 /* We definitely need to catch errors here.
389 If evaluate_expression succeeds we got the value we wanted.
390 But if it fails, we still go on with a call to evaluate_type(). */
391 TRY_CATCH (except, RETURN_MASK_ERROR)
393 value = evaluate_expression (var->root->exp);
396 if (except.reason < 0)
398 /* Error getting the value. Try to at least get the
400 struct value *type_only_value = evaluate_type (var->root->exp);
402 var->type = value_type (type_only_value);
406 int real_type_found = 0;
408 var->type = value_actual_type (value, 0, &real_type_found);
410 value = value_cast (var->type, value);
413 /* Set language info */
414 var->root->lang_ops = var->root->exp->language_defn->la_varobj_ops;
416 install_new_value (var, value, 1 /* Initial assignment */);
418 /* Set ourselves as our root. */
419 var->root->rootvar = var;
421 /* Reset the selected frame. */
422 if (frame_id_p (old_id))
423 select_frame (frame_find_by_id (old_id));
426 /* If the variable object name is null, that means this
427 is a temporary variable, so don't install it. */
429 if ((var != NULL) && (objname != NULL))
431 var->obj_name = xstrdup (objname);
433 /* If a varobj name is duplicated, the install will fail so
435 if (!install_variable (var))
437 do_cleanups (old_chain);
442 discard_cleanups (old_chain);
446 /* Generates an unique name that can be used for a varobj. */
449 varobj_gen_name (void)
454 /* Generate a name for this object. */
456 obj_name = xstrprintf ("var%d", id);
461 /* Given an OBJNAME, returns the pointer to the corresponding varobj. Call
462 error if OBJNAME cannot be found. */
465 varobj_get_handle (char *objname)
469 unsigned int index = 0;
472 for (chp = objname; *chp; chp++)
474 index = (index + (i++ * (unsigned int) *chp)) % VAROBJ_TABLE_SIZE;
477 cv = *(varobj_table + index);
478 while ((cv != NULL) && (strcmp (cv->var->obj_name, objname) != 0))
482 error (_("Variable object not found"));
487 /* Given the handle, return the name of the object. */
490 varobj_get_objname (const struct varobj *var)
492 return var->obj_name;
495 /* Given the handle, return the expression represented by the object. The
496 result must be freed by the caller. */
499 varobj_get_expression (const struct varobj *var)
501 return name_of_variable (var);
504 /* Deletes a varobj and all its children if only_children == 0,
505 otherwise deletes only the children. If DELLIST is non-NULL, it is
506 assigned a malloc'ed list of all the (malloc'ed) names of the variables
507 that have been deleted (NULL terminated). Returns the number of deleted
511 varobj_delete (struct varobj *var, char ***dellist, int only_children)
515 struct cpstack *result = NULL;
518 /* Initialize a stack for temporary results. */
519 cppush (&result, NULL);
522 /* Delete only the variable children. */
523 delcount = delete_variable (&result, var, 1 /* only the children */ );
525 /* Delete the variable and all its children. */
526 delcount = delete_variable (&result, var, 0 /* parent+children */ );
528 /* We may have been asked to return a list of what has been deleted. */
531 *dellist = xmalloc ((delcount + 1) * sizeof (char *));
535 *cp = cppop (&result);
536 while ((*cp != NULL) && (mycount > 0))
540 *cp = cppop (&result);
543 if (mycount || (*cp != NULL))
544 warning (_("varobj_delete: assertion failed - mycount(=%d) <> 0"),
553 /* Convenience function for varobj_set_visualizer. Instantiate a
554 pretty-printer for a given value. */
556 instantiate_pretty_printer (PyObject *constructor, struct value *value)
558 PyObject *val_obj = NULL;
561 val_obj = value_to_value_object (value);
565 printer = PyObject_CallFunctionObjArgs (constructor, val_obj, NULL);
572 /* Set/Get variable object display format. */
574 enum varobj_display_formats
575 varobj_set_display_format (struct varobj *var,
576 enum varobj_display_formats format)
583 case FORMAT_HEXADECIMAL:
585 var->format = format;
589 var->format = variable_default_display (var);
592 if (varobj_value_is_changeable_p (var)
593 && var->value && !value_lazy (var->value))
595 xfree (var->print_value);
596 var->print_value = varobj_value_get_print_value (var->value,
603 enum varobj_display_formats
604 varobj_get_display_format (const struct varobj *var)
610 varobj_get_display_hint (const struct varobj *var)
615 struct cleanup *back_to;
617 if (!gdb_python_initialized)
620 back_to = varobj_ensure_python_env (var);
622 if (var->dynamic->pretty_printer != NULL)
623 result = gdbpy_get_display_hint (var->dynamic->pretty_printer);
625 do_cleanups (back_to);
631 /* Return true if the varobj has items after TO, false otherwise. */
634 varobj_has_more (const struct varobj *var, int to)
636 if (VEC_length (varobj_p, var->children) > to)
638 return ((to == -1 || VEC_length (varobj_p, var->children) == to)
639 && (var->dynamic->saved_item != NULL));
642 /* If the variable object is bound to a specific thread, that
643 is its evaluation can always be done in context of a frame
644 inside that thread, returns GDB id of the thread -- which
645 is always positive. Otherwise, returns -1. */
647 varobj_get_thread_id (const struct varobj *var)
649 if (var->root->valid_block && var->root->thread_id > 0)
650 return var->root->thread_id;
656 varobj_set_frozen (struct varobj *var, int frozen)
658 /* When a variable is unfrozen, we don't fetch its value.
659 The 'not_fetched' flag remains set, so next -var-update
662 We don't fetch the value, because for structures the client
663 should do -var-update anyway. It would be bad to have different
664 client-size logic for structure and other types. */
665 var->frozen = frozen;
669 varobj_get_frozen (const struct varobj *var)
674 /* A helper function that restricts a range to what is actually
675 available in a VEC. This follows the usual rules for the meaning
676 of FROM and TO -- if either is negative, the entire range is
680 varobj_restrict_range (VEC (varobj_p) *children, int *from, int *to)
682 if (*from < 0 || *to < 0)
685 *to = VEC_length (varobj_p, children);
689 if (*from > VEC_length (varobj_p, children))
690 *from = VEC_length (varobj_p, children);
691 if (*to > VEC_length (varobj_p, children))
692 *to = VEC_length (varobj_p, children);
698 /* A helper for update_dynamic_varobj_children that installs a new
699 child when needed. */
702 install_dynamic_child (struct varobj *var,
703 VEC (varobj_p) **changed,
704 VEC (varobj_p) **type_changed,
705 VEC (varobj_p) **new,
706 VEC (varobj_p) **unchanged,
709 struct varobj_item *item)
711 if (VEC_length (varobj_p, var->children) < index + 1)
713 /* There's no child yet. */
714 struct varobj *child = varobj_add_child (var, item);
718 VEC_safe_push (varobj_p, *new, child);
724 varobj_p existing = VEC_index (varobj_p, var->children, index);
725 int type_updated = update_type_if_necessary (existing, item->value);
730 VEC_safe_push (varobj_p, *type_changed, existing);
732 if (install_new_value (existing, item->value, 0))
734 if (!type_updated && changed)
735 VEC_safe_push (varobj_p, *changed, existing);
737 else if (!type_updated && unchanged)
738 VEC_safe_push (varobj_p, *unchanged, existing);
745 dynamic_varobj_has_child_method (const struct varobj *var)
747 struct cleanup *back_to;
748 PyObject *printer = var->dynamic->pretty_printer;
751 if (!gdb_python_initialized)
754 back_to = varobj_ensure_python_env (var);
755 result = PyObject_HasAttr (printer, gdbpy_children_cst);
756 do_cleanups (back_to);
761 /* A factory for creating dynamic varobj's iterators. Returns an
762 iterator object suitable for iterating over VAR's children. */
764 static struct varobj_iter *
765 varobj_get_iterator (struct varobj *var)
768 if (var->dynamic->pretty_printer)
769 return py_varobj_get_iterator (var, var->dynamic->pretty_printer);
772 gdb_assert_not_reached (_("\
773 requested an iterator from a non-dynamic varobj"));
776 /* Release and clear VAR's saved item, if any. */
779 varobj_clear_saved_item (struct varobj_dynamic *var)
781 if (var->saved_item != NULL)
783 value_free (var->saved_item->value);
784 xfree (var->saved_item);
785 var->saved_item = NULL;
790 update_dynamic_varobj_children (struct varobj *var,
791 VEC (varobj_p) **changed,
792 VEC (varobj_p) **type_changed,
793 VEC (varobj_p) **new,
794 VEC (varobj_p) **unchanged,
804 if (update_children || var->dynamic->child_iter == NULL)
806 varobj_iter_delete (var->dynamic->child_iter);
807 var->dynamic->child_iter = varobj_get_iterator (var);
809 varobj_clear_saved_item (var->dynamic);
813 if (var->dynamic->child_iter == NULL)
817 i = VEC_length (varobj_p, var->children);
819 /* We ask for one extra child, so that MI can report whether there
820 are more children. */
821 for (; to < 0 || i < to + 1; ++i)
825 /* See if there was a leftover from last time. */
826 if (var->dynamic->saved_item != NULL)
828 item = var->dynamic->saved_item;
829 var->dynamic->saved_item = NULL;
833 item = varobj_iter_next (var->dynamic->child_iter);
834 /* Release vitem->value so its lifetime is not bound to the
835 execution of a command. */
836 if (item != NULL && item->value != NULL)
837 release_value_or_incref (item->value);
842 /* Iteration is done. Remove iterator from VAR. */
843 varobj_iter_delete (var->dynamic->child_iter);
844 var->dynamic->child_iter = NULL;
847 /* We don't want to push the extra child on any report list. */
848 if (to < 0 || i < to)
850 int can_mention = from < 0 || i >= from;
852 install_dynamic_child (var, can_mention ? changed : NULL,
853 can_mention ? type_changed : NULL,
854 can_mention ? new : NULL,
855 can_mention ? unchanged : NULL,
856 can_mention ? cchanged : NULL, i,
863 var->dynamic->saved_item = item;
865 /* We want to truncate the child list just before this
871 if (i < VEC_length (varobj_p, var->children))
876 for (j = i; j < VEC_length (varobj_p, var->children); ++j)
877 varobj_delete (VEC_index (varobj_p, var->children, j), NULL, 0);
878 VEC_truncate (varobj_p, var->children, i);
881 /* If there are fewer children than requested, note that the list of
883 if (to >= 0 && VEC_length (varobj_p, var->children) < to)
886 var->num_children = VEC_length (varobj_p, var->children);
892 varobj_get_num_children (struct varobj *var)
894 if (var->num_children == -1)
896 if (varobj_is_dynamic_p (var))
900 /* If we have a dynamic varobj, don't report -1 children.
901 So, try to fetch some children first. */
902 update_dynamic_varobj_children (var, NULL, NULL, NULL, NULL, &dummy,
906 var->num_children = number_of_children (var);
909 return var->num_children >= 0 ? var->num_children : 0;
912 /* Creates a list of the immediate children of a variable object;
913 the return code is the number of such children or -1 on error. */
916 varobj_list_children (struct varobj *var, int *from, int *to)
919 int i, children_changed;
921 var->dynamic->children_requested = 1;
923 if (varobj_is_dynamic_p (var))
925 /* This, in theory, can result in the number of children changing without
926 frontend noticing. But well, calling -var-list-children on the same
927 varobj twice is not something a sane frontend would do. */
928 update_dynamic_varobj_children (var, NULL, NULL, NULL, NULL,
929 &children_changed, 0, 0, *to);
930 varobj_restrict_range (var->children, from, to);
931 return var->children;
934 if (var->num_children == -1)
935 var->num_children = number_of_children (var);
937 /* If that failed, give up. */
938 if (var->num_children == -1)
939 return var->children;
941 /* If we're called when the list of children is not yet initialized,
942 allocate enough elements in it. */
943 while (VEC_length (varobj_p, var->children) < var->num_children)
944 VEC_safe_push (varobj_p, var->children, NULL);
946 for (i = 0; i < var->num_children; i++)
948 varobj_p existing = VEC_index (varobj_p, var->children, i);
950 if (existing == NULL)
952 /* Either it's the first call to varobj_list_children for
953 this variable object, and the child was never created,
954 or it was explicitly deleted by the client. */
955 name = name_of_child (var, i);
956 existing = create_child (var, i, name);
957 VEC_replace (varobj_p, var->children, i, existing);
961 varobj_restrict_range (var->children, from, to);
962 return var->children;
965 static struct varobj *
966 varobj_add_child (struct varobj *var, struct varobj_item *item)
968 varobj_p v = create_child_with_value (var,
969 VEC_length (varobj_p, var->children),
972 VEC_safe_push (varobj_p, var->children, v);
976 /* Obtain the type of an object Variable as a string similar to the one gdb
977 prints on the console. The caller is responsible for freeing the string.
981 varobj_get_type (struct varobj *var)
983 /* For the "fake" variables, do not return a type. (Its type is
985 Do not return a type for invalid variables as well. */
986 if (CPLUS_FAKE_CHILD (var) || !var->root->is_valid)
989 return type_to_string (var->type);
992 /* Obtain the type of an object variable. */
995 varobj_get_gdb_type (const struct varobj *var)
1000 /* Is VAR a path expression parent, i.e., can it be used to construct
1001 a valid path expression? */
1004 is_path_expr_parent (const struct varobj *var)
1006 gdb_assert (var->root->lang_ops->is_path_expr_parent != NULL);
1007 return var->root->lang_ops->is_path_expr_parent (var);
1010 /* Is VAR a path expression parent, i.e., can it be used to construct
1011 a valid path expression? By default we assume any VAR can be a path
1015 varobj_default_is_path_expr_parent (const struct varobj *var)
1020 /* Return the path expression parent for VAR. */
1023 varobj_get_path_expr_parent (struct varobj *var)
1025 struct varobj *parent = var;
1027 while (!is_root_p (parent) && !is_path_expr_parent (parent))
1028 parent = parent->parent;
1033 /* Return a pointer to the full rooted expression of varobj VAR.
1034 If it has not been computed yet, compute it. */
1036 varobj_get_path_expr (struct varobj *var)
1038 if (var->path_expr == NULL)
1040 /* For root varobjs, we initialize path_expr
1041 when creating varobj, so here it should be
1043 gdb_assert (!is_root_p (var));
1045 var->path_expr = (*var->root->lang_ops->path_expr_of_child) (var);
1048 return var->path_expr;
1051 const struct language_defn *
1052 varobj_get_language (const struct varobj *var)
1054 return var->root->exp->language_defn;
1058 varobj_get_attributes (const struct varobj *var)
1062 if (varobj_editable_p (var))
1063 /* FIXME: define masks for attributes. */
1064 attributes |= 0x00000001; /* Editable */
1069 /* Return true if VAR is a dynamic varobj. */
1072 varobj_is_dynamic_p (const struct varobj *var)
1074 return var->dynamic->pretty_printer != NULL;
1078 varobj_get_formatted_value (struct varobj *var,
1079 enum varobj_display_formats format)
1081 return my_value_of_variable (var, format);
1085 varobj_get_value (struct varobj *var)
1087 return my_value_of_variable (var, var->format);
1090 /* Set the value of an object variable (if it is editable) to the
1091 value of the given expression. */
1092 /* Note: Invokes functions that can call error(). */
1095 varobj_set_value (struct varobj *var, char *expression)
1097 struct value *val = NULL; /* Initialize to keep gcc happy. */
1098 /* The argument "expression" contains the variable's new value.
1099 We need to first construct a legal expression for this -- ugh! */
1100 /* Does this cover all the bases? */
1101 struct expression *exp;
1102 struct value *value = NULL; /* Initialize to keep gcc happy. */
1103 int saved_input_radix = input_radix;
1104 const char *s = expression;
1105 volatile struct gdb_exception except;
1107 gdb_assert (varobj_editable_p (var));
1109 input_radix = 10; /* ALWAYS reset to decimal temporarily. */
1110 exp = parse_exp_1 (&s, 0, 0, 0);
1111 TRY_CATCH (except, RETURN_MASK_ERROR)
1113 value = evaluate_expression (exp);
1116 if (except.reason < 0)
1118 /* We cannot proceed without a valid expression. */
1123 /* All types that are editable must also be changeable. */
1124 gdb_assert (varobj_value_is_changeable_p (var));
1126 /* The value of a changeable variable object must not be lazy. */
1127 gdb_assert (!value_lazy (var->value));
1129 /* Need to coerce the input. We want to check if the
1130 value of the variable object will be different
1131 after assignment, and the first thing value_assign
1132 does is coerce the input.
1133 For example, if we are assigning an array to a pointer variable we
1134 should compare the pointer with the array's address, not with the
1136 value = coerce_array (value);
1138 /* The new value may be lazy. value_assign, or
1139 rather value_contents, will take care of this. */
1140 TRY_CATCH (except, RETURN_MASK_ERROR)
1142 val = value_assign (var->value, value);
1145 if (except.reason < 0)
1148 /* If the value has changed, record it, so that next -var-update can
1149 report this change. If a variable had a value of '1', we've set it
1150 to '333' and then set again to '1', when -var-update will report this
1151 variable as changed -- because the first assignment has set the
1152 'updated' flag. There's no need to optimize that, because return value
1153 of -var-update should be considered an approximation. */
1154 var->updated = install_new_value (var, val, 0 /* Compare values. */);
1155 input_radix = saved_input_radix;
1161 /* A helper function to install a constructor function and visualizer
1162 in a varobj_dynamic. */
1165 install_visualizer (struct varobj_dynamic *var, PyObject *constructor,
1166 PyObject *visualizer)
1168 Py_XDECREF (var->constructor);
1169 var->constructor = constructor;
1171 Py_XDECREF (var->pretty_printer);
1172 var->pretty_printer = visualizer;
1174 varobj_iter_delete (var->child_iter);
1175 var->child_iter = NULL;
1178 /* Install the default visualizer for VAR. */
1181 install_default_visualizer (struct varobj *var)
1183 /* Do not install a visualizer on a CPLUS_FAKE_CHILD. */
1184 if (CPLUS_FAKE_CHILD (var))
1187 if (pretty_printing)
1189 PyObject *pretty_printer = NULL;
1193 pretty_printer = gdbpy_get_varobj_pretty_printer (var->value);
1194 if (! pretty_printer)
1196 gdbpy_print_stack ();
1197 error (_("Cannot instantiate printer for default visualizer"));
1201 if (pretty_printer == Py_None)
1203 Py_DECREF (pretty_printer);
1204 pretty_printer = NULL;
1207 install_visualizer (var->dynamic, NULL, pretty_printer);
1211 /* Instantiate and install a visualizer for VAR using CONSTRUCTOR to
1212 make a new object. */
1215 construct_visualizer (struct varobj *var, PyObject *constructor)
1217 PyObject *pretty_printer;
1219 /* Do not install a visualizer on a CPLUS_FAKE_CHILD. */
1220 if (CPLUS_FAKE_CHILD (var))
1223 Py_INCREF (constructor);
1224 if (constructor == Py_None)
1225 pretty_printer = NULL;
1228 pretty_printer = instantiate_pretty_printer (constructor, var->value);
1229 if (! pretty_printer)
1231 gdbpy_print_stack ();
1232 Py_DECREF (constructor);
1233 constructor = Py_None;
1234 Py_INCREF (constructor);
1237 if (pretty_printer == Py_None)
1239 Py_DECREF (pretty_printer);
1240 pretty_printer = NULL;
1244 install_visualizer (var->dynamic, constructor, pretty_printer);
1247 #endif /* HAVE_PYTHON */
1249 /* A helper function for install_new_value. This creates and installs
1250 a visualizer for VAR, if appropriate. */
1253 install_new_value_visualizer (struct varobj *var)
1256 /* If the constructor is None, then we want the raw value. If VAR
1257 does not have a value, just skip this. */
1258 if (!gdb_python_initialized)
1261 if (var->dynamic->constructor != Py_None && var->value != NULL)
1263 struct cleanup *cleanup;
1265 cleanup = varobj_ensure_python_env (var);
1267 if (var->dynamic->constructor == NULL)
1268 install_default_visualizer (var);
1270 construct_visualizer (var, var->dynamic->constructor);
1272 do_cleanups (cleanup);
1279 /* When using RTTI to determine variable type it may be changed in runtime when
1280 the variable value is changed. This function checks whether type of varobj
1281 VAR will change when a new value NEW_VALUE is assigned and if it is so
1282 updates the type of VAR. */
1285 update_type_if_necessary (struct varobj *var, struct value *new_value)
1289 struct value_print_options opts;
1291 get_user_print_options (&opts);
1292 if (opts.objectprint)
1294 struct type *new_type;
1295 char *curr_type_str, *new_type_str;
1296 int type_name_changed;
1298 new_type = value_actual_type (new_value, 0, 0);
1299 new_type_str = type_to_string (new_type);
1300 curr_type_str = varobj_get_type (var);
1301 type_name_changed = strcmp (curr_type_str, new_type_str) != 0;
1302 xfree (curr_type_str);
1303 xfree (new_type_str);
1305 if (type_name_changed)
1307 var->type = new_type;
1309 /* This information may be not valid for a new type. */
1310 varobj_delete (var, NULL, 1);
1311 VEC_free (varobj_p, var->children);
1312 var->num_children = -1;
1321 /* Assign a new value to a variable object. If INITIAL is non-zero,
1322 this is the first assignement after the variable object was just
1323 created, or changed type. In that case, just assign the value
1325 Otherwise, assign the new value, and return 1 if the value is
1326 different from the current one, 0 otherwise. The comparison is
1327 done on textual representation of value. Therefore, some types
1328 need not be compared. E.g. for structures the reported value is
1329 always "{...}", so no comparison is necessary here. If the old
1330 value was NULL and new one is not, or vice versa, we always return 1.
1332 The VALUE parameter should not be released -- the function will
1333 take care of releasing it when needed. */
1335 install_new_value (struct varobj *var, struct value *value, int initial)
1340 int intentionally_not_fetched = 0;
1341 char *print_value = NULL;
1343 /* We need to know the varobj's type to decide if the value should
1344 be fetched or not. C++ fake children (public/protected/private)
1345 don't have a type. */
1346 gdb_assert (var->type || CPLUS_FAKE_CHILD (var));
1347 changeable = varobj_value_is_changeable_p (var);
1349 /* If the type has custom visualizer, we consider it to be always
1350 changeable. FIXME: need to make sure this behaviour will not
1351 mess up read-sensitive values. */
1352 if (var->dynamic->pretty_printer != NULL)
1355 need_to_fetch = changeable;
1357 /* We are not interested in the address of references, and given
1358 that in C++ a reference is not rebindable, it cannot
1359 meaningfully change. So, get hold of the real value. */
1361 value = coerce_ref (value);
1363 if (var->type && TYPE_CODE (var->type) == TYPE_CODE_UNION)
1364 /* For unions, we need to fetch the value implicitly because
1365 of implementation of union member fetch. When gdb
1366 creates a value for a field and the value of the enclosing
1367 structure is not lazy, it immediately copies the necessary
1368 bytes from the enclosing values. If the enclosing value is
1369 lazy, the call to value_fetch_lazy on the field will read
1370 the data from memory. For unions, that means we'll read the
1371 same memory more than once, which is not desirable. So
1375 /* The new value might be lazy. If the type is changeable,
1376 that is we'll be comparing values of this type, fetch the
1377 value now. Otherwise, on the next update the old value
1378 will be lazy, which means we've lost that old value. */
1379 if (need_to_fetch && value && value_lazy (value))
1381 struct varobj *parent = var->parent;
1382 int frozen = var->frozen;
1384 for (; !frozen && parent; parent = parent->parent)
1385 frozen |= parent->frozen;
1387 if (frozen && initial)
1389 /* For variables that are frozen, or are children of frozen
1390 variables, we don't do fetch on initial assignment.
1391 For non-initial assignemnt we do the fetch, since it means we're
1392 explicitly asked to compare the new value with the old one. */
1393 intentionally_not_fetched = 1;
1397 volatile struct gdb_exception except;
1399 TRY_CATCH (except, RETURN_MASK_ERROR)
1401 value_fetch_lazy (value);
1404 if (except.reason < 0)
1406 /* Set the value to NULL, so that for the next -var-update,
1407 we don't try to compare the new value with this value,
1408 that we couldn't even read. */
1414 /* Get a reference now, before possibly passing it to any Python
1415 code that might release it. */
1417 value_incref (value);
1419 /* Below, we'll be comparing string rendering of old and new
1420 values. Don't get string rendering if the value is
1421 lazy -- if it is, the code above has decided that the value
1422 should not be fetched. */
1423 if (value != NULL && !value_lazy (value)
1424 && var->dynamic->pretty_printer == NULL)
1425 print_value = varobj_value_get_print_value (value, var->format, var);
1427 /* If the type is changeable, compare the old and the new values.
1428 If this is the initial assignment, we don't have any old value
1430 if (!initial && changeable)
1432 /* If the value of the varobj was changed by -var-set-value,
1433 then the value in the varobj and in the target is the same.
1434 However, that value is different from the value that the
1435 varobj had after the previous -var-update. So need to the
1436 varobj as changed. */
1441 else if (var->dynamic->pretty_printer == NULL)
1443 /* Try to compare the values. That requires that both
1444 values are non-lazy. */
1445 if (var->not_fetched && value_lazy (var->value))
1447 /* This is a frozen varobj and the value was never read.
1448 Presumably, UI shows some "never read" indicator.
1449 Now that we've fetched the real value, we need to report
1450 this varobj as changed so that UI can show the real
1454 else if (var->value == NULL && value == NULL)
1457 else if (var->value == NULL || value == NULL)
1463 gdb_assert (!value_lazy (var->value));
1464 gdb_assert (!value_lazy (value));
1466 gdb_assert (var->print_value != NULL && print_value != NULL);
1467 if (strcmp (var->print_value, print_value) != 0)
1473 if (!initial && !changeable)
1475 /* For values that are not changeable, we don't compare the values.
1476 However, we want to notice if a value was not NULL and now is NULL,
1477 or vise versa, so that we report when top-level varobjs come in scope
1478 and leave the scope. */
1479 changed = (var->value != NULL) != (value != NULL);
1482 /* We must always keep the new value, since children depend on it. */
1483 if (var->value != NULL && var->value != value)
1484 value_free (var->value);
1486 if (value && value_lazy (value) && intentionally_not_fetched)
1487 var->not_fetched = 1;
1489 var->not_fetched = 0;
1492 install_new_value_visualizer (var);
1494 /* If we installed a pretty-printer, re-compare the printed version
1495 to see if the variable changed. */
1496 if (var->dynamic->pretty_printer != NULL)
1498 xfree (print_value);
1499 print_value = varobj_value_get_print_value (var->value, var->format,
1501 if ((var->print_value == NULL && print_value != NULL)
1502 || (var->print_value != NULL && print_value == NULL)
1503 || (var->print_value != NULL && print_value != NULL
1504 && strcmp (var->print_value, print_value) != 0))
1507 if (var->print_value)
1508 xfree (var->print_value);
1509 var->print_value = print_value;
1511 gdb_assert (!var->value || value_type (var->value));
1516 /* Return the requested range for a varobj. VAR is the varobj. FROM
1517 and TO are out parameters; *FROM and *TO will be set to the
1518 selected sub-range of VAR. If no range was selected using
1519 -var-set-update-range, then both will be -1. */
1521 varobj_get_child_range (const struct varobj *var, int *from, int *to)
1527 /* Set the selected sub-range of children of VAR to start at index
1528 FROM and end at index TO. If either FROM or TO is less than zero,
1529 this is interpreted as a request for all children. */
1531 varobj_set_child_range (struct varobj *var, int from, int to)
1538 varobj_set_visualizer (struct varobj *var, const char *visualizer)
1541 PyObject *mainmod, *globals, *constructor;
1542 struct cleanup *back_to;
1544 if (!gdb_python_initialized)
1547 back_to = varobj_ensure_python_env (var);
1549 mainmod = PyImport_AddModule ("__main__");
1550 globals = PyModule_GetDict (mainmod);
1551 Py_INCREF (globals);
1552 make_cleanup_py_decref (globals);
1554 constructor = PyRun_String (visualizer, Py_eval_input, globals, globals);
1558 gdbpy_print_stack ();
1559 error (_("Could not evaluate visualizer expression: %s"), visualizer);
1562 construct_visualizer (var, constructor);
1563 Py_XDECREF (constructor);
1565 /* If there are any children now, wipe them. */
1566 varobj_delete (var, NULL, 1 /* children only */);
1567 var->num_children = -1;
1569 do_cleanups (back_to);
1571 error (_("Python support required"));
1575 /* If NEW_VALUE is the new value of the given varobj (var), return
1576 non-zero if var has mutated. In other words, if the type of
1577 the new value is different from the type of the varobj's old
1580 NEW_VALUE may be NULL, if the varobj is now out of scope. */
1583 varobj_value_has_mutated (const struct varobj *var, struct value *new_value,
1584 struct type *new_type)
1586 /* If we haven't previously computed the number of children in var,
1587 it does not matter from the front-end's perspective whether
1588 the type has mutated or not. For all intents and purposes,
1589 it has not mutated. */
1590 if (var->num_children < 0)
1593 if (var->root->lang_ops->value_has_mutated)
1595 /* The varobj module, when installing new values, explicitly strips
1596 references, saying that we're not interested in those addresses.
1597 But detection of mutation happens before installing the new
1598 value, so our value may be a reference that we need to strip
1599 in order to remain consistent. */
1600 if (new_value != NULL)
1601 new_value = coerce_ref (new_value);
1602 return var->root->lang_ops->value_has_mutated (var, new_value, new_type);
1608 /* Update the values for a variable and its children. This is a
1609 two-pronged attack. First, re-parse the value for the root's
1610 expression to see if it's changed. Then go all the way
1611 through its children, reconstructing them and noting if they've
1614 The EXPLICIT parameter specifies if this call is result
1615 of MI request to update this specific variable, or
1616 result of implicit -var-update *. For implicit request, we don't
1617 update frozen variables.
1619 NOTE: This function may delete the caller's varobj. If it
1620 returns TYPE_CHANGED, then it has done this and VARP will be modified
1621 to point to the new varobj. */
1623 VEC(varobj_update_result) *
1624 varobj_update (struct varobj **varp, int explicit)
1626 int type_changed = 0;
1629 VEC (varobj_update_result) *stack = NULL;
1630 VEC (varobj_update_result) *result = NULL;
1632 /* Frozen means frozen -- we don't check for any change in
1633 this varobj, including its going out of scope, or
1634 changing type. One use case for frozen varobjs is
1635 retaining previously evaluated expressions, and we don't
1636 want them to be reevaluated at all. */
1637 if (!explicit && (*varp)->frozen)
1640 if (!(*varp)->root->is_valid)
1642 varobj_update_result r = {0};
1645 r.status = VAROBJ_INVALID;
1646 VEC_safe_push (varobj_update_result, result, &r);
1650 if ((*varp)->root->rootvar == *varp)
1652 varobj_update_result r = {0};
1655 r.status = VAROBJ_IN_SCOPE;
1657 /* Update the root variable. value_of_root can return NULL
1658 if the variable is no longer around, i.e. we stepped out of
1659 the frame in which a local existed. We are letting the
1660 value_of_root variable dispose of the varobj if the type
1662 new = value_of_root (varp, &type_changed);
1663 if (update_type_if_necessary(*varp, new))
1666 r.type_changed = type_changed;
1667 if (install_new_value ((*varp), new, type_changed))
1671 r.status = VAROBJ_NOT_IN_SCOPE;
1672 r.value_installed = 1;
1674 if (r.status == VAROBJ_NOT_IN_SCOPE)
1676 if (r.type_changed || r.changed)
1677 VEC_safe_push (varobj_update_result, result, &r);
1681 VEC_safe_push (varobj_update_result, stack, &r);
1685 varobj_update_result r = {0};
1688 VEC_safe_push (varobj_update_result, stack, &r);
1691 /* Walk through the children, reconstructing them all. */
1692 while (!VEC_empty (varobj_update_result, stack))
1694 varobj_update_result r = *(VEC_last (varobj_update_result, stack));
1695 struct varobj *v = r.varobj;
1697 VEC_pop (varobj_update_result, stack);
1699 /* Update this variable, unless it's a root, which is already
1701 if (!r.value_installed)
1703 struct type *new_type;
1705 new = value_of_child (v->parent, v->index);
1706 if (update_type_if_necessary(v, new))
1709 new_type = value_type (new);
1711 new_type = v->root->lang_ops->type_of_child (v->parent, v->index);
1713 if (varobj_value_has_mutated (v, new, new_type))
1715 /* The children are no longer valid; delete them now.
1716 Report the fact that its type changed as well. */
1717 varobj_delete (v, NULL, 1 /* only_children */);
1718 v->num_children = -1;
1725 if (install_new_value (v, new, r.type_changed))
1732 /* We probably should not get children of a dynamic varobj, but
1733 for which -var-list-children was never invoked. */
1734 if (varobj_is_dynamic_p (v))
1736 VEC (varobj_p) *changed = 0, *type_changed = 0, *unchanged = 0;
1737 VEC (varobj_p) *new = 0;
1738 int i, children_changed = 0;
1743 if (!v->dynamic->children_requested)
1747 /* If we initially did not have potential children, but
1748 now we do, consider the varobj as changed.
1749 Otherwise, if children were never requested, consider
1750 it as unchanged -- presumably, such varobj is not yet
1751 expanded in the UI, so we need not bother getting
1753 if (!varobj_has_more (v, 0))
1755 update_dynamic_varobj_children (v, NULL, NULL, NULL, NULL,
1757 if (varobj_has_more (v, 0))
1762 VEC_safe_push (varobj_update_result, result, &r);
1767 /* If update_dynamic_varobj_children returns 0, then we have
1768 a non-conforming pretty-printer, so we skip it. */
1769 if (update_dynamic_varobj_children (v, &changed, &type_changed, &new,
1770 &unchanged, &children_changed, 1,
1773 if (children_changed || new)
1775 r.children_changed = 1;
1778 /* Push in reverse order so that the first child is
1779 popped from the work stack first, and so will be
1780 added to result first. This does not affect
1781 correctness, just "nicer". */
1782 for (i = VEC_length (varobj_p, type_changed) - 1; i >= 0; --i)
1784 varobj_p tmp = VEC_index (varobj_p, type_changed, i);
1785 varobj_update_result r = {0};
1787 /* Type may change only if value was changed. */
1791 r.value_installed = 1;
1792 VEC_safe_push (varobj_update_result, stack, &r);
1794 for (i = VEC_length (varobj_p, changed) - 1; i >= 0; --i)
1796 varobj_p tmp = VEC_index (varobj_p, changed, i);
1797 varobj_update_result r = {0};
1801 r.value_installed = 1;
1802 VEC_safe_push (varobj_update_result, stack, &r);
1804 for (i = VEC_length (varobj_p, unchanged) - 1; i >= 0; --i)
1806 varobj_p tmp = VEC_index (varobj_p, unchanged, i);
1810 varobj_update_result r = {0};
1813 r.value_installed = 1;
1814 VEC_safe_push (varobj_update_result, stack, &r);
1817 if (r.changed || r.children_changed)
1818 VEC_safe_push (varobj_update_result, result, &r);
1820 /* Free CHANGED, TYPE_CHANGED and UNCHANGED, but not NEW,
1821 because NEW has been put into the result vector. */
1822 VEC_free (varobj_p, changed);
1823 VEC_free (varobj_p, type_changed);
1824 VEC_free (varobj_p, unchanged);
1830 /* Push any children. Use reverse order so that the first
1831 child is popped from the work stack first, and so
1832 will be added to result first. This does not
1833 affect correctness, just "nicer". */
1834 for (i = VEC_length (varobj_p, v->children)-1; i >= 0; --i)
1836 varobj_p c = VEC_index (varobj_p, v->children, i);
1838 /* Child may be NULL if explicitly deleted by -var-delete. */
1839 if (c != NULL && !c->frozen)
1841 varobj_update_result r = {0};
1844 VEC_safe_push (varobj_update_result, stack, &r);
1848 if (r.changed || r.type_changed)
1849 VEC_safe_push (varobj_update_result, result, &r);
1852 VEC_free (varobj_update_result, stack);
1858 /* Helper functions */
1861 * Variable object construction/destruction
1865 delete_variable (struct cpstack **resultp, struct varobj *var,
1866 int only_children_p)
1870 delete_variable_1 (resultp, &delcount, var,
1871 only_children_p, 1 /* remove_from_parent_p */ );
1876 /* Delete the variable object VAR and its children. */
1877 /* IMPORTANT NOTE: If we delete a variable which is a child
1878 and the parent is not removed we dump core. It must be always
1879 initially called with remove_from_parent_p set. */
1881 delete_variable_1 (struct cpstack **resultp, int *delcountp,
1882 struct varobj *var, int only_children_p,
1883 int remove_from_parent_p)
1887 /* Delete any children of this variable, too. */
1888 for (i = 0; i < VEC_length (varobj_p, var->children); ++i)
1890 varobj_p child = VEC_index (varobj_p, var->children, i);
1894 if (!remove_from_parent_p)
1895 child->parent = NULL;
1896 delete_variable_1 (resultp, delcountp, child, 0, only_children_p);
1898 VEC_free (varobj_p, var->children);
1900 /* if we were called to delete only the children we are done here. */
1901 if (only_children_p)
1904 /* Otherwise, add it to the list of deleted ones and proceed to do so. */
1905 /* If the name is null, this is a temporary variable, that has not
1906 yet been installed, don't report it, it belongs to the caller... */
1907 if (var->obj_name != NULL)
1909 cppush (resultp, xstrdup (var->obj_name));
1910 *delcountp = *delcountp + 1;
1913 /* If this variable has a parent, remove it from its parent's list. */
1914 /* OPTIMIZATION: if the parent of this variable is also being deleted,
1915 (as indicated by remove_from_parent_p) we don't bother doing an
1916 expensive list search to find the element to remove when we are
1917 discarding the list afterwards. */
1918 if ((remove_from_parent_p) && (var->parent != NULL))
1920 VEC_replace (varobj_p, var->parent->children, var->index, NULL);
1923 if (var->obj_name != NULL)
1924 uninstall_variable (var);
1926 /* Free memory associated with this variable. */
1927 free_variable (var);
1930 /* Install the given variable VAR with the object name VAR->OBJ_NAME. */
1932 install_variable (struct varobj *var)
1935 struct vlist *newvl;
1937 unsigned int index = 0;
1940 for (chp = var->obj_name; *chp; chp++)
1942 index = (index + (i++ * (unsigned int) *chp)) % VAROBJ_TABLE_SIZE;
1945 cv = *(varobj_table + index);
1946 while ((cv != NULL) && (strcmp (cv->var->obj_name, var->obj_name) != 0))
1950 error (_("Duplicate variable object name"));
1952 /* Add varobj to hash table. */
1953 newvl = xmalloc (sizeof (struct vlist));
1954 newvl->next = *(varobj_table + index);
1956 *(varobj_table + index) = newvl;
1958 /* If root, add varobj to root list. */
1959 if (is_root_p (var))
1961 /* Add to list of root variables. */
1962 if (rootlist == NULL)
1963 var->root->next = NULL;
1965 var->root->next = rootlist;
1966 rootlist = var->root;
1972 /* Unistall the object VAR. */
1974 uninstall_variable (struct varobj *var)
1978 struct varobj_root *cr;
1979 struct varobj_root *prer;
1981 unsigned int index = 0;
1984 /* Remove varobj from hash table. */
1985 for (chp = var->obj_name; *chp; chp++)
1987 index = (index + (i++ * (unsigned int) *chp)) % VAROBJ_TABLE_SIZE;
1990 cv = *(varobj_table + index);
1992 while ((cv != NULL) && (strcmp (cv->var->obj_name, var->obj_name) != 0))
1999 fprintf_unfiltered (gdb_stdlog, "Deleting %s\n", var->obj_name);
2004 ("Assertion failed: Could not find variable object \"%s\" to delete",
2010 *(varobj_table + index) = cv->next;
2012 prev->next = cv->next;
2016 /* If root, remove varobj from root list. */
2017 if (is_root_p (var))
2019 /* Remove from list of root variables. */
2020 if (rootlist == var->root)
2021 rootlist = var->root->next;
2026 while ((cr != NULL) && (cr->rootvar != var))
2033 warning (_("Assertion failed: Could not find "
2034 "varobj \"%s\" in root list"),
2041 prer->next = cr->next;
2047 /* Create and install a child of the parent of the given name.
2049 The created VAROBJ takes ownership of the allocated NAME. */
2051 static struct varobj *
2052 create_child (struct varobj *parent, int index, char *name)
2054 struct varobj_item item;
2057 item.value = value_of_child (parent, index);
2059 return create_child_with_value (parent, index, &item);
2062 static struct varobj *
2063 create_child_with_value (struct varobj *parent, int index,
2064 struct varobj_item *item)
2066 struct varobj *child;
2069 child = new_variable ();
2071 /* NAME is allocated by caller. */
2072 child->name = item->name;
2073 child->index = index;
2074 child->parent = parent;
2075 child->root = parent->root;
2077 if (varobj_is_anonymous_child (child))
2078 childs_name = xstrprintf ("%s.%d_anonymous", parent->obj_name, index);
2080 childs_name = xstrprintf ("%s.%s", parent->obj_name, item->name);
2081 child->obj_name = childs_name;
2083 install_variable (child);
2085 /* Compute the type of the child. Must do this before
2086 calling install_new_value. */
2087 if (item->value != NULL)
2088 /* If the child had no evaluation errors, var->value
2089 will be non-NULL and contain a valid type. */
2090 child->type = value_actual_type (item->value, 0, NULL);
2092 /* Otherwise, we must compute the type. */
2093 child->type = (*child->root->lang_ops->type_of_child) (child->parent,
2095 install_new_value (child, item->value, 1);
2102 * Miscellaneous utility functions.
2105 /* Allocate memory and initialize a new variable. */
2106 static struct varobj *
2111 var = (struct varobj *) xmalloc (sizeof (struct varobj));
2113 var->path_expr = NULL;
2114 var->obj_name = NULL;
2118 var->num_children = -1;
2120 var->children = NULL;
2124 var->print_value = NULL;
2126 var->not_fetched = 0;
2128 = (struct varobj_dynamic *) xmalloc (sizeof (struct varobj_dynamic));
2129 var->dynamic->children_requested = 0;
2132 var->dynamic->constructor = 0;
2133 var->dynamic->pretty_printer = 0;
2134 var->dynamic->child_iter = 0;
2135 var->dynamic->saved_item = 0;
2140 /* Allocate memory and initialize a new root variable. */
2141 static struct varobj *
2142 new_root_variable (void)
2144 struct varobj *var = new_variable ();
2146 var->root = (struct varobj_root *) xmalloc (sizeof (struct varobj_root));
2147 var->root->lang_ops = NULL;
2148 var->root->exp = NULL;
2149 var->root->valid_block = NULL;
2150 var->root->frame = null_frame_id;
2151 var->root->floating = 0;
2152 var->root->rootvar = NULL;
2153 var->root->is_valid = 1;
2158 /* Free any allocated memory associated with VAR. */
2160 free_variable (struct varobj *var)
2163 if (var->dynamic->pretty_printer != NULL)
2165 struct cleanup *cleanup = varobj_ensure_python_env (var);
2167 Py_XDECREF (var->dynamic->constructor);
2168 Py_XDECREF (var->dynamic->pretty_printer);
2169 do_cleanups (cleanup);
2173 varobj_iter_delete (var->dynamic->child_iter);
2174 varobj_clear_saved_item (var->dynamic);
2175 value_free (var->value);
2177 /* Free the expression if this is a root variable. */
2178 if (is_root_p (var))
2180 xfree (var->root->exp);
2185 xfree (var->obj_name);
2186 xfree (var->print_value);
2187 xfree (var->path_expr);
2188 xfree (var->dynamic);
2193 do_free_variable_cleanup (void *var)
2195 free_variable (var);
2198 static struct cleanup *
2199 make_cleanup_free_variable (struct varobj *var)
2201 return make_cleanup (do_free_variable_cleanup, var);
2204 /* Return the type of the value that's stored in VAR,
2205 or that would have being stored there if the
2206 value were accessible.
2208 This differs from VAR->type in that VAR->type is always
2209 the true type of the expession in the source language.
2210 The return value of this function is the type we're
2211 actually storing in varobj, and using for displaying
2212 the values and for comparing previous and new values.
2214 For example, top-level references are always stripped. */
2216 varobj_get_value_type (const struct varobj *var)
2221 type = value_type (var->value);
2225 type = check_typedef (type);
2227 if (TYPE_CODE (type) == TYPE_CODE_REF)
2228 type = get_target_type (type);
2230 type = check_typedef (type);
2235 /* What is the default display for this variable? We assume that
2236 everything is "natural". Any exceptions? */
2237 static enum varobj_display_formats
2238 variable_default_display (struct varobj *var)
2240 return FORMAT_NATURAL;
2243 /* FIXME: The following should be generic for any pointer. */
2245 cppush (struct cpstack **pstack, char *name)
2249 s = (struct cpstack *) xmalloc (sizeof (struct cpstack));
2255 /* FIXME: The following should be generic for any pointer. */
2257 cppop (struct cpstack **pstack)
2262 if ((*pstack)->name == NULL && (*pstack)->next == NULL)
2267 *pstack = (*pstack)->next;
2274 * Language-dependencies
2277 /* Common entry points */
2279 /* Return the number of children for a given variable.
2280 The result of this function is defined by the language
2281 implementation. The number of children returned by this function
2282 is the number of children that the user will see in the variable
2285 number_of_children (const struct varobj *var)
2287 return (*var->root->lang_ops->number_of_children) (var);
2290 /* What is the expression for the root varobj VAR? Returns a malloc'd
2293 name_of_variable (const struct varobj *var)
2295 return (*var->root->lang_ops->name_of_variable) (var);
2298 /* What is the name of the INDEX'th child of VAR? Returns a malloc'd
2301 name_of_child (struct varobj *var, int index)
2303 return (*var->root->lang_ops->name_of_child) (var, index);
2306 /* If frame associated with VAR can be found, switch
2307 to it and return 1. Otherwise, return 0. */
2310 check_scope (const struct varobj *var)
2312 struct frame_info *fi;
2315 fi = frame_find_by_id (var->root->frame);
2320 CORE_ADDR pc = get_frame_pc (fi);
2322 if (pc < BLOCK_START (var->root->valid_block) ||
2323 pc >= BLOCK_END (var->root->valid_block))
2331 /* Helper function to value_of_root. */
2333 static struct value *
2334 value_of_root_1 (struct varobj **var_handle)
2336 struct value *new_val = NULL;
2337 struct varobj *var = *var_handle;
2338 int within_scope = 0;
2339 struct cleanup *back_to;
2341 /* Only root variables can be updated... */
2342 if (!is_root_p (var))
2343 /* Not a root var. */
2346 back_to = make_cleanup_restore_current_thread ();
2348 /* Determine whether the variable is still around. */
2349 if (var->root->valid_block == NULL || var->root->floating)
2351 else if (var->root->thread_id == 0)
2353 /* The program was single-threaded when the variable object was
2354 created. Technically, it's possible that the program became
2355 multi-threaded since then, but we don't support such
2357 within_scope = check_scope (var);
2361 ptid_t ptid = thread_id_to_pid (var->root->thread_id);
2362 if (in_thread_list (ptid))
2364 switch_to_thread (ptid);
2365 within_scope = check_scope (var);
2371 volatile struct gdb_exception except;
2373 /* We need to catch errors here, because if evaluate
2374 expression fails we want to just return NULL. */
2375 TRY_CATCH (except, RETURN_MASK_ERROR)
2377 new_val = evaluate_expression (var->root->exp);
2381 do_cleanups (back_to);
2386 /* What is the ``struct value *'' of the root variable VAR?
2387 For floating variable object, evaluation can get us a value
2388 of different type from what is stored in varobj already. In
2390 - *type_changed will be set to 1
2391 - old varobj will be freed, and new one will be
2392 created, with the same name.
2393 - *var_handle will be set to the new varobj
2394 Otherwise, *type_changed will be set to 0. */
2395 static struct value *
2396 value_of_root (struct varobj **var_handle, int *type_changed)
2400 if (var_handle == NULL)
2405 /* This should really be an exception, since this should
2406 only get called with a root variable. */
2408 if (!is_root_p (var))
2411 if (var->root->floating)
2413 struct varobj *tmp_var;
2414 char *old_type, *new_type;
2416 tmp_var = varobj_create (NULL, var->name, (CORE_ADDR) 0,
2417 USE_SELECTED_FRAME);
2418 if (tmp_var == NULL)
2422 old_type = varobj_get_type (var);
2423 new_type = varobj_get_type (tmp_var);
2424 if (strcmp (old_type, new_type) == 0)
2426 /* The expression presently stored inside var->root->exp
2427 remembers the locations of local variables relatively to
2428 the frame where the expression was created (in DWARF location
2429 button, for example). Naturally, those locations are not
2430 correct in other frames, so update the expression. */
2432 struct expression *tmp_exp = var->root->exp;
2434 var->root->exp = tmp_var->root->exp;
2435 tmp_var->root->exp = tmp_exp;
2437 varobj_delete (tmp_var, NULL, 0);
2442 tmp_var->obj_name = xstrdup (var->obj_name);
2443 tmp_var->from = var->from;
2444 tmp_var->to = var->to;
2445 varobj_delete (var, NULL, 0);
2447 install_variable (tmp_var);
2448 *var_handle = tmp_var;
2461 struct value *value;
2463 value = value_of_root_1 (var_handle);
2464 if (var->value == NULL || value == NULL)
2466 /* For root varobj-s, a NULL value indicates a scoping issue.
2467 So, nothing to do in terms of checking for mutations. */
2469 else if (varobj_value_has_mutated (var, value, value_type (value)))
2471 /* The type has mutated, so the children are no longer valid.
2472 Just delete them, and tell our caller that the type has
2474 varobj_delete (var, NULL, 1 /* only_children */);
2475 var->num_children = -1;
2484 /* What is the ``struct value *'' for the INDEX'th child of PARENT? */
2485 static struct value *
2486 value_of_child (struct varobj *parent, int index)
2488 struct value *value;
2490 value = (*parent->root->lang_ops->value_of_child) (parent, index);
2495 /* GDB already has a command called "value_of_variable". Sigh. */
2497 my_value_of_variable (struct varobj *var, enum varobj_display_formats format)
2499 if (var->root->is_valid)
2501 if (var->dynamic->pretty_printer != NULL)
2502 return varobj_value_get_print_value (var->value, var->format, var);
2503 return (*var->root->lang_ops->value_of_variable) (var, format);
2510 varobj_formatted_print_options (struct value_print_options *opts,
2511 enum varobj_display_formats format)
2513 get_formatted_print_options (opts, format_code[(int) format]);
2514 opts->deref_ref = 0;
2519 varobj_value_get_print_value (struct value *value,
2520 enum varobj_display_formats format,
2521 const struct varobj *var)
2523 struct ui_file *stb;
2524 struct cleanup *old_chain;
2525 char *thevalue = NULL;
2526 struct value_print_options opts;
2527 struct type *type = NULL;
2529 char *encoding = NULL;
2530 struct gdbarch *gdbarch = NULL;
2531 /* Initialize it just to avoid a GCC false warning. */
2532 CORE_ADDR str_addr = 0;
2533 int string_print = 0;
2538 stb = mem_fileopen ();
2539 old_chain = make_cleanup_ui_file_delete (stb);
2541 gdbarch = get_type_arch (value_type (value));
2543 if (gdb_python_initialized)
2545 PyObject *value_formatter = var->dynamic->pretty_printer;
2547 varobj_ensure_python_env (var);
2549 if (value_formatter)
2551 /* First check to see if we have any children at all. If so,
2552 we simply return {...}. */
2553 if (dynamic_varobj_has_child_method (var))
2555 do_cleanups (old_chain);
2556 return xstrdup ("{...}");
2559 if (PyObject_HasAttr (value_formatter, gdbpy_to_string_cst))
2561 struct value *replacement;
2562 PyObject *output = NULL;
2564 output = apply_varobj_pretty_printer (value_formatter,
2568 /* If we have string like output ... */
2571 make_cleanup_py_decref (output);
2573 /* If this is a lazy string, extract it. For lazy
2574 strings we always print as a string, so set
2576 if (gdbpy_is_lazy_string (output))
2578 gdbpy_extract_lazy_string (output, &str_addr, &type,
2580 make_cleanup (free_current_contents, &encoding);
2585 /* If it is a regular (non-lazy) string, extract
2586 it and copy the contents into THEVALUE. If the
2587 hint says to print it as a string, set
2588 string_print. Otherwise just return the extracted
2589 string as a value. */
2591 char *s = python_string_to_target_string (output);
2597 hint = gdbpy_get_display_hint (value_formatter);
2600 if (!strcmp (hint, "string"))
2606 thevalue = xmemdup (s, len + 1, len + 1);
2607 type = builtin_type (gdbarch)->builtin_char;
2612 do_cleanups (old_chain);
2616 make_cleanup (xfree, thevalue);
2619 gdbpy_print_stack ();
2622 /* If the printer returned a replacement value, set VALUE
2623 to REPLACEMENT. If there is not a replacement value,
2624 just use the value passed to this function. */
2626 value = replacement;
2632 varobj_formatted_print_options (&opts, format);
2634 /* If the THEVALUE has contents, it is a regular string. */
2636 LA_PRINT_STRING (stb, type, (gdb_byte *) thevalue, len, encoding, 0, &opts);
2637 else if (string_print)
2638 /* Otherwise, if string_print is set, and it is not a regular
2639 string, it is a lazy string. */
2640 val_print_string (type, encoding, str_addr, len, stb, &opts);
2642 /* All other cases. */
2643 common_val_print (value, stb, 0, &opts, current_language);
2645 thevalue = ui_file_xstrdup (stb, NULL);
2647 do_cleanups (old_chain);
2652 varobj_editable_p (const struct varobj *var)
2656 if (!(var->root->is_valid && var->value && VALUE_LVAL (var->value)))
2659 type = varobj_get_value_type (var);
2661 switch (TYPE_CODE (type))
2663 case TYPE_CODE_STRUCT:
2664 case TYPE_CODE_UNION:
2665 case TYPE_CODE_ARRAY:
2666 case TYPE_CODE_FUNC:
2667 case TYPE_CODE_METHOD:
2677 /* Call VAR's value_is_changeable_p language-specific callback. */
2680 varobj_value_is_changeable_p (const struct varobj *var)
2682 return var->root->lang_ops->value_is_changeable_p (var);
2685 /* Return 1 if that varobj is floating, that is is always evaluated in the
2686 selected frame, and not bound to thread/frame. Such variable objects
2687 are created using '@' as frame specifier to -var-create. */
2689 varobj_floating_p (const struct varobj *var)
2691 return var->root->floating;
2694 /* Implement the "value_is_changeable_p" varobj callback for most
2698 varobj_default_value_is_changeable_p (const struct varobj *var)
2703 if (CPLUS_FAKE_CHILD (var))
2706 type = varobj_get_value_type (var);
2708 switch (TYPE_CODE (type))
2710 case TYPE_CODE_STRUCT:
2711 case TYPE_CODE_UNION:
2712 case TYPE_CODE_ARRAY:
2723 /* Iterate all the existing _root_ VAROBJs and call the FUNC callback for them
2724 with an arbitrary caller supplied DATA pointer. */
2727 all_root_varobjs (void (*func) (struct varobj *var, void *data), void *data)
2729 struct varobj_root *var_root, *var_root_next;
2731 /* Iterate "safely" - handle if the callee deletes its passed VAROBJ. */
2733 for (var_root = rootlist; var_root != NULL; var_root = var_root_next)
2735 var_root_next = var_root->next;
2737 (*func) (var_root->rootvar, data);
2741 /* Invalidate varobj VAR if it is tied to locals and re-create it if it is
2742 defined on globals. It is a helper for varobj_invalidate.
2744 This function is called after changing the symbol file, in this case the
2745 pointers to "struct type" stored by the varobj are no longer valid. All
2746 varobj must be either re-evaluated, or marked as invalid here. */
2749 varobj_invalidate_iter (struct varobj *var, void *unused)
2751 /* global and floating var must be re-evaluated. */
2752 if (var->root->floating || var->root->valid_block == NULL)
2754 struct varobj *tmp_var;
2756 /* Try to create a varobj with same expression. If we succeed
2757 replace the old varobj, otherwise invalidate it. */
2758 tmp_var = varobj_create (NULL, var->name, (CORE_ADDR) 0,
2760 if (tmp_var != NULL)
2762 tmp_var->obj_name = xstrdup (var->obj_name);
2763 varobj_delete (var, NULL, 0);
2764 install_variable (tmp_var);
2767 var->root->is_valid = 0;
2769 else /* locals must be invalidated. */
2770 var->root->is_valid = 0;
2773 /* Invalidate the varobjs that are tied to locals and re-create the ones that
2774 are defined on globals.
2775 Invalidated varobjs will be always printed in_scope="invalid". */
2778 varobj_invalidate (void)
2780 all_root_varobjs (varobj_invalidate_iter, NULL);
2783 extern void _initialize_varobj (void);
2785 _initialize_varobj (void)
2787 int sizeof_table = sizeof (struct vlist *) * VAROBJ_TABLE_SIZE;
2789 varobj_table = xmalloc (sizeof_table);
2790 memset (varobj_table, 0, sizeof_table);
2792 add_setshow_zuinteger_cmd ("varobj", class_maintenance,
2794 _("Set varobj debugging."),
2795 _("Show varobj debugging."),
2796 _("When non-zero, varobj debugging is enabled."),
2797 NULL, show_varobjdebug,
2798 &setdebuglist, &showdebuglist);