tui-io.c 24.9 KB
Newer Older
1
/* TUI support I/O functions.
2

3
   Copyright (C) 1998-2019 Free Software Foundation, Inc.
4

5
6
7
8
9
10
   Contributed by Hewlett-Packard Company.

   This file is part of GDB.

   This program is free software; you can redistribute it and/or modify
   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
13
14
15
16
17
18
19
   (at your option) any later version.

   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.

   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
24
#include "target.h"
#include "event-loop.h"
25
#include "event-top.h"
26
27
#include "command.h"
#include "top.h"
28
29
30
31
32
33
34
#include "tui/tui.h"
#include "tui/tui-data.h"
#include "tui/tui-io.h"
#include "tui/tui-command.h"
#include "tui/tui-win.h"
#include "tui/tui-wingeneral.h"
#include "tui/tui-file.h"
Simon Marchi's avatar
Simon Marchi committed
35
#include "tui/tui-out.h"
36
37
38
#include "ui-out.h"
#include "cli-out.h"
#include <fcntl.h>
39
#include <signal.h>
Tom Tromey's avatar
Tom Tromey committed
40
#include "filestuff.h"
41
#include "completer.h"
42
#include "gdb_curses.h"
43
#include <map>
44

45
46
47
48
49
/* This redefines CTRL if it is not already defined, so it must come
   after terminal state releated include files like <term.h> and
   "gdb_curses.h".  */
#include "readline/readline.h"

Tom Tromey's avatar
Tom Tromey committed
50
51
52
static int tui_getc (FILE *fp);

static int
53
54
55
56
57
key_is_start_sequence (int ch)
{
  return (ch == 27);
}

58
59
/* Use definition from readline 4.3.  */
#undef CTRL_CHAR
60
61
#define CTRL_CHAR(c) \
     ((c) < control_character_threshold && (((c) & 0x80) == 0))
62

63
64
65
66
/* This file controls the IO interactions between gdb and curses.
   When the TUI is enabled, gdb has two modes a curses and a standard
   mode.

67
68
69
70
71
72
73
   In curses mode, the gdb outputs are made in a curses command
   window.  For this, the gdb_stdout and gdb_stderr are redirected to
   the specific ui_file implemented by TUI.  The output is handled by
   tui_puts().  The input is also controlled by curses with
   tui_getc().  The readline library uses this function to get its
   input.  Several readline hooks are installed to redirect readline
   output to the TUI (see also the note below).
74
75
76
77
78

   In normal mode, the gdb outputs are restored to their origin, that
   is as if TUI is not used.  Readline also uses its original getc()
   function with stdin.

79
80
81
82
83
84
85
86
87
88
89
90
91
92
   Note SCz/2001-07-21: the current readline is not clean in its
   management of the output.  Even if we install a redisplay handler,
   it sometimes writes on a stdout file.  It is important to redirect
   every output produced by readline, otherwise the curses window will
   be garbled.  This is implemented with a pipe that TUI reads and
   readline writes to.  A gdb input handler is created so that reading
   the pipe is handled automatically.  This will probably not work on
   non-Unix platforms.  The best fix is to make readline clean enougth
   so that is never write on stdout.

   Note SCz/2002-09-01: we now use more readline hooks and it seems
   that with them we don't need the pipe anymore (verified by creating
   the pipe and closing its end so that write causes a SIGPIPE).  The
   old pipe code is still there and can be conditionally removed by
93
94
95
   #undef TUI_USE_PIPE_FOR_READLINE.  */

/* For gdb 5.3, prefer to continue the pipe hack as a backup wheel.  */
96
#ifdef HAVE_PIPE
97
#define TUI_USE_PIPE_FOR_READLINE
98
#endif
99
/* #undef TUI_USE_PIPE_FOR_READLINE */
100
101
102
103

/* TUI output files.  */
static struct ui_file *tui_stdout;
static struct ui_file *tui_stderr;
104
struct ui_out *tui_out;
105
106
107
108

/* GDB output files in non-curses mode.  */
static struct ui_file *tui_old_stdout;
static struct ui_file *tui_old_stderr;
Simon Marchi's avatar
Simon Marchi committed
109
cli_ui_out *tui_old_uiout;
110
111

