Remove TUI data window special case
[deliverable/binutils-gdb.git] / gdb / tui / tui.c
1 /* General functions for the WDB TUI.
2
3 Copyright (C) 1998-2019 Free Software Foundation, Inc.
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 #include "terminal.h"
41 #include "top.h"
42
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 #include "interps.h"
53
54 /* This redefines CTRL if it is not already defined, so it must come
55 after terminal state releated include files like <term.h> and
56 "gdb_curses.h". */
57 #include "readline/readline.h"
58
59 /* Tells whether the TUI is active or not. */
60 int tui_active = 0;
61 static int tui_finish_init = 1;
62
63 enum tui_key_mode tui_current_key_mode = TUI_COMMAND_MODE;
64
65 struct tui_char_command
66 {
67 unsigned char key;
68 const char *cmd;
69 };
70
71 /* Key mapping to gdb commands when the TUI is using the single key
72 mode. */
73 static const struct tui_char_command tui_commands[] = {
74 { 'c', "continue" },
75 { 'd', "down" },
76 { 'f', "finish" },
77 { 'n', "next" },
78 { 'o', "nexti" },
79 { 'r', "run" },
80 { 's', "step" },
81 { 'i', "stepi" },
82 { 'u', "up" },
83 { 'v', "info locals" },
84 { 'w', "where" },
85 { 0, 0 },
86 };
87
88 static Keymap tui_keymap;
89 static Keymap tui_readline_standard_keymap;
90
91 /* TUI readline command.
92 Switch the output mode between TUI/standard gdb. */
93 static int
94 tui_rl_switch_mode (int notused1, int notused2)
95 {
96
97 /* Don't let exceptions escape. We're in the middle of a readline
98 callback that isn't prepared for that. */
99 try
100 {
101 if (tui_active)
102 {
103 tui_disable ();
104 rl_prep_terminal (0);
105 }
106 else
107 {
108 /* If tui_enable throws, we'll re-prep below. */
109 rl_deprep_terminal ();
110 tui_enable ();
111 }
112 }
113 catch (const gdb_exception &ex)
114 {
115 exception_print (gdb_stderr, ex);
116
117 if (!tui_active)
118 rl_prep_terminal (0);
119 }
120
121 /* Clear the readline in case switching occurred in middle of
122 something. */
123 if (rl_end)
124 rl_kill_text (0, rl_end);
125
126 /* Since we left the curses mode, the terminal mode is restored to
127 some previous state. That state may not be suitable for readline
128 to work correctly (it may be restored in line mode). We force an
129 exit of the current readline so that readline is re-entered and
130 it will be able to setup the terminal for its needs. By
131 re-entering in readline, we also redisplay its prompt in the
132 non-curses mode. */
133 rl_newline (1, '\n');
134
135 /* Make sure the \n we are returning does not repeat the last
136 command. */
137 dont_repeat ();
138 return 0;
139 }
140
141 /* TUI readline command.
142 Change the TUI layout to show a next layout.
143 This function is bound to CTRL-X 2. It is intended to provide
144 a functionality close to the Emacs split-window command. We
145 always show two windows (src+asm), (src+regs) or (asm+regs). */
146 static int
147 tui_rl_change_windows (int notused1, int notused2)
148 {
149 if (!tui_active)
150 tui_rl_switch_mode (0 /* notused */, 0 /* notused */);
151
152 if (tui_active)
153 {
154 enum tui_layout_type new_layout;
155
156 new_layout = tui_current_layout ();
157
158 /* Select a new layout to have a rolling layout behavior with
159 always two windows (except when undefined). */
160 switch (new_layout)
161 {
162 case SRC_COMMAND:
163 new_layout = SRC_DISASSEM_COMMAND;
164 break;
165
166 case DISASSEM_COMMAND:
167 new_layout = SRC_DISASSEM_COMMAND;
168 break;
169
170 case SRC_DATA_COMMAND:
171 new_layout = SRC_DISASSEM_COMMAND;
172 break;
173
174 case SRC_DISASSEM_COMMAND:
175 new_layout = DISASSEM_DATA_COMMAND;
176 break;
177
178 case DISASSEM_DATA_COMMAND:
179 new_layout = SRC_DATA_COMMAND;
180 break;
181
182 default:
183 new_layout = SRC_COMMAND;
184 break;
185 }
186 tui_set_layout (new_layout);
187 }
188 return 0;
189 }
190
191 /* TUI readline command.
192 Delete the second TUI window to only show one. */
193 static int
194 tui_rl_delete_other_windows (int notused1, int notused2)
195 {
196 if (!tui_active)
197 tui_rl_switch_mode (0 /* notused */, 0 /* notused */);
198
199 if (tui_active)
200 {
201 enum tui_layout_type new_layout;
202
203 new_layout = tui_current_layout ();
204
205 /* Kill one window. */
206 switch (new_layout)
207 {
208 case SRC_COMMAND:
209 case SRC_DATA_COMMAND:
210 case SRC_DISASSEM_COMMAND:
211 default:
212 new_layout = SRC_COMMAND;
213 break;
214
215 case DISASSEM_COMMAND:
216 case DISASSEM_DATA_COMMAND:
217 new_layout = DISASSEM_COMMAND;
218 break;
219 }
220 tui_set_layout (new_layout);
221 }
222 return 0;
223 }
224
225 /* TUI readline command.
226 Switch the active window to give the focus to a next window. */
227 static int
228 tui_rl_other_window (int count, int key)
229 {
230 struct tui_win_info *win_info;
231
232 if (!tui_active)
233 tui_rl_switch_mode (0 /* notused */, 0 /* notused */);
234
235 win_info = tui_next_win (tui_win_with_focus ());
236 if (win_info)
237 {
238 tui_set_win_focus_to (win_info);
239 keypad (TUI_CMD_WIN->handle, (win_info != TUI_CMD_WIN));
240 }
241 return 0;
242 }
243
244 /* TUI readline command.
245 Execute the gdb command bound to the specified key. */
246 static int
247 tui_rl_command_key (int count, int key)
248 {
249 int i;
250
251 reinitialize_more_filter ();
252 for (i = 0; tui_commands[i].cmd; i++)
253 {
254 if (tui_commands[i].key == key)
255 {
256 /* Insert the command in the readline buffer.
257 Avoid calling the gdb command here since it creates
258 a possible recursion on readline if prompt_for_continue
259 is called (See PR 9584). The command will also appear
260 in the readline history which turns out to be better. */
261 rl_insert_text (tui_commands[i].cmd);
262 rl_newline (1, '\n');
263
264 /* Switch to gdb command mode while executing the command.
265 This way the gdb's continue prompty will be displayed. */
266 tui_set_key_mode (TUI_ONE_COMMAND_MODE);
267 return 0;
268 }
269 }
270 return 0;
271 }
272
273 /* TUI readline command.
274 Temporarily leave the TUI SingleKey mode to allow editing
275 a gdb command with the normal readline. Once the command
276 is executed, the TUI SingleKey mode is installed back. */
277 static int
278 tui_rl_command_mode (int count, int key)
279 {
280 tui_set_key_mode (TUI_ONE_COMMAND_MODE);
281 return rl_insert (count, key);
282 }
283
284 /* TUI readline command.
285 Switch between TUI SingleKey mode and gdb readline editing. */
286 static int
287 tui_rl_next_keymap (int notused1, int notused2)
288 {
289 if (!tui_active)
290 tui_rl_switch_mode (0 /* notused */, 0 /* notused */);
291
292 tui_set_key_mode (tui_current_key_mode == TUI_COMMAND_MODE
293 ? TUI_SINGLE_KEY_MODE : TUI_COMMAND_MODE);
294 return 0;
295 }
296
297 /* Readline hook to redisplay ourself the gdb prompt.
298 In the SingleKey mode, the prompt is not printed so that
299 the command window is cleaner. It will be displayed if
300 we temporarily leave the SingleKey mode. */
301 static int
302 tui_rl_startup_hook (void)
303 {
304 rl_already_prompted = 1;
305 if (tui_current_key_mode != TUI_COMMAND_MODE
306 && !gdb_in_secondary_prompt_p (current_ui))
307 tui_set_key_mode (TUI_SINGLE_KEY_MODE);
308 tui_redisplay_readline ();
309 return 0;
310 }
311
312 /* Change the TUI key mode by installing the appropriate readline
313 keymap. */
314 void
315 tui_set_key_mode (enum tui_key_mode mode)
316 {
317 tui_current_key_mode = mode;
318 rl_set_keymap (mode == TUI_SINGLE_KEY_MODE
319 ? tui_keymap : tui_readline_standard_keymap);
320 tui_show_locator_content ();
321 }
322
323 /* Initialize readline and configure the keymap for the switching
324 key shortcut. */
325 void
326 tui_initialize_readline (void)
327 {
328 int i;
329 Keymap tui_ctlx_keymap;
330
331 rl_initialize ();
332
333 rl_add_defun ("tui-switch-mode", tui_rl_switch_mode, -1);
334 rl_add_defun ("gdb-command", tui_rl_command_key, -1);
335 rl_add_defun ("next-keymap", tui_rl_next_keymap, -1);
336
337 tui_keymap = rl_make_bare_keymap ();
338 tui_ctlx_keymap = rl_make_bare_keymap ();
339 tui_readline_standard_keymap = rl_get_keymap ();
340
341 for (i = 0; tui_commands[i].cmd; i++)
342 rl_bind_key_in_map (tui_commands[i].key, tui_rl_command_key, tui_keymap);
343
344 rl_generic_bind (ISKMAP, "\\C-x", (char*) tui_ctlx_keymap, tui_keymap);
345
346 /* Bind all other keys to tui_rl_command_mode so that we switch
347 temporarily from SingleKey mode and can enter a gdb command. */
348 for (i = ' '; i < 0x7f; i++)
349 {
350 int j;
351
352 for (j = 0; tui_commands[j].cmd; j++)
353 if (tui_commands[j].key == i)
354 break;
355
356 if (tui_commands[j].cmd)
357 continue;
358
359 rl_bind_key_in_map (i, tui_rl_command_mode, tui_keymap);
360 }
361
362 rl_bind_key_in_map ('a', tui_rl_switch_mode, emacs_ctlx_keymap);
363 rl_bind_key_in_map ('a', tui_rl_switch_mode, tui_ctlx_keymap);
364 rl_bind_key_in_map ('A', tui_rl_switch_mode, emacs_ctlx_keymap);
365 rl_bind_key_in_map ('A', tui_rl_switch_mode, tui_ctlx_keymap);
366 rl_bind_key_in_map (CTRL ('A'), tui_rl_switch_mode, emacs_ctlx_keymap);
367 rl_bind_key_in_map (CTRL ('A'), tui_rl_switch_mode, tui_ctlx_keymap);
368 rl_bind_key_in_map ('1', tui_rl_delete_other_windows, emacs_ctlx_keymap);
369 rl_bind_key_in_map ('1', tui_rl_delete_other_windows, tui_ctlx_keymap);
370 rl_bind_key_in_map ('2', tui_rl_change_windows, emacs_ctlx_keymap);
371 rl_bind_key_in_map ('2', tui_rl_change_windows, tui_ctlx_keymap);
372 rl_bind_key_in_map ('o', tui_rl_other_window, emacs_ctlx_keymap);
373 rl_bind_key_in_map ('o', tui_rl_other_window, tui_ctlx_keymap);
374 rl_bind_key_in_map ('q', tui_rl_next_keymap, tui_keymap);
375 rl_bind_key_in_map ('s', tui_rl_next_keymap, emacs_ctlx_keymap);
376 rl_bind_key_in_map ('s', tui_rl_next_keymap, tui_ctlx_keymap);
377 }
378
379 /* Return the TERM variable from the environment, or "<unset>"
380 if not set. */
381
382 static const char *
383 gdb_getenv_term (void)
384 {
385 const char *term;
386
387 term = getenv ("TERM");
388 if (term != NULL)
389 return term;
390 return "<unset>";
391 }
392
393 /* Enter in the tui mode (curses).
394 When in normal mode, it installs the tui hooks in gdb, redirects
395 the gdb output, configures the readline to work in tui mode.
396 When in curses mode, it does nothing. */
397 void
398 tui_enable (void)
399 {
400 if (tui_active)
401 return;
402
403 /* To avoid to initialize curses when gdb starts, there is a defered
404 curses initialization. This initialization is made only once
405 and the first time the curses mode is entered. */
406 if (tui_finish_init)
407 {
408 WINDOW *w;
409 SCREEN *s;
410 #ifndef __MINGW32__
411 const char *cap;
412 #endif
413 const char *interp;
414
415 /* If the top level interpreter is not the console/tui (e.g.,
416 MI), enabling curses will certainly lose. */
417 interp = top_level_interpreter ()->name ();
418 if (strcmp (interp, INTERP_TUI) != 0)
419 error (_("Cannot enable the TUI when the interpreter is '%s'"), interp);
420
421 /* Don't try to setup curses (and print funny control
422 characters) if we're not outputting to a terminal. */
423 if (!ui_file_isatty (gdb_stdout))
424 error (_("Cannot enable the TUI when output is not a terminal"));
425
426 s = newterm (NULL, stdout, stdin);
427 #ifdef __MINGW32__
428 /* The MinGW port of ncurses requires $TERM to be unset in order
429 to activate the Windows console driver. */
430 if (s == NULL)
431 s = newterm ((char *) "unknown", stdout, stdin);
432 #endif
433 if (s == NULL)
434 {
435 error (_("Cannot enable the TUI: error opening terminal [TERM=%s]"),
436 gdb_getenv_term ());
437 }
438 w = stdscr;
439 if (has_colors ())
440 {
441 #ifdef HAVE_USE_DEFAULT_COLORS
442 /* Ncurses extension to help with resetting to the default
443 color. */
444 use_default_colors ();
445 #endif
446 start_color ();
447 }
448
449 /* Check required terminal capabilities. The MinGW port of
450 ncurses does have them, but doesn't expose them through "cup". */
451 #ifndef __MINGW32__
452 cap = tigetstr ((char *) "cup");
453 if (cap == NULL || cap == (char *) -1 || *cap == '\0')
454 {
455 endwin ();
456 delscreen (s);
457 error (_("Cannot enable the TUI: "
458 "terminal doesn't support cursor addressing [TERM=%s]"),
459 gdb_getenv_term ());
460 }
461 #endif
462
463 cbreak ();
464 noecho ();
465 /* timeout (1); */
466 nodelay(w, FALSE);
467 nl();
468 keypad (w, TRUE);
469 rl_initialize ();
470 tui_set_term_height_to (LINES);
471 tui_set_term_width_to (COLS);
472 def_prog_mode ();
473
474 tui_show_frame_info (0);
475 tui_set_layout (SRC_COMMAND);
476 tui_set_win_focus_to (TUI_SRC_WIN);
477 keypad (TUI_CMD_WIN->handle, TRUE);
478 wrefresh (TUI_CMD_WIN->handle);
479 tui_finish_init = 0;
480 }
481 else
482 {
483 /* Save the current gdb setting of the terminal.
484 Curses will restore this state when endwin() is called. */
485 def_shell_mode ();
486 clearok (stdscr, TRUE);
487 }
488
489 /* Install the TUI specific hooks. */
490 tui_install_hooks ();
491 rl_startup_hook = tui_rl_startup_hook;
492
493 tui_update_variables ();
494
495 tui_setup_io (1);
496
497 tui_active = 1;
498
499 /* Resize windows before anything might display/refresh a
500 window. */
501 if (tui_win_resized ())
502 {
503 tui_set_win_resized_to (FALSE);
504 tui_resize_all ();
505 }
506
507 if (deprecated_safe_get_selected_frame ())
508 tui_show_frame_info (deprecated_safe_get_selected_frame ());
509
510 /* Restore TUI keymap. */
511 tui_set_key_mode (tui_current_key_mode);
512
513 /* Refresh the screen. */
514 tui_refresh_all_win ();
515
516 /* Update gdb's knowledge of its terminal. */
517 gdb_save_tty_state ();
518 tui_update_gdb_sizes ();
519 }
520
521 /* Leave the tui mode.
522 Remove the tui hooks and configure the gdb output and readline
523 back to their original state. The curses mode is left so that
524 the terminal setting is restored to the point when we entered. */
525 void
526 tui_disable (void)
527 {
528 if (!tui_active)
529 return;
530
531 /* Restore initial readline keymap. */
532 rl_set_keymap (tui_readline_standard_keymap);
533
534 /* Remove TUI hooks. */
535 tui_remove_hooks ();
536 rl_startup_hook = 0;
537 rl_already_prompted = 0;
538
539 /* Leave curses and restore previous gdb terminal setting. */
540 endwin ();
541
542 /* gdb terminal has changed, update gdb internal copy of it
543 so that terminal management with the inferior works. */
544 tui_setup_io (0);
545
546 /* Update gdb's knowledge of its terminal. */
547 gdb_save_tty_state ();
548
549 tui_active = 0;
550 tui_update_gdb_sizes ();
551 }
552
553 /* Command wrapper for enabling tui mode. */
554
555 static void
556 tui_enable_command (const char *args, int from_tty)
557 {
558 tui_enable ();
559 }
560
561 /* Command wrapper for leaving tui mode. */
562
563 static void
564 tui_disable_command (const char *args, int from_tty)
565 {
566 tui_disable ();
567 }
568
569 void
570 strcat_to_buf (char *buf, int buflen,
571 const char *item_to_add)
572 {
573 if (item_to_add != NULL && buf != NULL)
574 {
575 if ((strlen (buf) + strlen (item_to_add)) <= buflen)
576 strcat (buf, item_to_add);
577 else
578 strncat (buf, item_to_add, (buflen - strlen (buf)));
579 }
580 }
581
582 #if 0
583 /* Solaris <sys/termios.h> defines CTRL. */
584 #ifndef CTRL
585 #define CTRL(x) (x & ~0140)
586 #endif
587
588 #define FILEDES 2
589 #define CHK(val, dft) (val<=0 ? dft : val)
590
591 static void
592 tui_reset (void)
593 {
594 struct termio mode;
595
596 /* Reset the teletype mode bits to a sensible state.
597 Copied tset.c. */
598 #if defined (TIOCGETC)
599 struct tchars tbuf;
600 #endif /* TIOCGETC */
601 #ifdef UCB_NTTY
602 struct ltchars ltc;
603
604 if (ldisc == NTTYDISC)
605 {
606 ioctl (FILEDES, TIOCGLTC, &ltc);
607 ltc.t_suspc = CHK (ltc.t_suspc, CTRL ('Z'));
608 ltc.t_dsuspc = CHK (ltc.t_dsuspc, CTRL ('Y'));
609 ltc.t_rprntc = CHK (ltc.t_rprntc, CTRL ('R'));
610 ltc.t_flushc = CHK (ltc.t_flushc, CTRL ('O'));
611 ltc.t_werasc = CHK (ltc.t_werasc, CTRL ('W'));
612 ltc.t_lnextc = CHK (ltc.t_lnextc, CTRL ('V'));
613 ioctl (FILEDES, TIOCSLTC, &ltc);
614 }
615 #endif /* UCB_NTTY */
616 #ifdef TIOCGETC
617 ioctl (FILEDES, TIOCGETC, &tbuf);
618 tbuf.t_intrc = CHK (tbuf.t_intrc, CTRL ('?'));
619 tbuf.t_quitc = CHK (tbuf.t_quitc, CTRL ('\\'));
620 tbuf.t_startc = CHK (tbuf.t_startc, CTRL ('Q'));
621 tbuf.t_stopc = CHK (tbuf.t_stopc, CTRL ('S'));
622 tbuf.t_eofc = CHK (tbuf.t_eofc, CTRL ('D'));
623 /* brkc is left alone. */
624 ioctl (FILEDES, TIOCSETC, &tbuf);
625 #endif /* TIOCGETC */
626 mode.sg_flags &= ~(RAW
627 #ifdef CBREAK
628 | CBREAK
629 #endif /* CBREAK */
630 | VTDELAY | ALLDELAY);
631 mode.sg_flags |= XTABS | ECHO | CRMOD | ANYP;
632
633 return;
634 }
635 #endif
636
637 void
638 tui_show_source (const char *fullname, int line)
639 {
640 struct symtab_and_line cursal = get_current_source_symtab_and_line ();
641
642 /* Make sure that the source window is displayed. */
643 tui_add_win_to_layout (SRC_WIN);
644
645 tui_update_source_windows_with_line (cursal.symtab, line);
646 tui_update_locator_fullname (fullname);
647 }
648
649 void
650 tui_show_assembly (struct gdbarch *gdbarch, CORE_ADDR addr)
651 {
652 tui_add_win_to_layout (DISASSEM_WIN);
653 tui_update_source_windows_with_addr (gdbarch, addr);
654 }
655
656 bool
657 tui_is_window_visible (enum tui_win_type type)
658 {
659 if (tui_active == 0)
660 return false;
661
662 if (tui_win_list[type] == 0)
663 return false;
664
665 return tui_win_list[type]->is_visible;
666 }
667
668 int
669 tui_get_command_dimension (unsigned int *width,
670 unsigned int *height)
671 {
672 if (!tui_active || (TUI_CMD_WIN == NULL))
673 {
674 return 0;
675 }
676
677 *width = TUI_CMD_WIN->width;
678 *height = TUI_CMD_WIN->height;
679 return 1;
680 }
681
682 void
683 _initialize_tui (void)
684 {
685 struct cmd_list_element **tuicmd;
686
687 tuicmd = tui_get_cmd_list ();
688
689 add_cmd ("enable", class_tui, tui_enable_command,
690 _("Enable TUI display mode."),
691 tuicmd);
692 add_cmd ("disable", class_tui, tui_disable_command,
693 _("Disable TUI display mode."),
694 tuicmd);
695 }
This page took 0.073758 seconds and 5 git commands to generate.