gdb/tui/tui.c

   1 /* General functions for the WDB TUI.
   2
   3    Copyright (C) 1998-2024 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 "event-top.h"
  23 #include "cli/cli-cmds.h"
  24 #include "exceptions.h"
  25 #include "tui/tui.h"
  26 #include "tui/tui-hooks.h"
  27 #include "tui/tui-command.h"
  28 #include "tui/tui-data.h"
  29 #include "tui/tui-layout.h"
  30 #include "tui/tui-io.h"
  31 #include "tui/tui-status.h"
  32 #include "tui/tui-win.h"
  33 #include "tui/tui-wingeneral.h"
  34 #include "tui/tui-winsource.h"
  35 #include "tui/tui-source.h"
  36 #include "target.h"
  37 #include "frame.h"
  38 #include "inferior.h"
  39 #include "symtab.h"
  40 #include "terminal.h"
  41 #include "top.h"
  42 #include "ui.h"
  43 #include "observable.h"
  44
  45 #include <fcntl.h>
  46
  47 #include "gdb_curses.h"
  48 #include "interps.h"
  49
  50 /* See tui.h.  */
  51
  52 bool debug_tui = false;
  53
  54 /* Implement 'show debug tui'.  */
  55
  56 static void
  57 show_tui_debug (struct ui_file *file, int from_tty,
  58                 struct cmd_list_element *c, const char *value)
  59 {
  60   gdb_printf (file, _("TUI debugging is \"%s\".\n"), value);
  61 }
  62
  63 /* This redefines CTRL if it is not already defined, so it must come
  64    after terminal state releated include files like <term.h> and
  65    "gdb_curses.h".  */
  66 #include "readline/readline.h"
  67
  68 /* Tells whether the TUI is active or not.  */
  69 bool tui_active = false;
  70 static bool tui_finish_init = true;
  71
  72 enum tui_key_mode tui_current_key_mode = TUI_COMMAND_MODE;
  73
  74 struct tui_char_command
  75 {
  76   unsigned char key;
  77   const char *cmd;
  78 };
  79
  80 /* Key mapping to gdb commands when the TUI is using the single key
  81    mode.  */
  82 static const struct tui_char_command tui_commands[] = {
  83   { 'c', "continue" },
  84   { 'C', "reverse-continue" },
  85   { 'd', "down" },
  86   { 'f', "finish" },
  87   { 'F', "reverse-finish" },
  88   { 'n', "next" },
  89   { 'N', "reverse-next" },
  90   { 'o', "nexti" },
  91   { 'O', "reverse-nexti" },
  92   { 'r', "run" },
  93   { 's', "step" },
  94   { 'S', "reverse-step" },
  95   { 'i', "stepi" },
  96   { 'I', "reverse-stepi" },
  97   { 'u', "up" },
  98   { 'v', "info locals" },
  99   { 'w', "where" },
 100   { 0, 0 },
 101 };
 102
 103 static Keymap tui_keymap;
 104 static Keymap tui_readline_standard_keymap;
 105
 106 /* TUI readline command.
 107    Switch the output mode between TUI/standard gdb.  */
 108 static int
 109 tui_rl_switch_mode (int notused1, int notused2)
 110 {
 111
 112   /* Don't let exceptions escape.  We're in the middle of a readline
 113      callback that isn't prepared for that.  */
 114   try
 115     {
 116       if (tui_active)
 117         {
 118           tui_disable ();
 119           rl_prep_terminal (0);
 120         }
 121       else
 122         {
 123           /* If tui_enable throws, we'll re-prep below.  */
 124           rl_deprep_terminal ();
 125           tui_enable ();
 126         }
 127     }
 128   catch (const gdb_exception_forced_quit &ex)
 129     {
 130       /* Ideally, we'd do a 'throw' here, but as noted above, we can't
 131          do that, so, instead, we'll set the necessary flags so that
 132          a later QUIT check will restart the forced quit.  */
 133       set_force_quit_flag ();
 134     }
 135   catch (const gdb_exception &ex)
 136     {
 137       exception_print (gdb_stderr, ex);
 138
 139       if (!tui_active)
 140         rl_prep_terminal (0);
 141     }
 142
 143   /* Clear the readline in case switching occurred in middle of
 144      something.  */
 145   if (rl_end)
 146     rl_kill_text (0, rl_end);
 147
 148   /* Since we left the curses mode, the terminal mode is restored to
 149      some previous state.  That state may not be suitable for readline
 150      to work correctly (it may be restored in line mode).  We force an
 151      exit of the current readline so that readline is re-entered and
 152      it will be able to setup the terminal for its needs.  By
 153      re-entering in readline, we also redisplay its prompt in the
 154      non-curses mode.  */
 155   rl_newline (1, '\n');
 156
 157   /* Make sure the \n we are returning does not repeat the last
 158      command.  */
 159   dont_repeat ();
 160   return 0;
 161 }
 162
 163 /* TUI readline command.
 164    Change the TUI layout to show a next layout.
 165    This function is bound to CTRL-X 2.  It is intended to provide
 166    a functionality close to the Emacs split-window command.  */
 167 static int
 168 tui_rl_change_windows (int notused1, int notused2)
 169 {
 170   if (!tui_active)
 171     tui_rl_switch_mode (0 /* notused */, 0 /* notused */);
 172
 173   if (tui_active)
 174     tui_next_layout ();
 175
 176   return 0;
 177 }
 178
 179 /* TUI readline command.
 180    Delete the second TUI window to only show one.  */
 181 static int
 182 tui_rl_delete_other_windows (int notused1, int notused2)
 183 {
 184   if (!tui_active)
 185     tui_rl_switch_mode (0 /* notused */, 0 /* notused */);
 186
 187   if (tui_active)
 188     tui_remove_some_windows ();
 189
 190   return 0;
 191 }
 192
 193 /* TUI readline command.
 194    Switch the active window to give the focus to a next window.  */
 195 static int
 196 tui_rl_other_window (int count, int key)
 197 {
 198   struct tui_win_info *win_info;
 199
 200   if (!tui_active)
 201     tui_rl_switch_mode (0 /* notused */, 0 /* notused */);
 202
 203   win_info = tui_next_win (tui_win_with_focus ());
 204   if (win_info)
 205     tui_set_win_focus_to (win_info);
 206   return 0;
 207 }
 208
 209 /* TUI readline command.
 210    Execute the gdb command bound to the specified key.  */
 211 static int
 212 tui_rl_command_key (int count, int key)
 213 {
 214   int i;
 215
 216   reinitialize_more_filter ();
 217   for (i = 0; tui_commands[i].cmd; i++)
 218     {
 219       if (tui_commands[i].key == key)
 220         {
 221           /* Insert the command in the readline buffer.
 222              Avoid calling the gdb command here since it creates
 223              a possible recursion on readline if prompt_for_continue
 224              is called (See PR 9584).  The command will also appear
 225              in the readline history which turns out to be better.  */
 226           rl_insert_text (tui_commands[i].cmd);
 227           rl_newline (1, '\n');
 228
 229           /* Switch to gdb command mode while executing the command.
 230              This way the gdb's continue prompt will be displayed.  */
 231           tui_set_key_mode (TUI_ONE_COMMAND_MODE);
 232           return 0;
 233         }
 234     }
 235   return 0;
 236 }
 237
 238 /* TUI readline command.
 239    Temporarily leave the TUI SingleKey mode to allow editing
 240    a gdb command with the normal readline.  Once the command
 241    is executed, the TUI SingleKey mode is installed back.  */
 242 static int
 243 tui_rl_command_mode (int count, int key)
 244 {
 245   tui_set_key_mode (TUI_ONE_COMMAND_MODE);
 246   return rl_insert (count, key);
 247 }
 248
 249 /* TUI readline command.
 250    Switch between TUI SingleKey mode and gdb readline editing.  */
 251 static int
 252 tui_rl_next_keymap (int notused1, int notused2)
 253 {
 254   if (!tui_active)
 255     tui_rl_switch_mode (0 /* notused */, 0 /* notused */);
 256
 257   if (rl_end)
 258     {
 259       rl_end = 0;
 260       rl_point = 0;
 261       rl_mark = 0;
 262     }
 263
 264   tui_set_key_mode (tui_current_key_mode == TUI_COMMAND_MODE
 265                     ? TUI_SINGLE_KEY_MODE : TUI_COMMAND_MODE);
 266   return 0;
 267 }
 268
 269 /* Readline hook to redisplay ourself the gdb prompt.
 270    In the SingleKey mode, the prompt is not printed so that
 271    the command window is cleaner.  It will be displayed if
 272    we temporarily leave the SingleKey mode.  */
 273 static int
 274 tui_rl_startup_hook (void)
 275 {
 276   if (tui_current_key_mode != TUI_COMMAND_MODE
 277       && !gdb_in_secondary_prompt_p (current_ui))
 278     tui_set_key_mode (TUI_SINGLE_KEY_MODE);
 279   return 0;
 280 }
 281
 282 /* Change the TUI key mode by installing the appropriate readline
 283    keymap.  */
 284 void
 285 tui_set_key_mode (enum tui_key_mode mode)
 286 {
 287   tui_current_key_mode = mode;
 288   rl_set_keymap (mode == TUI_SINGLE_KEY_MODE
 289                  ? tui_keymap : tui_readline_standard_keymap);
 290   tui_show_status_content ();
 291 }
 292
 293 /* Initialize readline and configure the keymap for the switching
 294    key shortcut.  */
 295 void
 296 tui_ensure_readline_initialized ()
 297 {
 298   static bool initialized;
 299
 300   if (initialized)
 301     return;
 302   initialized = true;
 303
 304   int i;
 305   Keymap tui_ctlx_keymap;
 306
 307   rl_add_defun ("tui-switch-mode", tui_rl_switch_mode, -1);
 308   rl_add_defun ("next-keymap", tui_rl_next_keymap, -1);
 309   rl_add_defun ("tui-delete-other-windows", tui_rl_delete_other_windows, -1);
 310   rl_add_defun ("tui-change-windows", tui_rl_change_windows, -1);
 311   rl_add_defun ("tui-other-window", tui_rl_other_window, -1);
 312
 313   tui_keymap = rl_make_bare_keymap ();
 314
 315   /* The named keymap feature was added in Readline 8.0.  */
 316 #if RL_READLINE_VERSION >= 0x800
 317   rl_set_keymap_name ("SingleKey", tui_keymap);
 318 #endif
 319
 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   /* Initialize readline after the above.  */
 361   rl_initialize ();
 362 }
 363
 364 /* Return the TERM variable from the environment, or "<unset>"
 365    if not set.  */
 366
 367 static const char *
 368 gdb_getenv_term (void)
 369 {
 370   const char *term;
 371
 372   term = getenv ("TERM");
 373   if (term != NULL)
 374     return term;
 375   return "<unset>";
 376 }
 377
 378 /* Enter in the tui mode (curses).
 379    When in normal mode, it installs the tui hooks in gdb, redirects
 380    the gdb output, configures the readline to work in tui mode.
 381    When in curses mode, it does nothing.  */
 382 void
 383 tui_enable (void)
 384 {
 385   TUI_SCOPED_DEBUG_ENTER_EXIT;
 386
 387   if (tui_active)
 388     return;
 389
 390   /* To avoid to initialize curses when gdb starts, there is a deferred
 391      curses initialization.  This initialization is made only once
 392      and the first time the curses mode is entered.  */
 393   if (tui_finish_init)
 394     {
 395       WINDOW *w;
 396       SCREEN *s;
 397 #ifndef __MINGW32__
 398        const char *cap;
 399 #endif
 400       const char *interp;
 401
 402       /* If the top level interpreter is not the console/tui (e.g.,
 403          MI), enabling curses will certainly lose.  */
 404       interp = top_level_interpreter ()->name ();
 405       if (strcmp (interp, INTERP_TUI) != 0)
 406         error (_("Cannot enable the TUI when the interpreter is '%s'"), interp);
 407
 408       /* Don't try to setup curses (and print funny control
 409          characters) if we're not outputting to a terminal.  */
 410       if (!gdb_stderr->isatty ())
 411         error (_("Cannot enable the TUI when output is not a terminal"));
 412
 413       s = newterm (NULL, stdout, stdin);
 414 #ifdef __MINGW32__
 415       /* The MinGW port of ncurses requires $TERM to be unset in order
 416          to activate the Windows console driver.  */
 417       if (s == NULL)
 418         s = newterm ((char *) "unknown", stdout, stdin);
 419 #endif
 420       if (s == NULL)
 421         {
 422           error (_("Cannot enable the TUI: error opening terminal [TERM=%s]"),
 423                  gdb_getenv_term ());
 424         }
 425       w = stdscr;
 426       if (has_colors ())
 427         {
 428 #ifdef HAVE_USE_DEFAULT_COLORS
 429           /* Ncurses extension to help with resetting to the default
 430              color.  */
 431           use_default_colors ();
 432 #endif
 433           start_color ();
 434         }
 435
 436       /* Check required terminal capabilities.  The MinGW port of
 437          ncurses does have them, but doesn't expose them through "cup".  */
 438 #ifndef __MINGW32__
 439       cap = tigetstr ((char *) "cup");
 440       if (cap == NULL || cap == (char *) -1 || *cap == '\0')
 441         {
 442           endwin ();
 443           delscreen (s);
 444           error (_("Cannot enable the TUI: "
 445                    "terminal doesn't support cursor addressing [TERM=%s]"),
 446                  gdb_getenv_term ());
 447         }
 448 #endif
 449
 450       /* We must mark the tui sub-system active before trying to setup the
 451          current layout as tui windows defined by an extension language
 452          rely on this flag being true in order to know that the window
 453          they are creating is currently valid.  */
 454       tui_active = true;
 455
 456       cbreak ();
 457       noecho ();
 458       /* timeout (1); */
 459       nodelay(w, FALSE);
 460       nl();
 461       keypad (w, TRUE);
 462       tui_set_term_height_to (LINES);
 463       tui_set_term_width_to (COLS);
 464       def_prog_mode ();
 465
 466       tui_show_frame_info (deprecated_safe_get_selected_frame ());
 467       tui_set_initial_layout ();
 468       tui_set_win_focus_to (tui_src_win ());
 469       keypad (tui_cmd_win ()->handle.get (), TRUE);
 470       wrefresh (tui_cmd_win ()->handle.get ());
 471       tui_finish_init = false;
 472     }
 473   else
 474     {
 475       /* Save the current gdb setting of the terminal.
 476          Curses will restore this state when endwin() is called.  */
 477       def_shell_mode ();
 478       clearok (stdscr, TRUE);
 479
 480       tui_active = true;
 481     }
 482
 483   gdb_assert (tui_active);
 484
 485   if (tui_update_variables ())
 486     tui_rehighlight_all ();
 487
 488   tui_setup_io (1);
 489
 490   /* Resize windows before anything might display/refresh a
 491      window.  */
 492   if (tui_win_resized ())
 493     {
 494       tui_set_win_resized_to (false);
 495       tui_resize_all ();
 496     }
 497
 498   /* Install the TUI specific hooks.  This must be done after the call to
 499      tui_display_main so that we don't detect the symtab changed event it
 500      can cause.  */
 501   tui_install_hooks ();
 502   rl_startup_hook = tui_rl_startup_hook;
 503
 504   /* Restore TUI keymap.  */
 505   tui_set_key_mode (tui_current_key_mode);
 506
 507   /* Refresh the screen.  */
 508   tui_refresh_all_win ();
 509
 510   /* Update gdb's knowledge of its terminal.  */
 511   gdb_save_tty_state ();
 512   tui_update_gdb_sizes ();
 513
 514   gdb::observers::tui_enabled.notify (true);
 515 }
 516
 517 /* Leave the tui mode.
 518    Remove the tui hooks and configure the gdb output and readline
 519    back to their original state.  The curses mode is left so that
 520    the terminal setting is restored to the point when we entered.  */
 521 void
 522 tui_disable (void)
 523 {
 524   TUI_SCOPED_DEBUG_ENTER_EXIT;
 525
 526   if (!tui_active)
 527     return;
 528
 529   /* Restore initial readline keymap.  */
 530   rl_set_keymap (tui_readline_standard_keymap);
 531
 532   /* Remove TUI hooks.  */
 533   tui_remove_hooks ();
 534   rl_startup_hook = 0;
 535   rl_already_prompted = 0;
 536
 537 #ifdef NCURSES_MOUSE_VERSION
 538   mousemask (0, NULL);
 539 #endif
 540
 541   /* Leave curses and restore previous gdb terminal setting.  */
 542   endwin ();
 543
 544   /* gdb terminal has changed, update gdb internal copy of it
 545      so that terminal management with the inferior works.  */
 546   tui_setup_io (0);
 547
 548   /* Update gdb's knowledge of its terminal.  */
 549   gdb_save_tty_state ();
 550
 551   tui_active = false;
 552   tui_update_gdb_sizes ();
 553
 554   gdb::observers::tui_enabled.notify (false);
 555 }
 556
 557 /* Command wrapper for enabling tui mode.  */
 558
 559 static void
 560 tui_enable_command (const char *args, int from_tty)
 561 {
 562   tui_enable ();
 563 }
 564
 565 /* Command wrapper for leaving tui mode.  */
 566
 567 static void
 568 tui_disable_command (const char *args, int from_tty)
 569 {
 570   tui_disable ();
 571 }
 572
 573 void
 574 tui_show_assembly (struct gdbarch *gdbarch, CORE_ADDR addr)
 575 {
 576   tui_batch_rendering suppress;
 577   tui_add_win_to_layout (DISASSEM_WIN);
 578   tui_update_source_windows_with_addr (gdbarch, addr);
 579 }
 580
 581 bool
 582 tui_is_window_visible (enum tui_win_type type)
 583 {
 584   if (!tui_active)
 585     return false;
 586
 587   if (tui_win_list[type] == nullptr)
 588     return false;
 589
 590   return tui_win_list[type]->is_visible ();
 591 }
 592
 593 bool
 594 tui_get_command_dimension (unsigned int *width,
 595                            unsigned int *height)
 596 {
 597   if (!tui_active || (tui_cmd_win () == NULL))
 598     return false;
 599
 600   *width = tui_cmd_win ()->width;
 601   *height = tui_cmd_win ()->height;
 602   return true;
 603 }
 604
 605 void _initialize_tui ();
 606 void
 607 _initialize_tui ()
 608 {
 609   struct cmd_list_element **tuicmd;
 610
 611   tuicmd = tui_get_cmd_list ();
 612
 613   add_cmd ("enable", class_tui, tui_enable_command,
 614            _("Enable TUI display mode.\n\
 615 Usage: tui enable"),
 616            tuicmd);
 617   add_cmd ("disable", class_tui, tui_disable_command,
 618            _("Disable TUI display mode.\n\
 619 Usage: tui disable"),
 620            tuicmd);
 621
 622   /* Debug this tui internals.  */
 623   add_setshow_boolean_cmd ("tui", class_maintenance, &debug_tui,  _("\
 624 Set tui debugging."), _("\
 625 Show tui debugging."), _("\
 626 When true, tui specific internal debugging is enabled."),
 627                            NULL,
 628                            show_tui_debug,
 629                            &setdebuglist, &showdebuglist);
 630 }