gdb/tui/tui.c

   1 /* General functions for the WDB TUI.
   2
   3    Copyright (C) 1998-2004, 2007-2012 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
  41 #include <stdio.h>
  42 #include <stdlib.h>
  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
  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           return 0;
 251         }
 252     }
 253   return 0;
 254 }
 255
 256 /* TUI readline command.
 257    Temporarily leave the TUI SingleKey mode to allow editing
 258    a gdb command with the normal readline.  Once the command
 259    is executed, the TUI SingleKey mode is installed back.  */
 260 static int
 261 tui_rl_command_mode (int count, int key)
 262 {
 263   tui_set_key_mode (TUI_ONE_COMMAND_MODE);
 264   return rl_insert (count, key);
 265 }
 266
 267 /* TUI readline command.
 268    Switch between TUI SingleKey mode and gdb readline editing.  */
 269 static int
 270 tui_rl_next_keymap (int notused1, int notused2)
 271 {
 272   if (!tui_active)
 273     tui_rl_switch_mode (0 /* notused */, 0 /* notused */);
 274
 275   tui_set_key_mode (tui_current_key_mode == TUI_COMMAND_MODE
 276                     ? TUI_SINGLE_KEY_MODE : TUI_COMMAND_MODE);
 277   return 0;
 278 }
 279
 280 /* Readline hook to redisplay ourself the gdb prompt.
 281    In the SingleKey mode, the prompt is not printed so that
 282    the command window is cleaner.  It will be displayed if
 283    we temporarily leave the SingleKey mode.  */
 284 static int
 285 tui_rl_startup_hook (void)
 286 {
 287   rl_already_prompted = 1;
 288   if (tui_current_key_mode != TUI_COMMAND_MODE)
 289     tui_set_key_mode (TUI_SINGLE_KEY_MODE);
 290   tui_redisplay_readline ();
 291   return 0;
 292 }
 293
 294 /* Change the TUI key mode by installing the appropriate readline
 295    keymap.  */
 296 void
 297 tui_set_key_mode (enum tui_key_mode mode)
 298 {
 299   tui_current_key_mode = mode;
 300   rl_set_keymap (mode == TUI_SINGLE_KEY_MODE
 301                  ? tui_keymap : tui_readline_standard_keymap);
 302   tui_show_locator_content ();
 303 }
 304
 305 /* Initialize readline and configure the keymap for the switching
 306    key shortcut.  */
 307 void
 308 tui_initialize_readline (void)
 309 {
 310   int i;
 311   Keymap tui_ctlx_keymap;
 312
 313   rl_initialize ();
 314
 315   rl_add_defun ("tui-switch-mode", tui_rl_switch_mode, -1);
 316   rl_add_defun ("gdb-command", tui_rl_command_key, -1);
 317   rl_add_defun ("next-keymap", tui_rl_next_keymap, -1);
 318
 319   tui_keymap = rl_make_bare_keymap ();
 320   tui_ctlx_keymap = rl_make_bare_keymap ();
 321   tui_readline_standard_keymap = rl_get_keymap ();
 322
 323   for (i = 0; tui_commands[i].cmd; i++)
 324     rl_bind_key_in_map (tui_commands[i].key, tui_rl_command_key, tui_keymap);
 325
 326   rl_generic_bind (ISKMAP, "\\C-x", (char*) tui_ctlx_keymap, tui_keymap);
 327
 328   /* Bind all other keys to tui_rl_command_mode so that we switch
 329      temporarily from SingleKey mode and can enter a gdb command.  */
 330   for (i = ' '; i < 0x7f; i++)
 331     {
 332       int j;
 333
 334       for (j = 0; tui_commands[j].cmd; j++)
 335         if (tui_commands[j].key == i)
 336           break;
 337
 338       if (tui_commands[j].cmd)
 339         continue;
 340
 341       rl_bind_key_in_map (i, tui_rl_command_mode, tui_keymap);
 342     }
 343
 344   rl_bind_key_in_map ('a', tui_rl_switch_mode, emacs_ctlx_keymap);
 345   rl_bind_key_in_map ('a', tui_rl_switch_mode, tui_ctlx_keymap);
 346   rl_bind_key_in_map ('A', tui_rl_switch_mode, emacs_ctlx_keymap);
 347   rl_bind_key_in_map ('A', tui_rl_switch_mode, tui_ctlx_keymap);
 348   rl_bind_key_in_map (CTRL ('A'), tui_rl_switch_mode, emacs_ctlx_keymap);
 349   rl_bind_key_in_map (CTRL ('A'), tui_rl_switch_mode, tui_ctlx_keymap);
 350   rl_bind_key_in_map ('1', tui_rl_delete_other_windows, emacs_ctlx_keymap);
 351   rl_bind_key_in_map ('1', tui_rl_delete_other_windows, tui_ctlx_keymap);
 352   rl_bind_key_in_map ('2', tui_rl_change_windows, emacs_ctlx_keymap);
 353   rl_bind_key_in_map ('2', tui_rl_change_windows, tui_ctlx_keymap);
 354   rl_bind_key_in_map ('o', tui_rl_other_window, emacs_ctlx_keymap);
 355   rl_bind_key_in_map ('o', tui_rl_other_window, tui_ctlx_keymap);
 356   rl_bind_key_in_map ('q', tui_rl_next_keymap, tui_keymap);
 357   rl_bind_key_in_map ('s', tui_rl_next_keymap, emacs_ctlx_keymap);
 358   rl_bind_key_in_map ('s', tui_rl_next_keymap, tui_ctlx_keymap);
 359 }
 360
 361 /* Enter in the tui mode (curses).
 362    When in normal mode, it installs the tui hooks in gdb, redirects
 363    the gdb output, configures the readline to work in tui mode.
 364    When in curses mode, it does nothing.  */
 365 void
 366 tui_enable (void)
 367 {
 368   if (!tui_allowed_p ())
 369     error (_("TUI mode not allowed"));
 370
 371   if (tui_active)
 372     return;
 373
 374   /* To avoid to initialize curses when gdb starts, there is a defered
 375      curses initialization.  This initialization is made only once
 376      and the first time the curses mode is entered.  */
 377   if (tui_finish_init)
 378     {
 379       WINDOW *w;
 380
 381       w = initscr ();
 382
 383       cbreak ();
 384       noecho ();
 385       /* timeout (1); */
 386       nodelay(w, FALSE);
 387       nl();
 388       keypad (w, TRUE);
 389       rl_initialize ();
 390       tui_set_term_height_to (LINES);
 391       tui_set_term_width_to (COLS);
 392       def_prog_mode ();
 393
 394       tui_show_frame_info (0);
 395       tui_set_layout (SRC_COMMAND, TUI_UNDEFINED_REGS);
 396       tui_set_win_focus_to (TUI_SRC_WIN);
 397       keypad (TUI_CMD_WIN->generic.handle, TRUE);
 398       wrefresh (TUI_CMD_WIN->generic.handle);
 399       tui_finish_init = 0;
 400     }
 401   else
 402     {
 403      /* Save the current gdb setting of the terminal.
 404         Curses will restore this state when endwin() is called.  */
 405      def_shell_mode ();
 406      clearok (stdscr, TRUE);
 407    }
 408
 409   /* Install the TUI specific hooks.  */
 410   tui_install_hooks ();
 411   rl_startup_hook = tui_rl_startup_hook;
 412
 413   tui_update_variables ();
 414
 415   tui_setup_io (1);
 416
 417   tui_active = 1;
 418   if (deprecated_safe_get_selected_frame ())
 419      tui_show_frame_info (deprecated_safe_get_selected_frame ());
 420
 421   /* Restore TUI keymap.  */
 422   tui_set_key_mode (tui_current_key_mode);
 423   tui_refresh_all_win ();
 424
 425   /* Update gdb's knowledge of its terminal.  */
 426   target_terminal_save_ours ();
 427   tui_update_gdb_sizes ();
 428 }
 429
 430 /* Leave the tui mode.
 431    Remove the tui hooks and configure the gdb output and readline
 432    back to their original state.  The curses mode is left so that
 433    the terminal setting is restored to the point when we entered.  */
 434 void
 435 tui_disable (void)
 436 {
 437   if (!tui_active)
 438     return;
 439
 440   /* Restore initial readline keymap.  */
 441   rl_set_keymap (tui_readline_standard_keymap);
 442
 443   /* Remove TUI hooks.  */
 444   tui_remove_hooks ();
 445   rl_startup_hook = 0;
 446   rl_already_prompted = 0;
 447
 448   /* Leave curses and restore previous gdb terminal setting.  */
 449   endwin ();
 450
 451   /* gdb terminal has changed, update gdb internal copy of it
 452      so that terminal management with the inferior works.  */
 453   tui_setup_io (0);
 454
 455   /* Update gdb's knowledge of its terminal.  */
 456   target_terminal_save_ours ();
 457
 458   tui_active = 0;
 459   tui_update_gdb_sizes ();
 460 }
 461
 462 void
 463 strcat_to_buf (char *buf, int buflen,
 464                const char *item_to_add)
 465 {
 466   if (item_to_add != (char *) NULL && buf != (char *) NULL)
 467     {
 468       if ((strlen (buf) + strlen (item_to_add)) <= buflen)
 469         strcat (buf, item_to_add);
 470       else
 471         strncat (buf, item_to_add, (buflen - strlen (buf)));
 472     }
 473 }
 474
 475 #if 0
 476 /* Solaris <sys/termios.h> defines CTRL.  */
 477 #ifndef CTRL
 478 #define CTRL(x)         (x & ~0140)
 479 #endif
 480
 481 #define FILEDES         2
 482 #define CHK(val, dft)   (val<=0 ? dft : val)
 483
 484 static void
 485 tui_reset (void)
 486 {
 487   struct termio mode;
 488
 489   /* Reset the teletype mode bits to a sensible state.
 490      Copied tset.c.  */
 491 #if defined (TIOCGETC)
 492   struct tchars tbuf;
 493 #endif /* TIOCGETC */
 494 #ifdef UCB_NTTY
 495   struct ltchars ltc;
 496
 497   if (ldisc == NTTYDISC)
 498     {
 499       ioctl (FILEDES, TIOCGLTC, &ltc);
 500       ltc.t_suspc = CHK (ltc.t_suspc, CTRL ('Z'));
 501       ltc.t_dsuspc = CHK (ltc.t_dsuspc, CTRL ('Y'));
 502       ltc.t_rprntc = CHK (ltc.t_rprntc, CTRL ('R'));
 503       ltc.t_flushc = CHK (ltc.t_flushc, CTRL ('O'));
 504       ltc.t_werasc = CHK (ltc.t_werasc, CTRL ('W'));
 505       ltc.t_lnextc = CHK (ltc.t_lnextc, CTRL ('V'));
 506       ioctl (FILEDES, TIOCSLTC, &ltc);
 507     }
 508 #endif /* UCB_NTTY */
 509 #ifdef TIOCGETC
 510   ioctl (FILEDES, TIOCGETC, &tbuf);
 511   tbuf.t_intrc = CHK (tbuf.t_intrc, CTRL ('?'));
 512   tbuf.t_quitc = CHK (tbuf.t_quitc, CTRL ('\\'));
 513   tbuf.t_startc = CHK (tbuf.t_startc, CTRL ('Q'));
 514   tbuf.t_stopc = CHK (tbuf.t_stopc, CTRL ('S'));
 515   tbuf.t_eofc = CHK (tbuf.t_eofc, CTRL ('D'));
 516   /* brkc is left alone.  */
 517   ioctl (FILEDES, TIOCSETC, &tbuf);
 518 #endif /* TIOCGETC */
 519   mode.sg_flags &= ~(RAW
 520 #ifdef CBREAK
 521                      | CBREAK
 522 #endif /* CBREAK */
 523                      | VTDELAY | ALLDELAY);
 524   mode.sg_flags |= XTABS | ECHO | CRMOD | ANYP;
 525
 526   return;
 527 }
 528 #endif
 529
 530 void
 531 tui_show_source (const char *file, int line)
 532 {
 533   struct symtab_and_line cursal = get_current_source_symtab_and_line ();
 534
 535   /* Make sure that the source window is displayed.  */
 536   tui_add_win_to_layout (SRC_WIN);
 537
 538   tui_update_source_windows_with_line (cursal.symtab, line);
 539   tui_update_locator_filename (file);
 540 }
 541
 542 void
 543 tui_show_assembly (struct gdbarch *gdbarch, CORE_ADDR addr)
 544 {
 545   tui_add_win_to_layout (DISASSEM_WIN);
 546   tui_update_source_windows_with_addr (gdbarch, addr);
 547 }
 548
 549 int
 550 tui_is_window_visible (enum tui_win_type type)
 551 {
 552   if (tui_active == 0)
 553     return 0;
 554
 555   if (tui_win_list[type] == 0)
 556     return 0;
 557
 558   return tui_win_list[type]->generic.is_visible;
 559 }
 560
 561 int
 562 tui_get_command_dimension (unsigned int *width,
 563                            unsigned int *height)
 564 {
 565   if (!tui_active || (TUI_CMD_WIN == NULL))
 566     {
 567       return 0;
 568     }
 569
 570   *width = TUI_CMD_WIN->generic.width;
 571   *height = TUI_CMD_WIN->generic.height;
 572   return 1;
 573 }