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