1 /* TUI support I/O functions.
3 Copyright (C) 1998-2018 Free Software Foundation, Inc.
5 Contributed by Hewlett-Packard Company.
7 This file is part of GDB.
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.
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.
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/>. */
24 #include "event-loop.h"
25 #include "event-top.h"
29 #include "tui/tui-data.h"
30 #include "tui/tui-io.h"
31 #include "tui/tui-command.h"
32 #include "tui/tui-win.h"
33 #include "tui/tui-wingeneral.h"
34 #include "tui/tui-file.h"
35 #include "tui/tui-out.h"
40 #include "filestuff.h"
41 #include "completer.h"
42 #include "gdb_curses.h"
45 /* This redefines CTRL if it is not already defined, so it must come
46 after terminal state releated include files like <term.h> and
48 #include "readline/readline.h"
50 static int tui_getc (FILE *fp
);
53 key_is_start_sequence (int ch
)
58 /* Use definition from readline 4.3. */
60 #define CTRL_CHAR(c) \
61 ((c) < control_character_threshold && (((c) & 0x80) == 0))
63 /* This file controls the IO interactions between gdb and curses.
64 When the TUI is enabled, gdb has two modes a curses and a standard
67 In curses mode, the gdb outputs are made in a curses command
68 window. For this, the gdb_stdout and gdb_stderr are redirected to
69 the specific ui_file implemented by TUI. The output is handled by
70 tui_puts(). The input is also controlled by curses with
71 tui_getc(). The readline library uses this function to get its
72 input. Several readline hooks are installed to redirect readline
73 output to the TUI (see also the note below).
75 In normal mode, the gdb outputs are restored to their origin, that
76 is as if TUI is not used. Readline also uses its original getc()
79 Note SCz/2001-07-21: the current readline is not clean in its
80 management of the output. Even if we install a redisplay handler,
81 it sometimes writes on a stdout file. It is important to redirect
82 every output produced by readline, otherwise the curses window will
83 be garbled. This is implemented with a pipe that TUI reads and
84 readline writes to. A gdb input handler is created so that reading
85 the pipe is handled automatically. This will probably not work on
86 non-Unix platforms. The best fix is to make readline clean enougth
87 so that is never write on stdout.
89 Note SCz/2002-09-01: we now use more readline hooks and it seems
90 that with them we don't need the pipe anymore (verified by creating
91 the pipe and closing its end so that write causes a SIGPIPE). The
92 old pipe code is still there and can be conditionally removed by
93 #undef TUI_USE_PIPE_FOR_READLINE. */
95 /* For gdb 5.3, prefer to continue the pipe hack as a backup wheel. */
97 #define TUI_USE_PIPE_FOR_READLINE
99 /* #undef TUI_USE_PIPE_FOR_READLINE */
101 /* TUI output files. */
102 static struct ui_file
*tui_stdout
;
103 static struct ui_file
*tui_stderr
;
104 struct ui_out
*tui_out
;
106 /* GDB output files in non-curses mode. */
107 static struct ui_file
*tui_old_stdout
;
108 static struct ui_file
*tui_old_stderr
;
109 cli_ui_out
*tui_old_uiout
;
111 /* Readline previous hooks. */
112 static rl_getc_func_t
*tui_old_rl_getc_function
;
113 static rl_voidfunc_t
*tui_old_rl_redisplay_function
;
114 static rl_vintfunc_t
*tui_old_rl_prep_terminal
;
115 static rl_voidfunc_t
*tui_old_rl_deprep_terminal
;
116 static rl_compdisp_func_t
*tui_old_rl_display_matches_hook
;
117 static int tui_old_rl_echoing_p
;
119 /* Readline output stream.
120 Should be removed when readline is clean. */
121 static FILE *tui_rl_outstream
;
122 static FILE *tui_old_rl_outstream
;
123 #ifdef TUI_USE_PIPE_FOR_READLINE
124 static int tui_readline_pipe
[2];
127 /* The last gdb prompt that was registered in readline.
128 This may be the main gdb prompt or a secondary prompt. */
129 static char *tui_rl_saved_prompt
;
131 /* Print a character in the curses command window. The output is
132 buffered. It is up to the caller to refresh the screen if
136 do_tui_putc (WINDOW
*w
, char c
)
138 static int tui_skip_line
= -1;
140 /* Catch annotation and discard them. We need two \032 and discard
141 until a \n is seen. */
146 else if (tui_skip_line
!= 1)
149 /* Expand TABs, since ncurses on MS-Windows doesn't. */
160 while ((col
% 8) != 0);
169 /* Update the cached value of the command window's start line based on
170 the window's current Y coordinate. */
173 update_cmdwin_start_line ()
175 TUI_CMD_WIN
->detail
.command_info
.start_line
176 = getcury (TUI_CMD_WIN
->generic
.handle
);
179 /* Print a character in the curses command window. The output is
180 buffered. It is up to the caller to refresh the screen if
186 WINDOW
*w
= TUI_CMD_WIN
->generic
.handle
;
189 update_cmdwin_start_line ();
192 /* This maps colors to their corresponding color index. */
194 static std::map
<ui_file_style::color
, int> color_map
;
196 /* This holds a pair of colors and is used to track the mapping
197 between a color pair index and the actual colors. */
204 bool operator< (const color_pair
&o
) const
206 return fg
< o
.fg
|| (fg
== o
.fg
&& bg
< o
.bg
);
210 /* This maps pairs of colors to their corresponding color pair
213 static std::map
<color_pair
, int> color_pair_map
;
215 /* This is indexed by ANSI color offset from the base color, and holds
216 the corresponding curses color constant. */
218 static const int curses_colors
[] = {
229 /* Given a color, find its index. */
232 get_color (const ui_file_style::color
&color
, int *result
)
234 if (color
.is_none ())
236 else if (color
.is_basic ())
237 *result
= curses_colors
[color
.get_value ()];
240 auto it
= color_map
.find (color
);
241 if (it
== color_map
.end ())
243 /* The first 8 colors are standard. */
244 int next
= color_map
.size () + 8;
249 /* We store RGB as 0..255, but curses wants 0..1000. */
250 if (init_color (next
, rgb
[0] * 1000 / 255, rgb
[1] * 1000 / 255,
251 rgb
[2] * 1000 / 255) == ERR
)
253 color_map
[color
] = next
;
257 *result
= it
->second
;
262 /* The most recently emitted color pair. */
264 static int last_color_pair
= -1;
266 /* The most recently applied style. */
268 static ui_file_style last_style
;
270 /* Given two colors, return their color pair index; making a new one
274 get_color_pair (int fg
, int bg
)
276 color_pair c
= { fg
, bg
};
277 auto it
= color_pair_map
.find (c
);
278 if (it
== color_pair_map
.end ())
280 /* Color pair 0 is our default color, so new colors start at
282 int next
= color_pair_map
.size () + 1;
283 /* Curses has a limited number of available color pairs. Fall
284 back to the default if we've used too many. */
285 if (next
>= COLOR_PAIRS
)
287 init_pair (next
, fg
, bg
);
288 color_pair_map
[c
] = next
;
294 /* Apply an ANSI escape sequence from BUF to W. BUF must start with
295 the ESC character. If BUF does not start with an ANSI escape,
296 return 0. Otherwise, apply the sequence if it is recognized, or
297 simply ignore it if not. In this case, the number of bytes read
298 from BUF is returned. */
301 apply_ansi_escape (WINDOW
*w
, const char *buf
)
303 ui_file_style style
= last_style
;
306 if (!style
.parse (buf
, &n_read
))
310 wattron (w
, A_NORMAL
);
311 wattroff (w
, A_BOLD
);
313 wattroff (w
, A_REVERSE
);
314 if (last_color_pair
!= -1)
315 wattroff (w
, COLOR_PAIR (last_color_pair
));
316 wattron (w
, COLOR_PAIR (0));
318 const ui_file_style::color
&fg
= style
.get_foreground ();
319 const ui_file_style::color
&bg
= style
.get_background ();
320 if (!fg
.is_none () || !bg
.is_none ())
323 if (get_color (fg
, &fgi
) && get_color (bg
, &bgi
))
325 int pair
= get_color_pair (fgi
, bgi
);
326 if (last_color_pair
!= -1)
327 wattroff (w
, COLOR_PAIR (last_color_pair
));
328 wattron (w
, COLOR_PAIR (pair
));
329 last_color_pair
= pair
;
333 switch (style
.get_intensity ())
335 case ui_file_style::NORMAL
:
338 case ui_file_style::BOLD
:
342 case ui_file_style::DIM
:
347 gdb_assert_not_reached ("invalid intensity");
350 if (style
.is_reverse ())
351 wattron (w
, A_REVERSE
);
357 /* Print LENGTH characters from the buffer pointed to by BUF to the
358 curses command window. The output is buffered. It is up to the
359 caller to refresh the screen if necessary. */
362 tui_write (const char *buf
, size_t length
)
364 /* We need this to be \0-terminated for the regexp matching. */
365 std::string
copy (buf
, length
);
366 tui_puts (copy
.c_str ());
370 tui_puts_internal (WINDOW
*w
, const char *string
, int *height
)
375 while ((c
= *string
++) != 0)
377 if (c
== '\1' || c
== '\2')
379 /* Ignore these, they are readline escape-marking
386 size_t bytes_read
= apply_ansi_escape (w
, string
- 1);
389 string
= string
+ bytes_read
- 1;
395 if (height
!= nullptr)
397 int col
= getcurx (w
);
404 update_cmdwin_start_line ();
407 /* Print a string in the curses command window. The output is
408 buffered. It is up to the caller to refresh the screen if
412 tui_puts (const char *string
, WINDOW
*w
)
415 w
= TUI_CMD_WIN
->generic
.handle
;
416 tui_puts_internal (w
, string
, nullptr);
419 /* Readline callback.
420 Redisplay the command line with its prompt after readline has
421 changed the edited text. */
423 tui_redisplay_readline (void)
435 /* Detect when we temporarily left SingleKey and now the readline
436 edit buffer is empty, automatically restore the SingleKey
437 mode. The restore must only be done if the command has finished.
438 The command could call prompt_for_continue and we must not
439 restore SingleKey so that the prompt and normal keymap are used. */
440 if (tui_current_key_mode
== TUI_ONE_COMMAND_MODE
&& rl_end
== 0
441 && !gdb_in_secondary_prompt_p (current_ui
))
442 tui_set_key_mode (TUI_SINGLE_KEY_MODE
);
444 if (tui_current_key_mode
== TUI_SINGLE_KEY_MODE
)
447 prompt
= tui_rl_saved_prompt
;
451 w
= TUI_CMD_WIN
->generic
.handle
;
452 start_line
= TUI_CMD_WIN
->detail
.command_info
.start_line
;
453 wmove (w
, start_line
, 0);
456 if (prompt
!= nullptr)
457 tui_puts_internal (TUI_CMD_WIN
->generic
.handle
, prompt
, &height
);
459 prev_col
= getcurx (w
);
460 for (in
= 0; in
<= rl_end
; in
++)
466 getyx (w
, c_line
, c_pos
);
472 c
= (unsigned char) rl_line_buffer
[in
];
473 if (CTRL_CHAR (c
) || c
== RUBOUT
)
476 waddch (w
, CTRL_CHAR (c
) ? UNCTRL (c
) : '?');
480 /* Expand TABs, since ncurses on MS-Windows doesn't. */
486 } while ((col
% 8) != 0);
493 TUI_CMD_WIN
->detail
.command_info
.start_line
= getcury (w
);
500 TUI_CMD_WIN
->detail
.command_info
.start_line
= getcury (w
);
502 wmove (w
, c_line
, c_pos
);
503 TUI_CMD_WIN
->detail
.command_info
.start_line
-= height
- 1;
509 /* Readline callback to prepare the terminal. It is called once each
510 time we enter readline. Terminal is already setup in curses
513 tui_prep_terminal (int notused1
)
515 /* Save the prompt registered in readline to correctly display it.
516 (we can't use gdb_prompt() due to secondary prompts and can't use
517 rl_prompt because it points to an alloca buffer). */
518 xfree (tui_rl_saved_prompt
);
519 tui_rl_saved_prompt
= rl_prompt
!= NULL
? xstrdup (rl_prompt
) : NULL
;
522 /* Readline callback to restore the terminal. It is called once each
523 time we leave readline. There is nothing to do in curses mode. */
525 tui_deprep_terminal (void)
529 #ifdef TUI_USE_PIPE_FOR_READLINE
530 /* Read readline output pipe and feed the command window with it.
531 Should be removed when readline is clean. */
533 tui_readline_output (int error
, gdb_client_data data
)
538 size
= read (tui_readline_pipe
[0], buf
, sizeof (buf
) - 1);
539 if (size
> 0 && tui_active
)
547 /* TUI version of displayer.crlf. */
550 tui_mld_crlf (const struct match_list_displayer
*displayer
)
555 /* TUI version of displayer.putch. */
558 tui_mld_putch (const struct match_list_displayer
*displayer
, int ch
)
563 /* TUI version of displayer.puts. */
566 tui_mld_puts (const struct match_list_displayer
*displayer
, const char *s
)
571 /* TUI version of displayer.flush. */
574 tui_mld_flush (const struct match_list_displayer
*displayer
)
576 wrefresh (TUI_CMD_WIN
->generic
.handle
);
579 /* TUI version of displayer.erase_entire_line. */
582 tui_mld_erase_entire_line (const struct match_list_displayer
*displayer
)
584 WINDOW
*w
= TUI_CMD_WIN
->generic
.handle
;
585 int cur_y
= getcury (w
);
592 /* TUI version of displayer.beep. */
595 tui_mld_beep (const struct match_list_displayer
*displayer
)
600 /* A wrapper for wgetch that enters nonl mode. We We normally want
601 curses' "nl" mode, but when reading from the user, we'd like to
602 differentiate between C-j and C-m, because some users bind these
603 keys differently in their .inputrc. So, put curses into nonl mode
604 just when reading from the user. See PR tui/20819. */
607 gdb_wgetch (WINDOW
*win
)
610 int r
= wgetch (win
);
615 /* Helper function for tui_mld_read_key.
616 This temporarily replaces tui_getc for use during tab-completion
617 match list display. */
620 tui_mld_getc (FILE *fp
)
622 WINDOW
*w
= TUI_CMD_WIN
->generic
.handle
;
623 int c
= gdb_wgetch (w
);
628 /* TUI version of displayer.read_key. */
631 tui_mld_read_key (const struct match_list_displayer
*displayer
)
633 rl_getc_func_t
*prev
= rl_getc_function
;
636 /* We can't use tui_getc as we need NEWLINE to not get emitted. */
637 rl_getc_function
= tui_mld_getc
;
639 rl_getc_function
= prev
;
643 /* TUI version of rl_completion_display_matches_hook.
644 See gdb_display_match_list for a description of the arguments. */
647 tui_rl_display_match_list (char **matches
, int len
, int max
)
649 struct match_list_displayer displayer
;
651 rl_get_screen_size (&displayer
.height
, &displayer
.width
);
652 displayer
.crlf
= tui_mld_crlf
;
653 displayer
.putch
= tui_mld_putch
;
654 displayer
.puts
= tui_mld_puts
;
655 displayer
.flush
= tui_mld_flush
;
656 displayer
.erase_entire_line
= tui_mld_erase_entire_line
;
657 displayer
.beep
= tui_mld_beep
;
658 displayer
.read_key
= tui_mld_read_key
;
660 gdb_display_match_list (matches
, len
, max
, &displayer
);
663 /* Setup the IO for curses or non-curses mode.
664 - In non-curses mode, readline and gdb use the standard input and
665 standard output/error directly.
666 - In curses mode, the standard output/error is controlled by TUI
667 with the tui_stdout and tui_stderr. The output is redirected in
668 the curses command window. Several readline callbacks are installed
669 so that readline asks for its input to the curses command window
672 tui_setup_io (int mode
)
674 extern int _rl_echoing_p
;
678 /* Redirect readline to TUI. */
679 tui_old_rl_redisplay_function
= rl_redisplay_function
;
680 tui_old_rl_deprep_terminal
= rl_deprep_term_function
;
681 tui_old_rl_prep_terminal
= rl_prep_term_function
;
682 tui_old_rl_getc_function
= rl_getc_function
;
683 tui_old_rl_display_matches_hook
= rl_completion_display_matches_hook
;
684 tui_old_rl_outstream
= rl_outstream
;
685 tui_old_rl_echoing_p
= _rl_echoing_p
;
686 rl_redisplay_function
= tui_redisplay_readline
;
687 rl_deprep_term_function
= tui_deprep_terminal
;
688 rl_prep_term_function
= tui_prep_terminal
;
689 rl_getc_function
= tui_getc
;
691 rl_outstream
= tui_rl_outstream
;
693 rl_completion_display_matches_hook
= tui_rl_display_match_list
;
694 rl_already_prompted
= 0;
696 /* Keep track of previous gdb output. */
697 tui_old_stdout
= gdb_stdout
;
698 tui_old_stderr
= gdb_stderr
;
699 tui_old_uiout
= dynamic_cast<cli_ui_out
*> (current_uiout
);
700 gdb_assert (tui_old_uiout
!= nullptr);
702 /* Reconfigure gdb output. */
703 gdb_stdout
= tui_stdout
;
704 gdb_stderr
= tui_stderr
;
705 gdb_stdlog
= gdb_stdout
; /* for moment */
706 gdb_stdtarg
= gdb_stderr
; /* for moment */
707 gdb_stdtargerr
= gdb_stderr
; /* for moment */
708 current_uiout
= tui_out
;
710 /* Save tty for SIGCONT. */
715 /* Restore gdb output. */
716 gdb_stdout
= tui_old_stdout
;
717 gdb_stderr
= tui_old_stderr
;
718 gdb_stdlog
= gdb_stdout
; /* for moment */
719 gdb_stdtarg
= gdb_stderr
; /* for moment */
720 gdb_stdtargerr
= gdb_stderr
; /* for moment */
721 current_uiout
= tui_old_uiout
;
723 /* Restore readline. */
724 rl_redisplay_function
= tui_old_rl_redisplay_function
;
725 rl_deprep_term_function
= tui_old_rl_deprep_terminal
;
726 rl_prep_term_function
= tui_old_rl_prep_terminal
;
727 rl_getc_function
= tui_old_rl_getc_function
;
728 rl_completion_display_matches_hook
= tui_old_rl_display_matches_hook
;
729 rl_outstream
= tui_old_rl_outstream
;
730 _rl_echoing_p
= tui_old_rl_echoing_p
;
731 rl_already_prompted
= 0;
733 /* Save tty for SIGCONT. */
736 /* Clean up color information. */
737 last_color_pair
= -1;
738 last_style
= ui_file_style ();
740 color_pair_map
.clear ();
745 /* Catch SIGCONT to restore the terminal and refresh the screen. */
747 tui_cont_sig (int sig
)
751 /* Restore the terminal setting because another process (shell)
752 might have changed it. */
755 /* Force a refresh of the screen. */
756 tui_refresh_all_win ();
758 wrefresh (TUI_CMD_WIN
->generic
.handle
);
760 signal (sig
, tui_cont_sig
);
764 /* Initialize the IO for gdb in curses mode. */
766 tui_initialize_io (void)
769 signal (SIGCONT
, tui_cont_sig
);
772 /* Create tui output streams. */
773 tui_stdout
= new tui_file (stdout
);
774 tui_stderr
= new tui_file (stderr
);
775 tui_out
= tui_out_new (tui_stdout
);
777 /* Create the default UI. */
778 tui_old_uiout
= cli_out_new (gdb_stdout
);
780 #ifdef TUI_USE_PIPE_FOR_READLINE
781 /* Temporary solution for readline writing to stdout: redirect
782 readline output in a pipe, read that pipe and output the content
783 in the curses command window. */
784 if (gdb_pipe_cloexec (tui_readline_pipe
) != 0)
785 error (_("Cannot create pipe for readline"));
787 tui_rl_outstream
= fdopen (tui_readline_pipe
[1], "w");
788 if (tui_rl_outstream
== 0)
789 error (_("Cannot redirect readline output"));
791 setvbuf (tui_rl_outstream
, (char*) NULL
, _IOLBF
, 0);
794 (void) fcntl (tui_readline_pipe
[0], F_SETFL
, O_NONBLOCK
);
797 (void) fcntl (tui_readline_pipe
[0], F_SETFL
, O_NDELAY
);
800 add_file_handler (tui_readline_pipe
[0], tui_readline_output
, 0);
802 tui_rl_outstream
= stdout
;
806 /* Get a character from the command window. This is called from the
814 w
= TUI_CMD_WIN
->generic
.handle
;
816 #ifdef TUI_USE_PIPE_FOR_READLINE
817 /* Flush readline output. */
818 tui_readline_output (0, 0);
823 /* The \n must be echoed because it will not be printed by
827 /* When hitting return with an empty input, gdb executes the last
828 command. If we emit a newline, this fills up the command window
829 with empty lines with gdb prompt at beginning. Instead of that,
830 stay on the same line but provide a visual effect to show the
831 user we recognized the command. */
832 if (rl_end
== 0 && !gdb_in_secondary_prompt_p (current_ui
))
834 wmove (w
, getcury (w
), 0);
836 /* Clear the line. This will blink the gdb prompt since
837 it will be redrawn at the same line. */
844 /* Move cursor to the end of the command line before emitting the
845 newline. We need to do so because when ncurses outputs a newline
846 it truncates any text that appears past the end of the cursor. */
849 px
+= rl_end
- rl_point
;
850 py
+= px
/ TUI_CMD_WIN
->generic
.width
;
851 px
%= TUI_CMD_WIN
->generic
.width
;
857 /* Handle prev/next/up/down here. */
858 ch
= tui_dispatch_ctrl_char (ch
);
860 if (ch
== KEY_BACKSPACE
)
863 if (current_ui
->command_editing
&& key_is_start_sequence (ch
))
868 ch_pending
= gdb_wgetch (w
);
871 /* If we have pending input following a start sequence, call the stdin
872 event handler again because ncurses may have already read and stored
873 the input into its internal buffer, meaning that we won't get an stdin
874 event for it. If we don't compensate for this missed stdin event, key
875 sequences as Alt_F (^[f) will not behave promptly.
877 (We only compensates for the missed 2nd byte of a key sequence because
878 2-byte sequences are by far the most commonly used. ncurses may have
879 buffered a larger, 3+-byte key sequence though it remains to be seen
880 whether it is useful to compensate for all the bytes of such
882 if (ch_pending
!= ERR
)
884 ungetch (ch_pending
);
885 call_stdin_event_handler_again_p
= 1;
892 /* Utility function to expand TABs in a STRING into spaces. STRING
893 will be displayed starting at column COL, and is assumed to include
894 no newlines. The returned expanded string is malloc'ed. */
897 tui_expand_tabs (const char *string
, int col
)
903 /* 1. How many additional characters do we need? */
904 for (ncol
= col
, n_adjust
= 0, s
= string
; s
; )
906 s
= strpbrk (s
, "\t");
909 ncol
+= (s
- string
) + n_adjust
;
910 /* Adjustment for the next tab stop, minus one for the TAB
911 we replace with spaces. */
912 n_adjust
+= 8 - (ncol
% 8) - 1;
917 /* Allocate the copy. */
918 ret
= q
= (char *) xmalloc (strlen (string
) + n_adjust
+ 1);
920 /* 2. Copy the original string while replacing TABs with spaces. */
921 for (ncol
= col
, s
= string
; s
; )
923 const char *s1
= strpbrk (s
, "\t");
928 strncpy (q
, s
, s1
- s
);
935 } while ((ncol
% 8) != 0);