gdb/tui/tui-interp.c

   1 /* TUI Interpreter definitions for GDB, the GNU debugger.
   2
   3    Copyright (C) 2003-2014 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 /* True if TUI is the top-level interpreter.  */
  55 static int tui_is_toplevel = 0;
  56
  57 /* Observers for several run control events.  If the interpreter is
  58    quiet (i.e., another interpreter is being run with
  59    interpreter-exec), print nothing.  */
  60
  61 /* Observer for the signal_received notification.  */
  62
  63 static void
  64 tui_on_signal_received (enum gdb_signal siggnal)
  65 {
  66   if (!interp_quiet_p (tui_interp))
  67     print_signal_received_reason (tui_ui_out (tui_interp), siggnal);
  68 }
  69
  70 /* Observer for the end_stepping_range notification.  */
  71
  72 static void
  73 tui_on_end_stepping_range (void)
  74 {
  75   if (!interp_quiet_p (tui_interp))
  76     print_end_stepping_range_reason (tui_ui_out (tui_interp));
  77 }
  78
  79 /* Observer for the signal_exited notification.  */
  80
  81 static void
  82 tui_on_signal_exited (enum gdb_signal siggnal)
  83 {
  84   if (!interp_quiet_p (tui_interp))
  85     print_signal_exited_reason (tui_ui_out (tui_interp), siggnal);
  86 }
  87
  88 /* Observer for the exited notification.  */
  89
  90 static void
  91 tui_on_exited (int exitstatus)
  92 {
  93   if (!interp_quiet_p (tui_interp))
  94     print_exited_reason (tui_ui_out (tui_interp), exitstatus);
  95 }
  96
  97 /* Observer for the no_history notification.  */
  98
  99 static void
 100 tui_on_no_history (void)
 101 {
 102   if (!interp_quiet_p (tui_interp))
 103     print_no_history_reason (tui_ui_out (tui_interp));
 104 }
 105
 106 /* Observer for the sync_execution_done notification.  */
 107
 108 static void
 109 tui_on_sync_execution_done (void)
 110 {
 111   if (!interp_quiet_p (tui_interp))
 112     display_gdb_prompt (NULL);
 113 }
 114
 115 /* Observer for the command_error notification.  */
 116
 117 static void
 118 tui_on_command_error (void)
 119 {
 120   if (!interp_quiet_p (tui_interp))
 121     display_gdb_prompt (NULL);
 122 }
 123
 124 /* These implement the TUI interpreter.  */
 125
 126 static void *
 127 tui_init (struct interp *self, int top_level)
 128 {
 129   tui_is_toplevel = top_level;
 130
 131   /* Install exit handler to leave the screen in a good shape.  */
 132   atexit (tui_exit);
 133
 134   tui_initialize_static_data ();
 135
 136   tui_initialize_io ();
 137   tui_initialize_win ();
 138   if (ui_file_isatty (gdb_stdout))
 139     tui_initialize_readline ();
 140
 141   /* If changing this, remember to update cli-interp.c as well.  */
 142   observer_attach_signal_received (tui_on_signal_received);
 143   observer_attach_end_stepping_range (tui_on_end_stepping_range);
 144   observer_attach_signal_exited (tui_on_signal_exited);
 145   observer_attach_exited (tui_on_exited);
 146   observer_attach_no_history (tui_on_no_history);
 147   observer_attach_sync_execution_done (tui_on_sync_execution_done);
 148   observer_attach_command_error (tui_on_command_error);
 149
 150   return NULL;
 151 }
 152
 153 /* True if enabling the TUI is allowed.  Example, if the top level
 154    interpreter is MI, enabling curses will certainly lose.  */
 155
 156 int
 157 tui_allowed_p (void)
 158 {
 159   /* Only if TUI is the top level interpreter.  Also don't try to
 160      setup curses (and print funny control characters) if we're not
 161      outputting to a terminal.  */
 162   return tui_is_toplevel && ui_file_isatty (gdb_stdout);
 163 }
 164
 165 static int
 166 tui_resume (void *data)
 167 {
 168   struct ui_file *stream;
 169
 170   /* gdb_setup_readline will change gdb_stdout.  If the TUI was
 171      previously writing to gdb_stdout, then set it to the new
 172      gdb_stdout afterwards.  */
 173
 174   stream = cli_out_set_stream (tui_old_uiout, gdb_stdout);
 175   if (stream != gdb_stdout)
 176     {
 177       cli_out_set_stream (tui_old_uiout, stream);
 178       stream = NULL;
 179     }
 180
 181   gdb_setup_readline ();
 182
 183   if (stream != NULL)
 184     cli_out_set_stream (tui_old_uiout, gdb_stdout);
 185
 186   if (tui_start_enabled)
 187     tui_enable ();
 188   return 1;
 189 }
 190
 191 static int
 192 tui_suspend (void *data)
 193 {
 194   tui_start_enabled = tui_active;
 195   tui_disable ();
 196   return 1;
 197 }
 198
 199 static struct ui_out *
 200 tui_ui_out (struct interp *self)
 201 {
 202   if (tui_active)
 203     return tui_out;
 204   else
 205     return tui_old_uiout;
 206 }
 207
 208 static struct gdb_exception
 209 tui_exec (void *data, const char *command_str)
 210 {
 211   internal_error (__FILE__, __LINE__, _("tui_exec called"));
 212 }
 213
 214 /* Provide a prototype to silence -Wmissing-prototypes.  */
 215 extern initialize_file_ftype _initialize_tui_interp;
 216
 217 void
 218 _initialize_tui_interp (void)
 219 {
 220   static const struct interp_procs procs = {
 221     tui_init,
 222     tui_resume,
 223     tui_suspend,
 224     tui_exec,
 225     tui_ui_out,
 226     NULL,
 227     cli_command_loop
 228   };
 229
 230   /* Create a default uiout builder for the TUI.  */
 231   tui_interp = interp_new (INTERP_TUI, &procs);
 232   interp_add (tui_interp);
 233   if (interpreter_p && strcmp (interpreter_p, INTERP_TUI) == 0)
 234     tui_start_enabled = 1;
 235
 236   if (interpreter_p && strcmp (interpreter_p, INTERP_CONSOLE) == 0)
 237     {
 238       xfree (interpreter_p);
 239       interpreter_p = xstrdup (INTERP_TUI);
 240     }
 241 }