gdb/tui/tui.c

   1 /* General functions for the WDB TUI.
   2
   3    Copyright (C) 1998-2020 Free Software Foundation, Inc.
   4
   5    Contributed by Hewlett-Packard Company.
   6
   7    This file is part of GDB.
   8
   9    This program is free software; you can redistribute it and/or modify
  10    it under the terms of the GNU General Public License as published by
  11    the Free Software Foundation; either version 3 of the License, or
  12    (at your option) any later version.
  13
  14    This program is distributed in the hope that it will be useful,
  15    but WITHOUT ANY WARRANTY; without even the implied warranty of
  16    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17    GNU General Public License for more details.
  18
  19    You should have received a copy of the GNU General Public License
  20    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  21
  22 #include "defs.h"
  23 #include "gdbcmd.h"
  24 #include "tui/tui.h"
  25 #include "tui/tui-hooks.h"
  26 #include "tui/tui-command.h"
  27 #include "tui/tui-data.h"
  28 #include "tui/tui-layout.h"
  29 #include "tui/tui-io.h"
  30 #include "tui/tui-regs.h"
  31 #include "tui/tui-stack.h"
  32 #include "tui/tui-win.h"
  33 #include "tui/tui-wingeneral.h"
  34 #include "tui/tui-winsource.h"
  35 #include "tui/tui-source.h"
  36 #include "target.h"
  37 #include "frame.h"
  38 #include "breakpoint.h"
  39 #include "inferior.h"
  40 #include "symtab.h"
  41 #include "source.h"
  42 #include "terminal.h"
  43 #include "top.h"
  44
  45 #include <ctype.h>
  46 #include <signal.h>
  47 #include <fcntl.h>
  48 #include <setjmp.h>
  49
  50 #include "gdb_curses.h"
  51 #include "interps.h"
  52
  53 /* This redefines CTRL if it is not already defined, so it must come
  54    after terminal state releated include files like <term.h> and
  55    "gdb_curses.h".  */
  56 #include "readline/readline.h"
  57
  58 /* Tells whether the TUI is active or not.  */
  59 bool tui_active = false;
  60 static bool tui_finish_init = true;
  61
  62 enum tui_key_mode tui_current_key_mode = TUI_COMMAND_MODE;
  63
  64 struct tui_char_command
  65 {
  66   unsigned char key;
  67   const char *cmd;
  68 };
  69
  70 /* Key mapping to gdb commands when the TUI is using the single key
  71    mode.  */
  72 static const struct tui_char_command tui_commands[] = {
  73   { 'c', "continue" },
  74   { 'd', "down" },
  75   { 'f', "finish" },
  76   { 'n', "next" },
  77   { 'o', "nexti" },
  78   { 'r', "run" },
  79   { 's', "step" },
  80   { 'i', "stepi" },
  81   { 'u', "up" },
  82   { 'v', "info locals" },
  83   { 'w', "where" },
  84   { 0, 0 },
  85 };
  86
  87 static Keymap tui_keymap;
  88 static Keymap tui_readline_standard_keymap;
  89
  90 /* TUI readline command.
  91    Switch the output mode between TUI/standard gdb.  */
  92 static int
  93 tui_rl_switch_mode (int notused1, int notused2)
  94 {
  95
  96   /* Don't let exceptions escape.  We're in the middle of a readline
  97      callback that isn't prepared for that.  */
  98   try
  99     {
 100       if (tui_active)
 101         {
 102           tui_disable ();
 103           rl_prep_terminal (0);
 104         }
 105       else
 106         {
 107           /* If tui_enable throws, we'll re-prep below.  */
 108           rl_deprep_terminal ();
 109           tui_enable ();
 110         }
 111     }
 112   catch (const gdb_exception &ex)
 113     {
 114       exception_print (gdb_stderr, ex);
 115
 116       if (!tui_active)
 117         rl_prep_terminal (0);
 118     }
 119
 120   /* Clear the readline in case switching occurred in middle of
 121      something.  */
 122   if (rl_end)
 123     rl_kill_text (0, rl_end);
 124
 125   /* Since we left the curses mode, the terminal mode is restored to
 126      some previous state.  That state may not be suitable for readline
 127      to work correctly (it may be restored in line mode).  We force an
 128      exit of the current readline so that readline is re-entered and
 129      it will be able to setup the terminal for its needs.  By
 130      re-entering in readline, we also redisplay its prompt in the
 131      non-curses mode.  */
 132   rl_newline (1, '\n');
 133
 134   /* Make sure the \n we are returning does not repeat the last
 135      command.  */
 136   dont_repeat ();
 137   return 0;
 138 }
 139
 140 /* TUI readline command.
 141    Change the TUI layout to show a next layout.
 142    This function is bound to CTRL-X 2.  It is intended to provide
 143    a functionality close to the Emacs split-window command.  We
 144    always show two windows (src+asm), (src+regs) or (asm+regs).  */
 145 static int
 146 tui_rl_change_windows (int notused1, int notused2)
 147 {
 148   if (!tui_active)
 149     tui_rl_switch_mode (0 /* notused */, 0 /* notused */);
 150
 151   if (tui_active)
 152     {
 153       enum tui_layout_type new_layout;
 154
 155       new_layout = tui_current_layout ();
 156
 157       /* Select a new layout to have a rolling layout behavior with
 158          always two windows (except when undefined).  */
 159       switch (new_layout)
 160         {
 161         case SRC_COMMAND:
 162           new_layout = SRC_DISASSEM_COMMAND;
 163           break;
 164
 165         case DISASSEM_COMMAND:
 166           new_layout = SRC_DISASSEM_COMMAND;
 167           break;
 168
 169         case SRC_DATA_COMMAND:
 170           new_layout = SRC_DISASSEM_COMMAND;
 171           break;
 172
 173         case SRC_DISASSEM_COMMAND:
 174           new_layout = DISASSEM_DATA_COMMAND;
 175           break;
 176
 177         case DISASSEM_DATA_COMMAND:
 178           new_layout = SRC_DATA_COMMAND;
 179           break;
 180
 181         default:
 182           new_layout = SRC_COMMAND;
 183           break;
 184         }
 185       tui_set_layout (new_layout);
 186     }
 187   return 0;
 188 }
 189
 190 /* TUI readline command.
 191    Delete the second TUI window to only show one.  */
 192 static int
 193 tui_rl_delete_other_windows (int notused1, int notused2)
 194 {
 195   if (!tui_active)
 196     tui_rl_switch_mode (0 /* notused */, 0 /* notused */);
 197
 198   if (tui_active)
 199     {
 200       enum tui_layout_type new_layout;
 201
 202       new_layout = tui_current_layout ();
 203
 204       /* Kill one window.  */
 205       switch (new_layout)
 206         {
 207         case SRC_COMMAND:
 208         case SRC_DATA_COMMAND:
 209         case SRC_DISASSEM_COMMAND:
 210         default:
 211           new_layout = SRC_COMMAND;
 212           break;
 213
 214         case DISASSEM_COMMAND:
 215         case DISASSEM_DATA_COMMAND:
 216           new_layout = DISASSEM_COMMAND;
 217           break;
 218         }
 219       tui_set_layout (new_layout);
 220     }
 221   return 0;
 222 }
 223
 224 /* TUI readline command.
 225    Switch the active window to give the focus to a next window.  */
 226 static int
 227 tui_rl_other_window (int count, int key)
 228 {
 229   struct tui_win_info *win_info;
 230
 231   if (!tui_active)
 232     tui_rl_switch_mode (0 /* notused */, 0 /* notused */);
 233
 234   win_info = tui_next_win (tui_win_with_focus ());
 235   if (win_info)
 236     {
 237       tui_set_win_focus_to (win_info);
 238       keypad (TUI_CMD_WIN->handle.get (), win_info != TUI_CMD_WIN);
 239     }
 240   return 0;
 241 }
 242
 243 /* TUI readline command.
 244    Execute the gdb command bound to the specified key.  */
 245 static int
 246 tui_rl_command_key (int count, int key)
 247 {
 248   int i;
 249
 250   reinitialize_more_filter ();
 251   for (i = 0; tui_commands[i].cmd; i++)
 252     {
 253       if (tui_commands[i].key == key)
 254         {
 255           /* Insert the command in the readline buffer.
 256              Avoid calling the gdb command here since it creates
 257              a possible recursion on readline if prompt_for_continue
 258              is called (See PR 9584).  The command will also appear
 259              in the readline history which turns out to be better.  */
 260           rl_insert_text (tui_commands[i].cmd);
 261           rl_newline (1, '\n');
 262
 263           /* Switch to gdb command mode while executing the command.
 264              This way the gdb's continue prompty will be displayed.  */
 265           tui_set_key_mode (TUI_ONE_COMMAND_MODE);
 266           return 0;
 267         }
 268     }
 269   return 0;
 270 }
 271
 272 /* TUI readline command.
 273    Temporarily leave the TUI SingleKey mode to allow editing
 274    a gdb command with the normal readline.  Once the command
 275    is executed, the TUI SingleKey mode is installed back.  */
 276 static int
 277 tui_rl_command_mode (int count, int key)
 278 {
 279   tui_set_key_mode (TUI_ONE_COMMAND_MODE);
 280   return rl_insert (count, key);
 281 }
 282
 283 /* TUI readline command.
 284    Switch between TUI SingleKey mode and gdb readline editing.  */
 285 static int
 286 tui_rl_next_keymap (int notused1, int notused2)
 287 {
 288   if (!tui_active)
 289     tui_rl_switch_mode (0 /* notused */, 0 /* notused */);
 290
 291   tui_set_key_mode (tui_current_key_mode == TUI_COMMAND_MODE
 292                     ? TUI_SINGLE_KEY_MODE : TUI_COMMAND_MODE);
 293   return 0;
 294 }
 295
 296 /* Readline hook to redisplay ourself the gdb prompt.
 297    In the SingleKey mode, the prompt is not printed so that
 298    the command window is cleaner.  It will be displayed if
 299    we temporarily leave the SingleKey mode.  */
 300 static int
 301 tui_rl_startup_hook (void)
 302 {
 303   rl_already_prompted = 1;
 304   if (tui_current_key_mode != TUI_COMMAND_MODE
 305       && !gdb_in_secondary_prompt_p (current_ui))
 306     tui_set_key_mode (TUI_SINGLE_KEY_MODE);
 307   tui_redisplay_readline ();
 308   return 0;
 309 }
 310
 311 /* Change the TUI key mode by installing the appropriate readline
 312    keymap.  */
 313 void
 314 tui_set_key_mode (enum tui_key_mode mode)
 315 {
 316   tui_current_key_mode = mode;
 317   rl_set_keymap (mode == TUI_SINGLE_KEY_MODE
 318                  ? tui_keymap : tui_readline_standard_keymap);
 319   tui_show_locator_content ();
 320 }
 321
 322 /* Initialize readline and configure the keymap for the switching
 323    key shortcut.  */
 324 void
 325 tui_initialize_readline (void)
 326 {
 327   int i;
 328   Keymap tui_ctlx_keymap;
 329
 330   rl_add_defun ("tui-switch-mode", tui_rl_switch_mode, -1);
 331   rl_add_defun ("next-keymap", tui_rl_next_keymap, -1);
 332   rl_add_defun ("tui-delete-other-windows", tui_rl_delete_other_windows, -1);
 333   rl_add_defun ("tui-change-windows", tui_rl_change_windows, -1);
 334   rl_add_defun ("tui-other-window", tui_rl_other_window, -1);
 335
 336   tui_keymap = rl_make_bare_keymap ();
 337
 338   /* The named keymap feature was added in Readline 8.0.  */
 339 #if RL_READLINE_VERSION >= 0x800
 340   rl_set_keymap_name ("SingleKey", tui_keymap);
 341 #endif
 342
 343   tui_ctlx_keymap = rl_make_bare_keymap ();
 344   tui_readline_standard_keymap = rl_get_keymap ();
 345
 346   for (i = 0; tui_commands[i].cmd; i++)
 347     rl_bind_key_in_map (tui_commands[i].key, tui_rl_command_key, tui_keymap);
 348
 349   rl_generic_bind (ISKMAP, "\\C-x", (char*) tui_ctlx_keymap, tui_keymap);
 350
 351   /* Bind all other keys to tui_rl_command_mode so that we switch
 352      temporarily from SingleKey mode and can enter a gdb command.  */
 353   for (i = ' '; i < 0x7f; i++)
 354     {
 355       int j;
 356
 357       for (j = 0; tui_commands[j].cmd; j++)
 358         if (tui_commands[j].key == i)
 359           break;
 360
 361       if (tui_commands[j].cmd)
 362         continue;
 363
 364       rl_bind_key_in_map (i, tui_rl_command_mode, tui_keymap);
 365     }
 366
 367   rl_bind_key_in_map ('a', tui_rl_switch_mode, emacs_ctlx_keymap);
 368   rl_bind_key_in_map ('a', tui_rl_switch_mode, tui_ctlx_keymap);
 369   rl_bind_key_in_map ('A', tui_rl_switch_mode, emacs_ctlx_keymap);
 370   rl_bind_key_in_map ('A', tui_rl_switch_mode, tui_ctlx_keymap);
 371   rl_bind_key_in_map (CTRL ('A'), tui_rl_switch_mode, emacs_ctlx_keymap);
 372   rl_bind_key_in_map (CTRL ('A'), tui_rl_switch_mode, tui_ctlx_keymap);
 373   rl_bind_key_in_map ('1', tui_rl_delete_other_windows, emacs_ctlx_keymap);
 374   rl_bind_key_in_map ('1', tui_rl_delete_other_windows, tui_ctlx_keymap);
 375   rl_bind_key_in_map ('2', tui_rl_change_windows, emacs_ctlx_keymap);
 376   rl_bind_key_in_map ('2', tui_rl_change_windows, tui_ctlx_keymap);
 377   rl_bind_key_in_map ('o', tui_rl_other_window, emacs_ctlx_keymap);
 378   rl_bind_key_in_map ('o', tui_rl_other_window, tui_ctlx_keymap);
 379   rl_bind_key_in_map ('q', tui_rl_next_keymap, tui_keymap);
 380   rl_bind_key_in_map ('s', tui_rl_next_keymap, emacs_ctlx_keymap);
 381   rl_bind_key_in_map ('s', tui_rl_next_keymap, tui_ctlx_keymap);
 382 }
 383
 384 /* Return the TERM variable from the environment, or "<unset>"
 385    if not set.  */
 386
 387 static const char *
 388 gdb_getenv_term (void)
 389 {
 390   const char *term;
 391
 392   term = getenv ("TERM");
 393   if (term != NULL)
 394     return term;
 395   return "<unset>";
 396 }
 397
 398 /* Enter in the tui mode (curses).
 399    When in normal mode, it installs the tui hooks in gdb, redirects
 400    the gdb output, configures the readline to work in tui mode.
 401    When in curses mode, it does nothing.  */
 402 void
 403 tui_enable (void)
 404 {
 405   if (tui_active)
 406     return;
 407
 408   /* To avoid to initialize curses when gdb starts, there is a deferred
 409      curses initialization.  This initialization is made only once
 410      and the first time the curses mode is entered.  */
 411   if (tui_finish_init)
 412     {
 413       WINDOW *w;
 414       SCREEN *s;
 415 #ifndef __MINGW32__
 416        const char *cap;
 417 #endif
 418       const char *interp;
 419
 420       /* If the top level interpreter is not the console/tui (e.g.,
 421          MI), enabling curses will certainly lose.  */
 422       interp = top_level_interpreter ()->name ();
 423       if (strcmp (interp, INTERP_TUI) != 0)
 424         error (_("Cannot enable the TUI when the interpreter is '%s'"), interp);
 425
 426       /* Don't try to setup curses (and print funny control
 427          characters) if we're not outputting to a terminal.  */
 428       if (!ui_file_isatty (gdb_stdout))
 429         error (_("Cannot enable the TUI when output is not a terminal"));
 430
 431       s = newterm (NULL, stdout, stdin);
 432 #ifdef __MINGW32__
 433       /* The MinGW port of ncurses requires $TERM to be unset in order
 434          to activate the Windows console driver.  */
 435       if (s == NULL)
 436         s = newterm ((char *) "unknown", stdout, stdin);
 437 #endif
 438       if (s == NULL)
 439         {
 440           error (_("Cannot enable the TUI: error opening terminal [TERM=%s]"),
 441                  gdb_getenv_term ());
 442         }
 443       w = stdscr;
 444       if (has_colors ())
 445         {
 446 #ifdef HAVE_USE_DEFAULT_COLORS
 447           /* Ncurses extension to help with resetting to the default
 448              color.  */
 449           use_default_colors ();
 450 #endif
 451           start_color ();
 452         }
 453
 454       /* Check required terminal capabilities.  The MinGW port of
 455          ncurses does have them, but doesn't expose them through "cup".  */
 456 #ifndef __MINGW32__
 457       cap = tigetstr ((char *) "cup");
 458       if (cap == NULL || cap == (char *) -1 || *cap == '\0')
 459         {
 460           endwin ();
 461           delscreen (s);
 462           error (_("Cannot enable the TUI: "
 463                    "terminal doesn't support cursor addressing [TERM=%s]"),
 464                  gdb_getenv_term ());
 465         }
 466 #endif
 467
 468       cbreak ();
 469       noecho ();
 470       /* timeout (1); */
 471       nodelay(w, FALSE);
 472       nl();
 473       keypad (w, TRUE);
 474       tui_set_term_height_to (LINES);
 475       tui_set_term_width_to (COLS);
 476       def_prog_mode ();
 477
 478       tui_show_frame_info (0);
 479       tui_set_layout (SRC_COMMAND);
 480       tui_set_win_focus_to (TUI_SRC_WIN);
 481       keypad (TUI_CMD_WIN->handle.get (), TRUE);
 482       wrefresh (TUI_CMD_WIN->handle.get ());
 483       tui_finish_init = false;
 484     }
 485   else
 486     {
 487      /* Save the current gdb setting of the terminal.
 488         Curses will restore this state when endwin() is called.  */
 489      def_shell_mode ();
 490      clearok (stdscr, TRUE);
 491    }
 492
 493   if (tui_update_variables ())
 494     tui_rehighlight_all ();
 495
 496   tui_setup_io (1);
 497
 498   tui_active = true;
 499
 500   /* Resize windows before anything might display/refresh a
 501      window.  */
 502   if (tui_win_resized ())
 503     {
 504       tui_set_win_resized_to (false);
 505       tui_resize_all ();
 506     }
 507
 508   if (deprecated_safe_get_selected_frame ())
 509     tui_show_frame_info (deprecated_safe_get_selected_frame ());
 510   else
 511     tui_display_main ();
 512
 513   /* Install the TUI specific hooks.  This must be done after the call to
 514      tui_display_main so that we don't detect the symtab changed event it
 515      can cause.  */
 516   tui_install_hooks ();
 517   rl_startup_hook = tui_rl_startup_hook;
 518
 519   /* Restore TUI keymap.  */
 520   tui_set_key_mode (tui_current_key_mode);
 521
 522   /* Refresh the screen.  */
 523   tui_refresh_all_win ();
 524
 525   /* Update gdb's knowledge of its terminal.  */
 526   gdb_save_tty_state ();
 527   tui_update_gdb_sizes ();
 528 }
 529
 530 /* Leave the tui mode.
 531    Remove the tui hooks and configure the gdb output and readline
 532    back to their original state.  The curses mode is left so that
 533    the terminal setting is restored to the point when we entered.  */
 534 void
 535 tui_disable (void)
 536 {
 537   if (!tui_active)
 538     return;
 539
 540   /* Restore initial readline keymap.  */
 541   rl_set_keymap (tui_readline_standard_keymap);
 542
 543   /* Remove TUI hooks.  */
 544   tui_remove_hooks ();
 545   rl_startup_hook = 0;
 546   rl_already_prompted = 0;
 547
 548   /* Leave curses and restore previous gdb terminal setting.  */
 549   endwin ();
 550
 551   /* gdb terminal has changed, update gdb internal copy of it
 552      so that terminal management with the inferior works.  */
 553   tui_setup_io (0);
 554
 555   /* Update gdb's knowledge of its terminal.  */
 556   gdb_save_tty_state ();
 557
 558   tui_active = false;
 559   tui_update_gdb_sizes ();
 560 }
 561
 562 /* Command wrapper for enabling tui mode.  */
 563
 564 static void
 565 tui_enable_command (const char *args, int from_tty)
 566 {
 567   tui_enable ();
 568 }
 569
 570 /* Command wrapper for leaving tui mode.  */
 571
 572 static void
 573 tui_disable_command (const char *args, int from_tty)
 574 {
 575   tui_disable ();
 576 }
 577
 578 void
 579 tui_show_assembly (struct gdbarch *gdbarch, CORE_ADDR addr)
 580 {
 581   tui_suppress_output suppress;
 582   tui_add_win_to_layout (DISASSEM_WIN);
 583   tui_update_source_windows_with_addr (gdbarch, addr);
 584 }
 585
 586 bool
 587 tui_is_window_visible (enum tui_win_type type)
 588 {
 589   if (!tui_active)
 590     return false;
 591
 592   if (tui_win_list[type] == 0)
 593     return false;
 594
 595   return tui_win_list[type]->is_visible ();
 596 }
 597
 598 bool
 599 tui_get_command_dimension (unsigned int *width,
 600                            unsigned int *height)
 601 {
 602   if (!tui_active || (TUI_CMD_WIN == NULL))
 603     return false;
 604
 605   *width = TUI_CMD_WIN->width;
 606   *height = TUI_CMD_WIN->height;
 607   return true;
 608 }
 609
 610 void _initialize_tui ();
 611 void
 612 _initialize_tui ()
 613 {
 614   struct cmd_list_element **tuicmd;
 615
 616   tuicmd = tui_get_cmd_list ();
 617
 618   add_cmd ("enable", class_tui, tui_enable_command,
 619            _("Enable TUI display mode."),
 620            tuicmd);
 621   add_cmd ("disable", class_tui, tui_disable_command,
 622            _("Disable TUI display mode."),
 623            tuicmd);
 624 }