/* Readline previous hooks.  */
112
113
114
115
static rl_getc_func_t *tui_old_rl_getc_function;
static rl_voidfunc_t *tui_old_rl_redisplay_function;
static rl_vintfunc_t *tui_old_rl_prep_terminal;
static rl_voidfunc_t *tui_old_rl_deprep_terminal;
116
static rl_compdisp_func_t *tui_old_rl_display_matches_hook;
117
static int tui_old_rl_echoing_p;
118
119
120
121
122

/* Readline output stream.
   Should be removed when readline is clean.  */
static FILE *tui_rl_outstream;
static FILE *tui_old_rl_outstream;
123
#ifdef TUI_USE_PIPE_FOR_READLINE
124
static int tui_readline_pipe[2];
125
#endif
126

127
128
129
130
/* The last gdb prompt that was registered in readline.
   This may be the main gdb prompt or a secondary prompt.  */
static char *tui_rl_saved_prompt;

131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
/* Print a character in the curses command window.  The output is
   buffered.  It is up to the caller to refresh the screen if
   necessary.  */

static void
do_tui_putc (WINDOW *w, char c)
{
  static int tui_skip_line = -1;

  /* Catch annotation and discard them.  We need two \032 and discard
     until a \n is seen.  */
  if (c == '\032')
    {
      tui_skip_line++;
    }
  else if (tui_skip_line != 1)
    {
      tui_skip_line = -1;
      /* Expand TABs, since ncurses on MS-Windows doesn't.  */
      if (c == '\t')
	{
	  int col;

	  col = getcurx (w);
	  do
	    {
	      waddch (w, ' ');
	      col++;
	    }
	  while ((col % 8) != 0);
	}
      else
	waddch (w, c);
    }
  else if (c == '\n')
    tui_skip_line = -1;
}

/* Update the cached value of the command window's start line based on
   the window's current Y coordinate.  */

static void
update_cmdwin_start_line ()
{
  TUI_CMD_WIN->detail.command_info.start_line
    = getcury (TUI_CMD_WIN->generic.handle);
}

/* Print a character in the curses command window.  The output is
   buffered.  It is up to the caller to refresh the screen if
   necessary.  */

183
184
185
static void
tui_putc (char c)
{
186
  WINDOW *w = TUI_CMD_WIN->generic.handle;
187

188
189
  do_tui_putc (w, c);
  update_cmdwin_start_line ();
190
}
191

192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
/* This maps colors to their corresponding color index.  */

static std::map<ui_file_style::color, int> color_map;

/* This holds a pair of colors and is used to track the mapping
   between a color pair index and the actual colors.  */

struct color_pair
{
  int fg;
  int bg;

  bool operator< (const color_pair &o) const
  {
    return fg < o.fg || (fg == o.fg && bg < o.bg);
  }
};

/* This maps pairs of colors to their corresponding color pair
   index.  */

static std::map<color_pair, int> color_pair_map;

/* This is indexed by ANSI color offset from the base color, and holds
   the corresponding curses color constant.  */

static const int curses_colors[] = {
  COLOR_BLACK,
  COLOR_RED,
  COLOR_GREEN,
  COLOR_YELLOW,
  COLOR_BLUE,
  COLOR_MAGENTA,
  COLOR_CYAN,
  COLOR_WHITE
};

/* Given a color, find its index.  */

static bool
get_color (const ui_file_style::color &color, int *result)
{
  if (color.is_none ())
    *result = -1;
  else if (color.is_basic ())
    *result = curses_colors[color.get_value ()];
  else
    {
      auto it = color_map.find (color);
      if (it == color_map.end ())
	{
	  /* The first 8 colors are standard.  */
	  int next = color_map.size () + 8;
	  if (next >= COLORS)
	    return false;
	  uint8_t rgb[3];
	  color.get_rgb (rgb);
	  /* We store RGB as 0..255, but curses wants 0..1000.  */
	  if (init_color (next, rgb[0] * 1000 / 255, rgb[1] * 1000 / 255,
			  rgb[2] * 1000 / 255) == ERR)
	    return false;
	  color_map[color] = next;
	  *result = next;
	}
      else
	*result = it->second;
    }
  return true;
}

