Upgrade GDB from 7.3 to 7.4.1 on the vendor branch
[dragonfly.git] / contrib / gdb-7 / gdb / tui / tui-io.c
1 /* TUI support I/O functions.
2
3    Copyright (C) 1998-2004, 2007-2012 Free Software Foundation, Inc.
4
5    Contributed by Hewlett-Packard Company.
6
7    This file is part of GDB.
8
9    This program is free software; you can redistribute it and/or modify
10    it under the terms of the GNU General Public License as published by
11    the Free Software Foundation; either version 3 of the License, or
12    (at your option) any later version.
13
14    This program is distributed in the hope that it will be useful,
15    but WITHOUT ANY WARRANTY; without even the implied warranty of
16    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17    GNU General Public License for more details.
18
19    You should have received a copy of the GNU General Public License
20    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
21
22 #include "defs.h"
23 #include "target.h"
24 #include "event-loop.h"
25 #include "event-top.h"
26 #include "command.h"
27 #include "top.h"
28 #include "tui/tui.h"
29 #include "tui/tui-data.h"
30 #include "tui/tui-io.h"
31 #include "tui/tui-command.h"
32 #include "tui/tui-win.h"
33 #include "tui/tui-wingeneral.h"
34 #include "tui/tui-file.h"
35 #include "ui-out.h"
36 #include "cli-out.h"
37 #include <fcntl.h>
38 #include <signal.h>
39 #include <stdio.h>
40
41 #include "gdb_curses.h"
42
43 /* This redefines CTRL if it is not already defined, so it must come
44    after terminal state releated include files like <term.h> and
45    "gdb_curses.h".  */
46 #include "readline/readline.h"
47
48 int
49 key_is_start_sequence (int ch)
50 {
51   return (ch == 27);
52 }
53
54 int
55 key_is_end_sequence (int ch)
56 {
57   return (ch == 126);
58 }
59
60 int
61 key_is_backspace (int ch)
62 {
63   return (ch == 8);
64 }
65
66 int
67 key_is_command_char (int ch)
68 {
69   return ((ch == KEY_NPAGE) || (ch == KEY_PPAGE)
70           || (ch == KEY_LEFT) || (ch == KEY_RIGHT)
71           || (ch == KEY_UP) || (ch == KEY_DOWN)
72           || (ch == KEY_SF) || (ch == KEY_SR)
73           || (ch == (int)'\f') 
74           || key_is_start_sequence (ch));
75 }
76
77 /* Use definition from readline 4.3.  */
78 #undef CTRL_CHAR
79 #define CTRL_CHAR(c) \
80      ((c) < control_character_threshold && (((c) & 0x80) == 0))
81
82 /* This file controls the IO interactions between gdb and curses.
83    When the TUI is enabled, gdb has two modes a curses and a standard
84    mode.
85
86    In curses mode, the gdb outputs are made in a curses command
87    window.  For this, the gdb_stdout and gdb_stderr are redirected to
88    the specific ui_file implemented by TUI.  The output is handled by
89    tui_puts().  The input is also controlled by curses with
90    tui_getc().  The readline library uses this function to get its
91    input.  Several readline hooks are installed to redirect readline
92    output to the TUI (see also the note below).
93
94    In normal mode, the gdb outputs are restored to their origin, that
95    is as if TUI is not used.  Readline also uses its original getc()
96    function with stdin.
97
98    Note SCz/2001-07-21: the current readline is not clean in its
99    management of the output.  Even if we install a redisplay handler,
100    it sometimes writes on a stdout file.  It is important to redirect
101    every output produced by readline, otherwise the curses window will
102    be garbled.  This is implemented with a pipe that TUI reads and
103    readline writes to.  A gdb input handler is created so that reading
104    the pipe is handled automatically.  This will probably not work on
105    non-Unix platforms.  The best fix is to make readline clean enougth
106    so that is never write on stdout.
107
108    Note SCz/2002-09-01: we now use more readline hooks and it seems
109    that with them we don't need the pipe anymore (verified by creating
110    the pipe and closing its end so that write causes a SIGPIPE).  The
111    old pipe code 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 #ifdef HAVE_PIPE
116 #define TUI_USE_PIPE_FOR_READLINE
117 #endif
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_rl_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
189     = TUI_CMD_WIN->detail.command_info.cur_line;
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
214      mode.  */
215   if (tui_current_key_mode == TUI_ONE_COMMAND_MODE && rl_end == 0)
216     tui_set_key_mode (TUI_SINGLE_KEY_MODE);
217
218   if (tui_current_key_mode == TUI_SINGLE_KEY_MODE)
219     prompt = "";
220   else
221     prompt = tui_rl_saved_prompt;
222   
223   c_pos = -1;
224   c_line = -1;
225   w = TUI_CMD_WIN->generic.handle;
226   start_line = TUI_CMD_WIN->detail.command_info.start_line;
227   wmove (w, start_line, 0);
228   prev_col = 0;
229   height = 1;
230   for (in = 0; prompt && prompt[in]; in++)
231     {
232       waddch (w, prompt[in]);
233       getyx (w, line, col);
234       if (col < prev_col)
235         height++;
236       prev_col = col;
237     }
238   for (in = 0; in < rl_end; in++)
239     {
240       unsigned char c;
241       
242       c = (unsigned char) rl_line_buffer[in];
243       if (in == rl_point)
244         {
245           getyx (w, c_line, c_pos);
246         }
247
248       if (CTRL_CHAR (c) || c == RUBOUT)
249         {
250           waddch (w, '^');
251           waddch (w, CTRL_CHAR (c) ? UNCTRL (c) : '?');
252         }
253       else
254         {
255           waddch (w, c);
256         }
257       if (c == '\n')
258         {
259           getyx (w, TUI_CMD_WIN->detail.command_info.start_line,
260                  TUI_CMD_WIN->detail.command_info.curch);
261         }
262       getyx (w, line, col);
263       if (col < prev_col)
264         height++;
265       prev_col = col;
266     }
267   wclrtobot (w);
268   getyx (w, TUI_CMD_WIN->detail.command_info.start_line,
269          TUI_CMD_WIN->detail.command_info.curch);
270   if (c_line >= 0)
271     {
272       wmove (w, c_line, c_pos);
273       TUI_CMD_WIN->detail.command_info.cur_line = c_line;
274       TUI_CMD_WIN->detail.command_info.curch = c_pos;
275     }
276   TUI_CMD_WIN->detail.command_info.start_line -= height - 1;
277
278   wrefresh (w);
279   fflush(stdout);
280 }
281
282 /* Readline callback to prepare the terminal.  It is called once each
283    time we enter readline.  Terminal is already setup in curses
284    mode.  */
285 static void
286 tui_prep_terminal (int notused1)
287 {
288   /* Save the prompt registered in readline to correctly display it.
289      (we can't use gdb_prompt() due to secondary prompts and can't use
290      rl_prompt because it points to an alloca buffer).  */
291   xfree (tui_rl_saved_prompt);
292   tui_rl_saved_prompt = xstrdup (rl_prompt);
293 }
294
295 /* Readline callback to restore the terminal.  It is called once each
296    time we leave readline.  There is nothing to do in curses mode.  */
297 static void
298 tui_deprep_terminal (void)
299 {
300 }
301
302 #ifdef TUI_USE_PIPE_FOR_READLINE
303 /* Read readline output pipe and feed the command window with it.
304    Should be removed when readline is clean.  */
305 static void
306 tui_readline_output (int error, gdb_client_data data)
307 {
308   int size;
309   char buf[256];
310
311   size = read (tui_readline_pipe[0], buf, sizeof (buf) - 1);
312   if (size > 0 && tui_active)
313     {
314       buf[size] = 0;
315       tui_puts (buf);
316     }
317 }
318 #endif
319
320 /* Return the portion of PATHNAME that should be output when listing
321    possible completions.  If we are hacking filename completion, we
322    are only interested in the basename, the portion following the
323    final slash.  Otherwise, we return what we were passed.
324
325    Comes from readline/complete.c.  */
326 static const char *
327 printable_part (const char *pathname)
328 {
329   return rl_filename_completion_desired ? lbasename (pathname) : pathname;
330 }
331
332 /* Output TO_PRINT to rl_outstream.  If VISIBLE_STATS is defined and
333    we are using it, check for and output a single character for
334    `special' filenames.  Return the number of characters we
335    output.  */
336
337 #define PUTX(c) \
338     do { \
339       if (CTRL_CHAR (c)) \
340         { \
341           tui_puts ("^"); \
342           tui_putc (UNCTRL (c)); \
343           printed_len += 2; \
344         } \
345       else if (c == RUBOUT) \
346         { \
347           tui_puts ("^?"); \
348           printed_len += 2; \
349         } \
350       else \
351         { \
352           tui_putc (c); \
353           printed_len++; \
354         } \
355     } while (0)
356
357 static int
358 print_filename (const char *to_print, const char *full_pathname)
359 {
360   int printed_len = 0;
361   const char *s;
362
363   for (s = to_print; *s; s++)
364     {
365       PUTX (*s);
366     }
367   return printed_len;
368 }
369
370 /* The user must press "y" or "n".  Non-zero return means "y" pressed.
371    Comes from readline/complete.c.  */
372 static int
373 get_y_or_n (void)
374 {
375   extern int _rl_abort_internal ();
376   int c;
377
378   for (;;)
379     {
380       c = rl_read_key ();
381       if (c == 'y' || c == 'Y' || c == ' ')
382         return (1);
383       if (c == 'n' || c == 'N' || c == RUBOUT)
384         return (0);
385       if (c == ABORT_CHAR)
386         _rl_abort_internal ();
387       beep ();
388     }
389 }
390
391 /* A convenience function for displaying a list of strings in
392    columnar format on readline's output stream.  MATCHES is the list
393    of strings, in argv format, LEN is the number of strings in MATCHES,
394    and MAX is the length of the longest string in MATCHES.
395
396    Comes from readline/complete.c and modified to write in
397    the TUI command window using tui_putc/tui_puts.  */
398 static void
399 tui_rl_display_match_list (char **matches, int len, int max)
400 {
401   typedef int QSFUNC (const void *, const void *);
402   extern int _rl_qsort_string_compare (const void *, 
403                                        const void *);
404   extern int _rl_print_completions_horizontally;
405   
406   int count, limit, printed_len;
407   int i, j, k, l;
408   const 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, limit
435      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 _rl_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_rl_echoing_p = _rl_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       _rl_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 = current_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       gdb_stdtargerr = gdb_stderr;      /* for moment */
540       current_uiout = tui_out;
541
542       /* Save tty for SIGCONT.  */
543       savetty ();
544     }
545   else
546     {
547       /* Restore gdb output.  */
548       gdb_stdout = tui_old_stdout;
549       gdb_stderr = tui_old_stderr;
550       gdb_stdlog = gdb_stdout;  /* for moment */
551       gdb_stdtarg = gdb_stderr; /* for moment */
552       gdb_stdtargerr = gdb_stderr;      /* for moment */
553       current_uiout = tui_old_uiout;
554
555       /* Restore readline.  */
556       rl_redisplay_function = tui_old_rl_redisplay_function;
557       rl_deprep_term_function = tui_old_rl_deprep_terminal;
558       rl_prep_term_function = tui_old_rl_prep_terminal;
559       rl_getc_function = tui_old_rl_getc_function;
560       rl_outstream = tui_old_rl_outstream;
561       rl_completion_display_matches_hook = 0;
562       _rl_echoing_p = tui_old_rl_echoing_p;
563       rl_already_prompted = 0;
564
565       /* Save tty for SIGCONT.  */
566       savetty ();
567     }
568 }
569
570 #ifdef SIGCONT
571 /* Catch SIGCONT to restore the terminal and refresh the screen.  */
572 static void
573 tui_cont_sig (int sig)
574 {
575   if (tui_active)
576     {
577       /* Restore the terminal setting because another process (shell)
578          might have changed it.  */
579       resetty ();
580
581       /* Force a refresh of the screen.  */
582       tui_refresh_all_win ();
583
584       /* Update cursor position on the screen.  */
585       wmove (TUI_CMD_WIN->generic.handle,
586              TUI_CMD_WIN->detail.command_info.start_line,
587              TUI_CMD_WIN->detail.command_info.curch);
588       wrefresh (TUI_CMD_WIN->generic.handle);
589     }
590   signal (sig, tui_cont_sig);
591 }
592 #endif
593
594 /* Initialize the IO for gdb in curses mode.  */
595 void
596 tui_initialize_io (void)
597 {
598 #ifdef SIGCONT
599   signal (SIGCONT, tui_cont_sig);
600 #endif
601
602   /* Create tui output streams.  */
603   tui_stdout = tui_fileopen (stdout);
604   tui_stderr = tui_fileopen (stderr);
605   tui_out = tui_out_new (tui_stdout);
606
607   /* Create the default UI.  It is not created because we installed a
608      deprecated_init_ui_hook.  */
609   tui_old_uiout = cli_out_new (gdb_stdout);
610
611 #ifdef TUI_USE_PIPE_FOR_READLINE
612   /* Temporary solution for readline writing to stdout: redirect
613      readline output in a pipe, read that pipe and output the content
614      in the curses command window.  */
615   if (pipe (tui_readline_pipe) != 0)
616     {
617       fprintf_unfiltered (gdb_stderr, "Cannot create pipe for readline");
618       exit (1);
619     }
620   tui_rl_outstream = fdopen (tui_readline_pipe[1], "w");
621   if (tui_rl_outstream == 0)
622     {
623       fprintf_unfiltered (gdb_stderr, "Cannot redirect readline output");
624       exit (1);
625     }
626   setvbuf (tui_rl_outstream, (char*) NULL, _IOLBF, 0);
627
628 #ifdef O_NONBLOCK
629   (void) fcntl (tui_readline_pipe[0], F_SETFL, O_NONBLOCK);
630 #else
631 #ifdef O_NDELAY
632   (void) fcntl (tui_readline_pipe[0], F_SETFL, O_NDELAY);
633 #endif
634 #endif
635   add_file_handler (tui_readline_pipe[0], tui_readline_output, 0);
636 #else
637   tui_rl_outstream = stdout;
638 #endif
639 }
640
641 /* Get a character from the command window.  This is called from the
642    readline package.  */
643 int
644 tui_getc (FILE *fp)
645 {
646   int ch;
647   WINDOW *w;
648
649   w = TUI_CMD_WIN->generic.handle;
650
651 #ifdef TUI_USE_PIPE_FOR_READLINE
652   /* Flush readline output.  */
653   tui_readline_output (0, 0);
654 #endif
655
656   ch = wgetch (w);
657   ch = tui_handle_resize_during_io (ch);
658
659   /* The \n must be echoed because it will not be printed by
660      readline.  */
661   if (ch == '\n')
662     {
663       /* When hitting return with an empty input, gdb executes the last
664          command.  If we emit a newline, this fills up the command window
665          with empty lines with gdb prompt at beginning.  Instead of that,
666          stay on the same line but provide a visual effect to show the
667          user we recognized the command.  */
668       if (rl_end == 0)
669         {
670           wmove (w, TUI_CMD_WIN->detail.command_info.cur_line, 0);
671
672           /* Clear the line.  This will blink the gdb prompt since
673              it will be redrawn at the same line.  */
674           wclrtoeol (w);
675           wrefresh (w);
676           napms (20);
677         }
678       else
679         {
680           wmove (w, TUI_CMD_WIN->detail.command_info.cur_line,
681                  TUI_CMD_WIN->detail.command_info.curch);
682           waddch (w, ch);
683         }
684     }
685   
686   if (key_is_command_char (ch))
687     {                           /* Handle prev/next/up/down here.  */
688       ch = tui_dispatch_ctrl_char (ch);
689     }
690   
691   if (ch == '\n' || ch == '\r' || ch == '\f')
692     TUI_CMD_WIN->detail.command_info.curch = 0;
693   if (ch == KEY_BACKSPACE)
694     return '\b';
695   
696   return ch;
697 }
698
699
700 /* Cleanup when a resize has occured.
701    Returns the character that must be processed.  */
702 static unsigned int
703 tui_handle_resize_during_io (unsigned int original_ch)
704 {
705   if (tui_win_resized ())
706     {
707       tui_resize_all ();
708       tui_refresh_all_win ();
709       dont_repeat ();
710       tui_set_win_resized_to (FALSE);
711       return '\n';
712     }
713   else
714     return original_ch;
715 }