1 /* General functions for the WDB TUI.
3 Copyright (C) 1998-2015 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-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"
36 #include "breakpoint.h"
50 #include "gdb_curses.h"
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
56 #include "readline/readline.h"
58 /* Tells whether the TUI is active or not. */
60 static int tui_finish_init
= 1;
62 enum tui_key_mode tui_current_key_mode
= TUI_COMMAND_MODE
;
64 struct tui_char_command
70 /* Key mapping to gdb commands when the TUI is using the single key
72 static const struct tui_char_command tui_commands
[] = {
80 { 'v', "info locals" },
85 static Keymap tui_keymap
;
86 static Keymap tui_readline_standard_keymap
;
88 /* TUI readline command.
89 Switch the output mode between TUI/standard gdb. */
91 tui_rl_switch_mode (int notused1
, int notused2
)
94 /* Don't let exceptions escape. We're in the middle of a readline
95 callback that isn't prepared for that. */
101 rl_prep_terminal (0);
105 /* If tui_enable throws, we'll re-prep below. */
106 rl_deprep_terminal ();
110 CATCH (ex
, RETURN_MASK_ALL
)
112 exception_print (gdb_stderr
, ex
);
115 rl_prep_terminal (0);
119 /* Clear the readline in case switching occurred in middle of
122 rl_kill_text (0, rl_end
);
124 /* Since we left the curses mode, the terminal mode is restored to
125 some previous state. That state may not be suitable for readline
126 to work correctly (it may be restored in line mode). We force an
127 exit of the current readline so that readline is re-entered and
128 it will be able to setup the terminal for its needs. By
129 re-entering in readline, we also redisplay its prompt in the
131 rl_newline (1, '\n');
133 /* Make sure the \n we are returning does not repeat the last
139 /* TUI readline command.
140 Change the TUI layout to show a next layout.
141 This function is bound to CTRL-X 2. It is intended to provide
142 a functionality close to the Emacs split-window command. We
143 always show two windows (src+asm), (src+regs) or (asm+regs). */
145 tui_rl_change_windows (int notused1
, int notused2
)
148 tui_rl_switch_mode (0 /* notused */, 0 /* notused */);
152 enum tui_layout_type new_layout
;
154 new_layout
= tui_current_layout ();
156 /* Select a new layout to have a rolling layout behavior with
157 always two windows (except when undefined). */
161 new_layout
= SRC_DISASSEM_COMMAND
;
164 case DISASSEM_COMMAND
:
165 new_layout
= SRC_DISASSEM_COMMAND
;
168 case SRC_DATA_COMMAND
:
169 new_layout
= SRC_DISASSEM_COMMAND
;
172 case SRC_DISASSEM_COMMAND
:
173 new_layout
= DISASSEM_DATA_COMMAND
;
176 case DISASSEM_DATA_COMMAND
:
177 new_layout
= SRC_DATA_COMMAND
;
181 new_layout
= SRC_COMMAND
;
184 tui_set_layout (new_layout
);
189 /* TUI readline command.
190 Delete the second TUI window to only show one. */
192 tui_rl_delete_other_windows (int notused1
, int notused2
)
195 tui_rl_switch_mode (0 /* notused */, 0 /* notused */);
199 enum tui_layout_type new_layout
;
201 new_layout
= tui_current_layout ();
203 /* Kill one window. */
207 case SRC_DATA_COMMAND
:
208 case SRC_DISASSEM_COMMAND
:
210 new_layout
= SRC_COMMAND
;
213 case DISASSEM_COMMAND
:
214 case DISASSEM_DATA_COMMAND
:
215 new_layout
= DISASSEM_COMMAND
;
218 tui_set_layout (new_layout
);
223 /* TUI readline command.
224 Switch the active window to give the focus to a next window. */
226 tui_rl_other_window (int count
, int key
)
228 struct tui_win_info
*win_info
;
231 tui_rl_switch_mode (0 /* notused */, 0 /* notused */);
233 win_info
= tui_next_win (tui_win_with_focus ());
236 tui_set_win_focus_to (win_info
);
237 if (TUI_DATA_WIN
&& TUI_DATA_WIN
->generic
.is_visible
)
238 tui_refresh_data_win ();
239 keypad (TUI_CMD_WIN
->generic
.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
&& immediate_quit
== 0)
306 tui_set_key_mode (TUI_SINGLE_KEY_MODE
);
307 tui_redisplay_readline ();
311 /* Change the TUI key mode by installing the appropriate readline
314 tui_set_key_mode (enum tui_key_mode mode
)
316 tui_current_key_mode
= mode
;
317 rl_set_keymap (mode
== TUI_SINGLE_KEY_MODE
318 ? tui_keymap
: tui_readline_standard_keymap
);
319 tui_show_locator_content ();
322 /* Initialize readline and configure the keymap for the switching
325 tui_initialize_readline (void)
328 Keymap tui_ctlx_keymap
;
332 rl_add_defun ("tui-switch-mode", tui_rl_switch_mode
, -1);
333 rl_add_defun ("gdb-command", tui_rl_command_key
, -1);
334 rl_add_defun ("next-keymap", tui_rl_next_keymap
, -1);
336 tui_keymap
= rl_make_bare_keymap ();
337 tui_ctlx_keymap
= rl_make_bare_keymap ();
338 tui_readline_standard_keymap
= rl_get_keymap ();
340 for (i
= 0; tui_commands
[i
].cmd
; i
++)
341 rl_bind_key_in_map (tui_commands
[i
].key
, tui_rl_command_key
, tui_keymap
);
343 rl_generic_bind (ISKMAP
, "\\C-x", (char*) tui_ctlx_keymap
, tui_keymap
);
345 /* Bind all other keys to tui_rl_command_mode so that we switch
346 temporarily from SingleKey mode and can enter a gdb command. */
347 for (i
= ' '; i
< 0x7f; i
++)
351 for (j
= 0; tui_commands
[j
].cmd
; j
++)
352 if (tui_commands
[j
].key
== i
)
355 if (tui_commands
[j
].cmd
)
358 rl_bind_key_in_map (i
, tui_rl_command_mode
, tui_keymap
);
361 rl_bind_key_in_map ('a', tui_rl_switch_mode
, emacs_ctlx_keymap
);
362 rl_bind_key_in_map ('a', tui_rl_switch_mode
, tui_ctlx_keymap
);
363 rl_bind_key_in_map ('A', tui_rl_switch_mode
, emacs_ctlx_keymap
);
364 rl_bind_key_in_map ('A', tui_rl_switch_mode
, tui_ctlx_keymap
);
365 rl_bind_key_in_map (CTRL ('A'), tui_rl_switch_mode
, emacs_ctlx_keymap
);
366 rl_bind_key_in_map (CTRL ('A'), tui_rl_switch_mode
, tui_ctlx_keymap
);
367 rl_bind_key_in_map ('1', tui_rl_delete_other_windows
, emacs_ctlx_keymap
);
368 rl_bind_key_in_map ('1', tui_rl_delete_other_windows
, tui_ctlx_keymap
);
369 rl_bind_key_in_map ('2', tui_rl_change_windows
, emacs_ctlx_keymap
);
370 rl_bind_key_in_map ('2', tui_rl_change_windows
, tui_ctlx_keymap
);
371 rl_bind_key_in_map ('o', tui_rl_other_window
, emacs_ctlx_keymap
);
372 rl_bind_key_in_map ('o', tui_rl_other_window
, tui_ctlx_keymap
);
373 rl_bind_key_in_map ('q', tui_rl_next_keymap
, tui_keymap
);
374 rl_bind_key_in_map ('s', tui_rl_next_keymap
, emacs_ctlx_keymap
);
375 rl_bind_key_in_map ('s', tui_rl_next_keymap
, tui_ctlx_keymap
);
378 /* Return the TERM variable from the environment, or "<unset>"
382 gdb_getenv_term (void)
386 term
= getenv ("TERM");
392 /* Enter in the tui mode (curses).
393 When in normal mode, it installs the tui hooks in gdb, redirects
394 the gdb output, configures the readline to work in tui mode.
395 When in curses mode, it does nothing. */
399 struct interp
*interp
;
404 /* To avoid to initialize curses when gdb starts, there is a defered
405 curses initialization. This initialization is made only once
406 and the first time the curses mode is entered. */
414 /* If the top level interpreter is not the console/tui (e.g.,
415 MI), enabling curses will certainly lose. */
416 interp
= interp_name (top_level_interpreter ());
417 if (strcmp (interp
, INTERP_TUI
) != 0)
418 error (_("Cannot enable the TUI when the interpreter is '%s'"), interp
);
420 /* Don't try to setup curses (and print funny control
421 characters) if we're not outputting to a terminal. */
422 if (!ui_file_isatty (gdb_stdout
))
423 error (_("Cannot enable the TUI when output is not a terminal"));
425 s
= newterm (NULL
, stdout
, stdin
);
427 /* The MinGW port of ncurses requires $TERM to be unset in order
428 to activate the Windows console driver. */
430 s
= newterm ("unknown", stdout
, stdin
);
434 error (_("Cannot enable the TUI: error opening terminal [TERM=%s]"),
439 /* Check required terminal capabilities. The MinGW port of
440 ncurses does have them, but doesn't expose them through "cup". */
442 cap
= tigetstr ("cup");
443 if (cap
== NULL
|| cap
== (char *) -1 || *cap
== '\0')
447 error (_("Cannot enable the TUI: "
448 "terminal doesn't support cursor addressing [TERM=%s]"),
460 tui_set_term_height_to (LINES
);
461 tui_set_term_width_to (COLS
);
464 tui_show_frame_info (0);
465 tui_set_layout (SRC_COMMAND
);
466 tui_set_win_focus_to (TUI_SRC_WIN
);
467 keypad (TUI_CMD_WIN
->generic
.handle
, TRUE
);
468 wrefresh (TUI_CMD_WIN
->generic
.handle
);
473 /* Save the current gdb setting of the terminal.
474 Curses will restore this state when endwin() is called. */
476 clearok (stdscr
, TRUE
);
479 /* Install the TUI specific hooks. */
480 tui_install_hooks ();
481 rl_startup_hook
= tui_rl_startup_hook
;
483 tui_update_variables ();
489 /* Resize windows before anything might display/refresh a
491 if (tui_win_resized ())
493 tui_set_win_resized_to (FALSE
);
497 if (deprecated_safe_get_selected_frame ())
498 tui_show_frame_info (deprecated_safe_get_selected_frame ());
500 /* Restore TUI keymap. */
501 tui_set_key_mode (tui_current_key_mode
);
503 /* Refresh the screen. */
504 tui_refresh_all_win ();
506 /* Update gdb's knowledge of its terminal. */
507 gdb_save_tty_state ();
508 tui_update_gdb_sizes ();
511 /* Leave the tui mode.
512 Remove the tui hooks and configure the gdb output and readline
513 back to their original state. The curses mode is left so that
514 the terminal setting is restored to the point when we entered. */
521 /* Restore initial readline keymap. */
522 rl_set_keymap (tui_readline_standard_keymap
);
524 /* Remove TUI hooks. */
527 rl_already_prompted
= 0;
529 /* Leave curses and restore previous gdb terminal setting. */
532 /* gdb terminal has changed, update gdb internal copy of it
533 so that terminal management with the inferior works. */
536 /* Update gdb's knowledge of its terminal. */
537 gdb_save_tty_state ();
540 tui_update_gdb_sizes ();
543 /* Command wrapper for enabling tui mode. */
546 tui_enable_command (char *args
, int from_tty
)
551 /* Command wrapper for leaving tui mode. */
554 tui_disable_command (char *args
, int from_tty
)
560 strcat_to_buf (char *buf
, int buflen
,
561 const char *item_to_add
)
563 if (item_to_add
!= (char *) NULL
&& buf
!= (char *) NULL
)
565 if ((strlen (buf
) + strlen (item_to_add
)) <= buflen
)
566 strcat (buf
, item_to_add
);
568 strncat (buf
, item_to_add
, (buflen
- strlen (buf
)));
573 /* Solaris <sys/termios.h> defines CTRL. */
575 #define CTRL(x) (x & ~0140)
579 #define CHK(val, dft) (val<=0 ? dft : val)
586 /* Reset the teletype mode bits to a sensible state.
588 #if defined (TIOCGETC)
590 #endif /* TIOCGETC */
594 if (ldisc
== NTTYDISC
)
596 ioctl (FILEDES
, TIOCGLTC
, <c
);
597 ltc
.t_suspc
= CHK (ltc
.t_suspc
, CTRL ('Z'));
598 ltc
.t_dsuspc
= CHK (ltc
.t_dsuspc
, CTRL ('Y'));
599 ltc
.t_rprntc
= CHK (ltc
.t_rprntc
, CTRL ('R'));
600 ltc
.t_flushc
= CHK (ltc
.t_flushc
, CTRL ('O'));
601 ltc
.t_werasc
= CHK (ltc
.t_werasc
, CTRL ('W'));
602 ltc
.t_lnextc
= CHK (ltc
.t_lnextc
, CTRL ('V'));
603 ioctl (FILEDES
, TIOCSLTC
, <c
);
605 #endif /* UCB_NTTY */
607 ioctl (FILEDES
, TIOCGETC
, &tbuf
);
608 tbuf
.t_intrc
= CHK (tbuf
.t_intrc
, CTRL ('?'));
609 tbuf
.t_quitc
= CHK (tbuf
.t_quitc
, CTRL ('\\'));
610 tbuf
.t_startc
= CHK (tbuf
.t_startc
, CTRL ('Q'));
611 tbuf
.t_stopc
= CHK (tbuf
.t_stopc
, CTRL ('S'));
612 tbuf
.t_eofc
= CHK (tbuf
.t_eofc
, CTRL ('D'));
613 /* brkc is left alone. */
614 ioctl (FILEDES
, TIOCSETC
, &tbuf
);
615 #endif /* TIOCGETC */
616 mode
.sg_flags
&= ~(RAW
620 | VTDELAY
| ALLDELAY
);
621 mode
.sg_flags
|= XTABS
| ECHO
| CRMOD
| ANYP
;
628 tui_show_source (const char *fullname
, int line
)
630 struct symtab_and_line cursal
= get_current_source_symtab_and_line ();
632 /* Make sure that the source window is displayed. */
633 tui_add_win_to_layout (SRC_WIN
);
635 tui_update_source_windows_with_line (cursal
.symtab
, line
);
636 tui_update_locator_fullname (fullname
);
640 tui_show_assembly (struct gdbarch
*gdbarch
, CORE_ADDR addr
)
642 tui_add_win_to_layout (DISASSEM_WIN
);
643 tui_update_source_windows_with_addr (gdbarch
, addr
);
647 tui_is_window_visible (enum tui_win_type type
)
652 if (tui_win_list
[type
] == 0)
655 return tui_win_list
[type
]->generic
.is_visible
;
659 tui_get_command_dimension (unsigned int *width
,
660 unsigned int *height
)
662 if (!tui_active
|| (TUI_CMD_WIN
== NULL
))
667 *width
= TUI_CMD_WIN
->generic
.width
;
668 *height
= TUI_CMD_WIN
->generic
.height
;
672 /* Provide a prototype to silence -Wmissing-prototypes. */
673 extern initialize_file_ftype _initialize_tui
;
676 _initialize_tui (void)
678 struct cmd_list_element
**tuicmd
;
680 tuicmd
= tui_get_cmd_list ();
682 add_cmd ("enable", class_tui
, tui_enable_command
,
683 _("Enable TUI display mode."),
685 add_cmd ("disable", class_tui
, tui_disable_command
,
686 _("Disable TUI display mode."),