Rename gdb exception types
[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 if (TUI_DATA_WIN && TUI_DATA_WIN->generic.is_visible)
240 tui_refresh_data_win ();
241 keypad (TUI_CMD_WIN->generic.handle, (win_info != TUI_CMD_WIN));
242 }
243 return 0;
244 }
245
246 /* TUI readline command.
247 Execute the gdb command bound to the specified key. */
248 static int
249 tui_rl_command_key (int count, int key)
250 {
251 int i;
252
253 reinitialize_more_filter ();
254 for (i = 0; tui_commands[i].cmd; i++)
255 {
256 if (tui_commands[i].key == key)
257 {
258 /* Insert the command in the readline buffer.
259 Avoid calling the gdb command here since it creates
260 a possible recursion on readline if prompt_for_continue
261 is called (See PR 9584). The command will also appear
262 in the readline history which turns out to be better. */
263 rl_insert_text (tui_commands[i].cmd);
264 rl_newline (1, '\n');
265
266 /* Switch to gdb command mode while executing the command.
267 This way the gdb's continue prompty will be displayed. */
268 tui_set_key_mode (TUI_ONE_COMMAND_MODE);
269 return 0;
270 }
271 }
272 return 0;
273 }
274
275 /* TUI readline command.
276 Temporarily leave the TUI SingleKey mode to allow editing
277 a gdb command with the normal readline. Once the command
278 is executed, the TUI SingleKey mode is installed back. */
279 static int
280 tui_rl_command_mode (int count, int key)
281 {
282 tui_set_key_mode (TUI_ONE_COMMAND_MODE);
283 return rl_insert (count, key);
284 }
285
286 /* TUI readline command.
287 Switch between TUI SingleKey mode and gdb readline editing. */
288 static int
289 tui_rl_next_keymap (int notused1, int notused2)
290 {
291 if (!tui_active)
292 tui_rl_switch_mode (0 /* notused */, 0 /* notused */);
293
294 tui_set_key_mode (tui_current_key_mode == TUI_COMMAND_MODE
295 ? TUI_SINGLE_KEY_MODE : TUI_COMMAND_MODE);
296 return 0;
297 }
298
299 /* Readline hook to redisplay ourself the gdb prompt.
300 In the SingleKey mode, the prompt is not printed so that
301 the command window is cleaner. It will be displayed if
302 we temporarily leave the SingleKey mode. */
303 static int
304 tui_rl_startup_hook (void)
305 {
306 rl_already_prompted = 1;
307 if (tui_current_key_mode != TUI_COMMAND_MODE
308 && !gdb_in_secondary_prompt_p (current_ui))
309 tui_set_key_mode (TUI_SINGLE_KEY_MODE);
310 tui_redisplay_readline ();
311 return 0;
312 }
313
314 /* Change the TUI key mode by installing the appropriate readline
315 keymap. */
316 void
317 tui_set_key_mode (enum tui_key_mode mode)
318 {
319 tui_current_key_mode = mode;
320 rl_set_keymap (mode == TUI_SINGLE_KEY_MODE
321 ? tui_keymap : tui_readline_standard_keymap);
322 tui_show_locator_content ();
323 }
324
325 /* Initialize readline and configure the keymap for the switching
326 key shortcut. */
327 void
328 tui_initialize_readline (void)
329 {
330 int i;
331 Keymap tui_ctlx_keymap;
332
333 rl_initialize ();
334
335 rl_add_defun ("tui-switch-mode", tui_rl_switch_mode, -1);
336 rl_add_defun ("gdb-command", tui_rl_command_key, -1);
337 rl_add_defun ("next-keymap", tui_rl_next_keymap, -1);
338
339 tui_keymap = rl_make_bare_keymap ();
340 tui_ctlx_keymap = rl_make_bare_keymap ();
341 tui_readline_standard_keymap = rl_get_keymap ();
342
343 for (i = 0; tui_commands[i].cmd; i++)
344 rl_bind_key_in_map (tui_commands[i].key, tui_rl_command_key, tui_keymap);
345
346 rl_generic_bind (ISKMAP, "\\C-x", (char*) tui_ctlx_keymap, tui_keymap);
347
348 /* Bind all other keys to tui_rl_command_mode so that we switch
349 temporarily from SingleKey mode and can enter a gdb command. */
350 for (i = ' '; i < 0x7f; i++)
351 {
352 int j;
353
354 for (j = 0; tui_commands[j].cmd; j++)
355 if (tui_commands[j].key == i)
356 break;
357
358 if (tui_commands[j].cmd)
359 continue;
360
361 rl_bind_key_in_map (i, tui_rl_command_mode, tui_keymap);
362 }
363
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 ('A', tui_rl_switch_mode, emacs_ctlx_keymap);
367 rl_bind_key_in_map ('A', tui_rl_switch_mode, tui_ctlx_keymap);
368 rl_bind_key_in_map (CTRL ('A'), tui_rl_switch_mode, emacs_ctlx_keymap);
369 rl_bind_key_in_map (CTRL ('A'), tui_rl_switch_mode, tui_ctlx_keymap);
370 rl_bind_key_in_map ('1', tui_rl_delete_other_windows, emacs_ctlx_keymap);
371 rl_bind_key_in_map ('1', tui_rl_delete_other_windows, tui_ctlx_keymap);
372 rl_bind_key_in_map ('2', tui_rl_change_windows, emacs_ctlx_keymap);
373 rl_bind_key_in_map ('2', tui_rl_change_windows, tui_ctlx_keymap);
374 rl_bind_key_in_map ('o', tui_rl_other_window, emacs_ctlx_keymap);
375 rl_bind_key_in_map ('o', tui_rl_other_window, tui_ctlx_keymap);
376 rl_bind_key_in_map ('q', tui_rl_next_keymap, tui_keymap);
377 rl_bind_key_in_map ('s', tui_rl_next_keymap, emacs_ctlx_keymap);
378 rl_bind_key_in_map ('s', tui_rl_next_keymap, tui_ctlx_keymap);
379 }
380
381 /* Return the TERM variable from the environment, or "<unset>"
382 if not set. */
383
384 static const char *
385 gdb_getenv_term (void)
386 {
387 const char *term;
388
389 term = getenv ("TERM");
390 if (term != NULL)
391 return term;
392 return "<unset>";
393 }
394
395 /* Enter in the tui mode (curses).
396 When in normal mode, it installs the tui hooks in gdb, redirects
397 the gdb output, configures the readline to work in tui mode.
398 When in curses mode, it does nothing. */
399 void
400 tui_enable (void)
401 {
402 if (tui_active)
403 return;
404
405 /* To avoid to initialize curses when gdb starts, there is a defered
406 curses initialization. This initialization is made only once
407 and the first time the curses mode is entered. */
408 if (tui_finish_init)
409 {
410 WINDOW *w;
411 SCREEN *s;
412 #ifndef __MINGW32__
413 const char *cap;
414 #endif
415 const char *interp;
416
417 /* If the top level interpreter is not the console/tui (e.g.,
418 MI), enabling curses will certainly lose. */
419 interp = top_level_interpreter ()->name ();
420 if (strcmp (interp, INTERP_TUI) != 0)
421 error (_("Cannot enable the TUI when the interpreter is '%s'"), interp);
422
423 /* Don't try to setup curses (and print funny control
424 characters) if we're not outputting to a terminal. */
425 if (!ui_file_isatty (gdb_stdout))
426 error (_("Cannot enable the TUI when output is not a terminal"));
427
428 s = newterm (NULL, stdout, stdin);
429 #ifdef __MINGW32__
430 /* The MinGW port of ncurses requires $TERM to be unset in order
431 to activate the Windows console driver. */
432 if (s == NULL)
433 s = newterm ((char *) "unknown", stdout, stdin);
434 #endif
435 if (s == NULL)
436 {
437 error (_("Cannot enable the TUI: error opening terminal [TERM=%s]"),
438 gdb_getenv_term ());
439 }
440 w = stdscr;
441 if (has_colors ())
442 {
443 #ifdef HAVE_USE_DEFAULT_COLORS
444 /* Ncurses extension to help with resetting to the default
445 color. */
446 use_default_colors ();
447 #endif
448 start_color ();
449 }
450
451 /* Check required terminal capabilities. The MinGW port of
452 ncurses does have them, but doesn't expose them through "cup". */
453 #ifndef __MINGW32__
454 cap = tigetstr ((char *) "cup");
455 if (cap == NULL || cap == (char *) -1 || *cap == '\0')
456 {
457 endwin ();
458 delscreen (s);
459 error (_("Cannot enable the TUI: "
460 "terminal doesn't support cursor addressing [TERM=%s]"),
461 gdb_getenv_term ());
462 }
463 #endif
464
465 cbreak ();
466 noecho ();
467 /* timeout (1); */
468 nodelay(w, FALSE);
469 nl();
470 keypad (w, TRUE);
471 rl_initialize ();
472 tui_set_term_height_to (LINES);
473 tui_set_term_width_to (COLS);
474 def_prog_mode ();
475
476 tui_show_frame_info (0);
477 tui_set_layout (SRC_COMMAND);
478 tui_set_win_focus_to (TUI_SRC_WIN);
479 keypad (TUI_CMD_WIN->generic.handle, TRUE);
480 wrefresh (TUI_CMD_WIN->generic.handle);
481 tui_finish_init = 0;
482 }
483 else
484 {
485 /* Save the current gdb setting of the terminal.
486 Curses will restore this state when endwin() is called. */
487 def_shell_mode ();
488 clearok (stdscr, TRUE);
489 }
490
491 /* Install the TUI specific hooks. */
492 tui_install_hooks ();
493 rl_startup_hook = tui_rl_startup_hook;
494
495 tui_update_variables ();
496
497 tui_setup_io (1);
498
499 tui_active = 1;
500
501 /* Resize windows before anything might display/refresh a
502 window. */
503 if (tui_win_resized ())
504 {
505 tui_set_win_resized_to (FALSE);
506 tui_resize_all ();
507 }
508
509 if (deprecated_safe_get_selected_frame ())
510 tui_show_frame_info (deprecated_safe_get_selected_frame ());
511
512 /* Restore TUI keymap. */
513 tui_set_key_mode (tui_current_key_mode);
514
515 /* Refresh the screen. */
516 tui_refresh_all_win ();
517
518 /* Update gdb's knowledge of its terminal. */
519 gdb_save_tty_state ();
520 tui_update_gdb_sizes ();
521 }
522
523 /* Leave the tui mode.
524 Remove the tui hooks and configure the gdb output and readline
525 back to their original state. The curses mode is left so that
526 the terminal setting is restored to the point when we entered. */
527 void
528 tui_disable (void)
529 {
530 if (!tui_active)
531 return;
532
533 /* Restore initial readline keymap. */
534 rl_set_keymap (tui_readline_standard_keymap);
535
536 /* Remove TUI hooks. */
537 tui_remove_hooks ();
538 rl_startup_hook = 0;
539 rl_already_prompted = 0;
540
541 /* Leave curses and restore previous gdb terminal setting. */
542 endwin ();
543
544 /* gdb terminal has changed, update gdb internal copy of it
545 so that terminal management with the inferior works. */
546 tui_setup_io (0);
547
548 /* Update gdb's knowledge of its terminal. */
549 gdb_save_tty_state ();
550
551 tui_active = 0;
552 tui_update_gdb_sizes ();
553 }
554
555 /* Command wrapper for enabling tui mode. */
556
557 static void
558 tui_enable_command (const char *args, int from_tty)
559 {
560 tui_enable ();
561 }
562
563 /* Command wrapper for leaving tui mode. */
564
565 static void
566 tui_disable_command (const char *args, int from_tty)
567 {
568 tui_disable ();
569 }
570
571 void
572 strcat_to_buf (char *buf, int buflen,
573 const char *item_to_add)
574 {
575 if (item_to_add != NULL && buf != NULL)
576 {
577 if ((strlen (buf) + strlen (item_to_add)) <= buflen)
578 strcat (buf, item_to_add);
579 else
580 strncat (buf, item_to_add, (buflen - strlen (buf)));
581 }
582 }
583
584 #if 0
585 /* Solaris <sys/termios.h> defines CTRL. */
586 #ifndef CTRL
587 #define CTRL(x) (x & ~0140)
588 #endif
589
590 #define FILEDES 2
591 #define CHK(val, dft) (val<=0 ? dft : val)
592
593 static void
594 tui_reset (void)
595 {
596 struct termio mode;
597
598 /* Reset the teletype mode bits to a sensible state.
599 Copied tset.c. */
600 #if defined (TIOCGETC)
601 struct tchars tbuf;
602 #endif /* TIOCGETC */
603 #ifdef UCB_NTTY
604 struct ltchars ltc;
605
606 if (ldisc == NTTYDISC)
607 {
608 ioctl (FILEDES, TIOCGLTC, &ltc);
609 ltc.t_suspc = CHK (ltc.t_suspc, CTRL ('Z'));
610 ltc.t_dsuspc = CHK (ltc.t_dsuspc, CTRL ('Y'));
611 ltc.t_rprntc = CHK (ltc.t_rprntc, CTRL ('R'));
612 ltc.t_flushc = CHK (ltc.t_flushc, CTRL ('O'));
613 ltc.t_werasc = CHK (ltc.t_werasc, CTRL ('W'));
614 ltc.t_lnextc = CHK (ltc.t_lnextc, CTRL ('V'));
615 ioctl (FILEDES, TIOCSLTC, &ltc);
616 }
617 #endif /* UCB_NTTY */
618 #ifdef TIOCGETC
619 ioctl (FILEDES, TIOCGETC, &tbuf);
620 tbuf.t_intrc = CHK (tbuf.t_intrc, CTRL ('?'));
621 tbuf.t_quitc = CHK (tbuf.t_quitc, CTRL ('\\'));
622 tbuf.t_startc = CHK (tbuf.t_startc, CTRL ('Q'));
623 tbuf.t_stopc = CHK (tbuf.t_stopc, CTRL ('S'));
624 tbuf.t_eofc = CHK (tbuf.t_eofc, CTRL ('D'));
625 /* brkc is left alone. */
626 ioctl (FILEDES, TIOCSETC, &tbuf);
627 #endif /* TIOCGETC */
628 mode.sg_flags &= ~(RAW
629 #ifdef CBREAK
630 | CBREAK
631 #endif /* CBREAK */
632 | VTDELAY | ALLDELAY);
633 mode.sg_flags |= XTABS | ECHO | CRMOD | ANYP;
634
635 return;
636 }
637 #endif
638
639 void
640 tui_show_source (const char *fullname, int line)
641 {
642 struct symtab_and_line cursal = get_current_source_symtab_and_line ();
643
644 /* Make sure that the source window is displayed. */
645 tui_add_win_to_layout (SRC_WIN);
646
647 tui_update_source_windows_with_line (cursal.symtab, line);
648 tui_update_locator_fullname (fullname);
649 }
650
651 void
652 tui_show_assembly (struct gdbarch *gdbarch, CORE_ADDR addr)
653 {
654 tui_add_win_to_layout (DISASSEM_WIN);
655 tui_update_source_windows_with_addr (gdbarch, addr);
656 }
657
658 int
659 tui_is_window_visible (enum tui_win_type type)
660 {
661 if (tui_active == 0)
662 return 0;
663
664 if (tui_win_list[type] == 0)
665 return 0;
666
667 return tui_win_list[type]->generic.is_visible;
668 }
669
670 int
671 tui_get_command_dimension (unsigned int *width,
672 unsigned int *height)
673 {
674 if (!tui_active || (TUI_CMD_WIN == NULL))
675 {
676 return 0;
677 }
678
679 *width = TUI_CMD_WIN->generic.width;
680 *height = TUI_CMD_WIN->generic.height;
681 return 1;
682 }
683
684 void
685 _initialize_tui (void)
686 {
687 struct cmd_list_element **tuicmd;
688
689 tuicmd = tui_get_cmd_list ();
690
691 add_cmd ("enable", class_tui, tui_enable_command,
692 _("Enable TUI display mode."),
693 tuicmd);
694 add_cmd ("disable", class_tui, tui_disable_command,
695 _("Disable TUI display mode."),
696 tuicmd);
697 }
This page took 0.1147 seconds and 4 git commands to generate.