/* The most recently emitted color pair.  */

static int last_color_pair = -1;

/* The most recently applied style.  */

static ui_file_style last_style;

/* Given two colors, return their color pair index; making a new one
   if necessary.  */

static int
get_color_pair (int fg, int bg)
{
  color_pair c = { fg, bg };
  auto it = color_pair_map.find (c);
  if (it == color_pair_map.end ())
    {
      /* Color pair 0 is our default color, so new colors start at
	 1.  */
      int next = color_pair_map.size () + 1;
      /* Curses has a limited number of available color pairs.  Fall
	 back to the default if we've used too many.  */
      if (next >= COLOR_PAIRS)
	return 0;
      init_pair (next, fg, bg);
      color_pair_map[c] = next;
      return next;
    }
  return it->second;
}

/* Apply an ANSI escape sequence from BUF to W.  BUF must start with
   the ESC character.  If BUF does not start with an ANSI escape,
   return 0.  Otherwise, apply the sequence if it is recognized, or
   simply ignore it if not.  In this case, the number of bytes read
   from BUF is returned.  */

static size_t
apply_ansi_escape (WINDOW *w, const char *buf)
{
  ui_file_style style = last_style;
  size_t n_read;

  if (!style.parse (buf, &n_read))
    return n_read;

  /* Reset.  */
  wattron (w, A_NORMAL);
  wattroff (w, A_BOLD);
  wattroff (w, A_DIM);
  wattroff (w, A_REVERSE);
  if (last_color_pair != -1)
    wattroff (w, COLOR_PAIR (last_color_pair));
  wattron (w, COLOR_PAIR (0));

  const ui_file_style::color &fg = style.get_foreground ();
  const ui_file_style::color &bg = style.get_background ();
  if (!fg.is_none () || !bg.is_none ())
    {
      int fgi, bgi;
      if (get_color (fg, &fgi) && get_color (bg, &bgi))
	{
	  int pair = get_color_pair (fgi, bgi);
	  if (last_color_pair != -1)
	    wattroff (w, COLOR_PAIR (last_color_pair));
	  wattron (w, COLOR_PAIR (pair));
	  last_color_pair = pair;
	}
    }

  switch (style.get_intensity ())
    {
    case ui_file_style::NORMAL:
      break;

    case ui_file_style::BOLD:
      wattron (w, A_BOLD);
      break;

    case ui_file_style::DIM:
      wattron (w, A_DIM);
      break;

    default:
      gdb_assert_not_reached ("invalid intensity");
    }

  if (style.is_reverse ())
    wattron (w, A_REVERSE);

  last_style = style;
  return n_read;
}

357
358
359
360
361
362
/* Print LENGTH characters from the buffer pointed to by BUF to the
   curses command window.  The output is buffered.  It is up to the
   caller to refresh the screen if necessary.  */

void
tui_write (const char *buf, size_t length)
363
364
365
366
367
368
369
{
  /* We need this to be \0-terminated for the regexp matching.  */
  std::string copy (buf, length);
  tui_puts (copy.c_str ());
}

static void
370
tui_puts_internal (WINDOW *w, const char *string, int *height)
371
{
372
373
  char c;
  int prev_col = 0;
374

375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
  while ((c = *string++) != 0)
    {
      if (c == '\1' || c == '\2')
	{
	  /* Ignore these, they are readline escape-marking
	     sequences.  */
	}
      else
	{
	  if (c == '\033')
	    {
	      size_t bytes_read = apply_ansi_escape (w, string - 1);
	      if (bytes_read > 0)
		{
		  string = string + bytes_read - 1;
		  continue;
		}
	    }
	  do_tui_putc (w, c);

	  if (height != nullptr)
	    {
	      int col = getcurx (w);
	      if (col <= prev_col)
		++*height;
	      prev_col = col;
	    }
	}
    }
404
405
406
407
408
409
  update_cmdwin_start_line ();
}

