1 /* General functions for the WDB TUI.
3 Copyright (C) 1998-2014 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 /* Insert the command in the readline buffer.
244 Avoid calling the gdb command here since it creates
245 a possible recursion on readline if prompt_for_continue
246 is called (See PR 9584). The command will also appear
247 in the readline history which turns out to be better. */
248 rl_insert_text (tui_commands
[i
].cmd
);
249 rl_newline (1, '\n');
251 /* Switch to gdb command mode while executing the command.
252 This way the gdb's continue prompty will be displayed. */
253 tui_set_key_mode (TUI_ONE_COMMAND_MODE
);
260 /* TUI readline command.
261 Temporarily leave the TUI SingleKey mode to allow editing
262 a gdb command with the normal readline. Once the command
263 is executed, the TUI SingleKey mode is installed back. */
265 tui_rl_command_mode (int count
, int key
)
267 tui_set_key_mode (TUI_ONE_COMMAND_MODE
);
268 return rl_insert (count
, key
);
271 /* TUI readline command.
272 Switch between TUI SingleKey mode and gdb readline editing. */
274 tui_rl_next_keymap (int notused1
, int notused2
)
277 tui_rl_switch_mode (0 /* notused */, 0 /* notused */);
279 tui_set_key_mode (tui_current_key_mode
== TUI_COMMAND_MODE
280 ? TUI_SINGLE_KEY_MODE
: TUI_COMMAND_MODE
);
284 /* Readline hook to redisplay ourself the gdb prompt.
285 In the SingleKey mode, the prompt is not printed so that
286 the command window is cleaner. It will be displayed if
287 we temporarily leave the SingleKey mode. */
289 tui_rl_startup_hook (void)
291 rl_already_prompted
= 1;
292 if (tui_current_key_mode
!= TUI_COMMAND_MODE
&& immediate_quit
== 0)
293 tui_set_key_mode (TUI_SINGLE_KEY_MODE
);
294 tui_redisplay_readline ();
298 /* Change the TUI key mode by installing the appropriate readline
301 tui_set_key_mode (enum tui_key_mode mode
)
303 tui_current_key_mode
= mode
;
304 rl_set_keymap (mode
== TUI_SINGLE_KEY_MODE
305 ? tui_keymap
: tui_readline_standard_keymap
);
306 tui_show_locator_content ();
309 /* Initialize readline and configure the keymap for the switching
312 tui_initialize_readline (void)
315 Keymap tui_ctlx_keymap
;
319 rl_add_defun ("tui-switch-mode", tui_rl_switch_mode
, -1);
320 rl_add_defun ("gdb-command", tui_rl_command_key
, -1);
321 rl_add_defun ("next-keymap", tui_rl_next_keymap
, -1);
323 tui_keymap
= rl_make_bare_keymap ();
324 tui_ctlx_keymap
= rl_make_bare_keymap ();
325 tui_readline_standard_keymap
= rl_get_keymap ();
327 for (i
= 0; tui_commands
[i
].cmd
; i
++)
328 rl_bind_key_in_map (tui_commands
[i
].key
, tui_rl_command_key
, tui_keymap
);
330 rl_generic_bind (ISKMAP
, "\\C-x", (char*) tui_ctlx_keymap
, tui_keymap
);
332 /* Bind all other keys to tui_rl_command_mode so that we switch
333 temporarily from SingleKey mode and can enter a gdb command. */
334 for (i
= ' '; i
< 0x7f; i
++)
338 for (j
= 0; tui_commands
[j
].cmd
; j
++)
339 if (tui_commands
[j
].key
== i
)
342 if (tui_commands
[j
].cmd
)
345 rl_bind_key_in_map (i
, tui_rl_command_mode
, tui_keymap
);
348 rl_bind_key_in_map ('a', tui_rl_switch_mode
, emacs_ctlx_keymap
);
349 rl_bind_key_in_map ('a', tui_rl_switch_mode
, tui_ctlx_keymap
);
350 rl_bind_key_in_map ('A', tui_rl_switch_mode
, emacs_ctlx_keymap
);
351 rl_bind_key_in_map ('A', tui_rl_switch_mode
, tui_ctlx_keymap
);
352 rl_bind_key_in_map (CTRL ('A'), tui_rl_switch_mode
, emacs_ctlx_keymap
);
353 rl_bind_key_in_map (CTRL ('A'), tui_rl_switch_mode
, tui_ctlx_keymap
);
354 rl_bind_key_in_map ('1', tui_rl_delete_other_windows
, emacs_ctlx_keymap
);
355 rl_bind_key_in_map ('1', tui_rl_delete_other_windows
, tui_ctlx_keymap
);
356 rl_bind_key_in_map ('2', tui_rl_change_windows
, emacs_ctlx_keymap
);
357 rl_bind_key_in_map ('2', tui_rl_change_windows
, tui_ctlx_keymap
);
358 rl_bind_key_in_map ('o', tui_rl_other_window
, emacs_ctlx_keymap
);
359 rl_bind_key_in_map ('o', tui_rl_other_window
, tui_ctlx_keymap
);
360 rl_bind_key_in_map ('q', tui_rl_next_keymap
, tui_keymap
);
361 rl_bind_key_in_map ('s', tui_rl_next_keymap
, emacs_ctlx_keymap
);
362 rl_bind_key_in_map ('s', tui_rl_next_keymap
, tui_ctlx_keymap
);
365 /* Enter in the tui mode (curses).
366 When in normal mode, it installs the tui hooks in gdb, redirects
367 the gdb output, configures the readline to work in tui mode.
368 When in curses mode, it does nothing. */
372 if (!tui_allowed_p ())
373 error (_("TUI mode not allowed"));
378 /* To avoid to initialize curses when gdb starts, there is a defered
379 curses initialization. This initialization is made only once
380 and the first time the curses mode is entered. */
394 tui_set_term_height_to (LINES
);
395 tui_set_term_width_to (COLS
);
398 tui_show_frame_info (0);
399 tui_set_layout (SRC_COMMAND
, TUI_UNDEFINED_REGS
);
400 tui_set_win_focus_to (TUI_SRC_WIN
);
401 keypad (TUI_CMD_WIN
->generic
.handle
, TRUE
);
402 wrefresh (TUI_CMD_WIN
->generic
.handle
);
407 /* Save the current gdb setting of the terminal.
408 Curses will restore this state when endwin() is called. */
410 clearok (stdscr
, TRUE
);
413 /* Install the TUI specific hooks. */
414 tui_install_hooks ();
415 rl_startup_hook
= tui_rl_startup_hook
;
417 tui_update_variables ();
422 if (deprecated_safe_get_selected_frame ())
423 tui_show_frame_info (deprecated_safe_get_selected_frame ());
425 /* Restore TUI keymap. */
426 tui_set_key_mode (tui_current_key_mode
);
427 tui_refresh_all_win ();
429 /* Update gdb's knowledge of its terminal. */
430 target_terminal_save_ours ();
431 tui_update_gdb_sizes ();
434 /* Leave the tui mode.
435 Remove the tui hooks and configure the gdb output and readline
436 back to their original state. The curses mode is left so that
437 the terminal setting is restored to the point when we entered. */
444 /* Restore initial readline keymap. */
445 rl_set_keymap (tui_readline_standard_keymap
);
447 /* Remove TUI hooks. */
450 rl_already_prompted
= 0;
452 /* Leave curses and restore previous gdb terminal setting. */
455 /* gdb terminal has changed, update gdb internal copy of it
456 so that terminal management with the inferior works. */
459 /* Update gdb's knowledge of its terminal. */
460 target_terminal_save_ours ();
463 tui_update_gdb_sizes ();
467 strcat_to_buf (char *buf
, int buflen
,
468 const char *item_to_add
)
470 if (item_to_add
!= (char *) NULL
&& buf
!= (char *) NULL
)
472 if ((strlen (buf
) + strlen (item_to_add
)) <= buflen
)
473 strcat (buf
, item_to_add
);
475 strncat (buf
, item_to_add
, (buflen
- strlen (buf
)));
480 /* Solaris <sys/termios.h> defines CTRL. */
482 #define CTRL(x) (x & ~0140)
486 #define CHK(val, dft) (val<=0 ? dft : val)
493 /* Reset the teletype mode bits to a sensible state.
495 #if defined (TIOCGETC)
497 #endif /* TIOCGETC */
501 if (ldisc
== NTTYDISC
)
503 ioctl (FILEDES
, TIOCGLTC
, <c
);
504 ltc
.t_suspc
= CHK (ltc
.t_suspc
, CTRL ('Z'));
505 ltc
.t_dsuspc
= CHK (ltc
.t_dsuspc
, CTRL ('Y'));
506 ltc
.t_rprntc
= CHK (ltc
.t_rprntc
, CTRL ('R'));
507 ltc
.t_flushc
= CHK (ltc
.t_flushc
, CTRL ('O'));
508 ltc
.t_werasc
= CHK (ltc
.t_werasc
, CTRL ('W'));
509 ltc
.t_lnextc
= CHK (ltc
.t_lnextc
, CTRL ('V'));
510 ioctl (FILEDES
, TIOCSLTC
, <c
);
512 #endif /* UCB_NTTY */
514 ioctl (FILEDES
, TIOCGETC
, &tbuf
);
515 tbuf
.t_intrc
= CHK (tbuf
.t_intrc
, CTRL ('?'));
516 tbuf
.t_quitc
= CHK (tbuf
.t_quitc
, CTRL ('\\'));
517 tbuf
.t_startc
= CHK (tbuf
.t_startc
, CTRL ('Q'));
518 tbuf
.t_stopc
= CHK (tbuf
.t_stopc
, CTRL ('S'));
519 tbuf
.t_eofc
= CHK (tbuf
.t_eofc
, CTRL ('D'));
520 /* brkc is left alone. */
521 ioctl (FILEDES
, TIOCSETC
, &tbuf
);
522 #endif /* TIOCGETC */
523 mode
.sg_flags
&= ~(RAW
527 | VTDELAY
| ALLDELAY
);
528 mode
.sg_flags
|= XTABS
| ECHO
| CRMOD
| ANYP
;
535 tui_show_source (const char *fullname
, int line
)
537 struct symtab_and_line cursal
= get_current_source_symtab_and_line ();
539 /* Make sure that the source window is displayed. */
540 tui_add_win_to_layout (SRC_WIN
);
542 tui_update_source_windows_with_line (cursal
.symtab
, line
);
543 tui_update_locator_fullname (fullname
);
547 tui_show_assembly (struct gdbarch
*gdbarch
, CORE_ADDR addr
)
549 tui_add_win_to_layout (DISASSEM_WIN
);
550 tui_update_source_windows_with_addr (gdbarch
, addr
);
554 tui_is_window_visible (enum tui_win_type type
)
559 if (tui_win_list
[type
] == 0)
562 return tui_win_list
[type
]->generic
.is_visible
;
566 tui_get_command_dimension (unsigned int *width
,
567 unsigned int *height
)
569 if (!tui_active
|| (TUI_CMD_WIN
== NULL
))
574 *width
= TUI_CMD_WIN
->generic
.width
;
575 *height
= TUI_CMD_WIN
->generic
.height
;