1 /* Manages interpreters for GDB, the GNU debugger.
3 Copyright (C) 2000-2014 Free Software Foundation, Inc.
5 Written by Jim Ingham <jingham@apple.com> of Apple Computer, Inc.
7 This file is part of GDB.
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
11 the Free Software Foundation; either version 3 of the License, or
12 (at your option) any later version.
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.
19 You should have received a copy of the GNU General Public License
20 along with this program. If not, see <http://www.gnu.org/licenses/>. */
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:
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. */
35 #include "event-loop.h"
36 #include "event-top.h"
38 #include "completer.h"
40 #include "gdb_assert.h"
41 #include "top.h" /* For command_loop. */
42 #include "exceptions.h"
43 #include "continuations.h"
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
49 int interpreter_async
= 0;
53 /* This is the name in "-i=" and set interpreter. */
56 /* Interpreters are stored in a linked list, this is the next
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. */
66 /* Has the init_proc been run? */
69 const struct interp_procs
*procs
;
73 /* Functions local to this file. */
74 static void initialize_interps (void);
76 /* The magic initialization routine for this module. */
78 void _initialize_interpreter (void);
80 /* Variables local to this file: */
82 static struct interp
*interp_list
= NULL
;
83 static struct interp
*current_interpreter
= NULL
;
84 static struct interp
*top_level_interpreter_ptr
= NULL
;
86 static int interpreter_initialized
= 0;
88 /* interp_new - This allocates space for a new interpreter,
89 fills the fields from the inputs, and returns a pointer to the
92 interp_new (const char *name
, const struct interp_procs
*procs
)
94 struct interp
*new_interp
;
96 new_interp
= XNEW (struct interp
);
98 new_interp
->name
= xstrdup (name
);
99 new_interp
->data
= NULL
;
100 new_interp
->quiet_p
= 0;
101 new_interp
->procs
= procs
;
102 new_interp
->inited
= 0;
104 /* Check for required procs. */
105 gdb_assert (procs
->command_loop_proc
!= NULL
);
110 /* Add interpreter INTERP to the gdb interpreter list. The
111 interpreter must not have previously been added. */
113 interp_add (struct interp
*interp
)
115 if (!interpreter_initialized
)
116 initialize_interps ();
118 gdb_assert (interp_lookup (interp
->name
) == NULL
);
120 interp
->next
= interp_list
;
121 interp_list
= interp
;
124 /* This sets the current interpreter to be INTERP. If INTERP has not
125 been initialized, then this will also run the init proc. If the
126 init proc is successful, return 1, if it fails, set the old
127 interpreter back in place and return 0. If we can't restore the
128 old interpreter, then raise an internal error, since we are in
129 pretty bad shape at this point.
131 The TOP_LEVEL parameter tells if this new interpreter is
132 the top-level one. The top-level is what is requested
133 on the command line, and is responsible for reporting general
134 notification about target state changes. For example, if
135 MI is the top-level interpreter, then it will always report
136 events such as target stops and new thread creation, even if they
137 are caused by CLI commands. */
139 interp_set (struct interp
*interp
, int top_level
)
141 struct interp
*old_interp
= current_interpreter
;
145 /* If we already have an interpreter, then trying to
146 set top level interpreter is kinda pointless. */
147 gdb_assert (!top_level
|| !current_interpreter
);
148 gdb_assert (!top_level
|| !top_level_interpreter_ptr
);
150 if (current_interpreter
!= NULL
)
152 ui_out_flush (current_uiout
);
153 if (current_interpreter
->procs
->suspend_proc
154 && !current_interpreter
->procs
->suspend_proc (current_interpreter
->
157 error (_("Could not suspend interpreter \"%s\"."),
158 current_interpreter
->name
);
166 current_interpreter
= interp
;
168 top_level_interpreter_ptr
= interp
;
170 /* We use interpreter_p for the "set interpreter" variable, so we need
171 to make sure we have a malloc'ed copy for the set command to free. */
172 if (interpreter_p
!= NULL
173 && strcmp (current_interpreter
->name
, interpreter_p
) != 0)
175 xfree (interpreter_p
);
177 interpreter_p
= xstrdup (current_interpreter
->name
);
180 /* Run the init proc. If it fails, try to restore the old interp. */
184 if (interp
->procs
->init_proc
!= NULL
)
186 interp
->data
= interp
->procs
->init_proc (interp
, top_level
);
191 /* Do this only after the interpreter is initialized. */
192 current_uiout
= interp
->procs
->ui_out_proc (interp
);
194 /* Clear out any installed interpreter hooks/event handlers. */
195 clear_interpreter_hooks ();
197 if (interp
->procs
->resume_proc
!= NULL
198 && (!interp
->procs
->resume_proc (interp
->data
)))
200 if (old_interp
== NULL
|| !interp_set (old_interp
, 0))
201 internal_error (__FILE__
, __LINE__
,
202 _("Failed to initialize new interp \"%s\" %s"),
203 interp
->name
, "and could not restore old interp!\n");
207 /* Finally, put up the new prompt to show that we are indeed here.
208 Also, display_gdb_prompt for the console does some readline magic
209 which is needed for the console interpreter, at least... */
213 if (!interp_quiet_p (interp
))
215 xsnprintf (buffer
, sizeof (buffer
),
216 "Switching to interpreter \"%.24s\".\n", interp
->name
);
217 ui_out_text (current_uiout
, buffer
);
219 display_gdb_prompt (NULL
);
225 /* interp_lookup - Looks up the interpreter for NAME. If no such
226 interpreter exists, return NULL, otherwise return a pointer to the
229 interp_lookup (const char *name
)
231 struct interp
*interp
;
233 if (name
== NULL
|| strlen (name
) == 0)
236 for (interp
= interp_list
; interp
!= NULL
; interp
= interp
->next
)
238 if (strcmp (interp
->name
, name
) == 0)
245 /* Returns the current interpreter. */
248 interp_ui_out (struct interp
*interp
)
251 return interp
->procs
->ui_out_proc (interp
);
253 return current_interpreter
->procs
->ui_out_proc (current_interpreter
);
257 current_interp_set_logging (int start_log
, struct ui_file
*out
,
258 struct ui_file
*logfile
)
260 if (current_interpreter
== NULL
261 || current_interpreter
->procs
->set_logging_proc
== NULL
)
264 return current_interpreter
->procs
->set_logging_proc (current_interpreter
,
269 /* Temporarily overrides the current interpreter. */
271 interp_set_temp (const char *name
)
273 struct interp
*interp
= interp_lookup (name
);
274 struct interp
*old_interp
= current_interpreter
;
277 current_interpreter
= interp
;
281 /* Returns the interpreter's cookie. */
284 interp_data (struct interp
*interp
)
289 /* Returns the interpreter's name. */
292 interp_name (struct interp
*interp
)
297 /* Returns true if the current interp is the passed in name. */
299 current_interp_named_p (const char *interp_name
)
301 if (current_interpreter
)
302 return (strcmp (current_interpreter
->name
, interp_name
) == 0);
307 /* This is called in display_gdb_prompt. If the proc returns a zero
308 value, display_gdb_prompt will return without displaying the
311 current_interp_display_prompt_p (void)
313 if (current_interpreter
== NULL
314 || current_interpreter
->procs
->prompt_proc_p
== NULL
)
317 return current_interpreter
->procs
->prompt_proc_p (current_interpreter
->
321 /* The interpreter that is active while `interp_exec' is active, NULL
322 at all other times. */
323 static struct interp
*command_interpreter
;
325 /* The interpreter that was active when a command was executed.
326 Normally that'd always be CURRENT_INTERPRETER, except that MI's
327 -interpreter-exec command doesn't actually flip the current
328 interpreter when running its sub-command. The
329 `command_interpreter' global tracks when interp_exec is called
330 (IOW, when -interpreter-exec is called). If that is set, it is
331 INTERP in '-interpreter-exec INTERP "CMD"' or in 'interpreter-exec
332 INTERP "CMD". Otherwise, interp_exec isn't active, and so the
333 interpreter running the command is the current interpreter. */
336 command_interp (void)
338 if (command_interpreter
!= NULL
)
339 return command_interpreter
;
341 return current_interpreter
;
344 /* Run the current command interpreter's main loop. */
346 current_interp_command_loop (void)
348 gdb_assert (current_interpreter
!= NULL
);
350 current_interpreter
->procs
->command_loop_proc (current_interpreter
->data
);
354 interp_quiet_p (struct interp
*interp
)
357 return interp
->quiet_p
;
359 return current_interpreter
->quiet_p
;
363 interp_set_quiet (struct interp
*interp
, int quiet
)
365 int old_val
= interp
->quiet_p
;
367 interp
->quiet_p
= quiet
;
371 /* interp_exec - This executes COMMAND_STR in the current
375 interp_exec (struct interp
*interp
, const char *command_str
)
377 struct gdb_exception ex
;
378 struct interp
*save_command_interp
;
380 gdb_assert (interp
->procs
->exec_proc
!= NULL
);
382 /* See `command_interp' for why we do this. */
383 save_command_interp
= command_interpreter
;
384 command_interpreter
= interp
;
386 ex
= interp
->procs
->exec_proc (interp
->data
, command_str
);
388 command_interpreter
= save_command_interp
;
393 /* A convenience routine that nulls out all the common command hooks.
394 Use it when removing your interpreter in its suspend proc. */
396 clear_interpreter_hooks (void)
398 deprecated_init_ui_hook
= 0;
399 deprecated_print_frame_info_listing_hook
= 0;
400 /*print_frame_more_info_hook = 0; */
401 deprecated_query_hook
= 0;
402 deprecated_warning_hook
= 0;
403 deprecated_interactive_hook
= 0;
404 deprecated_readline_begin_hook
= 0;
405 deprecated_readline_hook
= 0;
406 deprecated_readline_end_hook
= 0;
407 deprecated_register_changed_hook
= 0;
408 deprecated_context_hook
= 0;
409 deprecated_target_wait_hook
= 0;
410 deprecated_call_command_hook
= 0;
411 deprecated_error_begin_hook
= 0;
414 /* This is a lazy init routine, called the first time the interpreter
415 module is used. I put it here just in case, but I haven't thought
416 of a use for it yet. I will probably bag it soon, since I don't
417 think it will be necessary. */
419 initialize_interps (void)
421 interpreter_initialized
= 1;
422 /* Don't know if anything needs to be done here... */
426 interpreter_exec_cmd (char *args
, int from_tty
)
428 struct interp
*old_interp
, *interp_to_use
;
429 char **prules
= NULL
;
433 int old_quiet
, use_quiet
;
434 struct cleanup
*cleanup
;
437 error_no_arg (_("interpreter-exec command"));
439 prules
= gdb_buildargv (args
);
440 cleanup
= make_cleanup_freeargv (prules
);
443 for (trule
= prules
; *trule
!= NULL
; trule
++)
447 error (_("usage: interpreter-exec <interpreter> [ <command> ... ]"));
449 old_interp
= current_interpreter
;
451 interp_to_use
= interp_lookup (prules
[0]);
452 if (interp_to_use
== NULL
)
453 error (_("Could not find interpreter \"%s\"."), prules
[0]);
455 /* Temporarily set interpreters quiet. */
456 old_quiet
= interp_set_quiet (old_interp
, 1);
457 use_quiet
= interp_set_quiet (interp_to_use
, 1);
459 if (!interp_set (interp_to_use
, 0))
460 error (_("Could not switch to interpreter \"%s\"."), prules
[0]);
462 for (i
= 1; i
< nrules
; i
++)
464 struct gdb_exception e
= interp_exec (interp_to_use
, prules
[i
]);
468 interp_set (old_interp
, 0);
469 interp_set_quiet (interp_to_use
, use_quiet
);
470 interp_set_quiet (old_interp
, old_quiet
);
471 error (_("error in command: \"%s\"."), prules
[i
]);
475 interp_set (old_interp
, 0);
476 interp_set_quiet (interp_to_use
, use_quiet
);
477 interp_set_quiet (old_interp
, old_quiet
);
479 do_cleanups (cleanup
);
482 /* List the possible interpreters which could complete the given text. */
483 static VEC (char_ptr
) *
484 interpreter_completer (struct cmd_list_element
*ignore
,
485 const char *text
, const char *word
)
488 VEC (char_ptr
) *matches
= NULL
;
489 struct interp
*interp
;
491 textlen
= strlen (text
);
492 for (interp
= interp_list
; interp
!= NULL
; interp
= interp
->next
)
494 if (strncmp (interp
->name
, text
, textlen
) == 0)
498 match
= (char *) xmalloc (strlen (word
) + strlen (interp
->name
) + 1);
500 strcpy (match
, interp
->name
);
501 else if (word
> text
)
503 /* Return some portion of interp->name. */
504 strcpy (match
, interp
->name
+ (word
- text
));
508 /* Return some of text plus interp->name. */
509 strncpy (match
, word
, text
- word
);
510 match
[text
- word
] = '\0';
511 strcat (match
, interp
->name
);
513 VEC_safe_push (char_ptr
, matches
, match
);
521 top_level_interpreter (void)
523 return top_level_interpreter_ptr
;
527 top_level_interpreter_data (void)
529 gdb_assert (top_level_interpreter_ptr
);
530 return top_level_interpreter_ptr
->data
;
533 /* This just adds the "interpreter-exec" command. */
535 _initialize_interpreter (void)
537 struct cmd_list_element
*c
;
539 c
= add_cmd ("interpreter-exec", class_support
,
540 interpreter_exec_cmd
, _("\
541 Execute a command in an interpreter. It takes two arguments:\n\
542 The first argument is the name of the interpreter to use.\n\
543 The second argument is the command to execute.\n"), &cmdlist
);
544 set_cmd_completer (c
, interpreter_completer
);