/* Print a string in the curses command window.  The output is
   buffered.  It is up to the caller to refresh the screen if
   necessary.  */
Doug Evans's avatar
Doug Evans committed
410

411
void
412
tui_puts (const char *string, WINDOW *w)
413
{
414
415
416
  if (w == nullptr)
    w = TUI_CMD_WIN->generic.handle;
  tui_puts_internal (w, string, nullptr);
417
418
419
420
421
}

/* Readline callback.
   Redisplay the command line with its prompt after readline has
   changed the edited text.  */
422
void
423
424
425
426
tui_redisplay_readline (void)
{
  int prev_col;
  int height;
Tom Tromey's avatar
Tom Tromey committed
427
  int col;
428
429
430
431
  int c_pos;
  int c_line;
  int in;
  WINDOW *w;
Pedro Alves's avatar
Pedro Alves committed
432
  const char *prompt;
433
  int start_line;
434
435

  /* Detect when we temporarily left SingleKey and now the readline
436
     edit buffer is empty, automatically restore the SingleKey
437
438
439
440
     mode.  The restore must only be done if the command has finished.
     The command could call prompt_for_continue and we must not
     restore SingleKey so that the prompt and normal keymap are used.  */
  if (tui_current_key_mode == TUI_ONE_COMMAND_MODE && rl_end == 0
441
      && !gdb_in_secondary_prompt_p (current_ui))
442
    tui_set_key_mode (TUI_SINGLE_KEY_MODE);
443

444
  if (tui_current_key_mode == TUI_SINGLE_KEY_MODE)
445
446
    prompt = "";
  else
447
    prompt = tui_rl_saved_prompt;
448
449
450
  
  c_pos = -1;
  c_line = -1;
451
452
  w = TUI_CMD_WIN->generic.handle;
  start_line = TUI_CMD_WIN->detail.command_info.start_line;
453
454
455
  wmove (w, start_line, 0);
  prev_col = 0;
  height = 1;
456
  if (prompt != nullptr)
457
    tui_puts_internal (TUI_CMD_WIN->generic.handle, prompt, &height);
458
459

  prev_col = getcurx (w);
460
  for (in = 0; in <= rl_end; in++)
461
462
463
464
465
466
467
468
    {
      unsigned char c;
      
      if (in == rl_point)
	{
          getyx (w, c_line, c_pos);
	}

469
470
471
472
      if (in == rl_end)
        break;

      c = (unsigned char) rl_line_buffer[in];
473
474
475
476
477
      if (CTRL_CHAR (c) || c == RUBOUT)
	{
          waddch (w, '^');
          waddch (w, CTRL_CHAR (c) ? UNCTRL (c) : '?');
	}
478
479
480
      else if (c == '\t')
	{
	  /* Expand TABs, since ncurses on MS-Windows doesn't.  */
Tom Tromey's avatar
Tom Tromey committed
481
	  col = getcurx (w);
482
483
484
485
486
487
	  do
	    {
	      waddch (w, ' ');
	      col++;
	    } while ((col % 8) != 0);
	}
488
489
      else
	{
490
          waddch (w, c);
491
	}
492
      if (c == '\n')
493
	TUI_CMD_WIN->detail.command_info.start_line = getcury (w);
Tom Tromey's avatar
Tom Tromey committed
494
      col = getcurx (w);
495
496
497
      if (col < prev_col)
        height++;
      prev_col = col;
498
    }
499
  wclrtobot (w);
500
  TUI_CMD_WIN->detail.command_info.start_line = getcury (w);
501
  if (c_line >= 0)
502
    wmove (w, c_line, c_pos);
503
  TUI_CMD_WIN->detail.command_info.start_line -= height - 1;
504
505
506
507
508

  wrefresh (w);
  fflush(stdout);
}

509
510
511
/* Readline callback to prepare the terminal.  It is called once each
   time we enter readline.  Terminal is already setup in curses
   mode.  */
