6ca2beeb85ed68740bd8e9f209824366e38178e9
[deliverable/binutils-gdb.git] / gdb / tui / tui-io.c
1 /* TUI support I/O functions.
2
3 Copyright 1998, 1999, 2000, 2001, 2002, 2003, 2004 Free Software
4 Foundation, Inc.
5
6 Contributed by Hewlett-Packard Company.
7
8 This file is part of GDB.
9
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.
14
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.
19
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. */
24
25 #include "defs.h"
26 #include "terminal.h"
27 #include "target.h"
28 #include "event-loop.h"
29 #include "event-top.h"
30 #include "command.h"
31 #include "top.h"
32 #include "readline/readline.h"
33 #include "tui/tui.h"
34 #include "tui/tui-data.h"
35 #include "tui/tui-io.h"
36 #include "tui/tui-command.h"
37 #include "tui/tui-win.h"
38 #include "tui/tui-wingeneral.h"
39 #include "tui/tui-file.h"
40 #include "ui-out.h"
41 #include "cli-out.h"
42 #include <fcntl.h>
43 #include <signal.h>
44 #include <stdio.h>
45
46 #ifdef HAVE_NCURSES_H
47 #include <ncurses.h>
48 #else
49 #ifdef HAVE_CURSES_H
50 #include <curses.h>
51 #endif
52 #endif
53
54 int
55 key_is_start_sequence (int ch)
56 {
57 return (ch == 27);
58 }
59
60 int
61 key_is_end_sequence (int ch)
62 {
63 return (ch == 126);
64 }
65
66 int
67 key_is_backspace (int ch)
68 {
69 return (ch == 8);
70 }
71
72 int
73 key_is_command_char (int ch)
74 {
75 return ((ch == KEY_NPAGE) || (ch == KEY_PPAGE)
76 || (ch == KEY_LEFT) || (ch == KEY_RIGHT)
77 || (ch == KEY_UP) || (ch == KEY_DOWN)
78 || (ch == KEY_SF) || (ch == KEY_SR)
79 || (ch == (int)'\f') || key_is_start_sequence (ch));
80 }
81
82 /* Use definition from readline 4.3. */
83 #undef CTRL_CHAR
84 #define CTRL_CHAR(c) ((c) < control_character_threshold && (((c) & 0x80) == 0))
85
86 /* This file controls the IO interactions between gdb and curses.
87 When the TUI is enabled, gdb has two modes a curses and a standard
88 mode.
89
90 In curses mode, the gdb outputs are made in a curses command window.
91 For this, the gdb_stdout and gdb_stderr are redirected to the specific
92 ui_file implemented by TUI. The output is handled by tui_puts().
93 The input is also controlled by curses with tui_getc(). The readline
94 library uses this function to get its input. Several readline hooks
95 are installed to redirect readline output to the TUI (see also the
96 note below).
97
98 In normal mode, the gdb outputs are restored to their origin, that
99 is as if TUI is not used. Readline also uses its original getc()
100 function with stdin.
101
102 Note SCz/2001-07-21: the current readline is not clean in its management of
103 the output. Even if we install a redisplay handler, it sometimes writes on
104 a stdout file. It is important to redirect every output produced by
105 readline, otherwise the curses window will be garbled. This is implemented
106 with a pipe that TUI reads and readline writes to. A gdb input handler
107 is created so that reading the pipe is handled automatically.
108 This will probably not work on non-Unix platforms. The best fix is
109 to make readline clean enougth so that is never write on stdout.
110
111 Note SCz/2002-09-01: we now use more readline hooks and it seems that
112 with them we don't need the pipe anymore (verified by creating the pipe
113 and closing its end so that write causes a SIGPIPE). The old pipe code
114 is still there and can be conditionally removed by
115 #undef TUI_USE_PIPE_FOR_READLINE. */
116
117 /* For gdb 5.3, prefer to continue the pipe hack as a backup wheel. */
118 #define TUI_USE_PIPE_FOR_READLINE
119 /*#undef TUI_USE_PIPE_FOR_READLINE*/
120
121 /* TUI output files. */
122 static struct ui_file *tui_stdout;
123 static struct ui_file *tui_stderr;
124 struct ui_out *tui_out;
125
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;
130
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;
137
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];
144 #endif
145
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;
149
150 static unsigned int tui_handle_resize_during_io (unsigned int);
151
152 static void
153 tui_putc (char c)
154 {
155 char buf[2];
156
157 buf[0] = c;
158 buf[1] = 0;
159 tui_puts (buf);
160 }
161
162 /* Print the string in the curses command window. */
163 void
164 tui_puts (const char *string)
165 {
166 static int tui_skip_line = -1;
167 char c;
168 WINDOW *w;
169
170 w = TUI_CMD_WIN->generic.handle;
171 while ((c = *string++) != 0)
172 {
173 /* Catch annotation and discard them. We need two \032 and
174 discard until a \n is seen. */
175 if (c == '\032')
176 {
177 tui_skip_line++;
178 }
179 else if (tui_skip_line != 1)
180 {
181 tui_skip_line = -1;
182 waddch (w, c);
183 }
184 else if (c == '\n')
185 tui_skip_line = -1;
186 }
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;
190
191 /* We could defer the following. */
192 wrefresh (w);
193 fflush (stdout);
194 }
195
196 /* Readline callback.
197 Redisplay the command line with its prompt after readline has
198 changed the edited text. */
199 void
200 tui_redisplay_readline (void)
201 {
202 int prev_col;
203 int height;
204 int col, line;
205 int c_pos;
206 int c_line;
207 int in;
208 WINDOW *w;
209 char *prompt;
210 int start_line;
211
212 /* Detect when we temporarily left SingleKey and now the readline
213 edit buffer is empty, automatically restore the SingleKey mode. */
214 if (tui_current_key_mode == TUI_ONE_COMMAND_MODE && rl_end == 0)
215 tui_set_key_mode (TUI_SINGLE_KEY_MODE);
216
217 if (tui_current_key_mode == TUI_SINGLE_KEY_MODE)
218 prompt = "";
219 else
220 prompt = tui_rl_saved_prompt;
221
222 c_pos = -1;
223 c_line = -1;
224 w = TUI_CMD_WIN->generic.handle;
225 start_line = TUI_CMD_WIN->detail.command_info.start_line;
226 wmove (w, start_line, 0);
227 prev_col = 0;
228 height = 1;
229 for (in = 0; prompt && prompt[in]; in++)
230 {
231 waddch (w, prompt[in]);
232 getyx (w, line, col);
233 if (col < prev_col)
234 height++;
235 prev_col = col;
236 }
237 for (in = 0; in < rl_end; in++)
238 {
239 unsigned char c;
240
241 c = (unsigned char) rl_line_buffer[in];
242 if (in == rl_point)
243 {
244 getyx (w, c_line, c_pos);
245 }
246
247 if (CTRL_CHAR (c) || c == RUBOUT)
248 {
249 waddch (w, '^');
250 waddch (w, CTRL_CHAR (c) ? UNCTRL (c) : '?');
251 }
252 else
253 {
254 waddch (w, c);
255 }
256 if (c == '\n')
257 {
258 getyx (w, TUI_CMD_WIN->detail.command_info.start_line,
259 TUI_CMD_WIN->detail.command_info.curch);
260 }
261 getyx (w, line, col);
262 if (col < prev_col)
263 height++;
264 prev_col = col;
265 }
266 wclrtobot (w);
267 getyx (w, TUI_CMD_WIN->detail.command_info.start_line,
268 TUI_CMD_WIN->detail.command_info.curch);
269 if (c_line >= 0)
270 {
271 wmove (w, c_line, c_pos);
272 TUI_CMD_WIN->detail.command_info.cur_line = c_line;
273 TUI_CMD_WIN->detail.command_info.curch = c_pos;
274 }
275 TUI_CMD_WIN->detail.command_info.start_line -= height - 1;
276
277 wrefresh (w);
278 fflush(stdout);
279 }
280
281 /* Readline callback to prepare the terminal. It is called once
282 each time we enter readline. Terminal is already setup in curses mode. */
283 static void
284 tui_prep_terminal (int notused1)
285 {
286 /* Save the prompt registered in readline to correctly display it.
287 (we can't use gdb_prompt() due to secondary prompts and can't use
288 rl_prompt because it points to an alloca buffer). */
289 xfree (tui_rl_saved_prompt);
290 tui_rl_saved_prompt = xstrdup (rl_prompt);
291 }
292
293 /* Readline callback to restore the terminal. It is called once
294 each time we leave readline. There is nothing to do in curses mode. */
295 static void
296 tui_deprep_terminal (void)
297 {
298 }
299
300 #ifdef TUI_USE_PIPE_FOR_READLINE
301 /* Read readline output pipe and feed the command window with it.
302 Should be removed when readline is clean. */
303 static void
304 tui_readline_output (int code, gdb_client_data data)
305 {
306 int size;
307 char buf[256];
308
309 size = read (tui_readline_pipe[0], buf, sizeof (buf) - 1);
310 if (size > 0 && tui_active)
311 {
312 buf[size] = 0;
313 tui_puts (buf);
314 }
315 }
316 #endif
317
318 /* Return the portion of PATHNAME that should be output when listing
319 possible completions. If we are hacking filename completion, we
320 are only interested in the basename, the portion following the
321 final slash. Otherwise, we return what we were passed.
322
323 Comes from readline/complete.c */
324 static char *
325 printable_part (char *pathname)
326 {
327 char *temp;
328
329 temp = rl_filename_completion_desired ? strrchr (pathname, '/') : (char *)NULL;
330 #if defined (__MSDOS__)
331 if (rl_filename_completion_desired && temp == 0 && isalpha (pathname[0]) && pathname[1] == ':')
332 temp = pathname + 1;
333 #endif
334 return (temp ? ++temp : pathname);
335 }
336
337 /* Output TO_PRINT to rl_outstream. If VISIBLE_STATS is defined and we
338 are using it, check for and output a single character for `special'
339 filenames. Return the number of characters we output. */
340
341 #define PUTX(c) \
342 do { \
343 if (CTRL_CHAR (c)) \
344 { \
345 tui_puts ("^"); \
346 tui_putc (UNCTRL (c)); \
347 printed_len += 2; \
348 } \
349 else if (c == RUBOUT) \
350 { \
351 tui_puts ("^?"); \
352 printed_len += 2; \
353 } \
354 else \
355 { \
356 tui_putc (c); \
357 printed_len++; \
358 } \
359 } while (0)
360
361 static int
362 print_filename (char *to_print, char *full_pathname)
363 {
364 int printed_len = 0;
365 char *s;
366
367 for (s = to_print; *s; s++)
368 {
369 PUTX (*s);
370 }
371 return printed_len;
372 }
373
374 /* The user must press "y" or "n". Non-zero return means "y" pressed.
375 Comes from readline/complete.c */
376 static int
377 get_y_or_n (void)
378 {
379 extern int _rl_abort_internal ();
380 int c;
381
382 for (;;)
383 {
384 c = rl_read_key ();
385 if (c == 'y' || c == 'Y' || c == ' ')
386 return (1);
387 if (c == 'n' || c == 'N' || c == RUBOUT)
388 return (0);
389 if (c == ABORT_CHAR)
390 _rl_abort_internal ();
391 beep ();
392 }
393 }
394
395 /* A convenience function for displaying a list of strings in
396 columnar format on readline's output stream. MATCHES is the list
397 of strings, in argv format, LEN is the number of strings in MATCHES,
398 and MAX is the length of the longest string in MATCHES.
399
400 Comes from readline/complete.c and modified to write in
401 the TUI command window using tui_putc/tui_puts. */
402 static void
403 tui_rl_display_match_list (char **matches, int len, int max)
404 {
405 typedef int QSFUNC (const void *, const void *);
406 extern int _rl_qsort_string_compare (const void*, const void*);
407 extern int _rl_print_completions_horizontally;
408
409 int count, limit, printed_len;
410 int i, j, k, l;
411 char *temp;
412
413 /* Screen dimension correspond to the TUI command window. */
414 int screenwidth = TUI_CMD_WIN->generic.width;
415
416 /* If there are many items, then ask the user if she really wants to
417 see them all. */
418 if (len >= rl_completion_query_items)
419 {
420 char msg[256];
421
422 sprintf (msg, "\nDisplay all %d possibilities? (y or n)", len);
423 tui_puts (msg);
424 if (get_y_or_n () == 0)
425 {
426 tui_puts ("\n");
427 return;
428 }
429 }
430
431 /* How many items of MAX length can we fit in the screen window? */
432 max += 2;
433 limit = screenwidth / max;
434 if (limit != 1 && (limit * max == screenwidth))
435 limit--;
436
437 /* Avoid a possible floating exception. If max > screenwidth,
438 limit will be 0 and a divide-by-zero fault will result. */
439 if (limit == 0)
440 limit = 1;
441
442 /* How many iterations of the printing loop? */
443 count = (len + (limit - 1)) / limit;
444
445 /* Watch out for special case. If LEN is less than LIMIT, then
446 just do the inner printing loop.
447 0 < len <= limit implies count = 1. */
448
449 /* Sort the items if they are not already sorted. */
450 if (rl_ignore_completion_duplicates == 0)
451 qsort (matches + 1, len, sizeof (char *),
452 (QSFUNC *)_rl_qsort_string_compare);
453
454 tui_putc ('\n');
455
456 if (_rl_print_completions_horizontally == 0)
457 {
458 /* Print the sorted items, up-and-down alphabetically, like ls. */
459 for (i = 1; i <= count; i++)
460 {
461 for (j = 0, l = i; j < limit; j++)
462 {
463 if (l > len || matches[l] == 0)
464 break;
465 else
466 {
467 temp = printable_part (matches[l]);
468 printed_len = print_filename (temp, matches[l]);
469
470 if (j + 1 < limit)
471 for (k = 0; k < max - printed_len; k++)
472 tui_putc (' ');
473 }
474 l += count;
475 }
476 tui_putc ('\n');
477 }
478 }
479 else
480 {
481 /* Print the sorted items, across alphabetically, like ls -x. */
482 for (i = 1; matches[i]; i++)
483 {
484 temp = printable_part (matches[i]);
485 printed_len = print_filename (temp, matches[i]);
486 /* Have we reached the end of this line? */
487 if (matches[i+1])
488 {
489 if (i && (limit > 1) && (i % limit) == 0)
490 tui_putc ('\n');
491 else
492 for (k = 0; k < max - printed_len; k++)
493 tui_putc (' ');
494 }
495 }
496 tui_putc ('\n');
497 }
498 }
499
500 /* Setup the IO for curses or non-curses mode.
501 - In non-curses mode, readline and gdb use the standard input and
502 standard output/error directly.
503 - In curses mode, the standard output/error is controlled by TUI
504 with the tui_stdout and tui_stderr. The output is redirected in
505 the curses command window. Several readline callbacks are installed
506 so that readline asks for its input to the curses command window
507 with wgetch(). */
508 void
509 tui_setup_io (int mode)
510 {
511 extern int readline_echoing_p;
512
513 if (mode)
514 {
515 /* Redirect readline to TUI. */
516 tui_old_rl_redisplay_function = rl_redisplay_function;
517 tui_old_rl_deprep_terminal = rl_deprep_term_function;
518 tui_old_rl_prep_terminal = rl_prep_term_function;
519 tui_old_rl_getc_function = rl_getc_function;
520 tui_old_rl_outstream = rl_outstream;
521 tui_old_readline_echoing_p = readline_echoing_p;
522 rl_redisplay_function = tui_redisplay_readline;
523 rl_deprep_term_function = tui_deprep_terminal;
524 rl_prep_term_function = tui_prep_terminal;
525 rl_getc_function = tui_getc;
526 readline_echoing_p = 0;
527 rl_outstream = tui_rl_outstream;
528 rl_prompt = 0;
529 rl_completion_display_matches_hook = tui_rl_display_match_list;
530 rl_already_prompted = 0;
531
532 /* Keep track of previous gdb output. */
533 tui_old_stdout = gdb_stdout;
534 tui_old_stderr = gdb_stderr;
535 tui_old_uiout = uiout;
536
537 /* Reconfigure gdb output. */
538 gdb_stdout = tui_stdout;
539 gdb_stderr = tui_stderr;
540 gdb_stdlog = gdb_stdout; /* for moment */
541 gdb_stdtarg = gdb_stderr; /* for moment */
542 uiout = tui_out;
543
544 /* Save tty for SIGCONT. */
545 savetty ();
546 }
547 else
548 {
549 /* Restore gdb output. */
550 gdb_stdout = tui_old_stdout;
551 gdb_stderr = tui_old_stderr;
552 gdb_stdlog = gdb_stdout; /* for moment */
553 gdb_stdtarg = gdb_stderr; /* for moment */
554 uiout = tui_old_uiout;
555
556 /* Restore readline. */
557 rl_redisplay_function = tui_old_rl_redisplay_function;
558 rl_deprep_term_function = tui_old_rl_deprep_terminal;
559 rl_prep_term_function = tui_old_rl_prep_terminal;
560 rl_getc_function = tui_old_rl_getc_function;
561 rl_outstream = tui_old_rl_outstream;
562 rl_completion_display_matches_hook = 0;
563 readline_echoing_p = tui_old_readline_echoing_p;
564 rl_already_prompted = 0;
565
566 /* Save tty for SIGCONT. */
567 savetty ();
568 }
569 }
570
571 #ifdef SIGCONT
572 /* Catch SIGCONT to restore the terminal and refresh the screen. */
573 static void
574 tui_cont_sig (int sig)
575 {
576 if (tui_active)
577 {
578 /* Restore the terminal setting because another process (shell)
579 might have changed it. */
580 resetty ();
581
582 /* Force a refresh of the screen. */
583 tui_refresh_all_win ();
584
585 /* Update cursor position on the screen. */
586 wmove (TUI_CMD_WIN->generic.handle,
587 TUI_CMD_WIN->detail.command_info.start_line,
588 TUI_CMD_WIN->detail.command_info.curch);
589 wrefresh (TUI_CMD_WIN->generic.handle);
590 }
591 signal (sig, tui_cont_sig);
592 }
593 #endif
594
595 /* Initialize the IO for gdb in curses mode. */
596 void
597 tui_initialize_io (void)
598 {
599 #ifdef SIGCONT
600 signal (SIGCONT, tui_cont_sig);
601 #endif
602
603 /* Create tui output streams. */
604 tui_stdout = tui_fileopen (stdout);
605 tui_stderr = tui_fileopen (stderr);
606 tui_out = tui_out_new (tui_stdout);
607
608 /* Create the default UI. It is not created because we installed
609 a init_ui_hook. */
610 tui_old_uiout = uiout = cli_out_new (gdb_stdout);
611
612 #ifdef TUI_USE_PIPE_FOR_READLINE
613 /* Temporary solution for readline writing to stdout:
614 redirect readline output in a pipe, read that pipe and
615 output the content in the curses command window. */
616 if (pipe (tui_readline_pipe) != 0)
617 {
618 fprintf_unfiltered (gdb_stderr, "Cannot create pipe for readline");
619 exit (1);
620 }
621 tui_rl_outstream = fdopen (tui_readline_pipe[1], "w");
622 if (tui_rl_outstream == 0)
623 {
624 fprintf_unfiltered (gdb_stderr, "Cannot redirect readline output");
625 exit (1);
626 }
627 setvbuf (tui_rl_outstream, (char*) NULL, _IOLBF, 0);
628
629 #ifdef O_NONBLOCK
630 (void) fcntl (tui_readline_pipe[0], F_SETFL, O_NONBLOCK);
631 #else
632 #ifdef O_NDELAY
633 (void) fcntl (tui_readline_pipe[0], F_SETFL, O_NDELAY);
634 #endif
635 #endif
636 add_file_handler (tui_readline_pipe[0], tui_readline_output, 0);
637 #else
638 tui_rl_outstream = stdout;
639 #endif
640 }
641
642 /* Get a character from the command window. This is called from the readline
643 package. */
644 int
645 tui_getc (FILE *fp)
646 {
647 int ch;
648 WINDOW *w;
649
650 w = TUI_CMD_WIN->generic.handle;
651
652 #ifdef TUI_USE_PIPE_FOR_READLINE
653 /* Flush readline output. */
654 tui_readline_output (GDB_READABLE, 0);
655 #endif
656
657 ch = wgetch (w);
658 ch = tui_handle_resize_during_io (ch);
659
660 /* The \n must be echoed because it will not be printed by readline. */
661 if (ch == '\n')
662 {
663 /* When hitting return with an empty input, gdb executes the last
664 command. If we emit a newline, this fills up the command window
665 with empty lines with gdb prompt at beginning. Instead of that,
666 stay on the same line but provide a visual effect to show the
667 user we recognized the command. */
668 if (rl_end == 0)
669 {
670 wmove (w, TUI_CMD_WIN->detail.command_info.cur_line, 0);
671
672 /* Clear the line. This will blink the gdb prompt since
673 it will be redrawn at the same line. */
674 wclrtoeol (w);
675 wrefresh (w);
676 napms (20);
677 }
678 else
679 {
680 wmove (w, TUI_CMD_WIN->detail.command_info.cur_line,
681 TUI_CMD_WIN->detail.command_info.curch);
682 waddch (w, ch);
683 }
684 }
685
686 if (key_is_command_char (ch))
687 { /* Handle prev/next/up/down here */
688 ch = tui_dispatch_ctrl_char (ch);
689 }
690
691 if (ch == '\n' || ch == '\r' || ch == '\f')
692 TUI_CMD_WIN->detail.command_info.curch = 0;
693 if (ch == KEY_BACKSPACE)
694 return '\b';
695
696 return ch;
697 }
698
699
700 /* Cleanup when a resize has occured.
701 Returns the character that must be processed. */
702 static unsigned int
703 tui_handle_resize_during_io (unsigned int original_ch)
704 {
705 if (tui_win_resized ())
706 {
707 tui_refresh_all_win ();
708 dont_repeat ();
709 tui_set_win_resized_to (FALSE);
710 return '\n';
711 }
712 else
713 return original_ch;
714 }
This page took 0.076266 seconds and 4 git commands to generate.