1 /* General functions for the WDB TUI.
3 Copyright 1998, 1999, 2000, 2001, 2002 Free Software Foundation,
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. */
25 /* FIXME: cagney/2002-02-28: The GDB coding standard indicates that
26 "defs.h" should be included first. Unfortunatly some systems
27 (currently Debian GNU/Linux) include the <stdbool.h> via <curses.h>
28 and they clash with "bfd.h"'s definiton of true/false. The correct
29 fix is to remove true/false from "bfd.h", however, until that
30 happens, hack around it by including "config.h" and <curses.h>
59 #include "tuiLayout.h"
64 #include "tuiSourceWin.h"
65 #include "readline/readline.h"
68 #include "breakpoint.h"
73 /* Tells whether the TUI is active or not. */
75 static int tui_finish_init
= 1;
77 enum tui_key_mode tui_current_key_mode
= tui_command_mode
;
79 struct tui_char_command
85 /* Key mapping to gdb commands when the TUI is using the single key mode. */
86 static const struct tui_char_command tui_commands
[] = {
94 { 'v', "info locals" },
99 static Keymap tui_keymap
;
100 static Keymap tui_readline_standard_keymap
;
102 /* TUI readline command.
103 Switch the output mode between TUI/standard gdb. */
105 tui_rl_switch_mode (int notused1
, int notused2
)
110 rl_prep_terminal (0);
114 rl_deprep_terminal ();
118 /* Clear the readline in case switching occurred in middle of something. */
120 rl_kill_text (0, rl_end
);
122 /* Since we left the curses mode, the terminal mode is restored to
123 some previous state. That state may not be suitable for readline
124 to work correctly (it may be restored in line mode). We force an
125 exit of the current readline so that readline is re-entered and it
126 will be able to setup the terminal for its needs. By re-entering
127 in readline, we also redisplay its prompt in the non-curses mode. */
128 rl_newline (1, '\n');
130 /* Make sure the \n we are returning does not repeat the last command. */
135 /* TUI readline command.
136 Change the TUI layout to show a next layout.
137 This function is bound to CTRL-X 2. It is intended to provide
138 a functionality close to the Emacs split-window command. We always
139 show two windows (src+asm), (src+regs) or (asm+regs). */
141 tui_rl_change_windows (int notused1
, int notused2
)
144 tui_rl_switch_mode (0/*notused*/, 0/*notused*/);
148 TuiLayoutType new_layout
;
149 TuiRegisterDisplayType regs_type
= TUI_UNDEFINED_REGS
;
151 new_layout
= currentLayout ();
153 /* Select a new layout to have a rolling layout behavior
154 with always two windows (except when undefined). */
158 new_layout
= SRC_DISASSEM_COMMAND
;
161 case DISASSEM_COMMAND
:
162 new_layout
= SRC_DISASSEM_COMMAND
;
165 case SRC_DATA_COMMAND
:
166 new_layout
= SRC_DISASSEM_COMMAND
;
169 case SRC_DISASSEM_COMMAND
:
170 new_layout
= DISASSEM_DATA_COMMAND
;
173 case DISASSEM_DATA_COMMAND
:
174 new_layout
= SRC_DATA_COMMAND
;
178 new_layout
= SRC_COMMAND
;
181 tuiSetLayout (new_layout
, regs_type
);
186 /* TUI readline command.
187 Delete the second TUI window to only show one. */
189 tui_rl_delete_other_windows (int notused1
, int notused2
)
192 tui_rl_switch_mode (0/*notused*/, 0/*notused*/);
196 TuiLayoutType new_layout
;
197 TuiRegisterDisplayType regs_type
= TUI_UNDEFINED_REGS
;
199 new_layout
= currentLayout ();
201 /* Kill one window. */
205 case SRC_DATA_COMMAND
:
206 case SRC_DISASSEM_COMMAND
:
208 new_layout
= SRC_COMMAND
;
211 case DISASSEM_COMMAND
:
212 case DISASSEM_DATA_COMMAND
:
213 new_layout
= DISASSEM_COMMAND
;
216 tuiSetLayout (new_layout
, regs_type
);
221 /* TUI readline command.
222 Execute the gdb command bound to the specified key. */
224 tui_rl_command_key (int count
, int key
)
228 reinitialize_more_filter ();
229 for (i
= 0; tui_commands
[i
].cmd
; i
++)
231 if (tui_commands
[i
].key
== key
)
233 /* Must save the command because it can be modified
234 by execute_command. */
235 char* cmd
= alloca (strlen (tui_commands
[i
].cmd
) + 1);
236 strcpy (cmd
, tui_commands
[i
].cmd
);
237 execute_command (cmd
, TRUE
);
244 /* TUI readline command.
245 Temporarily leave the TUI SingleKey mode to allow editing
246 a gdb command with the normal readline. Once the command
247 is executed, the TUI SingleKey mode is installed back. */
249 tui_rl_command_mode (int count
, int key
)
251 tui_set_key_mode (tui_one_command_mode
);
252 return rl_insert (count
, key
);
255 /* TUI readline command.
256 Switch between TUI SingleKey mode and gdb readline editing. */
258 tui_rl_next_keymap (int notused1
, int notused2
)
260 tui_set_key_mode (tui_current_key_mode
== tui_command_mode
261 ? tui_single_key_mode
: tui_command_mode
);
265 /* Readline hook to redisplay ourself the gdb prompt.
266 In the SingleKey mode, the prompt is not printed so that
267 the command window is cleaner. It will be displayed if
268 we temporarily leave the SingleKey mode. */
270 tui_rl_startup_hook ()
272 rl_already_prompted
= 1;
273 if (tui_current_key_mode
!= tui_command_mode
)
274 tui_set_key_mode (tui_single_key_mode
);
275 tui_redisplay_readline ();
279 /* Change the TUI key mode by installing the appropriate readline keymap. */
281 tui_set_key_mode (enum tui_key_mode mode
)
283 tui_current_key_mode
= mode
;
284 rl_set_keymap (mode
== tui_single_key_mode
285 ? tui_keymap
: tui_readline_standard_keymap
);
286 tuiShowLocatorContent ();
289 /* Initialize readline and configure the keymap for the switching
292 tui_initialize_readline ()
295 Keymap tui_ctlx_keymap
;
299 rl_add_defun ("tui-switch-mode", tui_rl_switch_mode
, -1);
300 rl_add_defun ("gdb-command", tui_rl_command_key
, -1);
301 rl_add_defun ("next-keymap", tui_rl_next_keymap
, -1);
303 tui_keymap
= rl_make_bare_keymap ();
304 tui_ctlx_keymap
= rl_make_bare_keymap ();
305 tui_readline_standard_keymap
= rl_get_keymap ();
307 for (i
= 0; tui_commands
[i
].cmd
; i
++)
308 rl_bind_key_in_map (tui_commands
[i
].key
, tui_rl_command_key
, tui_keymap
);
310 rl_generic_bind (ISKMAP
, "\\C-x", (char*) tui_ctlx_keymap
, tui_keymap
);
312 /* Bind all other keys to tui_rl_command_mode so that we switch
313 temporarily from SingleKey mode and can enter a gdb command. */
314 for (i
= ' '; i
< 0x7f; i
++)
318 for (j
= 0; tui_commands
[j
].cmd
; j
++)
319 if (tui_commands
[j
].key
== i
)
322 if (tui_commands
[j
].cmd
)
325 rl_bind_key_in_map (i
, tui_rl_command_mode
, tui_keymap
);
328 rl_bind_key_in_map ('a', tui_rl_switch_mode
, emacs_ctlx_keymap
);
329 rl_bind_key_in_map ('a', tui_rl_switch_mode
, tui_ctlx_keymap
);
330 rl_bind_key_in_map ('A', tui_rl_switch_mode
, emacs_ctlx_keymap
);
331 rl_bind_key_in_map ('A', tui_rl_switch_mode
, tui_ctlx_keymap
);
332 rl_bind_key_in_map (CTRL ('A'), tui_rl_switch_mode
, emacs_ctlx_keymap
);
333 rl_bind_key_in_map (CTRL ('A'), tui_rl_switch_mode
, tui_ctlx_keymap
);
334 rl_bind_key_in_map ('1', tui_rl_delete_other_windows
, emacs_ctlx_keymap
);
335 rl_bind_key_in_map ('1', tui_rl_delete_other_windows
, tui_ctlx_keymap
);
336 rl_bind_key_in_map ('2', tui_rl_change_windows
, emacs_ctlx_keymap
);
337 rl_bind_key_in_map ('2', tui_rl_change_windows
, tui_ctlx_keymap
);
338 rl_bind_key_in_map ('q', tui_rl_next_keymap
, tui_keymap
);
339 rl_bind_key_in_map ('s', tui_rl_next_keymap
, emacs_ctlx_keymap
);
340 rl_bind_key_in_map ('s', tui_rl_next_keymap
, tui_ctlx_keymap
);
343 /* Enter in the tui mode (curses).
344 When in normal mode, it installs the tui hooks in gdb, redirects
345 the gdb output, configures the readline to work in tui mode.
346 When in curses mode, it does nothing. */
353 /* To avoid to initialize curses when gdb starts, there is a defered
354 curses initialization. This initialization is made only once
355 and the first time the curses mode is entered. */
369 setTermHeightTo (LINES
);
370 setTermWidthTo (COLS
);
373 tuiShowFrameInfo (0);
374 tuiSetLayout (SRC_COMMAND
, TUI_UNDEFINED_REGS
);
375 tuiSetWinFocusTo (srcWin
);
376 keypad (cmdWin
->generic
.handle
, TRUE
);
377 wrefresh (cmdWin
->generic
.handle
);
382 /* Save the current gdb setting of the terminal.
383 Curses will restore this state when endwin() is called. */
385 clearok (stdscr
, TRUE
);
388 /* Install the TUI specific hooks. */
389 tui_install_hooks ();
390 rl_startup_hook
= tui_rl_startup_hook
;
392 tui_update_variables ();
397 if (deprecated_selected_frame
)
398 tuiShowFrameInfo (deprecated_selected_frame
);
400 /* Restore TUI keymap. */
401 tui_set_key_mode (tui_current_key_mode
);
404 /* Update gdb's knowledge of its terminal. */
405 target_terminal_save_ours ();
406 tui_update_gdb_sizes ();
409 /* Leave the tui mode.
410 Remove the tui hooks and configure the gdb output and readline
411 back to their original state. The curses mode is left so that
412 the terminal setting is restored to the point when we entered. */
419 /* Restore initial readline keymap. */
420 rl_set_keymap (tui_readline_standard_keymap
);
422 /* Remove TUI hooks. */
425 rl_already_prompted
= 0;
427 /* Leave curses and restore previous gdb terminal setting. */
430 /* gdb terminal has changed, update gdb internal copy of it
431 so that terminal management with the inferior works. */
434 /* Update gdb's knowledge of its terminal. */
435 target_terminal_save_ours ();
438 tui_update_gdb_sizes ();
441 /* Wrapper on top of free() to ensure that input address
442 is greater than 0x0. */
446 if (ptr
!= (char *) NULL
)
453 strcat_to_buf (char *buf
, int buflen
, const char *itemToAdd
)
455 if (itemToAdd
!= (char *) NULL
&& buf
!= (char *) NULL
)
457 if ((strlen (buf
) + strlen (itemToAdd
)) <= buflen
)
458 strcat (buf
, itemToAdd
);
460 strncat (buf
, itemToAdd
, (buflen
- strlen (buf
)));
465 /* Solaris <sys/termios.h> defines CTRL. */
467 #define CTRL(x) (x & ~0140)
471 #define CHK(val, dft) (val<=0 ? dft : val)
479 ** reset the teletype mode bits to a sensible state.
482 #if ! defined (USG) && defined (TIOCGETC)
484 #endif /* !USG && TIOCGETC */
488 if (ldisc
== NTTYDISC
)
490 ioctl (FILEDES
, TIOCGLTC
, <c
);
491 ltc
.t_suspc
= CHK (ltc
.t_suspc
, CTRL ('Z'));
492 ltc
.t_dsuspc
= CHK (ltc
.t_dsuspc
, CTRL ('Y'));
493 ltc
.t_rprntc
= CHK (ltc
.t_rprntc
, CTRL ('R'));
494 ltc
.t_flushc
= CHK (ltc
.t_flushc
, CTRL ('O'));
495 ltc
.t_werasc
= CHK (ltc
.t_werasc
, CTRL ('W'));
496 ltc
.t_lnextc
= CHK (ltc
.t_lnextc
, CTRL ('V'));
497 ioctl (FILEDES
, TIOCSLTC
, <c
);
499 #endif /* UCB_NTTY */
502 ioctl (FILEDES
, TIOCGETC
, &tbuf
);
503 tbuf
.t_intrc
= CHK (tbuf
.t_intrc
, CTRL ('?'));
504 tbuf
.t_quitc
= CHK (tbuf
.t_quitc
, CTRL ('\\'));
505 tbuf
.t_startc
= CHK (tbuf
.t_startc
, CTRL ('Q'));
506 tbuf
.t_stopc
= CHK (tbuf
.t_stopc
, CTRL ('S'));
507 tbuf
.t_eofc
= CHK (tbuf
.t_eofc
, CTRL ('D'));
508 /* brkc is left alone */
509 ioctl (FILEDES
, TIOCSETC
, &tbuf
);
510 #endif /* TIOCGETC */
511 mode
.sg_flags
&= ~(RAW
515 | VTDELAY
| ALLDELAY
);
516 mode
.sg_flags
|= XTABS
| ECHO
| CRMOD
| ANYP
;
518 ioctl (FILEDES
, TCGETA
, &mode
);
519 mode
.c_cc
[VINTR
] = CHK (mode
.c_cc
[VINTR
], CTRL ('?'));
520 mode
.c_cc
[VQUIT
] = CHK (mode
.c_cc
[VQUIT
], CTRL ('\\'));
521 mode
.c_cc
[VEOF
] = CHK (mode
.c_cc
[VEOF
], CTRL ('D'));
523 mode
.c_iflag
&= ~(IGNBRK
| PARMRK
| INPCK
| INLCR
| IGNCR
| IUCLC
| IXOFF
);
524 mode
.c_iflag
|= (BRKINT
| ISTRIP
| ICRNL
| IXON
);
525 mode
.c_oflag
&= ~(OLCUC
| OCRNL
| ONOCR
| ONLRET
| OFILL
| OFDEL
|
526 NLDLY
| CRDLY
| TABDLY
| BSDLY
| VTDLY
| FFDLY
);
527 mode
.c_oflag
|= (OPOST
| ONLCR
);
528 mode
.c_cflag
&= ~(CSIZE
| PARODD
| CLOCAL
);
530 mode
.c_cflag
|= (CS8
| CREAD
);
531 #else /*hp9000s800 */
532 mode
.c_cflag
|= (CS8
| CSTOPB
| CREAD
);
533 #endif /* hp9000s800 */
534 mode
.c_lflag
&= ~(XCASE
| ECHONL
| NOFLSH
);
535 mode
.c_lflag
|= (ISIG
| ICANON
| ECHO
| ECHOK
);
536 ioctl (FILEDES
, TCSETAW
, &mode
);
544 tui_show_source (const char *file
, int line
)
546 struct symtab_and_line cursal
= get_current_source_symtab_and_line ();
547 /* make sure that the source window is displayed */
548 tuiAddWinToLayout (SRC_WIN
);
550 tuiUpdateSourceWindowsWithLine (cursal
.symtab
, line
);
551 tuiUpdateLocatorFilename (file
);
555 tui_show_assembly (CORE_ADDR addr
)
557 tuiAddWinToLayout (DISASSEM_WIN
);
558 tuiUpdateSourceWindowsWithAddr (addr
);
562 tui_is_window_visible (TuiWinType type
)
567 if (winList
[type
] == 0)
570 return winList
[type
]->generic
.isVisible
;
574 tui_get_command_dimension (int *width
, int *height
)
576 if (!tui_active
|| !m_winPtrNotNull (cmdWin
))
581 *width
= cmdWin
->generic
.width
;
582 *height
= cmdWin
->generic
.height
;