1 /* TUI support I/O functions.
3 Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2007, 2008, 2009,
4 2010 Free Software Foundation, Inc.
6 Contributed by Hewlett-Packard Company.
8 This file is part of GDB.
10 This program is free software; you can redistribute it and/or modify
11 it under the terms of the GNU General Public License as published by
12 the Free Software Foundation; either version 3 of the License, or
13 (at your option) any later version.
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License for more details.
20 You should have received a copy of the GNU General Public License
21 along with this program. If not, see <http://www.gnu.org/licenses/>. */
25 #include "event-loop.h"
26 #include "event-top.h"
30 #include "tui/tui-data.h"
31 #include "tui/tui-io.h"
32 #include "tui/tui-command.h"
33 #include "tui/tui-win.h"
34 #include "tui/tui-wingeneral.h"
35 #include "tui/tui-file.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_readline_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 = 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
215 if (tui_current_key_mode == TUI_ONE_COMMAND_MODE && rl_end == 0)
216 tui_set_key_mode (TUI_SINGLE_KEY_MODE);
218 if (tui_current_key_mode == TUI_SINGLE_KEY_MODE)
221 prompt = tui_rl_saved_prompt;
225 w = TUI_CMD_WIN->generic.handle;
226 start_line = TUI_CMD_WIN->detail.command_info.start_line;
227 wmove (w, start_line, 0);
230 for (in = 0; prompt && prompt[in]; in++)
232 waddch (w, prompt[in]);
233 getyx (w, line, col);
238 for (in = 0; in < rl_end; in++)
242 c = (unsigned char) rl_line_buffer[in];
245 getyx (w, c_line, c_pos);
248 if (CTRL_CHAR (c) || c == RUBOUT)
251 waddch (w, CTRL_CHAR (c) ? UNCTRL (c) : '?');
259 getyx (w, TUI_CMD_WIN->detail.command_info.start_line,
260 TUI_CMD_WIN->detail.command_info.curch);
262 getyx (w, line, col);
268 getyx (w, TUI_CMD_WIN->detail.command_info.start_line,
269 TUI_CMD_WIN->detail.command_info.curch);
272 wmove (w, c_line, c_pos);
273 TUI_CMD_WIN->detail.command_info.cur_line = c_line;
274 TUI_CMD_WIN->detail.command_info.curch = c_pos;
276 TUI_CMD_WIN->detail.command_info.start_line -= height - 1;
282 /* Readline callback to prepare the terminal. It is called once each
283 time we enter readline. Terminal is already setup in curses
286 tui_prep_terminal (int notused1)
288 /* Save the prompt registered in readline to correctly display it.
289 (we can't use gdb_prompt() due to secondary prompts and can't use
290 rl_prompt because it points to an alloca buffer). */
291 xfree (tui_rl_saved_prompt);
292 tui_rl_saved_prompt = xstrdup (rl_prompt);
295 /* Readline callback to restore the terminal. It is called once each
296 time we leave readline. There is nothing to do in curses mode. */
298 tui_deprep_terminal (void)
302 #ifdef TUI_USE_PIPE_FOR_READLINE
303 /* Read readline output pipe and feed the command window with it.
304 Should be removed when readline is clean. */
306 tui_readline_output (int error, gdb_client_data data)
311 size = read (tui_readline_pipe[0], buf, sizeof (buf) - 1);
312 if (size > 0 && tui_active)
320 /* Return the portion of PATHNAME that should be output when listing
321 possible completions. If we are hacking filename completion, we
322 are only interested in the basename, the portion following the
323 final slash. Otherwise, we return what we were passed.
325 Comes from readline/complete.c. */
327 printable_part (char *pathname)
331 temp = rl_filename_completion_desired ? strrchr (pathname, '/') : (char *)NULL;
332 #if defined (__MSDOS__)
333 if (rl_filename_completion_desired
334 && temp == 0 && isalpha (pathname[0])
335 && pathname[1] == ':')
338 return (temp ? ++temp : pathname);
341 /* Output TO_PRINT to rl_outstream. If VISIBLE_STATS is defined and
342 we are using it, check for and output a single character for
343 `special' filenames. Return the number of characters we
351 tui_putc (UNCTRL (c)); \
354 else if (c == RUBOUT) \
367 print_filename (char *to_print, char *full_pathname)
372 for (s = to_print; *s; s++)
379 /* The user must press "y" or "n". Non-zero return means "y" pressed.
380 Comes from readline/complete.c. */
384 extern int _rl_abort_internal ();
390 if (c == 'y' || c == 'Y' || c == ' ')
392 if (c == 'n' || c == 'N' || c == RUBOUT)
395 _rl_abort_internal ();
400 /* A convenience function for displaying a list of strings in
401 columnar format on readline's output stream. MATCHES is the list
402 of strings, in argv format, LEN is the number of strings in MATCHES,
403 and MAX is the length of the longest string in MATCHES.
405 Comes from readline/complete.c and modified to write in
406 the TUI command window using tui_putc/tui_puts. */
408 tui_rl_display_match_list (char **matches, int len, int max)
410 typedef int QSFUNC (const void *, const void *);
411 extern int _rl_qsort_string_compare (const void *,
413 extern int _rl_print_completions_horizontally;
415 int count, limit, printed_len;
419 /* Screen dimension correspond to the TUI command window. */
420 int screenwidth = TUI_CMD_WIN->generic.width;
422 /* If there are many items, then ask the user if she really wants to
424 if (len >= rl_completion_query_items)
428 sprintf (msg, "\nDisplay all %d possibilities? (y or n)", len);
430 if (get_y_or_n () == 0)
437 /* How many items of MAX length can we fit in the screen window? */
439 limit = screenwidth / max;
440 if (limit != 1 && (limit * max == screenwidth))
443 /* Avoid a possible floating exception. If max > screenwidth, limit
444 will be 0 and a divide-by-zero fault will result. */
448 /* How many iterations of the printing loop? */
449 count = (len + (limit - 1)) / limit;
451 /* Watch out for special case. If LEN is less than LIMIT, then
452 just do the inner printing loop.
453 0 < len <= limit implies count = 1. */
455 /* Sort the items if they are not already sorted. */
456 if (rl_ignore_completion_duplicates == 0)
457 qsort (matches + 1, len, sizeof (char *),
458 (QSFUNC *)_rl_qsort_string_compare);
462 if (_rl_print_completions_horizontally == 0)
464 /* Print the sorted items, up-and-down alphabetically, like ls. */
465 for (i = 1; i <= count; i++)
467 for (j = 0, l = i; j < limit; j++)
469 if (l > len || matches[l] == 0)
473 temp = printable_part (matches[l]);
474 printed_len = print_filename (temp, matches[l]);
477 for (k = 0; k < max - printed_len; k++)
487 /* Print the sorted items, across alphabetically, like ls -x. */
488 for (i = 1; matches[i]; i++)
490 temp = printable_part (matches[i]);
491 printed_len = print_filename (temp, matches[i]);
492 /* Have we reached the end of this line? */
495 if (i && (limit > 1) && (i % limit) == 0)
498 for (k = 0; k < max - printed_len; k++)
506 /* Setup the IO for curses or non-curses mode.
507 - In non-curses mode, readline and gdb use the standard input and
508 standard output/error directly.
509 - In curses mode, the standard output/error is controlled by TUI
510 with the tui_stdout and tui_stderr. The output is redirected in
511 the curses command window. Several readline callbacks are installed
512 so that readline asks for its input to the curses command window
515 tui_setup_io (int mode)
517 extern int readline_echoing_p;
521 /* Redirect readline to TUI. */
522 tui_old_rl_redisplay_function = rl_redisplay_function;
523 tui_old_rl_deprep_terminal = rl_deprep_term_function;
524 tui_old_rl_prep_terminal = rl_prep_term_function;
525 tui_old_rl_getc_function = rl_getc_function;
526 tui_old_rl_outstream = rl_outstream;
527 tui_old_readline_echoing_p = readline_echoing_p;
528 rl_redisplay_function = tui_redisplay_readline;
529 rl_deprep_term_function = tui_deprep_terminal;
530 rl_prep_term_function = tui_prep_terminal;
531 rl_getc_function = tui_getc;
532 readline_echoing_p = 0;
533 rl_outstream = tui_rl_outstream;
535 rl_completion_display_matches_hook = tui_rl_display_match_list;
536 rl_already_prompted = 0;
538 /* Keep track of previous gdb output. */
539 tui_old_stdout = gdb_stdout;
540 tui_old_stderr = gdb_stderr;
541 tui_old_uiout = uiout;
543 /* Reconfigure gdb output. */
544 gdb_stdout = tui_stdout;
545 gdb_stderr = tui_stderr;
546 gdb_stdlog = gdb_stdout; /* for moment */
547 gdb_stdtarg = gdb_stderr; /* for moment */
548 gdb_stdtargerr = gdb_stderr; /* for moment */
551 /* Save tty for SIGCONT. */
556 /* Restore gdb output. */
557 gdb_stdout = tui_old_stdout;
558 gdb_stderr = tui_old_stderr;
559 gdb_stdlog = gdb_stdout; /* for moment */
560 gdb_stdtarg = gdb_stderr; /* for moment */
561 gdb_stdtargerr = gdb_stderr; /* for moment */
562 uiout = tui_old_uiout;
564 /* Restore readline. */
565 rl_redisplay_function = tui_old_rl_redisplay_function;
566 rl_deprep_term_function = tui_old_rl_deprep_terminal;
567 rl_prep_term_function = tui_old_rl_prep_terminal;
568 rl_getc_function = tui_old_rl_getc_function;
569 rl_outstream = tui_old_rl_outstream;
570 rl_completion_display_matches_hook = 0;
571 readline_echoing_p = tui_old_readline_echoing_p;
572 rl_already_prompted = 0;
574 /* Save tty for SIGCONT. */
580 /* Catch SIGCONT to restore the terminal and refresh the screen. */
582 tui_cont_sig (int sig)
586 /* Restore the terminal setting because another process (shell)
587 might have changed it. */
590 /* Force a refresh of the screen. */
591 tui_refresh_all_win ();
593 /* Update cursor position on the screen. */
594 wmove (TUI_CMD_WIN->generic.handle,
595 TUI_CMD_WIN->detail.command_info.start_line,
596 TUI_CMD_WIN->detail.command_info.curch);
597 wrefresh (TUI_CMD_WIN->generic.handle);
599 signal (sig, tui_cont_sig);
603 /* Initialize the IO for gdb in curses mode. */
605 tui_initialize_io (void)
608 signal (SIGCONT, tui_cont_sig);
611 /* Create tui output streams. */
612 tui_stdout = tui_fileopen (stdout);
613 tui_stderr = tui_fileopen (stderr);
614 tui_out = tui_out_new (tui_stdout);
616 /* Create the default UI. It is not created because we installed a
617 deprecated_init_ui_hook. */
618 tui_old_uiout = uiout = cli_out_new (gdb_stdout);
620 #ifdef TUI_USE_PIPE_FOR_READLINE
621 /* Temporary solution for readline writing to stdout: redirect
622 readline output in a pipe, read that pipe and output the content
623 in the curses command window. */
624 if (pipe (tui_readline_pipe) != 0)
626 fprintf_unfiltered (gdb_stderr, "Cannot create pipe for readline");
629 tui_rl_outstream = fdopen (tui_readline_pipe[1], "w");
630 if (tui_rl_outstream == 0)
632 fprintf_unfiltered (gdb_stderr, "Cannot redirect readline output");
635 setvbuf (tui_rl_outstream, (char*) NULL, _IOLBF, 0);
638 (void) fcntl (tui_readline_pipe[0], F_SETFL, O_NONBLOCK);
641 (void) fcntl (tui_readline_pipe[0], F_SETFL, O_NDELAY);
644 add_file_handler (tui_readline_pipe[0], tui_readline_output, 0);
646 tui_rl_outstream = stdout;
650 /* Get a character from the command window. This is called from the
658 w = TUI_CMD_WIN->generic.handle;
660 #ifdef TUI_USE_PIPE_FOR_READLINE
661 /* Flush readline output. */
662 tui_readline_output (0, 0);
666 ch = tui_handle_resize_during_io (ch);
668 /* The \n must be echoed because it will not be printed by
672 /* When hitting return with an empty input, gdb executes the last
673 command. If we emit a newline, this fills up the command window
674 with empty lines with gdb prompt at beginning. Instead of that,
675 stay on the same line but provide a visual effect to show the
676 user we recognized the command. */
679 wmove (w, TUI_CMD_WIN->detail.command_info.cur_line, 0);
681 /* Clear the line. This will blink the gdb prompt since
682 it will be redrawn at the same line. */
689 wmove (w, TUI_CMD_WIN->detail.command_info.cur_line,
690 TUI_CMD_WIN->detail.command_info.curch);
695 if (key_is_command_char (ch))
696 { /* Handle prev/next/up/down here. */
697 ch = tui_dispatch_ctrl_char (ch);
700 if (ch == '\n' || ch == '\r' || ch == '\f')
701 TUI_CMD_WIN->detail.command_info.curch = 0;
702 if (ch == KEY_BACKSPACE)
709 /* Cleanup when a resize has occured.
710 Returns the character that must be processed. */
712 tui_handle_resize_during_io (unsigned int original_ch)
714 if (tui_win_resized ())
717 tui_refresh_all_win ();
719 tui_set_win_resized_to (FALSE);