1 /* MI Interpreter Definitions and Commands for GDB, the GNU debugger.
3 Copyright 2002, 2003, 2003 Free Software Foundation, Inc.
5 This file is part of GDB.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program; if not, write to the Free Software
19 Foundation, Inc., 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
23 #include "gdb_string.h"
25 #include "event-top.h"
26 #include "event-loop.h"
34 #include "mi-console.h"
38 /* MI's output channels */
43 struct ui_file *event_channel;
45 /* This is the interpreter for the mi... */
46 struct interp *mi2_interp;
47 struct interp *mi1_interp;
48 struct interp *mi_interp;
51 /* These are the interpreter setup, etc. functions for the MI interpreter */
52 static void mi_execute_command_wrapper (char *cmd);
53 static void mi_command_loop (int mi_version);
54 static char *mi_input (char *);
56 /* These are hooks that we put in place while doing interpreter_exec
57 so we can report interesting things that happened "behind the mi's
58 back" in this command */
59 static int mi_interp_query_hook (const char *ctlstr, va_list ap);
61 static void mi3_command_loop (void);
62 static void mi2_command_loop (void);
63 static void mi1_command_loop (void);
65 static void mi_insert_notify_hooks (void);
66 static void mi_remove_notify_hooks (void);
69 mi_interpreter_init (void)
71 struct mi_interp *mi = XMALLOC (struct mi_interp);
73 /* Why is this a part of the mi architecture? */
75 mi_setup_architecture_data ();
77 /* HACK: We need to force stdout/stderr to point at the console. This avoids
78 any potential side effects caused by legacy code that is still
79 using the TUI / fputs_unfiltered_hook. So we set up output channels for
80 this now, and swap them in when we are run. */
82 raw_stdout = stdio_fileopen (stdout);
84 /* Create MI channels */
85 mi->out = mi_console_file_new (raw_stdout, "~", '"');
86 mi->err = mi_console_file_new (raw_stdout, "&", '"');
88 mi->targ = mi_console_file_new (raw_stdout, "@", '"');
89 mi->event_channel = mi_console_file_new (raw_stdout, "=", 0);
95 mi_interpreter_resume (void *data)
97 struct mi_interp *mi = data;
98 /* As per hack note in mi_interpreter_init, swap in the output channels... */
100 gdb_setup_readline ();
104 /* These overwrite some of the initialization done in
105 _intialize_event_loop. */
106 call_readline = gdb_readline2;
107 input_handler = mi_execute_command_wrapper;
108 add_file_handler (input_fd, stdin_event_handler, 0);
109 async_command_editing_p = 0;
110 /* FIXME: This is a total hack for now. PB's use of the MI implicitly
111 relies on a bug in the async support which allows asynchronous
112 commands to leak through the commmand loop. The bug involves
113 (but is not limited to) the fact that sync_execution was
114 erroneously initialized to 0. Duplicate by initializing it
119 gdb_stdout = mi->out;
120 /* Route error and log output through the MI */
121 gdb_stderr = mi->err;
122 gdb_stdlog = mi->log;
123 /* Route target output through the MI. */
124 gdb_stdtarg = mi->targ;
126 /* Replace all the hooks that we know about. There really needs to
127 be a better way of doing this... */
128 clear_interpreter_hooks ();
130 deprecated_show_load_progress = mi_load_progress;
132 /* If we're _the_ interpreter, take control. */
133 if (current_interp_named_p (INTERP_MI1))
134 deprecated_command_loop_hook = mi1_command_loop;
135 else if (current_interp_named_p (INTERP_MI2))
136 deprecated_command_loop_hook = mi2_command_loop;
137 else if (current_interp_named_p (INTERP_MI3))
138 deprecated_command_loop_hook = mi3_command_loop;
140 deprecated_command_loop_hook = mi2_command_loop;
146 mi_interpreter_suspend (void *data)
148 gdb_disable_readline ();
153 mi_interpreter_exec (void *data, const char *command)
155 char *tmp = alloca (strlen (command) + 1);
156 strcpy (tmp, command);
157 mi_execute_command_wrapper (tmp);
161 /* Never display the default gdb prompt in mi case. */
163 mi_interpreter_prompt_p (void *data)
169 mi_interpreter_exec_continuation (struct continuation_arg *arg)
171 bpstat_do_actions (&stop_bpstat);
172 if (!target_executing)
174 fputs_unfiltered ("*stopped", raw_stdout);
175 mi_out_put (uiout, raw_stdout);
176 fputs_unfiltered ("\n", raw_stdout);
177 fputs_unfiltered ("(gdb) \n", raw_stdout);
178 gdb_flush (raw_stdout);
179 do_exec_cleanups (ALL_CLEANUPS);
181 else if (target_can_async_p ())
183 add_continuation (mi_interpreter_exec_continuation, NULL);
188 mi_cmd_interpreter_exec (char *command, char **argv, int argc)
190 struct interp *interp_to_use;
191 enum mi_cmd_result result = MI_CMD_DONE;
193 struct interp_procs *procs;
197 mi_error_message = xstrprintf ("mi_cmd_interpreter_exec: Usage: -interpreter-exec interp command");
201 interp_to_use = interp_lookup (argv[0]);
202 if (interp_to_use == NULL)
204 mi_error_message = xstrprintf ("mi_cmd_interpreter_exec: could not find interpreter \"%s\"", argv[0]);
208 if (!interp_exec_p (interp_to_use))
210 mi_error_message = xstrprintf ("mi_cmd_interpreter_exec: interpreter \"%s\" does not support command execution",
215 /* Insert the MI out hooks, making sure to also call the interpreter's hooks
217 /* KRS: We shouldn't need this... Events should be installed and they should
218 just ALWAYS fire something out down the MI channel... */
219 mi_insert_notify_hooks ();
221 /* Now run the code... */
223 for (i = 1; i < argc; i++)
226 /* Do this in a cleaner way... We want to force execution to be
227 asynchronous for commands that run the target. */
228 if (target_can_async_p () && (strcmp (argv[0], "console") == 0))
230 int len = strlen (argv[i]);
231 buff = xmalloc (len + 2);
232 memcpy (buff, argv[i], len);
234 buff[len + 1] = '\0';
237 /* We had to set sync_execution = 0 for the mi (well really for Project
238 Builder's use of the mi - particularly so interrupting would work.
239 But for console commands to work, we need to initialize it to 1 -
240 since that is what the cli expects - before running the command,
241 and then set it back to 0 when we are done. */
243 if (interp_exec (interp_to_use, argv[i]) < 0)
245 mi_error_message = error_last_message ();
246 result = MI_CMD_ERROR;
250 do_exec_error_cleanups (ALL_CLEANUPS);
254 mi_remove_notify_hooks ();
256 /* Okay, now let's see if the command set the inferior going...
257 Tricky point - have to do this AFTER resetting the interpreter, since
258 changing the interpreter will clear out all the continuations for
259 that interpreter... */
261 if (target_can_async_p () && target_executing)
263 fputs_unfiltered ("^running\n", raw_stdout);
264 add_continuation (mi_interpreter_exec_continuation, NULL);
271 * mi_insert_notify_hooks - This inserts a number of hooks that are meant to produce
272 * async-notify ("=") MI messages while running commands in another interpreter
273 * using mi_interpreter_exec. The canonical use for this is to allow access to
274 * the gdb CLI interpreter from within the MI, while still producing MI style output
275 * when actions in the CLI command change gdb's state.
279 mi_insert_notify_hooks (void)
281 deprecated_query_hook = mi_interp_query_hook;
285 mi_remove_notify_hooks (void)
287 deprecated_query_hook = NULL;
291 mi_interp_query_hook (const char *ctlstr, va_list ap)
297 mi_execute_command_wrapper (char *cmd)
299 mi_execute_command (cmd, stdin == instream);
303 mi1_command_loop (void)
309 mi2_command_loop (void)
315 mi3_command_loop (void)
321 mi_command_loop (int mi_version)
324 /* HACK: Force stdout/stderr to point at the console. This avoids
325 any potential side effects caused by legacy code that is still
326 using the TUI / fputs_unfiltered_hook */
327 raw_stdout = stdio_fileopen (stdout);
328 /* Route normal output through the MIx */
329 gdb_stdout = mi_console_file_new (raw_stdout, "~", '"');
330 /* Route error and log output through the MI */
331 gdb_stderr = mi_console_file_new (raw_stdout, "&", '"');
332 gdb_stdlog = gdb_stderr;
333 /* Route target output through the MI. */
334 gdb_stdtarg = mi_console_file_new (raw_stdout, "@", '"');
335 /* HACK: Poke the ui_out table directly. Should we be creating a
336 mi_out object wired up to the above gdb_stdout / gdb_stderr? */
337 uiout = mi_out_new (mi_version);
338 /* HACK: Override any other interpreter hooks. We need to create a
339 real event table and pass in that. */
340 deprecated_init_ui_hook = 0;
341 /* deprecated_command_loop_hook = 0; */
342 deprecated_print_frame_info_listing_hook = 0;
343 deprecated_query_hook = 0;
344 deprecated_warning_hook = 0;
345 deprecated_create_breakpoint_hook = 0;
346 deprecated_delete_breakpoint_hook = 0;
347 deprecated_modify_breakpoint_hook = 0;
348 deprecated_interactive_hook = 0;
349 deprecated_registers_changed_hook = 0;
350 deprecated_readline_begin_hook = 0;
351 deprecated_readline_hook = 0;
352 deprecated_readline_end_hook = 0;
353 deprecated_register_changed_hook = 0;
354 deprecated_memory_changed_hook = 0;
355 deprecated_context_hook = 0;
356 deprecated_target_wait_hook = 0;
357 deprecated_call_command_hook = 0;
358 deprecated_error_hook = 0;
359 deprecated_error_begin_hook = 0;
360 deprecated_show_load_progress = mi_load_progress;
362 /* Turn off 8 bit strings in quoted output. Any character with the
363 high bit set is printed using C's octal format. */
364 sevenbit_strings = 1;
365 /* Tell the world that we're alive */
366 fputs_unfiltered ("(gdb) \n", raw_stdout);
367 gdb_flush (raw_stdout);
369 simplified_command_loop (mi_input, mi_execute_command);
377 return gdb_readline (NULL);
380 extern initialize_file_ftype _initialize_mi_interp; /* -Wmissing-prototypes */
383 _initialize_mi_interp (void)
385 static const struct interp_procs procs =
387 mi_interpreter_init, /* init_proc */
388 mi_interpreter_resume, /* resume_proc */
389 mi_interpreter_suspend, /* suspend_proc */
390 mi_interpreter_exec, /* exec_proc */
391 mi_interpreter_prompt_p /* prompt_proc_p */
394 /* The various interpreter levels. */
395 interp_add (interp_new (INTERP_MI1, NULL, mi_out_new (1), &procs));
396 interp_add (interp_new (INTERP_MI2, NULL, mi_out_new (2), &procs));
397 interp_add (interp_new (INTERP_MI3, NULL, mi_out_new (3), &procs));
399 /* "mi" selects the most recent released version. "mi2" was
400 released as part of GDB 6.0. */
401 interp_add (interp_new (INTERP_MI, NULL, mi_out_new (2), &procs));