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