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/>. */
24 /* Enumeration for the format types */
25 enum varobj_display_formats
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 */
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 */
41 /* Error return values for varobj_update function. */
42 enum varobj_update_error
44 NOT_IN_SCOPE
= -1, /* varobj not in scope, can not be updated. */
45 TYPE_CHANGED
= -2, /* varobj type has changed. */
46 INVALID
= -3, /* varobj is not valid anymore. */
49 /* String representations of gdb's format codes (defined in varobj.c) */
50 extern char *varobj_format_string
[];
52 /* Languages supported by this variable objects system. */
55 vlang_unknown
= 0, vlang_c
, vlang_cplus
, vlang_java
, vlang_end
58 /* String representations of gdb's known languages (defined in varobj.c) */
59 extern char *varobj_language_string
[];
61 /* Struct thar describes a variable object instance */
66 extern struct varobj
*varobj_create (char *objname
,
67 char *expression
, CORE_ADDR frame
,
68 enum varobj_type type
);
70 extern char *varobj_gen_name (void);
72 extern struct varobj
*varobj_get_handle (char *name
);
74 extern char *varobj_get_objname (struct varobj
*var
);
76 extern char *varobj_get_expression (struct varobj
*var
);
78 extern int varobj_delete (struct varobj
*var
, char ***dellist
,
81 extern enum varobj_display_formats
varobj_set_display_format (
83 enum varobj_display_formats format
);
85 extern enum varobj_display_formats
varobj_get_display_format (
88 extern void varobj_set_frozen (struct varobj
*var
, int frozen
);
90 extern int varobj_get_frozen (struct varobj
*var
);
92 extern int varobj_get_num_children (struct varobj
*var
);
94 extern int varobj_list_children (struct varobj
*var
,
95 struct varobj
***childlist
);
97 extern char *varobj_get_type (struct varobj
*var
);
99 extern struct type
*varobj_get_gdb_type (struct varobj
*var
);
101 extern char *varobj_get_path_expr (struct varobj
*var
);
103 extern enum varobj_languages
varobj_get_language (struct varobj
*var
);
105 extern int varobj_get_attributes (struct varobj
*var
);
107 extern char *varobj_get_value (struct varobj
*var
);
109 extern int varobj_set_value (struct varobj
*var
, char *expression
);
111 extern int varobj_list (struct varobj
***rootlist
);
113 extern int varobj_update (struct varobj
**varp
, struct varobj
***changelist
,
116 extern void varobj_invalidate (void);
118 extern int varobj_editable_p (struct varobj
*var
);
120 #endif /* VAROBJ_H */