2004-01-20 Andrew Cagney <cagney@redhat.com>
[external/binutils.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 _tuiHandleResizeDuringIO (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 = cmdWin->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, cmdWin->detail.commandInfo.curLine,
188          cmdWin->detail.commandInfo.curch);
189   cmdWin->detail.commandInfo.start_line = cmdWin->detail.commandInfo.curLine;
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 = cmdWin->generic.handle;
225   start_line = cmdWin->detail.commandInfo.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, cmdWin->detail.commandInfo.start_line,
259                  cmdWin->detail.commandInfo.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, cmdWin->detail.commandInfo.start_line,
268          cmdWin->detail.commandInfo.curch);
269   if (c_line >= 0)
270     {
271       wmove (w, c_line, c_pos);
272       cmdWin->detail.commandInfo.curLine = c_line;
273       cmdWin->detail.commandInfo.curch = c_pos;
274     }
275   cmdWin->detail.commandInfo.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 (pathname)
326      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 we
339    are using it, check for and output a single character for `special'
340    filenames.  Return the number of characters we 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 (to_print, full_pathname)
364      char *to_print, *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 ()
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 (matches, len, max)
406      char **matches;
407      int len, max;
408 {
409   typedef int QSFUNC (const void *, const void *);
410   extern int _rl_qsort_string_compare (const void*, const void*);
411   extern int _rl_print_completions_horizontally;
412   
413   int count, limit, printed_len;
414   int i, j, k, l;
415   char *temp;
416
417   /* Screen dimension correspond to the TUI command window.  */
418   int screenwidth = cmdWin->generic.width;
419
420   /* If there are many items, then ask the user if she really wants to
421      see them all. */
422   if (len >= rl_completion_query_items)
423     {
424       char msg[256];
425
426       sprintf (msg, "\nDisplay all %d possibilities? (y or n)", len);
427       tui_puts (msg);
428       if (get_y_or_n () == 0)
429         {
430           tui_puts ("\n");
431           return;
432         }
433     }
434
435   /* How many items of MAX length can we fit in the screen window? */
436   max += 2;
437   limit = screenwidth / max;
438   if (limit != 1 && (limit * max == screenwidth))
439     limit--;
440
441   /* Avoid a possible floating exception.  If max > screenwidth,
442      limit will be 0 and a divide-by-zero fault will result. */
443   if (limit == 0)
444     limit = 1;
445
446   /* How many iterations of the printing loop? */
447   count = (len + (limit - 1)) / limit;
448
449   /* Watch out for special case.  If LEN is less than LIMIT, then
450      just do the inner printing loop.
451            0 < len <= limit  implies  count = 1. */
452
453   /* Sort the items if they are not already sorted. */
454   if (rl_ignore_completion_duplicates == 0)
455     qsort (matches + 1, len, sizeof (char *),
456            (QSFUNC *)_rl_qsort_string_compare);
457
458   tui_putc ('\n');
459
460   if (_rl_print_completions_horizontally == 0)
461     {
462       /* Print the sorted items, up-and-down alphabetically, like ls. */
463       for (i = 1; i <= count; i++)
464         {
465           for (j = 0, l = i; j < limit; j++)
466             {
467               if (l > len || matches[l] == 0)
468                 break;
469               else
470                 {
471                   temp = printable_part (matches[l]);
472                   printed_len = print_filename (temp, matches[l]);
473
474                   if (j + 1 < limit)
475                     for (k = 0; k < max - printed_len; k++)
476                       tui_putc (' ');
477                 }
478               l += count;
479             }
480           tui_putc ('\n');
481         }
482     }
483   else
484     {
485       /* Print the sorted items, across alphabetically, like ls -x. */
486       for (i = 1; matches[i]; i++)
487         {
488           temp = printable_part (matches[i]);
489           printed_len = print_filename (temp, matches[i]);
490           /* Have we reached the end of this line? */
491           if (matches[i+1])
492             {
493               if (i && (limit > 1) && (i % limit) == 0)
494                 tui_putc ('\n');
495               else
496                 for (k = 0; k < max - printed_len; k++)
497                   tui_putc (' ');
498             }
499         }
500       tui_putc ('\n');
501     }
502 }
503
504 /* Setup the IO for curses or non-curses mode.
505    - In non-curses mode, readline and gdb use the standard input and
506    standard output/error directly.
507    - In curses mode, the standard output/error is controlled by TUI
508    with the tui_stdout and tui_stderr.  The output is redirected in
509    the curses command window.  Several readline callbacks are installed
510    so that readline asks for its input to the curses command window
511    with wgetch().  */
512 void
513 tui_setup_io (int mode)
514 {
515   extern int readline_echoing_p;
516  
517   if (mode)
518     {
519       /* Redirect readline to TUI.  */
520       tui_old_rl_redisplay_function = rl_redisplay_function;
521       tui_old_rl_deprep_terminal = rl_deprep_term_function;
522       tui_old_rl_prep_terminal = rl_prep_term_function;
523       tui_old_rl_getc_function = rl_getc_function;
524       tui_old_rl_outstream = rl_outstream;
525       tui_old_readline_echoing_p = readline_echoing_p;
526       rl_redisplay_function = tui_redisplay_readline;
527       rl_deprep_term_function = tui_deprep_terminal;
528       rl_prep_term_function = tui_prep_terminal;
529       rl_getc_function = tui_getc;
530       readline_echoing_p = 0;
531       rl_outstream = tui_rl_outstream;
532       rl_prompt = 0;
533       rl_completion_display_matches_hook = tui_rl_display_match_list;
534       rl_already_prompted = 0;
535
536       /* Keep track of previous gdb output.  */
537       tui_old_stdout = gdb_stdout;
538       tui_old_stderr = gdb_stderr;
539       tui_old_uiout = uiout;
540
541       /* Reconfigure gdb output.  */
542       gdb_stdout = tui_stdout;
543       gdb_stderr = tui_stderr;
544       gdb_stdlog = gdb_stdout;  /* for moment */
545       gdb_stdtarg = gdb_stderr; /* for moment */
546       uiout = tui_out;
547
548       /* Save tty for SIGCONT.  */
549       savetty ();
550     }
551   else
552     {
553       /* Restore gdb output.  */
554       gdb_stdout = tui_old_stdout;
555       gdb_stderr = tui_old_stderr;
556       gdb_stdlog = gdb_stdout;  /* for moment */
557       gdb_stdtarg = gdb_stderr; /* for moment */
558       uiout = tui_old_uiout;
559
560       /* Restore readline.  */
561       rl_redisplay_function = tui_old_rl_redisplay_function;
562       rl_deprep_term_function = tui_old_rl_deprep_terminal;
563       rl_prep_term_function = tui_old_rl_prep_terminal;
564       rl_getc_function = tui_old_rl_getc_function;
565       rl_outstream = tui_old_rl_outstream;
566       rl_completion_display_matches_hook = 0;
567       readline_echoing_p = tui_old_readline_echoing_p;
568       rl_already_prompted = 0;
569
570       /* Save tty for SIGCONT.  */
571       savetty ();
572     }
573 }
574
575 #ifdef SIGCONT
576 /* Catch SIGCONT to restore the terminal and refresh the screen.  */
577 static void
578 tui_cont_sig (int sig)
579 {
580   if (tui_active)
581     {
582       /* Restore the terminal setting because another process (shell)
583          might have changed it.  */
584       resetty ();
585
586       /* Force a refresh of the screen.  */
587       tuiRefreshAll ();
588
589       /* Update cursor position on the screen.  */
590       wmove (cmdWin->generic.handle,
591              cmdWin->detail.commandInfo.start_line,
592              cmdWin->detail.commandInfo.curch);
593       wrefresh (cmdWin->generic.handle);
594     }
595   signal (sig, tui_cont_sig);
596 }
597 #endif
598
599 /* Initialize the IO for gdb in curses mode.  */
600 void
601 tui_initialize_io ()
602 {
603 #ifdef SIGCONT
604   signal (SIGCONT, tui_cont_sig);
605 #endif
606
607   /* Create tui output streams.  */
608   tui_stdout = tui_fileopen (stdout);
609   tui_stderr = tui_fileopen (stderr);
610   tui_out = tui_out_new (tui_stdout);
611
612   /* Create the default UI.  It is not created because we installed
613      a init_ui_hook.  */
614   tui_old_uiout = uiout = cli_out_new (gdb_stdout);
615
616 #ifdef TUI_USE_PIPE_FOR_READLINE
617   /* Temporary solution for readline writing to stdout:
618      redirect readline output in a pipe, read that pipe and
619      output the content in the curses command window.  */
620   if (pipe (tui_readline_pipe) != 0)
621     {
622       fprintf_unfiltered (gdb_stderr, "Cannot create pipe for readline");
623       exit (1);
624     }
625   tui_rl_outstream = fdopen (tui_readline_pipe[1], "w");
626   if (tui_rl_outstream == 0)
627     {
628       fprintf_unfiltered (gdb_stderr, "Cannot redirect readline output");
629       exit (1);
630     }
631   setvbuf (tui_rl_outstream, (char*) NULL, _IOLBF, 0);
632
633 #ifdef O_NONBLOCK
634   (void) fcntl (tui_readline_pipe[0], F_SETFL, O_NONBLOCK);
635 #else
636 #ifdef O_NDELAY
637   (void) fcntl (tui_readline_pipe[0], F_SETFL, O_NDELAY);
638 #endif
639 #endif
640   add_file_handler (tui_readline_pipe[0], tui_readline_output, 0);
641 #else
642   tui_rl_outstream = stdout;
643 #endif
644 }
645
646 /* Get a character from the command window.  This is called from the readline
647    package.  */
648 int
649 tui_getc (FILE *fp)
650 {
651   int ch;
652   WINDOW *w;
653
654   w = cmdWin->generic.handle;
655
656 #ifdef TUI_USE_PIPE_FOR_READLINE
657   /* Flush readline output.  */
658   tui_readline_output (GDB_READABLE, 0);
659 #endif
660
661   ch = wgetch (w);
662   ch = _tuiHandleResizeDuringIO (ch);
663
664   /* The \n must be echoed because it will not be printed by 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, cmdWin->detail.commandInfo.curLine, 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, cmdWin->detail.commandInfo.curLine,
685                  cmdWin->detail.commandInfo.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     cmdWin->detail.commandInfo.curch = 0;
697 #if 0
698   else
699     tuiIncrCommandCharCountBy (1);
700 #endif
701   if (ch == KEY_BACKSPACE)
702     return '\b';
703   
704   return ch;
705 }
706
707
708 /* Cleanup when a resize has occured.
709    Returns the character that must be processed.  */
710 static unsigned int
711 _tuiHandleResizeDuringIO (unsigned int originalCh)
712 {
713   if (tuiWinResized ())
714     {
715       tuiRefreshAll ();
716       dont_repeat ();
717       tuiSetWinResizedTo (FALSE);
718       return '\n';
719     }
720   else
721     return originalCh;
722 }