512
static void
513
tui_prep_terminal (int notused1)
514
{
515
516
517
518
  /* Save the prompt registered in readline to correctly display it.
     (we can't use gdb_prompt() due to secondary prompts and can't use
     rl_prompt because it points to an alloca buffer).  */
  xfree (tui_rl_saved_prompt);
519
  tui_rl_saved_prompt = rl_prompt != NULL ? xstrdup (rl_prompt) : NULL;
520
}
521

522
523
/* Readline callback to restore the terminal.  It is called once each
   time we leave readline.  There is nothing to do in curses mode.  */
524
525
526
527
static void
tui_deprep_terminal (void)
{
}
528

529
#ifdef TUI_USE_PIPE_FOR_READLINE
530
531
532
/* Read readline output pipe and feed the command window with it.
   Should be removed when readline is clean.  */
static void
533
tui_readline_output (int error, gdb_client_data data)
534
535
536
{
  int size;
  char buf[256];
537

538
539
  size = read (tui_readline_pipe[0], buf, sizeof (buf) - 1);
  if (size > 0 && tui_active)
540
    {
541
542
      buf[size] = 0;
      tui_puts (buf);
543
    }
544
}
545
546
#endif

547
/* TUI version of displayer.crlf.  */
548

549
550
static void
tui_mld_crlf (const struct match_list_displayer *displayer)
551
{
552
  tui_putc ('\n');
553
554
}

555
/* TUI version of displayer.putch.  */
556

557
558
static void
tui_mld_putch (const struct match_list_displayer *displayer, int ch)
559
{
560
  tui_putc (ch);
561
562
}

563
564
565
566
/* TUI version of displayer.puts.  */

static void
tui_mld_puts (const struct match_list_displayer *displayer, const char *s)
567
{
568
569
  tui_puts (s);
}
570

571
572
573
574
575
576
/* TUI version of displayer.flush.  */

static void
tui_mld_flush (const struct match_list_displayer *displayer)
{
  wrefresh (TUI_CMD_WIN->generic.handle);
577
578
}

579
/* TUI version of displayer.erase_entire_line.  */
580
581

static void
582
tui_mld_erase_entire_line (const struct match_list_displayer *displayer)
583
{
584
  WINDOW *w = TUI_CMD_WIN->generic.handle;
585
  int cur_y = getcury (w);
586

587
  wmove (w, cur_y, 0);
588
  wclrtoeol (w);
589
  wmove (w, cur_y, 0);
590
}
591

592
/* TUI version of displayer.beep.  */
593

594
595
596
597
598
599
static void
tui_mld_beep (const struct match_list_displayer *displayer)
{
  beep ();
}

Tom Tromey's avatar
Tom Tromey committed
600
601
602
603
604
605
606
607
608
609
610
611
/* A wrapper for wgetch that enters nonl mode.  We We normally want
  curses' "nl" mode, but when reading from the user, we'd like to
  differentiate between C-j and C-m, because some users bind these
  keys differently in their .inputrc.  So, put curses into nonl mode
  just when reading from the user.  See PR tui/20819.  */

static int
gdb_wgetch (WINDOW *win)
{
  nonl ();
  int r = wgetch (win);
  nl ();
612
613
614
615
616
617
  /* In nonl mode, if the user types Enter, it will not be echoed
     properly.  This will result in gdb output appearing immediately
     after the command.  So, if we read \r, emit a \r now, after nl
     mode has been re-entered, so that the output looks correct.  */
  if (r == '\r')
    puts ("\r");
Tom Tromey's avatar
Tom Tromey committed
618
619
620
  return r;
}

621
622
623
624
625
626
627
628
/* Helper function for tui_mld_read_key.
   This temporarily replaces tui_getc for use during tab-completion
   match list display.  */

static int
tui_mld_getc (FILE *fp)
{
  WINDOW *w = TUI_CMD_WIN->generic.handle;
Tom Tromey's avatar
Tom Tromey committed
629
  int c = gdb_wgetch (w);
630

631
632
  return c;
}
633

634
/* TUI version of displayer.read_key.  */
635

