binutils-gdb/gdb/mi/mi-interp.c

395 lines
12 KiB
C

/* MI Interpreter Definitions and Commands for GDB, the GNU debugger.
Copyright 2002, 2003, 2004, 2005 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 2 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, write to the Free Software
Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA. */
#include "defs.h"
#include "gdb_string.h"
#include "interps.h"
#include "event-top.h"
#include "event-loop.h"
#include "inferior.h"
#include "ui-out.h"
#include "top.h"
#include "exceptions.h"
#include "mi-main.h"
#include "mi-cmds.h"
#include "mi-out.h"
#include "mi-console.h"
struct mi_interp
{
/* MI's output channels */
struct ui_file *out;
struct ui_file *err;
struct ui_file *log;
struct ui_file *targ;
struct ui_file *event_channel;
/* This is the interpreter for the mi... */
struct interp *mi2_interp;
struct interp *mi1_interp;
struct interp *mi_interp;
};
/* These are the interpreter setup, etc. functions for the MI interpreter */
static void mi_execute_command_wrapper (char *cmd);
static void mi_command_loop (int mi_version);
/* These are hooks that we put in place while doing interpreter_exec
so we can report interesting things that happened "behind the mi's
back" in this command */
static int mi_interp_query_hook (const char *ctlstr, va_list ap)
ATTR_FORMAT (printf, 1, 0);
static void mi3_command_loop (void);
static void mi2_command_loop (void);
static void mi1_command_loop (void);
static void mi_insert_notify_hooks (void);
static void mi_remove_notify_hooks (void);
static void *
mi_interpreter_init (void)
{
struct mi_interp *mi = XMALLOC (struct mi_interp);
/* Why is this a part of the mi architecture? */
mi_setup_architecture_data ();
/* HACK: We need to force stdout/stderr to point at the console. This avoids
any potential side effects caused by legacy code that is still
using the TUI / fputs_unfiltered_hook. So we set up output channels for
this now, and swap them in when we are run. */
raw_stdout = stdio_fileopen (stdout);
/* Create MI channels */
mi->out = mi_console_file_new (raw_stdout, "~", '"');
mi->err = mi_console_file_new (raw_stdout, "&", '"');
mi->log = mi->err;
mi->targ = mi_console_file_new (raw_stdout, "@", '"');
mi->event_channel = mi_console_file_new (raw_stdout, "=", 0);
return mi;
}
static int
mi_interpreter_resume (void *data)
{
struct mi_interp *mi = data;
/* As per hack note in mi_interpreter_init, swap in the output channels... */
gdb_setup_readline ();
/* These overwrite some of the initialization done in
_intialize_event_loop. */
call_readline = gdb_readline2;
input_handler = mi_execute_command_wrapper;
add_file_handler (input_fd, stdin_event_handler, 0);
async_command_editing_p = 0;
/* FIXME: This is a total hack for now. PB's use of the MI
implicitly relies on a bug in the async support which allows
asynchronous commands to leak through the commmand loop. The bug
involves (but is not limited to) the fact that sync_execution was
erroneously initialized to 0. Duplicate by initializing it thus
here... */
sync_execution = 0;
gdb_stdout = mi->out;
/* Route error and log output through the MI */
gdb_stderr = mi->err;
gdb_stdlog = mi->log;
/* Route target output through the MI. */
gdb_stdtarg = mi->targ;
/* Replace all the hooks that we know about. There really needs to
be a better way of doing this... */
clear_interpreter_hooks ();
deprecated_show_load_progress = mi_load_progress;
/* If we're _the_ interpreter, take control. */
if (current_interp_named_p (INTERP_MI1))
deprecated_command_loop_hook = mi1_command_loop;
else if (current_interp_named_p (INTERP_MI2))
deprecated_command_loop_hook = mi2_command_loop;
else if (current_interp_named_p (INTERP_MI3))
deprecated_command_loop_hook = mi3_command_loop;
else
deprecated_command_loop_hook = mi2_command_loop;
return 1;
}
static int
mi_interpreter_suspend (void *data)
{
gdb_disable_readline ();
return 1;
}
static struct gdb_exception
mi_interpreter_exec (void *data, const char *command)
{
static struct gdb_exception ok;
char *tmp = alloca (strlen (command) + 1);
strcpy (tmp, command);
mi_execute_command_wrapper (tmp);
return exception_none;
}
/* Never display the default gdb prompt in mi case. */
static int
mi_interpreter_prompt_p (void *data)
{
return 0;
}
static void
mi_interpreter_exec_continuation (struct continuation_arg *arg)
{
bpstat_do_actions (&stop_bpstat);
if (!target_executing)
{
fputs_unfiltered ("*stopped", raw_stdout);
mi_out_put (uiout, raw_stdout);
fputs_unfiltered ("\n", raw_stdout);
fputs_unfiltered ("(gdb) \n", raw_stdout);
gdb_flush (raw_stdout);
do_exec_cleanups (ALL_CLEANUPS);
}
else if (target_can_async_p ())
{
add_continuation (mi_interpreter_exec_continuation, NULL);
}
}
enum mi_cmd_result
mi_cmd_interpreter_exec (char *command, char **argv, int argc)
{
struct interp *interp_to_use;
enum mi_cmd_result result = MI_CMD_DONE;
int i;
struct interp_procs *procs;
if (argc < 2)
{
mi_error_message = xstrprintf ("mi_cmd_interpreter_exec: Usage: -interpreter-exec interp command");
return MI_CMD_ERROR;
}
interp_to_use = interp_lookup (argv[0]);
if (interp_to_use == NULL)
{
mi_error_message = xstrprintf ("mi_cmd_interpreter_exec: could not find interpreter \"%s\"", argv[0]);
return MI_CMD_ERROR;
}
if (!interp_exec_p (interp_to_use))
{
mi_error_message = xstrprintf ("mi_cmd_interpreter_exec: interpreter \"%s\" does not support command execution",
argv[0]);
return MI_CMD_ERROR;
}
/* Insert the MI out hooks, making sure to also call the interpreter's hooks
if it has any. */
/* KRS: We shouldn't need this... Events should be installed and they should
just ALWAYS fire something out down the MI channel... */
mi_insert_notify_hooks ();
/* Now run the code... */
for (i = 1; i < argc; i++)
{
char *buff = NULL;
/* Do this in a cleaner way... We want to force execution to be
asynchronous for commands that run the target. */
if (target_can_async_p () && (strcmp (argv[0], "console") == 0))
{
int len = strlen (argv[i]);
buff = xmalloc (len + 2);
memcpy (buff, argv[i], len);
buff[len] = '&';
buff[len + 1] = '\0';
}
/* We had to set sync_execution = 0 for the mi (well really for Project
Builder's use of the mi - particularly so interrupting would work.
But for console commands to work, we need to initialize it to 1 -
since that is what the cli expects - before running the command,
and then set it back to 0 when we are done. */
sync_execution = 1;
{
struct gdb_exception e = interp_exec (interp_to_use, argv[i]);
if (e.reason < 0)
{
mi_error_message = xstrdup (e.message);
result = MI_CMD_ERROR;
break;
}
}
xfree (buff);
do_exec_error_cleanups (ALL_CLEANUPS);
sync_execution = 0;
}
mi_remove_notify_hooks ();
/* Okay, now let's see if the command set the inferior going...
Tricky point - have to do this AFTER resetting the interpreter, since
changing the interpreter will clear out all the continuations for
that interpreter... */
if (target_can_async_p () && target_executing)
{
fputs_unfiltered ("^running\n", raw_stdout);
add_continuation (mi_interpreter_exec_continuation, NULL);
}
return result;
}
/*
* mi_insert_notify_hooks - This inserts a number of hooks that are meant to produce
* async-notify ("=") MI messages while running commands in another interpreter
* using mi_interpreter_exec. The canonical use for this is to allow access to
* the gdb CLI interpreter from within the MI, while still producing MI style output
* when actions in the CLI command change gdb's state.
*/
static void
mi_insert_notify_hooks (void)
{
deprecated_query_hook = mi_interp_query_hook;
}
static void
mi_remove_notify_hooks (void)
{
deprecated_query_hook = NULL;
}
static int
mi_interp_query_hook (const char *ctlstr, va_list ap)
{
return 1;
}
static void
mi_execute_command_wrapper (char *cmd)
{
mi_execute_command (cmd, stdin == instream);
}
static void
mi1_command_loop (void)
{
mi_command_loop (1);
}
static void
mi2_command_loop (void)
{
mi_command_loop (2);
}
static void
mi3_command_loop (void)
{
mi_command_loop (3);
}
static void
mi_command_loop (int mi_version)
{
#if 0
/* HACK: Force stdout/stderr to point at the console. This avoids
any potential side effects caused by legacy code that is still
using the TUI / fputs_unfiltered_hook */
raw_stdout = stdio_fileopen (stdout);
/* Route normal output through the MIx */
gdb_stdout = mi_console_file_new (raw_stdout, "~", '"');
/* Route error and log output through the MI */
gdb_stderr = mi_console_file_new (raw_stdout, "&", '"');
gdb_stdlog = gdb_stderr;
/* Route target output through the MI. */
gdb_stdtarg = mi_console_file_new (raw_stdout, "@", '"');
/* HACK: Poke the ui_out table directly. Should we be creating a
mi_out object wired up to the above gdb_stdout / gdb_stderr? */
uiout = mi_out_new (mi_version);
/* HACK: Override any other interpreter hooks. We need to create a
real event table and pass in that. */
deprecated_init_ui_hook = 0;
/* deprecated_command_loop_hook = 0; */
deprecated_print_frame_info_listing_hook = 0;
deprecated_query_hook = 0;
deprecated_warning_hook = 0;
deprecated_create_breakpoint_hook = 0;
deprecated_delete_breakpoint_hook = 0;
deprecated_modify_breakpoint_hook = 0;
deprecated_interactive_hook = 0;
deprecated_registers_changed_hook = 0;
deprecated_readline_begin_hook = 0;
deprecated_readline_hook = 0;
deprecated_readline_end_hook = 0;
deprecated_register_changed_hook = 0;
deprecated_memory_changed_hook = 0;
deprecated_context_hook = 0;
deprecated_target_wait_hook = 0;
deprecated_call_command_hook = 0;
deprecated_error_hook = 0;
deprecated_error_begin_hook = 0;
deprecated_show_load_progress = mi_load_progress;
#endif
/* Turn off 8 bit strings in quoted output. Any character with the
high bit set is printed using C's octal format. */
sevenbit_strings = 1;
/* Tell the world that we're alive */
fputs_unfiltered ("(gdb) \n", raw_stdout);
gdb_flush (raw_stdout);
start_event_loop ();
}
extern initialize_file_ftype _initialize_mi_interp; /* -Wmissing-prototypes */
void
_initialize_mi_interp (void)
{
static const struct interp_procs procs =
{
mi_interpreter_init, /* init_proc */
mi_interpreter_resume, /* resume_proc */
mi_interpreter_suspend, /* suspend_proc */
mi_interpreter_exec, /* exec_proc */
mi_interpreter_prompt_p /* prompt_proc_p */
};
/* The various interpreter levels. */
interp_add (interp_new (INTERP_MI1, NULL, mi_out_new (1), &procs));
interp_add (interp_new (INTERP_MI2, NULL, mi_out_new (2), &procs));
interp_add (interp_new (INTERP_MI3, NULL, mi_out_new (3), &procs));
/* "mi" selects the most recent released version. "mi2" was
released as part of GDB 6.0. */
interp_add (interp_new (INTERP_MI, NULL, mi_out_new (2), &procs));
}