Commit | Line | Data |
---|---|---|
4a8f6654 AC |
1 | /* Manages interpreters for GDB, the GNU debugger. |
2 | ||
28e7fd62 | 3 | Copyright (C) 2000-2013 Free Software Foundation, Inc. |
4a8f6654 AC |
4 | |
5 | Written by Jim Ingham <jingham@apple.com> of Apple Computer, Inc. | |
6 | ||
7 | This file is part of GDB. | |
8 | ||
9 | This program is free software; you can redistribute it and/or modify | |
10 | it under the terms of the GNU General Public License as published by | |
a9762ec7 | 11 | the Free Software Foundation; either version 3 of the License, or |
4a8f6654 AC |
12 | (at your option) any later version. |
13 | ||
14 | This program is distributed in the hope that it will be useful, | |
15 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
16 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
17 | GNU General Public License for more details. | |
18 | ||
19 | You should have received a copy of the GNU General Public License | |
1777feb0 | 20 | along with this program. If not, see <http://www.gnu.org/licenses/>. */ |
4a8f6654 AC |
21 | |
22 | /* This is just a first cut at separating out the "interpreter" | |
23 | functions of gdb into self-contained modules. There are a couple | |
24 | of open areas that need to be sorted out: | |
25 | ||
26 | 1) The interpreter explicitly contains a UI_OUT, and can insert itself | |
27 | into the event loop, but it doesn't explicitly contain hooks for readline. | |
28 | I did this because it seems to me many interpreters won't want to use | |
29 | the readline command interface, and it is probably simpler to just let | |
30 | them take over the input in their resume proc. */ | |
31 | ||
32 | #include "defs.h" | |
33 | #include "gdbcmd.h" | |
34 | #include "ui-out.h" | |
35 | #include "event-loop.h" | |
36 | #include "event-top.h" | |
37 | #include "interps.h" | |
38 | #include "completer.h" | |
39 | #include "gdb_string.h" | |
4a8f6654 AC |
40 | #include "gdb_assert.h" |
41 | #include "top.h" /* For command_loop. */ | |
c1043fc2 | 42 | #include "exceptions.h" |
be34f849 | 43 | #include "continuations.h" |
4a8f6654 | 44 | |
b4a14fd0 PA |
45 | /* True if the current interpreter in is async mode. See interps.h |
46 | for more details. This starts out disabled, until all the explicit | |
47 | command line arguments (e.g., `gdb -ex "start" -ex "next"') are | |
48 | processed. */ | |
49 | int interpreter_async = 0; | |
50 | ||
4a8f6654 AC |
51 | struct interp |
52 | { | |
1777feb0 | 53 | /* This is the name in "-i=" and set interpreter. */ |
4a8f6654 AC |
54 | const char *name; |
55 | ||
56 | /* Interpreters are stored in a linked list, this is the next | |
57 | one... */ | |
58 | struct interp *next; | |
59 | ||
60 | /* This is a cookie that an instance of the interpreter can use. | |
61 | This is a bit confused right now as the exact initialization | |
62 | sequence for it, and how it relates to the interpreter's uiout | |
63 | object is a bit confused. */ | |
64 | void *data; | |
65 | ||
1777feb0 | 66 | /* Has the init_proc been run? */ |
4a8f6654 AC |
67 | int inited; |
68 | ||
4a8f6654 AC |
69 | const struct interp_procs *procs; |
70 | int quiet_p; | |
71 | }; | |
72 | ||
1777feb0 | 73 | /* Functions local to this file. */ |
4a8f6654 | 74 | static void initialize_interps (void); |
4a8f6654 | 75 | |
1777feb0 | 76 | /* The magic initialization routine for this module. */ |
4a8f6654 AC |
77 | |
78 | void _initialize_interpreter (void); | |
79 | ||
80 | /* Variables local to this file: */ | |
81 | ||
82 | static struct interp *interp_list = NULL; | |
83 | static struct interp *current_interpreter = NULL; | |
eb18d289 | 84 | static struct interp *top_level_interpreter_ptr = NULL; |
4a8f6654 AC |
85 | |
86 | static int interpreter_initialized = 0; | |
87 | ||
88 | /* interp_new - This allocates space for a new interpreter, | |
89 | fills the fields from the inputs, and returns a pointer to the | |
1777feb0 | 90 | interpreter. */ |
4a8f6654 | 91 | struct interp * |
4801a9a3 | 92 | interp_new (const char *name, const struct interp_procs *procs) |
4a8f6654 AC |
93 | { |
94 | struct interp *new_interp; | |
95 | ||
96 | new_interp = XMALLOC (struct interp); | |
97 | ||
98 | new_interp->name = xstrdup (name); | |
4801a9a3 | 99 | new_interp->data = NULL; |
4a8f6654 AC |
100 | new_interp->quiet_p = 0; |
101 | new_interp->procs = procs; | |
102 | new_interp->inited = 0; | |
103 | ||
104 | return new_interp; | |
105 | } | |
106 | ||
107 | /* Add interpreter INTERP to the gdb interpreter list. The | |
108 | interpreter must not have previously been added. */ | |
109 | void | |
110 | interp_add (struct interp *interp) | |
111 | { | |
112 | if (!interpreter_initialized) | |
113 | initialize_interps (); | |
114 | ||
115 | gdb_assert (interp_lookup (interp->name) == NULL); | |
116 | ||
117 | interp->next = interp_list; | |
118 | interp_list = interp; | |
119 | } | |
120 | ||
121 | /* This sets the current interpreter to be INTERP. If INTERP has not | |
122 | been initialized, then this will also run the init proc. If the | |
123 | init proc is successful, return 1, if it fails, set the old | |
124 | interpreter back in place and return 0. If we can't restore the | |
125 | old interpreter, then raise an internal error, since we are in | |
1777feb0 | 126 | pretty bad shape at this point. |
683f2885 VP |
127 | |
128 | The TOP_LEVEL parameter tells if this new interpreter is | |
129 | the top-level one. The top-level is what is requested | |
130 | on the command line, and is responsible for reporting general | |
131 | notification about target state changes. For example, if | |
132 | MI is the top-level interpreter, then it will always report | |
133 | events such as target stops and new thread creation, even if they | |
134 | are caused by CLI commands. */ | |
4a8f6654 | 135 | int |
683f2885 | 136 | interp_set (struct interp *interp, int top_level) |
4a8f6654 AC |
137 | { |
138 | struct interp *old_interp = current_interpreter; | |
139 | int first_time = 0; | |
4a8f6654 AC |
140 | char buffer[64]; |
141 | ||
683f2885 VP |
142 | /* If we already have an interpreter, then trying to |
143 | set top level interpreter is kinda pointless. */ | |
144 | gdb_assert (!top_level || !current_interpreter); | |
eb18d289 | 145 | gdb_assert (!top_level || !top_level_interpreter_ptr); |
683f2885 | 146 | |
4a8f6654 AC |
147 | if (current_interpreter != NULL) |
148 | { | |
79a45e25 | 149 | ui_out_flush (current_uiout); |
4a8f6654 AC |
150 | if (current_interpreter->procs->suspend_proc |
151 | && !current_interpreter->procs->suspend_proc (current_interpreter-> | |
152 | data)) | |
153 | { | |
8a3fe4f8 | 154 | error (_("Could not suspend interpreter \"%s\"."), |
4a8f6654 AC |
155 | current_interpreter->name); |
156 | } | |
157 | } | |
158 | else | |
159 | { | |
160 | first_time = 1; | |
161 | } | |
162 | ||
163 | current_interpreter = interp; | |
683f2885 | 164 | if (top_level) |
eb18d289 | 165 | top_level_interpreter_ptr = interp; |
4a8f6654 AC |
166 | |
167 | /* We use interpreter_p for the "set interpreter" variable, so we need | |
1777feb0 | 168 | to make sure we have a malloc'ed copy for the set command to free. */ |
4a8f6654 AC |
169 | if (interpreter_p != NULL |
170 | && strcmp (current_interpreter->name, interpreter_p) != 0) | |
171 | { | |
172 | xfree (interpreter_p); | |
173 | ||
174 | interpreter_p = xstrdup (current_interpreter->name); | |
175 | } | |
176 | ||
1777feb0 | 177 | /* Run the init proc. If it fails, try to restore the old interp. */ |
4a8f6654 AC |
178 | |
179 | if (!interp->inited) | |
180 | { | |
181 | if (interp->procs->init_proc != NULL) | |
182 | { | |
4801a9a3 | 183 | interp->data = interp->procs->init_proc (interp, top_level); |
4a8f6654 AC |
184 | } |
185 | interp->inited = 1; | |
186 | } | |
187 | ||
4801a9a3 PA |
188 | /* Do this only after the interpreter is initialized. */ |
189 | current_uiout = interp->procs->ui_out_proc (interp); | |
190 | ||
907d819a | 191 | /* Clear out any installed interpreter hooks/event handlers. */ |
4a8f6654 AC |
192 | clear_interpreter_hooks (); |
193 | ||
194 | if (interp->procs->resume_proc != NULL | |
195 | && (!interp->procs->resume_proc (interp->data))) | |
196 | { | |
683f2885 | 197 | if (old_interp == NULL || !interp_set (old_interp, 0)) |
4a8f6654 | 198 | internal_error (__FILE__, __LINE__, |
e2e0b3e5 | 199 | _("Failed to initialize new interp \"%s\" %s"), |
4a8f6654 AC |
200 | interp->name, "and could not restore old interp!\n"); |
201 | return 0; | |
202 | } | |
203 | ||
204 | /* Finally, put up the new prompt to show that we are indeed here. | |
205 | Also, display_gdb_prompt for the console does some readline magic | |
1777feb0 | 206 | which is needed for the console interpreter, at least... */ |
4a8f6654 AC |
207 | |
208 | if (!first_time) | |
209 | { | |
210 | if (!interp_quiet_p (interp)) | |
211 | { | |
8c042590 PM |
212 | xsnprintf (buffer, sizeof (buffer), |
213 | "Switching to interpreter \"%.24s\".\n", interp->name); | |
79a45e25 | 214 | ui_out_text (current_uiout, buffer); |
4a8f6654 AC |
215 | } |
216 | display_gdb_prompt (NULL); | |
217 | } | |
218 | ||
219 | return 1; | |
220 | } | |
221 | ||
222 | /* interp_lookup - Looks up the interpreter for NAME. If no such | |
223 | interpreter exists, return NULL, otherwise return a pointer to the | |
224 | interpreter. */ | |
225 | struct interp * | |
226 | interp_lookup (const char *name) | |
227 | { | |
228 | struct interp *interp; | |
229 | ||
230 | if (name == NULL || strlen (name) == 0) | |
231 | return NULL; | |
232 | ||
233 | for (interp = interp_list; interp != NULL; interp = interp->next) | |
234 | { | |
235 | if (strcmp (interp->name, name) == 0) | |
236 | return interp; | |
237 | } | |
238 | ||
239 | return NULL; | |
240 | } | |
241 | ||
1777feb0 | 242 | /* Returns the current interpreter. */ |
4a8f6654 AC |
243 | |
244 | struct ui_out * | |
245 | interp_ui_out (struct interp *interp) | |
246 | { | |
247 | if (interp != NULL) | |
4801a9a3 PA |
248 | return interp->procs->ui_out_proc (interp); |
249 | ||
250 | return current_interpreter->procs->ui_out_proc (current_interpreter); | |
251 | } | |
252 | ||
37ce89eb SS |
253 | int |
254 | current_interp_set_logging (int start_log, struct ui_file *out, | |
255 | struct ui_file *logfile) | |
256 | { | |
257 | if (current_interpreter == NULL | |
258 | || current_interpreter->procs->set_logging_proc == NULL) | |
259 | return 0; | |
260 | ||
261 | return current_interpreter->procs->set_logging_proc (current_interpreter, | |
262 | start_log, out, | |
263 | logfile); | |
264 | } | |
265 | ||
c41535fd EZ |
266 | /* Temporarily overrides the current interpreter. */ |
267 | struct interp * | |
268 | interp_set_temp (const char *name) | |
269 | { | |
270 | struct interp *interp = interp_lookup (name); | |
271 | struct interp *old_interp = current_interpreter; | |
272 | ||
273 | if (interp) | |
274 | current_interpreter = interp; | |
275 | return old_interp; | |
276 | } | |
277 | ||
4801a9a3 | 278 | /* Returns the interpreter's cookie. */ |
4a8f6654 | 279 | |
4801a9a3 PA |
280 | void * |
281 | interp_data (struct interp *interp) | |
282 | { | |
283 | return interp->data; | |
284 | } | |
285 | ||
286 | /* Returns the interpreter's name. */ | |
287 | ||
288 | const char * | |
289 | interp_name (struct interp *interp) | |
290 | { | |
291 | return interp->name; | |
4a8f6654 AC |
292 | } |
293 | ||
1777feb0 | 294 | /* Returns true if the current interp is the passed in name. */ |
4a8f6654 AC |
295 | int |
296 | current_interp_named_p (const char *interp_name) | |
297 | { | |
298 | if (current_interpreter) | |
299 | return (strcmp (current_interpreter->name, interp_name) == 0); | |
300 | ||
301 | return 0; | |
302 | } | |
303 | ||
304 | /* This is called in display_gdb_prompt. If the proc returns a zero | |
305 | value, display_gdb_prompt will return without displaying the | |
306 | prompt. */ | |
307 | int | |
308 | current_interp_display_prompt_p (void) | |
309 | { | |
310 | if (current_interpreter == NULL | |
311 | || current_interpreter->procs->prompt_proc_p == NULL) | |
312 | return 0; | |
313 | else | |
314 | return current_interpreter->procs->prompt_proc_p (current_interpreter-> | |
315 | data); | |
316 | } | |
317 | ||
318 | /* Run the current command interpreter's main loop. */ | |
319 | void | |
320 | current_interp_command_loop (void) | |
321 | { | |
322 | /* Somewhat messy. For the moment prop up all the old ways of | |
9a4105ab AC |
323 | selecting the command loop. `deprecated_command_loop_hook' |
324 | should be deprecated. */ | |
325 | if (deprecated_command_loop_hook != NULL) | |
326 | deprecated_command_loop_hook (); | |
4a8f6654 AC |
327 | else if (current_interpreter != NULL |
328 | && current_interpreter->procs->command_loop_proc != NULL) | |
329 | current_interpreter->procs->command_loop_proc (current_interpreter->data); | |
330 | else | |
362646f5 | 331 | cli_command_loop (); |
4a8f6654 AC |
332 | } |
333 | ||
334 | int | |
335 | interp_quiet_p (struct interp *interp) | |
336 | { | |
337 | if (interp != NULL) | |
338 | return interp->quiet_p; | |
339 | else | |
340 | return current_interpreter->quiet_p; | |
341 | } | |
342 | ||
b9362cc7 | 343 | static int |
4a8f6654 AC |
344 | interp_set_quiet (struct interp *interp, int quiet) |
345 | { | |
346 | int old_val = interp->quiet_p; | |
abbb1732 | 347 | |
4a8f6654 AC |
348 | interp->quiet_p = quiet; |
349 | return old_val; | |
350 | } | |
351 | ||
352 | /* interp_exec - This executes COMMAND_STR in the current | |
1777feb0 | 353 | interpreter. */ |
4a8f6654 AC |
354 | int |
355 | interp_exec_p (struct interp *interp) | |
356 | { | |
357 | return interp->procs->exec_proc != NULL; | |
358 | } | |
359 | ||
71fff37b | 360 | struct gdb_exception |
4a8f6654 AC |
361 | interp_exec (struct interp *interp, const char *command_str) |
362 | { | |
363 | if (interp->procs->exec_proc != NULL) | |
364 | { | |
365 | return interp->procs->exec_proc (interp->data, command_str); | |
366 | } | |
c1043fc2 | 367 | return exception_none; |
4a8f6654 AC |
368 | } |
369 | ||
907d819a MS |
370 | /* A convenience routine that nulls out all the common command hooks. |
371 | Use it when removing your interpreter in its suspend proc. */ | |
4a8f6654 | 372 | void |
11308a41 | 373 | clear_interpreter_hooks (void) |
4a8f6654 | 374 | { |
9a4105ab AC |
375 | deprecated_init_ui_hook = 0; |
376 | deprecated_print_frame_info_listing_hook = 0; | |
4a8f6654 | 377 | /*print_frame_more_info_hook = 0; */ |
9a4105ab AC |
378 | deprecated_query_hook = 0; |
379 | deprecated_warning_hook = 0; | |
9a4105ab | 380 | deprecated_interactive_hook = 0; |
9a4105ab AC |
381 | deprecated_readline_begin_hook = 0; |
382 | deprecated_readline_hook = 0; | |
383 | deprecated_readline_end_hook = 0; | |
384 | deprecated_register_changed_hook = 0; | |
9a4105ab AC |
385 | deprecated_context_hook = 0; |
386 | deprecated_target_wait_hook = 0; | |
387 | deprecated_call_command_hook = 0; | |
9a4105ab AC |
388 | deprecated_error_begin_hook = 0; |
389 | deprecated_command_loop_hook = 0; | |
4a8f6654 AC |
390 | } |
391 | ||
907d819a MS |
392 | /* This is a lazy init routine, called the first time the interpreter |
393 | module is used. I put it here just in case, but I haven't thought | |
394 | of a use for it yet. I will probably bag it soon, since I don't | |
395 | think it will be necessary. */ | |
4a8f6654 AC |
396 | static void |
397 | initialize_interps (void) | |
398 | { | |
399 | interpreter_initialized = 1; | |
1777feb0 | 400 | /* Don't know if anything needs to be done here... */ |
4a8f6654 AC |
401 | } |
402 | ||
b9362cc7 | 403 | static void |
4a8f6654 AC |
404 | interpreter_exec_cmd (char *args, int from_tty) |
405 | { | |
406 | struct interp *old_interp, *interp_to_use; | |
407 | char **prules = NULL; | |
408 | char **trule = NULL; | |
409 | unsigned int nrules; | |
410 | unsigned int i; | |
411 | int old_quiet, use_quiet; | |
412 | ||
d1a41061 PP |
413 | if (args == NULL) |
414 | error_no_arg (_("interpreter-exec command")); | |
415 | ||
416 | prules = gdb_buildargv (args); | |
417 | make_cleanup_freeargv (prules); | |
4a8f6654 AC |
418 | |
419 | nrules = 0; | |
d1a41061 PP |
420 | for (trule = prules; *trule != NULL; trule++) |
421 | nrules++; | |
4a8f6654 AC |
422 | |
423 | if (nrules < 2) | |
8a3fe4f8 | 424 | error (_("usage: interpreter-exec <interpreter> [ <command> ... ]")); |
4a8f6654 AC |
425 | |
426 | old_interp = current_interpreter; | |
427 | ||
428 | interp_to_use = interp_lookup (prules[0]); | |
429 | if (interp_to_use == NULL) | |
8a3fe4f8 | 430 | error (_("Could not find interpreter \"%s\"."), prules[0]); |
4a8f6654 | 431 | |
1777feb0 | 432 | /* Temporarily set interpreters quiet. */ |
4a8f6654 AC |
433 | old_quiet = interp_set_quiet (old_interp, 1); |
434 | use_quiet = interp_set_quiet (interp_to_use, 1); | |
435 | ||
683f2885 | 436 | if (!interp_set (interp_to_use, 0)) |
8a3fe4f8 | 437 | error (_("Could not switch to interpreter \"%s\"."), prules[0]); |
4a8f6654 AC |
438 | |
439 | for (i = 1; i < nrules; i++) | |
440 | { | |
71fff37b | 441 | struct gdb_exception e = interp_exec (interp_to_use, prules[i]); |
abbb1732 | 442 | |
a7479e7e | 443 | if (e.reason < 0) |
4a8f6654 | 444 | { |
683f2885 | 445 | interp_set (old_interp, 0); |
04d1f770 DJ |
446 | interp_set_quiet (interp_to_use, use_quiet); |
447 | interp_set_quiet (old_interp, old_quiet); | |
8a3fe4f8 | 448 | error (_("error in command: \"%s\"."), prules[i]); |
4a8f6654 AC |
449 | } |
450 | } | |
451 | ||
683f2885 | 452 | interp_set (old_interp, 0); |
4a8f6654 AC |
453 | interp_set_quiet (interp_to_use, use_quiet); |
454 | interp_set_quiet (old_interp, old_quiet); | |
455 | } | |
456 | ||
1777feb0 | 457 | /* List the possible interpreters which could complete the given text. */ |
49c4e619 | 458 | static VEC (char_ptr) * |
d8906c6f | 459 | interpreter_completer (struct cmd_list_element *ignore, char *text, char *word) |
4a8f6654 | 460 | { |
4a8f6654 | 461 | int textlen; |
49c4e619 | 462 | VEC (char_ptr) *matches = NULL; |
4a8f6654 AC |
463 | struct interp *interp; |
464 | ||
4a8f6654 AC |
465 | textlen = strlen (text); |
466 | for (interp = interp_list; interp != NULL; interp = interp->next) | |
467 | { | |
468 | if (strncmp (interp->name, text, textlen) == 0) | |
469 | { | |
49c4e619 TT |
470 | char *match; |
471 | ||
472 | match = (char *) xmalloc (strlen (word) + strlen (interp->name) + 1); | |
4a8f6654 | 473 | if (word == text) |
49c4e619 | 474 | strcpy (match, interp->name); |
4a8f6654 AC |
475 | else if (word > text) |
476 | { | |
1777feb0 | 477 | /* Return some portion of interp->name. */ |
49c4e619 | 478 | strcpy (match, interp->name + (word - text)); |
4a8f6654 AC |
479 | } |
480 | else | |
481 | { | |
1777feb0 | 482 | /* Return some of text plus interp->name. */ |
49c4e619 TT |
483 | strncpy (match, word, text - word); |
484 | match[text - word] = '\0'; | |
485 | strcat (match, interp->name); | |
4a8f6654 | 486 | } |
49c4e619 | 487 | VEC_safe_push (char_ptr, matches, match); |
4a8f6654 AC |
488 | } |
489 | } | |
490 | ||
4a8f6654 AC |
491 | return matches; |
492 | } | |
493 | ||
eb18d289 NR |
494 | struct interp * |
495 | top_level_interpreter (void) | |
496 | { | |
497 | return top_level_interpreter_ptr; | |
498 | } | |
499 | ||
500 | void * | |
683f2885 VP |
501 | top_level_interpreter_data (void) |
502 | { | |
eb18d289 NR |
503 | gdb_assert (top_level_interpreter_ptr); |
504 | return top_level_interpreter_ptr->data; | |
683f2885 VP |
505 | } |
506 | ||
4a8f6654 AC |
507 | /* This just adds the "interpreter-exec" command. */ |
508 | void | |
509 | _initialize_interpreter (void) | |
510 | { | |
511 | struct cmd_list_element *c; | |
512 | ||
513 | c = add_cmd ("interpreter-exec", class_support, | |
1a966eab AC |
514 | interpreter_exec_cmd, _("\ |
515 | Execute a command in an interpreter. It takes two arguments:\n\ | |
4a8f6654 | 516 | The first argument is the name of the interpreter to use.\n\ |
1a966eab | 517 | The second argument is the command to execute.\n"), &cmdlist); |
4a8f6654 AC |
518 | set_cmd_completer (c, interpreter_completer); |
519 | } |