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. */
41 #include "tui/tui-data.h"
42 #include "tui/tui-layout.h"
43 #include "tui/tui-io.h"
44 #include "tui/tui-regs.h"
45 #include "tui/tui-stack.h"
46 #include "tui/tui-win.h"
47 #include "tui/tui-winsource.h"
48 #include "tui/tui-windata.h"
49 #include "readline/readline.h"
52 #include "breakpoint.h"
65 /* Tells whether the TUI is active or not. */
67 static int tui_finish_init
= 1;
69 enum tui_key_mode tui_current_key_mode
= TUI_COMMAND_MODE
;
71 struct tui_char_command
77 /* Key mapping to gdb commands when the TUI is using the single key mode. */
78 static const struct tui_char_command tui_commands
[] = {
86 { 'v', "info locals" },
91 static Keymap tui_keymap
;
92 static Keymap tui_readline_standard_keymap
;
94 /* TUI readline command.
95 Switch the output mode between TUI/standard gdb. */
97 tui_rl_switch_mode (int notused1
, int notused2
)
102 rl_prep_terminal (0);
106 rl_deprep_terminal ();
110 /* Clear the readline in case switching occurred in middle of something. */
112 rl_kill_text (0, rl_end
);
114 /* Since we left the curses mode, the terminal mode is restored to
115 some previous state. That state may not be suitable for readline
116 to work correctly (it may be restored in line mode). We force an
117 exit of the current readline so that readline is re-entered and it
118 will be able to setup the terminal for its needs. By re-entering
119 in readline, we also redisplay its prompt in the non-curses mode. */
120 rl_newline (1, '\n');
122 /* Make sure the \n we are returning does not repeat the last command. */
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 always
131 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
146 with 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
247 by execute_command. */
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 ()
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 keymap. */
297 tui_set_key_mode (enum tui_key_mode mode
)
299 tui_current_key_mode
= mode
;
300 rl_set_keymap (mode
== TUI_SINGLE_KEY_MODE
301 ? tui_keymap
: tui_readline_standard_keymap
);
302 tui_show_locator_content ();
305 /* Initialize readline and configure the keymap for the switching
308 tui_initialize_readline ()
311 Keymap tui_ctlx_keymap
;
315 rl_add_defun ("tui-switch-mode", tui_rl_switch_mode
, -1);
316 rl_add_defun ("gdb-command", tui_rl_command_key
, -1);
317 rl_add_defun ("next-keymap", tui_rl_next_keymap
, -1);
319 tui_keymap
= rl_make_bare_keymap ();
320 tui_ctlx_keymap
= rl_make_bare_keymap ();
321 tui_readline_standard_keymap
= rl_get_keymap ();
323 for (i
= 0; tui_commands
[i
].cmd
; i
++)
324 rl_bind_key_in_map (tui_commands
[i
].key
, tui_rl_command_key
, tui_keymap
);
326 rl_generic_bind (ISKMAP
, "\\C-x", (char*) tui_ctlx_keymap
, tui_keymap
);
328 /* Bind all other keys to tui_rl_command_mode so that we switch
329 temporarily from SingleKey mode and can enter a gdb command. */
330 for (i
= ' '; i
< 0x7f; i
++)
334 for (j
= 0; tui_commands
[j
].cmd
; j
++)
335 if (tui_commands
[j
].key
== i
)
338 if (tui_commands
[j
].cmd
)
341 rl_bind_key_in_map (i
, tui_rl_command_mode
, tui_keymap
);
344 rl_bind_key_in_map ('a', tui_rl_switch_mode
, emacs_ctlx_keymap
);
345 rl_bind_key_in_map ('a', tui_rl_switch_mode
, tui_ctlx_keymap
);
346 rl_bind_key_in_map ('A', tui_rl_switch_mode
, emacs_ctlx_keymap
);
347 rl_bind_key_in_map ('A', tui_rl_switch_mode
, tui_ctlx_keymap
);
348 rl_bind_key_in_map (CTRL ('A'), tui_rl_switch_mode
, emacs_ctlx_keymap
);
349 rl_bind_key_in_map (CTRL ('A'), tui_rl_switch_mode
, tui_ctlx_keymap
);
350 rl_bind_key_in_map ('1', tui_rl_delete_other_windows
, emacs_ctlx_keymap
);
351 rl_bind_key_in_map ('1', tui_rl_delete_other_windows
, tui_ctlx_keymap
);
352 rl_bind_key_in_map ('2', tui_rl_change_windows
, emacs_ctlx_keymap
);
353 rl_bind_key_in_map ('2', tui_rl_change_windows
, tui_ctlx_keymap
);
354 rl_bind_key_in_map ('o', tui_rl_other_window
, emacs_ctlx_keymap
);
355 rl_bind_key_in_map ('o', tui_rl_other_window
, tui_ctlx_keymap
);
356 rl_bind_key_in_map ('q', tui_rl_next_keymap
, tui_keymap
);
357 rl_bind_key_in_map ('s', tui_rl_next_keymap
, emacs_ctlx_keymap
);
358 rl_bind_key_in_map ('s', tui_rl_next_keymap
, tui_ctlx_keymap
);
361 /* Enter in the tui mode (curses).
362 When in normal mode, it installs the tui hooks in gdb, redirects
363 the gdb output, configures the readline to work in tui mode.
364 When in curses mode, it does nothing. */
371 /* To avoid to initialize curses when gdb starts, there is a defered
372 curses initialization. This initialization is made only once
373 and the first time the curses mode is entered. */
387 tui_set_term_height_to (LINES
);
388 tui_set_term_width_to (COLS
);
391 tui_show_frame_info (0);
392 tui_set_layout (SRC_COMMAND
, TUI_UNDEFINED_REGS
);
393 tui_set_win_focus_to (TUI_SRC_WIN
);
394 keypad (TUI_CMD_WIN
->generic
.handle
, TRUE
);
395 wrefresh (TUI_CMD_WIN
->generic
.handle
);
400 /* Save the current gdb setting of the terminal.
401 Curses will restore this state when endwin() is called. */
403 clearok (stdscr
, TRUE
);
406 /* Install the TUI specific hooks. */
407 tui_install_hooks ();
408 rl_startup_hook
= tui_rl_startup_hook
;
410 tui_update_variables ();
415 if (deprecated_selected_frame
)
416 tui_show_frame_info (deprecated_selected_frame
);
418 /* Restore TUI keymap. */
419 tui_set_key_mode (tui_current_key_mode
);
420 tui_refresh_all_win ();
422 /* Update gdb's knowledge of its terminal. */
423 target_terminal_save_ours ();
424 tui_update_gdb_sizes ();
427 /* Leave the tui mode.
428 Remove the tui hooks and configure the gdb output and readline
429 back to their original state. The curses mode is left so that
430 the terminal setting is restored to the point when we entered. */
437 /* Restore initial readline keymap. */
438 rl_set_keymap (tui_readline_standard_keymap
);
440 /* Remove TUI hooks. */
443 rl_already_prompted
= 0;
445 /* Leave curses and restore previous gdb terminal setting. */
448 /* gdb terminal has changed, update gdb internal copy of it
449 so that terminal management with the inferior works. */
452 /* Update gdb's knowledge of its terminal. */
453 target_terminal_save_ours ();
456 tui_update_gdb_sizes ();
460 strcat_to_buf (char *buf
, int buflen
, const char *item_to_add
)
462 if (item_to_add
!= (char *) NULL
&& buf
!= (char *) NULL
)
464 if ((strlen (buf
) + strlen (item_to_add
)) <= buflen
)
465 strcat (buf
, item_to_add
);
467 strncat (buf
, item_to_add
, (buflen
- strlen (buf
)));
472 /* Solaris <sys/termios.h> defines CTRL. */
474 #define CTRL(x) (x & ~0140)
478 #define CHK(val, dft) (val<=0 ? dft : val)
486 ** reset the teletype mode bits to a sensible state.
489 #if ! defined (USG) && defined (TIOCGETC)
491 #endif /* !USG && 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 */
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
;
525 ioctl (FILEDES
, TCGETA
, &mode
);
526 mode
.c_cc
[VINTR
] = CHK (mode
.c_cc
[VINTR
], CTRL ('?'));
527 mode
.c_cc
[VQUIT
] = CHK (mode
.c_cc
[VQUIT
], CTRL ('\\'));
528 mode
.c_cc
[VEOF
] = CHK (mode
.c_cc
[VEOF
], CTRL ('D'));
530 mode
.c_iflag
&= ~(IGNBRK
| PARMRK
| INPCK
| INLCR
| IGNCR
| IUCLC
| IXOFF
);
531 mode
.c_iflag
|= (BRKINT
| ISTRIP
| ICRNL
| IXON
);
532 mode
.c_oflag
&= ~(OLCUC
| OCRNL
| ONOCR
| ONLRET
| OFILL
| OFDEL
|
533 NLDLY
| CRDLY
| TABDLY
| BSDLY
| VTDLY
| FFDLY
);
534 mode
.c_oflag
|= (OPOST
| ONLCR
);
535 mode
.c_cflag
&= ~(CSIZE
| PARODD
| CLOCAL
);
537 mode
.c_cflag
|= (CS8
| CREAD
);
538 #else /*hp9000s800 */
539 mode
.c_cflag
|= (CS8
| CSTOPB
| CREAD
);
540 #endif /* hp9000s800 */
541 mode
.c_lflag
&= ~(XCASE
| ECHONL
| NOFLSH
);
542 mode
.c_lflag
|= (ISIG
| ICANON
| ECHO
| ECHOK
);
543 ioctl (FILEDES
, TCSETAW
, &mode
);
551 tui_show_source (const char *file
, int line
)
553 struct symtab_and_line cursal
= get_current_source_symtab_and_line ();
554 /* make sure that the source window is displayed */
555 tui_add_win_to_layout (SRC_WIN
);
557 tui_update_source_windows_with_line (cursal
.symtab
, line
);
558 tui_update_locator_filename (file
);
562 tui_show_assembly (CORE_ADDR addr
)
564 tui_add_win_to_layout (DISASSEM_WIN
);
565 tui_update_source_windows_with_addr (addr
);
569 tui_is_window_visible (enum tui_win_type type
)
574 if (tui_win_list
[type
] == 0)
577 return tui_win_list
[type
]->generic
.is_visible
;
581 tui_get_command_dimension (int *width
, int *height
)
583 if (!tui_active
|| (TUI_CMD_WIN
== NULL
))
588 *width
= TUI_CMD_WIN
->generic
.width
;
589 *height
= TUI_CMD_WIN
->generic
.height
;