Commit | Line | Data |
---|---|---|
8b93c638 | 1 | /* GDB variable objects API. |
9b254dd1 DJ |
2 | Copyright (C) 1999, 2000, 2001, 2005, 2007, 2008 |
3 | Free Software Foundation, Inc. | |
8b93c638 JM |
4 | |
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 | |
a9762ec7 | 7 | the Free Software Foundation; either version 3 of the License, or |
8b93c638 JM |
8 | (at your option) any later version. |
9 | ||
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. | |
14 | ||
15 | You should have received a copy of the GNU General Public License | |
a9762ec7 | 16 | along with this program. If not, see <http://www.gnu.org/licenses/>. */ |
8b93c638 JM |
17 | |
18 | #ifndef VAROBJ_H | |
19 | #define VAROBJ_H 1 | |
20 | ||
21 | #include "symtab.h" | |
22 | #include "gdbtypes.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 | ||
73a93a32 JI |
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 | }; | |
8756216b DP |
40 | |
41 | /* Error return values for varobj_update function. */ | |
42 | enum varobj_update_error | |
43 | { | |
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. */ | |
8756216b DP |
47 | }; |
48 | ||
8b93c638 JM |
49 | /* String representations of gdb's format codes (defined in varobj.c) */ |
50 | extern char *varobj_format_string[]; | |
51 | ||
52 | /* Languages supported by this variable objects system. */ | |
53 | enum varobj_languages | |
54 | { | |
55 | vlang_unknown = 0, vlang_c, vlang_cplus, vlang_java, vlang_end | |
56 | }; | |
57 | ||
58 | /* String representations of gdb's known languages (defined in varobj.c) */ | |
59 | extern char *varobj_language_string[]; | |
60 | ||
61 | /* Struct thar describes a variable object instance */ | |
62 | struct varobj; | |
63 | ||
64 | /* API functions */ | |
65 | ||
66 | extern struct varobj *varobj_create (char *objname, | |
73a93a32 JI |
67 | char *expression, CORE_ADDR frame, |
68 | enum varobj_type type); | |
8b93c638 JM |
69 | |
70 | extern char *varobj_gen_name (void); | |
71 | ||
72 | extern struct varobj *varobj_get_handle (char *name); | |
73 | ||
74 | extern char *varobj_get_objname (struct varobj *var); | |
75 | ||
76 | extern char *varobj_get_expression (struct varobj *var); | |
77 | ||
78 | extern int varobj_delete (struct varobj *var, char ***dellist, | |
79 | int only_children); | |
80 | ||
81 | extern enum varobj_display_formats varobj_set_display_format ( | |
82 | struct varobj *var, | |
83 | enum varobj_display_formats format); | |
84 | ||
85 | extern enum varobj_display_formats varobj_get_display_format ( | |
86 | struct varobj *var); | |
87 | ||
25d5ea92 VP |
88 | extern void varobj_set_frozen (struct varobj *var, int frozen); |
89 | ||
90 | extern int varobj_get_frozen (struct varobj *var); | |
91 | ||
8b93c638 JM |
92 | extern int varobj_get_num_children (struct varobj *var); |
93 | ||
94 | extern int varobj_list_children (struct varobj *var, | |
95 | struct varobj ***childlist); | |
96 | ||
97 | extern char *varobj_get_type (struct varobj *var); | |
98 | ||
1ecb4ee0 DJ |
99 | extern struct type *varobj_get_gdb_type (struct varobj *var); |
100 | ||
02142340 VP |
101 | extern char *varobj_get_path_expr (struct varobj *var); |
102 | ||
8b93c638 JM |
103 | extern enum varobj_languages varobj_get_language (struct varobj *var); |
104 | ||
105 | extern int varobj_get_attributes (struct varobj *var); | |
106 | ||
107 | extern char *varobj_get_value (struct varobj *var); | |
108 | ||
109 | extern int varobj_set_value (struct varobj *var, char *expression); | |
110 | ||
111 | extern int varobj_list (struct varobj ***rootlist); | |
112 | ||
25d5ea92 VP |
113 | extern int varobj_update (struct varobj **varp, struct varobj ***changelist, |
114 | int explicit); | |
8b93c638 | 115 | |
8756216b DP |
116 | extern void varobj_invalidate (void); |
117 | ||
c203027e NR |
118 | extern int varobj_editable_p (struct varobj *var); |
119 | ||
8b93c638 | 120 | #endif /* VAROBJ_H */ |