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