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 static unsigned int _tuiHandleResizeDuringIO (unsigned int);
139 /* Print the string in the curses command window. */
141 tui_puts (const char *string
)
143 static int tui_skip_line
= -1;
147 w
= cmdWin
->generic
.handle
;
148 while ((c
= *string
++) != 0)
150 /* Catch annotation and discard them. We need two \032 and
151 discard until a \n is seen. */
156 else if (tui_skip_line
!= 1)
164 getyx (w
, cmdWin
->detail
.commandInfo
.curLine
,
165 cmdWin
->detail
.commandInfo
.curch
);
166 cmdWin
->detail
.commandInfo
.start_line
= cmdWin
->detail
.commandInfo
.curLine
;
168 /* We could defer the following. */
173 /* Readline callback.
174 Redisplay the command line with its prompt after readline has
175 changed the edited text. */
177 tui_redisplay_readline (void)
189 if (tui_current_key_mode
== tui_single_key_mode
)
192 prompt
= get_prompt ();
196 w
= cmdWin
->generic
.handle
;
197 start_line
= cmdWin
->detail
.commandInfo
.start_line
;
198 wmove (w
, start_line
, 0);
201 for (in
= 0; prompt
&& prompt
[in
]; in
++)
203 waddch (w
, prompt
[in
]);
204 getyx (w
, line
, col
);
209 for (in
= 0; in
< rl_end
; in
++)
213 c
= (unsigned char) rl_line_buffer
[in
];
216 getyx (w
, c_line
, c_pos
);
219 if (CTRL_CHAR (c
) || c
== RUBOUT
)
222 waddch (w
, CTRL_CHAR (c
) ? UNCTRL (c
) : '?');
230 getyx (w
, cmdWin
->detail
.commandInfo
.start_line
,
231 cmdWin
->detail
.commandInfo
.curch
);
233 getyx (w
, line
, col
);
239 getyx (w
, cmdWin
->detail
.commandInfo
.start_line
,
240 cmdWin
->detail
.commandInfo
.curch
);
243 wmove (w
, c_line
, c_pos
);
244 cmdWin
->detail
.commandInfo
.curLine
= c_line
;
245 cmdWin
->detail
.commandInfo
.curch
= c_pos
;
247 cmdWin
->detail
.commandInfo
.start_line
-= height
- 1;
253 /* Readline callback to prepare the terminal. It is called once
254 each time we enter readline. There is nothing to do in curses mode. */
256 tui_prep_terminal (void)
260 /* Readline callback to restore the terminal. It is called once
261 each time we leave readline. There is nothing to do in curses mode. */
263 tui_deprep_terminal (void)
267 #ifdef TUI_USE_PIPE_FOR_READLINE
268 /* Read readline output pipe and feed the command window with it.
269 Should be removed when readline is clean. */
271 tui_readline_output (int code
, gdb_client_data data
)
276 size
= read (tui_readline_pipe
[0], buf
, sizeof (buf
) - 1);
277 if (size
> 0 && tui_active
)
285 /* Return the portion of PATHNAME that should be output when listing
286 possible completions. If we are hacking filename completion, we
287 are only interested in the basename, the portion following the
288 final slash. Otherwise, we return what we were passed.
290 Comes from readline/complete.c */
292 printable_part (pathname
)
297 temp
= rl_filename_completion_desired
? strrchr (pathname
, '/') : (char *)NULL
;
298 #if defined (__MSDOS__)
299 if (rl_filename_completion_desired
&& temp
== 0 && isalpha (pathname
[0]) && pathname
[1] == ':')
302 return (temp
? ++temp
: pathname
);
305 /* Output TO_PRINT to rl_outstream. If VISIBLE_STATS is defined and we
306 are using it, check for and output a single character for `special'
307 filenames. Return the number of characters we output. */
314 tui_putc (UNCTRL (c)); \
317 else if (c == RUBOUT) \
330 print_filename (to_print
, full_pathname
)
331 char *to_print
, *full_pathname
;
336 for (s
= to_print
; *s
; s
++)
343 /* The user must press "y" or "n". Non-zero return means "y" pressed.
344 Comes from readline/complete.c */
348 extern int _rl_abort_internal ();
354 if (c
== 'y' || c
== 'Y' || c
== ' ')
356 if (c
== 'n' || c
== 'N' || c
== RUBOUT
)
359 _rl_abort_internal ();
364 /* A convenience function for displaying a list of strings in
365 columnar format on readline's output stream. MATCHES is the list
366 of strings, in argv format, LEN is the number of strings in MATCHES,
367 and MAX is the length of the longest string in MATCHES.
369 Comes from readline/complete.c and modified to write in
370 the TUI command window using tui_putc/tui_puts. */
372 tui_rl_display_match_list (matches
, len
, max
)
376 typedef int QSFUNC (const void *, const void *);
377 extern int _rl_qsort_string_compare (const void*, const void*);
378 extern int _rl_print_completions_horizontally
;
380 int count
, limit
, printed_len
;
384 /* Screen dimension correspond to the TUI command window. */
385 int screenwidth
= cmdWin
->generic
.width
;
387 /* If there are many items, then ask the user if she really wants to
389 if (len
>= rl_completion_query_items
)
393 sprintf (msg
, "\nDisplay all %d possibilities? (y or n)", len
);
395 if (get_y_or_n () == 0)
402 /* How many items of MAX length can we fit in the screen window? */
404 limit
= screenwidth
/ max
;
405 if (limit
!= 1 && (limit
* max
== screenwidth
))
408 /* Avoid a possible floating exception. If max > screenwidth,
409 limit will be 0 and a divide-by-zero fault will result. */
413 /* How many iterations of the printing loop? */
414 count
= (len
+ (limit
- 1)) / limit
;
416 /* Watch out for special case. If LEN is less than LIMIT, then
417 just do the inner printing loop.
418 0 < len <= limit implies count = 1. */
420 /* Sort the items if they are not already sorted. */
421 if (rl_ignore_completion_duplicates
== 0)
422 qsort (matches
+ 1, len
, sizeof (char *),
423 (QSFUNC
*)_rl_qsort_string_compare
);
427 if (_rl_print_completions_horizontally
== 0)
429 /* Print the sorted items, up-and-down alphabetically, like ls. */
430 for (i
= 1; i
<= count
; i
++)
432 for (j
= 0, l
= i
; j
< limit
; j
++)
434 if (l
> len
|| matches
[l
] == 0)
438 temp
= printable_part (matches
[l
]);
439 printed_len
= print_filename (temp
, matches
[l
]);
442 for (k
= 0; k
< max
- printed_len
; k
++)
452 /* Print the sorted items, across alphabetically, like ls -x. */
453 for (i
= 1; matches
[i
]; i
++)
455 temp
= printable_part (matches
[i
]);
456 printed_len
= print_filename (temp
, matches
[i
]);
457 /* Have we reached the end of this line? */
460 if (i
&& (limit
> 1) && (i
% limit
) == 0)
463 for (k
= 0; k
< max
- printed_len
; k
++)
471 /* Setup the IO for curses or non-curses mode.
472 - In non-curses mode, readline and gdb use the standard input and
473 standard output/error directly.
474 - In curses mode, the standard output/error is controlled by TUI
475 with the tui_stdout and tui_stderr. The output is redirected in
476 the curses command window. Several readline callbacks are installed
477 so that readline asks for its input to the curses command window
480 tui_setup_io (int mode
)
482 extern int readline_echoing_p
;
486 /* Redirect readline to TUI. */
487 tui_old_rl_redisplay_function
= rl_redisplay_function
;
488 tui_old_rl_deprep_terminal
= rl_deprep_term_function
;
489 tui_old_rl_prep_terminal
= rl_prep_term_function
;
490 tui_old_rl_getc_function
= rl_getc_function
;
491 tui_old_rl_outstream
= rl_outstream
;
492 tui_old_readline_echoing_p
= readline_echoing_p
;
493 rl_redisplay_function
= tui_redisplay_readline
;
494 rl_deprep_term_function
= tui_deprep_terminal
;
495 rl_prep_term_function
= tui_prep_terminal
;
496 rl_getc_function
= tui_getc
;
497 readline_echoing_p
= 0;
498 rl_outstream
= tui_rl_outstream
;
500 rl_completion_display_matches_hook
= tui_rl_display_match_list
;
501 rl_already_prompted
= 0;
503 /* Keep track of previous gdb output. */
504 tui_old_stdout
= gdb_stdout
;
505 tui_old_stderr
= gdb_stderr
;
506 tui_old_uiout
= uiout
;
508 /* Reconfigure gdb output. */
509 gdb_stdout
= tui_stdout
;
510 gdb_stderr
= tui_stderr
;
511 gdb_stdlog
= gdb_stdout
; /* for moment */
512 gdb_stdtarg
= gdb_stderr
; /* for moment */
515 /* Save tty for SIGCONT. */
520 /* Restore gdb output. */
521 gdb_stdout
= tui_old_stdout
;
522 gdb_stderr
= tui_old_stderr
;
523 gdb_stdlog
= gdb_stdout
; /* for moment */
524 gdb_stdtarg
= gdb_stderr
; /* for moment */
525 uiout
= tui_old_uiout
;
527 /* Restore readline. */
528 rl_redisplay_function
= tui_old_rl_redisplay_function
;
529 rl_deprep_term_function
= tui_old_rl_deprep_terminal
;
530 rl_prep_term_function
= tui_old_rl_prep_terminal
;
531 rl_getc_function
= tui_old_rl_getc_function
;
532 rl_outstream
= tui_old_rl_outstream
;
533 rl_completion_display_matches_hook
= 0;
534 readline_echoing_p
= tui_old_readline_echoing_p
;
535 rl_already_prompted
= 0;
537 /* Save tty for SIGCONT. */
543 /* Catch SIGCONT to restore the terminal and refresh the screen. */
545 tui_cont_sig (int sig
)
549 /* Restore the terminal setting because another process (shell)
550 might have changed it. */
553 /* Force a refresh of the screen. */
556 /* Update cursor position on the screen. */
557 wmove (cmdWin
->generic
.handle
,
558 cmdWin
->detail
.commandInfo
.start_line
,
559 cmdWin
->detail
.commandInfo
.curch
);
560 wrefresh (cmdWin
->generic
.handle
);
562 signal (sig
, tui_cont_sig
);
566 /* Initialize the IO for gdb in curses mode. */
571 signal (SIGCONT
, tui_cont_sig
);
574 /* Create tui output streams. */
575 tui_stdout
= tui_fileopen (stdout
);
576 tui_stderr
= tui_fileopen (stderr
);
577 tui_out
= tui_out_new (tui_stdout
);
579 /* Create the default UI. It is not created because we installed
581 tui_old_uiout
= uiout
= cli_out_new (gdb_stdout
);
583 #ifdef TUI_USE_PIPE_FOR_READLINE
584 /* Temporary solution for readline writing to stdout:
585 redirect readline output in a pipe, read that pipe and
586 output the content in the curses command window. */
587 if (pipe (tui_readline_pipe
) != 0)
589 fprintf_unfiltered (gdb_stderr
, "Cannot create pipe for readline");
592 tui_rl_outstream
= fdopen (tui_readline_pipe
[1], "w");
593 if (tui_rl_outstream
== 0)
595 fprintf_unfiltered (gdb_stderr
, "Cannot redirect readline output");
598 setlinebuf (tui_rl_outstream
);
601 (void) fcntl (tui_readline_pipe
[0], F_SETFL
, O_NONBLOCK
);
604 (void) fcntl (tui_readline_pipe
[0], F_SETFL
, O_NDELAY
);
607 add_file_handler (tui_readline_pipe
[0], tui_readline_output
, 0);
609 tui_rl_outstream
= stdout
;
613 /* Get a character from the command window. This is called from the readline
621 w
= cmdWin
->generic
.handle
;
623 #ifdef TUI_USE_PIPE_FOR_READLINE
624 /* Flush readline output. */
625 tui_readline_output (GDB_READABLE
, 0);
629 ch
= _tuiHandleResizeDuringIO (ch
);
631 /* The \n must be echoed because it will not be printed by readline. */
634 /* When hitting return with an empty input, gdb executes the last
635 command. If we emit a newline, this fills up the command window
636 with empty lines with gdb prompt at beginning. Instead of that,
637 stay on the same line but provide a visual effect to show the
638 user we recognized the command. */
641 wmove (w
, cmdWin
->detail
.commandInfo
.curLine
, 0);
643 /* Clear the line. This will blink the gdb prompt since
644 it will be redrawn at the same line. */
651 wmove (w
, cmdWin
->detail
.commandInfo
.curLine
,
652 cmdWin
->detail
.commandInfo
.curch
);
657 if (m_isCommandChar (ch
))
658 { /* Handle prev/next/up/down here */
659 ch
= tuiDispatchCtrlChar (ch
);
662 if (ch
== '\n' || ch
== '\r' || ch
== '\f')
663 cmdWin
->detail
.commandInfo
.curch
= 0;
666 tuiIncrCommandCharCountBy (1);
668 if (ch
== KEY_BACKSPACE
)
675 /* Cleanup when a resize has occured.
676 Returns the character that must be processed. */
678 _tuiHandleResizeDuringIO (unsigned int originalCh
)
680 if (tuiWinResized ())
684 tuiSetWinResizedTo (FALSE
);