7c3e70497a17f6e23528edc451b8affe8e6badc0
[external/binutils.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 (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_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   if (tui_active)
402     return;
403
404   /* To avoid to initialize curses when gdb starts, there is a defered
405      curses initialization.  This initialization is made only once
406      and the first time the curses mode is entered.  */
407   if (tui_finish_init)
408     {
409       WINDOW *w;
410       SCREEN *s;
411       const char *cap;
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 = interp_name (top_level_interpreter ());
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 ("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
439       /* Check required terminal capabilities.  The MinGW port of
440          ncurses does have them, but doesn't expose them through "cup".  */
441 #ifndef __MINGW32__
442       cap = tigetstr ("cup");
443       if (cap == NULL || cap == (char *) -1 || *cap == '\0')
444         {
445           endwin ();
446           delscreen (s);
447           error (_("Cannot enable the TUI: "
448                    "terminal doesn't support cursor addressing [TERM=%s]"),
449                  gdb_getenv_term ());
450         }
451 #endif
452
453       cbreak ();
454       noecho ();
455       /* timeout (1); */
456       nodelay(w, FALSE);
457       nl();
458       keypad (w, TRUE);
459       rl_initialize ();
460       tui_set_term_height_to (LINES);
461       tui_set_term_width_to (COLS);
462       def_prog_mode ();
463
464       tui_show_frame_info (0);
465       tui_set_layout (SRC_COMMAND);
466       tui_set_win_focus_to (TUI_SRC_WIN);
467       keypad (TUI_CMD_WIN->generic.handle, TRUE);
468       wrefresh (TUI_CMD_WIN->generic.handle);
469       tui_finish_init = 0;
470     }
471   else
472     {
473      /* Save the current gdb setting of the terminal.
474         Curses will restore this state when endwin() is called.  */
475      def_shell_mode ();
476      clearok (stdscr, TRUE);
477    }
478
479   /* Install the TUI specific hooks.  */
480   tui_install_hooks ();
481   rl_startup_hook = tui_rl_startup_hook;
482
483   tui_update_variables ();
484   
485   tui_setup_io (1);
486
487   tui_active = 1;
488
489   /* Resize windows before anything might display/refresh a
490      window.  */
491   if (tui_win_resized ())
492     {
493       tui_set_win_resized_to (FALSE);
494       tui_resize_all ();
495     }
496
497   if (deprecated_safe_get_selected_frame ())
498     tui_show_frame_info (deprecated_safe_get_selected_frame ());
499
500   /* Restore TUI keymap.  */
501   tui_set_key_mode (tui_current_key_mode);
502
503   /* Refresh the screen.  */
504   tui_refresh_all_win ();
505
506   /* Update gdb's knowledge of its terminal.  */
507   gdb_save_tty_state ();
508   tui_update_gdb_sizes ();
509 }
510
511 /* Leave the tui mode.
512    Remove the tui hooks and configure the gdb output and readline
513    back to their original state.  The curses mode is left so that
514    the terminal setting is restored to the point when we entered.  */
515 void
516 tui_disable (void)
517 {
518   if (!tui_active)
519     return;
520
521   /* Restore initial readline keymap.  */
522   rl_set_keymap (tui_readline_standard_keymap);
523
524   /* Remove TUI hooks.  */
525   tui_remove_hooks ();
526   rl_startup_hook = 0;
527   rl_already_prompted = 0;
528
529   /* Leave curses and restore previous gdb terminal setting.  */
530   endwin ();
531
532   /* gdb terminal has changed, update gdb internal copy of it
533      so that terminal management with the inferior works.  */
534   tui_setup_io (0);
535
536   /* Update gdb's knowledge of its terminal.  */
537   gdb_save_tty_state ();
538
539   tui_active = 0;
540   tui_update_gdb_sizes ();
541 }
542
543 /* Command wrapper for enabling tui mode.  */
544
545 static void
546 tui_enable_command (char *args, int from_tty)
547 {
548   tui_enable ();
549 }
550
551 /* Command wrapper for leaving tui mode.  */
552
553 static void
554 tui_disable_command (char *args, int from_tty)
555 {
556   tui_disable ();
557 }
558
559 void
560 strcat_to_buf (char *buf, int buflen, 
561                const char *item_to_add)
562 {
563   if (item_to_add != (char *) NULL && buf != (char *) NULL)
564     {
565       if ((strlen (buf) + strlen (item_to_add)) <= buflen)
566         strcat (buf, item_to_add);
567       else
568         strncat (buf, item_to_add, (buflen - strlen (buf)));
569     }
570 }
571
572 #if 0
573 /* Solaris <sys/termios.h> defines CTRL.  */
574 #ifndef CTRL
575 #define CTRL(x)         (x & ~0140)
576 #endif
577
578 #define FILEDES         2
579 #define CHK(val, dft)   (val<=0 ? dft : val)
580
581 static void
582 tui_reset (void)
583 {
584   struct termio mode;
585
586   /* Reset the teletype mode bits to a sensible state.
587      Copied tset.c.  */
588 #if defined (TIOCGETC)
589   struct tchars tbuf;
590 #endif /* TIOCGETC */
591 #ifdef UCB_NTTY
592   struct ltchars ltc;
593
594   if (ldisc == NTTYDISC)
595     {
596       ioctl (FILEDES, TIOCGLTC, &ltc);
597       ltc.t_suspc = CHK (ltc.t_suspc, CTRL ('Z'));
598       ltc.t_dsuspc = CHK (ltc.t_dsuspc, CTRL ('Y'));
599       ltc.t_rprntc = CHK (ltc.t_rprntc, CTRL ('R'));
600       ltc.t_flushc = CHK (ltc.t_flushc, CTRL ('O'));
601       ltc.t_werasc = CHK (ltc.t_werasc, CTRL ('W'));
602       ltc.t_lnextc = CHK (ltc.t_lnextc, CTRL ('V'));
603       ioctl (FILEDES, TIOCSLTC, &ltc);
604     }
605 #endif /* UCB_NTTY */
606 #ifdef TIOCGETC
607   ioctl (FILEDES, TIOCGETC, &tbuf);
608   tbuf.t_intrc = CHK (tbuf.t_intrc, CTRL ('?'));
609   tbuf.t_quitc = CHK (tbuf.t_quitc, CTRL ('\\'));
610   tbuf.t_startc = CHK (tbuf.t_startc, CTRL ('Q'));
611   tbuf.t_stopc = CHK (tbuf.t_stopc, CTRL ('S'));
612   tbuf.t_eofc = CHK (tbuf.t_eofc, CTRL ('D'));
613   /* brkc is left alone.  */
614   ioctl (FILEDES, TIOCSETC, &tbuf);
615 #endif /* TIOCGETC */
616   mode.sg_flags &= ~(RAW
617 #ifdef CBREAK
618                      | CBREAK
619 #endif /* CBREAK */
620                      | VTDELAY | ALLDELAY);
621   mode.sg_flags |= XTABS | ECHO | CRMOD | ANYP;
622
623   return;
624 }
625 #endif
626
627 void
628 tui_show_source (const char *fullname, int line)
629 {
630   struct symtab_and_line cursal = get_current_source_symtab_and_line ();
631
632   /* Make sure that the source window is displayed.  */
633   tui_add_win_to_layout (SRC_WIN);
634
635   tui_update_source_windows_with_line (cursal.symtab, line);
636   tui_update_locator_fullname (fullname);
637 }
638
639 void
640 tui_show_assembly (struct gdbarch *gdbarch, CORE_ADDR addr)
641 {
642   tui_add_win_to_layout (DISASSEM_WIN);
643   tui_update_source_windows_with_addr (gdbarch, addr);
644 }
645
646 int
647 tui_is_window_visible (enum tui_win_type type)
648 {
649   if (tui_active == 0)
650     return 0;
651
652   if (tui_win_list[type] == 0)
653     return 0;
654   
655   return tui_win_list[type]->generic.is_visible;
656 }
657
658 int
659 tui_get_command_dimension (unsigned int *width, 
660                            unsigned int *height)
661 {
662   if (!tui_active || (TUI_CMD_WIN == NULL))
663     {
664       return 0;
665     }
666   
667   *width = TUI_CMD_WIN->generic.width;
668   *height = TUI_CMD_WIN->generic.height;
669   return 1;
670 }
671
672 /* Provide a prototype to silence -Wmissing-prototypes.  */
673 extern initialize_file_ftype _initialize_tui;
674
675 void
676 _initialize_tui (void)
677 {
678   struct cmd_list_element **tuicmd;
679
680   tuicmd = tui_get_cmd_list ();
681
682   add_cmd ("enable", class_tui, tui_enable_command,
683            _("Enable TUI display mode."),
684            tuicmd);
685   add_cmd ("disable", class_tui, tui_disable_command,
686            _("Disable TUI display mode."),
687            tuicmd);
688 }