1 /* TUI support I/O functions.
3 Copyright (C) 1998-2013 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"
41 #include "gdb_curses.h"
43 /* This redefines CTRL if it is not already defined, so it must come
44 after terminal state releated include files like <term.h> and
46 #include "readline/readline.h"
49 key_is_start_sequence (int ch)
55 key_is_end_sequence (int ch)
61 key_is_backspace (int ch)
67 key_is_command_char (int ch)
69 return ((ch == KEY_NPAGE) || (ch == KEY_PPAGE)
70 || (ch == KEY_LEFT) || (ch == KEY_RIGHT)
71 || (ch == KEY_UP) || (ch == KEY_DOWN)
72 || (ch == KEY_SF) || (ch == KEY_SR)
74 || key_is_start_sequence (ch));
77 /* Use definition from readline 4.3. */
79 #define CTRL_CHAR(c) \
80 ((c) < control_character_threshold && (((c) & 0x80) == 0))
82 /* This file controls the IO interactions between gdb and curses.
83 When the TUI is enabled, gdb has two modes a curses and a standard
86 In curses mode, the gdb outputs are made in a curses command
87 window. For this, the gdb_stdout and gdb_stderr are redirected to
88 the specific ui_file implemented by TUI. The output is handled by
89 tui_puts(). The input is also controlled by curses with
90 tui_getc(). The readline library uses this function to get its
91 input. Several readline hooks are installed to redirect readline
92 output to the TUI (see also the note below).
94 In normal mode, the gdb outputs are restored to their origin, that
95 is as if TUI is not used. Readline also uses its original getc()
98 Note SCz/2001-07-21: the current readline is not clean in its
99 management of the output. Even if we install a redisplay handler,
100 it sometimes writes on a stdout file. It is important to redirect
101 every output produced by readline, otherwise the curses window will
102 be garbled. This is implemented with a pipe that TUI reads and
103 readline writes to. A gdb input handler is created so that reading
104 the pipe is handled automatically. This will probably not work on
105 non-Unix platforms. The best fix is to make readline clean enougth
106 so that is never write on stdout.
108 Note SCz/2002-09-01: we now use more readline hooks and it seems
109 that with them we don't need the pipe anymore (verified by creating
110 the pipe and closing its end so that write causes a SIGPIPE). The
111 old pipe code is still there and can be conditionally removed by
112 #undef TUI_USE_PIPE_FOR_READLINE. */
114 /* For gdb 5.3, prefer to continue the pipe hack as a backup wheel. */
116 #define TUI_USE_PIPE_FOR_READLINE
118 /* #undef TUI_USE_PIPE_FOR_READLINE */
120 /* TUI output files. */
121 static struct ui_file *tui_stdout;
122 static struct ui_file *tui_stderr;
123 struct ui_out *tui_out;
125 /* GDB output files in non-curses mode. */
126 static struct ui_file *tui_old_stdout;
127 static struct ui_file *tui_old_stderr;
128 struct ui_out *tui_old_uiout;
130 /* Readline previous hooks. */
131 static Function *tui_old_rl_getc_function;
132 static VFunction *tui_old_rl_redisplay_function;
133 static VFunction *tui_old_rl_prep_terminal;
134 static VFunction *tui_old_rl_deprep_terminal;
135 static int tui_old_rl_echoing_p;
137 /* Readline output stream.
138 Should be removed when readline is clean. */
139 static FILE *tui_rl_outstream;
140 static FILE *tui_old_rl_outstream;
141 #ifdef TUI_USE_PIPE_FOR_READLINE
142 static int tui_readline_pipe[2];
145 /* The last gdb prompt that was registered in readline.
146 This may be the main gdb prompt or a secondary prompt. */
147 static char *tui_rl_saved_prompt;
149 static unsigned int tui_handle_resize_during_io (unsigned int);
161 /* Print the string in the curses command window. */
163 tui_puts (const char *string)
165 static int tui_skip_line = -1;
169 w = TUI_CMD_WIN->generic.handle;
170 while ((c = *string++) != 0)
172 /* Catch annotation and discard them. We need two \032 and
173 discard until a \n is seen. */
178 else if (tui_skip_line != 1)
186 getyx (w, TUI_CMD_WIN->detail.command_info.cur_line,
187 TUI_CMD_WIN->detail.command_info.curch);
188 TUI_CMD_WIN->detail.command_info.start_line
189 = TUI_CMD_WIN->detail.command_info.cur_line;
191 /* We could defer the following. */
196 /* Readline callback.
197 Redisplay the command line with its prompt after readline has
198 changed the edited text. */
200 tui_redisplay_readline (void)
212 /* Detect when we temporarily left SingleKey and now the readline
213 edit buffer is empty, automatically restore the SingleKey
214 mode. The restore must only be done if the command has finished.
215 The command could call prompt_for_continue and we must not
216 restore SingleKey so that the prompt and normal keymap are used. */
217 if (tui_current_key_mode == TUI_ONE_COMMAND_MODE && rl_end == 0
218 && immediate_quit == 0)
219 tui_set_key_mode (TUI_SINGLE_KEY_MODE);
221 if (tui_current_key_mode == TUI_SINGLE_KEY_MODE)
224 prompt = tui_rl_saved_prompt;
228 w = TUI_CMD_WIN->generic.handle;
229 start_line = TUI_CMD_WIN->detail.command_info.start_line;
230 wmove (w, start_line, 0);
233 for (in = 0; prompt && prompt[in]; in++)
235 waddch (w, prompt[in]);
236 getyx (w, line, col);
241 for (in = 0; in < rl_end; in++)
245 c = (unsigned char) rl_line_buffer[in];
248 getyx (w, c_line, c_pos);
251 if (CTRL_CHAR (c) || c == RUBOUT)
254 waddch (w, CTRL_CHAR (c) ? UNCTRL (c) : '?');
262 getyx (w, TUI_CMD_WIN->detail.command_info.start_line,
263 TUI_CMD_WIN->detail.command_info.curch);
265 getyx (w, line, col);
271 getyx (w, TUI_CMD_WIN->detail.command_info.start_line,
272 TUI_CMD_WIN->detail.command_info.curch);
275 wmove (w, c_line, c_pos);
276 TUI_CMD_WIN->detail.command_info.cur_line = c_line;
277 TUI_CMD_WIN->detail.command_info.curch = c_pos;
279 TUI_CMD_WIN->detail.command_info.start_line -= height - 1;
285 /* Readline callback to prepare the terminal. It is called once each
286 time we enter readline. Terminal is already setup in curses
289 tui_prep_terminal (int notused1)
291 /* Save the prompt registered in readline to correctly display it.
292 (we can't use gdb_prompt() due to secondary prompts and can't use
293 rl_prompt because it points to an alloca buffer). */
294 xfree (tui_rl_saved_prompt);
295 tui_rl_saved_prompt = xstrdup (rl_prompt);
298 /* Readline callback to restore the terminal. It is called once each
299 time we leave readline. There is nothing to do in curses mode. */
301 tui_deprep_terminal (void)
305 #ifdef TUI_USE_PIPE_FOR_READLINE
306 /* Read readline output pipe and feed the command window with it.
307 Should be removed when readline is clean. */
309 tui_readline_output (int error, gdb_client_data data)
314 size = read (tui_readline_pipe[0], buf, sizeof (buf) - 1);
315 if (size > 0 && tui_active)
323 /* Return the portion of PATHNAME that should be output when listing
324 possible completions. If we are hacking filename completion, we
325 are only interested in the basename, the portion following the
326 final slash. Otherwise, we return what we were passed.
328 Comes from readline/complete.c. */
330 printable_part (const char *pathname)
332 return rl_filename_completion_desired ? lbasename (pathname) : pathname;
335 /* Output TO_PRINT to rl_outstream. If VISIBLE_STATS is defined and
336 we are using it, check for and output a single character for
337 `special' filenames. Return the number of characters we
345 tui_putc (UNCTRL (c)); \
348 else if (c == RUBOUT) \
361 print_filename (const char *to_print, const char *full_pathname)
366 for (s = to_print; *s; s++)
373 /* The user must press "y" or "n". Non-zero return means "y" pressed.
374 Comes from readline/complete.c. */
378 extern int _rl_abort_internal ();
384 if (c == 'y' || c == 'Y' || c == ' ')
386 if (c == 'n' || c == 'N' || c == RUBOUT)
389 _rl_abort_internal ();
394 /* A convenience function for displaying a list of strings in
395 columnar format on readline's output stream. MATCHES is the list
396 of strings, in argv format, LEN is the number of strings in MATCHES,
397 and MAX is the length of the longest string in MATCHES.
399 Comes from readline/complete.c and modified to write in
400 the TUI command window using tui_putc/tui_puts. */
402 tui_rl_display_match_list (char **matches, int len, int max)
404 typedef int QSFUNC (const void *, const void *);
405 extern int _rl_qsort_string_compare (const void *,
407 extern int _rl_print_completions_horizontally;
409 int count, limit, printed_len;
413 /* Screen dimension correspond to the TUI command window. */
414 int screenwidth = TUI_CMD_WIN->generic.width;
416 /* If there are many items, then ask the user if she really wants to
418 if (len >= rl_completion_query_items)
422 xsnprintf (msg, sizeof (msg),
423 "\nDisplay all %d possibilities? (y or n)", len);
425 if (get_y_or_n () == 0)
432 /* How many items of MAX length can we fit in the screen window? */
434 limit = screenwidth / max;
435 if (limit != 1 && (limit * max == screenwidth))
438 /* Avoid a possible floating exception. If max > screenwidth, limit
439 will be 0 and a divide-by-zero fault will result. */
443 /* How many iterations of the printing loop? */
444 count = (len + (limit - 1)) / limit;
446 /* Watch out for special case. If LEN is less than LIMIT, then
447 just do the inner printing loop.
448 0 < len <= limit implies count = 1. */
450 /* Sort the items if they are not already sorted. */
451 if (rl_ignore_completion_duplicates == 0)
452 qsort (matches + 1, len, sizeof (char *),
453 (QSFUNC *)_rl_qsort_string_compare);
457 if (_rl_print_completions_horizontally == 0)
459 /* Print the sorted items, up-and-down alphabetically, like ls. */
460 for (i = 1; i <= count; i++)
462 for (j = 0, l = i; j < limit; j++)
464 if (l > len || matches[l] == 0)
468 temp = printable_part (matches[l]);
469 printed_len = print_filename (temp, matches[l]);
472 for (k = 0; k < max - printed_len; k++)
482 /* Print the sorted items, across alphabetically, like ls -x. */
483 for (i = 1; matches[i]; i++)
485 temp = printable_part (matches[i]);
486 printed_len = print_filename (temp, matches[i]);
487 /* Have we reached the end of this line? */
490 if (i && (limit > 1) && (i % limit) == 0)
493 for (k = 0; k < max - printed_len; k++)
501 /* Setup the IO for curses or non-curses mode.
502 - In non-curses mode, readline and gdb use the standard input and
503 standard output/error directly.
504 - In curses mode, the standard output/error is controlled by TUI
505 with the tui_stdout and tui_stderr. The output is redirected in
506 the curses command window. Several readline callbacks are installed
507 so that readline asks for its input to the curses command window
510 tui_setup_io (int mode)
512 extern int _rl_echoing_p;
516 /* Redirect readline to TUI. */
517 tui_old_rl_redisplay_function = rl_redisplay_function;
518 tui_old_rl_deprep_terminal = rl_deprep_term_function;
519 tui_old_rl_prep_terminal = rl_prep_term_function;
520 tui_old_rl_getc_function = rl_getc_function;
521 tui_old_rl_outstream = rl_outstream;
522 tui_old_rl_echoing_p = _rl_echoing_p;
523 rl_redisplay_function = tui_redisplay_readline;
524 rl_deprep_term_function = tui_deprep_terminal;
525 rl_prep_term_function = tui_prep_terminal;
526 rl_getc_function = tui_getc;
528 rl_outstream = tui_rl_outstream;
530 rl_completion_display_matches_hook = tui_rl_display_match_list;
531 rl_already_prompted = 0;
533 /* Keep track of previous gdb output. */
534 tui_old_stdout = gdb_stdout;
535 tui_old_stderr = gdb_stderr;
536 tui_old_uiout = current_uiout;
538 /* Reconfigure gdb output. */
539 gdb_stdout = tui_stdout;
540 gdb_stderr = tui_stderr;
541 gdb_stdlog = gdb_stdout; /* for moment */
542 gdb_stdtarg = gdb_stderr; /* for moment */
543 gdb_stdtargerr = gdb_stderr; /* for moment */
544 current_uiout = tui_out;
546 /* Save tty for SIGCONT. */
551 /* Restore gdb output. */
552 gdb_stdout = tui_old_stdout;
553 gdb_stderr = tui_old_stderr;
554 gdb_stdlog = gdb_stdout; /* for moment */
555 gdb_stdtarg = gdb_stderr; /* for moment */
556 gdb_stdtargerr = gdb_stderr; /* for moment */
557 current_uiout = tui_old_uiout;
559 /* Restore readline. */
560 rl_redisplay_function = tui_old_rl_redisplay_function;
561 rl_deprep_term_function = tui_old_rl_deprep_terminal;
562 rl_prep_term_function = tui_old_rl_prep_terminal;
563 rl_getc_function = tui_old_rl_getc_function;
564 rl_outstream = tui_old_rl_outstream;
565 rl_completion_display_matches_hook = 0;
566 _rl_echoing_p = tui_old_rl_echoing_p;
567 rl_already_prompted = 0;
569 /* Save tty for SIGCONT. */
575 /* Catch SIGCONT to restore the terminal and refresh the screen. */
577 tui_cont_sig (int sig)
581 /* Restore the terminal setting because another process (shell)
582 might have changed it. */
585 /* Force a refresh of the screen. */
586 tui_refresh_all_win ();
588 /* Update cursor position on the screen. */
589 wmove (TUI_CMD_WIN->generic.handle,
590 TUI_CMD_WIN->detail.command_info.start_line,
591 TUI_CMD_WIN->detail.command_info.curch);
592 wrefresh (TUI_CMD_WIN->generic.handle);
594 signal (sig, tui_cont_sig);
598 /* Initialize the IO for gdb in curses mode. */
600 tui_initialize_io (void)
603 signal (SIGCONT, tui_cont_sig);
606 /* Create tui output streams. */
607 tui_stdout = tui_fileopen (stdout);
608 tui_stderr = tui_fileopen (stderr);
609 tui_out = tui_out_new (tui_stdout);
611 /* Create the default UI. It is not created because we installed a
612 deprecated_init_ui_hook. */
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 (pipe (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);