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