1 /* General functions for the WDB TUI.
3 Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2007
4 Free Software Foundation, Inc.
6 Contributed by Hewlett-Packard Company.
8 This file is part of GDB.
10 This program is free software; you can redistribute it and/or modify
11 it under the terms of the GNU General Public License as published by
12 the Free Software Foundation; either version 2 of the License, or
13 (at your option) any later version.
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License for more details.
20 You should have received a copy of the GNU General Public License
21 along with this program; if not, write to the Free Software
22 Foundation, Inc., 51 Franklin Street, Fifth Floor,
23 Boston, MA 02110-1301, USA. */
28 #include "tui/tui-hooks.h"
29 #include "tui/tui-data.h"
30 #include "tui/tui-layout.h"
31 #include "tui/tui-io.h"
32 #include "tui/tui-regs.h"
33 #include "tui/tui-stack.h"
34 #include "tui/tui-win.h"
35 #include "tui/tui-winsource.h"
36 #include "tui/tui-windata.h"
39 #include "breakpoint.h"
54 #include "gdb_curses.h"
56 /* This redefines CTRL if it is not already defined, so it must come
57 after terminal state releated include files like <term.h> and
59 #include "readline/readline.h"
61 /* Tells whether the TUI is active or not. */
63 static int tui_finish_init
= 1;
65 enum tui_key_mode tui_current_key_mode
= TUI_COMMAND_MODE
;
67 struct tui_char_command
73 /* Key mapping to gdb commands when the TUI is using the single key
75 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
)
103 rl_deprep_terminal ();
107 /* Clear the readline in case switching occurred in middle of
110 rl_kill_text (0, rl_end
);
112 /* Since we left the curses mode, the terminal mode is restored to
113 some previous state. That state may not be suitable for readline
114 to work correctly (it may be restored in line mode). We force an
115 exit of the current readline so that readline is re-entered and
116 it will be able to setup the terminal for its needs. By
117 re-entering in readline, we also redisplay its prompt in the
119 rl_newline (1, '\n');
121 /* Make sure the \n we are returning does not repeat the last
127 /* TUI readline command.
128 Change the TUI layout to show a next layout.
129 This function is bound to CTRL-X 2. It is intended to provide
130 a functionality close to the Emacs split-window command. We
131 always show two windows (src+asm), (src+regs) or (asm+regs). */
133 tui_rl_change_windows (int notused1
, int notused2
)
136 tui_rl_switch_mode (0 /* notused */, 0 /* notused */);
140 enum tui_layout_type new_layout
;
141 enum tui_register_display_type regs_type
= TUI_UNDEFINED_REGS
;
143 new_layout
= tui_current_layout ();
145 /* Select a new layout to have a rolling layout behavior with
146 always two windows (except when undefined). */
150 new_layout
= SRC_DISASSEM_COMMAND
;
153 case DISASSEM_COMMAND
:
154 new_layout
= SRC_DISASSEM_COMMAND
;
157 case SRC_DATA_COMMAND
:
158 new_layout
= SRC_DISASSEM_COMMAND
;
161 case SRC_DISASSEM_COMMAND
:
162 new_layout
= DISASSEM_DATA_COMMAND
;
165 case DISASSEM_DATA_COMMAND
:
166 new_layout
= SRC_DATA_COMMAND
;
170 new_layout
= SRC_COMMAND
;
173 tui_set_layout (new_layout
, regs_type
);
178 /* TUI readline command.
179 Delete the second TUI window to only show one. */
181 tui_rl_delete_other_windows (int notused1
, int notused2
)
184 tui_rl_switch_mode (0 /* notused */, 0 /* notused */);
188 enum tui_layout_type new_layout
;
189 enum tui_register_display_type regs_type
= TUI_UNDEFINED_REGS
;
191 new_layout
= tui_current_layout ();
193 /* Kill one window. */
197 case SRC_DATA_COMMAND
:
198 case SRC_DISASSEM_COMMAND
:
200 new_layout
= SRC_COMMAND
;
203 case DISASSEM_COMMAND
:
204 case DISASSEM_DATA_COMMAND
:
205 new_layout
= DISASSEM_COMMAND
;
208 tui_set_layout (new_layout
, regs_type
);
213 /* TUI readline command.
214 Switch the active window to give the focus to a next window. */
216 tui_rl_other_window (int count
, int key
)
218 struct tui_win_info
*win_info
;
221 tui_rl_switch_mode (0 /* notused */, 0 /* notused */);
223 win_info
= tui_next_win (tui_win_with_focus ());
226 tui_set_win_focus_to (win_info
);
227 if (TUI_DATA_WIN
&& TUI_DATA_WIN
->generic
.is_visible
)
228 tui_refresh_data_win ();
229 keypad (TUI_CMD_WIN
->generic
.handle
, (win_info
!= TUI_CMD_WIN
));
234 /* TUI readline command.
235 Execute the gdb command bound to the specified key. */
237 tui_rl_command_key (int count
, int key
)
241 reinitialize_more_filter ();
242 for (i
= 0; tui_commands
[i
].cmd
; i
++)
244 if (tui_commands
[i
].key
== key
)
246 /* Must save the command because it can be modified by
248 char *cmd
= alloca (strlen (tui_commands
[i
].cmd
) + 1);
249 strcpy (cmd
, tui_commands
[i
].cmd
);
250 execute_command (cmd
, TRUE
);
257 /* TUI readline command.
258 Temporarily leave the TUI SingleKey mode to allow editing
259 a gdb command with the normal readline. Once the command
260 is executed, the TUI SingleKey mode is installed back. */
262 tui_rl_command_mode (int count
, int key
)
264 tui_set_key_mode (TUI_ONE_COMMAND_MODE
);
265 return rl_insert (count
, key
);
268 /* TUI readline command.
269 Switch between TUI SingleKey mode and gdb readline editing. */
271 tui_rl_next_keymap (int notused1
, int notused2
)
274 tui_rl_switch_mode (0 /* notused */, 0 /* notused */);
276 tui_set_key_mode (tui_current_key_mode
== TUI_COMMAND_MODE
277 ? TUI_SINGLE_KEY_MODE
: TUI_COMMAND_MODE
);
281 /* Readline hook to redisplay ourself the gdb prompt.
282 In the SingleKey mode, the prompt is not printed so that
283 the command window is cleaner. It will be displayed if
284 we temporarily leave the SingleKey mode. */
286 tui_rl_startup_hook (void)
288 rl_already_prompted
= 1;
289 if (tui_current_key_mode
!= TUI_COMMAND_MODE
)
290 tui_set_key_mode (TUI_SINGLE_KEY_MODE
);
291 tui_redisplay_readline ();
295 /* Change the TUI key mode by installing the appropriate readline
298 tui_set_key_mode (enum tui_key_mode mode
)
300 tui_current_key_mode
= mode
;
301 rl_set_keymap (mode
== TUI_SINGLE_KEY_MODE
302 ? tui_keymap
: tui_readline_standard_keymap
);
303 tui_show_locator_content ();
306 /* Initialize readline and configure the keymap for the switching
309 tui_initialize_readline (void)
312 Keymap tui_ctlx_keymap
;
316 rl_add_defun ("tui-switch-mode", tui_rl_switch_mode
, -1);
317 rl_add_defun ("gdb-command", tui_rl_command_key
, -1);
318 rl_add_defun ("next-keymap", tui_rl_next_keymap
, -1);
320 tui_keymap
= rl_make_bare_keymap ();
321 tui_ctlx_keymap
= rl_make_bare_keymap ();
322 tui_readline_standard_keymap
= rl_get_keymap ();
324 for (i
= 0; tui_commands
[i
].cmd
; i
++)
325 rl_bind_key_in_map (tui_commands
[i
].key
, tui_rl_command_key
, tui_keymap
);
327 rl_generic_bind (ISKMAP
, "\\C-x", (char*) tui_ctlx_keymap
, tui_keymap
);
329 /* Bind all other keys to tui_rl_command_mode so that we switch
330 temporarily from SingleKey mode and can enter a gdb command. */
331 for (i
= ' '; i
< 0x7f; i
++)
335 for (j
= 0; tui_commands
[j
].cmd
; j
++)
336 if (tui_commands
[j
].key
== i
)
339 if (tui_commands
[j
].cmd
)
342 rl_bind_key_in_map (i
, tui_rl_command_mode
, tui_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 ('A', tui_rl_switch_mode
, emacs_ctlx_keymap
);
348 rl_bind_key_in_map ('A', tui_rl_switch_mode
, tui_ctlx_keymap
);
349 rl_bind_key_in_map (CTRL ('A'), tui_rl_switch_mode
, emacs_ctlx_keymap
);
350 rl_bind_key_in_map (CTRL ('A'), tui_rl_switch_mode
, tui_ctlx_keymap
);
351 rl_bind_key_in_map ('1', tui_rl_delete_other_windows
, emacs_ctlx_keymap
);
352 rl_bind_key_in_map ('1', tui_rl_delete_other_windows
, tui_ctlx_keymap
);
353 rl_bind_key_in_map ('2', tui_rl_change_windows
, emacs_ctlx_keymap
);
354 rl_bind_key_in_map ('2', tui_rl_change_windows
, tui_ctlx_keymap
);
355 rl_bind_key_in_map ('o', tui_rl_other_window
, emacs_ctlx_keymap
);
356 rl_bind_key_in_map ('o', tui_rl_other_window
, tui_ctlx_keymap
);
357 rl_bind_key_in_map ('q', tui_rl_next_keymap
, tui_keymap
);
358 rl_bind_key_in_map ('s', tui_rl_next_keymap
, emacs_ctlx_keymap
);
359 rl_bind_key_in_map ('s', tui_rl_next_keymap
, tui_ctlx_keymap
);
362 /* Enter in the tui mode (curses).
363 When in normal mode, it installs the tui hooks in gdb, redirects
364 the gdb output, configures the readline to work in tui mode.
365 When in curses mode, it does nothing. */
372 /* To avoid to initialize curses when gdb starts, there is a defered
373 curses initialization. This initialization is made only once
374 and the first time the curses mode is entered. */
388 tui_set_term_height_to (LINES
);
389 tui_set_term_width_to (COLS
);
392 tui_show_frame_info (0);
393 tui_set_layout (SRC_COMMAND
, TUI_UNDEFINED_REGS
);
394 tui_set_win_focus_to (TUI_SRC_WIN
);
395 keypad (TUI_CMD_WIN
->generic
.handle
, TRUE
);
396 wrefresh (TUI_CMD_WIN
->generic
.handle
);
401 /* Save the current gdb setting of the terminal.
402 Curses will restore this state when endwin() is called. */
404 clearok (stdscr
, TRUE
);
407 /* Install the TUI specific hooks. */
408 tui_install_hooks ();
409 rl_startup_hook
= tui_rl_startup_hook
;
411 tui_update_variables ();
416 if (deprecated_safe_get_selected_frame ())
417 tui_show_frame_info (deprecated_safe_get_selected_frame ());
419 /* Restore TUI keymap. */
420 tui_set_key_mode (tui_current_key_mode
);
421 tui_refresh_all_win ();
423 /* Update gdb's knowledge of its terminal. */
424 target_terminal_save_ours ();
425 tui_update_gdb_sizes ();
428 /* Leave the tui mode.
429 Remove the tui hooks and configure the gdb output and readline
430 back to their original state. The curses mode is left so that
431 the terminal setting is restored to the point when we entered. */
438 /* Restore initial readline keymap. */
439 rl_set_keymap (tui_readline_standard_keymap
);
441 /* Remove TUI hooks. */
444 rl_already_prompted
= 0;
446 /* Leave curses and restore previous gdb terminal setting. */
449 /* gdb terminal has changed, update gdb internal copy of it
450 so that terminal management with the inferior works. */
453 /* Update gdb's knowledge of its terminal. */
454 target_terminal_save_ours ();
457 tui_update_gdb_sizes ();
461 strcat_to_buf (char *buf
, int buflen
,
462 const char *item_to_add
)
464 if (item_to_add
!= (char *) NULL
&& buf
!= (char *) NULL
)
466 if ((strlen (buf
) + strlen (item_to_add
)) <= buflen
)
467 strcat (buf
, item_to_add
);
469 strncat (buf
, item_to_add
, (buflen
- strlen (buf
)));
474 /* Solaris <sys/termios.h> defines CTRL. */
476 #define CTRL(x) (x & ~0140)
480 #define CHK(val, dft) (val<=0 ? dft : val)
487 /* Reset the teletype mode bits to a sensible state.
489 #if defined (TIOCGETC)
491 #endif /* TIOCGETC */
495 if (ldisc
== NTTYDISC
)
497 ioctl (FILEDES
, TIOCGLTC
, <c
);
498 ltc
.t_suspc
= CHK (ltc
.t_suspc
, CTRL ('Z'));
499 ltc
.t_dsuspc
= CHK (ltc
.t_dsuspc
, CTRL ('Y'));
500 ltc
.t_rprntc
= CHK (ltc
.t_rprntc
, CTRL ('R'));
501 ltc
.t_flushc
= CHK (ltc
.t_flushc
, CTRL ('O'));
502 ltc
.t_werasc
= CHK (ltc
.t_werasc
, CTRL ('W'));
503 ltc
.t_lnextc
= CHK (ltc
.t_lnextc
, CTRL ('V'));
504 ioctl (FILEDES
, TIOCSLTC
, <c
);
506 #endif /* UCB_NTTY */
508 ioctl (FILEDES
, TIOCGETC
, &tbuf
);
509 tbuf
.t_intrc
= CHK (tbuf
.t_intrc
, CTRL ('?'));
510 tbuf
.t_quitc
= CHK (tbuf
.t_quitc
, CTRL ('\\'));
511 tbuf
.t_startc
= CHK (tbuf
.t_startc
, CTRL ('Q'));
512 tbuf
.t_stopc
= CHK (tbuf
.t_stopc
, CTRL ('S'));
513 tbuf
.t_eofc
= CHK (tbuf
.t_eofc
, CTRL ('D'));
514 /* brkc is left alone. */
515 ioctl (FILEDES
, TIOCSETC
, &tbuf
);
516 #endif /* TIOCGETC */
517 mode
.sg_flags
&= ~(RAW
521 | VTDELAY
| ALLDELAY
);
522 mode
.sg_flags
|= XTABS
| ECHO
| CRMOD
| ANYP
;
529 tui_show_source (const char *file
, int line
)
531 struct symtab_and_line cursal
= get_current_source_symtab_and_line ();
532 /* Make sure that the source window is displayed. */
533 tui_add_win_to_layout (SRC_WIN
);
535 tui_update_source_windows_with_line (cursal
.symtab
, line
);
536 tui_update_locator_filename (file
);
540 tui_show_assembly (CORE_ADDR addr
)
542 tui_add_win_to_layout (DISASSEM_WIN
);
543 tui_update_source_windows_with_addr (addr
);
547 tui_is_window_visible (enum tui_win_type type
)
552 if (tui_win_list
[type
] == 0)
555 return tui_win_list
[type
]->generic
.is_visible
;
559 tui_get_command_dimension (unsigned int *width
,
560 unsigned int *height
)
562 if (!tui_active
|| (TUI_CMD_WIN
== NULL
))
567 *width
= TUI_CMD_WIN
->generic
.width
;
568 *height
= TUI_CMD_WIN
->generic
.height
;