/* Implementation of the GDB variable objects API.
- Copyright (C) 1999-2013 Free Software Foundation, Inc.
+ Copyright (C) 1999-2014 Free Software Foundation, Inc.
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
#include "valprint.h"
#include "gdb_assert.h"
-#include "gdb_string.h"
+#include <string.h>
#include "gdb_regex.h"
#include "varobj.h"
#include "vec.h"
#include "gdbthread.h"
#include "inferior.h"
+#include "varobj-iter.h"
#if HAVE_PYTHON
#include "python/python.h"
char *varobj_format_string[] =
{ "natural", "binary", "decimal", "hexadecimal", "octal" };
-/* String representations of gdb's known languages. */
-char *varobj_language_string[] = { "C", "C++", "Java" };
-
/* True if we want to allow Python-based pretty-printing. */
static int pretty_printing = 0;
/* Language-related operations for this variable and its
children. */
- const struct lang_varobj_ops *lang;
+ const struct lang_varobj_ops *lang_ops;
/* The varobj for this root node. */
struct varobj *rootvar;
/* The iterator returned by the printer's 'children' method, or NULL
if not available. */
- PyObject *child_iter;
+ struct varobj_iter *child_iter;
/* We request one extra item from the iterator, so that we can
report to the caller whether there are more items than we have
already reported. However, we don't want to install this value
when we read it, because that will mess up future updates. So,
we stash it here instead. */
- PyObject *saved_item;
+ varobj_item *saved_item;
};
struct cpstack
static struct varobj *create_child (struct varobj *, int, char *);
static struct varobj *
-create_child_with_value (struct varobj *parent, int index, char *name,
- struct value *value);
+create_child_with_value (struct varobj *parent, int index,
+ struct varobj_item *item);
/* Utility routines */
/* Language-specific routines. */
-static enum varobj_languages variable_language (struct varobj *var);
-
static int number_of_children (struct varobj *);
static char *name_of_variable (struct varobj *);
static int is_root_p (struct varobj *var);
-#if HAVE_PYTHON
-
static struct varobj *varobj_add_child (struct varobj *var,
- char *name,
- struct value *value);
-
-#endif /* HAVE_PYTHON */
-
-/* Array of known source language routines. */
-static const struct lang_varobj_ops *languages[vlang_end] = {
- &c_varobj_ops,
- &cplus_varobj_ops,
- &java_varobj_ops,
- &ada_varobj_ops,
-};
+ struct varobj_item *item);
/* Private data */
#ifdef HAVE_PYTHON
/* Helper function to install a Python environment suitable for
use during operations on VAR. */
-static struct cleanup *
+struct cleanup *
varobj_ensure_python_env (struct varobj *var)
{
return ensure_python_env (var->root->exp->gdbarch,
{
struct frame_info *fi;
struct frame_id old_id = null_frame_id;
- struct block *block;
+ const struct block *block;
const char *p;
struct value *value = NULL;
volatile struct gdb_exception except;
}
/* Set language info */
- var->root->lang = var->root->exp->language_defn->la_varobj_ops;
+ var->root->lang_ops = var->root->exp->language_defn->la_varobj_ops;
install_new_value (var, value, 1 /* Initial assignment */);
}
}
-#if HAVE_PYTHON
-
/* A helper for update_dynamic_varobj_children that installs a new
child when needed. */
VEC (varobj_p) **unchanged,
int *cchanged,
int index,
- char *name,
- struct value *value)
+ struct varobj_item *item)
{
if (VEC_length (varobj_p, var->children) < index + 1)
{
/* There's no child yet. */
- struct varobj *child = varobj_add_child (var, name, value);
+ struct varobj *child = varobj_add_child (var, item);
if (new)
{
else
{
varobj_p existing = VEC_index (varobj_p, var->children, index);
- int type_updated = update_type_if_necessary (existing, value);
+ int type_updated = update_type_if_necessary (existing, item->value);
if (type_updated)
{
if (type_changed)
VEC_safe_push (varobj_p, *type_changed, existing);
}
- if (install_new_value (existing, value, 0))
+ if (install_new_value (existing, item->value, 0))
{
if (!type_updated && changed)
VEC_safe_push (varobj_p, *changed, existing);
}
}
+#if HAVE_PYTHON
+
static int
dynamic_varobj_has_child_method (struct varobj *var)
{
do_cleanups (back_to);
return result;
}
+#endif
+/* A factory for creating dynamic varobj's iterators. Returns an
+ iterator object suitable for iterating over VAR's children. */
+
+static struct varobj_iter *
+varobj_get_iterator (struct varobj *var)
+{
+#if HAVE_PYTHON
+ if (var->dynamic->pretty_printer)
+ return py_varobj_get_iterator (var, var->dynamic->pretty_printer);
#endif
+ gdb_assert_not_reached (_("\
+requested an iterator from a non-dynamic varobj"));
+}
+
+/* Release and clear VAR's saved item, if any. */
+
+static void
+varobj_clear_saved_item (struct varobj_dynamic *var)
+{
+ if (var->saved_item != NULL)
+ {
+ value_free (var->saved_item->value);
+ xfree (var->saved_item);
+ var->saved_item = NULL;
+ }
+}
+
static int
update_dynamic_varobj_children (struct varobj *var,
VEC (varobj_p) **changed,
int from,
int to)
{
-#if HAVE_PYTHON
- struct cleanup *back_to;
- PyObject *children;
int i;
- PyObject *printer = var->dynamic->pretty_printer;
-
- if (!gdb_python_initialized)
- return 0;
-
- back_to = varobj_ensure_python_env (var);
*cchanged = 0;
- if (!PyObject_HasAttr (printer, gdbpy_children_cst))
- {
- do_cleanups (back_to);
- return 0;
- }
if (update_children || var->dynamic->child_iter == NULL)
{
- children = PyObject_CallMethodObjArgs (printer, gdbpy_children_cst,
- NULL);
+ varobj_iter_delete (var->dynamic->child_iter);
+ var->dynamic->child_iter = varobj_get_iterator (var);
- if (!children)
- {
- gdbpy_print_stack ();
- error (_("Null value returned for children"));
- }
+ varobj_clear_saved_item (var->dynamic);
- make_cleanup_py_decref (children);
+ i = 0;
- Py_XDECREF (var->dynamic->child_iter);
- var->dynamic->child_iter = PyObject_GetIter (children);
if (var->dynamic->child_iter == NULL)
- {
- gdbpy_print_stack ();
- error (_("Could not get children iterator"));
- }
-
- Py_XDECREF (var->dynamic->saved_item);
- var->dynamic->saved_item = NULL;
-
- i = 0;
+ return 0;
}
else
i = VEC_length (varobj_p, var->children);
are more children. */
for (; to < 0 || i < to + 1; ++i)
{
- PyObject *item;
- int force_done = 0;
+ varobj_item *item;
/* See if there was a leftover from last time. */
- if (var->dynamic->saved_item)
+ if (var->dynamic->saved_item != NULL)
{
item = var->dynamic->saved_item;
var->dynamic->saved_item = NULL;
}
else
- item = PyIter_Next (var->dynamic->child_iter);
-
- if (!item)
{
- /* Normal end of iteration. */
- if (!PyErr_Occurred ())
- break;
-
- /* If we got a memory error, just use the text as the
- item. */
- if (PyErr_ExceptionMatches (gdbpy_gdb_memory_error))
- {
- PyObject *type, *value, *trace;
- char *name_str, *value_str;
-
- PyErr_Fetch (&type, &value, &trace);
- value_str = gdbpy_exception_to_string (type, value);
- Py_XDECREF (type);
- Py_XDECREF (value);
- Py_XDECREF (trace);
- if (!value_str)
- {
- gdbpy_print_stack ();
- break;
- }
-
- name_str = xstrprintf ("<error at %d>", i);
- item = Py_BuildValue ("(ss)", name_str, value_str);
- xfree (name_str);
- xfree (value_str);
- if (!item)
- {
- gdbpy_print_stack ();
- break;
- }
-
- force_done = 1;
- }
- else
- {
- /* Any other kind of error. */
- gdbpy_print_stack ();
- break;
- }
+ item = varobj_iter_next (var->dynamic->child_iter);
+ /* Release vitem->value so its lifetime is not bound to the
+ execution of a command. */
+ if (item != NULL && item->value != NULL)
+ release_value_or_incref (item->value);
}
+ if (item == NULL)
+ {
+ /* Iteration is done. Remove iterator from VAR. */
+ varobj_iter_delete (var->dynamic->child_iter);
+ var->dynamic->child_iter = NULL;
+ break;
+ }
/* We don't want to push the extra child on any report list. */
if (to < 0 || i < to)
{
- PyObject *py_v;
- const char *name;
- struct value *v;
- struct cleanup *inner;
int can_mention = from < 0 || i >= from;
- inner = make_cleanup_py_decref (item);
-
- if (!PyArg_ParseTuple (item, "sO", &name, &py_v))
- {
- gdbpy_print_stack ();
- error (_("Invalid item from the child list"));
- }
-
- v = convert_value_from_python (py_v);
- if (v == NULL)
- gdbpy_print_stack ();
install_dynamic_child (var, can_mention ? changed : NULL,
can_mention ? type_changed : NULL,
can_mention ? new : NULL,
can_mention ? unchanged : NULL,
can_mention ? cchanged : NULL, i,
- xstrdup (name), v);
- do_cleanups (inner);
+ item);
+
+ xfree (item);
}
else
{
- Py_XDECREF (var->dynamic->saved_item);
var->dynamic->saved_item = item;
/* We want to truncate the child list just before this
element. */
break;
}
-
- if (force_done)
- break;
}
if (i < VEC_length (varobj_p, var->children))
*cchanged = 1;
var->num_children = VEC_length (varobj_p, var->children);
-
- do_cleanups (back_to);
return 1;
-#else
- gdb_assert_not_reached ("should never be called if Python is not enabled");
-#endif
}
int
{
if (var->num_children == -1)
{
- if (var->dynamic->pretty_printer != NULL)
+ if (varobj_is_dynamic_p (var))
{
int dummy;
var->dynamic->children_requested = 1;
- if (var->dynamic->pretty_printer != NULL)
+ if (varobj_is_dynamic_p (var))
{
/* This, in theory, can result in the number of children changing without
frontend noticing. But well, calling -var-list-children on the same
return var->children;
}
-#if HAVE_PYTHON
-
static struct varobj *
-varobj_add_child (struct varobj *var, char *name, struct value *value)
+varobj_add_child (struct varobj *var, struct varobj_item *item)
{
- varobj_p v = create_child_with_value (var,
+ varobj_p v = create_child_with_value (var,
VEC_length (varobj_p, var->children),
- name, value);
+ item);
VEC_safe_push (varobj_p, var->children, v);
return v;
}
-#endif /* HAVE_PYTHON */
-
/* Obtain the type of an object Variable as a string similar to the one gdb
prints on the console. */
char *
varobj_get_type (struct varobj *var)
{
- /* For the "fake" variables, do not return a type. (It's type is
+ /* For the "fake" variables, do not return a type. (Its type is
NULL, too.)
Do not return a type for invalid variables as well. */
if (CPLUS_FAKE_CHILD (var) || !var->root->is_valid)
static int
is_path_expr_parent (struct varobj *var)
{
- struct type *type;
-
- /* "Fake" children are not path_expr parents. */
- if (CPLUS_FAKE_CHILD (var))
- return 0;
+ gdb_assert (var->root->lang_ops->is_path_expr_parent != NULL);
+ return var->root->lang_ops->is_path_expr_parent (var);
+}
- type = varobj_get_value_type (var);
+/* Is VAR a path expression parent, i.e., can it be used to construct
+ a valid path expression? By default we assume any VAR can be a path
+ parent. */
- /* Anonymous unions and structs are also not path_expr parents. */
- return !((TYPE_CODE (type) == TYPE_CODE_STRUCT
- || TYPE_CODE (type) == TYPE_CODE_UNION)
- && TYPE_NAME (type) == NULL);
+int
+varobj_default_is_path_expr_parent (struct varobj *var)
+{
+ return 1;
}
/* Return the path expression parent for VAR. */
when creating varobj, so here it should be
child varobj. */
gdb_assert (!is_root_p (var));
- return (*var->root->lang->path_expr_of_child) (var);
+ return (*var->root->lang_ops->path_expr_of_child) (var);
}
}
-enum varobj_languages
+const struct language_defn *
varobj_get_language (struct varobj *var)
{
- return variable_language (var);
+ return var->root->exp->language_defn;
}
int
return attributes;
}
+/* Return true if VAR is a dynamic varobj. */
+
int
-varobj_pretty_printed_p (struct varobj *var)
+varobj_is_dynamic_p (struct varobj *var)
{
return var->dynamic->pretty_printer != NULL;
}
Py_XDECREF (var->pretty_printer);
var->pretty_printer = visualizer;
- Py_XDECREF (var->child_iter);
+ varobj_iter_delete (var->child_iter);
var->child_iter = NULL;
}
if (var->num_children < 0)
return 0;
- if (var->root->lang->value_has_mutated)
- return var->root->lang->value_has_mutated (var, new_value, new_type);
+ if (var->root->lang_ops->value_has_mutated)
+ {
+ /* The varobj module, when installing new values, explicitly strips
+ references, saying that we're not interested in those addresses.
+ But detection of mutation happens before installing the new
+ value, so our value may be a reference that we need to strip
+ in order to remain consistent. */
+ if (new_value != NULL)
+ new_value = coerce_ref (new_value);
+ return var->root->lang_ops->value_has_mutated (var, new_value, new_type);
+ }
else
return 0;
}
if (new)
new_type = value_type (new);
else
- new_type = v->root->lang->type_of_child (v->parent, v->index);
+ new_type = v->root->lang_ops->type_of_child (v->parent, v->index);
if (varobj_value_has_mutated (v, new, new_type))
{
}
}
- /* We probably should not get children of a varobj that has a
- pretty-printer, but for which -var-list-children was never
- invoked. */
- if (v->dynamic->pretty_printer != NULL)
+ /* We probably should not get children of a dynamic varobj, but
+ for which -var-list-children was never invoked. */
+ if (varobj_is_dynamic_p (v))
{
VEC (varobj_p) *changed = 0, *type_changed = 0, *unchanged = 0;
VEC (varobj_p) *new = 0;
static struct varobj *
create_child (struct varobj *parent, int index, char *name)
{
- return create_child_with_value (parent, index, name,
- value_of_child (parent, index));
+ struct varobj_item item;
+
+ item.name = name;
+ item.value = value_of_child (parent, index);
+
+ return create_child_with_value (parent, index, &item);
}
static struct varobj *
-create_child_with_value (struct varobj *parent, int index, char *name,
- struct value *value)
+create_child_with_value (struct varobj *parent, int index,
+ struct varobj_item *item)
{
struct varobj *child;
char *childs_name;
child = new_variable ();
/* NAME is allocated by caller. */
- child->name = name;
+ child->name = item->name;
child->index = index;
child->parent = parent;
child->root = parent->root;
if (varobj_is_anonymous_child (child))
childs_name = xstrprintf ("%s.%d_anonymous", parent->obj_name, index);
else
- childs_name = xstrprintf ("%s.%s", parent->obj_name, name);
+ childs_name = xstrprintf ("%s.%s", parent->obj_name, item->name);
child->obj_name = childs_name;
install_variable (child);
/* Compute the type of the child. Must do this before
calling install_new_value. */
- if (value != NULL)
+ if (item->value != NULL)
/* If the child had no evaluation errors, var->value
will be non-NULL and contain a valid type. */
- child->type = value_actual_type (value, 0, NULL);
+ child->type = value_actual_type (item->value, 0, NULL);
else
/* Otherwise, we must compute the type. */
- child->type = (*child->root->lang->type_of_child) (child->parent,
- child->index);
- install_new_value (child, value, 1);
+ child->type = (*child->root->lang_ops->type_of_child) (child->parent,
+ child->index);
+ install_new_value (child, item->value, 1);
return child;
}
struct varobj *var = new_variable ();
var->root = (struct varobj_root *) xmalloc (sizeof (struct varobj_root));
- var->root->lang = NULL;
+ var->root->lang_ops = NULL;
var->root->exp = NULL;
var->root->valid_block = NULL;
var->root->frame = null_frame_id;
Py_XDECREF (var->dynamic->constructor);
Py_XDECREF (var->dynamic->pretty_printer);
- Py_XDECREF (var->dynamic->child_iter);
- Py_XDECREF (var->dynamic->saved_item);
do_cleanups (cleanup);
}
#endif
+ varobj_iter_delete (var->dynamic->child_iter);
+ varobj_clear_saved_item (var->dynamic);
value_free (var->value);
/* Free the expression if this is a root variable. */
/* Common entry points */
-/* Get the language of variable VAR. */
-static enum varobj_languages
-variable_language (struct varobj *var)
-{
- enum varobj_languages lang;
-
- switch (var->root->exp->language_defn->la_language)
- {
- default:
- case language_c:
- lang = vlang_c;
- break;
- case language_cplus:
- lang = vlang_cplus;
- break;
- case language_java:
- lang = vlang_java;
- break;
- case language_ada:
- lang = vlang_ada;
- break;
- }
-
- return lang;
-}
-
/* Return the number of children for a given variable.
The result of this function is defined by the language
implementation. The number of children returned by this function
static int
number_of_children (struct varobj *var)
{
- return (*var->root->lang->number_of_children) (var);
+ return (*var->root->lang_ops->number_of_children) (var);
}
/* What is the expression for the root varobj VAR? Returns a malloc'd
static char *
name_of_variable (struct varobj *var)
{
- return (*var->root->lang->name_of_variable) (var);
+ return (*var->root->lang_ops->name_of_variable) (var);
}
/* What is the name of the INDEX'th child of VAR? Returns a malloc'd
static char *
name_of_child (struct varobj *var, int index)
{
- return (*var->root->lang->name_of_child) (var, index);
+ return (*var->root->lang_ops->name_of_child) (var, index);
}
/* If frame associated with VAR can be found, switch
{
struct value *value;
- value = (*parent->root->lang->value_of_child) (parent, index);
+ value = (*parent->root->lang_ops->value_of_child) (parent, index);
return value;
}
{
if (var->dynamic->pretty_printer != NULL)
return varobj_value_get_print_value (var->value, var->format, var);
- return (*var->root->lang->value_of_variable) (var, format);
+ return (*var->root->lang_ops->value_of_variable) (var, format);
}
else
return NULL;
int
varobj_value_is_changeable_p (struct varobj *var)
{
- return var->root->lang->value_is_changeable_p (var);
+ return var->root->lang_ops->value_is_changeable_p (var);
}
/* Return 1 if that varobj is floating, that is is always evaluated in the
varobj_table = xmalloc (sizeof_table);
memset (varobj_table, 0, sizeof_table);
- add_setshow_zuinteger_cmd ("debugvarobj", class_maintenance,
+ add_setshow_zuinteger_cmd ("varobj", class_maintenance,
&varobjdebug,
_("Set varobj debugging."),
_("Show varobj debugging."),
_("When non-zero, varobj debugging is enabled."),
NULL, show_varobjdebug,
- &setlist, &showlist);
+ &setdebuglist, &showdebuglist);
}
/* Invalidate varobj VAR if it is tied to locals and re-create it if it is