1 /* TUI support I/O functions.
3 Copyright (C) 1998-2014 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"
40 #include "filestuff.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
)
68 key_is_command_char (int ch
)
70 return ((ch
== KEY_NPAGE
) || (ch
== KEY_PPAGE
)
71 || (ch
== KEY_LEFT
) || (ch
== KEY_RIGHT
)
72 || (ch
== KEY_UP
) || (ch
== KEY_DOWN
)
73 || (ch
== KEY_SF
) || (ch
== KEY_SR
)
75 || key_is_start_sequence (ch
));
78 /* Use definition from readline 4.3. */
80 #define CTRL_CHAR(c) \
81 ((c) < control_character_threshold && (((c) & 0x80) == 0))
83 /* This file controls the IO interactions between gdb and curses.
84 When the TUI is enabled, gdb has two modes a curses and a standard
87 In curses mode, the gdb outputs are made in a curses command
88 window. For this, the gdb_stdout and gdb_stderr are redirected to
89 the specific ui_file implemented by TUI. The output is handled by
90 tui_puts(). The input is also controlled by curses with
91 tui_getc(). The readline library uses this function to get its
92 input. Several readline hooks are installed to redirect readline
93 output to the TUI (see also the note below).
95 In normal mode, the gdb outputs are restored to their origin, that
96 is as if TUI is not used. Readline also uses its original getc()
99 Note SCz/2001-07-21: the current readline is not clean in its
100 management of the output. Even if we install a redisplay handler,
101 it sometimes writes on a stdout file. It is important to redirect
102 every output produced by readline, otherwise the curses window will
103 be garbled. This is implemented with a pipe that TUI reads and
104 readline writes to. A gdb input handler is created so that reading
105 the pipe is handled automatically. This will probably not work on
106 non-Unix platforms. The best fix is to make readline clean enougth
107 so that is never write on stdout.
109 Note SCz/2002-09-01: we now use more readline hooks and it seems
110 that with them we don't need the pipe anymore (verified by creating
111 the pipe and closing its end so that write causes a SIGPIPE). The
112 old pipe code is still there and can be conditionally removed by
113 #undef TUI_USE_PIPE_FOR_READLINE. */
115 /* For gdb 5.3, prefer to continue the pipe hack as a backup wheel. */
117 #define TUI_USE_PIPE_FOR_READLINE
119 /* #undef TUI_USE_PIPE_FOR_READLINE */
121 /* TUI output files. */
122 static struct ui_file
*tui_stdout
;
123 static struct ui_file
*tui_stderr
;
124 struct ui_out
*tui_out
;
126 /* GDB output files in non-curses mode. */
127 static struct ui_file
*tui_old_stdout
;
128 static struct ui_file
*tui_old_stderr
;
129 struct ui_out
*tui_old_uiout
;
131 /* Readline previous hooks. */
132 static Function
*tui_old_rl_getc_function
;
133 static VFunction
*tui_old_rl_redisplay_function
;
134 static VFunction
*tui_old_rl_prep_terminal
;
135 static VFunction
*tui_old_rl_deprep_terminal
;
136 static int tui_old_rl_echoing_p
;
138 /* Readline output stream.
139 Should be removed when readline is clean. */
140 static FILE *tui_rl_outstream
;
141 static FILE *tui_old_rl_outstream
;
142 #ifdef TUI_USE_PIPE_FOR_READLINE
143 static int tui_readline_pipe
[2];
146 /* The last gdb prompt that was registered in readline.
147 This may be the main gdb prompt or a secondary prompt. */
148 static char *tui_rl_saved_prompt
;
150 static unsigned int tui_handle_resize_during_io (unsigned int);
162 /* Print the string in the curses command window. */
164 tui_puts (const char *string
)
166 static int tui_skip_line
= -1;
170 w
= TUI_CMD_WIN
->generic
.handle
;
171 while ((c
= *string
++) != 0)
173 /* Catch annotation and discard them. We need two \032 and
174 discard until a \n is seen. */
179 else if (tui_skip_line
!= 1)
187 getyx (w
, TUI_CMD_WIN
->detail
.command_info
.cur_line
,
188 TUI_CMD_WIN
->detail
.command_info
.curch
);
189 TUI_CMD_WIN
->detail
.command_info
.start_line
190 = TUI_CMD_WIN
->detail
.command_info
.cur_line
;
192 /* We could defer the following. */
197 /* Readline callback.
198 Redisplay the command line with its prompt after readline has
199 changed the edited text. */
201 tui_redisplay_readline (void)
213 /* Detect when we temporarily left SingleKey and now the readline
214 edit buffer is empty, automatically restore the SingleKey
215 mode. The restore must only be done if the command has finished.
216 The command could call prompt_for_continue and we must not
217 restore SingleKey so that the prompt and normal keymap are used. */
218 if (tui_current_key_mode
== TUI_ONE_COMMAND_MODE
&& rl_end
== 0
219 && immediate_quit
== 0)
220 tui_set_key_mode (TUI_SINGLE_KEY_MODE
);
222 if (tui_current_key_mode
== TUI_SINGLE_KEY_MODE
)
225 prompt
= tui_rl_saved_prompt
;
229 w
= TUI_CMD_WIN
->generic
.handle
;
230 start_line
= TUI_CMD_WIN
->detail
.command_info
.start_line
;
231 wmove (w
, start_line
, 0);
234 for (in
= 0; prompt
&& prompt
[in
]; in
++)
236 waddch (w
, prompt
[in
]);
237 getyx (w
, line
, col
);
242 for (in
= 0; in
< rl_end
; in
++)
246 c
= (unsigned char) rl_line_buffer
[in
];
249 getyx (w
, c_line
, c_pos
);
252 if (CTRL_CHAR (c
) || c
== RUBOUT
)
255 waddch (w
, CTRL_CHAR (c
) ? UNCTRL (c
) : '?');
263 getyx (w
, TUI_CMD_WIN
->detail
.command_info
.start_line
,
264 TUI_CMD_WIN
->detail
.command_info
.curch
);
266 getyx (w
, line
, col
);
272 getyx (w
, TUI_CMD_WIN
->detail
.command_info
.start_line
,
273 TUI_CMD_WIN
->detail
.command_info
.curch
);
276 wmove (w
, c_line
, c_pos
);
277 TUI_CMD_WIN
->detail
.command_info
.cur_line
= c_line
;
278 TUI_CMD_WIN
->detail
.command_info
.curch
= c_pos
;
280 TUI_CMD_WIN
->detail
.command_info
.start_line
-= height
- 1;
286 /* Readline callback to prepare the terminal. It is called once each
287 time we enter readline. Terminal is already setup in curses
290 tui_prep_terminal (int notused1
)
292 /* Save the prompt registered in readline to correctly display it.
293 (we can't use gdb_prompt() due to secondary prompts and can't use
294 rl_prompt because it points to an alloca buffer). */
295 xfree (tui_rl_saved_prompt
);
296 tui_rl_saved_prompt
= xstrdup (rl_prompt
);
299 /* Readline callback to restore the terminal. It is called once each
300 time we leave readline. There is nothing to do in curses mode. */
302 tui_deprep_terminal (void)
306 #ifdef TUI_USE_PIPE_FOR_READLINE
307 /* Read readline output pipe and feed the command window with it.
308 Should be removed when readline is clean. */
310 tui_readline_output (int error
, gdb_client_data data
)
315 size
= read (tui_readline_pipe
[0], buf
, sizeof (buf
) - 1);
316 if (size
> 0 && tui_active
)
324 /* Return the portion of PATHNAME that should be output when listing
325 possible completions. If we are hacking filename completion, we
326 are only interested in the basename, the portion following the
327 final slash. Otherwise, we return what we were passed.
329 Comes from readline/complete.c. */
331 printable_part (const char *pathname
)
333 return rl_filename_completion_desired
? lbasename (pathname
) : pathname
;
336 /* Output TO_PRINT to rl_outstream. If VISIBLE_STATS is defined and
337 we are using it, check for and output a single character for
338 `special' filenames. Return the number of characters we
346 tui_putc (UNCTRL (c)); \
349 else if (c == RUBOUT) \
362 print_filename (const char *to_print
, const char *full_pathname
)
367 for (s
= to_print
; *s
; s
++)
374 /* The user must press "y" or "n". Non-zero return means "y" pressed.
375 Comes from readline/complete.c. */
379 extern int _rl_abort_internal ();
385 if (c
== 'y' || c
== 'Y' || c
== ' ')
387 if (c
== 'n' || c
== 'N' || c
== RUBOUT
)
390 _rl_abort_internal ();
395 /* A convenience function for displaying a list of strings in
396 columnar format on readline's output stream. MATCHES is the list
397 of strings, in argv format, LEN is the number of strings in MATCHES,
398 and MAX is the length of the longest string in MATCHES.
400 Comes from readline/complete.c and modified to write in
401 the TUI command window using tui_putc/tui_puts. */
403 tui_rl_display_match_list (char **matches
, int len
, int max
)
405 typedef int QSFUNC (const void *, const void *);
406 extern int _rl_qsort_string_compare (const void *,
408 extern int _rl_print_completions_horizontally
;
410 int count
, limit
, printed_len
;
414 /* Screen dimension correspond to the TUI command window. */
415 int screenwidth
= TUI_CMD_WIN
->generic
.width
;
417 /* If there are many items, then ask the user if she really wants to
419 if (len
>= rl_completion_query_items
)
423 xsnprintf (msg
, sizeof (msg
),
424 "\nDisplay all %d possibilities? (y or n)", len
);
426 if (get_y_or_n () == 0)
433 /* How many items of MAX length can we fit in the screen window? */
435 limit
= screenwidth
/ max
;
436 if (limit
!= 1 && (limit
* max
== screenwidth
))
439 /* Avoid a possible floating exception. If max > screenwidth, limit
440 will be 0 and a divide-by-zero fault will result. */
444 /* How many iterations of the printing loop? */
445 count
= (len
+ (limit
- 1)) / limit
;
447 /* Watch out for special case. If LEN is less than LIMIT, then
448 just do the inner printing loop.
449 0 < len <= limit implies count = 1. */
451 /* Sort the items if they are not already sorted. */
452 if (rl_ignore_completion_duplicates
== 0)
453 qsort (matches
+ 1, len
, sizeof (char *),
454 (QSFUNC
*)_rl_qsort_string_compare
);
458 if (_rl_print_completions_horizontally
== 0)
460 /* Print the sorted items, up-and-down alphabetically, like ls. */
461 for (i
= 1; i
<= count
; i
++)
463 for (j
= 0, l
= i
; j
< limit
; j
++)
465 if (l
> len
|| matches
[l
] == 0)
469 temp
= printable_part (matches
[l
]);
470 printed_len
= print_filename (temp
, matches
[l
]);
473 for (k
= 0; k
< max
- printed_len
; k
++)
483 /* Print the sorted items, across alphabetically, like ls -x. */
484 for (i
= 1; matches
[i
]; i
++)
486 temp
= printable_part (matches
[i
]);
487 printed_len
= print_filename (temp
, matches
[i
]);
488 /* Have we reached the end of this line? */
491 if (i
&& (limit
> 1) && (i
% limit
) == 0)
494 for (k
= 0; k
< max
- printed_len
; k
++)
502 /* Setup the IO for curses or non-curses mode.
503 - In non-curses mode, readline and gdb use the standard input and
504 standard output/error directly.
505 - In curses mode, the standard output/error is controlled by TUI
506 with the tui_stdout and tui_stderr. The output is redirected in
507 the curses command window. Several readline callbacks are installed
508 so that readline asks for its input to the curses command window
511 tui_setup_io (int mode
)
513 extern int _rl_echoing_p
;
517 /* Redirect readline to TUI. */
518 tui_old_rl_redisplay_function
= rl_redisplay_function
;
519 tui_old_rl_deprep_terminal
= rl_deprep_term_function
;
520 tui_old_rl_prep_terminal
= rl_prep_term_function
;
521 tui_old_rl_getc_function
= rl_getc_function
;
522 tui_old_rl_outstream
= rl_outstream
;
523 tui_old_rl_echoing_p
= _rl_echoing_p
;
524 rl_redisplay_function
= tui_redisplay_readline
;
525 rl_deprep_term_function
= tui_deprep_terminal
;
526 rl_prep_term_function
= tui_prep_terminal
;
527 rl_getc_function
= tui_getc
;
529 rl_outstream
= tui_rl_outstream
;
531 rl_completion_display_matches_hook
= tui_rl_display_match_list
;
532 rl_already_prompted
= 0;
534 /* Keep track of previous gdb output. */
535 tui_old_stdout
= gdb_stdout
;
536 tui_old_stderr
= gdb_stderr
;
537 tui_old_uiout
= current_uiout
;
539 /* Reconfigure gdb output. */
540 gdb_stdout
= tui_stdout
;
541 gdb_stderr
= tui_stderr
;
542 gdb_stdlog
= gdb_stdout
; /* for moment */
543 gdb_stdtarg
= gdb_stderr
; /* for moment */
544 gdb_stdtargerr
= gdb_stderr
; /* for moment */
545 current_uiout
= tui_out
;
547 /* Save tty for SIGCONT. */
552 /* Restore gdb output. */
553 gdb_stdout
= tui_old_stdout
;
554 gdb_stderr
= tui_old_stderr
;
555 gdb_stdlog
= gdb_stdout
; /* for moment */
556 gdb_stdtarg
= gdb_stderr
; /* for moment */
557 gdb_stdtargerr
= gdb_stderr
; /* for moment */
558 current_uiout
= tui_old_uiout
;
560 /* Restore readline. */
561 rl_redisplay_function
= tui_old_rl_redisplay_function
;
562 rl_deprep_term_function
= tui_old_rl_deprep_terminal
;
563 rl_prep_term_function
= tui_old_rl_prep_terminal
;
564 rl_getc_function
= tui_old_rl_getc_function
;
565 rl_outstream
= tui_old_rl_outstream
;
566 rl_completion_display_matches_hook
= 0;
567 _rl_echoing_p
= tui_old_rl_echoing_p
;
568 rl_already_prompted
= 0;
570 /* Save tty for SIGCONT. */
576 /* Catch SIGCONT to restore the terminal and refresh the screen. */
578 tui_cont_sig (int sig
)
582 /* Restore the terminal setting because another process (shell)
583 might have changed it. */
586 /* Force a refresh of the screen. */
587 tui_refresh_all_win ();
589 /* Update cursor position on the screen. */
590 wmove (TUI_CMD_WIN
->generic
.handle
,
591 TUI_CMD_WIN
->detail
.command_info
.start_line
,
592 TUI_CMD_WIN
->detail
.command_info
.curch
);
593 wrefresh (TUI_CMD_WIN
->generic
.handle
);
595 signal (sig
, tui_cont_sig
);
599 /* Initialize the IO for gdb in curses mode. */
601 tui_initialize_io (void)
604 signal (SIGCONT
, tui_cont_sig
);
607 /* Create tui output streams. */
608 tui_stdout
= tui_fileopen (stdout
);
609 tui_stderr
= tui_fileopen (stderr
);
610 tui_out
= tui_out_new (tui_stdout
);
612 /* Create the default UI. */
613 tui_old_uiout
= cli_out_new (gdb_stdout
);
615 #ifdef TUI_USE_PIPE_FOR_READLINE
616 /* Temporary solution for readline writing to stdout: redirect
617 readline output in a pipe, read that pipe and output the content
618 in the curses command window. */
619 if (gdb_pipe_cloexec (tui_readline_pipe
) != 0)
621 fprintf_unfiltered (gdb_stderr
, "Cannot create pipe for readline");
624 tui_rl_outstream
= fdopen (tui_readline_pipe
[1], "w");
625 if (tui_rl_outstream
== 0)
627 fprintf_unfiltered (gdb_stderr
, "Cannot redirect readline output");
630 setvbuf (tui_rl_outstream
, (char*) NULL
, _IOLBF
, 0);
633 (void) fcntl (tui_readline_pipe
[0], F_SETFL
, O_NONBLOCK
);
636 (void) fcntl (tui_readline_pipe
[0], F_SETFL
, O_NDELAY
);
639 add_file_handler (tui_readline_pipe
[0], tui_readline_output
, 0);
641 tui_rl_outstream
= stdout
;
645 /* Get a character from the command window. This is called from the
653 w
= TUI_CMD_WIN
->generic
.handle
;
655 #ifdef TUI_USE_PIPE_FOR_READLINE
656 /* Flush readline output. */
657 tui_readline_output (0, 0);
661 ch
= tui_handle_resize_during_io (ch
);
663 /* The \n must be echoed because it will not be printed by
667 /* When hitting return with an empty input, gdb executes the last
668 command. If we emit a newline, this fills up the command window
669 with empty lines with gdb prompt at beginning. Instead of that,
670 stay on the same line but provide a visual effect to show the
671 user we recognized the command. */
674 wmove (w
, TUI_CMD_WIN
->detail
.command_info
.cur_line
, 0);
676 /* Clear the line. This will blink the gdb prompt since
677 it will be redrawn at the same line. */
684 wmove (w
, TUI_CMD_WIN
->detail
.command_info
.cur_line
,
685 TUI_CMD_WIN
->detail
.command_info
.curch
);
690 if (key_is_command_char (ch
))
691 { /* Handle prev/next/up/down here. */
692 ch
= tui_dispatch_ctrl_char (ch
);
695 if (ch
== '\n' || ch
== '\r' || ch
== '\f')
696 TUI_CMD_WIN
->detail
.command_info
.curch
= 0;
697 if (ch
== KEY_BACKSPACE
)
704 /* Cleanup when a resize has occured.
705 Returns the character that must be processed. */
707 tui_handle_resize_during_io (unsigned int original_ch
)
709 if (tui_win_resized ())
712 tui_refresh_all_win ();
714 tui_set_win_resized_to (FALSE
);