1 /* TUI support I/O functions.
3 Copyright 1998, 1999, 2000, 2001, 2002, 2003, 2004 Free Software
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. */
28 #include "event-loop.h"
29 #include "event-top.h"
33 #include "tui/tui-data.h"
34 #include "tui/tui-io.h"
35 #include "tui/tui-command.h"
36 #include "tui/tui-win.h"
37 #include "tui/tui-wingeneral.h"
38 #include "tui/tui-file.h"
45 #include "gdb_curses.h"
47 /* This redefines CTRL if it is not already defined, so it must come
48 after terminal state releated include files like <term.h> and
50 #include "readline/readline.h"
53 key_is_start_sequence (int ch
)
59 key_is_end_sequence (int ch
)
65 key_is_backspace (int ch
)
71 key_is_command_char (int ch
)
73 return ((ch
== KEY_NPAGE
) || (ch
== KEY_PPAGE
)
74 || (ch
== KEY_LEFT
) || (ch
== KEY_RIGHT
)
75 || (ch
== KEY_UP
) || (ch
== KEY_DOWN
)
76 || (ch
== KEY_SF
) || (ch
== KEY_SR
)
77 || (ch
== (int)'\f') || key_is_start_sequence (ch
));
80 /* Use definition from readline 4.3. */
82 #define CTRL_CHAR(c) ((c) < control_character_threshold && (((c) & 0x80) == 0))
84 /* This file controls the IO interactions between gdb and curses.
85 When the TUI is enabled, gdb has two modes a curses and a standard
88 In curses mode, the gdb outputs are made in a curses command window.
89 For this, the gdb_stdout and gdb_stderr are redirected to the specific
90 ui_file implemented by TUI. The output is handled by tui_puts().
91 The input is also controlled by curses with tui_getc(). The readline
92 library uses this function to get its input. Several readline hooks
93 are installed to redirect readline output to the TUI (see also the
96 In normal mode, the gdb outputs are restored to their origin, that
97 is as if TUI is not used. Readline also uses its original getc()
100 Note SCz/2001-07-21: the current readline is not clean in its management of
101 the output. Even if we install a redisplay handler, it sometimes writes on
102 a stdout file. It is important to redirect every output produced by
103 readline, otherwise the curses window will be garbled. This is implemented
104 with a pipe that TUI reads and readline writes to. A gdb input handler
105 is created so that reading the pipe is handled automatically.
106 This will probably not work on non-Unix platforms. The best fix is
107 to make readline clean enougth so that is never write on stdout.
109 Note SCz/2002-09-01: we now use more readline hooks and it seems that
110 with them we don't need the pipe anymore (verified by creating the pipe
111 and closing its end so that write causes a SIGPIPE). The old pipe code
112 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. */
116 #define TUI_USE_PIPE_FOR_READLINE
117 /*#undef TUI_USE_PIPE_FOR_READLINE*/
119 /* TUI output files. */
120 static struct ui_file
*tui_stdout
;
121 static struct ui_file
*tui_stderr
;
122 struct ui_out
*tui_out
;
124 /* GDB output files in non-curses mode. */
125 static struct ui_file
*tui_old_stdout
;
126 static struct ui_file
*tui_old_stderr
;
127 struct ui_out
*tui_old_uiout
;
129 /* Readline previous hooks. */
130 static Function
*tui_old_rl_getc_function
;
131 static VFunction
*tui_old_rl_redisplay_function
;
132 static VFunction
*tui_old_rl_prep_terminal
;
133 static VFunction
*tui_old_rl_deprep_terminal
;
134 static int tui_old_readline_echoing_p
;
136 /* Readline output stream.
137 Should be removed when readline is clean. */
138 static FILE *tui_rl_outstream
;
139 static FILE *tui_old_rl_outstream
;
140 #ifdef TUI_USE_PIPE_FOR_READLINE
141 static int tui_readline_pipe
[2];
144 /* The last gdb prompt that was registered in readline.
145 This may be the main gdb prompt or a secondary prompt. */
146 static char *tui_rl_saved_prompt
;
148 static unsigned int tui_handle_resize_during_io (unsigned int);
160 /* Print the string in the curses command window. */
162 tui_puts (const char *string
)
164 static int tui_skip_line
= -1;
168 w
= TUI_CMD_WIN
->generic
.handle
;
169 while ((c
= *string
++) != 0)
171 /* Catch annotation and discard them. We need two \032 and
172 discard until a \n is seen. */
177 else if (tui_skip_line
!= 1)
185 getyx (w
, TUI_CMD_WIN
->detail
.command_info
.cur_line
,
186 TUI_CMD_WIN
->detail
.command_info
.curch
);
187 TUI_CMD_WIN
->detail
.command_info
.start_line
= TUI_CMD_WIN
->detail
.command_info
.cur_line
;
189 /* We could defer the following. */
194 /* Readline callback.
195 Redisplay the command line with its prompt after readline has
196 changed the edited text. */
198 tui_redisplay_readline (void)
210 /* Detect when we temporarily left SingleKey and now the readline
211 edit buffer is empty, automatically restore the SingleKey mode. */
212 if (tui_current_key_mode
== TUI_ONE_COMMAND_MODE
&& rl_end
== 0)
213 tui_set_key_mode (TUI_SINGLE_KEY_MODE
);
215 if (tui_current_key_mode
== TUI_SINGLE_KEY_MODE
)
218 prompt
= tui_rl_saved_prompt
;
222 w
= TUI_CMD_WIN
->generic
.handle
;
223 start_line
= TUI_CMD_WIN
->detail
.command_info
.start_line
;
224 wmove (w
, start_line
, 0);
227 for (in
= 0; prompt
&& prompt
[in
]; in
++)
229 waddch (w
, prompt
[in
]);
230 getyx (w
, line
, col
);
235 for (in
= 0; in
< rl_end
; in
++)
239 c
= (unsigned char) rl_line_buffer
[in
];
242 getyx (w
, c_line
, c_pos
);
245 if (CTRL_CHAR (c
) || c
== RUBOUT
)
248 waddch (w
, CTRL_CHAR (c
) ? UNCTRL (c
) : '?');
256 getyx (w
, TUI_CMD_WIN
->detail
.command_info
.start_line
,
257 TUI_CMD_WIN
->detail
.command_info
.curch
);
259 getyx (w
, line
, col
);
265 getyx (w
, TUI_CMD_WIN
->detail
.command_info
.start_line
,
266 TUI_CMD_WIN
->detail
.command_info
.curch
);
269 wmove (w
, c_line
, c_pos
);
270 TUI_CMD_WIN
->detail
.command_info
.cur_line
= c_line
;
271 TUI_CMD_WIN
->detail
.command_info
.curch
= c_pos
;
273 TUI_CMD_WIN
->detail
.command_info
.start_line
-= height
- 1;
279 /* Readline callback to prepare the terminal. It is called once
280 each time we enter readline. Terminal is already setup in curses mode. */
282 tui_prep_terminal (int notused1
)
284 /* Save the prompt registered in readline to correctly display it.
285 (we can't use gdb_prompt() due to secondary prompts and can't use
286 rl_prompt because it points to an alloca buffer). */
287 xfree (tui_rl_saved_prompt
);
288 tui_rl_saved_prompt
= xstrdup (rl_prompt
);
291 /* Readline callback to restore the terminal. It is called once
292 each time we leave readline. There is nothing to do in curses mode. */
294 tui_deprep_terminal (void)
298 #ifdef TUI_USE_PIPE_FOR_READLINE
299 /* Read readline output pipe and feed the command window with it.
300 Should be removed when readline is clean. */
302 tui_readline_output (int code
, gdb_client_data data
)
307 size
= read (tui_readline_pipe
[0], buf
, sizeof (buf
) - 1);
308 if (size
> 0 && tui_active
)
316 /* Return the portion of PATHNAME that should be output when listing
317 possible completions. If we are hacking filename completion, we
318 are only interested in the basename, the portion following the
319 final slash. Otherwise, we return what we were passed.
321 Comes from readline/complete.c */
323 printable_part (char *pathname
)
327 temp
= rl_filename_completion_desired
? strrchr (pathname
, '/') : (char *)NULL
;
328 #if defined (__MSDOS__)
329 if (rl_filename_completion_desired
&& temp
== 0 && isalpha (pathname
[0]) && pathname
[1] == ':')
332 return (temp
? ++temp
: pathname
);
335 /* Output TO_PRINT to rl_outstream. If VISIBLE_STATS is defined and we
336 are using it, check for and output a single character for `special'
337 filenames. Return the number of characters we output. */
344 tui_putc (UNCTRL (c)); \
347 else if (c == RUBOUT) \
360 print_filename (char *to_print
, char *full_pathname
)
365 for (s
= to_print
; *s
; s
++)
372 /* The user must press "y" or "n". Non-zero return means "y" pressed.
373 Comes from readline/complete.c */
377 extern int _rl_abort_internal ();
383 if (c
== 'y' || c
== 'Y' || c
== ' ')
385 if (c
== 'n' || c
== 'N' || c
== RUBOUT
)
388 _rl_abort_internal ();
393 /* A convenience function for displaying a list of strings in
394 columnar format on readline's output stream. MATCHES is the list
395 of strings, in argv format, LEN is the number of strings in MATCHES,
396 and MAX is the length of the longest string in MATCHES.
398 Comes from readline/complete.c and modified to write in
399 the TUI command window using tui_putc/tui_puts. */
401 tui_rl_display_match_list (char **matches
, int len
, int max
)
403 typedef int QSFUNC (const void *, const void *);
404 extern int _rl_qsort_string_compare (const void*, const void*);
405 extern int _rl_print_completions_horizontally
;
407 int count
, limit
, printed_len
;
411 /* Screen dimension correspond to the TUI command window. */
412 int screenwidth
= TUI_CMD_WIN
->generic
.width
;
414 /* If there are many items, then ask the user if she really wants to
416 if (len
>= rl_completion_query_items
)
420 sprintf (msg
, "\nDisplay all %d possibilities? (y or n)", len
);
422 if (get_y_or_n () == 0)
429 /* How many items of MAX length can we fit in the screen window? */
431 limit
= screenwidth
/ max
;
432 if (limit
!= 1 && (limit
* max
== screenwidth
))
435 /* Avoid a possible floating exception. If max > screenwidth,
436 limit will be 0 and a divide-by-zero fault will result. */
440 /* How many iterations of the printing loop? */
441 count
= (len
+ (limit
- 1)) / limit
;
443 /* Watch out for special case. If LEN is less than LIMIT, then
444 just do the inner printing loop.
445 0 < len <= limit implies count = 1. */
447 /* Sort the items if they are not already sorted. */
448 if (rl_ignore_completion_duplicates
== 0)
449 qsort (matches
+ 1, len
, sizeof (char *),
450 (QSFUNC
*)_rl_qsort_string_compare
);
454 if (_rl_print_completions_horizontally
== 0)
456 /* Print the sorted items, up-and-down alphabetically, like ls. */
457 for (i
= 1; i
<= count
; i
++)
459 for (j
= 0, l
= i
; j
< limit
; j
++)
461 if (l
> len
|| matches
[l
] == 0)
465 temp
= printable_part (matches
[l
]);
466 printed_len
= print_filename (temp
, matches
[l
]);
469 for (k
= 0; k
< max
- printed_len
; k
++)
479 /* Print the sorted items, across alphabetically, like ls -x. */
480 for (i
= 1; matches
[i
]; i
++)
482 temp
= printable_part (matches
[i
]);
483 printed_len
= print_filename (temp
, matches
[i
]);
484 /* Have we reached the end of this line? */
487 if (i
&& (limit
> 1) && (i
% limit
) == 0)
490 for (k
= 0; k
< max
- printed_len
; k
++)
498 /* Setup the IO for curses or non-curses mode.
499 - In non-curses mode, readline and gdb use the standard input and
500 standard output/error directly.
501 - In curses mode, the standard output/error is controlled by TUI
502 with the tui_stdout and tui_stderr. The output is redirected in
503 the curses command window. Several readline callbacks are installed
504 so that readline asks for its input to the curses command window
507 tui_setup_io (int mode
)
509 extern int readline_echoing_p
;
513 /* Redirect readline to TUI. */
514 tui_old_rl_redisplay_function
= rl_redisplay_function
;
515 tui_old_rl_deprep_terminal
= rl_deprep_term_function
;
516 tui_old_rl_prep_terminal
= rl_prep_term_function
;
517 tui_old_rl_getc_function
= rl_getc_function
;
518 tui_old_rl_outstream
= rl_outstream
;
519 tui_old_readline_echoing_p
= readline_echoing_p
;
520 rl_redisplay_function
= tui_redisplay_readline
;
521 rl_deprep_term_function
= tui_deprep_terminal
;
522 rl_prep_term_function
= tui_prep_terminal
;
523 rl_getc_function
= tui_getc
;
524 readline_echoing_p
= 0;
525 rl_outstream
= tui_rl_outstream
;
527 rl_completion_display_matches_hook
= tui_rl_display_match_list
;
528 rl_already_prompted
= 0;
530 /* Keep track of previous gdb output. */
531 tui_old_stdout
= gdb_stdout
;
532 tui_old_stderr
= gdb_stderr
;
533 tui_old_uiout
= uiout
;
535 /* Reconfigure gdb output. */
536 gdb_stdout
= tui_stdout
;
537 gdb_stderr
= tui_stderr
;
538 gdb_stdlog
= gdb_stdout
; /* for moment */
539 gdb_stdtarg
= gdb_stderr
; /* for moment */
542 /* Save tty for SIGCONT. */
547 /* Restore gdb output. */
548 gdb_stdout
= tui_old_stdout
;
549 gdb_stderr
= tui_old_stderr
;
550 gdb_stdlog
= gdb_stdout
; /* for moment */
551 gdb_stdtarg
= gdb_stderr
; /* for moment */
552 uiout
= tui_old_uiout
;
554 /* Restore readline. */
555 rl_redisplay_function
= tui_old_rl_redisplay_function
;
556 rl_deprep_term_function
= tui_old_rl_deprep_terminal
;
557 rl_prep_term_function
= tui_old_rl_prep_terminal
;
558 rl_getc_function
= tui_old_rl_getc_function
;
559 rl_outstream
= tui_old_rl_outstream
;
560 rl_completion_display_matches_hook
= 0;
561 readline_echoing_p
= tui_old_readline_echoing_p
;
562 rl_already_prompted
= 0;
564 /* Save tty for SIGCONT. */
570 /* Catch SIGCONT to restore the terminal and refresh the screen. */
572 tui_cont_sig (int sig
)
576 /* Restore the terminal setting because another process (shell)
577 might have changed it. */
580 /* Force a refresh of the screen. */
581 tui_refresh_all_win ();
583 /* Update cursor position on the screen. */
584 wmove (TUI_CMD_WIN
->generic
.handle
,
585 TUI_CMD_WIN
->detail
.command_info
.start_line
,
586 TUI_CMD_WIN
->detail
.command_info
.curch
);
587 wrefresh (TUI_CMD_WIN
->generic
.handle
);
589 signal (sig
, tui_cont_sig
);
593 /* Initialize the IO for gdb in curses mode. */
595 tui_initialize_io (void)
598 signal (SIGCONT
, tui_cont_sig
);
601 /* Create tui output streams. */
602 tui_stdout
= tui_fileopen (stdout
);
603 tui_stderr
= tui_fileopen (stderr
);
604 tui_out
= tui_out_new (tui_stdout
);
606 /* Create the default UI. It is not created because we installed a
607 deprecated_init_ui_hook. */
608 tui_old_uiout
= uiout
= cli_out_new (gdb_stdout
);
610 #ifdef TUI_USE_PIPE_FOR_READLINE
611 /* Temporary solution for readline writing to stdout:
612 redirect readline output in a pipe, read that pipe and
613 output the content in the curses command window. */
614 if (pipe (tui_readline_pipe
) != 0)
616 fprintf_unfiltered (gdb_stderr
, "Cannot create pipe for readline");
619 tui_rl_outstream
= fdopen (tui_readline_pipe
[1], "w");
620 if (tui_rl_outstream
== 0)
622 fprintf_unfiltered (gdb_stderr
, "Cannot redirect readline output");
625 setvbuf (tui_rl_outstream
, (char*) NULL
, _IOLBF
, 0);
628 (void) fcntl (tui_readline_pipe
[0], F_SETFL
, O_NONBLOCK
);
631 (void) fcntl (tui_readline_pipe
[0], F_SETFL
, O_NDELAY
);
634 add_file_handler (tui_readline_pipe
[0], tui_readline_output
, 0);
636 tui_rl_outstream
= stdout
;
640 /* Get a character from the command window. This is called from the readline
648 w
= TUI_CMD_WIN
->generic
.handle
;
650 #ifdef TUI_USE_PIPE_FOR_READLINE
651 /* Flush readline output. */
652 tui_readline_output (GDB_READABLE
, 0);
656 ch
= tui_handle_resize_during_io (ch
);
658 /* The \n must be echoed because it will not be printed by readline. */
661 /* When hitting return with an empty input, gdb executes the last
662 command. If we emit a newline, this fills up the command window
663 with empty lines with gdb prompt at beginning. Instead of that,
664 stay on the same line but provide a visual effect to show the
665 user we recognized the command. */
668 wmove (w
, TUI_CMD_WIN
->detail
.command_info
.cur_line
, 0);
670 /* Clear the line. This will blink the gdb prompt since
671 it will be redrawn at the same line. */
678 wmove (w
, TUI_CMD_WIN
->detail
.command_info
.cur_line
,
679 TUI_CMD_WIN
->detail
.command_info
.curch
);
684 if (key_is_command_char (ch
))
685 { /* Handle prev/next/up/down here */
686 ch
= tui_dispatch_ctrl_char (ch
);
689 if (ch
== '\n' || ch
== '\r' || ch
== '\f')
690 TUI_CMD_WIN
->detail
.command_info
.curch
= 0;
691 if (ch
== KEY_BACKSPACE
)
698 /* Cleanup when a resize has occured.
699 Returns the character that must be processed. */
701 tui_handle_resize_during_io (unsigned int original_ch
)
703 if (tui_win_resized ())
705 tui_refresh_all_win ();
707 tui_set_win_resized_to (FALSE
);