1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
|
/* Interface between gdb and its extension languages.
Copyright (C) 2014-2015 Free Software Foundation, Inc.
This file is part of GDB.
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>. */
#ifndef EXTENSION_H
#define EXTENSION_H
#include "mi/mi-cmds.h" /* For PRINT_NO_VALUES, etc. */
#include "common/vec.h"
struct breakpoint;
struct command_line;
struct frame_info;
struct language_defn;
struct objfile;
struct extension_language_defn;
struct type;
struct ui_file;
struct ui_out;
struct value;
struct value_print_options;
/* A function to load and process a script file.
The file has been opened and is ready to be read from the beginning.
Any exceptions are not caught, and are passed to the caller. */
typedef void script_sourcer_func (const struct extension_language_defn *,
FILE *stream, const char *filename);
/* A function to load and process a script for an objfile.
The file has been opened and is ready to be read from the beginning.
Any exceptions are not caught, and are passed to the caller. */
typedef void objfile_script_sourcer_func
(const struct extension_language_defn *,
struct objfile *, FILE *stream, const char *filename);
/* Enum of each extension(/scripting) language. */
enum extension_language
{
EXT_LANG_NONE,
EXT_LANG_GDB,
EXT_LANG_PYTHON,
EXT_LANG_GUILE
};
/* Extension language frame-filter status return values. */
enum ext_lang_bt_status
{
/* Return when an error has occurred in processing frame filters,
or when printing the stack. */
EXT_LANG_BT_ERROR = -1,
/* Return from internal routines to indicate that the function
succeeded. */
EXT_LANG_BT_OK = 1,
/* Return when the frame filter process is complete, and all
operations have succeeded. */
EXT_LANG_BT_COMPLETED = 2,
/* Return when the frame filter process is complete, but there
were no filter registered and enabled to process. */
EXT_LANG_BT_NO_FILTERS = 3
};
/* Flags to pass to apply_extlang_frame_filter. */
enum frame_filter_flags
{
/* Set this flag if frame level is to be printed. */
PRINT_LEVEL = 1,
/* Set this flag if frame information is to be printed. */
PRINT_FRAME_INFO = 2,
/* Set this flag if frame arguments are to be printed. */
PRINT_ARGS = 4,
/* Set this flag if frame locals are to be printed. */
PRINT_LOCALS = 8,
};
/* A choice of the different frame argument printing strategies that
can occur in different cases of frame filter instantiation. */
enum ext_lang_frame_args
{
/* Print no values for arguments when invoked from the MI. */
NO_VALUES = PRINT_NO_VALUES,
MI_PRINT_ALL_VALUES = PRINT_ALL_VALUES,
/* Print only simple values (what MI defines as "simple") for
arguments when invoked from the MI. */
MI_PRINT_SIMPLE_VALUES = PRINT_SIMPLE_VALUES,
/* Print only scalar values for arguments when invoked from the CLI. */
CLI_SCALAR_VALUES,
/* Print all values for arguments when invoked from the CLI. */
CLI_ALL_VALUES
};
/* The possible results of
extension_language_ops.breakpoint_cond_says_stop. */
enum ext_lang_bp_stop
{
/* No "stop" condition is set. */
EXT_LANG_BP_STOP_UNSET,
/* A "stop" condition is set, and it says "don't stop". */
EXT_LANG_BP_STOP_NO,
/* A "stop" condition is set, and it says "stop". */
EXT_LANG_BP_STOP_YES
};
/* Table of type printers associated with the global typedef table. */
struct ext_lang_type_printers
{
/* Type-printers from Python. */
void *py_type_printers;
};
/* A type which holds its extension language specific xmethod worker data. */
struct xmethod_worker
{
/* The language the xmethod worker is implemented in. */
const struct extension_language_defn *extlang;
/* The extension language specific data for this xmethod worker. */
void *data;
/* The TYPE_CODE_XMETHOD value corresponding to this worker.
Always use value_of_xmethod to access it. */
struct value *value;
};
typedef struct xmethod_worker *xmethod_worker_ptr;
DEF_VEC_P (xmethod_worker_ptr);
typedef VEC (xmethod_worker_ptr) xmethod_worker_vec;
/* The interface for gdb's own extension(/scripting) language. */
extern const struct extension_language_defn extension_language_gdb;
extern const struct extension_language_defn *get_ext_lang_defn
(enum extension_language lang);
extern const struct extension_language_defn *get_ext_lang_of_file
(const char *file);
extern int ext_lang_present_p (const struct extension_language_defn *);
extern int ext_lang_initialized_p (const struct extension_language_defn *);
extern void throw_ext_lang_unsupported
(const struct extension_language_defn *);
/* Accessors for "public" attributes of the extension language definition. */
extern enum extension_language ext_lang_kind
(const struct extension_language_defn *);
extern const char *ext_lang_name (const struct extension_language_defn *);
extern const char *ext_lang_capitalized_name
(const struct extension_language_defn *);
extern const char *ext_lang_suffix (const struct extension_language_defn *);
extern const char *ext_lang_auto_load_suffix
(const struct extension_language_defn *);
extern script_sourcer_func *ext_lang_script_sourcer
(const struct extension_language_defn *);
extern objfile_script_sourcer_func *ext_lang_objfile_script_sourcer
(const struct extension_language_defn *);
extern int ext_lang_auto_load_enabled (const struct extension_language_defn *);
/* Wrappers for each extension language API function that iterate over all
extension languages. */
extern void finish_ext_lang_initialization (void);
extern void eval_ext_lang_from_control_command (struct command_line *cmd);
extern void auto_load_ext_lang_scripts_for_objfile (struct objfile *);
extern struct ext_lang_type_printers *start_ext_lang_type_printers (void);
extern char *apply_ext_lang_type_printers (struct ext_lang_type_printers *,
struct type *);
extern void free_ext_lang_type_printers (struct ext_lang_type_printers *);
extern int apply_ext_lang_val_pretty_printer
(struct type *type, const gdb_byte *valaddr,
int embedded_offset, CORE_ADDR address,
struct ui_file *stream, int recurse,
const struct value *val, const struct value_print_options *options,
const struct language_defn *language);
extern enum ext_lang_bt_status apply_ext_lang_frame_filter
(struct frame_info *frame, int flags, enum ext_lang_frame_args args_type,
struct ui_out *out, int frame_low, int frame_high);
extern void preserve_ext_lang_values (struct objfile *, htab_t copied_types);
extern const struct extension_language_defn *get_breakpoint_cond_ext_lang
(struct breakpoint *b, enum extension_language skip_lang);
extern int breakpoint_ext_lang_cond_says_stop (struct breakpoint *);
extern struct value *invoke_xmethod (struct xmethod_worker *,
struct value *,
struct value **, int nargs);
extern struct xmethod_worker *clone_xmethod_worker (struct xmethod_worker *);
extern struct xmethod_worker *new_xmethod_worker
(const struct extension_language_defn *extlang, void *data);
extern void free_xmethod_worker (struct xmethod_worker *);
extern void free_xmethod_worker_vec (void *vec);
extern xmethod_worker_vec *get_matching_xmethod_workers
(struct type *, const char *);
extern struct type **get_xmethod_arg_types (struct xmethod_worker *, int *);
#endif /* EXTENSION_H */
|
