gdb/tui/tui-interp.c

   1 /* TUI Interpreter definitions for GDB, the GNU debugger.
   2
   3    Copyright (C) 2003, 2007, 2008, 2009, 2010, 2011
   4    Free Software Foundation, Inc.
   5
   6    This file is part of GDB.
   7
   8    This program is free software; you can redistribute it and/or modify
   9    it under the terms of the GNU General Public License as published by
  10    the Free Software Foundation; either version 3 of the License, or
  11    (at your option) any later version.
  12
  13    This program is distributed in the hope that it will be useful,
  14    but WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16    GNU General Public License for more details.
  17
  18    You should have received a copy of the GNU General Public License
  19    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  20
  21 #include "defs.h"
  22 #include "interps.h"
  23 #include "top.h"
  24 #include "event-top.h"
  25 #include "event-loop.h"
  26 #include "ui-out.h"
  27 #include "cli-out.h"
  28 #include "tui/tui-data.h"
  29 #include "readline/readline.h"
  30 #include "tui/tui-win.h"
  31 #include "tui/tui.h"
  32 #include "tui/tui-io.h"
  33 #include "exceptions.h"
  34
  35 /* Set to 1 when the TUI mode must be activated when we first start
  36    gdb.  */
  37 static int tui_start_enabled = 0;
  38
  39 /* Cleanup the tui before exiting.  */
  40
  41 static void
  42 tui_exit (void)
  43 {
  44   /* Disable the tui.  Curses mode is left leaving the screen in a
  45      clean state (see endwin()).  */
  46   tui_disable ();
  47 }
  48
  49 /* True if TUI is the top-level interpreter.  */
  50 static int tui_is_toplevel = 0;
  51
  52 /* These implement the TUI interpreter.  */
  53
  54 static void *
  55 tui_init (struct interp *self, int top_level)
  56 {
  57   tui_is_toplevel = top_level;
  58
  59   /* Install exit handler to leave the screen in a good shape.  */
  60   atexit (tui_exit);
  61
  62   tui_initialize_static_data ();
  63
  64   tui_initialize_io ();
  65   tui_initialize_win ();
  66   if (ui_file_isatty (gdb_stdout))
  67     tui_initialize_readline ();
  68
  69   return NULL;
  70 }
  71
  72 /* True if enabling the TUI is allowed.  Example, if the top level
  73    interpreter is MI, enabling curses will certainly lose.  */
  74
  75 int
  76 tui_allowed_p (void)
  77 {
  78   /* Only if TUI is the top level interpreter.  Also don't try to
  79      setup curses (and print funny control characters) if we're not
  80      outputting to a terminal.  */
  81   return tui_is_toplevel && ui_file_isatty (gdb_stdout);
  82 }
  83
  84 static int
  85 tui_resume (void *data)
  86 {
  87   struct ui_file *stream;
  88
  89   /* gdb_setup_readline will change gdb_stdout.  If the TUI was
  90      previously writing to gdb_stdout, then set it to the new
  91      gdb_stdout afterwards.  */
  92
  93   stream = cli_out_set_stream (tui_old_uiout, gdb_stdout);
  94   if (stream != gdb_stdout)
  95     {
  96       cli_out_set_stream (tui_old_uiout, stream);
  97       stream = NULL;
  98     }
  99
 100   gdb_setup_readline ();
 101
 102   if (stream != NULL)
 103     cli_out_set_stream (tui_old_uiout, gdb_stdout);
 104
 105   if (tui_start_enabled)
 106     tui_enable ();
 107   return 1;
 108 }
 109
 110 static int
 111 tui_suspend (void *data)
 112 {
 113   tui_start_enabled = tui_active;
 114   tui_disable ();
 115   return 1;
 116 }
 117
 118 /* Display the prompt if we are silent.  */
 119
 120 static int
 121 tui_display_prompt_p (void *data)
 122 {
 123   if (interp_quiet_p (NULL))
 124     return 0;
 125   else
 126     return 1;
 127 }
 128
 129 static struct ui_out *
 130 tui_ui_out (struct interp *self)
 131 {
 132   if (tui_active)
 133     return tui_out;
 134   else
 135     return tui_old_uiout;
 136 }
 137
 138 static struct gdb_exception
 139 tui_exec (void *data, const char *command_str)
 140 {
 141   internal_error (__FILE__, __LINE__, _("tui_exec called"));
 142 }
 143
 144 /* Provide a prototype to silence -Wmissing-prototypes.  */
 145 extern initialize_file_ftype _initialize_tui_interp;
 146
 147 void
 148 _initialize_tui_interp (void)
 149 {
 150   static const struct interp_procs procs = {
 151     tui_init,
 152     tui_resume,
 153     tui_suspend,
 154     tui_exec,
 155     tui_display_prompt_p,
 156     tui_ui_out,
 157   };
 158   struct interp *tui_interp;
 159
 160   /* Create a default uiout builder for the TUI.  */
 161   tui_interp = interp_new (INTERP_TUI, &procs);
 162   interp_add (tui_interp);
 163   if (interpreter_p && strcmp (interpreter_p, INTERP_TUI) == 0)
 164     tui_start_enabled = 1;
 165
 166   if (interpreter_p && strcmp (interpreter_p, INTERP_CONSOLE) == 0)
 167     {
 168       xfree (interpreter_p);
 169       interpreter_p = xstrdup (INTERP_TUI);
 170     }
 171 }