gdb/tui/tui.c

   1 /* General functions for the WDB TUI.
   2
   3    Copyright (C) 1998-2015 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
  42 #include <ctype.h>
  43 #include <signal.h>
  44 #include <fcntl.h>
  45 #if 0
  46 #include <termio.h>
  47 #endif
  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 int tui_active = 0;
  60 static int tui_finish_init = 1;
  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   { 'r', "run" },
  78   { 's', "step" },
  79   { 'u', "up" },
  80   { 'v', "info locals" },
  81   { 'w', "where" },
  82   { 0, 0 },
  83 };
  84
  85 static Keymap tui_keymap;
  86 static Keymap tui_readline_standard_keymap;
  87
  88 /* TUI readline command.
  89    Switch the output mode between TUI/standard gdb.  */
  90 static int
  91 tui_rl_switch_mode (int notused1, int notused2)
  92 {
  93   volatile struct gdb_exception ex;
  94
  95   /* Don't let exceptions escape.  We're in the middle of a readline
  96      callback that isn't prepared for that.  */
  97   TRY_CATCH (ex, RETURN_MASK_ALL)
  98     {
  99       if (tui_active)
 100         {
 101           tui_disable ();
 102           rl_prep_terminal (0);
 103         }
 104       else
 105         {
 106           /* If tui_enable throws, we'll re-prep below.  */
 107           rl_deprep_terminal ();
 108           tui_enable ();
 109         }
 110     }
 111   if (ex.reason < 0)
 112     {
 113       exception_print (gdb_stderr, ex);
 114
 115       if (!tui_active)
 116         rl_prep_terminal (0);
 117     }
 118
 119   /* Clear the readline in case switching occurred in middle of
 120      something.  */
 121   if (rl_end)
 122     rl_kill_text (0, rl_end);
 123
 124   /* Since we left the curses mode, the terminal mode is restored to
 125      some previous state.  That state may not be suitable for readline
 126      to work correctly (it may be restored in line mode).  We force an
 127      exit of the current readline so that readline is re-entered and
 128      it will be able to setup the terminal for its needs.  By
 129      re-entering in readline, we also redisplay its prompt in the
 130      non-curses mode.  */
 131   rl_newline (1, '\n');
 132
 133   /* Make sure the \n we are returning does not repeat the last
 134      command.  */
 135   dont_repeat ();
 136   return 0;
 137 }
 138
 139 /* TUI readline command.
 140    Change the TUI layout to show a next layout.
 141    This function is bound to CTRL-X 2.  It is intended to provide
 142    a functionality close to the Emacs split-window command.  We
 143    always show two windows (src+asm), (src+regs) or (asm+regs).  */
 144 static int
 145 tui_rl_change_windows (int notused1, int notused2)
 146 {
 147   if (!tui_active)
 148     tui_rl_switch_mode (0 /* notused */, 0 /* notused */);
 149
 150   if (tui_active)
 151     {
 152       enum tui_layout_type new_layout;
 153       enum tui_register_display_type regs_type = TUI_UNDEFINED_REGS;
 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, regs_type);
 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       enum tui_register_display_type regs_type = TUI_UNDEFINED_REGS;
 202
 203       new_layout = tui_current_layout ();
 204
 205       /* Kill one window.  */
 206       switch (new_layout)
 207         {
 208         case SRC_COMMAND:
 209         case SRC_DATA_COMMAND:
 210         case SRC_DISASSEM_COMMAND:
 211         default:
 212           new_layout = SRC_COMMAND;
 213           break;
 214
 215         case DISASSEM_COMMAND:
 216         case DISASSEM_DATA_COMMAND:
 217           new_layout = DISASSEM_COMMAND;
 218           break;
 219         }
 220       tui_set_layout (new_layout, regs_type);
 221     }
 222   return 0;
 223 }
 224
 225 /* TUI readline command.
 226    Switch the active window to give the focus to a next window.  */
 227 static int
 228 tui_rl_other_window (int count, int key)
 229 {
 230   struct tui_win_info *win_info;
 231
 232   if (!tui_active)
 233     tui_rl_switch_mode (0 /* notused */, 0 /* notused */);
 234
 235   win_info = tui_next_win (tui_win_with_focus ());
 236   if (win_info)
 237     {
 238       tui_set_win_focus_to (win_info);
 239       if (TUI_DATA_WIN && TUI_DATA_WIN->generic.is_visible)
 240         tui_refresh_data_win ();
 241       keypad (TUI_CMD_WIN->generic.handle, (win_info != TUI_CMD_WIN));
 242     }
 243   return 0;
 244 }
 245
 246 /* TUI readline command.
 247    Execute the gdb command bound to the specified key.  */
 248 static int
 249 tui_rl_command_key (int count, int key)
 250 {
 251   int i;
 252
 253   reinitialize_more_filter ();
 254   for (i = 0; tui_commands[i].cmd; i++)
 255     {
 256       if (tui_commands[i].key == key)
 257         {
 258           /* Insert the command in the readline buffer.
 259              Avoid calling the gdb command here since it creates
 260              a possible recursion on readline if prompt_for_continue
 261              is called (See PR 9584).  The command will also appear
 262              in the readline history which turns out to be better.  */
 263           rl_insert_text (tui_commands[i].cmd);
 264           rl_newline (1, '\n');
 265
 266           /* Switch to gdb command mode while executing the command.
 267              This way the gdb's continue prompty will be displayed.  */
 268           tui_set_key_mode (TUI_ONE_COMMAND_MODE);
 269           return 0;
 270         }
 271     }
 272   return 0;
 273 }
 274
 275 /* TUI readline command.
 276    Temporarily leave the TUI SingleKey mode to allow editing
 277    a gdb command with the normal readline.  Once the command
 278    is executed, the TUI SingleKey mode is installed back.  */
 279 static int
 280 tui_rl_command_mode (int count, int key)
 281 {
 282   tui_set_key_mode (TUI_ONE_COMMAND_MODE);
 283   return rl_insert (count, key);
 284 }
 285
 286 /* TUI readline command.
 287    Switch between TUI SingleKey mode and gdb readline editing.  */
 288 static int
 289 tui_rl_next_keymap (int notused1, int notused2)
 290 {
 291   if (!tui_active)
 292     tui_rl_switch_mode (0 /* notused */, 0 /* notused */);
 293
 294   tui_set_key_mode (tui_current_key_mode == TUI_COMMAND_MODE
 295                     ? TUI_SINGLE_KEY_MODE : TUI_COMMAND_MODE);
 296   return 0;
 297 }
 298
 299 /* Readline hook to redisplay ourself the gdb prompt.
 300    In the SingleKey mode, the prompt is not printed so that
 301    the command window is cleaner.  It will be displayed if
 302    we temporarily leave the SingleKey mode.  */
 303 static int
 304 tui_rl_startup_hook (void)
 305 {
 306   rl_already_prompted = 1;
 307   if (tui_current_key_mode != TUI_COMMAND_MODE && immediate_quit == 0)
 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_initialize ();
 333
 334   rl_add_defun ("tui-switch-mode", tui_rl_switch_mode, -1);
 335   rl_add_defun ("gdb-command", tui_rl_command_key, -1);
 336   rl_add_defun ("next-keymap", tui_rl_next_keymap, -1);
 337
 338   tui_keymap = rl_make_bare_keymap ();
 339   tui_ctlx_keymap = rl_make_bare_keymap ();
 340   tui_readline_standard_keymap = rl_get_keymap ();
 341
 342   for (i = 0; tui_commands[i].cmd; i++)
 343     rl_bind_key_in_map (tui_commands[i].key, tui_rl_command_key, tui_keymap);
 344
 345   rl_generic_bind (ISKMAP, "\\C-x", (char*) tui_ctlx_keymap, tui_keymap);
 346
 347   /* Bind all other keys to tui_rl_command_mode so that we switch
 348      temporarily from SingleKey mode and can enter a gdb command.  */
 349   for (i = ' '; i < 0x7f; i++)
 350     {
 351       int j;
 352
 353       for (j = 0; tui_commands[j].cmd; j++)
 354         if (tui_commands[j].key == i)
 355           break;
 356
 357       if (tui_commands[j].cmd)
 358         continue;
 359
 360       rl_bind_key_in_map (i, tui_rl_command_mode, tui_keymap);
 361     }
 362
 363   rl_bind_key_in_map ('a', tui_rl_switch_mode, emacs_ctlx_keymap);
 364   rl_bind_key_in_map ('a', tui_rl_switch_mode, tui_ctlx_keymap);
 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 (CTRL ('A'), tui_rl_switch_mode, emacs_ctlx_keymap);
 368   rl_bind_key_in_map (CTRL ('A'), tui_rl_switch_mode, tui_ctlx_keymap);
 369   rl_bind_key_in_map ('1', tui_rl_delete_other_windows, emacs_ctlx_keymap);
 370   rl_bind_key_in_map ('1', tui_rl_delete_other_windows, tui_ctlx_keymap);
 371   rl_bind_key_in_map ('2', tui_rl_change_windows, emacs_ctlx_keymap);
 372   rl_bind_key_in_map ('2', tui_rl_change_windows, tui_ctlx_keymap);
 373   rl_bind_key_in_map ('o', tui_rl_other_window, emacs_ctlx_keymap);
 374   rl_bind_key_in_map ('o', tui_rl_other_window, tui_ctlx_keymap);
 375   rl_bind_key_in_map ('q', tui_rl_next_keymap, tui_keymap);
 376   rl_bind_key_in_map ('s', tui_rl_next_keymap, emacs_ctlx_keymap);
 377   rl_bind_key_in_map ('s', tui_rl_next_keymap, tui_ctlx_keymap);
 378 }
 379
 380 /* Return the TERM variable from the environment, or "<unset>"
 381    if not set.  */
 382
 383 static const char *
 384 gdb_getenv_term (void)
 385 {
 386   const char *term;
 387
 388   term = getenv ("TERM");
 389   if (term != NULL)
 390     return term;
 391   return "<unset>";
 392 }
 393
 394 /* Enter in the tui mode (curses).
 395    When in normal mode, it installs the tui hooks in gdb, redirects
 396    the gdb output, configures the readline to work in tui mode.
 397    When in curses mode, it does nothing.  */
 398 void
 399 tui_enable (void)
 400 {
 401   struct interp *interp;
 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 ("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 ("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, TUI_UNDEFINED_REGS);
 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   if (deprecated_safe_get_selected_frame ())
 491      tui_show_frame_info (deprecated_safe_get_selected_frame ());
 492
 493   /* Restore TUI keymap.  */
 494   tui_set_key_mode (tui_current_key_mode);
 495
 496   /* Resize and refresh the screen.  */
 497   if (tui_win_resized ())
 498     {
 499       tui_resize_all ();
 500       tui_set_win_resized_to (FALSE);
 501     }
 502   tui_refresh_all_win ();
 503
 504   /* Update gdb's knowledge of its terminal.  */
 505   gdb_save_tty_state ();
 506   tui_update_gdb_sizes ();
 507 }
 508
 509 /* Leave the tui mode.
 510    Remove the tui hooks and configure the gdb output and readline
 511    back to their original state.  The curses mode is left so that
 512    the terminal setting is restored to the point when we entered.  */
 513 void
 514 tui_disable (void)
 515 {
 516   if (!tui_active)
 517     return;
 518
 519   /* Restore initial readline keymap.  */
 520   rl_set_keymap (tui_readline_standard_keymap);
 521
 522   /* Remove TUI hooks.  */
 523   tui_remove_hooks ();
 524   rl_startup_hook = 0;
 525   rl_already_prompted = 0;
 526
 527   /* Leave curses and restore previous gdb terminal setting.  */
 528   endwin ();
 529
 530   /* gdb terminal has changed, update gdb internal copy of it
 531      so that terminal management with the inferior works.  */
 532   tui_setup_io (0);
 533
 534   /* Update gdb's knowledge of its terminal.  */
 535   gdb_save_tty_state ();
 536
 537   tui_active = 0;
 538   tui_update_gdb_sizes ();
 539 }
 540
 541 void
 542 strcat_to_buf (char *buf, int buflen,
 543                const char *item_to_add)
 544 {
 545   if (item_to_add != (char *) NULL && buf != (char *) NULL)
 546     {
 547       if ((strlen (buf) + strlen (item_to_add)) <= buflen)
 548         strcat (buf, item_to_add);
 549       else
 550         strncat (buf, item_to_add, (buflen - strlen (buf)));
 551     }
 552 }
 553
 554 #if 0
 555 /* Solaris <sys/termios.h> defines CTRL.  */
 556 #ifndef CTRL
 557 #define CTRL(x)         (x & ~0140)
 558 #endif
 559
 560 #define FILEDES         2
 561 #define CHK(val, dft)   (val<=0 ? dft : val)
 562
 563 static void
 564 tui_reset (void)
 565 {
 566   struct termio mode;
 567
 568   /* Reset the teletype mode bits to a sensible state.
 569      Copied tset.c.  */
 570 #if defined (TIOCGETC)
 571   struct tchars tbuf;
 572 #endif /* TIOCGETC */
 573 #ifdef UCB_NTTY
 574   struct ltchars ltc;
 575
 576   if (ldisc == NTTYDISC)
 577     {
 578       ioctl (FILEDES, TIOCGLTC, &ltc);
 579       ltc.t_suspc = CHK (ltc.t_suspc, CTRL ('Z'));
 580       ltc.t_dsuspc = CHK (ltc.t_dsuspc, CTRL ('Y'));
 581       ltc.t_rprntc = CHK (ltc.t_rprntc, CTRL ('R'));
 582       ltc.t_flushc = CHK (ltc.t_flushc, CTRL ('O'));
 583       ltc.t_werasc = CHK (ltc.t_werasc, CTRL ('W'));
 584       ltc.t_lnextc = CHK (ltc.t_lnextc, CTRL ('V'));
 585       ioctl (FILEDES, TIOCSLTC, &ltc);
 586     }
 587 #endif /* UCB_NTTY */
 588 #ifdef TIOCGETC
 589   ioctl (FILEDES, TIOCGETC, &tbuf);
 590   tbuf.t_intrc = CHK (tbuf.t_intrc, CTRL ('?'));
 591   tbuf.t_quitc = CHK (tbuf.t_quitc, CTRL ('\\'));
 592   tbuf.t_startc = CHK (tbuf.t_startc, CTRL ('Q'));
 593   tbuf.t_stopc = CHK (tbuf.t_stopc, CTRL ('S'));
 594   tbuf.t_eofc = CHK (tbuf.t_eofc, CTRL ('D'));
 595   /* brkc is left alone.  */
 596   ioctl (FILEDES, TIOCSETC, &tbuf);
 597 #endif /* TIOCGETC */
 598   mode.sg_flags &= ~(RAW
 599 #ifdef CBREAK
 600                      | CBREAK
 601 #endif /* CBREAK */
 602                      | VTDELAY | ALLDELAY);
 603   mode.sg_flags |= XTABS | ECHO | CRMOD | ANYP;
 604
 605   return;
 606 }
 607 #endif
 608
 609 void
 610 tui_show_source (const char *fullname, int line)
 611 {
 612   struct symtab_and_line cursal = get_current_source_symtab_and_line ();
 613
 614   /* Make sure that the source window is displayed.  */
 615   tui_add_win_to_layout (SRC_WIN);
 616
 617   tui_update_source_windows_with_line (cursal.symtab, line);
 618   tui_update_locator_fullname (fullname);
 619 }
 620
 621 void
 622 tui_show_assembly (struct gdbarch *gdbarch, CORE_ADDR addr)
 623 {
 624   tui_add_win_to_layout (DISASSEM_WIN);
 625   tui_update_source_windows_with_addr (gdbarch, addr);
 626 }
 627
 628 int
 629 tui_is_window_visible (enum tui_win_type type)
 630 {
 631   if (tui_active == 0)
 632     return 0;
 633
 634   if (tui_win_list[type] == 0)
 635     return 0;
 636
 637   return tui_win_list[type]->generic.is_visible;
 638 }
 639
 640 int
 641 tui_get_command_dimension (unsigned int *width,
 642                            unsigned int *height)
 643 {
 644   if (!tui_active || (TUI_CMD_WIN == NULL))
 645     {
 646       return 0;
 647     }
 648
 649   *width = TUI_CMD_WIN->generic.width;
 650   *height = TUI_CMD_WIN->generic.height;
 651   return 1;
 652 }