636
637
638
639
640
static int
tui_mld_read_key (const struct match_list_displayer *displayer)
{
  rl_getc_func_t *prev = rl_getc_function;
  int c;
641

642
643
644
645
646
647
  /* We can't use tui_getc as we need NEWLINE to not get emitted.  */
  rl_getc_function = tui_mld_getc;
  c = rl_read_key ();
  rl_getc_function = prev;
  return c;
}
648

649
650
/* TUI version of rl_completion_display_matches_hook.
   See gdb_display_match_list for a description of the arguments.  */
651

652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
static void
tui_rl_display_match_list (char **matches, int len, int max)
{
  struct match_list_displayer displayer;

  rl_get_screen_size (&displayer.height, &displayer.width);
  displayer.crlf = tui_mld_crlf;
  displayer.putch = tui_mld_putch;
  displayer.puts = tui_mld_puts;
  displayer.flush = tui_mld_flush;
  displayer.erase_entire_line = tui_mld_erase_entire_line;
  displayer.beep = tui_mld_beep;
  displayer.read_key = tui_mld_read_key;

  gdb_display_match_list (matches, len, max, &displayer);
667
}
668
669
670
671
672
673
674
675
676
677
678
679

/* Setup the IO for curses or non-curses mode.
   - In non-curses mode, readline and gdb use the standard input and
   standard output/error directly.
   - In curses mode, the standard output/error is controlled by TUI
   with the tui_stdout and tui_stderr.  The output is redirected in
   the curses command window.  Several readline callbacks are installed
   so that readline asks for its input to the curses command window
   with wgetch().  */
void
tui_setup_io (int mode)
{
680
681
  extern int _rl_echoing_p;

682
  if (mode)
683
    {
684
685
686
687
688
      /* Redirect readline to TUI.  */
      tui_old_rl_redisplay_function = rl_redisplay_function;
      tui_old_rl_deprep_terminal = rl_deprep_term_function;
      tui_old_rl_prep_terminal = rl_prep_term_function;
      tui_old_rl_getc_function = rl_getc_function;
689
      tui_old_rl_display_matches_hook = rl_completion_display_matches_hook;
690
      tui_old_rl_outstream = rl_outstream;
691
      tui_old_rl_echoing_p = _rl_echoing_p;
692
693
694
695
      rl_redisplay_function = tui_redisplay_readline;
      rl_deprep_term_function = tui_deprep_terminal;
      rl_prep_term_function = tui_prep_terminal;
      rl_getc_function = tui_getc;
696
      _rl_echoing_p = 0;
697
698
      rl_outstream = tui_rl_outstream;
      rl_prompt = 0;
699
700
      rl_completion_display_matches_hook = tui_rl_display_match_list;
      rl_already_prompted = 0;
701
702
703
704

      /* Keep track of previous gdb output.  */
      tui_old_stdout = gdb_stdout;
      tui_old_stderr = gdb_stderr;
Simon Marchi's avatar
Simon Marchi committed
705
706
      tui_old_uiout = dynamic_cast<cli_ui_out *> (current_uiout);
      gdb_assert (tui_old_uiout != nullptr);
707
708
709
710
711
712

      /* Reconfigure gdb output.  */
      gdb_stdout = tui_stdout;
      gdb_stderr = tui_stderr;
      gdb_stdlog = gdb_stdout;	/* for moment */
      gdb_stdtarg = gdb_stderr;	/* for moment */
Jan Kratochvil's avatar
gdb/    
Jan Kratochvil committed
713
      gdb_stdtargerr = gdb_stderr;	/* for moment */
714
      current_uiout = tui_out;
715
716
717

      /* Save tty for SIGCONT.  */
      savetty ();
718
    }
719
  else
720
    {
721
722
723
724
725
      /* Restore gdb output.  */
      gdb_stdout = tui_old_stdout;
      gdb_stderr = tui_old_stderr;
      gdb_stdlog = gdb_stdout;	/* for moment */
      gdb_stdtarg = gdb_stderr;	/* for moment */
Jan Kratochvil's avatar
gdb/    
Jan Kratochvil committed
726
      gdb_stdtargerr = gdb_stderr;	/* for moment */
727
      current_uiout = tui_old_uiout;
728
729
730
731
732
733

      /* Restore readline.  */
      rl_redisplay_function = tui_old_rl_redisplay_function;
      rl_deprep_term_function = tui_old_rl_deprep_terminal;
      rl_prep_term_function = tui_old_rl_prep_terminal;
      rl_getc_function = tui_old_rl_getc_function;
734
      rl_completion_display_matches_hook = tui_old_rl_display_matches_hook;
735
      rl_outstream = tui_old_rl_outstream;
736
      _rl_echoing_p = tui_old_rl_echoing_p;
737
      rl_already_prompted = 0;
738
739
740

      /* Save tty for SIGCONT.  */
      savetty ();
741
742
743
744
745
746

      /* Clean up color information.  */
      last_color_pair = -1;
      last_style = ui_file_style ();
      color_map.clear ();
      color_pair_map.clear ();
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
    }
}

