1 /* TUI support I/O functions.
3 Copyright (C) 1998-2004, 2007-2012 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
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 (const char *pathname)
329 return rl_filename_completion_desired ? lbasename (pathname) : pathname;
332 /* Output TO_PRINT to rl_outstream. If VISIBLE_STATS is defined and
333 we are using it, check for and output a single character for
334 `special' filenames. Return the number of characters we
342 tui_putc (UNCTRL (c)); \
345 else if (c == RUBOUT) \
358 print_filename (const char *to_print, const char *full_pathname)
363 for (s = to_print; *s; s++)
370 /* The user must press "y" or "n". Non-zero return means "y" pressed.
371 Comes from readline/complete.c. */
375 extern int _rl_abort_internal ();
381 if (c == 'y' || c == 'Y' || c == ' ')
383 if (c == 'n' || c == 'N' || c == RUBOUT)
386 _rl_abort_internal ();
391 /* A convenience function for displaying a list of strings in
392 columnar format on readline's output stream. MATCHES is the list
393 of strings, in argv format, LEN is the number of strings in MATCHES,
394 and MAX is the length of the longest string in MATCHES.
396 Comes from readline/complete.c and modified to write in
397 the TUI command window using tui_putc/tui_puts. */
399 tui_rl_display_match_list (char **matches, int len, int max)
401 typedef int QSFUNC (const void *, const void *);
403 int count, limit, printed_len;
407 /* Screen dimension correspond to the TUI command window. */
408 int screenwidth = TUI_CMD_WIN->generic.width;
410 /* If there are many items, then ask the user if she really wants to
412 if (len >= rl_completion_query_items)
416 sprintf (msg, "\nDisplay all %d possibilities? (y or n)", len);
418 if (get_y_or_n () == 0)
425 /* How many items of MAX length can we fit in the screen window? */
427 limit = screenwidth / max;
428 if (limit != 1 && (limit * max == screenwidth))
431 /* Avoid a possible floating exception. If max > screenwidth, limit
432 will be 0 and a divide-by-zero fault will result. */
436 /* How many iterations of the printing loop? */
437 count = (len + (limit - 1)) / limit;
439 /* Watch out for special case. If LEN is less than LIMIT, then
440 just do the inner printing loop.
441 0 < len <= limit implies count = 1. */
443 /* Sort the items if they are not already sorted. */
444 if (rl_ignore_completion_duplicates == 0)
445 qsort (matches + 1, len, sizeof (char *),
446 (QSFUNC *)_rl_qsort_string_compare);
450 if (_rl_print_completions_horizontally == 0)
452 /* Print the sorted items, up-and-down alphabetically, like ls. */
453 for (i = 1; i <= count; i++)
455 for (j = 0, l = i; j < limit; j++)
457 if (l > len || matches[l] == 0)
461 temp = printable_part (matches[l]);
462 printed_len = print_filename (temp, matches[l]);
465 for (k = 0; k < max - printed_len; k++)
475 /* Print the sorted items, across alphabetically, like ls -x. */
476 for (i = 1; matches[i]; i++)
478 temp = printable_part (matches[i]);
479 printed_len = print_filename (temp, matches[i]);
480 /* Have we reached the end of this line? */
483 if (i && (limit > 1) && (i % limit) == 0)
486 for (k = 0; k < max - printed_len; k++)
494 /* Setup the IO for curses or non-curses mode.
495 - In non-curses mode, readline and gdb use the standard input and
496 standard output/error directly.
497 - In curses mode, the standard output/error is controlled by TUI
498 with the tui_stdout and tui_stderr. The output is redirected in
499 the curses command window. Several readline callbacks are installed
500 so that readline asks for its input to the curses command window
503 tui_setup_io (int mode)
505 extern int _rl_echoing_p;
509 /* Redirect readline to TUI. */
510 tui_old_rl_redisplay_function = rl_redisplay_function;
511 tui_old_rl_deprep_terminal = rl_deprep_term_function;
512 tui_old_rl_prep_terminal = rl_prep_term_function;
513 tui_old_rl_getc_function = rl_getc_function;
514 tui_old_rl_outstream = rl_outstream;
515 tui_old_rl_echoing_p = _rl_echoing_p;
516 rl_redisplay_function = tui_redisplay_readline;
517 rl_deprep_term_function = tui_deprep_terminal;
518 rl_prep_term_function = tui_prep_terminal;
519 rl_getc_function = tui_getc;
521 rl_outstream = tui_rl_outstream;
523 rl_completion_display_matches_hook = tui_rl_display_match_list;
524 rl_already_prompted = 0;
526 /* Keep track of previous gdb output. */
527 tui_old_stdout = gdb_stdout;
528 tui_old_stderr = gdb_stderr;
529 tui_old_uiout = current_uiout;
531 /* Reconfigure gdb output. */
532 gdb_stdout = tui_stdout;
533 gdb_stderr = tui_stderr;
534 gdb_stdlog = gdb_stdout; /* for moment */
535 gdb_stdtarg = gdb_stderr; /* for moment */
536 gdb_stdtargerr = gdb_stderr; /* for moment */
537 current_uiout = tui_out;
539 /* Save tty for SIGCONT. */
544 /* Restore gdb output. */
545 gdb_stdout = tui_old_stdout;
546 gdb_stderr = tui_old_stderr;
547 gdb_stdlog = gdb_stdout; /* for moment */
548 gdb_stdtarg = gdb_stderr; /* for moment */
549 gdb_stdtargerr = gdb_stderr; /* for moment */
550 current_uiout = tui_old_uiout;
552 /* Restore readline. */
553 rl_redisplay_function = tui_old_rl_redisplay_function;
554 rl_deprep_term_function = tui_old_rl_deprep_terminal;
555 rl_prep_term_function = tui_old_rl_prep_terminal;
556 rl_getc_function = tui_old_rl_getc_function;
557 rl_outstream = tui_old_rl_outstream;
558 rl_completion_display_matches_hook = 0;
559 _rl_echoing_p = tui_old_rl_echoing_p;
560 rl_already_prompted = 0;
562 /* Save tty for SIGCONT. */
568 /* Catch SIGCONT to restore the terminal and refresh the screen. */
570 tui_cont_sig (int sig)
574 /* Restore the terminal setting because another process (shell)
575 might have changed it. */
578 /* Force a refresh of the screen. */
579 tui_refresh_all_win ();
581 /* Update cursor position on the screen. */
582 wmove (TUI_CMD_WIN->generic.handle,
583 TUI_CMD_WIN->detail.command_info.start_line,
584 TUI_CMD_WIN->detail.command_info.curch);
585 wrefresh (TUI_CMD_WIN->generic.handle);
587 signal (sig, tui_cont_sig);
591 /* Initialize the IO for gdb in curses mode. */
593 tui_initialize_io (void)
596 signal (SIGCONT, tui_cont_sig);
599 /* Create tui output streams. */
600 tui_stdout = tui_fileopen (stdout);
601 tui_stderr = tui_fileopen (stderr);
602 tui_out = tui_out_new (tui_stdout);
604 /* Create the default UI. It is not created because we installed a
605 deprecated_init_ui_hook. */
606 tui_old_uiout = cli_out_new (gdb_stdout);
608 #ifdef TUI_USE_PIPE_FOR_READLINE
609 /* Temporary solution for readline writing to stdout: redirect
610 readline output in a pipe, read that pipe and output the content
611 in the curses command window. */
612 if (pipe (tui_readline_pipe) != 0)
614 fprintf_unfiltered (gdb_stderr, "Cannot create pipe for readline");
617 tui_rl_outstream = fdopen (tui_readline_pipe[1], "w");
618 if (tui_rl_outstream == 0)
620 fprintf_unfiltered (gdb_stderr, "Cannot redirect readline output");
623 setvbuf (tui_rl_outstream, (char*) NULL, _IOLBF, 0);
626 (void) fcntl (tui_readline_pipe[0], F_SETFL, O_NONBLOCK);
629 (void) fcntl (tui_readline_pipe[0], F_SETFL, O_NDELAY);
632 add_file_handler (tui_readline_pipe[0], tui_readline_output, 0);
634 tui_rl_outstream = stdout;
638 /* Get a character from the command window. This is called from the
646 w = TUI_CMD_WIN->generic.handle;
648 #ifdef TUI_USE_PIPE_FOR_READLINE
649 /* Flush readline output. */
650 tui_readline_output (0, 0);
654 ch = tui_handle_resize_during_io (ch);
656 /* The \n must be echoed because it will not be printed by
660 /* When hitting return with an empty input, gdb executes the last
661 command. If we emit a newline, this fills up the command window
662 with empty lines with gdb prompt at beginning. Instead of that,
663 stay on the same line but provide a visual effect to show the
664 user we recognized the command. */
667 wmove (w, TUI_CMD_WIN->detail.command_info.cur_line, 0);
669 /* Clear the line. This will blink the gdb prompt since
670 it will be redrawn at the same line. */
677 wmove (w, TUI_CMD_WIN->detail.command_info.cur_line,
678 TUI_CMD_WIN->detail.command_info.curch);
683 if (key_is_command_char (ch))
684 { /* Handle prev/next/up/down here. */
685 ch = tui_dispatch_ctrl_char (ch);
688 if (ch == '\n' || ch == '\r' || ch == '\f')
689 TUI_CMD_WIN->detail.command_info.curch = 0;
690 if (ch == KEY_BACKSPACE)
697 /* Cleanup when a resize has occured.
698 Returns the character that must be processed. */
700 tui_handle_resize_during_io (unsigned int original_ch)
702 if (tui_win_resized ())
705 tui_refresh_all_win ();
707 tui_set_win_resized_to (FALSE);