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