1 /* General functions for the WDB TUI.
3 Copyright 1998, 1999, 2000, 2001, 2002, 2003, 2004 Free Software
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., 59 Temple Place - Suite 330,
23 Boston, MA 02111-1307, 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"
37 #include "readline/readline.h"
40 #include "breakpoint.h"
58 #include "gdb_curses.h"
60 /* Tells whether the TUI is active or not. */
62 static int tui_finish_init
= 1;
64 enum tui_key_mode tui_current_key_mode
= TUI_COMMAND_MODE
;
66 struct tui_char_command
72 /* Key mapping to gdb commands when the TUI is using the single key mode. */
73 static const struct tui_char_command tui_commands
[] = {
81 { 'v', "info locals" },
86 static Keymap tui_keymap
;
87 static Keymap tui_readline_standard_keymap
;
89 /* TUI readline command.
90 Switch the output mode between TUI/standard gdb. */
92 tui_rl_switch_mode (int notused1
, int notused2
)
101 rl_deprep_terminal ();
105 /* Clear the readline in case switching occurred in middle of something. */
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 it
113 will be able to setup the terminal for its needs. By re-entering
114 in readline, we also redisplay its prompt in the non-curses mode. */
115 rl_newline (1, '\n');
117 /* Make sure the \n we are returning does not repeat the last command. */
122 /* TUI readline command.
123 Change the TUI layout to show a next layout.
124 This function is bound to CTRL-X 2. It is intended to provide
125 a functionality close to the Emacs split-window command. We always
126 show two windows (src+asm), (src+regs) or (asm+regs). */
128 tui_rl_change_windows (int notused1
, int notused2
)
131 tui_rl_switch_mode (0/*notused*/, 0/*notused*/);
135 enum tui_layout_type new_layout
;
136 enum tui_register_display_type regs_type
= TUI_UNDEFINED_REGS
;
138 new_layout
= tui_current_layout ();
140 /* Select a new layout to have a rolling layout behavior
141 with always two windows (except when undefined). */
145 new_layout
= SRC_DISASSEM_COMMAND
;
148 case DISASSEM_COMMAND
:
149 new_layout
= SRC_DISASSEM_COMMAND
;
152 case SRC_DATA_COMMAND
:
153 new_layout
= SRC_DISASSEM_COMMAND
;
156 case SRC_DISASSEM_COMMAND
:
157 new_layout
= DISASSEM_DATA_COMMAND
;
160 case DISASSEM_DATA_COMMAND
:
161 new_layout
= SRC_DATA_COMMAND
;
165 new_layout
= SRC_COMMAND
;
168 tui_set_layout (new_layout
, regs_type
);
173 /* TUI readline command.
174 Delete the second TUI window to only show one. */
176 tui_rl_delete_other_windows (int notused1
, int notused2
)
179 tui_rl_switch_mode (0/*notused*/, 0/*notused*/);
183 enum tui_layout_type new_layout
;
184 enum tui_register_display_type regs_type
= TUI_UNDEFINED_REGS
;
186 new_layout
= tui_current_layout ();
188 /* Kill one window. */
192 case SRC_DATA_COMMAND
:
193 case SRC_DISASSEM_COMMAND
:
195 new_layout
= SRC_COMMAND
;
198 case DISASSEM_COMMAND
:
199 case DISASSEM_DATA_COMMAND
:
200 new_layout
= DISASSEM_COMMAND
;
203 tui_set_layout (new_layout
, regs_type
);
208 /* TUI readline command.
209 Switch the active window to give the focus to a next window. */
211 tui_rl_other_window (int count
, int key
)
213 struct tui_win_info
* win_info
;
216 tui_rl_switch_mode (0/*notused*/, 0/*notused*/);
218 win_info
= tui_next_win (tui_win_with_focus ());
221 tui_set_win_focus_to (win_info
);
222 if (TUI_DATA_WIN
&& TUI_DATA_WIN
->generic
.is_visible
)
223 tui_refresh_data_win ();
224 keypad (TUI_CMD_WIN
->generic
.handle
, (win_info
!= TUI_CMD_WIN
));
229 /* TUI readline command.
230 Execute the gdb command bound to the specified key. */
232 tui_rl_command_key (int count
, int key
)
236 reinitialize_more_filter ();
237 for (i
= 0; tui_commands
[i
].cmd
; i
++)
239 if (tui_commands
[i
].key
== key
)
241 /* Must save the command because it can be modified
242 by execute_command. */
243 char* cmd
= alloca (strlen (tui_commands
[i
].cmd
) + 1);
244 strcpy (cmd
, tui_commands
[i
].cmd
);
245 execute_command (cmd
, TRUE
);
252 /* TUI readline command.
253 Temporarily leave the TUI SingleKey mode to allow editing
254 a gdb command with the normal readline. Once the command
255 is executed, the TUI SingleKey mode is installed back. */
257 tui_rl_command_mode (int count
, int key
)
259 tui_set_key_mode (TUI_ONE_COMMAND_MODE
);
260 return rl_insert (count
, key
);
263 /* TUI readline command.
264 Switch between TUI SingleKey mode and gdb readline editing. */
266 tui_rl_next_keymap (int notused1
, int notused2
)
269 tui_rl_switch_mode (0/*notused*/, 0/*notused*/);
271 tui_set_key_mode (tui_current_key_mode
== TUI_COMMAND_MODE
272 ? TUI_SINGLE_KEY_MODE
: TUI_COMMAND_MODE
);
276 /* Readline hook to redisplay ourself the gdb prompt.
277 In the SingleKey mode, the prompt is not printed so that
278 the command window is cleaner. It will be displayed if
279 we temporarily leave the SingleKey mode. */
281 tui_rl_startup_hook (void)
283 rl_already_prompted
= 1;
284 if (tui_current_key_mode
!= TUI_COMMAND_MODE
)
285 tui_set_key_mode (TUI_SINGLE_KEY_MODE
);
286 tui_redisplay_readline ();
290 /* Change the TUI key mode by installing the appropriate readline keymap. */
292 tui_set_key_mode (enum tui_key_mode mode
)
294 tui_current_key_mode
= mode
;
295 rl_set_keymap (mode
== TUI_SINGLE_KEY_MODE
296 ? tui_keymap
: tui_readline_standard_keymap
);
297 tui_show_locator_content ();
300 /* Initialize readline and configure the keymap for the switching
303 tui_initialize_readline (void)
306 Keymap tui_ctlx_keymap
;
310 rl_add_defun ("tui-switch-mode", tui_rl_switch_mode
, -1);
311 rl_add_defun ("gdb-command", tui_rl_command_key
, -1);
312 rl_add_defun ("next-keymap", tui_rl_next_keymap
, -1);
314 tui_keymap
= rl_make_bare_keymap ();
315 tui_ctlx_keymap
= rl_make_bare_keymap ();
316 tui_readline_standard_keymap
= rl_get_keymap ();
318 for (i
= 0; tui_commands
[i
].cmd
; i
++)
319 rl_bind_key_in_map (tui_commands
[i
].key
, tui_rl_command_key
, tui_keymap
);
321 rl_generic_bind (ISKMAP
, "\\C-x", (char*) tui_ctlx_keymap
, tui_keymap
);
323 /* Bind all other keys to tui_rl_command_mode so that we switch
324 temporarily from SingleKey mode and can enter a gdb command. */
325 for (i
= ' '; i
< 0x7f; i
++)
329 for (j
= 0; tui_commands
[j
].cmd
; j
++)
330 if (tui_commands
[j
].key
== i
)
333 if (tui_commands
[j
].cmd
)
336 rl_bind_key_in_map (i
, tui_rl_command_mode
, tui_keymap
);
339 rl_bind_key_in_map ('a', tui_rl_switch_mode
, emacs_ctlx_keymap
);
340 rl_bind_key_in_map ('a', tui_rl_switch_mode
, tui_ctlx_keymap
);
341 rl_bind_key_in_map ('A', tui_rl_switch_mode
, emacs_ctlx_keymap
);
342 rl_bind_key_in_map ('A', tui_rl_switch_mode
, tui_ctlx_keymap
);
343 rl_bind_key_in_map (CTRL ('A'), tui_rl_switch_mode
, emacs_ctlx_keymap
);
344 rl_bind_key_in_map (CTRL ('A'), tui_rl_switch_mode
, tui_ctlx_keymap
);
345 rl_bind_key_in_map ('1', tui_rl_delete_other_windows
, emacs_ctlx_keymap
);
346 rl_bind_key_in_map ('1', tui_rl_delete_other_windows
, tui_ctlx_keymap
);
347 rl_bind_key_in_map ('2', tui_rl_change_windows
, emacs_ctlx_keymap
);
348 rl_bind_key_in_map ('2', tui_rl_change_windows
, tui_ctlx_keymap
);
349 rl_bind_key_in_map ('o', tui_rl_other_window
, emacs_ctlx_keymap
);
350 rl_bind_key_in_map ('o', tui_rl_other_window
, tui_ctlx_keymap
);
351 rl_bind_key_in_map ('q', tui_rl_next_keymap
, tui_keymap
);
352 rl_bind_key_in_map ('s', tui_rl_next_keymap
, emacs_ctlx_keymap
);
353 rl_bind_key_in_map ('s', tui_rl_next_keymap
, tui_ctlx_keymap
);
356 /* Enter in the tui mode (curses).
357 When in normal mode, it installs the tui hooks in gdb, redirects
358 the gdb output, configures the readline to work in tui mode.
359 When in curses mode, it does nothing. */
366 /* To avoid to initialize curses when gdb starts, there is a defered
367 curses initialization. This initialization is made only once
368 and the first time the curses mode is entered. */
382 tui_set_term_height_to (LINES
);
383 tui_set_term_width_to (COLS
);
386 tui_show_frame_info (0);
387 tui_set_layout (SRC_COMMAND
, TUI_UNDEFINED_REGS
);
388 tui_set_win_focus_to (TUI_SRC_WIN
);
389 keypad (TUI_CMD_WIN
->generic
.handle
, TRUE
);
390 wrefresh (TUI_CMD_WIN
->generic
.handle
);
395 /* Save the current gdb setting of the terminal.
396 Curses will restore this state when endwin() is called. */
398 clearok (stdscr
, TRUE
);
401 /* Install the TUI specific hooks. */
402 tui_install_hooks ();
403 rl_startup_hook
= tui_rl_startup_hook
;
405 tui_update_variables ();
410 if (deprecated_selected_frame
)
411 tui_show_frame_info (deprecated_selected_frame
);
413 /* Restore TUI keymap. */
414 tui_set_key_mode (tui_current_key_mode
);
415 tui_refresh_all_win ();
417 /* Update gdb's knowledge of its terminal. */
418 target_terminal_save_ours ();
419 tui_update_gdb_sizes ();
422 /* Leave the tui mode.
423 Remove the tui hooks and configure the gdb output and readline
424 back to their original state. The curses mode is left so that
425 the terminal setting is restored to the point when we entered. */
432 /* Restore initial readline keymap. */
433 rl_set_keymap (tui_readline_standard_keymap
);
435 /* Remove TUI hooks. */
438 rl_already_prompted
= 0;
440 /* Leave curses and restore previous gdb terminal setting. */
443 /* gdb terminal has changed, update gdb internal copy of it
444 so that terminal management with the inferior works. */
447 /* Update gdb's knowledge of its terminal. */
448 target_terminal_save_ours ();
451 tui_update_gdb_sizes ();
455 strcat_to_buf (char *buf
, int buflen
, const char *item_to_add
)
457 if (item_to_add
!= (char *) NULL
&& buf
!= (char *) NULL
)
459 if ((strlen (buf
) + strlen (item_to_add
)) <= buflen
)
460 strcat (buf
, item_to_add
);
462 strncat (buf
, item_to_add
, (buflen
- strlen (buf
)));
467 /* Solaris <sys/termios.h> defines CTRL. */
469 #define CTRL(x) (x & ~0140)
473 #define CHK(val, dft) (val<=0 ? dft : val)
481 ** reset the teletype mode bits to a sensible state.
484 #if ! defined (USG) && defined (TIOCGETC)
486 #endif /* !USG && TIOCGETC */
490 if (ldisc
== NTTYDISC
)
492 ioctl (FILEDES
, TIOCGLTC
, <c
);
493 ltc
.t_suspc
= CHK (ltc
.t_suspc
, CTRL ('Z'));
494 ltc
.t_dsuspc
= CHK (ltc
.t_dsuspc
, CTRL ('Y'));
495 ltc
.t_rprntc
= CHK (ltc
.t_rprntc
, CTRL ('R'));
496 ltc
.t_flushc
= CHK (ltc
.t_flushc
, CTRL ('O'));
497 ltc
.t_werasc
= CHK (ltc
.t_werasc
, CTRL ('W'));
498 ltc
.t_lnextc
= CHK (ltc
.t_lnextc
, CTRL ('V'));
499 ioctl (FILEDES
, TIOCSLTC
, <c
);
501 #endif /* UCB_NTTY */
504 ioctl (FILEDES
, TIOCGETC
, &tbuf
);
505 tbuf
.t_intrc
= CHK (tbuf
.t_intrc
, CTRL ('?'));
506 tbuf
.t_quitc
= CHK (tbuf
.t_quitc
, CTRL ('\\'));
507 tbuf
.t_startc
= CHK (tbuf
.t_startc
, CTRL ('Q'));
508 tbuf
.t_stopc
= CHK (tbuf
.t_stopc
, CTRL ('S'));
509 tbuf
.t_eofc
= CHK (tbuf
.t_eofc
, CTRL ('D'));
510 /* brkc is left alone */
511 ioctl (FILEDES
, TIOCSETC
, &tbuf
);
512 #endif /* TIOCGETC */
513 mode
.sg_flags
&= ~(RAW
517 | VTDELAY
| ALLDELAY
);
518 mode
.sg_flags
|= XTABS
| ECHO
| CRMOD
| ANYP
;
520 ioctl (FILEDES
, TCGETA
, &mode
);
521 mode
.c_cc
[VINTR
] = CHK (mode
.c_cc
[VINTR
], CTRL ('?'));
522 mode
.c_cc
[VQUIT
] = CHK (mode
.c_cc
[VQUIT
], CTRL ('\\'));
523 mode
.c_cc
[VEOF
] = CHK (mode
.c_cc
[VEOF
], CTRL ('D'));
525 mode
.c_iflag
&= ~(IGNBRK
| PARMRK
| INPCK
| INLCR
| IGNCR
| IUCLC
| IXOFF
);
526 mode
.c_iflag
|= (BRKINT
| ISTRIP
| ICRNL
| IXON
);
527 mode
.c_oflag
&= ~(OLCUC
| OCRNL
| ONOCR
| ONLRET
| OFILL
| OFDEL
|
528 NLDLY
| CRDLY
| TABDLY
| BSDLY
| VTDLY
| FFDLY
);
529 mode
.c_oflag
|= (OPOST
| ONLCR
);
530 mode
.c_cflag
&= ~(CSIZE
| PARODD
| CLOCAL
);
532 mode
.c_cflag
|= (CS8
| CREAD
);
533 #else /*hp9000s800 */
534 mode
.c_cflag
|= (CS8
| CSTOPB
| CREAD
);
535 #endif /* hp9000s800 */
536 mode
.c_lflag
&= ~(XCASE
| ECHONL
| NOFLSH
);
537 mode
.c_lflag
|= (ISIG
| ICANON
| ECHO
| ECHOK
);
538 ioctl (FILEDES
, TCSETAW
, &mode
);
546 tui_show_source (const char *file
, int line
)
548 struct symtab_and_line cursal
= get_current_source_symtab_and_line ();
549 /* make sure that the source window is displayed */
550 tui_add_win_to_layout (SRC_WIN
);
552 tui_update_source_windows_with_line (cursal
.symtab
, line
);
553 tui_update_locator_filename (file
);
557 tui_show_assembly (CORE_ADDR addr
)
559 tui_add_win_to_layout (DISASSEM_WIN
);
560 tui_update_source_windows_with_addr (addr
);
564 tui_is_window_visible (enum tui_win_type type
)
569 if (tui_win_list
[type
] == 0)
572 return tui_win_list
[type
]->generic
.is_visible
;
576 tui_get_command_dimension (int *width
, int *height
)
578 if (!tui_active
|| (TUI_CMD_WIN
== NULL
))
583 *width
= TUI_CMD_WIN
->generic
.width
;
584 *height
= TUI_CMD_WIN
->generic
.height
;