gdb/tui/tui.c

   1 /* General functions for the WDB TUI.
   2
   3    Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2007, 2008
   4    Free Software Foundation, Inc.
   5
   6    Contributed by Hewlett-Packard Company.
   7
   8    This file is part of GDB.
   9
  10    This program is free software; you can redistribute it and/or modify
  11    it under the terms of the GNU General Public License as published by
  12    the Free Software Foundation; either version 3 of the License, or
  13    (at your option) any later version.
  14
  15    This program is distributed in the hope that it will be useful,
  16    but WITHOUT ANY WARRANTY; without even the implied warranty of
  17    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18    GNU General Public License for more details.
  19
  20    You should have received a copy of the GNU General Public License
  21    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  22
  23 #include "defs.h"
  24 #include "gdbcmd.h"
  25 #include "tui/tui.h"
  26 #include "tui/tui-hooks.h"
  27 #include "tui/tui-data.h"
  28 #include "tui/tui-layout.h"
  29 #include "tui/tui-io.h"
  30 #include "tui/tui-regs.h"
  31 #include "tui/tui-stack.h"
  32 #include "tui/tui-win.h"
  33 #include "tui/tui-winsource.h"
  34 #include "tui/tui-windata.h"
  35 #include "target.h"
  36 #include "frame.h"
  37 #include "breakpoint.h"
  38 #include "inferior.h"
  39 #include "symtab.h"
  40 #include "source.h"
  41
  42 #include <stdio.h>
  43 #include <stdlib.h>
  44 #include <ctype.h>
  45 #include <signal.h>
  46 #include <fcntl.h>
  47 #if 0
  48 #include <termio.h>
  49 #endif
  50 #include <setjmp.h>
  51
  52 #include "gdb_curses.h"
  53
  54 /* This redefines CTRL if it is not already defined, so it must come
  55    after terminal state releated include files like <term.h> and
  56    "gdb_curses.h".  */
  57 #include "readline/readline.h"
  58
  59 /* Tells whether the TUI is active or not.  */
  60 int tui_active = 0;
  61 static int tui_finish_init = 1;
  62
  63 enum tui_key_mode tui_current_key_mode = TUI_COMMAND_MODE;
  64
  65 struct tui_char_command
  66 {
  67   unsigned char key;
  68   const char *cmd;
  69 };
  70
  71 /* Key mapping to gdb commands when the TUI is using the single key
  72    mode.  */
  73 static const struct tui_char_command tui_commands[] = {
  74   { 'c', "continue" },
  75   { 'd', "down" },
  76   { 'f', "finish" },
  77   { 'n', "next" },
  78   { 'r', "run" },
  79   { 's', "step" },
  80   { 'u', "up" },
  81   { 'v', "info locals" },
  82   { 'w', "where" },
  83   { 0, 0 },
  84 };
  85
  86 static Keymap tui_keymap;
  87 static Keymap tui_readline_standard_keymap;
  88
  89 /* TUI readline command.
  90    Switch the output mode between TUI/standard gdb.  */
  91 static int
  92 tui_rl_switch_mode (int notused1, int notused2)
  93 {
  94   if (tui_active)
  95     {
  96       tui_disable ();
  97       rl_prep_terminal (0);
  98     }
  99   else
 100     {
 101       rl_deprep_terminal ();
 102       tui_enable ();
 103     }
 104
 105   /* Clear the readline in case switching occurred in middle of
 106      something.  */
 107   if (rl_end)
 108     rl_kill_text (0, rl_end);
 109
 110   /* Since we left the curses mode, the terminal mode is restored to
 111      some previous state.  That state may not be suitable for readline
 112      to work correctly (it may be restored in line mode).  We force an
 113      exit of the current readline so that readline is re-entered and
 114      it will be able to setup the terminal for its needs.  By
 115      re-entering in readline, we also redisplay its prompt in the
 116      non-curses mode.  */
 117   rl_newline (1, '\n');
 118
 119   /* Make sure the \n we are returning does not repeat the last
 120      command.  */
 121   dont_repeat ();
 122   return 0;
 123 }
 124
 125 /* TUI readline command.
 126    Change the TUI layout to show a next layout.
 127    This function is bound to CTRL-X 2.  It is intended to provide
 128    a functionality close to the Emacs split-window command.  We
 129    always show two windows (src+asm), (src+regs) or (asm+regs).  */
 130 static int
 131 tui_rl_change_windows (int notused1, int notused2)
 132 {
 133   if (!tui_active)
 134     tui_rl_switch_mode (0 /* notused */, 0 /* notused */);
 135
 136   if (tui_active)
 137     {
 138       enum tui_layout_type new_layout;
 139       enum tui_register_display_type regs_type = TUI_UNDEFINED_REGS;
 140
 141       new_layout = tui_current_layout ();
 142
 143       /* Select a new layout to have a rolling layout behavior with
 144          always two windows (except when undefined).  */
 145       switch (new_layout)
 146         {
 147         case SRC_COMMAND:
 148           new_layout = SRC_DISASSEM_COMMAND;
 149           break;
 150
 151         case DISASSEM_COMMAND:
 152           new_layout = SRC_DISASSEM_COMMAND;
 153           break;
 154
 155         case SRC_DATA_COMMAND:
 156           new_layout = SRC_DISASSEM_COMMAND;
 157           break;
 158
 159         case SRC_DISASSEM_COMMAND:
 160           new_layout = DISASSEM_DATA_COMMAND;
 161           break;
 162
 163         case DISASSEM_DATA_COMMAND:
 164           new_layout = SRC_DATA_COMMAND;
 165           break;
 166
 167         default:
 168           new_layout = SRC_COMMAND;
 169           break;
 170         }
 171       tui_set_layout (new_layout, regs_type);
 172     }
 173   return 0;
 174 }
 175
 176 /* TUI readline command.
 177    Delete the second TUI window to only show one.  */
 178 static int
 179 tui_rl_delete_other_windows (int notused1, int notused2)
 180 {
 181   if (!tui_active)
 182     tui_rl_switch_mode (0 /* notused */, 0 /* notused */);
 183
 184   if (tui_active)
 185     {
 186       enum tui_layout_type new_layout;
 187       enum tui_register_display_type regs_type = TUI_UNDEFINED_REGS;
 188
 189       new_layout = tui_current_layout ();
 190
 191       /* Kill one window.  */
 192       switch (new_layout)
 193         {
 194         case SRC_COMMAND:
 195         case SRC_DATA_COMMAND:
 196         case SRC_DISASSEM_COMMAND:
 197         default:
 198           new_layout = SRC_COMMAND;
 199           break;
 200
 201         case DISASSEM_COMMAND:
 202         case DISASSEM_DATA_COMMAND:
 203           new_layout = DISASSEM_COMMAND;
 204           break;
 205         }
 206       tui_set_layout (new_layout, regs_type);
 207     }
 208   return 0;
 209 }
 210
 211 /* TUI readline command.
 212    Switch the active window to give the focus to a next window.  */
 213 static int
 214 tui_rl_other_window (int count, int key)
 215 {
 216   struct tui_win_info *win_info;
 217
 218   if (!tui_active)
 219     tui_rl_switch_mode (0 /* notused */, 0 /* notused */);
 220
 221   win_info = tui_next_win (tui_win_with_focus ());
 222   if (win_info)
 223     {
 224       tui_set_win_focus_to (win_info);
 225       if (TUI_DATA_WIN && TUI_DATA_WIN->generic.is_visible)
 226         tui_refresh_data_win ();
 227       keypad (TUI_CMD_WIN->generic.handle, (win_info != TUI_CMD_WIN));
 228     }
 229   return 0;
 230 }
 231
 232 /* TUI readline command.
 233    Execute the gdb command bound to the specified key.  */
 234 static int
 235 tui_rl_command_key (int count, int key)
 236 {
 237   int i;
 238
 239   reinitialize_more_filter ();
 240   for (i = 0; tui_commands[i].cmd; i++)
 241     {
 242       if (tui_commands[i].key == key)
 243         {
 244           /* Must save the command because it can be modified by
 245              execute_command.  */
 246           char *cmd = alloca (strlen (tui_commands[i].cmd) + 1);
 247           strcpy (cmd, tui_commands[i].cmd);
 248           execute_command (cmd, TRUE);
 249           return 0;
 250         }
 251     }
 252   return 0;
 253 }
 254
 255 /* TUI readline command.
 256    Temporarily leave the TUI SingleKey mode to allow editing
 257    a gdb command with the normal readline.  Once the command
 258    is executed, the TUI SingleKey mode is installed back.  */
 259 static int
 260 tui_rl_command_mode (int count, int key)
 261 {
 262   tui_set_key_mode (TUI_ONE_COMMAND_MODE);
 263   return rl_insert (count, key);
 264 }
 265
 266 /* TUI readline command.
 267    Switch between TUI SingleKey mode and gdb readline editing.  */
 268 static int
 269 tui_rl_next_keymap (int notused1, int notused2)
 270 {
 271   if (!tui_active)
 272     tui_rl_switch_mode (0 /* notused */, 0 /* notused */);
 273
 274   tui_set_key_mode (tui_current_key_mode == TUI_COMMAND_MODE
 275                     ? TUI_SINGLE_KEY_MODE : TUI_COMMAND_MODE);
 276   return 0;
 277 }
 278
 279 /* Readline hook to redisplay ourself the gdb prompt.
 280    In the SingleKey mode, the prompt is not printed so that
 281    the command window is cleaner.  It will be displayed if
 282    we temporarily leave the SingleKey mode.  */
 283 static int
 284 tui_rl_startup_hook (void)
 285 {
 286   rl_already_prompted = 1;
 287   if (tui_current_key_mode != TUI_COMMAND_MODE)
 288     tui_set_key_mode (TUI_SINGLE_KEY_MODE);
 289   tui_redisplay_readline ();
 290   return 0;
 291 }
 292
 293 /* Change the TUI key mode by installing the appropriate readline
 294    keymap.  */
 295 void
 296 tui_set_key_mode (enum tui_key_mode mode)
 297 {
 298   tui_current_key_mode = mode;
 299   rl_set_keymap (mode == TUI_SINGLE_KEY_MODE
 300                  ? tui_keymap : tui_readline_standard_keymap);
 301   tui_show_locator_content ();
 302 }
 303
 304 /* Initialize readline and configure the keymap for the switching
 305    key shortcut.  */
 306 void
 307 tui_initialize_readline (void)
 308 {
 309   int i;
 310   Keymap tui_ctlx_keymap;
 311
 312   rl_initialize ();
 313
 314   rl_add_defun ("tui-switch-mode", tui_rl_switch_mode, -1);
 315   rl_add_defun ("gdb-command", tui_rl_command_key, -1);
 316   rl_add_defun ("next-keymap", tui_rl_next_keymap, -1);
 317
 318   tui_keymap = rl_make_bare_keymap ();
 319   tui_ctlx_keymap = rl_make_bare_keymap ();
 320   tui_readline_standard_keymap = rl_get_keymap ();
 321
 322   for (i = 0; tui_commands[i].cmd; i++)
 323     rl_bind_key_in_map (tui_commands[i].key, tui_rl_command_key, tui_keymap);
 324
 325   rl_generic_bind (ISKMAP, "\\C-x", (char*) tui_ctlx_keymap, tui_keymap);
 326
 327   /* Bind all other keys to tui_rl_command_mode so that we switch
 328      temporarily from SingleKey mode and can enter a gdb command.  */
 329   for (i = ' '; i < 0x7f; i++)
 330     {
 331       int j;
 332
 333       for (j = 0; tui_commands[j].cmd; j++)
 334         if (tui_commands[j].key == i)
 335           break;
 336
 337       if (tui_commands[j].cmd)
 338         continue;
 339
 340       rl_bind_key_in_map (i, tui_rl_command_mode, tui_keymap);
 341     }
 342
 343   rl_bind_key_in_map ('a', tui_rl_switch_mode, emacs_ctlx_keymap);
 344   rl_bind_key_in_map ('a', tui_rl_switch_mode, tui_ctlx_keymap);
 345   rl_bind_key_in_map ('A', tui_rl_switch_mode, emacs_ctlx_keymap);
 346   rl_bind_key_in_map ('A', tui_rl_switch_mode, tui_ctlx_keymap);
 347   rl_bind_key_in_map (CTRL ('A'), tui_rl_switch_mode, emacs_ctlx_keymap);
 348   rl_bind_key_in_map (CTRL ('A'), tui_rl_switch_mode, tui_ctlx_keymap);
 349   rl_bind_key_in_map ('1', tui_rl_delete_other_windows, emacs_ctlx_keymap);
 350   rl_bind_key_in_map ('1', tui_rl_delete_other_windows, tui_ctlx_keymap);
 351   rl_bind_key_in_map ('2', tui_rl_change_windows, emacs_ctlx_keymap);
 352   rl_bind_key_in_map ('2', tui_rl_change_windows, tui_ctlx_keymap);
 353   rl_bind_key_in_map ('o', tui_rl_other_window, emacs_ctlx_keymap);
 354   rl_bind_key_in_map ('o', tui_rl_other_window, tui_ctlx_keymap);
 355   rl_bind_key_in_map ('q', tui_rl_next_keymap, tui_keymap);
 356   rl_bind_key_in_map ('s', tui_rl_next_keymap, emacs_ctlx_keymap);
 357   rl_bind_key_in_map ('s', tui_rl_next_keymap, tui_ctlx_keymap);
 358 }
 359
 360 /* Enter in the tui mode (curses).
 361    When in normal mode, it installs the tui hooks in gdb, redirects
 362    the gdb output, configures the readline to work in tui mode.
 363    When in curses mode, it does nothing.  */
 364 void
 365 tui_enable (void)
 366 {
 367   if (tui_active)
 368     return;
 369
 370   /* To avoid to initialize curses when gdb starts, there is a defered
 371      curses initialization.  This initialization is made only once
 372      and the first time the curses mode is entered.  */
 373   if (tui_finish_init)
 374     {
 375       WINDOW *w;
 376
 377       w = initscr ();
 378
 379       cbreak ();
 380       noecho ();
 381       /* timeout (1); */
 382       nodelay(w, FALSE);
 383       nl();
 384       keypad (w, TRUE);
 385       rl_initialize ();
 386       tui_set_term_height_to (LINES);
 387       tui_set_term_width_to (COLS);
 388       def_prog_mode ();
 389
 390       tui_show_frame_info (0);
 391       tui_set_layout (SRC_COMMAND, TUI_UNDEFINED_REGS);
 392       tui_set_win_focus_to (TUI_SRC_WIN);
 393       keypad (TUI_CMD_WIN->generic.handle, TRUE);
 394       wrefresh (TUI_CMD_WIN->generic.handle);
 395       tui_finish_init = 0;
 396     }
 397   else
 398     {
 399      /* Save the current gdb setting of the terminal.
 400         Curses will restore this state when endwin() is called.  */
 401      def_shell_mode ();
 402      clearok (stdscr, TRUE);
 403    }
 404
 405   /* Install the TUI specific hooks.  */
 406   tui_install_hooks ();
 407   rl_startup_hook = tui_rl_startup_hook;
 408
 409   tui_update_variables ();
 410
 411   tui_setup_io (1);
 412
 413   tui_active = 1;
 414   if (deprecated_safe_get_selected_frame ())
 415      tui_show_frame_info (deprecated_safe_get_selected_frame ());
 416
 417   /* Restore TUI keymap.  */
 418   tui_set_key_mode (tui_current_key_mode);
 419   tui_refresh_all_win ();
 420
 421   /* Update gdb's knowledge of its terminal.  */
 422   target_terminal_save_ours ();
 423   tui_update_gdb_sizes ();
 424 }
 425
 426 /* Leave the tui mode.
 427    Remove the tui hooks and configure the gdb output and readline
 428    back to their original state.  The curses mode is left so that
 429    the terminal setting is restored to the point when we entered.  */
 430 void
 431 tui_disable (void)
 432 {
 433   if (!tui_active)
 434     return;
 435
 436   /* Restore initial readline keymap.  */
 437   rl_set_keymap (tui_readline_standard_keymap);
 438
 439   /* Remove TUI hooks.  */
 440   tui_remove_hooks ();
 441   rl_startup_hook = 0;
 442   rl_already_prompted = 0;
 443
 444   /* Leave curses and restore previous gdb terminal setting.  */
 445   endwin ();
 446
 447   /* gdb terminal has changed, update gdb internal copy of it
 448      so that terminal management with the inferior works.  */
 449   tui_setup_io (0);
 450
 451   /* Update gdb's knowledge of its terminal.  */
 452   target_terminal_save_ours ();
 453
 454   tui_active = 0;
 455   tui_update_gdb_sizes ();
 456 }
 457
 458 void
 459 strcat_to_buf (char *buf, int buflen,
 460                const char *item_to_add)
 461 {
 462   if (item_to_add != (char *) NULL && buf != (char *) NULL)
 463     {
 464       if ((strlen (buf) + strlen (item_to_add)) <= buflen)
 465         strcat (buf, item_to_add);
 466       else
 467         strncat (buf, item_to_add, (buflen - strlen (buf)));
 468     }
 469 }
 470
 471 #if 0
 472 /* Solaris <sys/termios.h> defines CTRL.  */
 473 #ifndef CTRL
 474 #define CTRL(x)         (x & ~0140)
 475 #endif
 476
 477 #define FILEDES         2
 478 #define CHK(val, dft)   (val<=0 ? dft : val)
 479
 480 static void
 481 tui_reset (void)
 482 {
 483   struct termio mode;
 484
 485   /* Reset the teletype mode bits to a sensible state.
 486      Copied tset.c.  */
 487 #if defined (TIOCGETC)
 488   struct tchars tbuf;
 489 #endif /* TIOCGETC */
 490 #ifdef UCB_NTTY
 491   struct ltchars ltc;
 492
 493   if (ldisc == NTTYDISC)
 494     {
 495       ioctl (FILEDES, TIOCGLTC, &ltc);
 496       ltc.t_suspc = CHK (ltc.t_suspc, CTRL ('Z'));
 497       ltc.t_dsuspc = CHK (ltc.t_dsuspc, CTRL ('Y'));
 498       ltc.t_rprntc = CHK (ltc.t_rprntc, CTRL ('R'));
 499       ltc.t_flushc = CHK (ltc.t_flushc, CTRL ('O'));
 500       ltc.t_werasc = CHK (ltc.t_werasc, CTRL ('W'));
 501       ltc.t_lnextc = CHK (ltc.t_lnextc, CTRL ('V'));
 502       ioctl (FILEDES, TIOCSLTC, &ltc);
 503     }
 504 #endif /* UCB_NTTY */
 505 #ifdef TIOCGETC
 506   ioctl (FILEDES, TIOCGETC, &tbuf);
 507   tbuf.t_intrc = CHK (tbuf.t_intrc, CTRL ('?'));
 508   tbuf.t_quitc = CHK (tbuf.t_quitc, CTRL ('\\'));
 509   tbuf.t_startc = CHK (tbuf.t_startc, CTRL ('Q'));
 510   tbuf.t_stopc = CHK (tbuf.t_stopc, CTRL ('S'));
 511   tbuf.t_eofc = CHK (tbuf.t_eofc, CTRL ('D'));
 512   /* brkc is left alone.  */
 513   ioctl (FILEDES, TIOCSETC, &tbuf);
 514 #endif /* TIOCGETC */
 515   mode.sg_flags &= ~(RAW
 516 #ifdef CBREAK
 517                      | CBREAK
 518 #endif /* CBREAK */
 519                      | VTDELAY | ALLDELAY);
 520   mode.sg_flags |= XTABS | ECHO | CRMOD | ANYP;
 521
 522   return;
 523 }
 524 #endif
 525
 526 void
 527 tui_show_source (const char *file, int line)
 528 {
 529   struct symtab_and_line cursal = get_current_source_symtab_and_line ();
 530   /* Make sure that the source window is displayed.  */
 531   tui_add_win_to_layout (SRC_WIN);
 532
 533   tui_update_source_windows_with_line (cursal.symtab, line);
 534   tui_update_locator_filename (file);
 535 }
 536
 537 void
 538 tui_show_assembly (CORE_ADDR addr)
 539 {
 540   tui_add_win_to_layout (DISASSEM_WIN);
 541   tui_update_source_windows_with_addr (addr);
 542 }
 543
 544 int
 545 tui_is_window_visible (enum tui_win_type type)
 546 {
 547   if (tui_active == 0)
 548     return 0;
 549
 550   if (tui_win_list[type] == 0)
 551     return 0;
 552
 553   return tui_win_list[type]->generic.is_visible;
 554 }
 555
 556 int
 557 tui_get_command_dimension (unsigned int *width,
 558                            unsigned int *height)
 559 {
 560   if (!tui_active || (TUI_CMD_WIN == NULL))
 561     {
 562       return 0;
 563     }
 564
 565   *width = TUI_CMD_WIN->generic.width;
 566   *height = TUI_CMD_WIN->generic.height;
 567   return 1;
 568 }