]> git.ipfire.org Git - thirdparty/binutils-gdb.git/blobdiff - gdb/tui/tui.c
GDB copyright headers update after running GDB's copyright.py script.
[thirdparty/binutils-gdb.git] / gdb / tui / tui.c
index 4503be7ed919e5c08df5ebc76dd511aa970a5c85..273a0d9d8ba49d9ef8a39f418e75fe9146811eb7 100644 (file)
@@ -1,7 +1,6 @@
 /* General functions for the WDB TUI.
 
-   Copyright 1998, 1999, 2000, 2001, 2002, 2003, 2004 Free Software
-   Foundation, Inc.
+   Copyright (C) 1998-2016 Free Software Foundation, Inc.
 
    Contributed by Hewlett-Packard Company.
 
@@ -9,7 +8,7 @@
 
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
-   the Free Software Foundation; either version 2 of the License, or
+   the Free Software Foundation; either version 3 of the License, or
    (at your option) any later version.
 
    This program is distributed in the hope that it will be useful,
@@ -18,9 +17,7 @@
    GNU General Public License for more details.
 
    You should have received a copy of the GNU General Public License
-   along with this program; if not, write to the Free Software
-   Foundation, Inc., 59 Temple Place - Suite 330,
-   Boston, MA 02111-1307, USA.  */
+   along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
 
 #include "defs.h"
 #include "gdbcmd.h"
@@ -40,9 +37,8 @@
 #include "inferior.h"
 #include "symtab.h"
 #include "source.h"
+#include "terminal.h"
 
-#include <stdio.h>
-#include <stdlib.h>
 #include <ctype.h>
 #include <signal.h>
 #include <fcntl.h>
@@ -52,6 +48,7 @@
 #include <setjmp.h>
 
 #include "gdb_curses.h"
+#include "interps.h"
 
 /* This redefines CTRL if it is not already defined, so it must come
    after terminal state releated include files like <term.h> and
@@ -67,10 +64,11 @@ enum tui_key_mode tui_current_key_mode = TUI_COMMAND_MODE;
 struct tui_char_command
 {
   unsigned char key;
-  const charcmd;
+  const char *cmd;
 };
 
-/* Key mapping to gdb commands when the TUI is using the single key mode.  */
+/* Key mapping to gdb commands when the TUI is using the single key
+   mode.  */
 static const struct tui_char_command tui_commands[] = {
   { 'c', "continue" },
   { 'd', "down" },
@@ -92,30 +90,48 @@ static Keymap tui_readline_standard_keymap;
 static int
 tui_rl_switch_mode (int notused1, int notused2)
 {
-  if (tui_active)
+
+  /* Don't let exceptions escape.  We're in the middle of a readline
+     callback that isn't prepared for that.  */
+  TRY
     {
-      tui_disable ();
-      rl_prep_terminal (0);
+      if (tui_active)
+       {
+         tui_disable ();
+         rl_prep_terminal (0);
+       }
+      else
+       {
+         /* If tui_enable throws, we'll re-prep below.  */
+         rl_deprep_terminal ();
+         tui_enable ();
+       }
     }
-  else
+  CATCH (ex, RETURN_MASK_ALL)
     {
-      rl_deprep_terminal ();
-      tui_enable ();
+      exception_print (gdb_stderr, ex);
+
+      if (!tui_active)
+       rl_prep_terminal (0);
     }
+  END_CATCH
 
-  /* Clear the readline in case switching occurred in middle of something.  */
+  /* Clear the readline in case switching occurred in middle of
+     something.  */
   if (rl_end)
     rl_kill_text (0, rl_end);
 
   /* Since we left the curses mode, the terminal mode is restored to
      some previous state.  That state may not be suitable for readline
      to work correctly (it may be restored in line mode).  We force an
-     exit of the current readline so that readline is re-entered and it
-     will be able to setup the terminal for its needs.  By re-entering
-     in readline, we also redisplay its prompt in the non-curses mode.  */
+     exit of the current readline so that readline is re-entered and
+     it will be able to setup the terminal for its needs.  By
+     re-entering in readline, we also redisplay its prompt in the
+     non-curses mode.  */
   rl_newline (1, '\n');
 
-  /* Make sure the \n we are returning does not repeat the last command.  */
+  /* Make sure the \n we are returning does not repeat the last
+     command.  */
   dont_repeat ();
   return 0;
 }
@@ -123,23 +139,22 @@ tui_rl_switch_mode (int notused1, int notused2)
 /* TUI readline command.
    Change the TUI layout to show a next layout.
    This function is bound to CTRL-X 2.  It is intended to provide
-   a functionality close to the Emacs split-window command.  We always
-   show two windows (src+asm), (src+regs) or (asm+regs).  */
+   a functionality close to the Emacs split-window command.  We
+   always show two windows (src+asm), (src+regs) or (asm+regs).  */
 static int
 tui_rl_change_windows (int notused1, int notused2)
 {
   if (!tui_active)
-    tui_rl_switch_mode (0/*notused*/, 0/*notused*/);
+    tui_rl_switch_mode (0 /* notused */, 0 /* notused */);
 
   if (tui_active)
     {
       enum tui_layout_type new_layout;
-      enum tui_register_display_type regs_type = TUI_UNDEFINED_REGS;
 
       new_layout = tui_current_layout ();
 
-      /* Select a new layout to have a rolling layout behavior
-        with always two windows (except when undefined).  */
+      /* Select a new layout to have a rolling layout behavior with
+        always two windows (except when undefined).  */
       switch (new_layout)
        {
        case SRC_COMMAND:
@@ -166,7 +181,7 @@ tui_rl_change_windows (int notused1, int notused2)
          new_layout = SRC_COMMAND;
          break;
        }
-      tui_set_layout (new_layout, regs_type);
+      tui_set_layout (new_layout);
     }
   return 0;
 }
@@ -177,12 +192,11 @@ static int
 tui_rl_delete_other_windows (int notused1, int notused2)
 {
   if (!tui_active)
-    tui_rl_switch_mode (0/*notused*/, 0/*notused*/);
+    tui_rl_switch_mode (0 /* notused */, 0 /* notused */);
 
   if (tui_active)
     {
       enum tui_layout_type new_layout;
-      enum tui_register_display_type regs_type = TUI_UNDEFINED_REGS;
 
       new_layout = tui_current_layout ();
 
@@ -201,7 +215,7 @@ tui_rl_delete_other_windows (int notused1, int notused2)
          new_layout = DISASSEM_COMMAND;
          break;
        }
-      tui_set_layout (new_layout, regs_type);
+      tui_set_layout (new_layout);
     }
   return 0;
 }
