1 /* GDB variable objects API.
2 Copyright (C) 1999, 2000, 2001, 2005, 2007, 2008
3 Free Software Foundation, Inc.
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 3 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>. */
25 /* Enumeration for the format types */
26 enum varobj_display_formats
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 */
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 */
42 /* Error return values for varobj_update function. */
43 enum varobj_update_error
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. */
50 /* String representations of gdb's format codes (defined in varobj.c) */
51 extern char *varobj_format_string[];
53 /* Languages supported by this variable objects system. */
56 vlang_unknown = 0, vlang_c, vlang_cplus, vlang_java, vlang_end
59 /* String representations of gdb's known languages (defined in varobj.c) */
60 extern char *varobj_language_string[];
62 /* Struct thar describes a variable object instance */
65 typedef struct varobj *varobj_p;
70 extern struct varobj *varobj_create (char *objname,
71 char *expression, CORE_ADDR frame,
72 enum varobj_type type);
74 extern char *varobj_gen_name (void);
76 extern struct varobj *varobj_get_handle (char *name);
78 extern char *varobj_get_objname (struct varobj *var);
80 extern char *varobj_get_expression (struct varobj *var);
82 extern int varobj_delete (struct varobj *var, char ***dellist,
85 extern enum varobj_display_formats varobj_set_display_format (
87 enum varobj_display_formats format);
89 extern enum varobj_display_formats varobj_get_display_format (
92 extern int varobj_get_thread_id (struct varobj *var);
94 extern void varobj_set_frozen (struct varobj *var, int frozen);
96 extern int varobj_get_frozen (struct varobj *var);
98 extern int varobj_get_num_children (struct varobj *var);
100 /* Return the list of children of VAR. The returned vector
101 should not be modified in any way. */
102 extern VEC (varobj_p)* varobj_list_children (struct varobj *var);
104 extern char *varobj_get_type (struct varobj *var);
106 extern struct type *varobj_get_gdb_type (struct varobj *var);
108 extern char *varobj_get_path_expr (struct varobj *var);
110 extern enum varobj_languages varobj_get_language (struct varobj *var);
112 extern int varobj_get_attributes (struct varobj *var);
114 extern char *varobj_get_value (struct varobj *var);
116 extern int varobj_set_value (struct varobj *var, char *expression);
118 extern int varobj_list (struct varobj ***rootlist);
120 extern int varobj_update (struct varobj **varp, struct varobj ***changelist,
123 extern void varobj_invalidate (void);
125 extern int varobj_editable_p (struct varobj *var);
127 extern int varobj_floating_p (struct varobj *var);
129 #endif /* VAROBJ_H */