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