1 /* TUI support I/O functions.
3 Copyright 1998, 1999, 2000, 2001, 2002 Free Software Foundation,
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 2 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, write to the Free Software
22 Foundation, Inc., 59 Temple Place - Suite 330,
23 Boston, MA 02111-1307, USA. */
25 /* FIXME: cagney/2002-02-28: The GDB coding standard indicates that
26 "defs.h" should be included first. Unfortunatly some systems
27 (currently Debian GNU/Linux) include the <stdbool.h> via <curses.h>
28 and they clash with "bfd.h"'s definiton of true/false. The correct
29 fix is to remove true/false from "bfd.h", however, until that
30 happens, hack around it by including "config.h" and <curses.h>
46 #include "event-loop.h"
47 #include "event-top.h"
50 #include "readline/readline.h"
54 #include "tuiCommand.h"
56 #include "tuiGeneralWin.h"
63 /* Use definition from readline 4.3. */
65 #define CTRL_CHAR(c) ((c) < control_character_threshold && (((c) & 0x80) == 0))
67 /* This file controls the IO interactions between gdb and curses.
68 When the TUI is enabled, gdb has two modes a curses and a standard
71 In curses mode, the gdb outputs are made in a curses command window.
72 For this, the gdb_stdout and gdb_stderr are redirected to the specific
73 ui_file implemented by TUI. The output is handled by tui_puts().
74 The input is also controlled by curses with tui_getc(). The readline
75 library uses this function to get its input. Several readline hooks
76 are installed to redirect readline output to the TUI (see also the
79 In normal mode, the gdb outputs are restored to their origin, that
80 is as if TUI is not used. Readline also uses its original getc()
83 Note SCz/2001-07-21: the current readline is not clean in its management of
84 the output. Even if we install a redisplay handler, it sometimes writes on
85 a stdout file. It is important to redirect every output produced by
86 readline, otherwise the curses window will be garbled. This is implemented
87 with a pipe that TUI reads and readline writes to. A gdb input handler
88 is created so that reading the pipe is handled automatically.
89 This will probably not work on non-Unix platforms. The best fix is
90 to make readline clean enougth so that is never write on stdout.
92 Note SCz/2002-09-01: we now use more readline hooks and it seems that
93 with them we don't need the pipe anymore (verified by creating the pipe
94 and closing its end so that write causes a SIGPIPE). The old pipe code
95 is still there and can be conditionally removed by
96 #undef TUI_USE_PIPE_FOR_READLINE. */
98 /* For gdb 5.3, prefer to continue the pipe hack as a backup wheel. */
99 #define TUI_USE_PIPE_FOR_READLINE
100 /*#undef TUI_USE_PIPE_FOR_READLINE*/
102 /* TUI output files. */
103 static struct ui_file
*tui_stdout
;
104 static struct ui_file
*tui_stderr
;
105 struct ui_out
*tui_out
;
107 /* GDB output files in non-curses mode. */
108 static struct ui_file
*tui_old_stdout
;
109 static struct ui_file
*tui_old_stderr
;
110 struct ui_out
*tui_old_uiout
;
112 /* Readline previous hooks. */
113 static Function
*tui_old_rl_getc_function
;
114 static VFunction
*tui_old_rl_redisplay_function
;
115 static VFunction
*tui_old_rl_prep_terminal
;
116 static VFunction
*tui_old_rl_deprep_terminal
;
117 static int tui_old_readline_echoing_p
;
119 /* Readline output stream.
120 Should be removed when readline is clean. */
121 static FILE *tui_rl_outstream
;
122 static FILE *tui_old_rl_outstream
;
123 #ifdef TUI_USE_PIPE_FOR_READLINE
124 static int tui_readline_pipe
[2];
127 /* The last gdb prompt that was registered in readline.
128 This may be the main gdb prompt or a secondary prompt. */
129 static char *tui_rl_saved_prompt
;
131 static unsigned int _tuiHandleResizeDuringIO (unsigned int);
143 /* Print the string in the curses command window. */
145 tui_puts (const char *string
)
147 static int tui_skip_line
= -1;
151 w
= cmdWin
->generic
.handle
;
152 while ((c
= *string
++) != 0)
154 /* Catch annotation and discard them. We need two \032 and
155 discard until a \n is seen. */
160 else if (tui_skip_line
!= 1)
168 getyx (w
, cmdWin
->detail
.commandInfo
.curLine
,
169 cmdWin
->detail
.commandInfo
.curch
);
170 cmdWin
->detail
.commandInfo
.start_line
= cmdWin
->detail
.commandInfo
.curLine
;
172 /* We could defer the following. */
177 /* Readline callback.
178 Redisplay the command line with its prompt after readline has
179 changed the edited text. */
181 tui_redisplay_readline (void)
193 /* Detect when we temporarily left SingleKey and now the readline
194 edit buffer is empty, automatically restore the SingleKey mode. */
195 if (tui_current_key_mode
== tui_one_command_mode
&& rl_end
== 0)
196 tui_set_key_mode (tui_single_key_mode
);
198 if (tui_current_key_mode
== tui_single_key_mode
)
201 prompt
= tui_rl_saved_prompt
;
205 w
= cmdWin
->generic
.handle
;
206 start_line
= cmdWin
->detail
.commandInfo
.start_line
;
207 wmove (w
, start_line
, 0);
210 for (in
= 0; prompt
&& prompt
[in
]; in
++)
212 waddch (w
, prompt
[in
]);
213 getyx (w
, line
, col
);
218 for (in
= 0; in
< rl_end
; in
++)
222 c
= (unsigned char) rl_line_buffer
[in
];
225 getyx (w
, c_line
, c_pos
);
228 if (CTRL_CHAR (c
) || c
== RUBOUT
)
231 waddch (w
, CTRL_CHAR (c
) ? UNCTRL (c
) : '?');
239 getyx (w
, cmdWin
->detail
.commandInfo
.start_line
,
240 cmdWin
->detail
.commandInfo
.curch
);
242 getyx (w
, line
, col
);
248 getyx (w
, cmdWin
->detail
.commandInfo
.start_line
,
249 cmdWin
->detail
.commandInfo
.curch
);
252 wmove (w
, c_line
, c_pos
);
253 cmdWin
->detail
.commandInfo
.curLine
= c_line
;
254 cmdWin
->detail
.commandInfo
.curch
= c_pos
;
256 cmdWin
->detail
.commandInfo
.start_line
-= height
- 1;
262 /* Readline callback to prepare the terminal. It is called once
263 each time we enter readline. Terminal is already setup in curses mode. */
265 tui_prep_terminal (void)
267 /* Save the prompt registered in readline to correctly display it.
268 (we can't use gdb_prompt() due to secondary prompts and can't use
269 rl_prompt because it points to an alloca buffer). */
270 xfree (tui_rl_saved_prompt
);
271 tui_rl_saved_prompt
= xstrdup (rl_prompt
);
274 /* Readline callback to restore the terminal. It is called once
275 each time we leave readline. There is nothing to do in curses mode. */
277 tui_deprep_terminal (void)
281 #ifdef TUI_USE_PIPE_FOR_READLINE
282 /* Read readline output pipe and feed the command window with it.
283 Should be removed when readline is clean. */
285 tui_readline_output (int code
, gdb_client_data data
)
290 size
= read (tui_readline_pipe
[0], buf
, sizeof (buf
) - 1);
291 if (size
> 0 && tui_active
)
299 /* Return the portion of PATHNAME that should be output when listing
300 possible completions. If we are hacking filename completion, we
301 are only interested in the basename, the portion following the
302 final slash. Otherwise, we return what we were passed.
304 Comes from readline/complete.c */
306 printable_part (pathname
)
311 temp
= rl_filename_completion_desired
? strrchr (pathname
, '/') : (char *)NULL
;
312 #if defined (__MSDOS__)
313 if (rl_filename_completion_desired
&& temp
== 0 && isalpha (pathname
[0]) && pathname
[1] == ':')
316 return (temp
? ++temp
: pathname
);
319 /* Output TO_PRINT to rl_outstream. If VISIBLE_STATS is defined and we
320 are using it, check for and output a single character for `special'
321 filenames. Return the number of characters we output. */
328 tui_putc (UNCTRL (c)); \
331 else if (c == RUBOUT) \
344 print_filename (to_print
, full_pathname
)
345 char *to_print
, *full_pathname
;
350 for (s
= to_print
; *s
; s
++)
357 /* The user must press "y" or "n". Non-zero return means "y" pressed.
358 Comes from readline/complete.c */
362 extern int _rl_abort_internal ();
368 if (c
== 'y' || c
== 'Y' || c
== ' ')
370 if (c
== 'n' || c
== 'N' || c
== RUBOUT
)
373 _rl_abort_internal ();
378 /* A convenience function for displaying a list of strings in
379 columnar format on readline's output stream. MATCHES is the list
380 of strings, in argv format, LEN is the number of strings in MATCHES,
381 and MAX is the length of the longest string in MATCHES.
383 Comes from readline/complete.c and modified to write in
384 the TUI command window using tui_putc/tui_puts. */
386 tui_rl_display_match_list (matches
, len
, max
)
390 typedef int QSFUNC (const void *, const void *);
391 extern int _rl_qsort_string_compare (const void*, const void*);
392 extern int _rl_print_completions_horizontally
;
394 int count
, limit
, printed_len
;
398 /* Screen dimension correspond to the TUI command window. */
399 int screenwidth
= cmdWin
->generic
.width
;
401 /* If there are many items, then ask the user if she really wants to
403 if (len
>= rl_completion_query_items
)
407 sprintf (msg
, "\nDisplay all %d possibilities? (y or n)", len
);
409 if (get_y_or_n () == 0)
416 /* How many items of MAX length can we fit in the screen window? */
418 limit
= screenwidth
/ max
;
419 if (limit
!= 1 && (limit
* max
== screenwidth
))
422 /* Avoid a possible floating exception. If max > screenwidth,
423 limit will be 0 and a divide-by-zero fault will result. */
427 /* How many iterations of the printing loop? */
428 count
= (len
+ (limit
- 1)) / limit
;
430 /* Watch out for special case. If LEN is less than LIMIT, then
431 just do the inner printing loop.
432 0 < len <= limit implies count = 1. */
434 /* Sort the items if they are not already sorted. */
435 if (rl_ignore_completion_duplicates
== 0)
436 qsort (matches
+ 1, len
, sizeof (char *),
437 (QSFUNC
*)_rl_qsort_string_compare
);
441 if (_rl_print_completions_horizontally
== 0)
443 /* Print the sorted items, up-and-down alphabetically, like ls. */
444 for (i
= 1; i
<= count
; i
++)
446 for (j
= 0, l
= i
; j
< limit
; j
++)
448 if (l
> len
|| matches
[l
] == 0)
452 temp
= printable_part (matches
[l
]);
453 printed_len
= print_filename (temp
, matches
[l
]);
456 for (k
= 0; k
< max
- printed_len
; k
++)
466 /* Print the sorted items, across alphabetically, like ls -x. */
467 for (i
= 1; matches
[i
]; i
++)
469 temp
= printable_part (matches
[i
]);
470 printed_len
= print_filename (temp
, matches
[i
]);
471 /* Have we reached the end of this line? */
474 if (i
&& (limit
> 1) && (i
% limit
) == 0)
477 for (k
= 0; k
< max
- printed_len
; k
++)
485 /* Setup the IO for curses or non-curses mode.
486 - In non-curses mode, readline and gdb use the standard input and
487 standard output/error directly.
488 - In curses mode, the standard output/error is controlled by TUI
489 with the tui_stdout and tui_stderr. The output is redirected in
490 the curses command window. Several readline callbacks are installed
491 so that readline asks for its input to the curses command window
494 tui_setup_io (int mode
)
496 extern int readline_echoing_p
;
500 /* Redirect readline to TUI. */
501 tui_old_rl_redisplay_function
= rl_redisplay_function
;
502 tui_old_rl_deprep_terminal
= rl_deprep_term_function
;
503 tui_old_rl_prep_terminal
= rl_prep_term_function
;
504 tui_old_rl_getc_function
= rl_getc_function
;
505 tui_old_rl_outstream
= rl_outstream
;
506 tui_old_readline_echoing_p
= readline_echoing_p
;
507 rl_redisplay_function
= tui_redisplay_readline
;
508 rl_deprep_term_function
= tui_deprep_terminal
;
509 rl_prep_term_function
= tui_prep_terminal
;
510 rl_getc_function
= tui_getc
;
511 readline_echoing_p
= 0;
512 rl_outstream
= tui_rl_outstream
;
514 rl_completion_display_matches_hook
= tui_rl_display_match_list
;
515 rl_already_prompted
= 0;
517 /* Keep track of previous gdb output. */
518 tui_old_stdout
= gdb_stdout
;
519 tui_old_stderr
= gdb_stderr
;
520 tui_old_uiout
= uiout
;
522 /* Reconfigure gdb output. */
523 gdb_stdout
= tui_stdout
;
524 gdb_stderr
= tui_stderr
;
525 gdb_stdlog
= gdb_stdout
; /* for moment */
526 gdb_stdtarg
= gdb_stderr
; /* for moment */
529 /* Save tty for SIGCONT. */
534 /* Restore gdb output. */
535 gdb_stdout
= tui_old_stdout
;
536 gdb_stderr
= tui_old_stderr
;
537 gdb_stdlog
= gdb_stdout
; /* for moment */
538 gdb_stdtarg
= gdb_stderr
; /* for moment */
539 uiout
= tui_old_uiout
;
541 /* Restore readline. */
542 rl_redisplay_function
= tui_old_rl_redisplay_function
;
543 rl_deprep_term_function
= tui_old_rl_deprep_terminal
;
544 rl_prep_term_function
= tui_old_rl_prep_terminal
;
545 rl_getc_function
= tui_old_rl_getc_function
;
546 rl_outstream
= tui_old_rl_outstream
;
547 rl_completion_display_matches_hook
= 0;
548 readline_echoing_p
= tui_old_readline_echoing_p
;
549 rl_already_prompted
= 0;
551 /* Save tty for SIGCONT. */
557 /* Catch SIGCONT to restore the terminal and refresh the screen. */
559 tui_cont_sig (int sig
)
563 /* Restore the terminal setting because another process (shell)
564 might have changed it. */
567 /* Force a refresh of the screen. */
570 /* Update cursor position on the screen. */
571 wmove (cmdWin
->generic
.handle
,
572 cmdWin
->detail
.commandInfo
.start_line
,
573 cmdWin
->detail
.commandInfo
.curch
);
574 wrefresh (cmdWin
->generic
.handle
);
576 signal (sig
, tui_cont_sig
);
580 /* Initialize the IO for gdb in curses mode. */
585 signal (SIGCONT
, tui_cont_sig
);
588 /* Create tui output streams. */
589 tui_stdout
= tui_fileopen (stdout
);
590 tui_stderr
= tui_fileopen (stderr
);
591 tui_out
= tui_out_new (tui_stdout
);
593 /* Create the default UI. It is not created because we installed
595 tui_old_uiout
= uiout
= cli_out_new (gdb_stdout
);
597 #ifdef TUI_USE_PIPE_FOR_READLINE
598 /* Temporary solution for readline writing to stdout:
599 redirect readline output in a pipe, read that pipe and
600 output the content in the curses command window. */
601 if (pipe (tui_readline_pipe
) != 0)
603 fprintf_unfiltered (gdb_stderr
, "Cannot create pipe for readline");
606 tui_rl_outstream
= fdopen (tui_readline_pipe
[1], "w");
607 if (tui_rl_outstream
== 0)
609 fprintf_unfiltered (gdb_stderr
, "Cannot redirect readline output");
612 setvbuf (tui_rl_outstream
, (char*) NULL
, _IOLBF
, 0);
615 (void) fcntl (tui_readline_pipe
[0], F_SETFL
, O_NONBLOCK
);
618 (void) fcntl (tui_readline_pipe
[0], F_SETFL
, O_NDELAY
);
621 add_file_handler (tui_readline_pipe
[0], tui_readline_output
, 0);
623 tui_rl_outstream
= stdout
;
627 /* Get a character from the command window. This is called from the readline
635 w
= cmdWin
->generic
.handle
;
637 #ifdef TUI_USE_PIPE_FOR_READLINE
638 /* Flush readline output. */
639 tui_readline_output (GDB_READABLE
, 0);
643 ch
= _tuiHandleResizeDuringIO (ch
);
645 /* The \n must be echoed because it will not be printed by readline. */
648 /* When hitting return with an empty input, gdb executes the last
649 command. If we emit a newline, this fills up the command window
650 with empty lines with gdb prompt at beginning. Instead of that,
651 stay on the same line but provide a visual effect to show the
652 user we recognized the command. */
655 wmove (w
, cmdWin
->detail
.commandInfo
.curLine
, 0);
657 /* Clear the line. This will blink the gdb prompt since
658 it will be redrawn at the same line. */
665 wmove (w
, cmdWin
->detail
.commandInfo
.curLine
,
666 cmdWin
->detail
.commandInfo
.curch
);
671 if (m_isCommandChar (ch
))
672 { /* Handle prev/next/up/down here */
673 ch
= tuiDispatchCtrlChar (ch
);
676 if (ch
== '\n' || ch
== '\r' || ch
== '\f')
677 cmdWin
->detail
.commandInfo
.curch
= 0;
680 tuiIncrCommandCharCountBy (1);
682 if (ch
== KEY_BACKSPACE
)
689 /* Cleanup when a resize has occured.
690 Returns the character that must be processed. */
692 _tuiHandleResizeDuringIO (unsigned int originalCh
)
694 if (tuiWinResized ())
698 tuiSetWinResizedTo (FALSE
);