gdb/tui/tui.c

   1 /* General functions for the WDB TUI.
   2
   3    Copyright (C) 1998-2018 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-data.h"
  27 #include "tui/tui-layout.h"
  28 #include "tui/tui-io.h"
  29 #include "tui/tui-regs.h"
  30 #include "tui/tui-stack.h"
  31 #include "tui/tui-win.h"
  32 #include "tui/tui-winsource.h"
  33 #include "tui/tui-windata.h"
  34 #include "target.h"
  35 #include "frame.h"
  36 #include "breakpoint.h"
  37 #include "inferior.h"
  38 #include "symtab.h"
  39 #include "source.h"
  40 #include "terminal.h"
  41 #include "top.h"
  42
  43 #include <ctype.h>
  44 #include <signal.h>
  45 #include <fcntl.h>
  46 #if 0
  47 #include <termio.h>
  48 #endif
  49 #include <setjmp.h>
  50
  51 #include "gdb_curses.h"
  52 #include "interps.h"
  53
  54 /* This redefines CTRL if it is not already defined, so it must come
  55    after terminal state releated include files like <term.h> and
  56    "gdb_curses.h".  */
  57 #include "readline/readline.h"
  58
  59 /* Tells whether the TUI is active or not.  */
  60 int tui_active = 0;
  61 static int tui_finish_init = 1;
  62
  63 enum tui_key_mode tui_current_key_mode = TUI_COMMAND_MODE;
  64
  65 struct tui_char_command
  66 {
  67   unsigned char key;
  68   const char *cmd;
  69 };
  70
  71 /* Key mapping to gdb commands when the TUI is using the single key
  72    mode.  */
  73 static const struct tui_char_command tui_commands[] = {
  74   { 'c', "continue" },
  75   { 'd', "down" },
  76   { 'f', "finish" },
  77   { 'n', "next" },
  78   { 'o', "nexti" },
  79   { 'r', "run" },
  80   { 's', "step" },
  81   { 'i', "stepi" },
  82   { 'u', "up" },
  83   { 'v', "info locals" },
  84   { 'w', "where" },
  85   { 0, 0 },
  86 };
  87
  88 static Keymap tui_keymap;
  89 static Keymap tui_readline_standard_keymap;
  90
  91 /* TUI readline command.
  92    Switch the output mode between TUI/standard gdb.  */
  93 static int
  94 tui_rl_switch_mode (int notused1, int notused2)
  95 {
  96
  97   /* Don't let exceptions escape.  We're in the middle of a readline
  98      callback that isn't prepared for that.  */
  99   TRY
 100     {
 101       if (tui_active)
 102         {
 103           tui_disable ();
 104           rl_prep_terminal (0);
 105         }
 106       else
 107         {
 108           /* If tui_enable throws, we'll re-prep below.  */
 109           rl_deprep_terminal ();
 110           tui_enable ();
 111         }
 112     }
 113   CATCH (ex, RETURN_MASK_ALL)
 114     {
 115       exception_print (gdb_stderr, ex);
 116
 117       if (!tui_active)
 118         rl_prep_terminal (0);
 119     }
 120   END_CATCH
 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       if (TUI_DATA_WIN && TUI_DATA_WIN->generic.is_visible)
 241         tui_refresh_data_win ();
 242       keypad (TUI_CMD_WIN->generic.handle, (win_info != TUI_CMD_WIN));
 243     }
 244   return 0;
 245 }
 246
 247 /* TUI readline command.
 248    Execute the gdb command bound to the specified key.  */
 249 static int
 250 tui_rl_command_key (int count, int key)
 251 {
 252   int i;
 253
 254   reinitialize_more_filter ();
 255   for (i = 0; tui_commands[i].cmd; i++)
 256     {
 257       if (tui_commands[i].key == key)
 258         {
 259           /* Insert the command in the readline buffer.
 260              Avoid calling the gdb command here since it creates
 261              a possible recursion on readline if prompt_for_continue
 262              is called (See PR 9584).  The command will also appear
 263              in the readline history which turns out to be better.  */
 264           rl_insert_text (tui_commands[i].cmd);
 265           rl_newline (1, '\n');
 266
 267           /* Switch to gdb command mode while executing the command.
 268              This way the gdb's continue prompty will be displayed.  */
 269           tui_set_key_mode (TUI_ONE_COMMAND_MODE);
 270           return 0;
 271         }
 272     }
 273   return 0;
 274 }
 275
 276 /* TUI readline command.
 277    Temporarily leave the TUI SingleKey mode to allow editing
 278    a gdb command with the normal readline.  Once the command
 279    is executed, the TUI SingleKey mode is installed back.  */
 280 static int
 281 tui_rl_command_mode (int count, int key)
 282 {
 283   tui_set_key_mode (TUI_ONE_COMMAND_MODE);
 284   return rl_insert (count, key);
 285 }
 286
 287 /* TUI readline command.
 288    Switch between TUI SingleKey mode and gdb readline editing.  */
 289 static int
 290 tui_rl_next_keymap (int notused1, int notused2)
 291 {
 292   if (!tui_active)
 293     tui_rl_switch_mode (0 /* notused */, 0 /* notused */);
 294
 295   tui_set_key_mode (tui_current_key_mode == TUI_COMMAND_MODE
 296                     ? TUI_SINGLE_KEY_MODE : TUI_COMMAND_MODE);
 297   return 0;
 298 }
 299
 300 /* Readline hook to redisplay ourself the gdb prompt.
 301    In the SingleKey mode, the prompt is not printed so that
 302    the command window is cleaner.  It will be displayed if
 303    we temporarily leave the SingleKey mode.  */
 304 static int
 305 tui_rl_startup_hook (void)
 306 {
 307   rl_already_prompted = 1;
 308   if (tui_current_key_mode != TUI_COMMAND_MODE
 309       && !gdb_in_secondary_prompt_p (current_ui))
 310     tui_set_key_mode (TUI_SINGLE_KEY_MODE);
 311   tui_redisplay_readline ();
 312   return 0;
 313 }
 314
 315 /* Change the TUI key mode by installing the appropriate readline
 316    keymap.  */
 317 void
 318 tui_set_key_mode (enum tui_key_mode mode)
 319 {
 320   tui_current_key_mode = mode;
 321   rl_set_keymap (mode == TUI_SINGLE_KEY_MODE
 322                  ? tui_keymap : tui_readline_standard_keymap);
 323   tui_show_locator_content ();
 324 }
 325
 326 /* Initialize readline and configure the keymap for the switching
 327    key shortcut.  */
 328 void
 329 tui_initialize_readline (void)
 330 {
 331   int i;
 332   Keymap tui_ctlx_keymap;
 333
 334   rl_initialize ();
 335
 336   rl_add_defun ("tui-switch-mode", tui_rl_switch_mode, -1);
 337   rl_add_defun ("gdb-command", tui_rl_command_key, -1);
 338   rl_add_defun ("next-keymap", tui_rl_next_keymap, -1);
 339
 340   tui_keymap = rl_make_bare_keymap ();
 341   tui_ctlx_keymap = rl_make_bare_keymap ();
 342   tui_readline_standard_keymap = rl_get_keymap ();
 343
 344   for (i = 0; tui_commands[i].cmd; i++)
 345     rl_bind_key_in_map (tui_commands[i].key, tui_rl_command_key, tui_keymap);
 346
 347   rl_generic_bind (ISKMAP, "\\C-x", (char*) tui_ctlx_keymap, tui_keymap);
 348
 349   /* Bind all other keys to tui_rl_command_mode so that we switch
 350      temporarily from SingleKey mode and can enter a gdb command.  */
 351   for (i = ' '; i < 0x7f; i++)
 352     {
 353       int j;
 354
 355       for (j = 0; tui_commands[j].cmd; j++)
 356         if (tui_commands[j].key == i)
 357           break;
 358
 359       if (tui_commands[j].cmd)
 360         continue;
 361
 362       rl_bind_key_in_map (i, tui_rl_command_mode, tui_keymap);
 363     }
 364
 365   rl_bind_key_in_map ('a', tui_rl_switch_mode, emacs_ctlx_keymap);
 366   rl_bind_key_in_map ('a', tui_rl_switch_mode, tui_ctlx_keymap);
 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 (CTRL ('A'), tui_rl_switch_mode, emacs_ctlx_keymap);
 370   rl_bind_key_in_map (CTRL ('A'), tui_rl_switch_mode, tui_ctlx_keymap);
 371   rl_bind_key_in_map ('1', tui_rl_delete_other_windows, emacs_ctlx_keymap);
 372   rl_bind_key_in_map ('1', tui_rl_delete_other_windows, tui_ctlx_keymap);
 373   rl_bind_key_in_map ('2', tui_rl_change_windows, emacs_ctlx_keymap);
 374   rl_bind_key_in_map ('2', tui_rl_change_windows, tui_ctlx_keymap);
 375   rl_bind_key_in_map ('o', tui_rl_other_window, emacs_ctlx_keymap);
 376   rl_bind_key_in_map ('o', tui_rl_other_window, tui_ctlx_keymap);
 377   rl_bind_key_in_map ('q', tui_rl_next_keymap, tui_keymap);
 378   rl_bind_key_in_map ('s', tui_rl_next_keymap, emacs_ctlx_keymap);
 379   rl_bind_key_in_map ('s', tui_rl_next_keymap, tui_ctlx_keymap);
 380 }
 381
 382 /* Return the TERM variable from the environment, or "<unset>"
 383    if not set.  */
 384
 385 static const char *
 386 gdb_getenv_term (void)
 387 {
 388   const char *term;
 389
 390   term = getenv ("TERM");
 391   if (term != NULL)
 392     return term;
 393   return "<unset>";
 394 }
 395
 396 /* Enter in the tui mode (curses).
 397    When in normal mode, it installs the tui hooks in gdb, redirects
 398    the gdb output, configures the readline to work in tui mode.
 399    When in curses mode, it does nothing.  */
 400 void
 401 tui_enable (void)
 402 {
 403   if (tui_active)
 404     return;
 405
 406   /* To avoid to initialize curses when gdb starts, there is a defered
 407      curses initialization.  This initialization is made only once
 408      and the first time the curses mode is entered.  */
 409   if (tui_finish_init)
 410     {
 411       WINDOW *w;
 412       SCREEN *s;
 413       const char *cap;
 414       const char *interp;
 415
 416       /* If the top level interpreter is not the console/tui (e.g.,
 417          MI), enabling curses will certainly lose.  */
 418       interp = interp_name (top_level_interpreter ());
 419       if (strcmp (interp, INTERP_TUI) != 0)
 420         error (_("Cannot enable the TUI when the interpreter is '%s'"), interp);
 421
 422       /* Don't try to setup curses (and print funny control
 423          characters) if we're not outputting to a terminal.  */
 424       if (!ui_file_isatty (gdb_stdout))
 425         error (_("Cannot enable the TUI when output is not a terminal"));
 426
 427       s = newterm (NULL, stdout, stdin);
 428 #ifdef __MINGW32__
 429       /* The MinGW port of ncurses requires $TERM to be unset in order
 430          to activate the Windows console driver.  */
 431       if (s == NULL)
 432         s = newterm ((char *) "unknown", stdout, stdin);
 433 #endif
 434       if (s == NULL)
 435         {
 436           error (_("Cannot enable the TUI: error opening terminal [TERM=%s]"),
 437                  gdb_getenv_term ());
 438         }
 439       w = stdscr;
 440
 441       /* Check required terminal capabilities.  The MinGW port of
 442          ncurses does have them, but doesn't expose them through "cup".  */
 443 #ifndef __MINGW32__
 444       cap = tigetstr ((char *) "cup");
 445       if (cap == NULL || cap == (char *) -1 || *cap == '\0')
 446         {
 447           endwin ();
 448           delscreen (s);
 449           error (_("Cannot enable the TUI: "
 450                    "terminal doesn't support cursor addressing [TERM=%s]"),
 451                  gdb_getenv_term ());
 452         }
 453 #endif
 454
 455       cbreak ();
 456       noecho ();
 457       /* timeout (1); */
 458       nodelay(w, FALSE);
 459       nl();
 460       keypad (w, TRUE);
 461       rl_initialize ();
 462       tui_set_term_height_to (LINES);
 463       tui_set_term_width_to (COLS);
 464       def_prog_mode ();
 465
 466       tui_show_frame_info (0);
 467       tui_set_layout (SRC_COMMAND);
 468       tui_set_win_focus_to (TUI_SRC_WIN);
 469       keypad (TUI_CMD_WIN->generic.handle, TRUE);
 470       wrefresh (TUI_CMD_WIN->generic.handle);
 471       tui_finish_init = 0;
 472     }
 473   else
 474     {
 475      /* Save the current gdb setting of the terminal.
 476         Curses will restore this state when endwin() is called.  */
 477      def_shell_mode ();
 478      clearok (stdscr, TRUE);
 479    }
 480
 481   /* Install the TUI specific hooks.  */
 482   tui_install_hooks ();
 483   rl_startup_hook = tui_rl_startup_hook;
 484
 485   tui_update_variables ();
 486
 487   tui_setup_io (1);
 488
 489   tui_active = 1;
 490
 491   /* Resize windows before anything might display/refresh a
 492      window.  */
 493   if (tui_win_resized ())
 494     {
 495       tui_set_win_resized_to (FALSE);
 496       tui_resize_all ();
 497     }
 498
 499   if (deprecated_safe_get_selected_frame ())
 500     tui_show_frame_info (deprecated_safe_get_selected_frame ());
 501
 502   /* Restore TUI keymap.  */
 503   tui_set_key_mode (tui_current_key_mode);
 504
 505   /* Refresh the screen.  */
 506   tui_refresh_all_win ();
 507
 508   /* Update gdb's knowledge of its terminal.  */
 509   gdb_save_tty_state ();
 510   tui_update_gdb_sizes ();
 511 }
 512
 513 /* Leave the tui mode.
 514    Remove the tui hooks and configure the gdb output and readline
 515    back to their original state.  The curses mode is left so that
 516    the terminal setting is restored to the point when we entered.  */
 517 void
 518 tui_disable (void)
 519 {
 520   if (!tui_active)
 521     return;
 522
 523   /* Restore initial readline keymap.  */
 524   rl_set_keymap (tui_readline_standard_keymap);
 525
 526   /* Remove TUI hooks.  */
 527   tui_remove_hooks ();
 528   rl_startup_hook = 0;
 529   rl_already_prompted = 0;
 530
 531   /* Leave curses and restore previous gdb terminal setting.  */
 532   endwin ();
 533
 534   /* gdb terminal has changed, update gdb internal copy of it
 535      so that terminal management with the inferior works.  */
 536   tui_setup_io (0);
 537
 538   /* Update gdb's knowledge of its terminal.  */
 539   gdb_save_tty_state ();
 540
 541   tui_active = 0;
 542   tui_update_gdb_sizes ();
 543 }
 544
 545 /* Command wrapper for enabling tui mode.  */
 546
 547 static void
 548 tui_enable_command (const char *args, int from_tty)
 549 {
 550   tui_enable ();
 551 }
 552
 553 /* Command wrapper for leaving tui mode.  */
 554
 555 static void
 556 tui_disable_command (const char *args, int from_tty)
 557 {
 558   tui_disable ();
 559 }
 560
 561 void
 562 strcat_to_buf (char *buf, int buflen,
 563                const char *item_to_add)
 564 {
 565   if (item_to_add != (char *) NULL && buf != (char *) NULL)
 566     {
 567       if ((strlen (buf) + strlen (item_to_add)) <= buflen)
 568         strcat (buf, item_to_add);
 569       else
 570         strncat (buf, item_to_add, (buflen - strlen (buf)));
 571     }
 572 }
 573
 574 #if 0
 575 /* Solaris <sys/termios.h> defines CTRL.  */
 576 #ifndef CTRL
 577 #define CTRL(x)         (x & ~0140)
 578 #endif
 579
 580 #define FILEDES         2
 581 #define CHK(val, dft)   (val<=0 ? dft : val)
 582
 583 static void
 584 tui_reset (void)
 585 {
 586   struct termio mode;
 587
 588   /* Reset the teletype mode bits to a sensible state.
 589      Copied tset.c.  */
 590 #if defined (TIOCGETC)
 591   struct tchars tbuf;
 592 #endif /* TIOCGETC */
 593 #ifdef UCB_NTTY
 594   struct ltchars ltc;
 595
 596   if (ldisc == NTTYDISC)
 597     {
 598       ioctl (FILEDES, TIOCGLTC, &ltc);
 599       ltc.t_suspc = CHK (ltc.t_suspc, CTRL ('Z'));
 600       ltc.t_dsuspc = CHK (ltc.t_dsuspc, CTRL ('Y'));
 601       ltc.t_rprntc = CHK (ltc.t_rprntc, CTRL ('R'));
 602       ltc.t_flushc = CHK (ltc.t_flushc, CTRL ('O'));
 603       ltc.t_werasc = CHK (ltc.t_werasc, CTRL ('W'));
 604       ltc.t_lnextc = CHK (ltc.t_lnextc, CTRL ('V'));
 605       ioctl (FILEDES, TIOCSLTC, &ltc);
 606     }
 607 #endif /* UCB_NTTY */
 608 #ifdef TIOCGETC
 609   ioctl (FILEDES, TIOCGETC, &tbuf);
 610   tbuf.t_intrc = CHK (tbuf.t_intrc, CTRL ('?'));
 611   tbuf.t_quitc = CHK (tbuf.t_quitc, CTRL ('\\'));
 612   tbuf.t_startc = CHK (tbuf.t_startc, CTRL ('Q'));
 613   tbuf.t_stopc = CHK (tbuf.t_stopc, CTRL ('S'));
 614   tbuf.t_eofc = CHK (tbuf.t_eofc, CTRL ('D'));
 615   /* brkc is left alone.  */
 616   ioctl (FILEDES, TIOCSETC, &tbuf);
 617 #endif /* TIOCGETC */
 618   mode.sg_flags &= ~(RAW
 619 #ifdef CBREAK
 620                      | CBREAK
 621 #endif /* CBREAK */
 622                      | VTDELAY | ALLDELAY);
 623   mode.sg_flags |= XTABS | ECHO | CRMOD | ANYP;
 624
 625   return;
 626 }
 627 #endif
 628
 629 void
 630 tui_show_source (const char *fullname, int line)
 631 {
 632   struct symtab_and_line cursal = get_current_source_symtab_and_line ();
 633
 634   /* Make sure that the source window is displayed.  */
 635   tui_add_win_to_layout (SRC_WIN);
 636
 637   tui_update_source_windows_with_line (cursal.symtab, line);
 638   tui_update_locator_fullname (fullname);
 639 }
 640
 641 void
 642 tui_show_assembly (struct gdbarch *gdbarch, CORE_ADDR addr)
 643 {
 644   tui_add_win_to_layout (DISASSEM_WIN);
 645   tui_update_source_windows_with_addr (gdbarch, addr);
 646 }
 647
 648 int
 649 tui_is_window_visible (enum tui_win_type type)
 650 {
 651   if (tui_active == 0)
 652     return 0;
 653
 654   if (tui_win_list[type] == 0)
 655     return 0;
 656
 657   return tui_win_list[type]->generic.is_visible;
 658 }
 659
 660 int
 661 tui_get_command_dimension (unsigned int *width,
 662                            unsigned int *height)
 663 {
 664   if (!tui_active || (TUI_CMD_WIN == NULL))
 665     {
 666       return 0;
 667     }
 668
 669   *width = TUI_CMD_WIN->generic.width;
 670   *height = TUI_CMD_WIN->generic.height;
 671   return 1;
 672 }
 673
 674 void
 675 _initialize_tui (void)
 676 {
 677   struct cmd_list_element **tuicmd;
 678
 679   tuicmd = tui_get_cmd_list ();
 680
 681   add_cmd ("enable", class_tui, tui_enable_command,
 682            _("Enable TUI display mode."),
 683            tuicmd);
 684   add_cmd ("disable", class_tui, tui_disable_command,
 685            _("Disable TUI display mode."),
 686            tuicmd);
 687 }