gdb/tui/tui-interp.c

   1 /* TUI Interpreter definitions for GDB, the GNU debugger.
   2
   3    Copyright (C) 2003, 2007-2012 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 "exceptions.h"
  33
  34 /* Set to 1 when the TUI mode must be activated when we first start
  35    gdb.  */
  36 static int tui_start_enabled = 0;
  37
  38 /* Cleanup the tui before exiting.  */
  39
  40 static void
  41 tui_exit (void)
  42 {
  43   /* Disable the tui.  Curses mode is left leaving the screen in a
  44      clean state (see endwin()).  */
  45   tui_disable ();
  46 }
  47
  48 /* True if TUI is the top-level interpreter.  */
  49 static int tui_is_toplevel = 0;
  50
  51 /* These implement the TUI interpreter.  */
  52
  53 static void *
  54 tui_init (struct interp *self, int top_level)
  55 {
  56   tui_is_toplevel = top_level;
  57
  58   /* Install exit handler to leave the screen in a good shape.  */
  59   atexit (tui_exit);
  60
  61   tui_initialize_static_data ();
  62
  63   tui_initialize_io ();
  64   tui_initialize_win ();
  65   if (ui_file_isatty (gdb_stdout))
  66     tui_initialize_readline ();
  67
  68   return NULL;
  69 }
  70
  71 /* True if enabling the TUI is allowed.  Example, if the top level
  72    interpreter is MI, enabling curses will certainly lose.  */
  73
  74 int
  75 tui_allowed_p (void)
  76 {
  77   /* Only if TUI is the top level interpreter.  Also don't try to
  78      setup curses (and print funny control characters) if we're not
  79      outputting to a terminal.  */
  80   return tui_is_toplevel && ui_file_isatty (gdb_stdout);
  81 }
  82
  83 static int
  84 tui_resume (void *data)
  85 {
  86   struct ui_file *stream;
  87
  88   /* gdb_setup_readline will change gdb_stdout.  If the TUI was
  89      previously writing to gdb_stdout, then set it to the new
  90      gdb_stdout afterwards.  */
  91
  92   stream = cli_out_set_stream (tui_old_uiout, gdb_stdout);
  93   if (stream != gdb_stdout)
  94     {
  95       cli_out_set_stream (tui_old_uiout, stream);
  96       stream = NULL;
  97     }
  98
  99   gdb_setup_readline ();
 100
 101   if (stream != NULL)
 102     cli_out_set_stream (tui_old_uiout, gdb_stdout);
 103
 104   if (tui_start_enabled)
 105     tui_enable ();
 106   return 1;
 107 }
 108
 109 static int
 110 tui_suspend (void *data)
 111 {
 112   tui_start_enabled = tui_active;
 113   tui_disable ();
 114   return 1;
 115 }
 116
 117 /* Display the prompt if we are silent.  */
 118
 119 static int
 120 tui_display_prompt_p (void *data)
 121 {
 122   if (interp_quiet_p (NULL))
 123     return 0;
 124   else
 125     return 1;
 126 }
 127
 128 static struct ui_out *
 129 tui_ui_out (struct interp *self)
 130 {
 131   if (tui_active)
 132     return tui_out;
 133   else
 134     return tui_old_uiout;
 135 }
 136
 137 static struct gdb_exception
 138 tui_exec (void *data, const char *command_str)
 139 {
 140   internal_error (__FILE__, __LINE__, _("tui_exec called"));
 141 }
 142
 143 /* Provide a prototype to silence -Wmissing-prototypes.  */
 144 extern initialize_file_ftype _initialize_tui_interp;
 145
 146 void
 147 _initialize_tui_interp (void)
 148 {
 149   static const struct interp_procs procs = {
 150     tui_init,
 151     tui_resume,
 152     tui_suspend,
 153     tui_exec,
 154     tui_display_prompt_p,
 155     tui_ui_out,
 156   };
 157   struct interp *tui_interp;
 158
 159   /* Create a default uiout builder for the TUI.  */
 160   tui_interp = interp_new (INTERP_TUI, &procs);
 161   interp_add (tui_interp);
 162   if (interpreter_p && strcmp (interpreter_p, INTERP_TUI) == 0)
 163     tui_start_enabled = 1;
 164
 165   if (interpreter_p && strcmp (interpreter_p, INTERP_CONSOLE) == 0)
 166     {
 167       xfree (interpreter_p);
 168       interpreter_p = xstrdup (INTERP_TUI);
 169     }
 170 }