gdb/tui/tui-interp.c

   1 /* TUI Interpreter definitions for GDB, the GNU debugger.
   2
   3    Copyright 2003 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 2 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, write to the Free Software
  19    Foundation, Inc., 59 Temple Place - Suite 330,
  20    Boston, MA 02111-1307, USA.  */
  21
  22 #include "defs.h"
  23 #include "interps.h"
  24 #include "top.h"
  25 #include "event-top.h"
  26 #include "event-loop.h"
  27 #include "ui-out.h"
  28 #include "tui/tuiData.h"
  29 #include "readline/readline.h"
  30 #include "tui/tuiWin.h"
  31 #include "tui/tui.h"
  32 #include "tui/tuiIO.h"
  33
  34 /* Set to 1 when the TUI mode must be activated when we first start gdb.  */
  35 static int tui_start_enabled = 0;
  36
  37 /* Cleanup the tui before exiting.  */
  38
  39 static void
  40 tui_exit (void)
  41 {
  42   /* Disable the tui.  Curses mode is left leaving the screen
  43      in a clean state (see endwin()).  */
  44   tui_disable ();
  45 }
  46
  47 /* These implement the TUI interpreter.  */
  48
  49 static void *
  50 tui_init (void)
  51 {
  52   /* Install exit handler to leave the screen in a good shape.  */
  53   atexit (tui_exit);
  54
  55   initializeStaticData ();
  56
  57   tui_initialize_io ();
  58   tui_initialize_readline ();
  59
  60   return NULL;
  61 }
  62
  63 static int
  64 tui_resume (void *data)
  65 {
  66   gdb_setup_readline ();
  67   if (tui_start_enabled)
  68     tui_enable ();
  69   return 1;
  70 }
  71
  72 static int
  73 tui_suspend (void *data)
  74 {
  75   tui_start_enabled = tui_active;
  76   tui_disable ();
  77   return 1;
  78 }
  79
  80 /* Display the prompt if we are silent.  */
  81
  82 static int
  83 tui_display_prompt_p (void *data)
  84 {
  85   if (interp_quiet_p (NULL))
  86     return 0;
  87   else
  88     return 1;
  89 }
  90
  91 static int
  92 tui_exec (void *data, const char *command_str)
  93 {
  94   internal_error (__FILE__, __LINE__, "tui_exec called");
  95 }
  96
  97
  98 /* Initialize all the necessary variables, start the event loop,
  99    register readline, and stdin, start the loop.  */
 100
 101 static void
 102 tui_command_loop (void *data)
 103 {
 104   int length;
 105   char *a_prompt;
 106   char *gdb_prompt = get_prompt ();
 107
 108   /* If we are using readline, set things up and display the first
 109      prompt, otherwise just print the prompt.  */
 110   if (async_command_editing_p)
 111     {
 112       /* Tell readline what the prompt to display is and what function
 113          it will need to call after a whole line is read. This also
 114          displays the first prompt.  */
 115       length = strlen (PREFIX (0)) + strlen (gdb_prompt) + strlen (SUFFIX (0)) + 1;
 116       a_prompt = (char *) xmalloc (length);
 117       strcpy (a_prompt, PREFIX (0));
 118       strcat (a_prompt, gdb_prompt);
 119       strcat (a_prompt, SUFFIX (0));
 120       rl_callback_handler_install (a_prompt, input_handler);
 121     }
 122   else
 123     display_gdb_prompt (0);
 124
 125   /* Loop until there is nothing to do. This is the entry point to the
 126      event loop engine. gdb_do_one_event, called via catch_errors()
 127      will process one event for each invocation.  It blocks waits for
 128      an event and then processes it.  >0 when an event is processed, 0
 129      when catch_errors() caught an error and <0 when there are no
 130      longer any event sources registered.  */
 131   while (1)
 132     {
 133       int result = catch_errors (gdb_do_one_event, 0, "", RETURN_MASK_ALL);
 134       if (result < 0)
 135         break;
 136
 137       /* Update gdb output according to TUI mode.  Since catch_errors
 138          preserves the uiout from changing, this must be done at top
 139          level of event loop.  */
 140       if (tui_active)
 141         uiout = tui_out;
 142       else
 143         uiout = tui_old_uiout;
 144
 145       if (result == 0)
 146         {
 147           /* FIXME: this should really be a call to a hook that is
 148              interface specific, because interfaces can display the
 149              prompt in their own way.  */
 150           display_gdb_prompt (0);
 151           /* This call looks bizarre, but it is required.  If the user
 152              entered a command that caused an error,
 153              after_char_processing_hook won't be called from
 154              rl_callback_read_char_wrapper.  Using a cleanup there
 155              won't work, since we want this function to be called
 156              after a new prompt is printed.  */
 157           if (after_char_processing_hook)
 158             (*after_char_processing_hook) ();
 159           /* Maybe better to set a flag to be checked somewhere as to
 160              whether display the prompt or not.  */
 161         }
 162     }
 163
 164   /* We are done with the event loop. There are no more event sources
 165      to listen to.  So we exit GDB.  */
 166   return;
 167 }
 168
 169 void
 170 _initialize_tui_interp (void)
 171 {
 172   static const struct interp_procs procs = {
 173     tui_init,
 174     tui_resume,
 175     tui_suspend,
 176     tui_exec,
 177     tui_display_prompt_p,
 178     tui_command_loop,
 179   };
 180   struct interp *tui_interp;
 181
 182   /* Create a default uiout builder for the TUI. */
 183   tui_out = tui_out_new (gdb_stdout);
 184   interp_add (interp_new ("tui", NULL, tui_out, &procs));
 185   if (interpreter_p && strcmp (interpreter_p, "tui") == 0)
 186     tui_start_enabled = 1;
 187
 188   if (interpreter_p && strcmp (interpreter_p, INTERP_CONSOLE) == 0)
 189     {
 190       xfree (interpreter_p);
 191       interpreter_p = xstrdup ("tui");
 192     }
 193 }