gdb/tui/tui.c

   1 /* General functions for the WDB TUI.
   2
   3    Copyright (C) 1998-2019 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-winsource.h"
  34 #include "tui/tui-source.h"
  35 #include "target.h"
  36 #include "frame.h"
  37 #include "breakpoint.h"
  38 #include "inferior.h"
  39 #include "symtab.h"
  40 #include "source.h"
  41 #include "terminal.h"
  42 #include "top.h"
  43
  44 #include <ctype.h>
  45 #include <signal.h>
  46 #include <fcntl.h>
  47 #if 0
  48 #include <termio.h>
  49 #endif
  50 #include <setjmp.h>
  51
  52 #include "gdb_curses.h"
  53 #include "interps.h"
  54
  55 /* This redefines CTRL if it is not already defined, so it must come
  56    after terminal state releated include files like <term.h> and
  57    "gdb_curses.h".  */
  58 #include "readline/readline.h"
  59
  60 /* Tells whether the TUI is active or not.  */
  61 int tui_active = 0;
  62 static int tui_finish_init = 1;
  63
  64 enum tui_key_mode tui_current_key_mode = TUI_COMMAND_MODE;
  65
  66 struct tui_char_command
  67 {
  68   unsigned char key;
  69   const char *cmd;
  70 };
  71
  72 /* Key mapping to gdb commands when the TUI is using the single key
  73    mode.  */
  74 static const struct tui_char_command tui_commands[] = {
  75   { 'c', "continue" },
  76   { 'd', "down" },
  77   { 'f', "finish" },
  78   { 'n', "next" },
  79   { 'o', "nexti" },
  80   { 'r', "run" },
  81   { 's', "step" },
  82   { 'i', "stepi" },
  83   { 'u', "up" },
  84   { 'v', "info locals" },
  85   { 'w', "where" },
  86   { 0, 0 },
  87 };
  88
  89 static Keymap tui_keymap;
  90 static Keymap tui_readline_standard_keymap;
  91
  92 /* TUI readline command.
  93    Switch the output mode between TUI/standard gdb.  */
  94 static int
  95 tui_rl_switch_mode (int notused1, int notused2)
  96 {
  97
  98   /* Don't let exceptions escape.  We're in the middle of a readline
  99      callback that isn't prepared for that.  */
 100   try
 101     {
 102       if (tui_active)
 103         {
 104           tui_disable ();
 105           rl_prep_terminal (0);
 106         }
 107       else
 108         {
 109           /* If tui_enable throws, we'll re-prep below.  */
 110           rl_deprep_terminal ();
 111           tui_enable ();
 112         }
 113     }
 114   catch (const gdb_exception &ex)
 115     {
 116       exception_print (gdb_stderr, ex);
 117
 118       if (!tui_active)
 119         rl_prep_terminal (0);
 120     }
 121
 122   /* Clear the readline in case switching occurred in middle of
 123      something.  */
 124   if (rl_end)
 125     rl_kill_text (0, rl_end);
 126
 127   /* Since we left the curses mode, the terminal mode is restored to
 128      some previous state.  That state may not be suitable for readline
 129      to work correctly (it may be restored in line mode).  We force an
 130      exit of the current readline so that readline is re-entered and
 131      it will be able to setup the terminal for its needs.  By
 132      re-entering in readline, we also redisplay its prompt in the
 133      non-curses mode.  */
 134   rl_newline (1, '\n');
 135
 136   /* Make sure the \n we are returning does not repeat the last
 137      command.  */
 138   dont_repeat ();
 139   return 0;
 140 }
 141
 142 /* TUI readline command.
 143    Change the TUI layout to show a next layout.
 144    This function is bound to CTRL-X 2.  It is intended to provide
 145    a functionality close to the Emacs split-window command.  We
 146    always show two windows (src+asm), (src+regs) or (asm+regs).  */
 147 static int
 148 tui_rl_change_windows (int notused1, int notused2)
 149 {
 150   if (!tui_active)
 151     tui_rl_switch_mode (0 /* notused */, 0 /* notused */);
 152
 153   if (tui_active)
 154     {
 155       enum tui_layout_type new_layout;
 156
 157       new_layout = tui_current_layout ();
 158
 159       /* Select a new layout to have a rolling layout behavior with
 160          always two windows (except when undefined).  */
 161       switch (new_layout)
 162         {
 163         case SRC_COMMAND:
 164           new_layout = SRC_DISASSEM_COMMAND;
 165           break;
 166
 167         case DISASSEM_COMMAND:
 168           new_layout = SRC_DISASSEM_COMMAND;
 169           break;
 170
 171         case SRC_DATA_COMMAND:
 172           new_layout = SRC_DISASSEM_COMMAND;
 173           break;
 174
 175         case SRC_DISASSEM_COMMAND:
 176           new_layout = DISASSEM_DATA_COMMAND;
 177           break;
 178
 179         case DISASSEM_DATA_COMMAND:
 180           new_layout = SRC_DATA_COMMAND;
 181           break;
 182
 183         default:
 184           new_layout = SRC_COMMAND;
 185           break;
 186         }
 187       tui_set_layout (new_layout);
 188     }
 189   return 0;
 190 }
 191
 192 /* TUI readline command.
 193    Delete the second TUI window to only show one.  */
 194 static int
 195 tui_rl_delete_other_windows (int notused1, int notused2)
 196 {
 197   if (!tui_active)
 198     tui_rl_switch_mode (0 /* notused */, 0 /* notused */);
 199
 200   if (tui_active)
 201     {
 202       enum tui_layout_type new_layout;
 203
 204       new_layout = tui_current_layout ();
 205
 206       /* Kill one window.  */
 207       switch (new_layout)
 208         {
 209         case SRC_COMMAND:
 210         case SRC_DATA_COMMAND:
 211         case SRC_DISASSEM_COMMAND:
 212         default:
 213           new_layout = SRC_COMMAND;
 214           break;
 215
 216         case DISASSEM_COMMAND:
 217         case DISASSEM_DATA_COMMAND:
 218           new_layout = DISASSEM_COMMAND;
 219           break;
 220         }
 221       tui_set_layout (new_layout);
 222     }
 223   return 0;
 224 }
 225
 226 /* TUI readline command.
 227    Switch the active window to give the focus to a next window.  */
 228 static int
 229 tui_rl_other_window (int count, int key)
 230 {
 231   struct tui_win_info *win_info;
 232
 233   if (!tui_active)
 234     tui_rl_switch_mode (0 /* notused */, 0 /* notused */);
 235
 236   win_info = tui_next_win (tui_win_with_focus ());
 237   if (win_info)
 238     {
 239       tui_set_win_focus_to (win_info);
 240       keypad (TUI_CMD_WIN->handle.get (), win_info != TUI_CMD_WIN);
 241     }
 242   return 0;
 243 }
 244
 245 /* TUI readline command.
 246    Execute the gdb command bound to the specified key.  */
 247 static int
 248 tui_rl_command_key (int count, int key)
 249 {
 250   int i;
 251
 252   reinitialize_more_filter ();
 253   for (i = 0; tui_commands[i].cmd; i++)
 254     {
 255       if (tui_commands[i].key == key)
 256         {
 257           /* Insert the command in the readline buffer.
 258              Avoid calling the gdb command here since it creates
 259              a possible recursion on readline if prompt_for_continue
 260              is called (See PR 9584).  The command will also appear
 261              in the readline history which turns out to be better.  */
 262           rl_insert_text (tui_commands[i].cmd);
 263           rl_newline (1, '\n');
 264
 265           /* Switch to gdb command mode while executing the command.
 266              This way the gdb's continue prompty will be displayed.  */
 267           tui_set_key_mode (TUI_ONE_COMMAND_MODE);
 268           return 0;
 269         }
 270     }
 271   return 0;
 272 }
 273
 274 /* TUI readline command.
 275    Temporarily leave the TUI SingleKey mode to allow editing
 276    a gdb command with the normal readline.  Once the command
 277    is executed, the TUI SingleKey mode is installed back.  */
 278 static int
 279 tui_rl_command_mode (int count, int key)
 280 {
 281   tui_set_key_mode (TUI_ONE_COMMAND_MODE);
 282   return rl_insert (count, key);
 283 }
 284
 285 /* TUI readline command.
 286    Switch between TUI SingleKey mode and gdb readline editing.  */
 287 static int
 288 tui_rl_next_keymap (int notused1, int notused2)
 289 {
 290   if (!tui_active)
 291     tui_rl_switch_mode (0 /* notused */, 0 /* notused */);
 292
 293   tui_set_key_mode (tui_current_key_mode == TUI_COMMAND_MODE
 294                     ? TUI_SINGLE_KEY_MODE : TUI_COMMAND_MODE);
 295   return 0;
 296 }
 297
 298 /* Readline hook to redisplay ourself the gdb prompt.
 299    In the SingleKey mode, the prompt is not printed so that
 300    the command window is cleaner.  It will be displayed if
 301    we temporarily leave the SingleKey mode.  */
 302 static int
 303 tui_rl_startup_hook (void)
 304 {
 305   rl_already_prompted = 1;
 306   if (tui_current_key_mode != TUI_COMMAND_MODE
 307       && !gdb_in_secondary_prompt_p (current_ui))
 308     tui_set_key_mode (TUI_SINGLE_KEY_MODE);
 309   tui_redisplay_readline ();
 310   return 0;
 311 }
 312
 313 /* Change the TUI key mode by installing the appropriate readline
 314    keymap.  */
 315 void
 316 tui_set_key_mode (enum tui_key_mode mode)
 317 {
 318   tui_current_key_mode = mode;
 319   rl_set_keymap (mode == TUI_SINGLE_KEY_MODE
 320                  ? tui_keymap : tui_readline_standard_keymap);
 321   tui_show_locator_content ();
 322 }
 323
 324 /* Initialize readline and configure the keymap for the switching
 325    key shortcut.  */
 326 void
 327 tui_initialize_readline (void)
 328 {
 329   int i;
 330   Keymap tui_ctlx_keymap;
 331
 332   rl_add_defun ("tui-switch-mode", tui_rl_switch_mode, -1);
 333   rl_add_defun ("gdb-command", tui_rl_command_key, -1);
 334   rl_add_defun ("next-keymap", tui_rl_next_keymap, -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 = 0;
 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   /* Install the TUI specific hooks.  */
 494   tui_install_hooks ();
 495   rl_startup_hook = tui_rl_startup_hook;
 496
 497   tui_update_variables ();
 498
 499   tui_setup_io (1);
 500
 501   tui_active = 1;
 502
 503   /* Resize windows before anything might display/refresh a
 504      window.  */
 505   if (tui_win_resized ())
 506     {
 507       tui_set_win_resized_to (false);
 508       tui_resize_all ();
 509     }
 510
 511   if (deprecated_safe_get_selected_frame ())
 512     tui_show_frame_info (deprecated_safe_get_selected_frame ());
 513
 514   /* Restore TUI keymap.  */
 515   tui_set_key_mode (tui_current_key_mode);
 516
 517   /* Refresh the screen.  */
 518   tui_refresh_all_win ();
 519
 520   /* Update gdb's knowledge of its terminal.  */
 521   gdb_save_tty_state ();
 522   tui_update_gdb_sizes ();
 523 }
 524
 525 /* Leave the tui mode.
 526    Remove the tui hooks and configure the gdb output and readline
 527    back to their original state.  The curses mode is left so that
 528    the terminal setting is restored to the point when we entered.  */
 529 void
 530 tui_disable (void)
 531 {
 532   if (!tui_active)
 533     return;
 534
 535   /* Restore initial readline keymap.  */
 536   rl_set_keymap (tui_readline_standard_keymap);
 537
 538   /* Remove TUI hooks.  */
 539   tui_remove_hooks ();
 540   rl_startup_hook = 0;
 541   rl_already_prompted = 0;
 542
 543   /* Leave curses and restore previous gdb terminal setting.  */
 544   endwin ();
 545
 546   /* gdb terminal has changed, update gdb internal copy of it
 547      so that terminal management with the inferior works.  */
 548   tui_setup_io (0);
 549
 550   /* Update gdb's knowledge of its terminal.  */
 551   gdb_save_tty_state ();
 552
 553   tui_active = 0;
 554   tui_update_gdb_sizes ();
 555 }
 556
 557 /* Command wrapper for enabling tui mode.  */
 558
 559 static void
 560 tui_enable_command (const char *args, int from_tty)
 561 {
 562   tui_enable ();
 563 }
 564
 565 /* Command wrapper for leaving tui mode.  */
 566
 567 static void
 568 tui_disable_command (const char *args, int from_tty)
 569 {
 570   tui_disable ();
 571 }
 572
 573 #if 0
 574 /* Solaris <sys/termios.h> defines CTRL.  */
 575 #ifndef CTRL
 576 #define CTRL(x)         (x & ~0140)
 577 #endif
 578
 579 #define FILEDES         2
 580 #define CHK(val, dft)   (val<=0 ? dft : val)
 581
 582 static void
 583 tui_reset (void)
 584 {
 585   struct termio mode;
 586
 587   /* Reset the teletype mode bits to a sensible state.
 588      Copied tset.c.  */
 589 #if defined (TIOCGETC)
 590   struct tchars tbuf;
 591 #endif /* TIOCGETC */
 592 #ifdef UCB_NTTY
 593   struct ltchars ltc;
 594
 595   if (ldisc == NTTYDISC)
 596     {
 597       ioctl (FILEDES, TIOCGLTC, &ltc);
 598       ltc.t_suspc = CHK (ltc.t_suspc, CTRL ('Z'));
 599       ltc.t_dsuspc = CHK (ltc.t_dsuspc, CTRL ('Y'));
 600       ltc.t_rprntc = CHK (ltc.t_rprntc, CTRL ('R'));
 601       ltc.t_flushc = CHK (ltc.t_flushc, CTRL ('O'));
 602       ltc.t_werasc = CHK (ltc.t_werasc, CTRL ('W'));
 603       ltc.t_lnextc = CHK (ltc.t_lnextc, CTRL ('V'));
 604       ioctl (FILEDES, TIOCSLTC, &ltc);
 605     }
 606 #endif /* UCB_NTTY */
 607 #ifdef TIOCGETC
 608   ioctl (FILEDES, TIOCGETC, &tbuf);
 609   tbuf.t_intrc = CHK (tbuf.t_intrc, CTRL ('?'));
 610   tbuf.t_quitc = CHK (tbuf.t_quitc, CTRL ('\\'));
 611   tbuf.t_startc = CHK (tbuf.t_startc, CTRL ('Q'));
 612   tbuf.t_stopc = CHK (tbuf.t_stopc, CTRL ('S'));
 613   tbuf.t_eofc = CHK (tbuf.t_eofc, CTRL ('D'));
 614   /* brkc is left alone.  */
 615   ioctl (FILEDES, TIOCSETC, &tbuf);
 616 #endif /* TIOCGETC */
 617   mode.sg_flags &= ~(RAW
 618 #ifdef CBREAK
 619                      | CBREAK
 620 #endif /* CBREAK */
 621                      | VTDELAY | ALLDELAY);
 622   mode.sg_flags |= XTABS | ECHO | CRMOD | ANYP;
 623 }
 624 #endif
 625
 626 void
 627 tui_show_source (const char *fullname, int line)
 628 {
 629   struct symtab_and_line cursal = get_current_source_symtab_and_line ();
 630
 631   /* Make sure that the source window is displayed.  */
 632   tui_add_win_to_layout (SRC_WIN);
 633
 634   tui_update_source_windows_with_line (cursal.symtab, line);
 635   tui_update_locator_fullname (fullname);
 636 }
 637
 638 void
 639 tui_show_assembly (struct gdbarch *gdbarch, CORE_ADDR addr)
 640 {
 641   tui_add_win_to_layout (DISASSEM_WIN);
 642   tui_update_source_windows_with_addr (gdbarch, addr);
 643 }
 644
 645 bool
 646 tui_is_window_visible (enum tui_win_type type)
 647 {
 648   if (tui_active == 0)
 649     return false;
 650
 651   if (tui_win_list[type] == 0)
 652     return false;
 653
 654   return tui_win_list[type]->is_visible ();
 655 }
 656
 657 int
 658 tui_get_command_dimension (unsigned int *width,
 659                            unsigned int *height)
 660 {
 661   if (!tui_active || (TUI_CMD_WIN == NULL))
 662     {
 663       return 0;
 664     }
 665
 666   *width = TUI_CMD_WIN->width;
 667   *height = TUI_CMD_WIN->height;
 668   return 1;
 669 }
 670
 671 void
 672 _initialize_tui (void)
 673 {
 674   struct cmd_list_element **tuicmd;
 675
 676   tuicmd = tui_get_cmd_list ();
 677
 678   add_cmd ("enable", class_tui, tui_enable_command,
 679            _("Enable TUI display mode."),
 680            tuicmd);
 681   add_cmd ("disable", class_tui, tui_disable_command,
 682            _("Disable TUI display mode."),
 683            tuicmd);
 684 }