@@ -211,10 +225,10 @@ tui_rl_delete_other_windows (int notused1, int notused2)
 static int
 tui_rl_other_window (int count, int key)
 {
-  struct tui_win_info * win_info;
+  struct tui_win_info *win_info;
 
   if (!tui_active)
-    tui_rl_switch_mode (0/*notused*/, 0/*notused*/);
+    tui_rl_switch_mode (0 /* notused */, 0 /* notused */);
 
   win_info = tui_next_win (tui_win_with_focus ());
   if (win_info)
@@ -239,11 +253,17 @@ tui_rl_command_key (int count, int key)
     {
       if (tui_commands[i].key == key)
         {
-          /* Must save the command because it can be modified
-             by execute_command.  */
-          char* cmd = alloca (strlen (tui_commands[i].cmd) + 1);
-          strcpy (cmd, tui_commands[i].cmd);
-          execute_command (cmd, TRUE);
+          /* Insert the command in the readline buffer.
+             Avoid calling the gdb command here since it creates
+             a possible recursion on readline if prompt_for_continue
+             is called (See PR 9584).  The command will also appear
+             in the readline history which turns out to be better.  */
+          rl_insert_text (tui_commands[i].cmd);
+          rl_newline (1, '\n');
+
+          /* Switch to gdb command mode while executing the command.
+             This way the gdb's continue prompty will be displayed.  */
+          tui_set_key_mode (TUI_ONE_COMMAND_MODE);
           return 0;
         }
     }
@@ -267,7 +287,7 @@ static int
 tui_rl_next_keymap (int notused1, int notused2)
 {
   if (!tui_active)
-    tui_rl_switch_mode (0/*notused*/, 0/*notused*/);
+    tui_rl_switch_mode (0 /* notused */, 0 /* notused */);
 
   tui_set_key_mode (tui_current_key_mode == TUI_COMMAND_MODE
                     ? TUI_SINGLE_KEY_MODE : TUI_COMMAND_MODE);
@@ -282,13 +302,14 @@ static int
 tui_rl_startup_hook (void)
 {
   rl_already_prompted = 1;
-  if (tui_current_key_mode != TUI_COMMAND_MODE)
+  if (tui_current_key_mode != TUI_COMMAND_MODE && immediate_quit == 0)
     tui_set_key_mode (TUI_SINGLE_KEY_MODE);
   tui_redisplay_readline ();
   return 0;
 }
 
-/* Change the TUI key mode by installing the appropriate readline keymap.  */
+/* Change the TUI key mode by installing the appropriate readline
+   keymap.  */
 void
 tui_set_key_mode (enum tui_key_mode mode)
 {
@@ -354,6 +375,20 @@ tui_initialize_readline (void)
   rl_bind_key_in_map ('s', tui_rl_next_keymap, tui_ctlx_keymap);
 }
 
+/* Return the TERM variable from the environment, or "<unset>"
+   if not set.  */
+
+static const char *
+gdb_getenv_term (void)
+{
+  const char *term;
+
+  term = getenv ("TERM");
+  if (term != NULL)
+    return term;
+  return "<unset>";
+}
+
 /* Enter in the tui mode (curses).
    When in normal mode, it installs the tui hooks in gdb, redirects
    the gdb output, configures the readline to work in tui mode.
@@ -361,6 +396,8 @@ tui_initialize_readline (void)
 void
 tui_enable (void)
 {
+  struct interp *interp;
+
   if (tui_active)
     return;
 
@@ -370,12 +407,52 @@ tui_enable (void)
   if (tui_finish_init)
     {
       WINDOW *w;
+      SCREEN *s;
+      const char *cap;
+      const char *interp;
+
+      /* If the top level interpreter is not the console/tui (e.g.,
+        MI), enabling curses will certainly lose.  */
+      interp = interp_name (top_level_interpreter ());
+      if (strcmp (interp, INTERP_TUI) != 0)
+       error (_("Cannot enable the TUI when the interpreter is '%s'"), interp);
+
+      /* Don't try to setup curses (and print funny control
+        characters) if we're not outputting to a terminal.  */
+      if (!ui_file_isatty (gdb_stdout))
+       error (_("Cannot enable the TUI when output is not a terminal"));
+
+      s = newterm (NULL, stdout, stdin);
+#ifdef __MINGW32__
+      /* The MinGW port of ncurses requires $TERM to be unset in order
+        to activate the Windows console driver.  */
+      if (s == NULL)
+       s = newterm ("unknown", stdout, stdin);
+#endif
+      if (s == NULL)
+       {
+         error (_("Cannot enable the TUI: error opening terminal [TERM=%s]"),
+                gdb_getenv_term ());
+       }
+      w = stdscr;
+
+      /* Check required terminal capabilities.  The MinGW port of
+        ncurses does have them, but doesn't expose them through "cup".  */
+#ifndef __MINGW32__
+      cap = tigetstr ("cup");
+      if (cap == NULL || cap == (char *) -1 || *cap == '\0')
+       {
+         endwin ();
+         delscreen (s);
+         error (_("Cannot enable the TUI: "
+                  "terminal doesn't support cursor addressing [TERM=%s]"),
+                gdb_getenv_term ());
+       }
+#endif
 
-      w = initscr ();
-  
       cbreak ();
       noecho ();
-      /*timeout (1);*/
+      /* timeout (1); */
       nodelay(w, FALSE);
       nl();
       keypad (w, TRUE);
@@ -385,7 +462,7 @@ tui_enable (void)
       def_prog_mode ();
 
       tui_show_frame_info (0);
-      tui_set_layout (SRC_COMMAND, TUI_UNDEFINED_REGS);
+      tui_set_layout (SRC_COMMAND);
       tui_set_win_focus_to (TUI_SRC_WIN);
       keypad (TUI_CMD_WIN->generic.handle, TRUE);
       wrefresh (TUI_CMD_WIN->generic.handle);
@@ -408,15 +485,26 @@ tui_enable (void)
   tui_setup_io (1);
 
   tui_active = 1;
-  if (deprecated_selected_frame)
-     tui_show_frame_info (deprecated_selected_frame);
+
+  /* Resize windows before anything might display/refresh a
+     window.  */
+  if (tui_win_resized ())
+    {
+      tui_set_win_resized_to (FALSE);
+      tui_resize_all ();
+    }
+
+  if (deprecated_safe_get_selected_frame ())
+    tui_show_frame_info (deprecated_safe_get_selected_frame ());
 
   /* Restore TUI keymap.  */
   tui_set_key_mode (tui_current_key_mode);
+
+  /* Refresh the screen.  */
   tui_refresh_all_win ();
 
   /* Update gdb's knowledge of its terminal.  */
-  target_terminal_save_ours ();
+  gdb_save_tty_state ();
   tui_update_gdb_sizes ();
 }
 
@@ -446,14 +534,31 @@ tui_disable (void)
   tui_setup_io (0);
 
   /* Update gdb's knowledge of its terminal.  */
-  target_terminal_save_ours ();
+  gdb_save_tty_state ();
 
   tui_active = 0;
   tui_update_gdb_sizes ();
 }
 
