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