gdb/varobj.h

   1 /* GDB variable objects API.
   2    Copyright (C) 1999, 2000, 2001, 2005, 2007 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
  23 /* Enumeration for the format types */
  24 enum varobj_display_formats
  25   {
  26     FORMAT_NATURAL,             /* What gdb actually calls 'natural' */
  27     FORMAT_BINARY,              /* Binary display                    */
  28     FORMAT_DECIMAL,             /* Decimal display                   */
  29     FORMAT_HEXADECIMAL,         /* Hex display                       */
  30     FORMAT_OCTAL                /* Octal display                     */
  31   };
  32
  33 enum varobj_type
  34   {
  35     USE_SPECIFIED_FRAME,        /* Use the frame passed to varobj_create */
  36     USE_CURRENT_FRAME,          /* Use the current frame */
  37     USE_SELECTED_FRAME          /* Always reevaluate in selected frame */
  38   };
  39
  40 /* Error return values for varobj_update function.  */
  41 enum varobj_update_error
  42   {
  43     NOT_IN_SCOPE = -1,          /* varobj not in scope, can not be updated.  */
  44     TYPE_CHANGED = -2,          /* varobj type has changed.  */
  45     INVALID = -3,               /* varobj is not valid anymore.  */
  46   };
  47
  48 /* String representations of gdb's format codes (defined in varobj.c) */
  49 extern char *varobj_format_string[];
  50
  51 /* Languages supported by this variable objects system. */
  52 enum varobj_languages
  53   {
  54     vlang_unknown = 0, vlang_c, vlang_cplus, vlang_java, vlang_end
  55   };
  56
  57 /* String representations of gdb's known languages (defined in varobj.c) */
  58 extern char *varobj_language_string[];
  59
  60 /* Struct thar describes a variable object instance */
  61 struct varobj;
  62
  63 /* API functions */
  64
  65 extern struct varobj *varobj_create (char *objname,
  66                                      char *expression, CORE_ADDR frame,
  67                                      enum varobj_type type);
  68
  69 extern char *varobj_gen_name (void);
  70
  71 extern struct varobj *varobj_get_handle (char *name);
  72
  73 extern char *varobj_get_objname (struct varobj *var);
  74
  75 extern char *varobj_get_expression (struct varobj *var);
  76
  77 extern int varobj_delete (struct varobj *var, char ***dellist,
  78                           int only_children);
  79
  80 extern enum varobj_display_formats varobj_set_display_format (
  81                                                          struct varobj *var,
  82                                         enum varobj_display_formats format);
  83
  84 extern enum varobj_display_formats varobj_get_display_format (
  85                                                         struct varobj *var);
  86
  87 extern void varobj_set_frozen (struct varobj *var, int frozen);
  88
  89 extern int varobj_get_frozen (struct varobj *var);
  90
  91 extern int varobj_get_num_children (struct varobj *var);
  92
  93 extern int varobj_list_children (struct varobj *var,
  94                                  struct varobj ***childlist);
  95
  96 extern char *varobj_get_type (struct varobj *var);
  97
  98 extern struct type *varobj_get_gdb_type (struct varobj *var);
  99
 100 extern char *varobj_get_path_expr (struct varobj *var);
 101
 102 extern enum varobj_languages varobj_get_language (struct varobj *var);
 103
 104 extern int varobj_get_attributes (struct varobj *var);
 105
 106 extern char *varobj_get_value (struct varobj *var);
 107
 108 extern int varobj_set_value (struct varobj *var, char *expression);
 109
 110 extern int varobj_list (struct varobj ***rootlist);
 111
 112 extern int varobj_update (struct varobj **varp, struct varobj ***changelist,
 113                           int explicit);
 114
 115 extern void varobj_invalidate (void);
 116
 117 extern int varobj_editable_p (struct varobj *var);
 118
 119 #endif /* VAROBJ_H */