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
  94   /* Don't let exceptions escape.  We're in the middle of a readline
  95      callback that isn't prepared for that.  */
  96   TRY
  97     {
  98       if (tui_active)
  99         {
 100           tui_disable ();
 101           rl_prep_terminal (0);
 102         }
 103       else
 104         {
 105           /* If tui_enable throws, we'll re-prep below.  */
 106           rl_deprep_terminal ();
 107           tui_enable ();
 108         }
 109     }
 110   CATCH (ex, RETURN_MASK_ALL)
 111     {
 112       exception_print (gdb_stderr, ex);
 113
 114       if (!tui_active)
 115         rl_prep_terminal (0);
 116     }
 117   END_CATCH
 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
 154       new_layout = tui_current_layout ();
 155
 156       /* Select a new layout to have a rolling layout behavior with
 157          always two windows (except when undefined).  */
 158       switch (new_layout)
 159         {
 160         case SRC_COMMAND:
 161           new_layout = SRC_DISASSEM_COMMAND;
 162           break;
 163
 164         case DISASSEM_COMMAND:
 165           new_layout = SRC_DISASSEM_COMMAND;
 166           break;
 167
 168         case SRC_DATA_COMMAND:
 169           new_layout = SRC_DISASSEM_COMMAND;
 170           break;
 171
 172         case SRC_DISASSEM_COMMAND:
 173           new_layout = DISASSEM_DATA_COMMAND;
 174           break;
 175
 176         case DISASSEM_DATA_COMMAND:
 177           new_layout = SRC_DATA_COMMAND;
 178           break;
 179
 180         default:
 181           new_layout = SRC_COMMAND;
 182           break;
 183         }
 184       tui_set_layout (new_layout);
 185     }
 186   return 0;
 187 }
 188
 189 /* TUI readline command.
 190    Delete the second TUI window to only show one.  */
 191 static int
 192 tui_rl_delete_other_windows (int notused1, int notused2)
 193 {
 194   if (!tui_active)
 195     tui_rl_switch_mode (0 /* notused */, 0 /* notused */);
 196
 197   if (tui_active)
 198     {
 199       enum tui_layout_type new_layout;
 200
 201       new_layout = tui_current_layout ();
 202
 203       /* Kill one window.  */
 204       switch (new_layout)
 205         {
 206         case SRC_COMMAND:
 207         case SRC_DATA_COMMAND:
 208         case SRC_DISASSEM_COMMAND:
 209         default:
 210           new_layout = SRC_COMMAND;
 211           break;
 212
 213         case DISASSEM_COMMAND:
 214         case DISASSEM_DATA_COMMAND:
 215           new_layout = DISASSEM_COMMAND;
 216           break;
 217         }
 218       tui_set_layout (new_layout);
 219     }
 220   return 0;
 221 }
 222
 223 /* TUI readline command.
 224    Switch the active window to give the focus to a next window.  */
 225 static int
 226 tui_rl_other_window (int count, int key)
 227 {
 228   struct tui_win_info *win_info;
 229
 230   if (!tui_active)
 231     tui_rl_switch_mode (0 /* notused */, 0 /* notused */);
 232
 233   win_info = tui_next_win (tui_win_with_focus ());
 234   if (win_info)
 235     {
 236       tui_set_win_focus_to (win_info);
 237       if (TUI_DATA_WIN && TUI_DATA_WIN->generic.is_visible)
 238         tui_refresh_data_win ();
 239       keypad (TUI_CMD_WIN->generic.handle, (win_info != TUI_CMD_WIN));
 240     }
 241   return 0;
 242 }
 243
 244 /* TUI readline command.
 245    Execute the gdb command bound to the specified key.  */
 246 static int
 247 tui_rl_command_key (int count, int key)
 248 {
 249   int i;
 250
 251   reinitialize_more_filter ();
 252   for (i = 0; tui_commands[i].cmd; i++)
 253     {
 254       if (tui_commands[i].key == key)
 255         {
 256           /* Insert the command in the readline buffer.
 257              Avoid calling the gdb command here since it creates
 258              a possible recursion on readline if prompt_for_continue
 259              is called (See PR 9584).  The command will also appear
 260              in the readline history which turns out to be better.  */
 261           rl_insert_text (tui_commands[i].cmd);
 262           rl_newline (1, '\n');
 263
 264           /* Switch to gdb command mode while executing the command.
 265              This way the gdb's continue prompty will be displayed.  */
 266           tui_set_key_mode (TUI_ONE_COMMAND_MODE);
 267           return 0;
 268         }
 269     }
 270   return 0;
 271 }
 272
 273 /* TUI readline command.
 274    Temporarily leave the TUI SingleKey mode to allow editing
 275    a gdb command with the normal readline.  Once the command
 276    is executed, the TUI SingleKey mode is installed back.  */
 277 static int
 278 tui_rl_command_mode (int count, int key)
 279 {
 280   tui_set_key_mode (TUI_ONE_COMMAND_MODE);
 281   return rl_insert (count, key);
 282 }
 283
 284 /* TUI readline command.
 285    Switch between TUI SingleKey mode and gdb readline editing.  */
 286 static int
 287 tui_rl_next_keymap (int notused1, int notused2)
 288 {
 289   if (!tui_active)
 290     tui_rl_switch_mode (0 /* notused */, 0 /* notused */);
 291
 292   tui_set_key_mode (tui_current_key_mode == TUI_COMMAND_MODE
 293                     ? TUI_SINGLE_KEY_MODE : TUI_COMMAND_MODE);
 294   return 0;
 295 }
 296
 297 /* Readline hook to redisplay ourself the gdb prompt.
 298    In the SingleKey mode, the prompt is not printed so that
 299    the command window is cleaner.  It will be displayed if
 300    we temporarily leave the SingleKey mode.  */
 301 static int
 302 tui_rl_startup_hook (void)
 303 {
 304   rl_already_prompted = 1;
 305   if (tui_current_key_mode != TUI_COMMAND_MODE && immediate_quit == 0)
 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_initialize ();
 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   tui_ctlx_keymap = rl_make_bare_keymap ();
 338   tui_readline_standard_keymap = rl_get_keymap ();
 339
 340   for (i = 0; tui_commands[i].cmd; i++)
 341     rl_bind_key_in_map (tui_commands[i].key, tui_rl_command_key, tui_keymap);
 342
 343   rl_generic_bind (ISKMAP, "\\C-x", (char*) tui_ctlx_keymap, tui_keymap);
 344
 345   /* Bind all other keys to tui_rl_command_mode so that we switch
 346      temporarily from SingleKey mode and can enter a gdb command.  */
 347   for (i = ' '; i < 0x7f; i++)
 348     {
 349       int j;
 350
 351       for (j = 0; tui_commands[j].cmd; j++)
 352         if (tui_commands[j].key == i)
 353           break;
 354
 355       if (tui_commands[j].cmd)
 356         continue;
 357
 358       rl_bind_key_in_map (i, tui_rl_command_mode, tui_keymap);
 359     }
 360
 361   rl_bind_key_in_map ('a', tui_rl_switch_mode, emacs_ctlx_keymap);
 362   rl_bind_key_in_map ('a', tui_rl_switch_mode, tui_ctlx_keymap);
 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 (CTRL ('A'), tui_rl_switch_mode, emacs_ctlx_keymap);
 366   rl_bind_key_in_map (CTRL ('A'), tui_rl_switch_mode, tui_ctlx_keymap);
 367   rl_bind_key_in_map ('1', tui_rl_delete_other_windows, emacs_ctlx_keymap);
 368   rl_bind_key_in_map ('1', tui_rl_delete_other_windows, tui_ctlx_keymap);
 369   rl_bind_key_in_map ('2', tui_rl_change_windows, emacs_ctlx_keymap);
 370   rl_bind_key_in_map ('2', tui_rl_change_windows, tui_ctlx_keymap);
 371   rl_bind_key_in_map ('o', tui_rl_other_window, emacs_ctlx_keymap);
 372   rl_bind_key_in_map ('o', tui_rl_other_window, tui_ctlx_keymap);
 373   rl_bind_key_in_map ('q', tui_rl_next_keymap, tui_keymap);
 374   rl_bind_key_in_map ('s', tui_rl_next_keymap, emacs_ctlx_keymap);
 375   rl_bind_key_in_map ('s', tui_rl_next_keymap, tui_ctlx_keymap);
 376 }
 377
 378 /* Return the TERM variable from the environment, or "<unset>"
 379    if not set.  */
 380
 381 static const char *
 382 gdb_getenv_term (void)
 383 {
 384   const char *term;
 385
 386   term = getenv ("TERM");
 387   if (term != NULL)
 388     return term;
 389   return "<unset>";
 390 }
 391
 392 /* Enter in the tui mode (curses).
 393    When in normal mode, it installs the tui hooks in gdb, redirects
 394    the gdb output, configures the readline to work in tui mode.
 395    When in curses mode, it does nothing.  */
 396 void
 397 tui_enable (void)
 398 {
 399   struct interp *interp;
 400
 401   if (tui_active)
 402     return;
 403
 404   /* To avoid to initialize curses when gdb starts, there is a defered
 405      curses initialization.  This initialization is made only once
 406      and the first time the curses mode is entered.  */
 407   if (tui_finish_init)
 408     {
 409       WINDOW *w;
 410       SCREEN *s;
 411       const char *cap;
 412       const char *interp;
 413
 414       /* If the top level interpreter is not the console/tui (e.g.,
 415          MI), enabling curses will certainly lose.  */
 416       interp = interp_name (top_level_interpreter ());
 417       if (strcmp (interp, INTERP_TUI) != 0)
 418         error (_("Cannot enable the TUI when the interpreter is '%s'"), interp);
 419
 420       /* Don't try to setup curses (and print funny control
 421          characters) if we're not outputting to a terminal.  */
 422       if (!ui_file_isatty (gdb_stdout))
 423         error (_("Cannot enable the TUI when output is not a terminal"));
 424
 425       s = newterm (NULL, stdout, stdin);
 426 #ifdef __MINGW32__
 427       /* The MinGW port of ncurses requires $TERM to be unset in order
 428          to activate the Windows console driver.  */
 429       if (s == NULL)
 430         s = newterm ("unknown", stdout, stdin);
 431 #endif
 432       if (s == NULL)
 433         {
 434           error (_("Cannot enable the TUI: error opening terminal [TERM=%s]"),
 435                  gdb_getenv_term ());
 436         }
 437       w = stdscr;
 438
 439       /* Check required terminal capabilities.  The MinGW port of
 440          ncurses does have them, but doesn't expose them through "cup".  */
 441 #ifndef __MINGW32__
 442       cap = tigetstr ("cup");
 443       if (cap == NULL || cap == (char *) -1 || *cap == '\0')
 444         {
 445           endwin ();
 446           delscreen (s);
 447           error (_("Cannot enable the TUI: "
 448                    "terminal doesn't support cursor addressing [TERM=%s]"),
 449                  gdb_getenv_term ());
 450         }
 451 #endif
 452
 453       cbreak ();
 454       noecho ();
 455       /* timeout (1); */
 456       nodelay(w, FALSE);
 457       nl();
 458       keypad (w, TRUE);
 459       rl_initialize ();
 460       tui_set_term_height_to (LINES);
 461       tui_set_term_width_to (COLS);
 462       def_prog_mode ();
 463
 464       tui_show_frame_info (0);
 465       tui_set_layout (SRC_COMMAND);
 466       tui_set_win_focus_to (TUI_SRC_WIN);
 467       keypad (TUI_CMD_WIN->generic.handle, TRUE);
 468       wrefresh (TUI_CMD_WIN->generic.handle);
 469       tui_finish_init = 0;
 470     }
 471   else
 472     {
 473      /* Save the current gdb setting of the terminal.
 474         Curses will restore this state when endwin() is called.  */
 475      def_shell_mode ();
 476      clearok (stdscr, TRUE);
 477    }
 478
 479   /* Install the TUI specific hooks.  */
 480   tui_install_hooks ();
 481   rl_startup_hook = tui_rl_startup_hook;
 482
 483   tui_update_variables ();
 484
 485   tui_setup_io (1);
 486
 487   tui_active = 1;
 488
 489   /* Resize windows before anything might display/refresh a
 490      window.  */
 491   if (tui_win_resized ())
 492     {
 493       tui_set_win_resized_to (FALSE);
 494       tui_resize_all ();
 495     }
 496
 497   if (deprecated_safe_get_selected_frame ())
 498     tui_show_frame_info (deprecated_safe_get_selected_frame ());
 499
 500   /* Restore TUI keymap.  */
 501   tui_set_key_mode (tui_current_key_mode);
 502
 503   /* Refresh the screen.  */
 504   tui_refresh_all_win ();
 505
 506   /* Update gdb's knowledge of its terminal.  */
 507   gdb_save_tty_state ();
 508   tui_update_gdb_sizes ();
 509 }
 510
 511 /* Leave the tui mode.
 512    Remove the tui hooks and configure the gdb output and readline
 513    back to their original state.  The curses mode is left so that
 514    the terminal setting is restored to the point when we entered.  */
 515 void
 516 tui_disable (void)
 517 {
 518   if (!tui_active)
 519     return;
 520
 521   /* Restore initial readline keymap.  */
 522   rl_set_keymap (tui_readline_standard_keymap);
 523
 524   /* Remove TUI hooks.  */
 525   tui_remove_hooks ();
 526   rl_startup_hook = 0;
 527   rl_already_prompted = 0;
 528
 529   /* Leave curses and restore previous gdb terminal setting.  */
 530   endwin ();
 531
 532   /* gdb terminal has changed, update gdb internal copy of it
 533      so that terminal management with the inferior works.  */
 534   tui_setup_io (0);
 535
 536   /* Update gdb's knowledge of its terminal.  */
 537   gdb_save_tty_state ();
 538
 539   tui_active = 0;
 540   tui_update_gdb_sizes ();
 541 }
 542
 543 void
 544 strcat_to_buf (char *buf, int buflen,
 545                const char *item_to_add)
 546 {
 547   if (item_to_add != (char *) NULL && buf != (char *) NULL)
 548     {
 549       if ((strlen (buf) + strlen (item_to_add)) <= buflen)
 550         strcat (buf, item_to_add);
 551       else
 552         strncat (buf, item_to_add, (buflen - strlen (buf)));
 553     }
 554 }
 555
 556 #if 0
 557 /* Solaris <sys/termios.h> defines CTRL.  */
 558 #ifndef CTRL
 559 #define CTRL(x)         (x & ~0140)
 560 #endif
 561
 562 #define FILEDES         2
 563 #define CHK(val, dft)   (val<=0 ? dft : val)
 564
 565 static void
 566 tui_reset (void)
 567 {
 568   struct termio mode;
 569
 570   /* Reset the teletype mode bits to a sensible state.
 571      Copied tset.c.  */
 572 #if defined (TIOCGETC)
 573   struct tchars tbuf;
 574 #endif /* TIOCGETC */
 575 #ifdef UCB_NTTY
 576   struct ltchars ltc;
 577
 578   if (ldisc == NTTYDISC)
 579     {
 580       ioctl (FILEDES, TIOCGLTC, &ltc);
 581       ltc.t_suspc = CHK (ltc.t_suspc, CTRL ('Z'));
 582       ltc.t_dsuspc = CHK (ltc.t_dsuspc, CTRL ('Y'));
 583       ltc.t_rprntc = CHK (ltc.t_rprntc, CTRL ('R'));
 584       ltc.t_flushc = CHK (ltc.t_flushc, CTRL ('O'));
 585       ltc.t_werasc = CHK (ltc.t_werasc, CTRL ('W'));
 586       ltc.t_lnextc = CHK (ltc.t_lnextc, CTRL ('V'));
 587       ioctl (FILEDES, TIOCSLTC, &ltc);
 588     }
 589 #endif /* UCB_NTTY */
 590 #ifdef TIOCGETC
 591   ioctl (FILEDES, TIOCGETC, &tbuf);
 592   tbuf.t_intrc = CHK (tbuf.t_intrc, CTRL ('?'));
 593   tbuf.t_quitc = CHK (tbuf.t_quitc, CTRL ('\\'));
 594   tbuf.t_startc = CHK (tbuf.t_startc, CTRL ('Q'));
 595   tbuf.t_stopc = CHK (tbuf.t_stopc, CTRL ('S'));
 596   tbuf.t_eofc = CHK (tbuf.t_eofc, CTRL ('D'));
 597   /* brkc is left alone.  */
 598   ioctl (FILEDES, TIOCSETC, &tbuf);
 599 #endif /* TIOCGETC */
 600   mode.sg_flags &= ~(RAW
 601 #ifdef CBREAK
 602                      | CBREAK
 603 #endif /* CBREAK */
 604                      | VTDELAY | ALLDELAY);
 605   mode.sg_flags |= XTABS | ECHO | CRMOD | ANYP;
 606
 607   return;
 608 }
 609 #endif
 610
 611 void
 612 tui_show_source (const char *fullname, int line)
 613 {
 614   struct symtab_and_line cursal = get_current_source_symtab_and_line ();
 615
 616   /* Make sure that the source window is displayed.  */
 617   tui_add_win_to_layout (SRC_WIN);
 618
 619   tui_update_source_windows_with_line (cursal.symtab, line);
 620   tui_update_locator_fullname (fullname);
 621 }
 622
 623 void
 624 tui_show_assembly (struct gdbarch *gdbarch, CORE_ADDR addr)
 625 {
 626   tui_add_win_to_layout (DISASSEM_WIN);
 627   tui_update_source_windows_with_addr (gdbarch, addr);
 628 }
 629
 630 int
 631 tui_is_window_visible (enum tui_win_type type)
 632 {
 633   if (tui_active == 0)
 634     return 0;
 635
 636   if (tui_win_list[type] == 0)
 637     return 0;
 638
 639   return tui_win_list[type]->generic.is_visible;
 640 }
 641
 642 int
 643 tui_get_command_dimension (unsigned int *width,
 644                            unsigned int *height)
 645 {
 646   if (!tui_active || (TUI_CMD_WIN == NULL))
 647     {
 648       return 0;
 649     }
 650
 651   *width = TUI_CMD_WIN->generic.width;
 652   *height = TUI_CMD_WIN->generic.height;
 653   return 1;
 654 }