#ifdef SIGCONT
/* Catch SIGCONT to restore the terminal and refresh the screen.  */
static void
tui_cont_sig (int sig)
{
  if (tui_active)
    {
      /* Restore the terminal setting because another process (shell)
         might have changed it.  */
      resetty ();

      /* Force a refresh of the screen.  */
762
      tui_refresh_all_win ();
763

764
      wrefresh (TUI_CMD_WIN->generic.handle);
765
    }
766
  signal (sig, tui_cont_sig);
767
}
768
#endif
769

770
771
/* Initialize the IO for gdb in curses mode.  */
void
772
tui_initialize_io (void)
773
{
774
775
776
777
#ifdef SIGCONT
  signal (SIGCONT, tui_cont_sig);
#endif

778
  /* Create tui output streams.  */
779
780
  tui_stdout = new tui_file (stdout);
  tui_stderr = new tui_file (stderr);
781
782
  tui_out = tui_out_new (tui_stdout);

783
  /* Create the default UI.  */
Pedro Alves's avatar
gdb/    
Pedro Alves committed
784
  tui_old_uiout = cli_out_new (gdb_stdout);
785

786
#ifdef TUI_USE_PIPE_FOR_READLINE
787
788
789
  /* Temporary solution for readline writing to stdout: redirect
     readline output in a pipe, read that pipe and output the content
     in the curses command window.  */
Tom Tromey's avatar
Tom Tromey committed
790
  if (gdb_pipe_cloexec (tui_readline_pipe) != 0)
791
792
    error (_("Cannot create pipe for readline"));

793
794
  tui_rl_outstream = fdopen (tui_readline_pipe[1], "w");
  if (tui_rl_outstream == 0)
795
796
    error (_("Cannot redirect readline output"));

Stephane Carrez's avatar
Stephane Carrez committed
797
  setvbuf (tui_rl_outstream, (char*) NULL, _IOLBF, 0);
798

799
800
#ifdef O_NONBLOCK
  (void) fcntl (tui_readline_pipe[0], F_SETFL, O_NONBLOCK);
801
#else
802
803
#ifdef O_NDELAY
  (void) fcntl (tui_readline_pipe[0], F_SETFL, O_NDELAY);
804
#endif
805
806
#endif
  add_file_handler (tui_readline_pipe[0], tui_readline_output, 0);
807
808
809
#else
  tui_rl_outstream = stdout;
#endif
810
811
}

812
813
/* Get a character from the command window.  This is called from the
   readline package.  */
