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"
36 #include "breakpoint.h"
51 #include "gdb_curses.h"
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
57 #include "readline/readline.h"
59 /* Tells whether the TUI is active or not. */
61 static int tui_finish_init
= 1;
63 enum tui_key_mode tui_current_key_mode
= TUI_COMMAND_MODE
;
65 struct tui_char_command
71 /* Key mapping to gdb commands when the TUI is using the single key
73 static const struct tui_char_command tui_commands
[] = {
83 { 'v', "info locals" },
88 static Keymap tui_keymap
;
89 static Keymap tui_readline_standard_keymap
;
91 /* TUI readline command.
92 Switch the output mode between TUI/standard gdb. */
94 tui_rl_switch_mode (int notused1
, int notused2
)
97 /* Don't let exceptions escape. We're in the middle of a readline
98 callback that isn't prepared for that. */
104 rl_prep_terminal (0);
108 /* If tui_enable throws, we'll re-prep below. */
109 rl_deprep_terminal ();
113 catch (const gdb_exception
&ex
)
115 exception_print (gdb_stderr
, ex
);
118 rl_prep_terminal (0);
121 /* Clear the readline in case switching occurred in middle of
124 rl_kill_text (0, rl_end
);
126 /* Since we left the curses mode, the terminal mode is restored to
127 some previous state. That state may not be suitable for readline
128 to work correctly (it may be restored in line mode). We force an
129 exit of the current readline so that readline is re-entered and
130 it will be able to setup the terminal for its needs. By
131 re-entering in readline, we also redisplay its prompt in the
133 rl_newline (1, '\n');
135 /* Make sure the \n we are returning does not repeat the last
141 /* TUI readline command.
142 Change the TUI layout to show a next layout.
143 This function is bound to CTRL-X 2. It is intended to provide
144 a functionality close to the Emacs split-window command. We
145 always show two windows (src+asm), (src+regs) or (asm+regs). */
147 tui_rl_change_windows (int notused1
, int notused2
)
150 tui_rl_switch_mode (0 /* notused */, 0 /* notused */);
154 enum tui_layout_type new_layout
;
156 new_layout
= tui_current_layout ();
158 /* Select a new layout to have a rolling layout behavior with
159 always two windows (except when undefined). */
163 new_layout
= SRC_DISASSEM_COMMAND
;
166 case DISASSEM_COMMAND
:
167 new_layout
= SRC_DISASSEM_COMMAND
;
170 case SRC_DATA_COMMAND
:
171 new_layout
= SRC_DISASSEM_COMMAND
;
174 case SRC_DISASSEM_COMMAND
:
175 new_layout
= DISASSEM_DATA_COMMAND
;
178 case DISASSEM_DATA_COMMAND
:
179 new_layout
= SRC_DATA_COMMAND
;
183 new_layout
= SRC_COMMAND
;
186 tui_set_layout (new_layout
);
191 /* TUI readline command.
192 Delete the second TUI window to only show one. */
194 tui_rl_delete_other_windows (int notused1
, int notused2
)
197 tui_rl_switch_mode (0 /* notused */, 0 /* notused */);
201 enum tui_layout_type new_layout
;
203 new_layout
= tui_current_layout ();
205 /* Kill one window. */
209 case SRC_DATA_COMMAND
:
210 case SRC_DISASSEM_COMMAND
:
212 new_layout
= SRC_COMMAND
;
215 case DISASSEM_COMMAND
:
216 case DISASSEM_DATA_COMMAND
:
217 new_layout
= DISASSEM_COMMAND
;
220 tui_set_layout (new_layout
);
225 /* TUI readline command.
226 Switch the active window to give the focus to a next window. */
228 tui_rl_other_window (int count
, int key
)
230 struct tui_win_info
*win_info
;
233 tui_rl_switch_mode (0 /* notused */, 0 /* notused */);
235 win_info
= tui_next_win (tui_win_with_focus ());
238 tui_set_win_focus_to (win_info
);
239 keypad (TUI_CMD_WIN
->handle
, (win_info
!= TUI_CMD_WIN
));
244 /* TUI readline command.
245 Execute the gdb command bound to the specified key. */
247 tui_rl_command_key (int count
, int key
)
251 reinitialize_more_filter ();
252 for (i
= 0; tui_commands
[i
].cmd
; i
++)
254 if (tui_commands
[i
].key
== key
)
256 /* Insert the command in the readline buffer.
257 Avoid calling the gdb command here since it creates
258 a possible recursion on readline if prompt_for_continue
259 is called (See PR 9584). The command will also appear
260 in the readline history which turns out to be better. */
261 rl_insert_text (tui_commands
[i
].cmd
);
262 rl_newline (1, '\n');
264 /* Switch to gdb command mode while executing the command.
265 This way the gdb's continue prompty will be displayed. */
266 tui_set_key_mode (TUI_ONE_COMMAND_MODE
);
273 /* TUI readline command.
274 Temporarily leave the TUI SingleKey mode to allow editing
275 a gdb command with the normal readline. Once the command
276 is executed, the TUI SingleKey mode is installed back. */
278 tui_rl_command_mode (int count
, int key
)
280 tui_set_key_mode (TUI_ONE_COMMAND_MODE
);
281 return rl_insert (count
, key
);
284 /* TUI readline command.
285 Switch between TUI SingleKey mode and gdb readline editing. */
287 tui_rl_next_keymap (int notused1
, int notused2
)
290 tui_rl_switch_mode (0 /* notused */, 0 /* notused */);
292 tui_set_key_mode (tui_current_key_mode
== TUI_COMMAND_MODE
293 ? TUI_SINGLE_KEY_MODE
: TUI_COMMAND_MODE
);
297 /* Readline hook to redisplay ourself the gdb prompt.
298 In the SingleKey mode, the prompt is not printed so that
299 the command window is cleaner. It will be displayed if
300 we temporarily leave the SingleKey mode. */
302 tui_rl_startup_hook (void)
304 rl_already_prompted
= 1;
305 if (tui_current_key_mode
!= TUI_COMMAND_MODE
306 && !gdb_in_secondary_prompt_p (current_ui
))
307 tui_set_key_mode (TUI_SINGLE_KEY_MODE
);
308 tui_redisplay_readline ();
312 /* Change the TUI key mode by installing the appropriate readline
315 tui_set_key_mode (enum tui_key_mode mode
)
317 tui_current_key_mode
= mode
;
318 rl_set_keymap (mode
== TUI_SINGLE_KEY_MODE
319 ? tui_keymap
: tui_readline_standard_keymap
);
320 tui_show_locator_content ();
323 /* Initialize readline and configure the keymap for the switching
326 tui_initialize_readline (void)
329 Keymap tui_ctlx_keymap
;
333 rl_add_defun ("tui-switch-mode", tui_rl_switch_mode
, -1);
334 rl_add_defun ("gdb-command", tui_rl_command_key
, -1);
335 rl_add_defun ("next-keymap", tui_rl_next_keymap
, -1);
337 tui_keymap
= rl_make_bare_keymap ();
338 tui_ctlx_keymap
= rl_make_bare_keymap ();
339 tui_readline_standard_keymap
= rl_get_keymap ();
341 for (i
= 0; tui_commands
[i
].cmd
; i
++)
342 rl_bind_key_in_map (tui_commands
[i
].key
, tui_rl_command_key
, tui_keymap
);
344 rl_generic_bind (ISKMAP
, "\\C-x", (char*) tui_ctlx_keymap
, tui_keymap
);
346 /* Bind all other keys to tui_rl_command_mode so that we switch
347 temporarily from SingleKey mode and can enter a gdb command. */
348 for (i
= ' '; i
< 0x7f; i
++)
352 for (j
= 0; tui_commands
[j
].cmd
; j
++)
353 if (tui_commands
[j
].key
== i
)
356 if (tui_commands
[j
].cmd
)
359 rl_bind_key_in_map (i
, tui_rl_command_mode
, tui_keymap
);
362 rl_bind_key_in_map ('a', tui_rl_switch_mode
, emacs_ctlx_keymap
);
363 rl_bind_key_in_map ('a', tui_rl_switch_mode
, tui_ctlx_keymap
);
364 rl_bind_key_in_map ('A', tui_rl_switch_mode
, emacs_ctlx_keymap
);
365 rl_bind_key_in_map ('A', tui_rl_switch_mode
, tui_ctlx_keymap
);
366 rl_bind_key_in_map (CTRL ('A'), tui_rl_switch_mode
, emacs_ctlx_keymap
);
367 rl_bind_key_in_map (CTRL ('A'), tui_rl_switch_mode
, tui_ctlx_keymap
);
368 rl_bind_key_in_map ('1', tui_rl_delete_other_windows
, emacs_ctlx_keymap
);
369 rl_bind_key_in_map ('1', tui_rl_delete_other_windows
, tui_ctlx_keymap
);
370 rl_bind_key_in_map ('2', tui_rl_change_windows
, emacs_ctlx_keymap
);
371 rl_bind_key_in_map ('2', tui_rl_change_windows
, tui_ctlx_keymap
);
372 rl_bind_key_in_map ('o', tui_rl_other_window
, emacs_ctlx_keymap
);
373 rl_bind_key_in_map ('o', tui_rl_other_window
, tui_ctlx_keymap
);
374 rl_bind_key_in_map ('q', tui_rl_next_keymap
, tui_keymap
);
375 rl_bind_key_in_map ('s', tui_rl_next_keymap
, emacs_ctlx_keymap
);
376 rl_bind_key_in_map ('s', tui_rl_next_keymap
, tui_ctlx_keymap
);
379 /* Return the TERM variable from the environment, or "<unset>"
383 gdb_getenv_term (void)
387 term
= getenv ("TERM");
393 /* Enter in the tui mode (curses).
394 When in normal mode, it installs the tui hooks in gdb, redirects
395 the gdb output, configures the readline to work in tui mode.
396 When in curses mode, it does nothing. */
403 /* To avoid to initialize curses when gdb starts, there is a defered
404 curses initialization. This initialization is made only once
405 and the first time the curses mode is entered. */
415 /* If the top level interpreter is not the console/tui (e.g.,
416 MI), enabling curses will certainly lose. */
417 interp
= top_level_interpreter ()->name ();
418 if (strcmp (interp
, INTERP_TUI
) != 0)
419 error (_("Cannot enable the TUI when the interpreter is '%s'"), interp
);
421 /* Don't try to setup curses (and print funny control
422 characters) if we're not outputting to a terminal. */
423 if (!ui_file_isatty (gdb_stdout
))
424 error (_("Cannot enable the TUI when output is not a terminal"));
426 s
= newterm (NULL
, stdout
, stdin
);
428 /* The MinGW port of ncurses requires $TERM to be unset in order
429 to activate the Windows console driver. */
431 s
= newterm ((char *) "unknown", stdout
, stdin
);
435 error (_("Cannot enable the TUI: error opening terminal [TERM=%s]"),
441 #ifdef HAVE_USE_DEFAULT_COLORS
442 /* Ncurses extension to help with resetting to the default
444 use_default_colors ();
449 /* Check required terminal capabilities. The MinGW port of
450 ncurses does have them, but doesn't expose them through "cup". */
452 cap
= tigetstr ((char *) "cup");
453 if (cap
== NULL
|| cap
== (char *) -1 || *cap
== '\0')
457 error (_("Cannot enable the TUI: "
458 "terminal doesn't support cursor addressing [TERM=%s]"),
470 tui_set_term_height_to (LINES
);
471 tui_set_term_width_to (COLS
);
474 tui_show_frame_info (0);
475 tui_set_layout (SRC_COMMAND
);
476 tui_set_win_focus_to (TUI_SRC_WIN
);
477 keypad (TUI_CMD_WIN
->handle
, TRUE
);
478 wrefresh (TUI_CMD_WIN
->handle
);
483 /* Save the current gdb setting of the terminal.
484 Curses will restore this state when endwin() is called. */
486 clearok (stdscr
, TRUE
);
489 /* Install the TUI specific hooks. */
490 tui_install_hooks ();
491 rl_startup_hook
= tui_rl_startup_hook
;
493 tui_update_variables ();
499 /* Resize windows before anything might display/refresh a
501 if (tui_win_resized ())
503 tui_set_win_resized_to (FALSE
);
507 if (deprecated_safe_get_selected_frame ())
508 tui_show_frame_info (deprecated_safe_get_selected_frame ());
510 /* Restore TUI keymap. */
511 tui_set_key_mode (tui_current_key_mode
);
513 /* Refresh the screen. */
514 tui_refresh_all_win ();
516 /* Update gdb's knowledge of its terminal. */
517 gdb_save_tty_state ();
518 tui_update_gdb_sizes ();
521 /* Leave the tui mode.
522 Remove the tui hooks and configure the gdb output and readline
523 back to their original state. The curses mode is left so that
524 the terminal setting is restored to the point when we entered. */
531 /* Restore initial readline keymap. */
532 rl_set_keymap (tui_readline_standard_keymap
);
534 /* Remove TUI hooks. */
537 rl_already_prompted
= 0;
539 /* Leave curses and restore previous gdb terminal setting. */
542 /* gdb terminal has changed, update gdb internal copy of it
543 so that terminal management with the inferior works. */
546 /* Update gdb's knowledge of its terminal. */
547 gdb_save_tty_state ();
550 tui_update_gdb_sizes ();
553 /* Command wrapper for enabling tui mode. */
556 tui_enable_command (const char *args
, int from_tty
)
561 /* Command wrapper for leaving tui mode. */
564 tui_disable_command (const char *args
, int from_tty
)
570 strcat_to_buf (char *buf
, int buflen
,
571 const char *item_to_add
)
573 if (item_to_add
!= NULL
&& buf
!= NULL
)
575 if ((strlen (buf
) + strlen (item_to_add
)) <= buflen
)
576 strcat (buf
, item_to_add
);
578 strncat (buf
, item_to_add
, (buflen
- strlen (buf
)));
583 /* Solaris <sys/termios.h> defines CTRL. */
585 #define CTRL(x) (x & ~0140)
589 #define CHK(val, dft) (val<=0 ? dft : val)
596 /* Reset the teletype mode bits to a sensible state.
598 #if defined (TIOCGETC)
600 #endif /* TIOCGETC */
604 if (ldisc
== NTTYDISC
)
606 ioctl (FILEDES
, TIOCGLTC
, <c
);
607 ltc
.t_suspc
= CHK (ltc
.t_suspc
, CTRL ('Z'));
608 ltc
.t_dsuspc
= CHK (ltc
.t_dsuspc
, CTRL ('Y'));
609 ltc
.t_rprntc
= CHK (ltc
.t_rprntc
, CTRL ('R'));
610 ltc
.t_flushc
= CHK (ltc
.t_flushc
, CTRL ('O'));
611 ltc
.t_werasc
= CHK (ltc
.t_werasc
, CTRL ('W'));
612 ltc
.t_lnextc
= CHK (ltc
.t_lnextc
, CTRL ('V'));
613 ioctl (FILEDES
, TIOCSLTC
, <c
);
615 #endif /* UCB_NTTY */
617 ioctl (FILEDES
, TIOCGETC
, &tbuf
);
618 tbuf
.t_intrc
= CHK (tbuf
.t_intrc
, CTRL ('?'));
619 tbuf
.t_quitc
= CHK (tbuf
.t_quitc
, CTRL ('\\'));
620 tbuf
.t_startc
= CHK (tbuf
.t_startc
, CTRL ('Q'));
621 tbuf
.t_stopc
= CHK (tbuf
.t_stopc
, CTRL ('S'));
622 tbuf
.t_eofc
= CHK (tbuf
.t_eofc
, CTRL ('D'));
623 /* brkc is left alone. */
624 ioctl (FILEDES
, TIOCSETC
, &tbuf
);
625 #endif /* TIOCGETC */
626 mode
.sg_flags
&= ~(RAW
630 | VTDELAY
| ALLDELAY
);
631 mode
.sg_flags
|= XTABS
| ECHO
| CRMOD
| ANYP
;
638 tui_show_source (const char *fullname
, int line
)
640 struct symtab_and_line cursal
= get_current_source_symtab_and_line ();
642 /* Make sure that the source window is displayed. */
643 tui_add_win_to_layout (SRC_WIN
);
645 tui_update_source_windows_with_line (cursal
.symtab
, line
);
646 tui_update_locator_fullname (fullname
);
650 tui_show_assembly (struct gdbarch
*gdbarch
, CORE_ADDR addr
)
652 tui_add_win_to_layout (DISASSEM_WIN
);
653 tui_update_source_windows_with_addr (gdbarch
, addr
);
657 tui_is_window_visible (enum tui_win_type type
)
662 if (tui_win_list
[type
] == 0)
665 return tui_win_list
[type
]->is_visible
;
669 tui_get_command_dimension (unsigned int *width
,
670 unsigned int *height
)
672 if (!tui_active
|| (TUI_CMD_WIN
== NULL
))
677 *width
= TUI_CMD_WIN
->width
;
678 *height
= TUI_CMD_WIN
->height
;
683 _initialize_tui (void)
685 struct cmd_list_element
**tuicmd
;
687 tuicmd
= tui_get_cmd_list ();
689 add_cmd ("enable", class_tui
, tui_enable_command
,
690 _("Enable TUI display mode."),
692 add_cmd ("disable", class_tui
, tui_disable_command
,
693 _("Disable TUI display mode."),