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