1 /* GDB variable objects API.
2 Copyright (C) 1999-2013 Free Software Foundation, Inc.
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 3 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program. If not, see <http://www.gnu.org/licenses/>. */
24 /* Enumeration for the format types */
25 enum varobj_display_formats
27 FORMAT_NATURAL, /* What gdb actually calls 'natural' */
28 FORMAT_BINARY, /* Binary display */
29 FORMAT_DECIMAL, /* Decimal display */
30 FORMAT_HEXADECIMAL, /* Hex display */
31 FORMAT_OCTAL /* Octal display */
36 USE_SPECIFIED_FRAME, /* Use the frame passed to varobj_create. */
37 USE_CURRENT_FRAME, /* Use the current frame. */
38 USE_SELECTED_FRAME /* Always reevaluate in selected frame. */
41 /* Enumerator describing if a variable object is in scope. */
42 enum varobj_scope_status
44 VAROBJ_IN_SCOPE = 0, /* Varobj is scope, value available. */
45 VAROBJ_NOT_IN_SCOPE = 1, /* Varobj is not in scope, value not
46 available, but varobj can become in
48 VAROBJ_INVALID = 2, /* Varobj no longer has any value, and never
52 /* String representations of gdb's format codes (defined in varobj.c). */
53 extern char *varobj_format_string[];
55 /* Languages supported by this variable objects system. This enum is used
56 to index arrays so we make its first enum explicitly zero. */
59 vlang_c = 0, vlang_cplus, vlang_java, vlang_ada, vlang_end
62 /* String representations of gdb's known languages (defined in varobj.c). */
63 extern char *varobj_language_string[];
65 /* Struct thar describes a variable object instance. */
69 typedef struct varobj *varobj_p;
72 typedef struct varobj_update_result_t
74 struct varobj *varobj;
78 enum varobj_scope_status status;
79 /* This variable is used internally by varobj_update to indicate if the
80 new value of varobj is already computed and installed, or has to
81 be yet installed. Don't use this outside varobj.c. */
84 /* This will be non-NULL when new children were added to the varobj.
85 It lists the new children (which must necessarily come at the end
86 of the child list) added during an update. The caller is
87 responsible for freeing this vector. */
89 } varobj_update_result;
91 DEF_VEC_O (varobj_update_result);
94 struct varobj_dynamic;
96 /* Every variable in the system has a structure of this type defined
97 for it. This structure holds all information necessary to manipulate
98 a particular object variable. Members which must be freed are noted. */
101 /* Alloc'd name of the variable for this object. If this variable is a
102 child, then this name will be the child's source name.
103 (bar, not foo.bar). */
104 /* NOTE: This is the "expression". */
107 /* Alloc'd expression for this child. Can be used to create a
108 root variable corresponding to this child. */
111 /* The alloc'd name for this variable's object. This is here for
112 convenience when constructing this object's children. */
115 /* Index of this variable in its parent or -1. */
118 /* The type of this variable. This can be NULL
119 for artifial variable objects -- currently, the "accessibility"
120 variable objects in C++. */
123 /* The value of this expression or subexpression. A NULL value
124 indicates there was an error getting this value.
125 Invariant: if varobj_value_is_changeable_p (this) is non-zero,
126 the value is either NULL, or not lazy. */
129 /* The number of (immediate) children this variable has. */
132 /* If this object is a child, this points to its immediate parent. */
133 struct varobj *parent;
135 /* Children of this object. */
136 VEC (varobj_p) *children;
138 /* Description of the root variable. Points to root variable for
140 struct varobj_root *root;
142 /* The format of the output for this object. */
143 enum varobj_display_formats format;
145 /* Was this variable updated via a varobj_set_value operation. */
148 /* Last print value. */
151 /* Is this variable frozen. Frozen variables are never implicitly
152 updated by -var-update *
153 or -var-update <direct-or-indirect-parent>. */
156 /* Is the value of this variable intentionally not fetched? It is
157 not fetched if either the variable is frozen, or any parents is
161 /* Sub-range of children which the MI consumer has requested. If
162 FROM < 0 or TO < 0, means that all children have been
167 /* Dynamic part of varobj. */
168 struct varobj_dynamic *dynamic;
171 /* Is the variable X one of our "fake" children? */
172 #define CPLUS_FAKE_CHILD(x) \
173 ((x) != NULL && (x)->type == NULL && (x)->value == NULL)
175 /* The language specific vector */
177 struct lang_varobj_ops
179 /* The number of children of PARENT. */
180 int (*number_of_children) (struct varobj * parent);
182 /* The name (expression) of a root varobj. */
183 char *(*name_of_variable) (struct varobj * parent);
185 /* The name of the INDEX'th child of PARENT. */
186 char *(*name_of_child) (struct varobj * parent, int index);
188 /* Returns the rooted expression of CHILD, which is a variable
189 obtain that has some parent. */
190 char *(*path_expr_of_child) (struct varobj * child);
192 /* The ``struct value *'' of the INDEX'th child of PARENT. */
193 struct value *(*value_of_child) (struct varobj * parent, int index);
195 /* The type of the INDEX'th child of PARENT. */
196 struct type *(*type_of_child) (struct varobj * parent, int index);
198 /* The current value of VAR. */
199 char *(*value_of_variable) (struct varobj * var,
200 enum varobj_display_formats format);
202 /* Return non-zero if changes in value of VAR must be detected and
203 reported by -var-update. Return zero if -var-update should never
204 report changes of such values. This makes sense for structures
205 (since the changes in children values will be reported separately),
206 or for artifical objects (like 'public' pseudo-field in C++).
208 Return value of 0 means that gdb need not call value_fetch_lazy
209 for the value of this variable object. */
210 int (*value_is_changeable_p) (struct varobj *var);
212 /* Return nonzero if the type of VAR has mutated.
214 VAR's value is still the varobj's previous value, while NEW_VALUE
215 is VAR's new value and NEW_TYPE is the var's new type. NEW_VALUE
216 may be NULL indicating that there is no value available (the varobj
217 may be out of scope, of may be the child of a null pointer, for
218 instance). NEW_TYPE, on the other hand, must never be NULL.
220 This function should also be able to assume that var's number of
221 children is set (not < 0).
223 Languages where types do not mutate can set this to NULL. */
224 int (*value_has_mutated) (struct varobj *var, struct value *new_value,
225 struct type *new_type);
228 const struct lang_varobj_ops c_varobj_ops;
229 const struct lang_varobj_ops cplus_varobj_ops;
230 const struct lang_varobj_ops java_varobj_ops;
231 const struct lang_varobj_ops ada_varobj_ops;
235 extern struct varobj *varobj_create (char *objname,
236 char *expression, CORE_ADDR frame,
237 enum varobj_type type);
239 extern char *varobj_gen_name (void);
241 extern struct varobj *varobj_get_handle (char *name);
243 extern char *varobj_get_objname (struct varobj *var);
245 extern char *varobj_get_expression (struct varobj *var);
247 extern int varobj_delete (struct varobj *var, char ***dellist,
250 extern enum varobj_display_formats varobj_set_display_format (
252 enum varobj_display_formats format);
254 extern enum varobj_display_formats varobj_get_display_format (
257 extern int varobj_get_thread_id (struct varobj *var);
259 extern void varobj_set_frozen (struct varobj *var, int frozen);
261 extern int varobj_get_frozen (struct varobj *var);
263 extern void varobj_get_child_range (struct varobj *var, int *from, int *to);
265 extern void varobj_set_child_range (struct varobj *var, int from, int to);
267 extern char *varobj_get_display_hint (struct varobj *var);
269 extern int varobj_get_num_children (struct varobj *var);
271 /* Return the list of children of VAR. The returned vector should not
272 be modified in any way. FROM and TO are in/out parameters
273 indicating the range of children to return. If either *FROM or *TO
274 is less than zero on entry, then all children will be returned. On
275 return, *FROM and *TO will be updated to indicate the real range
276 that was returned. The resulting VEC will contain at least the
277 children from *FROM to just before *TO; it might contain more
278 children, depending on whether any more were available. */
279 extern VEC (varobj_p)* varobj_list_children (struct varobj *var,
282 extern char *varobj_get_type (struct varobj *var);
284 extern struct type *varobj_get_gdb_type (struct varobj *var);
286 extern char *varobj_get_path_expr (struct varobj *var);
288 extern enum varobj_languages varobj_get_language (struct varobj *var);
290 extern int varobj_get_attributes (struct varobj *var);
292 extern char *varobj_get_formatted_value (struct varobj *var,
293 enum varobj_display_formats format);
295 extern char *varobj_get_value (struct varobj *var);
297 extern int varobj_set_value (struct varobj *var, char *expression);
299 extern void all_root_varobjs (void (*func) (struct varobj *var, void *data),
302 extern VEC(varobj_update_result) *varobj_update (struct varobj **varp,
305 extern void varobj_invalidate (void);
307 extern int varobj_editable_p (struct varobj *var);
309 extern int varobj_floating_p (struct varobj *var);
311 extern void varobj_set_visualizer (struct varobj *var,
312 const char *visualizer);
314 extern void varobj_enable_pretty_printing (void);
316 extern int varobj_has_more (struct varobj *var, int to);
318 extern int varobj_pretty_printed_p (struct varobj *var);
320 extern int varobj_default_value_is_changeable_p (struct varobj *var);
321 extern int varobj_value_is_changeable_p (struct varobj *var);
323 extern struct type *varobj_get_value_type (struct varobj *var);
325 extern int varobj_is_anonymous_child (struct varobj *child);
327 extern struct varobj *varobj_get_path_expr_parent (struct varobj *var);
329 extern char *varobj_value_get_print_value (struct value *value,
330 enum varobj_display_formats format,
333 extern void varobj_formatted_print_options (struct value_print_options *opts,
334 enum varobj_display_formats format);
336 extern void varobj_restrict_range (VEC (varobj_p) *children, int *from,
338 #endif /* VAROBJ_H */