Tom Tromey's avatar
Tom Tromey committed
814
static int
815
816
817
818
819
tui_getc (FILE *fp)
{
  int ch;
  WINDOW *w;

820
  w = TUI_CMD_WIN->generic.handle;
821

822
#ifdef TUI_USE_PIPE_FOR_READLINE
823
  /* Flush readline output.  */
824
  tui_readline_output (0, 0);
825
826
#endif

Tom Tromey's avatar
Tom Tromey committed
827
  ch = gdb_wgetch (w);
828

829
830
  /* The \n must be echoed because it will not be printed by
     readline.  */
831
832
833
834
835
836
837
  if (ch == '\n')
    {
      /* When hitting return with an empty input, gdb executes the last
         command.  If we emit a newline, this fills up the command window
         with empty lines with gdb prompt at beginning.  Instead of that,
         stay on the same line but provide a visual effect to show the
         user we recognized the command.  */
838
      if (rl_end == 0 && !gdb_in_secondary_prompt_p (current_ui))
839
        {
840
	  wmove (w, getcury (w), 0);
841
842
843
844
845
846
847
848
849

          /* Clear the line.  This will blink the gdb prompt since
             it will be redrawn at the same line.  */
          wclrtoeol (w);
          wrefresh (w);
          napms (20);
        }
      else
        {
850
851
852
	  /* Move cursor to the end of the command line before emitting the
	     newline.  We need to do so because when ncurses outputs a newline
	     it truncates any text that appears past the end of the cursor.  */
853
854
	  int px, py;
	  getyx (w, py, px);
855
856
857
858
	  px += rl_end - rl_point;
	  py += px / TUI_CMD_WIN->generic.width;
	  px %= TUI_CMD_WIN->generic.width;
	  wmove (w, py, px);
859
	  tui_putc ('\n');
860
861
862
        }
    }
  
863
864
  /* Handle prev/next/up/down here.  */
  ch = tui_dispatch_ctrl_char (ch);
865
866
867
  
  if (ch == KEY_BACKSPACE)
    return '\b';
868

869
  if (current_ui->command_editing && key_is_start_sequence (ch))
870
871
872
873
    {
      int ch_pending;

      nodelay (w, TRUE);
Tom Tromey's avatar
Tom Tromey committed
874
      ch_pending = gdb_wgetch (w);
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
      nodelay (w, FALSE);

      /* If we have pending input following a start sequence, call the stdin
	 event handler again because ncurses may have already read and stored
	 the input into its internal buffer, meaning that we won't get an stdin
	 event for it.  If we don't compensate for this missed stdin event, key
	 sequences as Alt_F (^[f) will not behave promptly.

	 (We only compensates for the missed 2nd byte of a key sequence because
	 2-byte sequences are by far the most commonly used. ncurses may have
	 buffered a larger, 3+-byte key sequence though it remains to be seen
	 whether it is useful to compensate for all the bytes of such
	 sequences.)  */
      if (ch_pending != ERR)
	{
	  ungetch (ch_pending);
	  call_stdin_event_handler_again_p = 1;
	}
    }

895
  return ch;
896
}
897

898
899
900
901
902
903
904
/* Utility function to expand TABs in a STRING into spaces.  STRING
   will be displayed starting at column COL, and is assumed to include
   no newlines.  The returned expanded string is malloc'ed.  */

char *
tui_expand_tabs (const char *string, int col)
{
905
  int n_adjust, ncol;
906
907
908
909
  const char *s;
  char *ret, *q;

  /* 1. How many additional characters do we need?  */
910
  for (ncol = col, n_adjust = 0, s = string; s; )
911
912
913
914
    {
      s = strpbrk (s, "\t");
      if (s)
	{
915
	  ncol += (s - string) + n_adjust;
916
917
	  /* Adjustment for the next tab stop, minus one for the TAB
	     we replace with spaces.  */
918
	  n_adjust += 8 - (ncol % 8) - 1;
919
920
921
922
923
	  s++;
	}
    }

  /* Allocate the copy.  */
924
  ret = q = (char *) xmalloc (strlen (string) + n_adjust + 1);
925
926

  /* 2. Copy the original string while replacing TABs with spaces.  */
927
  for (ncol = col, s = string; s; )
928
    {
Pedro Alves's avatar
Pedro Alves committed
929
      const char *s1 = strpbrk (s, "\t");
930
931
932
933
934
935
      if (s1)
	{
	  if (s1 > s)
	    {
	      strncpy (q, s, s1 - s);
	      q += s1 - s;
936
	      ncol += s1 - s;
937
938
939
	    }
	  do {
	    *q++ = ' ';
940
941
	    ncol++;
	  } while ((ncol % 8) != 0);
942
943
944
945
946
947
948
949
950
	  s1++;
	}
      else
	strcpy (q, s);
      s = s1;
    }

  return ret;
}