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
;
153 enum tui_register_display_type regs_type
= TUI_UNDEFINED_REGS
;
155 new_layout
= tui_current_layout ();
157 /* Select a new layout to have a rolling layout behavior with
158 always two windows (except when undefined). */
162 new_layout
= SRC_DISASSEM_COMMAND
;
165 case DISASSEM_COMMAND
:
166 new_layout
= SRC_DISASSEM_COMMAND
;
169 case SRC_DATA_COMMAND
:
170 new_layout
= SRC_DISASSEM_COMMAND
;
173 case SRC_DISASSEM_COMMAND
:
174 new_layout
= DISASSEM_DATA_COMMAND
;
177 case DISASSEM_DATA_COMMAND
:
178 new_layout
= SRC_DATA_COMMAND
;
182 new_layout
= SRC_COMMAND
;
185 tui_set_layout (new_layout
, regs_type
);
190 /* TUI readline command.
191 Delete the second TUI window to only show one. */
193 tui_rl_delete_other_windows (int notused1
, int notused2
)
196 tui_rl_switch_mode (0 /* notused */, 0 /* notused */);
200 enum tui_layout_type new_layout
;
201 enum tui_register_display_type regs_type
= TUI_UNDEFINED_REGS
;
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
, regs_type
);
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 if (TUI_DATA_WIN
&& TUI_DATA_WIN
->generic
.is_visible
)
240 tui_refresh_data_win ();
241 keypad (TUI_CMD_WIN
->generic
.handle
, (win_info
!= TUI_CMD_WIN
));
246 /* TUI readline command.
247 Execute the gdb command bound to the specified key. */
249 tui_rl_command_key (int count
, int key
)
253 reinitialize_more_filter ();
254 for (i
= 0; tui_commands
[i
].cmd
; i
++)
256 if (tui_commands
[i
].key
== key
)
258 /* Insert the command in the readline buffer.
259 Avoid calling the gdb command here since it creates
260 a possible recursion on readline if prompt_for_continue
261 is called (See PR 9584). The command will also appear
262 in the readline history which turns out to be better. */
263 rl_insert_text (tui_commands
[i
].cmd
);
264 rl_newline (1, '\n');
266 /* Switch to gdb command mode while executing the command.
267 This way the gdb's continue prompty will be displayed. */
268 tui_set_key_mode (TUI_ONE_COMMAND_MODE
);
275 /* TUI readline command.
276 Temporarily leave the TUI SingleKey mode to allow editing
277 a gdb command with the normal readline. Once the command
278 is executed, the TUI SingleKey mode is installed back. */
280 tui_rl_command_mode (int count
, int key
)
282 tui_set_key_mode (TUI_ONE_COMMAND_MODE
);
283 return rl_insert (count
, key
);
286 /* TUI readline command.
287 Switch between TUI SingleKey mode and gdb readline editing. */
289 tui_rl_next_keymap (int notused1
, int notused2
)
292 tui_rl_switch_mode (0 /* notused */, 0 /* notused */);
294 tui_set_key_mode (tui_current_key_mode
== TUI_COMMAND_MODE
295 ? TUI_SINGLE_KEY_MODE
: TUI_COMMAND_MODE
);
299 /* Readline hook to redisplay ourself the gdb prompt.
300 In the SingleKey mode, the prompt is not printed so that
301 the command window is cleaner. It will be displayed if
302 we temporarily leave the SingleKey mode. */
304 tui_rl_startup_hook (void)
306 rl_already_prompted
= 1;
307 if (tui_current_key_mode
!= TUI_COMMAND_MODE
&& immediate_quit
== 0)
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
;
334 rl_add_defun ("tui-switch-mode", tui_rl_switch_mode
, -1);
335 rl_add_defun ("gdb-command", tui_rl_command_key
, -1);
336 rl_add_defun ("next-keymap", tui_rl_next_keymap
, -1);
338 tui_keymap
= rl_make_bare_keymap ();
339 tui_ctlx_keymap
= rl_make_bare_keymap ();
340 tui_readline_standard_keymap
= rl_get_keymap ();
342 for (i
= 0; tui_commands
[i
].cmd
; i
++)
343 rl_bind_key_in_map (tui_commands
[i
].key
, tui_rl_command_key
, tui_keymap
);
345 rl_generic_bind (ISKMAP
, "\\C-x", (char*) tui_ctlx_keymap
, tui_keymap
);
347 /* Bind all other keys to tui_rl_command_mode so that we switch
348 temporarily from SingleKey mode and can enter a gdb command. */
349 for (i
= ' '; i
< 0x7f; i
++)
353 for (j
= 0; tui_commands
[j
].cmd
; j
++)
354 if (tui_commands
[j
].key
== i
)
357 if (tui_commands
[j
].cmd
)
360 rl_bind_key_in_map (i
, tui_rl_command_mode
, tui_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 ('A', tui_rl_switch_mode
, emacs_ctlx_keymap
);
366 rl_bind_key_in_map ('A', tui_rl_switch_mode
, tui_ctlx_keymap
);
367 rl_bind_key_in_map (CTRL ('A'), tui_rl_switch_mode
, emacs_ctlx_keymap
);
368 rl_bind_key_in_map (CTRL ('A'), tui_rl_switch_mode
, tui_ctlx_keymap
);
369 rl_bind_key_in_map ('1', tui_rl_delete_other_windows
, emacs_ctlx_keymap
);
370 rl_bind_key_in_map ('1', tui_rl_delete_other_windows
, tui_ctlx_keymap
);
371 rl_bind_key_in_map ('2', tui_rl_change_windows
, emacs_ctlx_keymap
);
372 rl_bind_key_in_map ('2', tui_rl_change_windows
, tui_ctlx_keymap
);
373 rl_bind_key_in_map ('o', tui_rl_other_window
, emacs_ctlx_keymap
);
374 rl_bind_key_in_map ('o', tui_rl_other_window
, tui_ctlx_keymap
);
375 rl_bind_key_in_map ('q', tui_rl_next_keymap
, tui_keymap
);
376 rl_bind_key_in_map ('s', tui_rl_next_keymap
, emacs_ctlx_keymap
);
377 rl_bind_key_in_map ('s', tui_rl_next_keymap
, tui_ctlx_keymap
);
380 /* Return the TERM variable from the environment, or "<unset>"
384 gdb_getenv_term (void)
388 term
= getenv ("TERM");
394 /* Enter in the tui mode (curses).
395 When in normal mode, it installs the tui hooks in gdb, redirects
396 the gdb output, configures the readline to work in tui mode.
397 When in curses mode, it does nothing. */
401 struct interp
*interp
;
406 /* To avoid to initialize curses when gdb starts, there is a defered
407 curses initialization. This initialization is made only once
408 and the first time the curses mode is entered. */
416 /* If the top level interpreter is not the console/tui (e.g.,
417 MI), enabling curses will certainly lose. */
418 interp
= interp_name (top_level_interpreter ());
419 if (strcmp (interp
, INTERP_TUI
) != 0)
420 error (_("Cannot enable the TUI when the interpreter is '%s'"), interp
);
422 /* Don't try to setup curses (and print funny control
423 characters) if we're not outputting to a terminal. */
424 if (!ui_file_isatty (gdb_stdout
))
425 error (_("Cannot enable the TUI when output is not a terminal"));
427 s
= newterm (NULL
, stdout
, stdin
);
429 /* The MinGW port of ncurses requires $TERM to be unset in order
430 to activate the Windows console driver. */
432 s
= newterm ("unknown", stdout
, stdin
);
436 error (_("Cannot enable the TUI: error opening terminal [TERM=%s]"),
441 /* Check required terminal capabilities. The MinGW port of
442 ncurses does have them, but doesn't expose them through "cup". */
444 cap
= tigetstr ("cup");
445 if (cap
== NULL
|| cap
== (char *) -1 || *cap
== '\0')
449 error (_("Cannot enable the TUI: "
450 "terminal doesn't support cursor addressing [TERM=%s]"),
462 tui_set_term_height_to (LINES
);
463 tui_set_term_width_to (COLS
);
466 tui_show_frame_info (0);
467 tui_set_layout (SRC_COMMAND
, TUI_UNDEFINED_REGS
);
468 tui_set_win_focus_to (TUI_SRC_WIN
);
469 keypad (TUI_CMD_WIN
->generic
.handle
, TRUE
);
470 wrefresh (TUI_CMD_WIN
->generic
.handle
);
475 /* Save the current gdb setting of the terminal.
476 Curses will restore this state when endwin() is called. */
478 clearok (stdscr
, TRUE
);
481 /* Install the TUI specific hooks. */
482 tui_install_hooks ();
483 rl_startup_hook
= tui_rl_startup_hook
;
485 tui_update_variables ();
491 /* Resize windows before anything might display/refresh a
493 if (tui_win_resized ())
496 tui_set_win_resized_to (FALSE
);
499 if (deprecated_safe_get_selected_frame ())
500 tui_show_frame_info (deprecated_safe_get_selected_frame ());
502 /* Restore TUI keymap. */
503 tui_set_key_mode (tui_current_key_mode
);
505 /* Refresh the screen. */
506 tui_refresh_all_win ();
508 /* Update gdb's knowledge of its terminal. */
509 gdb_save_tty_state ();
510 tui_update_gdb_sizes ();
513 /* Leave the tui mode.
514 Remove the tui hooks and configure the gdb output and readline
515 back to their original state. The curses mode is left so that
516 the terminal setting is restored to the point when we entered. */
523 /* Restore initial readline keymap. */
524 rl_set_keymap (tui_readline_standard_keymap
);
526 /* Remove TUI hooks. */
529 rl_already_prompted
= 0;
531 /* Leave curses and restore previous gdb terminal setting. */
534 /* gdb terminal has changed, update gdb internal copy of it
535 so that terminal management with the inferior works. */
538 /* Update gdb's knowledge of its terminal. */
539 gdb_save_tty_state ();
542 tui_update_gdb_sizes ();
546 strcat_to_buf (char *buf
, int buflen
,
547 const char *item_to_add
)
549 if (item_to_add
!= (char *) NULL
&& buf
!= (char *) NULL
)
551 if ((strlen (buf
) + strlen (item_to_add
)) <= buflen
)
552 strcat (buf
, item_to_add
);
554 strncat (buf
, item_to_add
, (buflen
- strlen (buf
)));
559 /* Solaris <sys/termios.h> defines CTRL. */
561 #define CTRL(x) (x & ~0140)
565 #define CHK(val, dft) (val<=0 ? dft : val)
572 /* Reset the teletype mode bits to a sensible state.
574 #if defined (TIOCGETC)
576 #endif /* TIOCGETC */
580 if (ldisc
== NTTYDISC
)
582 ioctl (FILEDES
, TIOCGLTC
, <c
);
583 ltc
.t_suspc
= CHK (ltc
.t_suspc
, CTRL ('Z'));
584 ltc
.t_dsuspc
= CHK (ltc
.t_dsuspc
, CTRL ('Y'));
585 ltc
.t_rprntc
= CHK (ltc
.t_rprntc
, CTRL ('R'));
586 ltc
.t_flushc
= CHK (ltc
.t_flushc
, CTRL ('O'));
587 ltc
.t_werasc
= CHK (ltc
.t_werasc
, CTRL ('W'));
588 ltc
.t_lnextc
= CHK (ltc
.t_lnextc
, CTRL ('V'));
589 ioctl (FILEDES
, TIOCSLTC
, <c
);
591 #endif /* UCB_NTTY */
593 ioctl (FILEDES
, TIOCGETC
, &tbuf
);
594 tbuf
.t_intrc
= CHK (tbuf
.t_intrc
, CTRL ('?'));
595 tbuf
.t_quitc
= CHK (tbuf
.t_quitc
, CTRL ('\\'));
596 tbuf
.t_startc
= CHK (tbuf
.t_startc
, CTRL ('Q'));
597 tbuf
.t_stopc
= CHK (tbuf
.t_stopc
, CTRL ('S'));
598 tbuf
.t_eofc
= CHK (tbuf
.t_eofc
, CTRL ('D'));
599 /* brkc is left alone. */
600 ioctl (FILEDES
, TIOCSETC
, &tbuf
);
601 #endif /* TIOCGETC */
602 mode
.sg_flags
&= ~(RAW
606 | VTDELAY
| ALLDELAY
);
607 mode
.sg_flags
|= XTABS
| ECHO
| CRMOD
| ANYP
;
614 tui_show_source (const char *fullname
, int line
)
616 struct symtab_and_line cursal
= get_current_source_symtab_and_line ();
618 /* Make sure that the source window is displayed. */
619 tui_add_win_to_layout (SRC_WIN
);
621 tui_update_source_windows_with_line (cursal
.symtab
, line
);
622 tui_update_locator_fullname (fullname
);
626 tui_show_assembly (struct gdbarch
*gdbarch
, CORE_ADDR addr
)
628 tui_add_win_to_layout (DISASSEM_WIN
);
629 tui_update_source_windows_with_addr (gdbarch
, addr
);
633 tui_is_window_visible (enum tui_win_type type
)
638 if (tui_win_list
[type
] == 0)
641 return tui_win_list
[type
]->generic
.is_visible
;
645 tui_get_command_dimension (unsigned int *width
,
646 unsigned int *height
)
648 if (!tui_active
|| (TUI_CMD_WIN
== NULL
))
653 *width
= TUI_CMD_WIN
->generic
.width
;
654 *height
= TUI_CMD_WIN
->generic
.height
;