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