1 /* General functions for the WDB TUI.
3 Copyright (C) 1998-2019 Free Software Foundation, Inc.
5 Contributed by Hewlett-Packard Company.
7 This file is part of GDB.
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.
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.
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/>. */
25 #include "tui/tui-hooks.h"
26 #include "tui/tui-command.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-source.h"
37 #include "breakpoint.h"
52 #include "gdb_curses.h"
55 /* This redefines CTRL if it is not already defined, so it must come
56 after terminal state releated include files like <term.h> and
58 #include "readline/readline.h"
60 /* Tells whether the TUI is active or not. */
61 bool tui_active
= false;
62 static bool tui_finish_init
= true;
64 enum tui_key_mode tui_current_key_mode
= TUI_COMMAND_MODE
;
66 struct tui_char_command
72 /* Key mapping to gdb commands when the TUI is using the single key
74 static const struct tui_char_command tui_commands
[] = {
84 { 'v', "info locals" },
89 static Keymap tui_keymap
;
90 static Keymap tui_readline_standard_keymap
;
92 /* TUI readline command.
93 Switch the output mode between TUI/standard gdb. */
95 tui_rl_switch_mode (int notused1
, int notused2
)
98 /* Don't let exceptions escape. We're in the middle of a readline
99 callback that isn't prepared for that. */
105 rl_prep_terminal (0);
109 /* If tui_enable throws, we'll re-prep below. */
110 rl_deprep_terminal ();
114 catch (const gdb_exception
&ex
)
116 exception_print (gdb_stderr
, ex
);
119 rl_prep_terminal (0);
122 /* Clear the readline in case switching occurred in middle of
125 rl_kill_text (0, rl_end
);
127 /* Since we left the curses mode, the terminal mode is restored to
128 some previous state. That state may not be suitable for readline
129 to work correctly (it may be restored in line mode). We force an
130 exit of the current readline so that readline is re-entered and
131 it will be able to setup the terminal for its needs. By
132 re-entering in readline, we also redisplay its prompt in the
134 rl_newline (1, '\n');
136 /* Make sure the \n we are returning does not repeat the last
142 /* TUI readline command.
143 Change the TUI layout to show a next layout.
144 This function is bound to CTRL-X 2. It is intended to provide
145 a functionality close to the Emacs split-window command. We
146 always show two windows (src+asm), (src+regs) or (asm+regs). */
148 tui_rl_change_windows (int notused1
, int notused2
)
151 tui_rl_switch_mode (0 /* notused */, 0 /* notused */);
155 enum tui_layout_type new_layout
;
157 new_layout
= tui_current_layout ();
159 /* Select a new layout to have a rolling layout behavior with
160 always two windows (except when undefined). */
164 new_layout
= SRC_DISASSEM_COMMAND
;
167 case DISASSEM_COMMAND
:
168 new_layout
= SRC_DISASSEM_COMMAND
;
171 case SRC_DATA_COMMAND
:
172 new_layout
= SRC_DISASSEM_COMMAND
;
175 case SRC_DISASSEM_COMMAND
:
176 new_layout
= DISASSEM_DATA_COMMAND
;
179 case DISASSEM_DATA_COMMAND
:
180 new_layout
= SRC_DATA_COMMAND
;
184 new_layout
= SRC_COMMAND
;
187 tui_set_layout (new_layout
);
192 /* TUI readline command.
193 Delete the second TUI window to only show one. */
195 tui_rl_delete_other_windows (int notused1
, int notused2
)
198 tui_rl_switch_mode (0 /* notused */, 0 /* notused */);
202 enum tui_layout_type new_layout
;
204 new_layout
= tui_current_layout ();
206 /* Kill one window. */
210 case SRC_DATA_COMMAND
:
211 case SRC_DISASSEM_COMMAND
:
213 new_layout
= SRC_COMMAND
;
216 case DISASSEM_COMMAND
:
217 case DISASSEM_DATA_COMMAND
:
218 new_layout
= DISASSEM_COMMAND
;
221 tui_set_layout (new_layout
);
226 /* TUI readline command.
227 Switch the active window to give the focus to a next window. */
229 tui_rl_other_window (int count
, int key
)
231 struct tui_win_info
*win_info
;
234 tui_rl_switch_mode (0 /* notused */, 0 /* notused */);
236 win_info
= tui_next_win (tui_win_with_focus ());
239 tui_set_win_focus_to (win_info
);
240 keypad (TUI_CMD_WIN
->handle
.get (), win_info
!= TUI_CMD_WIN
);
245 /* TUI readline command.
246 Execute the gdb command bound to the specified key. */
248 tui_rl_command_key (int count
, int key
)
252 reinitialize_more_filter ();
253 for (i
= 0; tui_commands
[i
].cmd
; i
++)
255 if (tui_commands
[i
].key
== key
)
257 /* Insert the command in the readline buffer.
258 Avoid calling the gdb command here since it creates
259 a possible recursion on readline if prompt_for_continue
260 is called (See PR 9584). The command will also appear
261 in the readline history which turns out to be better. */
262 rl_insert_text (tui_commands
[i
].cmd
);
263 rl_newline (1, '\n');
265 /* Switch to gdb command mode while executing the command.
266 This way the gdb's continue prompty will be displayed. */
267 tui_set_key_mode (TUI_ONE_COMMAND_MODE
);
274 /* TUI readline command.
275 Temporarily leave the TUI SingleKey mode to allow editing
276 a gdb command with the normal readline. Once the command
277 is executed, the TUI SingleKey mode is installed back. */
279 tui_rl_command_mode (int count
, int key
)
281 tui_set_key_mode (TUI_ONE_COMMAND_MODE
);
282 return rl_insert (count
, key
);
285 /* TUI readline command.
286 Switch between TUI SingleKey mode and gdb readline editing. */
288 tui_rl_next_keymap (int notused1
, int notused2
)
291 tui_rl_switch_mode (0 /* notused */, 0 /* notused */);
293 tui_set_key_mode (tui_current_key_mode
== TUI_COMMAND_MODE
294 ? TUI_SINGLE_KEY_MODE
: TUI_COMMAND_MODE
);
298 /* Readline hook to redisplay ourself the gdb prompt.
299 In the SingleKey mode, the prompt is not printed so that
300 the command window is cleaner. It will be displayed if
301 we temporarily leave the SingleKey mode. */
303 tui_rl_startup_hook (void)
305 rl_already_prompted
= 1;
306 if (tui_current_key_mode
!= TUI_COMMAND_MODE
307 && !gdb_in_secondary_prompt_p (current_ui
))
308 tui_set_key_mode (TUI_SINGLE_KEY_MODE
);
309 tui_redisplay_readline ();
313 /* Change the TUI key mode by installing the appropriate readline
316 tui_set_key_mode (enum tui_key_mode mode
)
318 tui_current_key_mode
= mode
;
319 rl_set_keymap (mode
== TUI_SINGLE_KEY_MODE
320 ? tui_keymap
: tui_readline_standard_keymap
);
321 tui_show_locator_content ();
324 /* Initialize readline and configure the keymap for the switching
327 tui_initialize_readline (void)
330 Keymap tui_ctlx_keymap
;
332 rl_add_defun ("tui-switch-mode", tui_rl_switch_mode
, -1);
333 rl_add_defun ("next-keymap", tui_rl_next_keymap
, -1);
334 rl_add_defun ("tui-delete-other-windows", tui_rl_delete_other_windows
, -1);
335 rl_add_defun ("tui-change-windows", tui_rl_change_windows
, -1);
336 rl_add_defun ("tui-other-window", tui_rl_other_window
, -1);
338 tui_keymap
= rl_make_bare_keymap ();
340 /* The named keymap feature was added in Readline 8.0. */
341 #if RL_READLINE_VERSION >= 0x800
342 rl_set_keymap_name ("SingleKey", tui_keymap
);
345 tui_ctlx_keymap
= rl_make_bare_keymap ();
346 tui_readline_standard_keymap
= rl_get_keymap ();
348 for (i
= 0; tui_commands
[i
].cmd
; i
++)
349 rl_bind_key_in_map (tui_commands
[i
].key
, tui_rl_command_key
, tui_keymap
);
351 rl_generic_bind (ISKMAP
, "\\C-x", (char*) tui_ctlx_keymap
, tui_keymap
);
353 /* Bind all other keys to tui_rl_command_mode so that we switch
354 temporarily from SingleKey mode and can enter a gdb command. */
355 for (i
= ' '; i
< 0x7f; i
++)
359 for (j
= 0; tui_commands
[j
].cmd
; j
++)
360 if (tui_commands
[j
].key
== i
)
363 if (tui_commands
[j
].cmd
)
366 rl_bind_key_in_map (i
, tui_rl_command_mode
, tui_keymap
);
369 rl_bind_key_in_map ('a', tui_rl_switch_mode
, emacs_ctlx_keymap
);
370 rl_bind_key_in_map ('a', tui_rl_switch_mode
, tui_ctlx_keymap
);
371 rl_bind_key_in_map ('A', tui_rl_switch_mode
, emacs_ctlx_keymap
);
372 rl_bind_key_in_map ('A', tui_rl_switch_mode
, tui_ctlx_keymap
);
373 rl_bind_key_in_map (CTRL ('A'), tui_rl_switch_mode
, emacs_ctlx_keymap
);
374 rl_bind_key_in_map (CTRL ('A'), tui_rl_switch_mode
, tui_ctlx_keymap
);
375 rl_bind_key_in_map ('1', tui_rl_delete_other_windows
, emacs_ctlx_keymap
);
376 rl_bind_key_in_map ('1', tui_rl_delete_other_windows
, tui_ctlx_keymap
);
377 rl_bind_key_in_map ('2', tui_rl_change_windows
, emacs_ctlx_keymap
);
378 rl_bind_key_in_map ('2', tui_rl_change_windows
, tui_ctlx_keymap
);
379 rl_bind_key_in_map ('o', tui_rl_other_window
, emacs_ctlx_keymap
);
380 rl_bind_key_in_map ('o', tui_rl_other_window
, tui_ctlx_keymap
);
381 rl_bind_key_in_map ('q', tui_rl_next_keymap
, tui_keymap
);
382 rl_bind_key_in_map ('s', tui_rl_next_keymap
, emacs_ctlx_keymap
);
383 rl_bind_key_in_map ('s', tui_rl_next_keymap
, tui_ctlx_keymap
);
386 /* Return the TERM variable from the environment, or "<unset>"
390 gdb_getenv_term (void)
394 term
= getenv ("TERM");
400 /* Enter in the tui mode (curses).
401 When in normal mode, it installs the tui hooks in gdb, redirects
402 the gdb output, configures the readline to work in tui mode.
403 When in curses mode, it does nothing. */
410 /* To avoid to initialize curses when gdb starts, there is a deferred
411 curses initialization. This initialization is made only once
412 and the first time the curses mode is entered. */
422 /* If the top level interpreter is not the console/tui (e.g.,
423 MI), enabling curses will certainly lose. */
424 interp
= top_level_interpreter ()->name ();
425 if (strcmp (interp
, INTERP_TUI
) != 0)
426 error (_("Cannot enable the TUI when the interpreter is '%s'"), interp
);
428 /* Don't try to setup curses (and print funny control
429 characters) if we're not outputting to a terminal. */
430 if (!ui_file_isatty (gdb_stdout
))
431 error (_("Cannot enable the TUI when output is not a terminal"));
433 s
= newterm (NULL
, stdout
, stdin
);
435 /* The MinGW port of ncurses requires $TERM to be unset in order
436 to activate the Windows console driver. */
438 s
= newterm ((char *) "unknown", stdout
, stdin
);
442 error (_("Cannot enable the TUI: error opening terminal [TERM=%s]"),
448 #ifdef HAVE_USE_DEFAULT_COLORS
449 /* Ncurses extension to help with resetting to the default
451 use_default_colors ();
456 /* Check required terminal capabilities. The MinGW port of
457 ncurses does have them, but doesn't expose them through "cup". */
459 cap
= tigetstr ((char *) "cup");
460 if (cap
== NULL
|| cap
== (char *) -1 || *cap
== '\0')
464 error (_("Cannot enable the TUI: "
465 "terminal doesn't support cursor addressing [TERM=%s]"),
476 tui_set_term_height_to (LINES
);
477 tui_set_term_width_to (COLS
);
480 tui_show_frame_info (0);
481 tui_set_layout (SRC_COMMAND
);
482 tui_set_win_focus_to (TUI_SRC_WIN
);
483 keypad (TUI_CMD_WIN
->handle
.get (), TRUE
);
484 wrefresh (TUI_CMD_WIN
->handle
.get ());
485 tui_finish_init
= false;
489 /* Save the current gdb setting of the terminal.
490 Curses will restore this state when endwin() is called. */
492 clearok (stdscr
, TRUE
);
495 /* Install the TUI specific hooks. */
496 tui_install_hooks ();
497 rl_startup_hook
= tui_rl_startup_hook
;
499 if (tui_update_variables ())
500 tui_rehighlight_all ();
506 /* Resize windows before anything might display/refresh a
508 if (tui_win_resized ())
510 tui_set_win_resized_to (false);
514 if (deprecated_safe_get_selected_frame ())
515 tui_show_frame_info (deprecated_safe_get_selected_frame ());
519 /* Restore TUI keymap. */
520 tui_set_key_mode (tui_current_key_mode
);
522 /* Refresh the screen. */
523 tui_refresh_all_win ();
525 /* Update gdb's knowledge of its terminal. */
526 gdb_save_tty_state ();
527 tui_update_gdb_sizes ();
530 /* Leave the tui mode.
531 Remove the tui hooks and configure the gdb output and readline
532 back to their original state. The curses mode is left so that
533 the terminal setting is restored to the point when we entered. */
540 /* Restore initial readline keymap. */
541 rl_set_keymap (tui_readline_standard_keymap
);
543 /* Remove TUI hooks. */
546 rl_already_prompted
= 0;
548 /* Leave curses and restore previous gdb terminal setting. */
551 /* gdb terminal has changed, update gdb internal copy of it
552 so that terminal management with the inferior works. */
555 /* Update gdb's knowledge of its terminal. */
556 gdb_save_tty_state ();
559 tui_update_gdb_sizes ();
562 /* Command wrapper for enabling tui mode. */
565 tui_enable_command (const char *args
, int from_tty
)
570 /* Command wrapper for leaving tui mode. */
573 tui_disable_command (const char *args
, int from_tty
)
579 /* Solaris <sys/termios.h> defines CTRL. */
581 #define CTRL(x) (x & ~0140)
585 #define CHK(val, dft) (val<=0 ? dft : val)
592 /* Reset the teletype mode bits to a sensible state.
594 #if defined (TIOCGETC)
596 #endif /* TIOCGETC */
600 if (ldisc
== NTTYDISC
)
602 ioctl (FILEDES
, TIOCGLTC
, <c
);
603 ltc
.t_suspc
= CHK (ltc
.t_suspc
, CTRL ('Z'));
604 ltc
.t_dsuspc
= CHK (ltc
.t_dsuspc
, CTRL ('Y'));
605 ltc
.t_rprntc
= CHK (ltc
.t_rprntc
, CTRL ('R'));
606 ltc
.t_flushc
= CHK (ltc
.t_flushc
, CTRL ('O'));
607 ltc
.t_werasc
= CHK (ltc
.t_werasc
, CTRL ('W'));
608 ltc
.t_lnextc
= CHK (ltc
.t_lnextc
, CTRL ('V'));
609 ioctl (FILEDES
, TIOCSLTC
, <c
);
611 #endif /* UCB_NTTY */
613 ioctl (FILEDES
, TIOCGETC
, &tbuf
);
614 tbuf
.t_intrc
= CHK (tbuf
.t_intrc
, CTRL ('?'));
615 tbuf
.t_quitc
= CHK (tbuf
.t_quitc
, CTRL ('\\'));
616 tbuf
.t_startc
= CHK (tbuf
.t_startc
, CTRL ('Q'));
617 tbuf
.t_stopc
= CHK (tbuf
.t_stopc
, CTRL ('S'));
618 tbuf
.t_eofc
= CHK (tbuf
.t_eofc
, CTRL ('D'));
619 /* brkc is left alone. */
620 ioctl (FILEDES
, TIOCSETC
, &tbuf
);
621 #endif /* TIOCGETC */
622 mode
.sg_flags
&= ~(RAW
626 | VTDELAY
| ALLDELAY
);
627 mode
.sg_flags
|= XTABS
| ECHO
| CRMOD
| ANYP
;
632 tui_show_assembly (struct gdbarch
*gdbarch
, CORE_ADDR addr
)
634 tui_add_win_to_layout (DISASSEM_WIN
);
635 tui_update_source_windows_with_addr (gdbarch
, addr
);
639 tui_is_window_visible (enum tui_win_type type
)
644 if (tui_win_list
[type
] == 0)
647 return tui_win_list
[type
]->is_visible ();
651 tui_get_command_dimension (unsigned int *width
,
652 unsigned int *height
)
654 if (!tui_active
|| (TUI_CMD_WIN
== NULL
))
659 *width
= TUI_CMD_WIN
->width
;
660 *height
= TUI_CMD_WIN
->height
;
665 _initialize_tui (void)
667 struct cmd_list_element
**tuicmd
;
669 tuicmd
= tui_get_cmd_list ();
671 add_cmd ("enable", class_tui
, tui_enable_command
,
672 _("Enable TUI display mode."),
674 add_cmd ("disable", class_tui
, tui_disable_command
,
675 _("Disable TUI display mode."),