+/* Command wrapper for enabling tui mode.  */
+
+static void
+tui_enable_command (char *args, int from_tty)
+{
+  tui_enable ();
+}
+
+/* Command wrapper for leaving tui mode.  */
+
+static void
+tui_disable_command (char *args, int from_tty)
+{
+  tui_disable ();
+}
+
 void
-strcat_to_buf (char *buf, int buflen, const char *item_to_add)
+strcat_to_buf (char *buf, int buflen, 
+              const char *item_to_add)
 {
   if (item_to_add != (char *) NULL && buf != (char *) NULL)
     {
@@ -465,7 +570,7 @@ strcat_to_buf (char *buf, int buflen, const char *item_to_add)
 }
 
 #if 0
-/* Solaris <sys/termios.h> defines CTRL. */
+/* Solaris <sys/termios.h> defines CTRL.  */
 #ifndef CTRL
 #define CTRL(x)         (x & ~0140)
 #endif
@@ -478,10 +583,8 @@ tui_reset (void)
 {
   struct termio mode;
 
-  /*
-     ** reset the teletype mode bits to a sensible state.
-     ** Copied tset.c
-   */
+  /* Reset the teletype mode bits to a sensible state.
+     Copied tset.c.  */
 #if defined (TIOCGETC)
   struct tchars tbuf;
 #endif /* TIOCGETC */
@@ -507,7 +610,7 @@ tui_reset (void)
   tbuf.t_startc = CHK (tbuf.t_startc, CTRL ('Q'));
   tbuf.t_stopc = CHK (tbuf.t_stopc, CTRL ('S'));
   tbuf.t_eofc = CHK (tbuf.t_eofc, CTRL ('D'));
-  /* brkc is left alone */
+  /* brkc is left alone */
   ioctl (FILEDES, TIOCSETC, &tbuf);
 #endif /* TIOCGETC */
   mode.sg_flags &= ~(RAW
@@ -522,21 +625,22 @@ tui_reset (void)
 #endif
 
 void
-tui_show_source (const char *file, int line)
+tui_show_source (const char *fullname, int line)
 {
   struct symtab_and_line cursal = get_current_source_symtab_and_line ();
-  /* make sure that the source window is displayed */
+
+  /* Make sure that the source window is displayed.  */
   tui_add_win_to_layout (SRC_WIN);
 
   tui_update_source_windows_with_line (cursal.symtab, line);
-  tui_update_locator_filename (file);
+  tui_update_locator_fullname (fullname);
 }
 
 void
-tui_show_assembly (CORE_ADDR addr)
+tui_show_assembly (struct gdbarch *gdbarch, CORE_ADDR addr)
 {
   tui_add_win_to_layout (DISASSEM_WIN);
-  tui_update_source_windows_with_addr (addr);
+  tui_update_source_windows_with_addr (gdbarch, addr);
 }
 
 int
@@ -552,7 +656,8 @@ tui_is_window_visible (enum tui_win_type type)
 }
 
 int
-tui_get_command_dimension (unsigned int *width, unsigned int *height)
+tui_get_command_dimension (unsigned int *width, 
+                          unsigned int *height)
 {
   if (!tui_active || (TUI_CMD_WIN == NULL))
     {
@@ -563,3 +668,21 @@ tui_get_command_dimension (unsigned int *width, unsigned int *height)
   *height = TUI_CMD_WIN->generic.height;
   return 1;
 }
+
+/* Provide a prototype to silence -Wmissing-prototypes.  */
+extern initialize_file_ftype _initialize_tui;
+
+void
+_initialize_tui (void)
+{
+  struct cmd_list_element **tuicmd;
+
+  tuicmd = tui_get_cmd_list ();
+
+  add_cmd ("enable", class_tui, tui_enable_command,
+          _("Enable TUI display mode."),
+          tuicmd);
+  add_cmd ("disable", class_tui, tui_disable_command,
+          _("Disable TUI display mode."),
+          tuicmd);
+}