/* Manages interpreters for GDB, the GNU debugger.
- Copyright (C) 2000-2017 Free Software Foundation, Inc.
+ Copyright (C) 2000-2023 Free Software Foundation, Inc.
Written by Jim Ingham <jingham@apple.com> of Apple Computer, Inc.
#include "defs.h"
#include "gdbcmd.h"
#include "ui-out.h"
-#include "event-loop.h"
+#include "gdbsupport/event-loop.h"
#include "event-top.h"
#include "interps.h"
#include "completer.h"
-#include "top.h" /* For command_loop. */
-#include "continuations.h"
-
-/* Each UI has its own independent set of interpreters. */
-
-struct ui_interp_info
-{
- /* Each top level has its own independent set of interpreters. */
- struct interp *interp_list;
- struct interp *current_interpreter;
- struct interp *top_level_interpreter;
-
- /* The interpreter that is active while `interp_exec' is active, NULL
- at all other times. */
- struct interp *command_interpreter;
-};
-
-/* Get UI's ui_interp_info object. Never returns NULL. */
-
-static struct ui_interp_info *
-get_interp_info (struct ui *ui)
-{
- if (ui->interp_info == NULL)
- ui->interp_info = XCNEW (struct ui_interp_info);
- return ui->interp_info;
-}
-
-/* Get the current UI's ui_interp_info object. Never returns
- NULL. */
-
-static struct ui_interp_info *
-get_current_interp_info (void)
-{
- return get_interp_info (current_ui);
-}
+#include "ui.h"
+#include "main.h"
+#include "gdbsupport/buildargv.h"
+#include "gdbsupport/scope-exit.h"
/* The magic initialization routine for this module. */
-void _initialize_interpreter (void);
-
static struct interp *interp_lookup_existing (struct ui *ui,
const char *name);
interp::interp (const char *name)
+ : m_name (name)
{
- this->name = xstrdup (name);
- this->inited = false;
}
-interp::~interp ()
-{}
+interp::~interp () = default;
/* An interpreter factory. Maps an interpreter name to the factory
function that instantiates an interpreter by that name. */
struct interp_factory
{
+ interp_factory (const char *name_, interp_factory_func func_)
+ : name (name_), func (func_)
+ {}
+
/* This is the name in "-i=INTERP" and "interpreter-exec INTERP". */
const char *name;
interp_factory_func func;
};
-typedef struct interp_factory *interp_factory_p;
-DEF_VEC_P(interp_factory_p);
-
/* The registered interpreter factories. */
-static VEC(interp_factory_p) *interpreter_factories = NULL;
+static std::vector<interp_factory> interpreter_factories;
/* See interps.h. */
void
interp_factory_register (const char *name, interp_factory_func func)
{
- struct interp_factory *f;
- int ix;
-
/* Assert that no factory for NAME is already registered. */
- for (ix = 0;
- VEC_iterate (interp_factory_p, interpreter_factories, ix, f);
- ++ix)
- if (strcmp (f->name, name) == 0)
+ for (const interp_factory &f : interpreter_factories)
+ if (strcmp (f.name, name) == 0)
{
- internal_error (__FILE__, __LINE__,
- _("interpreter factory already registered: \"%s\"\n"),
+ internal_error (_("interpreter factory already registered: \"%s\"\n"),
name);
}
- f = XNEW (struct interp_factory);
- f->name = name;
- f->func = func;
- VEC_safe_push (interp_factory_p, interpreter_factories, f);
+ interpreter_factories.emplace_back (name, func);
}
/* Add interpreter INTERP to the gdb interpreter list. The
interpreter must not have previously been added. */
-void
+static void
interp_add (struct ui *ui, struct interp *interp)
{
- struct ui_interp_info *ui_interp = get_interp_info (ui);
+ gdb_assert (interp_lookup_existing (ui, interp->name ()) == NULL);
- gdb_assert (interp_lookup_existing (ui, interp->name) == NULL);
-
- interp->next = ui_interp->interp_list;
- ui_interp->interp_list = interp;
+ ui->interp_list.push_back (*interp);
}
/* This sets the current interpreter to be INTERP. If INTERP has not
static void
interp_set (struct interp *interp, bool top_level)
{
- struct ui_interp_info *ui_interp = get_current_interp_info ();
- struct interp *old_interp = ui_interp->current_interpreter;
+ struct interp *old_interp = current_ui->current_interpreter;
/* If we already have an interpreter, then trying to
set top level interpreter is kinda pointless. */
- gdb_assert (!top_level || !ui_interp->current_interpreter);
- gdb_assert (!top_level || !ui_interp->top_level_interpreter);
+ gdb_assert (!top_level || !current_ui->current_interpreter);
+ gdb_assert (!top_level || !current_ui->top_level_interpreter);
if (old_interp != NULL)
{
old_interp->suspend ();
}
- ui_interp->current_interpreter = interp;
+ current_ui->current_interpreter = interp;
if (top_level)
- ui_interp->top_level_interpreter = interp;
-
- /* We use interpreter_p for the "set interpreter" variable, so we need
- to make sure we have a malloc'ed copy for the set command to free. */
- if (interpreter_p != NULL
- && strcmp (interp->name, interpreter_p) != 0)
- {
- xfree (interpreter_p);
+ current_ui->top_level_interpreter = interp;
- interpreter_p = xstrdup (interp->name);
- }
+ if (interpreter_p != interp->name ())
+ interpreter_p = interp->name ();
/* Run the init proc. */
if (!interp->inited)
static struct interp *
interp_lookup_existing (struct ui *ui, const char *name)
{
- struct ui_interp_info *ui_interp = get_interp_info (ui);
- struct interp *interp;
+ for (interp &interp : ui->interp_list)
+ if (strcmp (interp.name (), name) == 0)
+ return &interp;
- for (interp = ui_interp->interp_list;
- interp != NULL;
- interp = interp->next)
- {
- if (strcmp (interp->name, name) == 0)
- return interp;
- }
-
- return NULL;
+ return nullptr;
}
/* See interps.h. */
struct interp *
interp_lookup (struct ui *ui, const char *name)
{
- struct interp_factory *factory;
- struct interp *interp;
- int ix;
-
if (name == NULL || strlen (name) == 0)
return NULL;
/* Only create each interpreter once per top level. */
- interp = interp_lookup_existing (ui, name);
+ struct interp *interp = interp_lookup_existing (ui, name);
if (interp != NULL)
return interp;
- for (ix = 0;
- VEC_iterate (interp_factory_p, interpreter_factories, ix, factory);
- ++ix)
- if (strcmp (factory->name, name) == 0)
+ for (const interp_factory &factory : interpreter_factories)
+ if (strcmp (factory.name, name) == 0)
{
- interp = factory->func (name);
+ interp = factory.func (factory.name);
interp_add (ui, interp);
return interp;
}
interp_set (interp, true);
}
-/* Returns the current interpreter. */
-
-struct ui_out *
-interp_ui_out (struct interp *interp)
-{
- struct ui_interp_info *ui_interp = get_current_interp_info ();
-
- if (interp == NULL)
- interp = ui_interp->current_interpreter;
- return interp->interp_ui_out ();
-}
-
void
-current_interp_set_logging (ui_file_up logfile,
- bool logging_redirect)
+current_interp_set_logging (ui_file_up logfile, bool logging_redirect,
+ bool debug_redirect)
{
- struct ui_interp_info *ui_interp = get_current_interp_info ();
- struct interp *interp = ui_interp->current_interpreter;
+ struct interp *interp = current_ui->current_interpreter;
- return interp->set_logging (std::move (logfile), logging_redirect);
+ interp->set_logging (std::move (logfile), logging_redirect, debug_redirect);
}
/* Temporarily overrides the current interpreter. */
struct interp *
-interp_set_temp (const char *name)
+scoped_restore_interp::set_interp (const char *name)
{
- struct ui_interp_info *ui_interp = get_current_interp_info ();
struct interp *interp = interp_lookup (current_ui, name);
- struct interp *old_interp = ui_interp->current_interpreter;
+ struct interp *old_interp = current_ui->current_interpreter;
if (interp)
- ui_interp->current_interpreter = interp;
- return old_interp;
-}
-
-/* Returns the interpreter's name. */
+ current_ui->current_interpreter = interp;
-const char *
-interp_name (struct interp *interp)
-{
- return interp->name;
+ return old_interp;
}
/* Returns true if the current interp is the passed in name. */
int
current_interp_named_p (const char *interp_name)
{
- struct ui_interp_info *ui_interp = get_current_interp_info ();
- struct interp *interp = ui_interp->current_interpreter;
+ interp *interp = current_ui->current_interpreter;
if (interp != NULL)
- return (strcmp (interp->name, interp_name) == 0);
+ return (strcmp (interp->name (), interp_name) == 0);
return 0;
}
struct interp *
command_interp (void)
{
- struct ui_interp_info *ui_interp = get_current_interp_info ();
-
- if (ui_interp->command_interpreter != NULL)
- return ui_interp->command_interpreter;
+ if (current_ui->command_interpreter != nullptr)
+ return current_ui->command_interpreter;
else
- return ui_interp->current_interpreter;
-}
-
-/* See interps.h. */
-
-void
-interp_pre_command_loop (struct interp *interp)
-{
- gdb_assert (interp != NULL);
-
- interp->pre_command_loop ();
-}
-
-/* See interp.h */
-
-int
-interp_supports_command_editing (struct interp *interp)
-{
- return interp->supports_command_editing ();
+ return current_ui->current_interpreter;
}
/* interp_exec - This executes COMMAND_STR in the current
interpreter. */
-struct gdb_exception
+void
interp_exec (struct interp *interp, const char *command_str)
{
- struct ui_interp_info *ui_interp = get_current_interp_info ();
-
- struct gdb_exception ex;
- struct interp *save_command_interp;
-
/* See `command_interp' for why we do this. */
- save_command_interp = ui_interp->command_interpreter;
- ui_interp->command_interpreter = interp;
-
- ex = interp->exec (command_str);
+ scoped_restore save_command_interp
+ = make_scoped_restore (¤t_ui->command_interpreter, interp);
- ui_interp->command_interpreter = save_command_interp;
-
- return ex;
+ interp->exec (command_str);
}
/* A convenience routine that nulls out all the common command hooks.
/*print_frame_more_info_hook = 0; */
deprecated_query_hook = 0;
deprecated_warning_hook = 0;
- deprecated_interactive_hook = 0;
deprecated_readline_begin_hook = 0;
deprecated_readline_hook = 0;
deprecated_readline_end_hook = 0;
deprecated_context_hook = 0;
- deprecated_target_wait_hook = 0;
deprecated_call_command_hook = 0;
deprecated_error_begin_hook = 0;
}
static void
-interpreter_exec_cmd (char *args, int from_tty)
+interpreter_exec_cmd (const char *args, int from_tty)
{
- struct ui_interp_info *ui_interp = get_current_interp_info ();
- struct interp *old_interp, *interp_to_use;
- char **prules = NULL;
- char **trule = NULL;
+ struct interp *interp_to_use;
unsigned int nrules;
unsigned int i;
- struct cleanup *cleanup;
+
+ /* Interpreters may clobber stdout/stderr (e.g. in mi_interp::resume at time
+ of writing), preserve their state here. */
+ scoped_restore save_stdout = make_scoped_restore (&gdb_stdout);
+ scoped_restore save_stderr = make_scoped_restore (&gdb_stderr);
+ scoped_restore save_stdlog = make_scoped_restore (&gdb_stdlog);
+ scoped_restore save_stdtarg = make_scoped_restore (&gdb_stdtarg);
+ scoped_restore save_stdtargerr = make_scoped_restore (&gdb_stdtargerr);
if (args == NULL)
error_no_arg (_("interpreter-exec command"));
- prules = gdb_buildargv (args);
- cleanup = make_cleanup_freeargv (prules);
-
- nrules = 0;
- for (trule = prules; *trule != NULL; trule++)
- nrules++;
+ gdb_argv prules (args);
+ nrules = prules.count ();
if (nrules < 2)
- error (_("usage: interpreter-exec <interpreter> [ <command> ... ]"));
+ error (_("Usage: interpreter-exec INTERPRETER COMMAND..."));
- old_interp = ui_interp->current_interpreter;
+ interp *old_interp = current_ui->current_interpreter;
interp_to_use = interp_lookup (current_ui, prules[0]);
if (interp_to_use == NULL)
error (_("Could not find interpreter \"%s\"."), prules[0]);
interp_set (interp_to_use, false);
-
- for (i = 1; i < nrules; i++)
+ SCOPE_EXIT
{
- struct gdb_exception e = interp_exec (interp_to_use, prules[i]);
+ interp_set (old_interp, false);
+ };
- if (e.reason < 0)
- {
- interp_set (old_interp, 0);
- error (_("error in command: \"%s\"."), prules[i]);
- }
- }
-
- interp_set (old_interp, 0);
-
- do_cleanups (cleanup);
+ for (i = 1; i < nrules; i++)
+ interp_exec (interp_to_use, prules[i]);
}
/* See interps.h. */
-VEC (char_ptr) *
+void
interpreter_completer (struct cmd_list_element *ignore,
+ completion_tracker &tracker,
const char *text, const char *word)
{
- struct interp_factory *interp;
- int textlen;
- VEC (char_ptr) *matches = NULL;
- int ix;
+ int textlen = strlen (text);
- textlen = strlen (text);
- for (ix = 0;
- VEC_iterate (interp_factory_p, interpreter_factories, ix, interp);
- ++ix)
+ for (const interp_factory &interp : interpreter_factories)
{
- if (strncmp (interp->name, text, textlen) == 0)
+ if (strncmp (interp.name, text, textlen) == 0)
{
- char *match;
-
- match = (char *) xmalloc (strlen (word) + strlen (interp->name) + 1);
- if (word == text)
- strcpy (match, interp->name);
- else if (word > text)
- {
- /* Return some portion of interp->name. */
- strcpy (match, interp->name + (word - text));
- }
- else
- {
- /* Return some of text plus interp->name. */
- strncpy (match, word, text - word);
- match[text - word] = '\0';
- strcat (match, interp->name);
- }
- VEC_safe_push (char_ptr, matches, match);
+ tracker.add_completion
+ (make_completion_match_str (interp.name, text, word));
}
}
-
- return matches;
}
struct interp *
top_level_interpreter (void)
{
- struct ui_interp_info *ui_interp = get_current_interp_info ();
-
- return ui_interp->top_level_interpreter;
+ return current_ui->top_level_interpreter;
}
/* See interps.h. */
struct interp *
current_interpreter (void)
{
- struct ui_interp_info *ui_interp = get_interp_info (current_ui);
+ return current_ui->current_interpreter;
+}
- return ui_interp->current_interpreter;
+/* Helper interps_notify_* functions. Call METHOD on the top-level interpreter
+ of all UIs. */
+
+template <typename ...Args>
+void
+interps_notify (void (interp::*method) (Args...), Args... args)
+{
+ SWITCH_THRU_ALL_UIS ()
+ {
+ interp *tli = top_level_interpreter ();
+ if (tli != nullptr)
+ (tli->*method) (args...);
+ }
+}
+
+/* See interps.h. */
+
+void
+interps_notify_signal_received (gdb_signal sig)
+{
+ interps_notify (&interp::on_signal_received, sig);
+}
+
+/* See interps.h. */
+
+void
+interps_notify_signal_exited (gdb_signal sig)
+{
+ interps_notify (&interp::on_signal_exited, sig);
+}
+
+/* See interps.h. */
+
+void
+interps_notify_no_history ()
+{
+ interps_notify (&interp::on_no_history);
+}
+
+/* See interps.h. */
+
+void
+interps_notify_normal_stop (bpstat *bs, int print_frame)
+{
+ interps_notify (&interp::on_normal_stop, bs, print_frame);
+}
+
+/* See interps.h. */
+
+void
+interps_notify_exited (int status)
+{
+ interps_notify (&interp::on_exited, status);
+}
+
+/* See interps.h. */
+
+void
+interps_notify_user_selected_context_changed (user_selected_what selection)
+{
+ interps_notify (&interp::on_user_selected_context_changed, selection);
+}
+
+/* See interps.h. */
+
+void
+interps_notify_new_thread (thread_info *t)
+{
+ interps_notify (&interp::on_new_thread, t);
+}
+
+/* See interps.h. */
+
+void
+interps_notify_thread_exited (thread_info *t,
+ gdb::optional<ULONGEST> exit_code,
+ int silent)
+{
+ interps_notify (&interp::on_thread_exited, t, exit_code, silent);
+}
+
+/* See interps.h. */
+
+void
+interps_notify_inferior_added (inferior *inf)
+{
+ interps_notify (&interp::on_inferior_added, inf);
+}
+
+/* See interps.h. */
+
+void
+interps_notify_inferior_appeared (inferior *inf)
+{
+ interps_notify (&interp::on_inferior_appeared, inf);
+}
+
+/* See interps.h. */
+
+void
+interps_notify_inferior_disappeared (inferior *inf)
+{
+ interps_notify (&interp::on_inferior_disappeared, inf);
+}
+
+/* See interps.h. */
+
+void
+interps_notify_inferior_removed (inferior *inf)
+{
+ interps_notify (&interp::on_inferior_removed, inf);
+}
+
+/* See interps.h. */
+
+void
+interps_notify_record_changed (inferior *inf, int started, const char *method,
+ const char *format)
+{
+ interps_notify (&interp::on_record_changed, inf, started, method, format);
+}
+
+/* See interps.h. */
+
+void
+interps_notify_target_resumed (ptid_t ptid)
+{
+ interps_notify (&interp::on_target_resumed, ptid);
+}
+
+/* See interps.h. */
+
+void
+interps_notify_solib_loaded (so_list *so)
+{
+ interps_notify (&interp::on_solib_loaded, so);
+}
+
+/* See interps.h. */
+
+void
+interps_notify_solib_unloaded (so_list *so)
+{
+ interps_notify (&interp::on_solib_unloaded, so);
+}
+
+/* See interps.h. */
+
+void
+interps_notify_traceframe_changed (int tfnum, int tpnum)
+{
+ interps_notify (&interp::on_traceframe_changed, tfnum, tpnum);
+}
+
+/* See interps.h. */
+
+void
+interps_notify_tsv_created (const trace_state_variable *tsv)
+{
+ interps_notify (&interp::on_tsv_created, tsv);
+}
+
+/* See interps.h. */
+
+void
+interps_notify_tsv_deleted (const trace_state_variable *tsv)
+{
+ interps_notify (&interp::on_tsv_deleted, tsv);
+}
+
+/* See interps.h. */
+
+void
+interps_notify_tsv_modified (const trace_state_variable *tsv)
+{
+ interps_notify (&interp::on_tsv_modified, tsv);
+}
+
+/* See interps.h. */
+
+void
+interps_notify_breakpoint_created (breakpoint *b)
+{
+ interps_notify (&interp::on_breakpoint_created, b);
+}
+
+/* See interps.h. */
+
+void
+interps_notify_breakpoint_deleted (breakpoint *b)
+{
+ interps_notify (&interp::on_breakpoint_deleted, b);
+}
+
+/* See interps.h. */
+
+void
+interps_notify_breakpoint_modified (breakpoint *b)
+{
+ interps_notify (&interp::on_breakpoint_modified, b);
+}
+
+/* See interps.h. */
+
+void
+interps_notify_param_changed (const char *param, const char *value)
+{
+ interps_notify (&interp::on_param_changed, param, value);
+}
+
+/* See interps.h. */
+
+void
+interps_notify_memory_changed (inferior *inf, CORE_ADDR addr, ssize_t len,
+ const bfd_byte *data)
+{
+ interps_notify (&interp::on_memory_changed, inf, addr, len, data);
}
/* This just adds the "interpreter-exec" command. */
+void _initialize_interpreter ();
void
-_initialize_interpreter (void)
+_initialize_interpreter ()
{
struct cmd_list_element *c;
c = add_cmd ("interpreter-exec", class_support,
interpreter_exec_cmd, _("\
-Execute a command in an interpreter. It takes two arguments:\n\
+Execute a command in an interpreter.\n\
+Usage: interpreter-exec INTERPRETER COMMAND...\n\
The first argument is the name of the interpreter to use.\n\
-The second argument is the command to execute.\n"), &cmdlist);
+The following arguments are the commands to execute.\n\
+A command can have arguments, separated by spaces.\n\
+These spaces must be escaped using \\ or the command\n\
+and its arguments must be enclosed in double quotes."), &cmdlist);
set_cmd_completer (c, interpreter_completer);
}