gdb/tui/tui-interp.c

   1 /* TUI Interpreter definitions for GDB, the GNU debugger.
   2
   3    Copyright (C) 2003-2016 Free Software Foundation, Inc.
   4
   5    This file is part of GDB.
   6
   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.
  11
  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.
  16
  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/>.  */
  19
  20 #include "defs.h"
  21 #include "interps.h"
  22 #include "top.h"
  23 #include "event-top.h"
  24 #include "event-loop.h"
  25 #include "ui-out.h"
  26 #include "cli-out.h"
  27 #include "tui/tui-data.h"
  28 #include "readline/readline.h"
  29 #include "tui/tui-win.h"
  30 #include "tui/tui.h"
  31 #include "tui/tui-io.h"
  32 #include "infrun.h"
  33 #include "observer.h"
  34
  35 static struct ui_out *tui_ui_out (struct interp *self);
  36
  37 /* Set to 1 when the TUI mode must be activated when we first start
  38    gdb.  */
  39 static int tui_start_enabled = 0;
  40
  41 /* The TUI interpreter.  */
  42 static struct interp *tui_interp;
  43
  44 /* Cleanup the tui before exiting.  */
  45
  46 static void
  47 tui_exit (void)
  48 {
  49   /* Disable the tui.  Curses mode is left leaving the screen in a
  50      clean state (see endwin()).  */
  51   tui_disable ();
  52 }
  53
  54 /* Observers for several run control events.  If the interpreter is
  55    quiet (i.e., another interpreter is being run with
  56    interpreter-exec), print nothing.  */
  57
  58 /* Observer for the normal_stop notification.  */
  59
  60 static void
  61 tui_on_normal_stop (struct bpstats *bs, int print_frame)
  62 {
  63   if (!interp_quiet_p (tui_interp))
  64     {
  65       if (print_frame)
  66         print_stop_event (tui_ui_out (tui_interp));
  67     }
  68 }
  69
  70 /* Observer for the signal_received notification.  */
  71
  72 static void
  73 tui_on_signal_received (enum gdb_signal siggnal)
  74 {
  75   if (!interp_quiet_p (tui_interp))
  76     print_signal_received_reason (tui_ui_out (tui_interp), siggnal);
  77 }
  78
  79 /* Observer for the end_stepping_range notification.  */
  80
  81 static void
  82 tui_on_end_stepping_range (void)
  83 {
  84   if (!interp_quiet_p (tui_interp))
  85     print_end_stepping_range_reason (tui_ui_out (tui_interp));
  86 }
  87
  88 /* Observer for the signal_exited notification.  */
  89
  90 static void
  91 tui_on_signal_exited (enum gdb_signal siggnal)
  92 {
  93   if (!interp_quiet_p (tui_interp))
  94     print_signal_exited_reason (tui_ui_out (tui_interp), siggnal);
  95 }
  96
  97 /* Observer for the exited notification.  */
  98
  99 static void
 100 tui_on_exited (int exitstatus)
 101 {
 102   if (!interp_quiet_p (tui_interp))
 103     print_exited_reason (tui_ui_out (tui_interp), exitstatus);
 104 }
 105
 106 /* Observer for the no_history notification.  */
 107
 108 static void
 109 tui_on_no_history (void)
 110 {
 111   if (!interp_quiet_p (tui_interp))
 112     print_no_history_reason (tui_ui_out (tui_interp));
 113 }
 114
 115 /* Observer for the sync_execution_done notification.  */
 116
 117 static void
 118 tui_on_sync_execution_done (void)
 119 {
 120   if (!interp_quiet_p (tui_interp))
 121     display_gdb_prompt (NULL);
 122 }
 123
 124 /* Observer for the command_error notification.  */
 125
 126 static void
 127 tui_on_command_error (void)
 128 {
 129   if (!interp_quiet_p (tui_interp))
 130     display_gdb_prompt (NULL);
 131 }
 132
 133 /* These implement the TUI interpreter.  */
 134
 135 static void *
 136 tui_init (struct interp *self, int top_level)
 137 {
 138   /* Install exit handler to leave the screen in a good shape.  */
 139   atexit (tui_exit);
 140
 141   if (top_level)
 142     tui_interp = self;
 143
 144   tui_initialize_static_data ();
 145
 146   tui_initialize_io ();
 147   tui_initialize_win ();
 148   if (ui_file_isatty (gdb_stdout))
 149     tui_initialize_readline ();
 150
 151   /* If changing this, remember to update cli-interp.c as well.  */
 152   observer_attach_normal_stop (tui_on_normal_stop);
 153   observer_attach_signal_received (tui_on_signal_received);
 154   observer_attach_end_stepping_range (tui_on_end_stepping_range);
 155   observer_attach_signal_exited (tui_on_signal_exited);
 156   observer_attach_exited (tui_on_exited);
 157   observer_attach_no_history (tui_on_no_history);
 158   observer_attach_sync_execution_done (tui_on_sync_execution_done);
 159   observer_attach_command_error (tui_on_command_error);
 160
 161   return NULL;
 162 }
 163
 164 static int
 165 tui_resume (void *data)
 166 {
 167   struct ui_file *stream;
 168
 169   /* gdb_setup_readline will change gdb_stdout.  If the TUI was
 170      previously writing to gdb_stdout, then set it to the new
 171      gdb_stdout afterwards.  */
 172
 173   stream = cli_out_set_stream (tui_old_uiout, gdb_stdout);
 174   if (stream != gdb_stdout)
 175     {
 176       cli_out_set_stream (tui_old_uiout, stream);
 177       stream = NULL;
 178     }
 179
 180   gdb_setup_readline ();
 181
 182   if (stream != NULL)
 183     cli_out_set_stream (tui_old_uiout, gdb_stdout);
 184
 185   if (tui_start_enabled)
 186     tui_enable ();
 187   return 1;
 188 }
 189
 190 static int
 191 tui_suspend (void *data)
 192 {
 193   tui_start_enabled = tui_active;
 194   tui_disable ();
 195   return 1;
 196 }
 197
 198 static struct ui_out *
 199 tui_ui_out (struct interp *self)
 200 {
 201   if (tui_active)
 202     return tui_out;
 203   else
 204     return tui_old_uiout;
 205 }
 206
 207 static struct gdb_exception
 208 tui_exec (void *data, const char *command_str)
 209 {
 210   internal_error (__FILE__, __LINE__, _("tui_exec called"));
 211 }
 212
 213 /* The TUI interpreter's vtable.  */
 214
 215 static const struct interp_procs tui_interp_procs = {
 216   tui_init,
 217   tui_resume,
 218   tui_suspend,
 219   tui_exec,
 220   tui_ui_out,
 221   NULL,
 222   cli_command_loop
 223 };
 224
 225 /* Factory for TUI interpreters.  */
 226
 227 static struct interp *
 228 tui_interp_factory (const char *name)
 229 {
 230   return interp_new (name, &tui_interp_procs, NULL);
 231 }
 232
 233 /* Provide a prototype to silence -Wmissing-prototypes.  */
 234 extern initialize_file_ftype _initialize_tui_interp;
 235
 236 void
 237 _initialize_tui_interp (void)
 238 {
 239   interp_factory_register (INTERP_TUI, tui_interp_factory);
 240
 241   if (interpreter_p && strcmp (interpreter_p, INTERP_TUI) == 0)
 242     tui_start_enabled = 1;
 243
 244   if (interpreter_p && strcmp (interpreter_p, INTERP_CONSOLE) == 0)
 245     {
 246       xfree (interpreter_p);
 247       interpreter_p = xstrdup (INTERP_TUI);
 248     }
 249 }