gdb/varobj.h

   1 /* GDB variable objects API.
   2    Copyright (C) 1999-2013 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 */
  25 enum 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
  34 enum 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.  */
  42 enum 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).  */
  53 extern char *varobj_format_string[];
  54
  55 /* Languages supported by this variable objects system.  This enum is used
  56    to index arrays so we make its first enum explicitly zero.  */
  57 enum varobj_languages
  58   {
  59     vlang_c = 0, vlang_cplus, vlang_java, vlang_ada, vlang_end
  60   };
  61
  62 /* String representations of gdb's known languages (defined in varobj.c).  */
  63 extern char *varobj_language_string[];
  64
  65 /* Struct thar describes a variable object instance.  */
  66
  67 struct varobj;
  68
  69 typedef struct varobj *varobj_p;
  70 DEF_VEC_P (varobj_p);
  71
  72 typedef struct varobj_update_result_t
  73 {
  74   struct varobj *varobj;
  75   int type_changed;
  76   int children_changed;
  77   int changed;
  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.  */
  82   int value_installed;
  83
  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.  */
  88   VEC (varobj_p) *new;
  89 } varobj_update_result;
  90
  91 DEF_VEC_O (varobj_update_result);
  92
  93 struct varobj_root;
  94 struct varobj_dynamic;
  95
  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.  */
  99 struct varobj
 100 {
 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".  */
 105   char *name;
 106
 107   /* Alloc'd expression for this child.  Can be used to create a
 108      root variable corresponding to this child.  */
 109   char *path_expr;
 110
 111   /* The alloc'd name for this variable's object.  This is here for
 112      convenience when constructing this object's children.  */
 113   char *obj_name;
 114
 115   /* Index of this variable in its parent or -1.  */
 116   int index;
 117
 118   /* The type of this variable.  This can be NULL
 119      for artifial variable objects -- currently, the "accessibility"
 120      variable objects in C++.  */
 121   struct type *type;
 122
 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.  */
 127   struct value *value;
 128
 129   /* The number of (immediate) children this variable has.  */
 130   int num_children;
 131
 132   /* If this object is a child, this points to its immediate parent.  */
 133   struct varobj *parent;
 134
 135   /* Children of this object.  */
 136   VEC (varobj_p) *children;
 137
 138   /* Description of the root variable.  Points to root variable for
 139      children.  */
 140   struct varobj_root *root;
 141
 142   /* The format of the output for this object.  */
 143   enum varobj_display_formats format;
 144
 145   /* Was this variable updated via a varobj_set_value operation.  */
 146   int updated;
 147
 148   /* Last print value.  */
 149   char *print_value;
 150
 151   /* Is this variable frozen.  Frozen variables are never implicitly
 152      updated by -var-update *
 153      or -var-update <direct-or-indirect-parent>.  */
 154   int frozen;
 155
 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
 158      frozen.  */
 159   int not_fetched;
 160
 161   /* Sub-range of children which the MI consumer has requested.  If
 162      FROM < 0 or TO < 0, means that all children have been
 163      requested.  */
 164   int from;
 165   int to;
 166
 167   /* Dynamic part of varobj.  */
 168   struct varobj_dynamic *dynamic;
 169 };
 170
 171 /* API functions */
 172
 173 extern struct varobj *varobj_create (char *objname,
 174                                      char *expression, CORE_ADDR frame,
 175                                      enum varobj_type type);
 176
 177 extern char *varobj_gen_name (void);
 178
 179 extern struct varobj *varobj_get_handle (char *name);
 180
 181 extern char *varobj_get_objname (struct varobj *var);
 182
 183 extern char *varobj_get_expression (struct varobj *var);
 184
 185 extern int varobj_delete (struct varobj *var, char ***dellist,
 186                           int only_children);
 187
 188 extern enum varobj_display_formats varobj_set_display_format (
 189                                                          struct varobj *var,
 190                                         enum varobj_display_formats format);
 191
 192 extern enum varobj_display_formats varobj_get_display_format (
 193                                                         struct varobj *var);
 194
 195 extern int varobj_get_thread_id (struct varobj *var);
 196
 197 extern void varobj_set_frozen (struct varobj *var, int frozen);
 198
 199 extern int varobj_get_frozen (struct varobj *var);
 200
 201 extern void varobj_get_child_range (struct varobj *var, int *from, int *to);
 202
 203 extern void varobj_set_child_range (struct varobj *var, int from, int to);
 204
 205 extern char *varobj_get_display_hint (struct varobj *var);
 206
 207 extern int varobj_get_num_children (struct varobj *var);
 208
 209 /* Return the list of children of VAR.  The returned vector should not
 210    be modified in any way.  FROM and TO are in/out parameters
 211    indicating the range of children to return.  If either *FROM or *TO
 212    is less than zero on entry, then all children will be returned.  On
 213    return, *FROM and *TO will be updated to indicate the real range
 214    that was returned.  The resulting VEC will contain at least the
 215    children from *FROM to just before *TO; it might contain more
 216    children, depending on whether any more were available.  */
 217 extern VEC (varobj_p)* varobj_list_children (struct varobj *var,
 218                                              int *from, int *to);
 219
 220 extern char *varobj_get_type (struct varobj *var);
 221
 222 extern struct type *varobj_get_gdb_type (struct varobj *var);
 223
 224 extern char *varobj_get_path_expr (struct varobj *var);
 225
 226 extern enum varobj_languages varobj_get_language (struct varobj *var);
 227
 228 extern int varobj_get_attributes (struct varobj *var);
 229
 230 extern char *varobj_get_formatted_value (struct varobj *var,
 231                                          enum varobj_display_formats format);
 232
 233 extern char *varobj_get_value (struct varobj *var);
 234
 235 extern int varobj_set_value (struct varobj *var, char *expression);
 236
 237 extern void all_root_varobjs (void (*func) (struct varobj *var, void *data),
 238                               void *data);
 239
 240 extern VEC(varobj_update_result) *varobj_update (struct varobj **varp,
 241                                                  int explicit);
 242
 243 extern void varobj_invalidate (void);
 244
 245 extern int varobj_editable_p (struct varobj *var);
 246
 247 extern int varobj_floating_p (struct varobj *var);
 248
 249 extern void varobj_set_visualizer (struct varobj *var,
 250                                    const char *visualizer);
 251
 252 extern void varobj_enable_pretty_printing (void);
 253
 254 extern int varobj_has_more (struct varobj *var, int to);
 255
 256 extern int varobj_pretty_printed_p (struct varobj *var);
 257
 258 #endif /* VAROBJ_H */