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"
44 /* This redefines CTRL if it is not already defined, so it must come
45 after terminal state releated include files like <term.h> and
47 #include "readline/readline.h"
50 key_is_start_sequence (int ch
)
56 key_is_end_sequence (int ch
)
62 key_is_backspace (int ch
)
67 /* Use definition from readline 4.3. */
69 #define CTRL_CHAR(c) \
70 ((c) < control_character_threshold && (((c) & 0x80) == 0))
72 /* This file controls the IO interactions between gdb and curses.
73 When the TUI is enabled, gdb has two modes a curses and a standard
76 In curses mode, the gdb outputs are made in a curses command
77 window. For this, the gdb_stdout and gdb_stderr are redirected to
78 the specific ui_file implemented by TUI. The output is handled by
79 tui_puts(). The input is also controlled by curses with
80 tui_getc(). The readline library uses this function to get its
81 input. Several readline hooks are installed to redirect readline
82 output to the TUI (see also the note below).
84 In normal mode, the gdb outputs are restored to their origin, that
85 is as if TUI is not used. Readline also uses its original getc()
88 Note SCz/2001-07-21: the current readline is not clean in its
89 management of the output. Even if we install a redisplay handler,
90 it sometimes writes on a stdout file. It is important to redirect
91 every output produced by readline, otherwise the curses window will
92 be garbled. This is implemented with a pipe that TUI reads and
93 readline writes to. A gdb input handler is created so that reading
94 the pipe is handled automatically. This will probably not work on
95 non-Unix platforms. The best fix is to make readline clean enougth
96 so that is never write on stdout.
98 Note SCz/2002-09-01: we now use more readline hooks and it seems
99 that with them we don't need the pipe anymore (verified by creating
100 the pipe and closing its end so that write causes a SIGPIPE). The
101 old pipe code is still there and can be conditionally removed by
102 #undef TUI_USE_PIPE_FOR_READLINE. */
104 /* For gdb 5.3, prefer to continue the pipe hack as a backup wheel. */
106 #define TUI_USE_PIPE_FOR_READLINE
108 /* #undef TUI_USE_PIPE_FOR_READLINE */
110 /* TUI output files. */
111 static struct ui_file
*tui_stdout
;
112 static struct ui_file
*tui_stderr
;
113 struct ui_out
*tui_out
;
115 /* GDB output files in non-curses mode. */
116 static struct ui_file
*tui_old_stdout
;
117 static struct ui_file
*tui_old_stderr
;
118 cli_ui_out
*tui_old_uiout
;
120 /* Readline previous hooks. */
121 static rl_getc_func_t
*tui_old_rl_getc_function
;
122 static rl_voidfunc_t
*tui_old_rl_redisplay_function
;
123 static rl_vintfunc_t
*tui_old_rl_prep_terminal
;
124 static rl_voidfunc_t
*tui_old_rl_deprep_terminal
;
125 static rl_compdisp_func_t
*tui_old_rl_display_matches_hook
;
126 static int tui_old_rl_echoing_p
;
128 /* Readline output stream.
129 Should be removed when readline is clean. */
130 static FILE *tui_rl_outstream
;
131 static FILE *tui_old_rl_outstream
;
132 #ifdef TUI_USE_PIPE_FOR_READLINE
133 static int tui_readline_pipe
[2];
136 /* The last gdb prompt that was registered in readline.
137 This may be the main gdb prompt or a secondary prompt. */
138 static char *tui_rl_saved_prompt
;
140 /* Print a character in the curses command window. The output is
141 buffered. It is up to the caller to refresh the screen if
145 do_tui_putc (WINDOW
*w
, char c
)
147 static int tui_skip_line
= -1;
149 /* Catch annotation and discard them. We need two \032 and discard
150 until a \n is seen. */
155 else if (tui_skip_line
!= 1)
158 /* Expand TABs, since ncurses on MS-Windows doesn't. */
169 while ((col
% 8) != 0);
178 /* Update the cached value of the command window's start line based on
179 the window's current Y coordinate. */
182 update_cmdwin_start_line ()
184 TUI_CMD_WIN
->detail
.command_info
.start_line
185 = getcury (TUI_CMD_WIN
->generic
.handle
);
188 /* Print a character in the curses command window. The output is
189 buffered. It is up to the caller to refresh the screen if
195 WINDOW
*w
= TUI_CMD_WIN
->generic
.handle
;
198 update_cmdwin_start_line ();
201 /* Print LENGTH characters from the buffer pointed to by BUF to the
202 curses command window. The output is buffered. It is up to the
203 caller to refresh the screen if necessary. */
206 tui_write (const char *buf
, size_t length
)
208 WINDOW
*w
= TUI_CMD_WIN
->generic
.handle
;
210 for (size_t i
= 0; i
< length
; i
++)
211 do_tui_putc (w
, buf
[i
]);
212 update_cmdwin_start_line ();
215 /* Print a string in the curses command window. The output is
216 buffered. It is up to the caller to refresh the screen if
220 tui_puts (const char *string
)
222 WINDOW
*w
= TUI_CMD_WIN
->generic
.handle
;
225 while ((c
= *string
++) != 0)
227 update_cmdwin_start_line ();
230 /* Readline callback.
231 Redisplay the command line with its prompt after readline has
232 changed the edited text. */
234 tui_redisplay_readline (void)
246 /* Detect when we temporarily left SingleKey and now the readline
247 edit buffer is empty, automatically restore the SingleKey
248 mode. The restore must only be done if the command has finished.
249 The command could call prompt_for_continue and we must not
250 restore SingleKey so that the prompt and normal keymap are used. */
251 if (tui_current_key_mode
== TUI_ONE_COMMAND_MODE
&& rl_end
== 0
252 && !gdb_in_secondary_prompt_p (current_ui
))
253 tui_set_key_mode (TUI_SINGLE_KEY_MODE
);
255 if (tui_current_key_mode
== TUI_SINGLE_KEY_MODE
)
258 prompt
= tui_rl_saved_prompt
;
262 w
= TUI_CMD_WIN
->generic
.handle
;
263 start_line
= TUI_CMD_WIN
->detail
.command_info
.start_line
;
264 wmove (w
, start_line
, 0);
267 for (in
= 0; prompt
&& prompt
[in
]; in
++)
269 waddch (w
, prompt
[in
]);
275 for (in
= 0; in
<= rl_end
; in
++)
281 getyx (w
, c_line
, c_pos
);
287 c
= (unsigned char) rl_line_buffer
[in
];
288 if (CTRL_CHAR (c
) || c
== RUBOUT
)
291 waddch (w
, CTRL_CHAR (c
) ? UNCTRL (c
) : '?');
295 /* Expand TABs, since ncurses on MS-Windows doesn't. */
301 } while ((col
% 8) != 0);
308 TUI_CMD_WIN
->detail
.command_info
.start_line
= getcury (w
);
315 TUI_CMD_WIN
->detail
.command_info
.start_line
= getcury (w
);
317 wmove (w
, c_line
, c_pos
);
318 TUI_CMD_WIN
->detail
.command_info
.start_line
-= height
- 1;
324 /* Readline callback to prepare the terminal. It is called once each
325 time we enter readline. Terminal is already setup in curses
328 tui_prep_terminal (int notused1
)
330 /* Save the prompt registered in readline to correctly display it.
331 (we can't use gdb_prompt() due to secondary prompts and can't use
332 rl_prompt because it points to an alloca buffer). */
333 xfree (tui_rl_saved_prompt
);
334 tui_rl_saved_prompt
= rl_prompt
!= NULL
? xstrdup (rl_prompt
) : NULL
;
337 /* Readline callback to restore the terminal. It is called once each
338 time we leave readline. There is nothing to do in curses mode. */
340 tui_deprep_terminal (void)
344 #ifdef TUI_USE_PIPE_FOR_READLINE
345 /* Read readline output pipe and feed the command window with it.
346 Should be removed when readline is clean. */
348 tui_readline_output (int error
, gdb_client_data data
)
353 size
= read (tui_readline_pipe
[0], buf
, sizeof (buf
) - 1);
354 if (size
> 0 && tui_active
)
362 /* TUI version of displayer.crlf. */
365 tui_mld_crlf (const struct match_list_displayer
*displayer
)
370 /* TUI version of displayer.putch. */
373 tui_mld_putch (const struct match_list_displayer
*displayer
, int ch
)
378 /* TUI version of displayer.puts. */
381 tui_mld_puts (const struct match_list_displayer
*displayer
, const char *s
)
386 /* TUI version of displayer.flush. */
389 tui_mld_flush (const struct match_list_displayer
*displayer
)
391 wrefresh (TUI_CMD_WIN
->generic
.handle
);
394 /* TUI version of displayer.erase_entire_line. */
397 tui_mld_erase_entire_line (const struct match_list_displayer
*displayer
)
399 WINDOW
*w
= TUI_CMD_WIN
->generic
.handle
;
400 int cur_y
= getcury (w
);
407 /* TUI version of displayer.beep. */
410 tui_mld_beep (const struct match_list_displayer
*displayer
)
415 /* A wrapper for wgetch that enters nonl mode. We We normally want
416 curses' "nl" mode, but when reading from the user, we'd like to
417 differentiate between C-j and C-m, because some users bind these
418 keys differently in their .inputrc. So, put curses into nonl mode
419 just when reading from the user. See PR tui/20819. */
422 gdb_wgetch (WINDOW
*win
)
425 int r
= wgetch (win
);
430 /* Helper function for tui_mld_read_key.
431 This temporarily replaces tui_getc for use during tab-completion
432 match list display. */
435 tui_mld_getc (FILE *fp
)
437 WINDOW
*w
= TUI_CMD_WIN
->generic
.handle
;
438 int c
= gdb_wgetch (w
);
443 /* TUI version of displayer.read_key. */
446 tui_mld_read_key (const struct match_list_displayer
*displayer
)
448 rl_getc_func_t
*prev
= rl_getc_function
;
451 /* We can't use tui_getc as we need NEWLINE to not get emitted. */
452 rl_getc_function
= tui_mld_getc
;
454 rl_getc_function
= prev
;
458 /* TUI version of rl_completion_display_matches_hook.
459 See gdb_display_match_list for a description of the arguments. */
462 tui_rl_display_match_list (char **matches
, int len
, int max
)
464 struct match_list_displayer displayer
;
466 rl_get_screen_size (&displayer
.height
, &displayer
.width
);
467 displayer
.crlf
= tui_mld_crlf
;
468 displayer
.putch
= tui_mld_putch
;
469 displayer
.puts
= tui_mld_puts
;
470 displayer
.flush
= tui_mld_flush
;
471 displayer
.erase_entire_line
= tui_mld_erase_entire_line
;
472 displayer
.beep
= tui_mld_beep
;
473 displayer
.read_key
= tui_mld_read_key
;
475 gdb_display_match_list (matches
, len
, max
, &displayer
);
478 /* Setup the IO for curses or non-curses mode.
479 - In non-curses mode, readline and gdb use the standard input and
480 standard output/error directly.
481 - In curses mode, the standard output/error is controlled by TUI
482 with the tui_stdout and tui_stderr. The output is redirected in
483 the curses command window. Several readline callbacks are installed
484 so that readline asks for its input to the curses command window
487 tui_setup_io (int mode
)
489 extern int _rl_echoing_p
;
493 /* Redirect readline to TUI. */
494 tui_old_rl_redisplay_function
= rl_redisplay_function
;
495 tui_old_rl_deprep_terminal
= rl_deprep_term_function
;
496 tui_old_rl_prep_terminal
= rl_prep_term_function
;
497 tui_old_rl_getc_function
= rl_getc_function
;
498 tui_old_rl_display_matches_hook
= rl_completion_display_matches_hook
;
499 tui_old_rl_outstream
= rl_outstream
;
500 tui_old_rl_echoing_p
= _rl_echoing_p
;
501 rl_redisplay_function
= tui_redisplay_readline
;
502 rl_deprep_term_function
= tui_deprep_terminal
;
503 rl_prep_term_function
= tui_prep_terminal
;
504 rl_getc_function
= tui_getc
;
506 rl_outstream
= tui_rl_outstream
;
508 rl_completion_display_matches_hook
= tui_rl_display_match_list
;
509 rl_already_prompted
= 0;
511 /* Keep track of previous gdb output. */
512 tui_old_stdout
= gdb_stdout
;
513 tui_old_stderr
= gdb_stderr
;
514 tui_old_uiout
= dynamic_cast<cli_ui_out
*> (current_uiout
);
515 gdb_assert (tui_old_uiout
!= nullptr);
517 /* Reconfigure gdb output. */
518 gdb_stdout
= tui_stdout
;
519 gdb_stderr
= tui_stderr
;
520 gdb_stdlog
= gdb_stdout
; /* for moment */
521 gdb_stdtarg
= gdb_stderr
; /* for moment */
522 gdb_stdtargerr
= gdb_stderr
; /* for moment */
523 current_uiout
= tui_out
;
525 /* Save tty for SIGCONT. */
530 /* Restore gdb output. */
531 gdb_stdout
= tui_old_stdout
;
532 gdb_stderr
= tui_old_stderr
;
533 gdb_stdlog
= gdb_stdout
; /* for moment */
534 gdb_stdtarg
= gdb_stderr
; /* for moment */
535 gdb_stdtargerr
= gdb_stderr
; /* for moment */
536 current_uiout
= tui_old_uiout
;
538 /* Restore readline. */
539 rl_redisplay_function
= tui_old_rl_redisplay_function
;
540 rl_deprep_term_function
= tui_old_rl_deprep_terminal
;
541 rl_prep_term_function
= tui_old_rl_prep_terminal
;
542 rl_getc_function
= tui_old_rl_getc_function
;
543 rl_completion_display_matches_hook
= tui_old_rl_display_matches_hook
;
544 rl_outstream
= tui_old_rl_outstream
;
545 _rl_echoing_p
= tui_old_rl_echoing_p
;
546 rl_already_prompted
= 0;
548 /* Save tty for SIGCONT. */
554 /* Catch SIGCONT to restore the terminal and refresh the screen. */
556 tui_cont_sig (int sig
)
560 /* Restore the terminal setting because another process (shell)
561 might have changed it. */
564 /* Force a refresh of the screen. */
565 tui_refresh_all_win ();
567 wrefresh (TUI_CMD_WIN
->generic
.handle
);
569 signal (sig
, tui_cont_sig
);
573 /* Initialize the IO for gdb in curses mode. */
575 tui_initialize_io (void)
578 signal (SIGCONT
, tui_cont_sig
);
581 /* Create tui output streams. */
582 tui_stdout
= new tui_file (stdout
);
583 tui_stderr
= new tui_file (stderr
);
584 tui_out
= tui_out_new (tui_stdout
);
586 /* Create the default UI. */
587 tui_old_uiout
= cli_out_new (gdb_stdout
);
589 #ifdef TUI_USE_PIPE_FOR_READLINE
590 /* Temporary solution for readline writing to stdout: redirect
591 readline output in a pipe, read that pipe and output the content
592 in the curses command window. */
593 if (gdb_pipe_cloexec (tui_readline_pipe
) != 0)
594 error (_("Cannot create pipe for readline"));
596 tui_rl_outstream
= fdopen (tui_readline_pipe
[1], "w");
597 if (tui_rl_outstream
== 0)
598 error (_("Cannot redirect readline output"));
600 setvbuf (tui_rl_outstream
, (char*) NULL
, _IOLBF
, 0);
603 (void) fcntl (tui_readline_pipe
[0], F_SETFL
, O_NONBLOCK
);
606 (void) fcntl (tui_readline_pipe
[0], F_SETFL
, O_NDELAY
);
609 add_file_handler (tui_readline_pipe
[0], tui_readline_output
, 0);
611 tui_rl_outstream
= stdout
;
615 /* Get a character from the command window. This is called from the
623 w
= TUI_CMD_WIN
->generic
.handle
;
625 #ifdef TUI_USE_PIPE_FOR_READLINE
626 /* Flush readline output. */
627 tui_readline_output (0, 0);
632 /* The \n must be echoed because it will not be printed by
636 /* When hitting return with an empty input, gdb executes the last
637 command. If we emit a newline, this fills up the command window
638 with empty lines with gdb prompt at beginning. Instead of that,
639 stay on the same line but provide a visual effect to show the
640 user we recognized the command. */
641 if (rl_end
== 0 && !gdb_in_secondary_prompt_p (current_ui
))
643 wmove (w
, getcury (w
), 0);
645 /* Clear the line. This will blink the gdb prompt since
646 it will be redrawn at the same line. */
653 /* Move cursor to the end of the command line before emitting the
654 newline. We need to do so because when ncurses outputs a newline
655 it truncates any text that appears past the end of the cursor. */
658 px
+= rl_end
- rl_point
;
659 py
+= px
/ TUI_CMD_WIN
->generic
.width
;
660 px
%= TUI_CMD_WIN
->generic
.width
;
666 /* Handle prev/next/up/down here. */
667 ch
= tui_dispatch_ctrl_char (ch
);
669 if (ch
== KEY_BACKSPACE
)
672 if (current_ui
->command_editing
&& key_is_start_sequence (ch
))
677 ch_pending
= gdb_wgetch (w
);
680 /* If we have pending input following a start sequence, call the stdin
681 event handler again because ncurses may have already read and stored
682 the input into its internal buffer, meaning that we won't get an stdin
683 event for it. If we don't compensate for this missed stdin event, key
684 sequences as Alt_F (^[f) will not behave promptly.
686 (We only compensates for the missed 2nd byte of a key sequence because
687 2-byte sequences are by far the most commonly used. ncurses may have
688 buffered a larger, 3+-byte key sequence though it remains to be seen
689 whether it is useful to compensate for all the bytes of such
691 if (ch_pending
!= ERR
)
693 ungetch (ch_pending
);
694 call_stdin_event_handler_again_p
= 1;
701 /* Utility function to expand TABs in a STRING into spaces. STRING
702 will be displayed starting at column COL, and is assumed to include
703 no newlines. The returned expanded string is malloc'ed. */
706 tui_expand_tabs (const char *string
, int col
)
712 /* 1. How many additional characters do we need? */
713 for (ncol
= col
, n_adjust
= 0, s
= string
; s
; )
715 s
= strpbrk (s
, "\t");
718 ncol
+= (s
- string
) + n_adjust
;
719 /* Adjustment for the next tab stop, minus one for the TAB
720 we replace with spaces. */
721 n_adjust
+= 8 - (ncol
% 8) - 1;
726 /* Allocate the copy. */
727 ret
= q
= (char *) xmalloc (strlen (string
) + n_adjust
+ 1);
729 /* 2. Copy the original string while replacing TABs with spaces. */
730 for (ncol
= col
, s
= string
; s
; )
732 const char *s1
= strpbrk (s
, "\t");
737 strncpy (q
, s
, s1
- s
);
744 } while ((ncol
% 8) != 0);