1 /* Manages interpreters for GDB, the GNU debugger.
3 Copyright (C) 2000, 2002, 2003, 2007, 2008, 2009, 2010, 2011
4 Free Software Foundation, Inc.
6 Written by Jim Ingham <jingham@apple.com> of Apple Computer, Inc.
8 This file is part of GDB.
10 This program is free software; you can redistribute it and/or modify
11 it under the terms of the GNU General Public License as published by
12 the Free Software Foundation; either version 3 of the License, or
13 (at your option) any later version.
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License for more details.
20 You should have received a copy of the GNU General Public License
21 along with this program. If not, see <http://www.gnu.org/licenses/>. */
23 /* This is just a first cut at separating out the "interpreter"
24 functions of gdb into self-contained modules. There are a couple
25 of open areas that need to be sorted out:
27 1) The interpreter explicitly contains a UI_OUT, and can insert itself
28 into the event loop, but it doesn't explicitly contain hooks for readline.
29 I did this because it seems to me many interpreters won't want to use
30 the readline command interface, and it is probably simpler to just let
31 them take over the input in their resume proc. */
36 #include "event-loop.h"
37 #include "event-top.h"
39 #include "completer.h"
40 #include "gdb_string.h"
41 #include "gdb_assert.h"
42 #include "top.h" /* For command_loop. */
43 #include "exceptions.h"
44 #include "continuations.h"
48 /* This is the name in "-i=" and set interpreter. */
51 /* Interpreters are stored in a linked list, this is the next
55 /* This is a cookie that an instance of the interpreter can use.
56 This is a bit confused right now as the exact initialization
57 sequence for it, and how it relates to the interpreter's uiout
58 object is a bit confused. */
61 /* Has the init_proc been run? */
64 /* This is the ui_out used to collect results for this interpreter.
65 It can be a formatter for stdout, as is the case for the console
66 & mi outputs, or it might be a result formatter. */
67 struct ui_out *interpreter_out;
69 const struct interp_procs *procs;
73 /* Functions local to this file. */
74 static void initialize_interps (void);
75 static char **interpreter_completer (struct cmd_list_element *cmd,
76 char *text, char *word);
78 /* The magic initialization routine for this module. */
80 void _initialize_interpreter (void);
82 /* Variables local to this file: */
84 static struct interp *interp_list = NULL;
85 static struct interp *current_interpreter = NULL;
86 static struct interp *top_level_interpreter_ptr = NULL;
88 static int interpreter_initialized = 0;
90 /* interp_new - This allocates space for a new interpreter,
91 fills the fields from the inputs, and returns a pointer to the
94 interp_new (const char *name, void *data, struct ui_out *uiout,
95 const struct interp_procs *procs)
97 struct interp *new_interp;
99 new_interp = XMALLOC (struct interp);
101 new_interp->name = xstrdup (name);
102 new_interp->data = data;
103 new_interp->interpreter_out = uiout;
104 new_interp->quiet_p = 0;
105 new_interp->procs = procs;
106 new_interp->inited = 0;
111 /* Add interpreter INTERP to the gdb interpreter list. The
112 interpreter must not have previously been added. */
114 interp_add (struct interp *interp)
116 if (!interpreter_initialized)
117 initialize_interps ();
119 gdb_assert (interp_lookup (interp->name) == NULL);
121 interp->next = interp_list;
122 interp_list = interp;
125 /* This sets the current interpreter to be INTERP. If INTERP has not
126 been initialized, then this will also run the init proc. If the
127 init proc is successful, return 1, if it fails, set the old
128 interpreter back in place and return 0. If we can't restore the
129 old interpreter, then raise an internal error, since we are in
130 pretty bad shape at this point.
132 The TOP_LEVEL parameter tells if this new interpreter is
133 the top-level one. The top-level is what is requested
134 on the command line, and is responsible for reporting general
135 notification about target state changes. For example, if
136 MI is the top-level interpreter, then it will always report
137 events such as target stops and new thread creation, even if they
138 are caused by CLI commands. */
140 interp_set (struct interp *interp, int top_level)
142 struct interp *old_interp = current_interpreter;
146 /* If we already have an interpreter, then trying to
147 set top level interpreter is kinda pointless. */
148 gdb_assert (!top_level || !current_interpreter);
149 gdb_assert (!top_level || !top_level_interpreter_ptr);
151 if (current_interpreter != NULL)
153 ui_out_flush (current_uiout);
154 if (current_interpreter->procs->suspend_proc
155 && !current_interpreter->procs->suspend_proc (current_interpreter->
158 error (_("Could not suspend interpreter \"%s\"."),
159 current_interpreter->name);
167 current_interpreter = interp;
169 top_level_interpreter_ptr = interp;
171 /* We use interpreter_p for the "set interpreter" variable, so we need
172 to make sure we have a malloc'ed copy for the set command to free. */
173 if (interpreter_p != NULL
174 && strcmp (current_interpreter->name, interpreter_p) != 0)
176 xfree (interpreter_p);
178 interpreter_p = xstrdup (current_interpreter->name);
181 current_uiout = interp->interpreter_out;
183 /* Run the init proc. If it fails, try to restore the old interp. */
187 if (interp->procs->init_proc != NULL)
189 interp->data = interp->procs->init_proc (top_level);
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 sprintf (buffer, "Switching to interpreter \"%.24s\".\n",
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->interpreter_out;
253 return current_interpreter->interpreter_out;
256 /* Returns true if the current interp is the passed in name. */
258 current_interp_named_p (const char *interp_name)
260 if (current_interpreter)
261 return (strcmp (current_interpreter->name, interp_name) == 0);
266 /* This is called in display_gdb_prompt. If the proc returns a zero
267 value, display_gdb_prompt will return without displaying the
270 current_interp_display_prompt_p (void)
272 if (current_interpreter == NULL
273 || current_interpreter->procs->prompt_proc_p == NULL)
276 return current_interpreter->procs->prompt_proc_p (current_interpreter->
280 /* Run the current command interpreter's main loop. */
282 current_interp_command_loop (void)
284 /* Somewhat messy. For the moment prop up all the old ways of
285 selecting the command loop. `deprecated_command_loop_hook'
286 should be deprecated. */
287 if (deprecated_command_loop_hook != NULL)
288 deprecated_command_loop_hook ();
289 else if (current_interpreter != NULL
290 && current_interpreter->procs->command_loop_proc != NULL)
291 current_interpreter->procs->command_loop_proc (current_interpreter->data);
297 interp_quiet_p (struct interp *interp)
300 return interp->quiet_p;
302 return current_interpreter->quiet_p;
306 interp_set_quiet (struct interp *interp, int quiet)
308 int old_val = interp->quiet_p;
310 interp->quiet_p = quiet;
314 /* interp_exec - This executes COMMAND_STR in the current
317 interp_exec_p (struct interp *interp)
319 return interp->procs->exec_proc != NULL;
323 interp_exec (struct interp *interp, const char *command_str)
325 if (interp->procs->exec_proc != NULL)
327 return interp->procs->exec_proc (interp->data, command_str);
329 return exception_none;
332 /* A convenience routine that nulls out all the common command hooks.
333 Use it when removing your interpreter in its suspend proc. */
335 clear_interpreter_hooks (void)
337 deprecated_init_ui_hook = 0;
338 deprecated_print_frame_info_listing_hook = 0;
339 /*print_frame_more_info_hook = 0; */
340 deprecated_query_hook = 0;
341 deprecated_warning_hook = 0;
342 deprecated_interactive_hook = 0;
343 deprecated_readline_begin_hook = 0;
344 deprecated_readline_hook = 0;
345 deprecated_readline_end_hook = 0;
346 deprecated_register_changed_hook = 0;
347 deprecated_context_hook = 0;
348 deprecated_target_wait_hook = 0;
349 deprecated_call_command_hook = 0;
350 deprecated_error_begin_hook = 0;
351 deprecated_command_loop_hook = 0;
354 /* This is a lazy init routine, called the first time the interpreter
355 module is used. I put it here just in case, but I haven't thought
356 of a use for it yet. I will probably bag it soon, since I don't
357 think it will be necessary. */
359 initialize_interps (void)
361 interpreter_initialized = 1;
362 /* Don't know if anything needs to be done here... */
366 interpreter_exec_cmd (char *args, int from_tty)
368 struct interp *old_interp, *interp_to_use;
369 char **prules = NULL;
373 int old_quiet, use_quiet;
376 error_no_arg (_("interpreter-exec command"));
378 prules = gdb_buildargv (args);
379 make_cleanup_freeargv (prules);
382 for (trule = prules; *trule != NULL; trule++)
386 error (_("usage: interpreter-exec <interpreter> [ <command> ... ]"));
388 old_interp = current_interpreter;
390 interp_to_use = interp_lookup (prules[0]);
391 if (interp_to_use == NULL)
392 error (_("Could not find interpreter \"%s\"."), prules[0]);
394 /* Temporarily set interpreters quiet. */
395 old_quiet = interp_set_quiet (old_interp, 1);
396 use_quiet = interp_set_quiet (interp_to_use, 1);
398 if (!interp_set (interp_to_use, 0))
399 error (_("Could not switch to interpreter \"%s\"."), prules[0]);
401 for (i = 1; i < nrules; i++)
403 struct gdb_exception e = interp_exec (interp_to_use, prules[i]);
407 interp_set (old_interp, 0);
408 interp_set_quiet (interp_to_use, use_quiet);
409 interp_set_quiet (old_interp, old_quiet);
410 error (_("error in command: \"%s\"."), prules[i]);
414 interp_set (old_interp, 0);
415 interp_set_quiet (interp_to_use, use_quiet);
416 interp_set_quiet (old_interp, old_quiet);
419 /* List the possible interpreters which could complete the given text. */
421 interpreter_completer (struct cmd_list_element *ignore, char *text, char *word)
427 struct interp *interp;
429 /* We expect only a very limited number of interpreters, so just
430 allocate room for all of them plus one for the last that must be NULL
431 to correctly end the list. */
432 for (interp = interp_list; interp != NULL; interp = interp->next)
434 matches = (char **) xcalloc (alloced + 1, sizeof (char *));
437 textlen = strlen (text);
438 for (interp = interp_list; interp != NULL; interp = interp->next)
440 if (strncmp (interp->name, text, textlen) == 0)
442 matches[num_matches] =
443 (char *) xmalloc (strlen (word) + strlen (interp->name) + 1);
445 strcpy (matches[num_matches], interp->name);
446 else if (word > text)
448 /* Return some portion of interp->name. */
449 strcpy (matches[num_matches], interp->name + (word - text));
453 /* Return some of text plus interp->name. */
454 strncpy (matches[num_matches], word, text - word);
455 matches[num_matches][text - word] = '\0';
456 strcat (matches[num_matches], interp->name);
462 if (num_matches == 0)
472 top_level_interpreter (void)
474 return top_level_interpreter_ptr;
478 top_level_interpreter_data (void)
480 gdb_assert (top_level_interpreter_ptr);
481 return top_level_interpreter_ptr->data;
484 /* This just adds the "interpreter-exec" command. */
486 _initialize_interpreter (void)
488 struct cmd_list_element *c;
490 c = add_cmd ("interpreter-exec", class_support,
491 interpreter_exec_cmd, _("\
492 Execute a command in an interpreter. It takes two arguments:\n\
493 The first argument is the name of the interpreter to use.\n\
494 The second argument is the command to execute.\n"), &cmdlist);
495 set_cmd_completer (c, interpreter_completer);