varobj.h revision 1.1 
1/* GDB variable objects API.
2   Copyright (C) 1999-2014 Free Software Foundation, Inc.
3
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.
8
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.
13
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/>.  */
16
17#ifndef VAROBJ_H
18#define VAROBJ_H 1
19
20#include "symtab.h"
21#include "gdbtypes.h"
22#include "vec.h"
23
24/* Enumeration for the format types */
25enum varobj_display_formats
26  {
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                     */
32  };
33
34enum varobj_type
35  {
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.  */
39  };
40
41/* Enumerator describing if a variable object is in scope.  */
42enum varobj_scope_status
43  {
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
47				   scope later.  */
48    VAROBJ_INVALID = 2,         /* Varobj no longer has any value, and never
49				   will.  */
50  };
51
52/* String representations of gdb's format codes (defined in varobj.c).  */
53extern char *varobj_format_string[];
54
55/* Struct thar describes a variable object instance.  */
56
57struct varobj;
58
59typedef struct varobj *varobj_p;
60DEF_VEC_P (varobj_p);
61
62typedef struct varobj_update_result_t
63{
64  struct varobj *varobj;
65  int type_changed;
66  int children_changed;
67  int changed;
68  enum varobj_scope_status status;
69  /* This variable is used internally by varobj_update to indicate if the
70     new value of varobj is already computed and installed, or has to
71     be yet installed.  Don't use this outside varobj.c.  */
72  int value_installed;
73
74  /* This will be non-NULL when new children were added to the varobj.
75     It lists the new children (which must necessarily come at the end
76     of the child list) added during an update.  The caller is
77     responsible for freeing this vector.  */
78  VEC (varobj_p) *new;
79} varobj_update_result;
80
81DEF_VEC_O (varobj_update_result);
82
83struct varobj_root;
84struct varobj_dynamic;
85
86/* Every variable in the system has a structure of this type defined
87   for it.  This structure holds all information necessary to manipulate
88   a particular object variable.  Members which must be freed are noted.  */
89struct varobj
90{
91  /* Alloc'd name of the variable for this object.  If this variable is a
92     child, then this name will be the child's source name.
93     (bar, not foo.bar).  */
94  /* NOTE: This is the "expression".  */
95  char *name;
96
97  /* Alloc'd expression for this child.  Can be used to create a
98     root variable corresponding to this child.  */
99  char *path_expr;
100
101  /* The alloc'd name for this variable's object.  This is here for
102     convenience when constructing this object's children.  */
103  char *obj_name;
104
105  /* Index of this variable in its parent or -1.  */
106  int index;
107
108  /* The type of this variable.  This can be NULL
109     for artifial variable objects -- currently, the "accessibility"
110     variable objects in C++.  */
111  struct type *type;
112
113  /* The value of this expression or subexpression.  A NULL value
114     indicates there was an error getting this value.
115     Invariant: if varobj_value_is_changeable_p (this) is non-zero,
116     the value is either NULL, or not lazy.  */
117  struct value *value;
118
119  /* The number of (immediate) children this variable has.  */
120  int num_children;
121
122  /* If this object is a child, this points to its immediate parent.  */
123  struct varobj *parent;
124
125  /* Children of this object.  */
126  VEC (varobj_p) *children;
127
128  /* Description of the root variable.  Points to root variable for
129     children.  */
130  struct varobj_root *root;
131
132  /* The format of the output for this object.  */
133  enum varobj_display_formats format;
134
135  /* Was this variable updated via a varobj_set_value operation.  */
136  int updated;
137
138  /* Last print value.  */
139  char *print_value;
140
141  /* Is this variable frozen.  Frozen variables are never implicitly
142     updated by -var-update *
143     or -var-update <direct-or-indirect-parent>.  */
144  int frozen;
145
146  /* Is the value of this variable intentionally not fetched?  It is
147     not fetched if either the variable is frozen, or any parents is
148     frozen.  */
149  int not_fetched;
150
151  /* Sub-range of children which the MI consumer has requested.  If
152     FROM < 0 or TO < 0, means that all children have been
153     requested.  */
154  int from;
155  int to;
156
157  /* Dynamic part of varobj.  */
158  struct varobj_dynamic *dynamic;
159};
160
161/* Is the variable X one of our "fake" children?  */
162#define CPLUS_FAKE_CHILD(x) \
163((x) != NULL && (x)->type == NULL && (x)->value == NULL)
164
165/* The language specific vector */
166
167struct lang_varobj_ops
168{
169  /* The number of children of PARENT.  */
170  int (*number_of_children) (struct varobj *parent);
171
172  /* The name (expression) of a root varobj.  */
173  char *(*name_of_variable) (struct varobj *parent);
174
175  /* The name of the INDEX'th child of PARENT.  */
176  char *(*name_of_child) (struct varobj *parent, int index);
177
178  /* Returns the rooted expression of CHILD, which is a variable
179     obtain that has some parent.  */
180  char *(*path_expr_of_child) (struct varobj *child);
181
182  /* The ``struct value *'' of the INDEX'th child of PARENT.  */
183  struct value *(*value_of_child) (struct varobj *parent, int index);
184
185  /* The type of the INDEX'th child of PARENT.  */
186  struct type *(*type_of_child) (struct varobj *parent, int index);
187
188  /* The current value of VAR.  */
189  char *(*value_of_variable) (struct varobj *var,
190			      enum varobj_display_formats format);
191
192  /* Return non-zero if changes in value of VAR must be detected and
193     reported by -var-update.  Return zero if -var-update should never
194     report changes of such values.  This makes sense for structures
195     (since the changes in children values will be reported separately),
196     or for artifical objects (like 'public' pseudo-field in C++).
197
198     Return value of 0 means that gdb need not call value_fetch_lazy
199     for the value of this variable object.  */
200  int (*value_is_changeable_p) (struct varobj *var);
201
202  /* Return nonzero if the type of VAR has mutated.
203
204     VAR's value is still the varobj's previous value, while NEW_VALUE
205     is VAR's new value and NEW_TYPE is the var's new type.  NEW_VALUE
206     may be NULL indicating that there is no value available (the varobj
207     may be out of scope, of may be the child of a null pointer, for
208     instance).  NEW_TYPE, on the other hand, must never be NULL.
209
210     This function should also be able to assume that var's number of
211     children is set (not < 0).
212
213     Languages where types do not mutate can set this to NULL.  */
214  int (*value_has_mutated) (struct varobj *var, struct value *new_value,
215			    struct type *new_type);
216};
217
218const struct lang_varobj_ops c_varobj_ops;
219const struct lang_varobj_ops cplus_varobj_ops;
220const struct lang_varobj_ops java_varobj_ops;
221const struct lang_varobj_ops ada_varobj_ops;
222
223#define default_varobj_ops c_varobj_ops
224/* API functions */
225
226extern struct varobj *varobj_create (char *objname,
227				     char *expression, CORE_ADDR frame,
228				     enum varobj_type type);
229
230extern char *varobj_gen_name (void);
231
232extern struct varobj *varobj_get_handle (char *name);
233
234extern char *varobj_get_objname (struct varobj *var);
235
236extern char *varobj_get_expression (struct varobj *var);
237
238extern int varobj_delete (struct varobj *var, char ***dellist,
239			  int only_children);
240
241extern enum varobj_display_formats varobj_set_display_format (
242							 struct varobj *var,
243					enum varobj_display_formats format);
244
245extern enum varobj_display_formats varobj_get_display_format (
246							struct varobj *var);
247
248extern int varobj_get_thread_id (struct varobj *var);
249
250extern void varobj_set_frozen (struct varobj *var, int frozen);
251
252extern int varobj_get_frozen (struct varobj *var);
253
254extern void varobj_get_child_range (struct varobj *var, int *from, int *to);
255
256extern void varobj_set_child_range (struct varobj *var, int from, int to);
257
258extern char *varobj_get_display_hint (struct varobj *var);
259
260extern int varobj_get_num_children (struct varobj *var);
261
262/* Return the list of children of VAR.  The returned vector should not
263   be modified in any way.  FROM and TO are in/out parameters
264   indicating the range of children to return.  If either *FROM or *TO
265   is less than zero on entry, then all children will be returned.  On
266   return, *FROM and *TO will be updated to indicate the real range
267   that was returned.  The resulting VEC will contain at least the
268   children from *FROM to just before *TO; it might contain more
269   children, depending on whether any more were available.  */
270extern VEC (varobj_p)* varobj_list_children (struct varobj *var,
271					     int *from, int *to);
272
273extern char *varobj_get_type (struct varobj *var);
274
275extern struct type *varobj_get_gdb_type (struct varobj *var);
276
277extern char *varobj_get_path_expr (struct varobj *var);
278
279extern const struct language_defn *varobj_get_language (struct varobj *var);
280
281extern int varobj_get_attributes (struct varobj *var);
282
283extern char *varobj_get_formatted_value (struct varobj *var,
284					 enum varobj_display_formats format);
285
286extern char *varobj_get_value (struct varobj *var);
287
288extern int varobj_set_value (struct varobj *var, char *expression);
289
290extern void all_root_varobjs (void (*func) (struct varobj *var, void *data),
291			      void *data);
292
293extern VEC(varobj_update_result) *varobj_update (struct varobj **varp,
294						 int explicit);
295
296extern void varobj_invalidate (void);
297
298extern int varobj_editable_p (struct varobj *var);
299
300extern int varobj_floating_p (struct varobj *var);
301
302extern void varobj_set_visualizer (struct varobj *var,
303				   const char *visualizer);
304
305extern void varobj_enable_pretty_printing (void);
306
307extern int varobj_has_more (struct varobj *var, int to);
308
309extern int varobj_pretty_printed_p (struct varobj *var);
310
311extern int varobj_default_value_is_changeable_p (struct varobj *var);
312extern int varobj_value_is_changeable_p (struct varobj *var);
313
314extern struct type *varobj_get_value_type (struct varobj *var);
315
316extern int varobj_is_anonymous_child (struct varobj *child);
317
318extern struct varobj *varobj_get_path_expr_parent (struct varobj *var);
319
320extern char *varobj_value_get_print_value (struct value *value,
321					   enum varobj_display_formats format,
322					   struct varobj *var);
323
324extern void varobj_formatted_print_options (struct value_print_options *opts,
325					    enum varobj_display_formats format);
326
327extern void varobj_restrict_range (VEC (varobj_p) *children, int *from,
328				   int *to);
329#endif /* VAROBJ_H */
330