gdb/tui/tui.c

   1 /* General functions for the WDB TUI.
   2
   3    Copyright (C) 1998-2014 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, NULL, NULL);
 428       if (s == NULL)
 429         {
 430           error (_("Cannot enable the TUI: error opening terminal [TERM=%s]"),
 431                  gdb_getenv_term ());
 432         }
 433       w = stdscr;
 434
 435       /* Check required terminal capabilities.  */
 436       cap = tigetstr ("cup");
 437       if (cap == NULL || cap == (char *) -1 || *cap == '\0')
 438         {
 439           endwin ();
 440           delscreen (s);
 441           error (_("Cannot enable the TUI: "
 442                    "terminal doesn't support cursor addressing [TERM=%s]"),
 443                  gdb_getenv_term ());
 444         }
 445
 446       cbreak ();
 447       noecho ();
 448       /* timeout (1); */
 449       nodelay(w, FALSE);
 450       nl();
 451       keypad (w, TRUE);
 452       rl_initialize ();
 453       tui_set_term_height_to (LINES);
 454       tui_set_term_width_to (COLS);
 455       def_prog_mode ();
 456
 457       tui_show_frame_info (0);
 458       tui_set_layout (SRC_COMMAND, TUI_UNDEFINED_REGS);
 459       tui_set_win_focus_to (TUI_SRC_WIN);
 460       keypad (TUI_CMD_WIN->generic.handle, TRUE);
 461       wrefresh (TUI_CMD_WIN->generic.handle);
 462       tui_finish_init = 0;
 463     }
 464   else
 465     {
 466      /* Save the current gdb setting of the terminal.
 467         Curses will restore this state when endwin() is called.  */
 468      def_shell_mode ();
 469      clearok (stdscr, TRUE);
 470    }
 471
 472   /* Install the TUI specific hooks.  */
 473   tui_install_hooks ();
 474   rl_startup_hook = tui_rl_startup_hook;
 475
 476   tui_update_variables ();
 477
 478   tui_setup_io (1);
 479
 480   tui_active = 1;
 481   if (deprecated_safe_get_selected_frame ())
 482      tui_show_frame_info (deprecated_safe_get_selected_frame ());
 483
 484   /* Restore TUI keymap.  */
 485   tui_set_key_mode (tui_current_key_mode);
 486   tui_refresh_all_win ();
 487
 488   /* Update gdb's knowledge of its terminal.  */
 489   gdb_save_tty_state ();
 490   tui_update_gdb_sizes ();
 491 }
 492
 493 /* Leave the tui mode.
 494    Remove the tui hooks and configure the gdb output and readline
 495    back to their original state.  The curses mode is left so that
 496    the terminal setting is restored to the point when we entered.  */
 497 void
 498 tui_disable (void)
 499 {
 500   if (!tui_active)
 501     return;
 502
 503   /* Restore initial readline keymap.  */
 504   rl_set_keymap (tui_readline_standard_keymap);
 505
 506   /* Remove TUI hooks.  */
 507   tui_remove_hooks ();
 508   rl_startup_hook = 0;
 509   rl_already_prompted = 0;
 510
 511   /* Leave curses and restore previous gdb terminal setting.  */
 512   endwin ();
 513
 514   /* gdb terminal has changed, update gdb internal copy of it
 515      so that terminal management with the inferior works.  */
 516   tui_setup_io (0);
 517
 518   /* Update gdb's knowledge of its terminal.  */
 519   gdb_save_tty_state ();
 520
 521   tui_active = 0;
 522   tui_update_gdb_sizes ();
 523 }
 524
 525 void
 526 strcat_to_buf (char *buf, int buflen,
 527                const char *item_to_add)
 528 {
 529   if (item_to_add != (char *) NULL && buf != (char *) NULL)
 530     {
 531       if ((strlen (buf) + strlen (item_to_add)) <= buflen)
 532         strcat (buf, item_to_add);
 533       else
 534         strncat (buf, item_to_add, (buflen - strlen (buf)));
 535     }
 536 }
 537
 538 #if 0
 539 /* Solaris <sys/termios.h> defines CTRL.  */
 540 #ifndef CTRL
 541 #define CTRL(x)         (x & ~0140)
 542 #endif
 543
 544 #define FILEDES         2
 545 #define CHK(val, dft)   (val<=0 ? dft : val)
 546
 547 static void
 548 tui_reset (void)
 549 {
 550   struct termio mode;
 551
 552   /* Reset the teletype mode bits to a sensible state.
 553      Copied tset.c.  */
 554 #if defined (TIOCGETC)
 555   struct tchars tbuf;
 556 #endif /* TIOCGETC */
 557 #ifdef UCB_NTTY
 558   struct ltchars ltc;
 559
 560   if (ldisc == NTTYDISC)
 561     {
 562       ioctl (FILEDES, TIOCGLTC, &ltc);
 563       ltc.t_suspc = CHK (ltc.t_suspc, CTRL ('Z'));
 564       ltc.t_dsuspc = CHK (ltc.t_dsuspc, CTRL ('Y'));
 565       ltc.t_rprntc = CHK (ltc.t_rprntc, CTRL ('R'));
 566       ltc.t_flushc = CHK (ltc.t_flushc, CTRL ('O'));
 567       ltc.t_werasc = CHK (ltc.t_werasc, CTRL ('W'));
 568       ltc.t_lnextc = CHK (ltc.t_lnextc, CTRL ('V'));
 569       ioctl (FILEDES, TIOCSLTC, &ltc);
 570     }
 571 #endif /* UCB_NTTY */
 572 #ifdef TIOCGETC
 573   ioctl (FILEDES, TIOCGETC, &tbuf);
 574   tbuf.t_intrc = CHK (tbuf.t_intrc, CTRL ('?'));
 575   tbuf.t_quitc = CHK (tbuf.t_quitc, CTRL ('\\'));
 576   tbuf.t_startc = CHK (tbuf.t_startc, CTRL ('Q'));
 577   tbuf.t_stopc = CHK (tbuf.t_stopc, CTRL ('S'));
 578   tbuf.t_eofc = CHK (tbuf.t_eofc, CTRL ('D'));
 579   /* brkc is left alone.  */
 580   ioctl (FILEDES, TIOCSETC, &tbuf);
 581 #endif /* TIOCGETC */
 582   mode.sg_flags &= ~(RAW
 583 #ifdef CBREAK
 584                      | CBREAK
 585 #endif /* CBREAK */
 586                      | VTDELAY | ALLDELAY);
 587   mode.sg_flags |= XTABS | ECHO | CRMOD | ANYP;
 588
 589   return;
 590 }
 591 #endif
 592
 593 void
 594 tui_show_source (const char *fullname, int line)
 595 {
 596   struct symtab_and_line cursal = get_current_source_symtab_and_line ();
 597
 598   /* Make sure that the source window is displayed.  */
 599   tui_add_win_to_layout (SRC_WIN);
 600
 601   tui_update_source_windows_with_line (cursal.symtab, line);
 602   tui_update_locator_fullname (fullname);
 603 }
 604
 605 void
 606 tui_show_assembly (struct gdbarch *gdbarch, CORE_ADDR addr)
 607 {
 608   tui_add_win_to_layout (DISASSEM_WIN);
 609   tui_update_source_windows_with_addr (gdbarch, addr);
 610 }
 611
 612 int
 613 tui_is_window_visible (enum tui_win_type type)
 614 {
 615   if (tui_active == 0)
 616     return 0;
 617
 618   if (tui_win_list[type] == 0)
 619     return 0;
 620
 621   return tui_win_list[type]->generic.is_visible;
 622 }
 623
 624 int
 625 tui_get_command_dimension (unsigned int *width,
 626                            unsigned int *height)
 627 {
 628   if (!tui_active || (TUI_CMD_WIN == NULL))
 629     {
 630       return 0;
 631     }
 632
 633   *width = TUI_CMD_WIN->generic.width;
 634   *height = TUI_CMD_WIN->generic.height;
 635   return 1;
 636 }