gdb vendor branch: Bring in additional source files
[dragonfly.git] / contrib / gdb-7 / gdb / tui / tui.c
CommitLineData
5796c8dc
SS
1/* General functions for the WDB TUI.
2
a45ae5f8 3 Copyright (C) 1998-2004, 2007-2012 Free Software Foundation, Inc.
5796c8dc
SS
4
5 Contributed by Hewlett-Packard Company.
6
7 This file is part of GDB.
8
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.
13
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.
18
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/>. */
21
22#include "defs.h"
23#include "gdbcmd.h"
24#include "tui/tui.h"
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"
34#include "target.h"
35#include "frame.h"
36#include "breakpoint.h"
37#include "inferior.h"
38#include "symtab.h"
39#include "source.h"
40
41#include <stdio.h>
42#include <stdlib.h>
43#include <ctype.h>
44#include <signal.h>
45#include <fcntl.h>
46#if 0
47#include <termio.h>
48#endif
49#include <setjmp.h>
50
51#include "gdb_curses.h"
52
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
55 "gdb_curses.h". */
56#include "readline/readline.h"
57
58/* Tells whether the TUI is active or not. */
59int tui_active = 0;
60static int tui_finish_init = 1;
61
62enum tui_key_mode tui_current_key_mode = TUI_COMMAND_MODE;
63
64struct tui_char_command
65{
66 unsigned char key;
67 const char *cmd;
68};
69
70/* Key mapping to gdb commands when the TUI is using the single key
71 mode. */
72static const struct tui_char_command tui_commands[] = {
73 { 'c', "continue" },
74 { 'd', "down" },
75 { 'f', "finish" },
76 { 'n', "next" },
77 { 'r', "run" },
78 { 's', "step" },
79 { 'u', "up" },
80 { 'v', "info locals" },
81 { 'w', "where" },
82 { 0, 0 },
83};
84
85static Keymap tui_keymap;
86static Keymap tui_readline_standard_keymap;
87
88/* TUI readline command.
89 Switch the output mode between TUI/standard gdb. */
90static int
91tui_rl_switch_mode (int notused1, int notused2)
92{
93 if (tui_active)
94 {
95 tui_disable ();
96 rl_prep_terminal (0);
97 }
98 else
99 {
100 rl_deprep_terminal ();
101 tui_enable ();
102 }
103
104 /* Clear the readline in case switching occurred in middle of
105 something. */
106 if (rl_end)
107 rl_kill_text (0, rl_end);
108
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
115 non-curses mode. */
116 rl_newline (1, '\n');
117
118 /* Make sure the \n we are returning does not repeat the last
119 command. */
120 dont_repeat ();
121 return 0;
122}
123
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). */
129static int
130tui_rl_change_windows (int notused1, int notused2)
131{
132 if (!tui_active)
133 tui_rl_switch_mode (0 /* notused */, 0 /* notused */);
134
135 if (tui_active)
136 {
137 enum tui_layout_type new_layout;
138 enum tui_register_display_type regs_type = TUI_UNDEFINED_REGS;
139
140 new_layout = tui_current_layout ();
141
142 /* Select a new layout to have a rolling layout behavior with
143 always two windows (except when undefined). */
144 switch (new_layout)
145 {
146 case SRC_COMMAND:
147 new_layout = SRC_DISASSEM_COMMAND;
148 break;
149
150 case DISASSEM_COMMAND:
151 new_layout = SRC_DISASSEM_COMMAND;
152 break;
153
154 case SRC_DATA_COMMAND:
155 new_layout = SRC_DISASSEM_COMMAND;
156 break;
157
158 case SRC_DISASSEM_COMMAND:
159 new_layout = DISASSEM_DATA_COMMAND;
160 break;
161
162 case DISASSEM_DATA_COMMAND:
163 new_layout = SRC_DATA_COMMAND;
164 break;
165
166 default:
167 new_layout = SRC_COMMAND;
168 break;
169 }
170 tui_set_layout (new_layout, regs_type);
171 }
172 return 0;
173}
174
175/* TUI readline command.
176 Delete the second TUI window to only show one. */
177static int
178tui_rl_delete_other_windows (int notused1, int notused2)
179{
180 if (!tui_active)
181 tui_rl_switch_mode (0 /* notused */, 0 /* notused */);
182
183 if (tui_active)
184 {
185 enum tui_layout_type new_layout;
186 enum tui_register_display_type regs_type = TUI_UNDEFINED_REGS;
187
188 new_layout = tui_current_layout ();
189
190 /* Kill one window. */
191 switch (new_layout)
192 {
193 case SRC_COMMAND:
194 case SRC_DATA_COMMAND:
195 case SRC_DISASSEM_COMMAND:
196 default:
197 new_layout = SRC_COMMAND;
198 break;
199
200 case DISASSEM_COMMAND:
201 case DISASSEM_DATA_COMMAND:
202 new_layout = DISASSEM_COMMAND;
203 break;
204 }
205 tui_set_layout (new_layout, regs_type);
206 }
207 return 0;
208}
209
210/* TUI readline command.
211 Switch the active window to give the focus to a next window. */
212static int
213tui_rl_other_window (int count, int key)
214{
215 struct tui_win_info *win_info;
216
217 if (!tui_active)
218 tui_rl_switch_mode (0 /* notused */, 0 /* notused */);
219
220 win_info = tui_next_win (tui_win_with_focus ());
221 if (win_info)
222 {
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));
227 }
228 return 0;
229}
230
231/* TUI readline command.
232 Execute the gdb command bound to the specified key. */
233static int
234tui_rl_command_key (int count, int key)
235{
236 int i;
237
238 reinitialize_more_filter ();
239 for (i = 0; tui_commands[i].cmd; i++)
240 {
241 if (tui_commands[i].key == key)
242 {
243 /* Must save the command because it can be modified by
244 execute_command. */
245 char *cmd = alloca (strlen (tui_commands[i].cmd) + 1);
cf7f2e2d 246
5796c8dc
SS
247 strcpy (cmd, tui_commands[i].cmd);
248 execute_command (cmd, TRUE);
249 return 0;
250 }
251 }
252 return 0;
253}
254
255/* TUI readline command.
256 Temporarily leave the TUI SingleKey mode to allow editing
257 a gdb command with the normal readline. Once the command
258 is executed, the TUI SingleKey mode is installed back. */
259static int
260tui_rl_command_mode (int count, int key)
261{
262 tui_set_key_mode (TUI_ONE_COMMAND_MODE);
263 return rl_insert (count, key);
264}
265
266/* TUI readline command.
267 Switch between TUI SingleKey mode and gdb readline editing. */
268static int
269tui_rl_next_keymap (int notused1, int notused2)
270{
271 if (!tui_active)
272 tui_rl_switch_mode (0 /* notused */, 0 /* notused */);
273
274 tui_set_key_mode (tui_current_key_mode == TUI_COMMAND_MODE
275 ? TUI_SINGLE_KEY_MODE : TUI_COMMAND_MODE);
276 return 0;
277}
278
279/* Readline hook to redisplay ourself the gdb prompt.
280 In the SingleKey mode, the prompt is not printed so that
281 the command window is cleaner. It will be displayed if
282 we temporarily leave the SingleKey mode. */
283static int
284tui_rl_startup_hook (void)
285{
286 rl_already_prompted = 1;
287 if (tui_current_key_mode != TUI_COMMAND_MODE)
288 tui_set_key_mode (TUI_SINGLE_KEY_MODE);
289 tui_redisplay_readline ();
290 return 0;
291}
292
293/* Change the TUI key mode by installing the appropriate readline
294 keymap. */
295void
296tui_set_key_mode (enum tui_key_mode mode)
297{
298 tui_current_key_mode = mode;
299 rl_set_keymap (mode == TUI_SINGLE_KEY_MODE
300 ? tui_keymap : tui_readline_standard_keymap);
301 tui_show_locator_content ();
302}
303
304/* Initialize readline and configure the keymap for the switching
305 key shortcut. */
306void
307tui_initialize_readline (void)
308{
309 int i;
310 Keymap tui_ctlx_keymap;
311
312 rl_initialize ();
313
314 rl_add_defun ("tui-switch-mode", tui_rl_switch_mode, -1);
315 rl_add_defun ("gdb-command", tui_rl_command_key, -1);
316 rl_add_defun ("next-keymap", tui_rl_next_keymap, -1);
317
318 tui_keymap = rl_make_bare_keymap ();
319 tui_ctlx_keymap = rl_make_bare_keymap ();
320 tui_readline_standard_keymap = rl_get_keymap ();
321
322 for (i = 0; tui_commands[i].cmd; i++)
323 rl_bind_key_in_map (tui_commands[i].key, tui_rl_command_key, tui_keymap);
324
325 rl_generic_bind (ISKMAP, "\\C-x", (char*) tui_ctlx_keymap, tui_keymap);
326
327 /* Bind all other keys to tui_rl_command_mode so that we switch
328 temporarily from SingleKey mode and can enter a gdb command. */
329 for (i = ' '; i < 0x7f; i++)
330 {
331 int j;
332
333 for (j = 0; tui_commands[j].cmd; j++)
334 if (tui_commands[j].key == i)
335 break;
336
337 if (tui_commands[j].cmd)
338 continue;
339
340 rl_bind_key_in_map (i, tui_rl_command_mode, tui_keymap);
341 }
342
343 rl_bind_key_in_map ('a', tui_rl_switch_mode, emacs_ctlx_keymap);
344 rl_bind_key_in_map ('a', tui_rl_switch_mode, tui_ctlx_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 (CTRL ('A'), tui_rl_switch_mode, emacs_ctlx_keymap);
348 rl_bind_key_in_map (CTRL ('A'), tui_rl_switch_mode, tui_ctlx_keymap);
349 rl_bind_key_in_map ('1', tui_rl_delete_other_windows, emacs_ctlx_keymap);
350 rl_bind_key_in_map ('1', tui_rl_delete_other_windows, tui_ctlx_keymap);
351 rl_bind_key_in_map ('2', tui_rl_change_windows, emacs_ctlx_keymap);
352 rl_bind_key_in_map ('2', tui_rl_change_windows, tui_ctlx_keymap);
353 rl_bind_key_in_map ('o', tui_rl_other_window, emacs_ctlx_keymap);
354 rl_bind_key_in_map ('o', tui_rl_other_window, tui_ctlx_keymap);
355 rl_bind_key_in_map ('q', tui_rl_next_keymap, tui_keymap);
356 rl_bind_key_in_map ('s', tui_rl_next_keymap, emacs_ctlx_keymap);
357 rl_bind_key_in_map ('s', tui_rl_next_keymap, tui_ctlx_keymap);
358}
359
360/* Enter in the tui mode (curses).
361 When in normal mode, it installs the tui hooks in gdb, redirects
362 the gdb output, configures the readline to work in tui mode.
363 When in curses mode, it does nothing. */
364void
365tui_enable (void)
366{
cf7f2e2d
JM
367 if (!tui_allowed_p ())
368 error (_("TUI mode not allowed"));
369
5796c8dc
SS
370 if (tui_active)
371 return;
372
373 /* To avoid to initialize curses when gdb starts, there is a defered
374 curses initialization. This initialization is made only once
375 and the first time the curses mode is entered. */
376 if (tui_finish_init)
377 {
378 WINDOW *w;
379
380 w = initscr ();
381
382 cbreak ();
383 noecho ();
384 /* timeout (1); */
385 nodelay(w, FALSE);
386 nl();
387 keypad (w, TRUE);
388 rl_initialize ();
389 tui_set_term_height_to (LINES);
390 tui_set_term_width_to (COLS);
391 def_prog_mode ();
392
393 tui_show_frame_info (0);
394 tui_set_layout (SRC_COMMAND, TUI_UNDEFINED_REGS);
395 tui_set_win_focus_to (TUI_SRC_WIN);
396 keypad (TUI_CMD_WIN->generic.handle, TRUE);
397 wrefresh (TUI_CMD_WIN->generic.handle);
398 tui_finish_init = 0;
399 }
400 else
401 {
402 /* Save the current gdb setting of the terminal.
403 Curses will restore this state when endwin() is called. */
404 def_shell_mode ();
405 clearok (stdscr, TRUE);
406 }
407
408 /* Install the TUI specific hooks. */
409 tui_install_hooks ();
410 rl_startup_hook = tui_rl_startup_hook;
411
412 tui_update_variables ();
413
414 tui_setup_io (1);
415
416 tui_active = 1;
417 if (deprecated_safe_get_selected_frame ())
418 tui_show_frame_info (deprecated_safe_get_selected_frame ());
419
420 /* Restore TUI keymap. */
421 tui_set_key_mode (tui_current_key_mode);
422 tui_refresh_all_win ();
423
424 /* Update gdb's knowledge of its terminal. */
425 target_terminal_save_ours ();
426 tui_update_gdb_sizes ();
427}
428
429/* Leave the tui mode.
430 Remove the tui hooks and configure the gdb output and readline
431 back to their original state. The curses mode is left so that
432 the terminal setting is restored to the point when we entered. */
433void
434tui_disable (void)
435{
436 if (!tui_active)
437 return;
438
439 /* Restore initial readline keymap. */
440 rl_set_keymap (tui_readline_standard_keymap);
441
442 /* Remove TUI hooks. */
443 tui_remove_hooks ();
444 rl_startup_hook = 0;
445 rl_already_prompted = 0;
446
447 /* Leave curses and restore previous gdb terminal setting. */
448 endwin ();
449
450 /* gdb terminal has changed, update gdb internal copy of it
451 so that terminal management with the inferior works. */
452 tui_setup_io (0);
453
454 /* Update gdb's knowledge of its terminal. */
455 target_terminal_save_ours ();
456
457 tui_active = 0;
458 tui_update_gdb_sizes ();
459}
460
461void
462strcat_to_buf (char *buf, int buflen,
463 const char *item_to_add)
464{
465 if (item_to_add != (char *) NULL && buf != (char *) NULL)
466 {
467 if ((strlen (buf) + strlen (item_to_add)) <= buflen)
468 strcat (buf, item_to_add);
469 else
470 strncat (buf, item_to_add, (buflen - strlen (buf)));
471 }
472}
473
474#if 0
475/* Solaris <sys/termios.h> defines CTRL. */
476#ifndef CTRL
477#define CTRL(x) (x & ~0140)
478#endif
479
480#define FILEDES 2
481#define CHK(val, dft) (val<=0 ? dft : val)
482
483static void
484tui_reset (void)
485{
486 struct termio mode;
487
488 /* Reset the teletype mode bits to a sensible state.
489 Copied tset.c. */
490#if defined (TIOCGETC)
491 struct tchars tbuf;
492#endif /* TIOCGETC */
493#ifdef UCB_NTTY
494 struct ltchars ltc;
495
496 if (ldisc == NTTYDISC)
497 {
498 ioctl (FILEDES, TIOCGLTC, &ltc);
499 ltc.t_suspc = CHK (ltc.t_suspc, CTRL ('Z'));
500 ltc.t_dsuspc = CHK (ltc.t_dsuspc, CTRL ('Y'));
501 ltc.t_rprntc = CHK (ltc.t_rprntc, CTRL ('R'));
502 ltc.t_flushc = CHK (ltc.t_flushc, CTRL ('O'));
503 ltc.t_werasc = CHK (ltc.t_werasc, CTRL ('W'));
504 ltc.t_lnextc = CHK (ltc.t_lnextc, CTRL ('V'));
505 ioctl (FILEDES, TIOCSLTC, &ltc);
506 }
507#endif /* UCB_NTTY */
508#ifdef TIOCGETC
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
519#ifdef CBREAK
520 | CBREAK
521#endif /* CBREAK */
522 | VTDELAY | ALLDELAY);
523 mode.sg_flags |= XTABS | ECHO | CRMOD | ANYP;
524
525 return;
526}
527#endif
528
529void
530tui_show_source (const char *file, int line)
531{
532 struct symtab_and_line cursal = get_current_source_symtab_and_line ();
cf7f2e2d 533
5796c8dc
SS
534 /* Make sure that the source window is displayed. */
535 tui_add_win_to_layout (SRC_WIN);
536
537 tui_update_source_windows_with_line (cursal.symtab, line);
538 tui_update_locator_filename (file);
539}
540
541void
542tui_show_assembly (struct gdbarch *gdbarch, CORE_ADDR addr)
543{
544 tui_add_win_to_layout (DISASSEM_WIN);
545 tui_update_source_windows_with_addr (gdbarch, addr);
546}
547
548int
549tui_is_window_visible (enum tui_win_type type)
550{
551 if (tui_active == 0)
552 return 0;
553
554 if (tui_win_list[type] == 0)
555 return 0;
556
557 return tui_win_list[type]->generic.is_visible;
558}
559
560int
561tui_get_command_dimension (unsigned int *width,
562 unsigned int *height)
563{
564 if (!tui_active || (TUI_CMD_WIN == NULL))
565 {
566 return 0;
567 }
568
569 *width = TUI_CMD_WIN->generic.width;
570 *height = TUI_CMD_WIN->generic.height;
571 return 1;
572}