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