GDB (xrefs)
/tmp/gdb-7.10/gdb/varobj.h
Go to the documentation of this file.
1 /* GDB variable objects API.
2  Copyright (C) 1999-2015 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 */
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 
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. */
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). */
53 extern char *varobj_format_string[];
54 
55 /* Struct thar describes a variable object instance. */
56 
57 struct varobj;
58 
59 typedef struct varobj *varobj_p;
60 DEF_VEC_P (varobj_p);
61 
62 typedef struct varobj_update_result_t
63 {
64  struct varobj *varobj;
67  int changed;
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. */
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) *newobj;
80 
82 
83 struct varobj_root;
84 struct 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. */
89 struct 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. */
121 
122  /* If this object is a child, this points to its immediate parent. */
123  const 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. */
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. */
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. */
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 
168 {
169  /* The number of children of PARENT. */
170  int (*number_of_children) (const struct varobj *parent);
171 
172  /* The name (expression) of a root varobj. The returned value must be freed
173  by the caller. */
174  char *(*name_of_variable) (const struct varobj *parent);
175 
176  /* The name of the INDEX'th child of PARENT. The returned value must be
177  freed by the caller. */
178  char *(*name_of_child) (const struct varobj *parent, int index);
179 
180  /* Returns the rooted expression of CHILD, which is a variable
181  obtain that has some parent. The returned value must be freed by the
182  caller. */
183  char *(*path_expr_of_child) (const struct varobj *child);
184 
185  /* The ``struct value *'' of the INDEX'th child of PARENT. */
186  struct value *(*value_of_child) (const struct varobj *parent, int index);
187 
188  /* The type of the INDEX'th child of PARENT. */
189  struct type *(*type_of_child) (const struct varobj *parent, int index);
190 
191  /* The current value of VAR. The returned value must be freed by the
192  caller. */
193  char *(*value_of_variable) (const struct varobj *var,
195 
196  /* Return non-zero if changes in value of VAR must be detected and
197  reported by -var-update. Return zero if -var-update should never
198  report changes of such values. This makes sense for structures
199  (since the changes in children values will be reported separately),
200  or for artifical objects (like 'public' pseudo-field in C++).
201 
202  Return value of 0 means that gdb need not call value_fetch_lazy
203  for the value of this variable object. */
204  int (*value_is_changeable_p) (const struct varobj *var);
205 
206  /* Return nonzero if the type of VAR has mutated.
207 
208  VAR's value is still the varobj's previous value, while NEW_VALUE
209  is VAR's new value and NEW_TYPE is the var's new type. NEW_VALUE
210  may be NULL indicating that there is no value available (the varobj
211  may be out of scope, of may be the child of a null pointer, for
212  instance). NEW_TYPE, on the other hand, must never be NULL.
213 
214  This function should also be able to assume that var's number of
215  children is set (not < 0).
216 
217  Languages where types do not mutate can set this to NULL. */
218  int (*value_has_mutated) (const struct varobj *var, struct value *new_value,
219  struct type *new_type);
220 
221  /* Return nonzero if VAR is a suitable path expression parent.
222 
223  For C like languages with anonymous structures and unions an anonymous
224  structure or union is not a suitable parent. */
225  int (*is_path_expr_parent) (const struct varobj *var);
226 };
227 
228 extern const struct lang_varobj_ops c_varobj_ops;
229 extern const struct lang_varobj_ops cplus_varobj_ops;
230 extern const struct lang_varobj_ops java_varobj_ops;
231 extern const struct lang_varobj_ops ada_varobj_ops;
232 
233 #define default_varobj_ops c_varobj_ops
234 /* API functions */
235 
236 extern struct varobj *varobj_create (char *objname,
237  char *expression, CORE_ADDR frame,
238  enum varobj_type type);
239 
240 extern char *varobj_gen_name (void);
241 
242 extern struct varobj *varobj_get_handle (char *name);
243 
244 extern char *varobj_get_objname (const struct varobj *var);
245 
246 extern char *varobj_get_expression (const struct varobj *var);
247 
248 extern int varobj_delete (struct varobj *var, char ***dellist,
249  int only_children);
250 
252  struct varobj *var,
254 
256  const struct varobj *var);
257 
258 extern int varobj_get_thread_id (const struct varobj *var);
259 
260 extern void varobj_set_frozen (struct varobj *var, int frozen);
261 
262 extern int varobj_get_frozen (const struct varobj *var);
263 
264 extern void varobj_get_child_range (const struct varobj *var, int *from,
265  int *to);
266 
267 extern void varobj_set_child_range (struct varobj *var, int from, int to);
268 
269 extern char *varobj_get_display_hint (const struct varobj *var);
270 
271 extern int varobj_get_num_children (struct varobj *var);
272 
273 /* Return the list of children of VAR. The returned vector should not
274  be modified in any way. FROM and TO are in/out parameters
275  indicating the range of children to return. If either *FROM or *TO
276  is less than zero on entry, then all children will be returned. On
277  return, *FROM and *TO will be updated to indicate the real range
278  that was returned. The resulting VEC will contain at least the
279  children from *FROM to just before *TO; it might contain more
280  children, depending on whether any more were available. */
281 extern VEC (varobj_p)* varobj_list_children (struct varobj *var,
282  int *from, int *to);
283 
284 extern char *varobj_get_type (struct varobj *var);
285 
286 extern struct type *varobj_get_gdb_type (const struct varobj *var);
287 
288 extern char *varobj_get_path_expr (const struct varobj *var);
289 
290 extern const struct language_defn *
291  varobj_get_language (const struct varobj *var);
292 
293 extern int varobj_get_attributes (const struct varobj *var);
294 
295 extern char *varobj_get_formatted_value (struct varobj *var,
296  enum varobj_display_formats format);
297 
298 extern char *varobj_get_value (struct varobj *var);
299 
300 extern int varobj_set_value (struct varobj *var, char *expression);
301 
302 extern void all_root_varobjs (void (*func) (struct varobj *var, void *data),
303  void *data);
304 
305 extern VEC(varobj_update_result) *varobj_update (struct varobj **varp,
307 
308 extern void varobj_invalidate (void);
309 
310 extern int varobj_editable_p (const struct varobj *var);
311 
312 extern int varobj_floating_p (const struct varobj *var);
313 
314 extern void varobj_set_visualizer (struct varobj *var,
315  const char *visualizer);
316 
317 extern void varobj_enable_pretty_printing (void);
318 
319 extern int varobj_has_more (const struct varobj *var, int to);
320 
321 extern int varobj_is_dynamic_p (const struct varobj *var);
322 
323 extern struct cleanup *varobj_ensure_python_env (const struct varobj *var);
324 
325 extern int varobj_default_value_is_changeable_p (const struct varobj *var);
326 extern int varobj_value_is_changeable_p (const struct varobj *var);
327 
328 extern struct type *varobj_get_value_type (const struct varobj *var);
329 
330 extern int varobj_is_anonymous_child (const struct varobj *child);
331 
332 extern const struct varobj *
333  varobj_get_path_expr_parent (const struct varobj *var);
334 
335 extern char *varobj_value_get_print_value (struct value *value,
337  const struct varobj *var);
338 
339 extern void varobj_formatted_print_options (struct value_print_options *opts,
341 
342 extern void varobj_restrict_range (VEC (varobj_p) *children, int *from,
343  int *to);
344 
345 extern int varobj_default_is_path_expr_parent (const struct varobj *var);
346 
347 #endif /* VAROBJ_H */
void varobj_set_visualizer(struct varobj *var, const char *visualizer)
Definition: varobj.c:1543
char * varobj_get_display_hint(const struct varobj *var)
Definition: varobj.c:611
int index
Definition: varobj.h:106
Definition: varobj.h:89
char * varobj_gen_name(void)
Definition: varobj.c:450
bfd_vma CORE_ADDR
Definition: common-types.h:41
int is_explicit
Definition: varobj.h:306
VEC(varobj_p)*children
const struct lang_varobj_ops cplus_varobj_ops
Definition: c-varobj.c:959
void(* func)(char *)
int varobj_get_frozen(const struct varobj *var)
Definition: varobj.c:670
int varobj_default_is_path_expr_parent(const struct varobj *var)
Definition: varobj.c:1016
void varobj_set_frozen(struct varobj *var, int frozen)
Definition: varobj.c:657
char * varobj_get_formatted_value(struct varobj *var, enum varobj_display_formats format)
Definition: varobj.c:1080
int(* is_path_expr_parent)(const struct varobj *var)
Definition: varobj.h:225
void all_root_varobjs(void(*func)(struct varobj *var, void *data), void *data)
Definition: varobj.c:2735
int not_fetched
Definition: varobj.h:149
static struct type * new_type(char *)
Definition: mdebugread.c:4864
int(* value_has_mutated)(const struct varobj *var, struct value *new_value, struct type *new_type)
Definition: varobj.h:218
const struct varobj * parent
Definition: varobj.h:123
varobj_scope_status
Definition: varobj.h:42
DEF_VEC_O(varobj_update_result)
int(* number_of_children)(const struct varobj *parent)
Definition: varobj.h:170
const char *const name
Definition: aarch64-tdep.c:68
int * from
Definition: varobj.h:282
int varobj_editable_p(const struct varobj *var)
Definition: varobj.c:2660
enum varobj_scope_status status
Definition: varobj.h:68
void varobj_restrict_range(VEC(varobj_p)*children, int *from, int *to)
Definition: varobj.c:681
int varobj_is_anonymous_child(const struct varobj *child)
Definition: c-varobj.c:38
const struct language_defn * varobj_get_language(const struct varobj *var)
Definition: varobj.c:1054
char * varobj_get_path_expr(const struct varobj *var)
Definition: varobj.c:1037
void varobj_enable_pretty_printing(void)
Definition: varobj.c:59
struct cleanup * varobj_ensure_python_env(const struct varobj *var)
Definition: varobj.c:242
struct type * type
Definition: varobj.h:111
Definition: gdbtypes.h:749
int varobj_has_more(const struct varobj *var, int to)
Definition: varobj.c:635
int from
Definition: varobj.h:154
int varobj_floating_p(const struct varobj *var)
Definition: varobj.c:2697
struct value * value
Definition: varobj.h:117
struct varobj_dynamic * dynamic
Definition: varobj.h:158
char * varobj_get_type(struct varobj *var)
Definition: varobj.c:982
VEC(varobj_p)*newobj
const struct lang_varobj_ops ada_varobj_ops
Definition: ada-varobj.c:1032
void varobj_set_child_range(struct varobj *var, int from, int to)
Definition: varobj.c:1536
struct varobj_root * root
Definition: varobj.h:130
struct varobj * varobj_create(char *objname, char *expression, CORE_ADDR frame, enum varobj_type type)
Definition: varobj.c:284
Definition: value.c:172
char * varobj_format_string[]
Definition: varobj.c:52
struct type * varobj_get_value_type(const struct varobj *var)
Definition: varobj.c:2221
int num_children
Definition: varobj.h:120
void varobj_invalidate(void)
Definition: varobj.c:2786
const char const char int
Definition: command.h:229
struct varobj * varobj
Definition: varobj.h:64
char * obj_name
Definition: varobj.h:103
int updated
Definition: varobj.h:136
char * varobj_get_value(struct varobj *var)
Definition: varobj.c:1087
char * varobj_value_get_print_value(struct value *value, enum varobj_display_formats format, const struct varobj *var)
Definition: varobj.c:2527
enum varobj_display_formats varobj_get_display_format(const struct varobj *var)
Definition: varobj.c:605
int(* value_is_changeable_p)(const struct varobj *var)
Definition: varobj.h:204
char * path_expr
Definition: varobj.h:99
struct varobj * varobj_get_handle(char *name)
Definition: varobj.c:466
int varobj_value_is_changeable_p(const struct varobj *var)
Definition: varobj.c:2688
const struct lang_varobj_ops java_varobj_ops
Definition: jv-varobj.c:95
struct varobj_update_result_t varobj_update_result
void varobj_get_child_range(const struct varobj *var, int *from, int *to)
Definition: varobj.c:1526
VEC(varobj_p)*varobj_list_children(struct varobj *var
void varobj_formatted_print_options(struct value_print_options *opts, enum varobj_display_formats format)
Definition: varobj.c:2518
int varobj_get_attributes(const struct varobj *var)
Definition: varobj.c:1060
const struct lang_varobj_ops c_varobj_ops
Definition: c-varobj.c:545
int varobj_is_dynamic_p(const struct varobj *var)
Definition: varobj.c:1074
struct type * varobj_get_gdb_type(const struct varobj *var)
Definition: varobj.c:996
const struct varobj * varobj_get_path_expr_parent(const struct varobj *var)
Definition: varobj.c:1024
int varobj_delete(struct varobj *var, char ***dellist, int only_children)
Definition: varobj.c:512
char * print_value
Definition: varobj.h:139
varobj_type
Definition: varobj.h:34
int int * to
Definition: varobj.h:282
int frozen
Definition: varobj.h:144
struct varobj * varobj_p
Definition: varobj.h:59
enum varobj_display_formats format
Definition: varobj.h:133
char * varobj_get_objname(const struct varobj *var)
Definition: varobj.c:491
char * varobj_get_expression(const struct varobj *var)
Definition: varobj.c:500
DEF_VEC_P(varobj_p)
enum varobj_display_formats varobj_set_display_format(struct varobj *var, enum varobj_display_formats format)
Definition: varobj.c:576
int varobj_get_thread_id(const struct varobj *var)
Definition: varobj.c:648
char * name
Definition: varobj.h:95
int varobj_default_value_is_changeable_p(const struct varobj *var)
Definition: varobj.c:2706
int varobj_get_num_children(struct varobj *var)
Definition: varobj.c:893
int to
Definition: varobj.h:155
int varobj_set_value(struct varobj *var, char *expression)
Definition: varobj.c:1097
varobj_display_formats
Definition: varobj.h:25