1 /* General functions for the WDB TUI.
3 Copyright (C) 1998-2004, 2007-2012 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"
51 #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
)
100 rl_deprep_terminal ();
104 /* Clear the readline in case switching occurred in middle of
107 rl_kill_text (0, rl_end
);
109 /* Since we left the curses mode, the terminal mode is restored to
110 some previous state. That state may not be suitable for readline
111 to work correctly (it may be restored in line mode). We force an
112 exit of the current readline so that readline is re-entered and
113 it will be able to setup the terminal for its needs. By
114 re-entering in readline, we also redisplay its prompt in the
116 rl_newline (1, '\n');
118 /* Make sure the \n we are returning does not repeat the last
124 /* TUI readline command.
125 Change the TUI layout to show a next layout.
126 This function is bound to CTRL-X 2. It is intended to provide
127 a functionality close to the Emacs split-window command. We
128 always show two windows (src+asm), (src+regs) or (asm+regs). */
130 tui_rl_change_windows (int notused1
, int notused2
)
133 tui_rl_switch_mode (0 /* notused */, 0 /* notused */);
137 enum tui_layout_type new_layout
;
138 enum tui_register_display_type regs_type
= TUI_UNDEFINED_REGS
;
140 new_layout
= tui_current_layout ();
142 /* Select a new layout to have a rolling layout behavior with
143 always two windows (except when undefined). */
147 new_layout
= SRC_DISASSEM_COMMAND
;
150 case DISASSEM_COMMAND
:
151 new_layout
= SRC_DISASSEM_COMMAND
;
154 case SRC_DATA_COMMAND
:
155 new_layout
= SRC_DISASSEM_COMMAND
;
158 case SRC_DISASSEM_COMMAND
:
159 new_layout
= DISASSEM_DATA_COMMAND
;
162 case DISASSEM_DATA_COMMAND
:
163 new_layout
= SRC_DATA_COMMAND
;
167 new_layout
= SRC_COMMAND
;
170 tui_set_layout (new_layout
, regs_type
);
175 /* TUI readline command.
176 Delete the second TUI window to only show one. */
178 tui_rl_delete_other_windows (int notused1
, int notused2
)
181 tui_rl_switch_mode (0 /* notused */, 0 /* notused */);
185 enum tui_layout_type new_layout
;
186 enum tui_register_display_type regs_type
= TUI_UNDEFINED_REGS
;
188 new_layout
= tui_current_layout ();
190 /* Kill one window. */
194 case SRC_DATA_COMMAND
:
195 case SRC_DISASSEM_COMMAND
:
197 new_layout
= SRC_COMMAND
;
200 case DISASSEM_COMMAND
:
201 case DISASSEM_DATA_COMMAND
:
202 new_layout
= DISASSEM_COMMAND
;
205 tui_set_layout (new_layout
, regs_type
);
210 /* TUI readline command.
211 Switch the active window to give the focus to a next window. */
213 tui_rl_other_window (int count
, int key
)
215 struct tui_win_info
*win_info
;
218 tui_rl_switch_mode (0 /* notused */, 0 /* notused */);
220 win_info
= tui_next_win (tui_win_with_focus ());
223 tui_set_win_focus_to (win_info
);
224 if (TUI_DATA_WIN
&& TUI_DATA_WIN
->generic
.is_visible
)
225 tui_refresh_data_win ();
226 keypad (TUI_CMD_WIN
->generic
.handle
, (win_info
!= TUI_CMD_WIN
));
231 /* TUI readline command.
232 Execute the gdb command bound to the specified key. */
234 tui_rl_command_key (int count
, int key
)
238 reinitialize_more_filter ();
239 for (i
= 0; tui_commands
[i
].cmd
; i
++)
241 if (tui_commands
[i
].key
== key
)
243 /* Must save the command because it can be modified by
245 char *cmd
= alloca (strlen (tui_commands
[i
].cmd
) + 1);
247 strcpy (cmd
, tui_commands
[i
].cmd
);
248 execute_command (cmd
, TRUE
);
255 /* TUI readline command.
256 Temporarily leave the TUI SingleKey mode to allow editing
257 a gdb command with the normal readline. Once the command
258 is executed, the TUI SingleKey mode is installed back. */
260 tui_rl_command_mode (int count
, int key
)
262 tui_set_key_mode (TUI_ONE_COMMAND_MODE
);
263 return rl_insert (count
, key
);
266 /* TUI readline command.
267 Switch between TUI SingleKey mode and gdb readline editing. */
269 tui_rl_next_keymap (int notused1
, int notused2
)
272 tui_rl_switch_mode (0 /* notused */, 0 /* notused */);
274 tui_set_key_mode (tui_current_key_mode
== TUI_COMMAND_MODE
275 ? TUI_SINGLE_KEY_MODE
: TUI_COMMAND_MODE
);
279 /* Readline hook to redisplay ourself the gdb prompt.
280 In the SingleKey mode, the prompt is not printed so that
281 the command window is cleaner. It will be displayed if
282 we temporarily leave the SingleKey mode. */
284 tui_rl_startup_hook (void)
286 rl_already_prompted
= 1;
287 if (tui_current_key_mode
!= TUI_COMMAND_MODE
)
288 tui_set_key_mode (TUI_SINGLE_KEY_MODE
);
289 tui_redisplay_readline ();
293 /* Change the TUI key mode by installing the appropriate readline
296 tui_set_key_mode (enum tui_key_mode mode
)
298 tui_current_key_mode
= mode
;
299 rl_set_keymap (mode
== TUI_SINGLE_KEY_MODE
300 ? tui_keymap
: tui_readline_standard_keymap
);
301 tui_show_locator_content ();
304 /* Initialize readline and configure the keymap for the switching
307 tui_initialize_readline (void)
310 Keymap tui_ctlx_keymap
;
314 rl_add_defun ("tui-switch-mode", tui_rl_switch_mode
, -1);
315 rl_add_defun ("gdb-command", tui_rl_command_key
, -1);
316 rl_add_defun ("next-keymap", tui_rl_next_keymap
, -1);
318 tui_keymap
= rl_make_bare_keymap ();
319 tui_ctlx_keymap
= rl_make_bare_keymap ();
320 tui_readline_standard_keymap
= rl_get_keymap ();
322 for (i
= 0; tui_commands
[i
].cmd
; i
++)
323 rl_bind_key_in_map (tui_commands
[i
].key
, tui_rl_command_key
, tui_keymap
);
325 rl_generic_bind (ISKMAP
, "\\C-x", (char*) tui_ctlx_keymap
, tui_keymap
);
327 /* Bind all other keys to tui_rl_command_mode so that we switch
328 temporarily from SingleKey mode and can enter a gdb command. */
329 for (i
= ' '; i
< 0x7f; i
++)
333 for (j
= 0; tui_commands
[j
].cmd
; j
++)
334 if (tui_commands
[j
].key
== i
)
337 if (tui_commands
[j
].cmd
)
340 rl_bind_key_in_map (i
, tui_rl_command_mode
, tui_keymap
);
343 rl_bind_key_in_map ('a', tui_rl_switch_mode
, emacs_ctlx_keymap
);
344 rl_bind_key_in_map ('a', tui_rl_switch_mode
, tui_ctlx_keymap
);
345 rl_bind_key_in_map ('A', tui_rl_switch_mode
, emacs_ctlx_keymap
);
346 rl_bind_key_in_map ('A', tui_rl_switch_mode
, tui_ctlx_keymap
);
347 rl_bind_key_in_map (CTRL ('A'), tui_rl_switch_mode
, emacs_ctlx_keymap
);
348 rl_bind_key_in_map (CTRL ('A'), tui_rl_switch_mode
, tui_ctlx_keymap
);
349 rl_bind_key_in_map ('1', tui_rl_delete_other_windows
, emacs_ctlx_keymap
);
350 rl_bind_key_in_map ('1', tui_rl_delete_other_windows
, tui_ctlx_keymap
);
351 rl_bind_key_in_map ('2', tui_rl_change_windows
, emacs_ctlx_keymap
);
352 rl_bind_key_in_map ('2', tui_rl_change_windows
, tui_ctlx_keymap
);
353 rl_bind_key_in_map ('o', tui_rl_other_window
, emacs_ctlx_keymap
);
354 rl_bind_key_in_map ('o', tui_rl_other_window
, tui_ctlx_keymap
);
355 rl_bind_key_in_map ('q', tui_rl_next_keymap
, tui_keymap
);
356 rl_bind_key_in_map ('s', tui_rl_next_keymap
, emacs_ctlx_keymap
);
357 rl_bind_key_in_map ('s', tui_rl_next_keymap
, tui_ctlx_keymap
);
360 /* Enter in the tui mode (curses).
361 When in normal mode, it installs the tui hooks in gdb, redirects
362 the gdb output, configures the readline to work in tui mode.
363 When in curses mode, it does nothing. */
367 if (!tui_allowed_p ())
368 error (_("TUI mode not allowed"));
373 /* To avoid to initialize curses when gdb starts, there is a defered
374 curses initialization. This initialization is made only once
375 and the first time the curses mode is entered. */
389 tui_set_term_height_to (LINES
);
390 tui_set_term_width_to (COLS
);
393 tui_show_frame_info (0);
394 tui_set_layout (SRC_COMMAND
, TUI_UNDEFINED_REGS
);
395 tui_set_win_focus_to (TUI_SRC_WIN
);
396 keypad (TUI_CMD_WIN
->generic
.handle
, TRUE
);
397 wrefresh (TUI_CMD_WIN
->generic
.handle
);
402 /* Save the current gdb setting of the terminal.
403 Curses will restore this state when endwin() is called. */
405 clearok (stdscr
, TRUE
);
408 /* Install the TUI specific hooks. */
409 tui_install_hooks ();
410 rl_startup_hook
= tui_rl_startup_hook
;
412 tui_update_variables ();
417 if (deprecated_safe_get_selected_frame ())
418 tui_show_frame_info (deprecated_safe_get_selected_frame ());
420 /* Restore TUI keymap. */
421 tui_set_key_mode (tui_current_key_mode
);
422 tui_refresh_all_win ();
424 /* Update gdb's knowledge of its terminal. */
425 target_terminal_save_ours ();
426 tui_update_gdb_sizes ();
429 /* Leave the tui mode.
430 Remove the tui hooks and configure the gdb output and readline
431 back to their original state. The curses mode is left so that
432 the terminal setting is restored to the point when we entered. */
439 /* Restore initial readline keymap. */
440 rl_set_keymap (tui_readline_standard_keymap
);
442 /* Remove TUI hooks. */
445 rl_already_prompted
= 0;
447 /* Leave curses and restore previous gdb terminal setting. */
450 /* gdb terminal has changed, update gdb internal copy of it
451 so that terminal management with the inferior works. */
454 /* Update gdb's knowledge of its terminal. */
455 target_terminal_save_ours ();
458 tui_update_gdb_sizes ();
462 strcat_to_buf (char *buf
, int buflen
,
463 const char *item_to_add
)
465 if (item_to_add
!= (char *) NULL
&& buf
!= (char *) NULL
)
467 if ((strlen (buf
) + strlen (item_to_add
)) <= buflen
)
468 strcat (buf
, item_to_add
);
470 strncat (buf
, item_to_add
, (buflen
- strlen (buf
)));
475 /* Solaris <sys/termios.h> defines CTRL. */
477 #define CTRL(x) (x & ~0140)
481 #define CHK(val, dft) (val<=0 ? dft : val)
488 /* Reset the teletype mode bits to a sensible state.
490 #if defined (TIOCGETC)
492 #endif /* TIOCGETC */
496 if (ldisc
== NTTYDISC
)
498 ioctl (FILEDES
, TIOCGLTC
, <c
);
499 ltc
.t_suspc
= CHK (ltc
.t_suspc
, CTRL ('Z'));
500 ltc
.t_dsuspc
= CHK (ltc
.t_dsuspc
, CTRL ('Y'));
501 ltc
.t_rprntc
= CHK (ltc
.t_rprntc
, CTRL ('R'));
502 ltc
.t_flushc
= CHK (ltc
.t_flushc
, CTRL ('O'));
503 ltc
.t_werasc
= CHK (ltc
.t_werasc
, CTRL ('W'));
504 ltc
.t_lnextc
= CHK (ltc
.t_lnextc
, CTRL ('V'));
505 ioctl (FILEDES
, TIOCSLTC
, <c
);
507 #endif /* UCB_NTTY */
509 ioctl (FILEDES
, TIOCGETC
, &tbuf
);
510 tbuf
.t_intrc
= CHK (tbuf
.t_intrc
, CTRL ('?'));
511 tbuf
.t_quitc
= CHK (tbuf
.t_quitc
, CTRL ('\\'));
512 tbuf
.t_startc
= CHK (tbuf
.t_startc
, CTRL ('Q'));
513 tbuf
.t_stopc
= CHK (tbuf
.t_stopc
, CTRL ('S'));
514 tbuf
.t_eofc
= CHK (tbuf
.t_eofc
, CTRL ('D'));
515 /* brkc is left alone. */
516 ioctl (FILEDES
, TIOCSETC
, &tbuf
);
517 #endif /* TIOCGETC */
518 mode
.sg_flags
&= ~(RAW
522 | VTDELAY
| ALLDELAY
);
523 mode
.sg_flags
|= XTABS
| ECHO
| CRMOD
| ANYP
;
530 tui_show_source (const char *file
, int line
)
532 struct symtab_and_line cursal
= get_current_source_symtab_and_line ();
534 /* Make sure that the source window is displayed. */
535 tui_add_win_to_layout (SRC_WIN
);
537 tui_update_source_windows_with_line (cursal
.symtab
, line
);
538 tui_update_locator_filename (file
);
542 tui_show_assembly (struct gdbarch
*gdbarch
, CORE_ADDR addr
)
544 tui_add_win_to_layout (DISASSEM_WIN
);
545 tui_update_source_windows_with_addr (gdbarch
, addr
);
549 tui_is_window_visible (enum tui_win_type type
)
554 if (tui_win_list
[type
] == 0)
557 return tui_win_list
[type
]->generic
.is_visible
;
561 tui_get_command_dimension (unsigned int *width
,
562 unsigned int *height
)
564 if (!tui_active
|| (TUI_CMD_WIN
== NULL
))
569 *width
= TUI_CMD_WIN
->generic
.width
;
570 *height
= TUI_CMD_WIN
->generic
.height
;