1 /* CLI Definitions for GDB, the GNU debugger.
3 Copyright (C) 2002-2017 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 3 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, see <http://www.gnu.org/licenses/>. */
21 #include "cli-interp.h"
23 #include "event-top.h"
26 #include "top.h" /* for "execute_command" */
27 #include "event-top.h"
30 #include "gdbthread.h"
31 #include "thread-fsm.h"
33 cli_interp_base::cli_interp_base (const char *name)
37 cli_interp_base::~cli_interp_base ()
40 /* The console interpreter. */
42 class cli_interp final : public cli_interp_base
45 explicit cli_interp (const char *name);
47 void init (bool top_level) override;
48 void resume () override;
49 void suspend () override;
50 gdb_exception exec (const char *command_str) override;
51 ui_out *interp_ui_out () override;
53 /* The ui_out for the console interpreter. */
54 cli_ui_out *cli_uiout;
57 cli_interp::cli_interp (const char *name)
58 : cli_interp_base (name)
60 /* Create a default uiout builder for the CLI. */
61 this->cli_uiout = cli_out_new (gdb_stdout);
64 /* Suppress notification struct. */
65 struct cli_suppress_notification cli_suppress_notification =
67 0 /* user_selected_context_changed */
70 /* Returns the INTERP's data cast as cli_interp if INTERP is a CLI,
71 and returns NULL otherwise. */
73 static struct cli_interp *
74 as_cli_interp (struct interp *interp)
76 if (strcmp (interp_name (interp), INTERP_CONSOLE) == 0)
77 return (struct cli_interp *) interp;
81 /* Longjmp-safe wrapper for "execute_command". */
82 static struct gdb_exception safe_execute_command (struct ui_out *uiout,
88 Breakpoint hits should always be mirrored to a console. Deciding
89 what to mirror to a console wrt to breakpoints and random stops
90 gets messy real fast. E.g., say "s" trips on a breakpoint. We'd
91 clearly want to mirror the event to the console in this case. But
92 what about more complicated cases like "s&; thread n; s&", and one
93 of those steps spawning a new thread, and that thread hitting a
94 breakpoint? It's impossible in general to track whether the thread
95 had any relation to the commands that had been executed. So we
96 just simplify and always mirror breakpoints and random events to
99 OTOH, we should print the source line to the console when stepping
100 or other similar commands, iff the step was started by that console
101 (or in MI's case, by a console command), but not if it was started
102 with MI's -exec-step or similar. */
105 should_print_stop_to_console (struct interp *console_interp,
106 struct thread_info *tp)
108 if ((bpstat_what (tp->control.stop_bpstat).main_action
109 == BPSTAT_WHAT_STOP_NOISY)
110 || tp->thread_fsm == NULL
111 || tp->thread_fsm->command_interp == console_interp
112 || !thread_fsm_finished_p (tp->thread_fsm))
117 /* Observers for several run control events. If the interpreter is
118 quiet (i.e., another interpreter is being run with
119 interpreter-exec), print nothing. */
121 /* Observer for the normal_stop notification. */
124 cli_on_normal_stop (struct bpstats *bs, int print_frame)
129 SWITCH_THRU_ALL_UIS ()
131 struct interp *interp = top_level_interpreter ();
132 struct cli_interp *cli = as_cli_interp (interp);
133 struct thread_info *thread;
138 thread = inferior_thread ();
139 if (should_print_stop_to_console (interp, thread))
140 print_stop_event (cli->cli_uiout);
144 /* Observer for the signal_received notification. */
147 cli_on_signal_received (enum gdb_signal siggnal)
149 SWITCH_THRU_ALL_UIS ()
151 struct cli_interp *cli = as_cli_interp (top_level_interpreter ());
156 print_signal_received_reason (cli->cli_uiout, siggnal);
160 /* Observer for the end_stepping_range notification. */
163 cli_on_end_stepping_range (void)
165 SWITCH_THRU_ALL_UIS ()
167 struct cli_interp *cli = as_cli_interp (top_level_interpreter ());
172 print_end_stepping_range_reason (cli->cli_uiout);
176 /* Observer for the signalled notification. */
179 cli_on_signal_exited (enum gdb_signal siggnal)
181 SWITCH_THRU_ALL_UIS ()
183 struct cli_interp *cli = as_cli_interp (top_level_interpreter ());
188 print_signal_exited_reason (cli->cli_uiout, siggnal);
192 /* Observer for the exited notification. */
195 cli_on_exited (int exitstatus)
197 SWITCH_THRU_ALL_UIS ()
199 struct cli_interp *cli = as_cli_interp (top_level_interpreter ());
204 print_exited_reason (cli->cli_uiout, exitstatus);
208 /* Observer for the no_history notification. */
211 cli_on_no_history (void)
213 SWITCH_THRU_ALL_UIS ()
215 struct cli_interp *cli = as_cli_interp (top_level_interpreter ());
220 print_no_history_reason (cli->cli_uiout);
224 /* Observer for the sync_execution_done notification. */
227 cli_on_sync_execution_done (void)
229 struct cli_interp *cli = as_cli_interp (top_level_interpreter ());
234 display_gdb_prompt (NULL);
237 /* Observer for the command_error notification. */
240 cli_on_command_error (void)
242 struct cli_interp *cli = as_cli_interp (top_level_interpreter ());
247 display_gdb_prompt (NULL);
250 /* Observer for the user_selected_context_changed notification. */
253 cli_on_user_selected_context_changed (user_selected_what selection)
255 struct thread_info *tp;
257 /* This event is suppressed. */
258 if (cli_suppress_notification.user_selected_context)
261 tp = find_thread_ptid (inferior_ptid);
263 SWITCH_THRU_ALL_UIS ()
265 struct cli_interp *cli = as_cli_interp (top_level_interpreter ());
270 if (selection & USER_SELECTED_INFERIOR)
271 print_selected_inferior (cli->cli_uiout);
274 && ((selection & (USER_SELECTED_THREAD | USER_SELECTED_FRAME))))
275 print_selected_thread_frame (cli->cli_uiout, selection);
279 /* pre_command_loop implementation. */
282 cli_interp_base::pre_command_loop ()
284 display_gdb_prompt (0);
287 /* These implement the cli out interpreter: */
290 cli_interp::init (bool top_level)
295 cli_interp::resume ()
297 struct ui *ui = current_ui;
298 struct cli_interp *cli = this;
299 struct ui_file *stream;
301 /*sync_execution = 1; */
303 /* gdb_setup_readline will change gdb_stdout. If the CLI was
304 previously writing to gdb_stdout, then set it to the new
305 gdb_stdout afterwards. */
307 stream = cli->cli_uiout->set_stream (gdb_stdout);
308 if (stream != gdb_stdout)
310 cli->cli_uiout->set_stream (stream);
314 gdb_setup_readline (1);
316 ui->input_handler = command_line_handler;
319 cli->cli_uiout->set_stream (gdb_stdout);
323 cli_interp::suspend ()
325 gdb_disable_readline ();
329 cli_interp::exec (const char *command_str)
331 struct cli_interp *cli = this;
332 struct ui_file *old_stream;
333 struct gdb_exception result;
335 /* FIXME: cagney/2003-02-01: Need to const char *propogate
336 safe_execute_command. */
337 char *str = (char *) alloca (strlen (command_str) + 1);
338 strcpy (str, command_str);
340 /* gdb_stdout could change between the time cli_uiout was
341 initialized and now. Since we're probably using a different
342 interpreter which has a new ui_file for gdb_stdout, use that one
343 instead of the default.
345 It is important that it gets reset everytime, since the user
346 could set gdb to use a different interpreter. */
347 old_stream = cli->cli_uiout->set_stream (gdb_stdout);
348 result = safe_execute_command (cli->cli_uiout, str, 1);
349 cli->cli_uiout->set_stream (old_stream);
354 cli_interp_base::supports_command_editing ()
359 static struct gdb_exception
360 safe_execute_command (struct ui_out *command_uiout, char *command, int from_tty)
362 struct gdb_exception e = exception_none;
363 struct ui_out *saved_uiout;
365 /* Save and override the global ``struct ui_out'' builder. */
366 saved_uiout = current_uiout;
367 current_uiout = command_uiout;
371 execute_command (command, from_tty);
373 CATCH (exception, RETURN_MASK_ALL)
379 /* Restore the global builder. */
380 current_uiout = saved_uiout;
382 /* FIXME: cagney/2005-01-13: This shouldn't be needed. Instead the
383 caller should print the exception. */
384 exception_print (gdb_stderr, e);
389 cli_interp::interp_ui_out ()
391 struct cli_interp *cli = (struct cli_interp *) this;
393 return cli->cli_uiout;
396 /* These hold the pushed copies of the gdb output files.
397 If NULL then nothing has yet been pushed. */
398 struct saved_output_files
406 static saved_output_files saved_output;
408 /* See cli-interp.h. */
411 cli_interp_base::set_logging (ui_file_up logfile, bool logging_redirect)
415 saved_output.out = gdb_stdout;
416 saved_output.err = gdb_stderr;
417 saved_output.log = gdb_stdlog;
418 saved_output.targ = gdb_stdtarg;
419 saved_output.targerr = gdb_stdtargerr;
421 /* A raw pointer since ownership is transferred to
423 ui_file *output = make_logging_output (gdb_stdout,
429 gdb_stdtarg = output;
430 gdb_stdtargerr = output;
434 /* Only delete one of the files -- they are all set to the same
438 gdb_stdout = saved_output.out;
439 gdb_stderr = saved_output.err;
440 gdb_stdlog = saved_output.log;
441 gdb_stdtarg = saved_output.targ;
442 gdb_stdtargerr = saved_output.targerr;
444 saved_output.out = NULL;
445 saved_output.err = NULL;
446 saved_output.log = NULL;
447 saved_output.targ = NULL;
448 saved_output.targerr = NULL;
452 /* Factory for CLI interpreters. */
454 static struct interp *
455 cli_interp_factory (const char *name)
457 return new cli_interp (name);
460 /* Standard gdb initialization hook. */
461 extern initialize_file_ftype _initialize_cli_interp; /* -Wmissing-prototypes */
464 _initialize_cli_interp (void)
466 interp_factory_register (INTERP_CONSOLE, cli_interp_factory);
468 /* If changing this, remember to update tui-interp.c as well. */
469 observer_attach_normal_stop (cli_on_normal_stop);
470 observer_attach_end_stepping_range (cli_on_end_stepping_range);
471 observer_attach_signal_received (cli_on_signal_received);
472 observer_attach_signal_exited (cli_on_signal_exited);
473 observer_attach_exited (cli_on_exited);
474 observer_attach_no_history (cli_on_no_history);
475 observer_attach_sync_execution_done (cli_on_sync_execution_done);
476 observer_attach_command_error (cli_on_command_error);
477 observer_attach_user_selected_context_changed
478 (cli_on_user_selected_context_changed);