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