Commit | Line | Data |
---|---|---|
f377b406 | 1 | /* TUI support I/O functions. |
f33c6cbf | 2 | |
b811d2c2 | 3 | Copyright (C) 1998-2020 Free Software Foundation, Inc. |
f33c6cbf | 4 | |
f377b406 SC |
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 | |
a9762ec7 | 11 | the Free Software Foundation; either version 3 of the License, or |
f377b406 SC |
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 | |
a9762ec7 | 20 | along with this program. If not, see <http://www.gnu.org/licenses/>. */ |
c906108c | 21 | |
c906108c | 22 | #include "defs.h" |
a198b876 | 23 | #include "target.h" |
400b5eca | 24 | #include "gdbsupport/event-loop.h" |
e09d2eba | 25 | #include "event-top.h" |
a198b876 SC |
26 | #include "command.h" |
27 | #include "top.h" | |
d7b2e967 AC |
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" | |
112e8700 | 35 | #include "tui/tui-out.h" |
a198b876 SC |
36 | #include "ui-out.h" |
37 | #include "cli-out.h" | |
38 | #include <fcntl.h> | |
9d876a16 | 39 | #include <signal.h> |
3fff2c37 EZ |
40 | #ifdef __MINGW32__ |
41 | #include <windows.h> | |
42 | #endif | |
268a13a5 | 43 | #include "gdbsupport/filestuff.h" |
82083d6d | 44 | #include "completer.h" |
6a83354a | 45 | #include "gdb_curses.h" |
1d1d0bf7 | 46 | #include <map> |
a198b876 | 47 | |
4a1bcc8c MK |
48 | /* This redefines CTRL if it is not already defined, so it must come |
49 | after terminal state releated include files like <term.h> and | |
50 | "gdb_curses.h". */ | |
51 | #include "readline/readline.h" | |
52 | ||
3fff2c37 EZ |
53 | #ifdef __MINGW32__ |
54 | static SHORT ncurses_norm_attr; | |
55 | #endif | |
56 | ||
84371624 TT |
57 | static int tui_getc (FILE *fp); |
58 | ||
59 | static int | |
bcdf1568 AC |
60 | key_is_start_sequence (int ch) |
61 | { | |
62 | return (ch == 27); | |
63 | } | |
64 | ||
ec6f8892 SC |
65 | /* Use definition from readline 4.3. */ |
66 | #undef CTRL_CHAR | |
08ef48c5 MS |
67 | #define CTRL_CHAR(c) \ |
68 | ((c) < control_character_threshold && (((c) & 0x80) == 0)) | |
ec6f8892 | 69 | |
a198b876 SC |
70 | /* This file controls the IO interactions between gdb and curses. |
71 | When the TUI is enabled, gdb has two modes a curses and a standard | |
72 | mode. | |
73 | ||
1cc6d956 MS |
74 | In curses mode, the gdb outputs are made in a curses command |
75 | window. For this, the gdb_stdout and gdb_stderr are redirected to | |
76 | the specific ui_file implemented by TUI. The output is handled by | |
77 | tui_puts(). The input is also controlled by curses with | |
78 | tui_getc(). The readline library uses this function to get its | |
79 | input. Several readline hooks are installed to redirect readline | |
80 | output to the TUI (see also the note below). | |
a198b876 SC |
81 | |
82 | In normal mode, the gdb outputs are restored to their origin, that | |
83 | is as if TUI is not used. Readline also uses its original getc() | |
84 | function with stdin. | |
85 | ||
1cc6d956 MS |
86 | Note SCz/2001-07-21: the current readline is not clean in its |
87 | management of the output. Even if we install a redisplay handler, | |
88 | it sometimes writes on a stdout file. It is important to redirect | |
89 | every output produced by readline, otherwise the curses window will | |
90 | be garbled. This is implemented with a pipe that TUI reads and | |
91 | readline writes to. A gdb input handler is created so that reading | |
92 | the pipe is handled automatically. This will probably not work on | |
30baf67b | 93 | non-Unix platforms. The best fix is to make readline clean enough |
1cc6d956 MS |
94 | so that is never write on stdout. |
95 | ||
96 | Note SCz/2002-09-01: we now use more readline hooks and it seems | |
97 | that with them we don't need the pipe anymore (verified by creating | |
98 | the pipe and closing its end so that write causes a SIGPIPE). The | |
99 | old pipe code is still there and can be conditionally removed by | |
8cee930b SC |
100 | #undef TUI_USE_PIPE_FOR_READLINE. */ |
101 | ||
102 | /* For gdb 5.3, prefer to continue the pipe hack as a backup wheel. */ | |
a156a290 | 103 | #ifdef HAVE_PIPE |
8cee930b | 104 | #define TUI_USE_PIPE_FOR_READLINE |
a156a290 | 105 | #endif |
1cc6d956 | 106 | /* #undef TUI_USE_PIPE_FOR_READLINE */ |
a198b876 SC |
107 | |
108 | /* TUI output files. */ | |
109 | static struct ui_file *tui_stdout; | |
110 | static struct ui_file *tui_stderr; | |
2b68e2c5 | 111 | struct ui_out *tui_out; |
a198b876 SC |
112 | |
113 | /* GDB output files in non-curses mode. */ | |
114 | static struct ui_file *tui_old_stdout; | |
115 | static struct ui_file *tui_old_stderr; | |
112e8700 | 116 | cli_ui_out *tui_old_uiout; |
a198b876 SC |
117 | |
118 | /* Readline previous hooks. */ | |
840ed64d JK |
119 | static rl_getc_func_t *tui_old_rl_getc_function; |
120 | static rl_voidfunc_t *tui_old_rl_redisplay_function; | |
121 | static rl_vintfunc_t *tui_old_rl_prep_terminal; | |
122 | static rl_voidfunc_t *tui_old_rl_deprep_terminal; | |
ef0b411a | 123 | static rl_compdisp_func_t *tui_old_rl_display_matches_hook; |
cc88a640 | 124 | static int tui_old_rl_echoing_p; |
a198b876 SC |
125 | |
126 | /* Readline output stream. | |
127 | Should be removed when readline is clean. */ | |
128 | static FILE *tui_rl_outstream; | |
129 | static FILE *tui_old_rl_outstream; | |
8cee930b | 130 | #ifdef TUI_USE_PIPE_FOR_READLINE |
a198b876 | 131 | static int tui_readline_pipe[2]; |
8cee930b | 132 | #endif |
c906108c | 133 | |
9753a2f6 PA |
134 | /* Print a character in the curses command window. The output is |
135 | buffered. It is up to the caller to refresh the screen if | |
136 | necessary. */ | |
137 | ||
138 | static void | |
139 | do_tui_putc (WINDOW *w, char c) | |
140 | { | |
fc96d20b TT |
141 | /* Expand TABs, since ncurses on MS-Windows doesn't. */ |
142 | if (c == '\t') | |
9753a2f6 | 143 | { |
fc96d20b TT |
144 | int col; |
145 | ||
146 | col = getcurx (w); | |
147 | do | |
9753a2f6 | 148 | { |
fc96d20b TT |
149 | waddch (w, ' '); |
150 | col++; | |
9753a2f6 | 151 | } |
fc96d20b | 152 | while ((col % 8) != 0); |
9753a2f6 | 153 | } |
fc96d20b TT |
154 | else |
155 | waddch (w, c); | |
9753a2f6 PA |
156 | } |
157 | ||
158 | /* Update the cached value of the command window's start line based on | |
159 | the window's current Y coordinate. */ | |
160 | ||
161 | static void | |
162 | update_cmdwin_start_line () | |
163 | { | |
7523da63 | 164 | TUI_CMD_WIN->start_line = getcury (TUI_CMD_WIN->handle.get ()); |
9753a2f6 PA |
165 | } |
166 | ||
167 | /* Print a character in the curses command window. The output is | |
168 | buffered. It is up to the caller to refresh the screen if | |
169 | necessary. */ | |
170 | ||
8cee930b SC |
171 | static void |
172 | tui_putc (char c) | |
173 | { | |
7523da63 | 174 | do_tui_putc (TUI_CMD_WIN->handle.get (), c); |
9753a2f6 | 175 | update_cmdwin_start_line (); |
8cee930b | 176 | } |
c906108c | 177 | |
1d1d0bf7 TT |
178 | /* This maps colors to their corresponding color index. */ |
179 | ||
180 | static std::map<ui_file_style::color, int> color_map; | |
181 | ||
182 | /* This holds a pair of colors and is used to track the mapping | |
183 | between a color pair index and the actual colors. */ | |
184 | ||
185 | struct color_pair | |
186 | { | |
187 | int fg; | |
188 | int bg; | |
189 | ||
190 | bool operator< (const color_pair &o) const | |
191 | { | |
192 | return fg < o.fg || (fg == o.fg && bg < o.bg); | |
193 | } | |
194 | }; | |
195 | ||
196 | /* This maps pairs of colors to their corresponding color pair | |
197 | index. */ | |
198 | ||
199 | static std::map<color_pair, int> color_pair_map; | |
200 | ||
201 | /* This is indexed by ANSI color offset from the base color, and holds | |
202 | the corresponding curses color constant. */ | |
203 | ||
204 | static const int curses_colors[] = { | |
205 | COLOR_BLACK, | |
206 | COLOR_RED, | |
207 | COLOR_GREEN, | |
208 | COLOR_YELLOW, | |
209 | COLOR_BLUE, | |
210 | COLOR_MAGENTA, | |
211 | COLOR_CYAN, | |
212 | COLOR_WHITE | |
213 | }; | |
214 | ||
215 | /* Given a color, find its index. */ | |
216 | ||
217 | static bool | |
218 | get_color (const ui_file_style::color &color, int *result) | |
219 | { | |
220 | if (color.is_none ()) | |
221 | *result = -1; | |
222 | else if (color.is_basic ()) | |
223 | *result = curses_colors[color.get_value ()]; | |
224 | else | |
225 | { | |
226 | auto it = color_map.find (color); | |
227 | if (it == color_map.end ()) | |
228 | { | |
229 | /* The first 8 colors are standard. */ | |
230 | int next = color_map.size () + 8; | |
231 | if (next >= COLORS) | |
232 | return false; | |
233 | uint8_t rgb[3]; | |
234 | color.get_rgb (rgb); | |
235 | /* We store RGB as 0..255, but curses wants 0..1000. */ | |
236 | if (init_color (next, rgb[0] * 1000 / 255, rgb[1] * 1000 / 255, | |
237 | rgb[2] * 1000 / 255) == ERR) | |
238 | return false; | |
239 | color_map[color] = next; | |
240 | *result = next; | |
241 | } | |
242 | else | |
243 | *result = it->second; | |
244 | } | |
245 | return true; | |
246 | } | |
247 | ||
248 | /* The most recently emitted color pair. */ | |
249 | ||
250 | static int last_color_pair = -1; | |
251 | ||
252 | /* The most recently applied style. */ | |
253 | ||
254 | static ui_file_style last_style; | |
255 | ||
55c10aca PA |
256 | /* If true, we're highlighting the current source line in reverse |
257 | video mode. */ | |
258 | static bool reverse_mode_p = false; | |
259 | ||
260 | /* The background/foreground colors before we entered reverse | |
261 | mode. */ | |
262 | static ui_file_style::color reverse_save_bg (ui_file_style::NONE); | |
263 | static ui_file_style::color reverse_save_fg (ui_file_style::NONE); | |
264 | ||
1d1d0bf7 TT |
265 | /* Given two colors, return their color pair index; making a new one |
266 | if necessary. */ | |
267 | ||
268 | static int | |
269 | get_color_pair (int fg, int bg) | |
270 | { | |
271 | color_pair c = { fg, bg }; | |
272 | auto it = color_pair_map.find (c); | |
273 | if (it == color_pair_map.end ()) | |
274 | { | |
275 | /* Color pair 0 is our default color, so new colors start at | |
276 | 1. */ | |
277 | int next = color_pair_map.size () + 1; | |
278 | /* Curses has a limited number of available color pairs. Fall | |
279 | back to the default if we've used too many. */ | |
280 | if (next >= COLOR_PAIRS) | |
281 | return 0; | |
282 | init_pair (next, fg, bg); | |
283 | color_pair_map[c] = next; | |
284 | return next; | |
285 | } | |
286 | return it->second; | |
287 | } | |
288 | ||
55c10aca | 289 | /* Apply STYLE to W. */ |
1d1d0bf7 | 290 | |
a2a7af0c TT |
291 | void |
292 | tui_apply_style (WINDOW *w, ui_file_style style) | |
1d1d0bf7 | 293 | { |
1d1d0bf7 TT |
294 | /* Reset. */ |
295 | wattron (w, A_NORMAL); | |
296 | wattroff (w, A_BOLD); | |
297 | wattroff (w, A_DIM); | |
298 | wattroff (w, A_REVERSE); | |
299 | if (last_color_pair != -1) | |
300 | wattroff (w, COLOR_PAIR (last_color_pair)); | |
301 | wattron (w, COLOR_PAIR (0)); | |
302 | ||
303 | const ui_file_style::color &fg = style.get_foreground (); | |
304 | const ui_file_style::color &bg = style.get_background (); | |
305 | if (!fg.is_none () || !bg.is_none ()) | |
306 | { | |
307 | int fgi, bgi; | |
308 | if (get_color (fg, &fgi) && get_color (bg, &bgi)) | |
309 | { | |
3fff2c37 EZ |
310 | #ifdef __MINGW32__ |
311 | /* MS-Windows port of ncurses doesn't support implicit | |
312 | default foreground and background colors, so we must | |
313 | specify them explicitly when needed, using the colors we | |
314 | saw at startup. */ | |
315 | if (fgi == -1) | |
316 | fgi = ncurses_norm_attr & 15; | |
317 | if (bgi == -1) | |
318 | bgi = (ncurses_norm_attr >> 4) & 15; | |
319 | #endif | |
1d1d0bf7 TT |
320 | int pair = get_color_pair (fgi, bgi); |
321 | if (last_color_pair != -1) | |
322 | wattroff (w, COLOR_PAIR (last_color_pair)); | |
323 | wattron (w, COLOR_PAIR (pair)); | |
324 | last_color_pair = pair; | |
325 | } | |
326 | } | |
327 | ||
328 | switch (style.get_intensity ()) | |
329 | { | |
330 | case ui_file_style::NORMAL: | |
331 | break; | |
332 | ||
333 | case ui_file_style::BOLD: | |
334 | wattron (w, A_BOLD); | |
335 | break; | |
336 | ||
337 | case ui_file_style::DIM: | |
338 | wattron (w, A_DIM); | |
339 | break; | |
340 | ||
341 | default: | |
342 | gdb_assert_not_reached ("invalid intensity"); | |
343 | } | |
344 | ||
345 | if (style.is_reverse ()) | |
346 | wattron (w, A_REVERSE); | |
347 | ||
348 | last_style = style; | |
55c10aca PA |
349 | } |
350 | ||
351 | /* Apply an ANSI escape sequence from BUF to W. BUF must start with | |
352 | the ESC character. If BUF does not start with an ANSI escape, | |
353 | return 0. Otherwise, apply the sequence if it is recognized, or | |
354 | simply ignore it if not. In this case, the number of bytes read | |
355 | from BUF is returned. */ | |
356 | ||
357 | static size_t | |
358 | apply_ansi_escape (WINDOW *w, const char *buf) | |
359 | { | |
360 | ui_file_style style = last_style; | |
361 | size_t n_read; | |
362 | ||
363 | if (!style.parse (buf, &n_read)) | |
364 | return n_read; | |
365 | ||
366 | if (reverse_mode_p) | |
367 | { | |
368 | /* We want to reverse _only_ the default foreground/background | |
369 | colors. If the foreground color is not the default (because | |
370 | the text was styled), we want to leave it as is. If e.g., | |
371 | the terminal is fg=BLACK, and bg=WHITE, and the style wants | |
372 | to print text in RED, we want to reverse the background color | |
373 | (print in BLACK), but still print the text in RED. To do | |
374 | that, we enable the A_REVERSE attribute, and re-reverse the | |
375 | parsed-style's fb/bg colors. | |
376 | ||
377 | Notes on the approach: | |
378 | ||
379 | - there's no portable way to know which colors the default | |
380 | fb/bg colors map to. | |
381 | ||
382 | - this approach does the right thing even if you change the | |
383 | terminal colors while GDB is running -- the reversed | |
384 | colors automatically adapt. | |
385 | */ | |
386 | if (!style.is_default ()) | |
387 | { | |
388 | ui_file_style::color bg = style.get_background (); | |
389 | ui_file_style::color fg = style.get_foreground (); | |
390 | style.set_fg (bg); | |
391 | style.set_bg (fg); | |
392 | } | |
393 | ||
394 | /* Enable A_REVERSE. */ | |
395 | style.set_reverse (true); | |
396 | } | |
397 | ||
a2a7af0c | 398 | tui_apply_style (w, style); |
1d1d0bf7 TT |
399 | return n_read; |
400 | } | |
401 | ||
55c10aca PA |
402 | /* See tui.io.h. */ |
403 | ||
404 | void | |
405 | tui_set_reverse_mode (WINDOW *w, bool reverse) | |
406 | { | |
407 | ui_file_style style = last_style; | |
408 | ||
409 | reverse_mode_p = reverse; | |
410 | style.set_reverse (reverse); | |
411 | ||
412 | if (reverse) | |
413 | { | |
414 | reverse_save_bg = style.get_background (); | |
415 | reverse_save_fg = style.get_foreground (); | |
416 | } | |
417 | else | |
418 | { | |
419 | style.set_bg (reverse_save_bg); | |
420 | style.set_fg (reverse_save_fg); | |
421 | } | |
422 | ||
a2a7af0c | 423 | tui_apply_style (w, style); |
55c10aca PA |
424 | } |
425 | ||
9753a2f6 PA |
426 | /* Print LENGTH characters from the buffer pointed to by BUF to the |
427 | curses command window. The output is buffered. It is up to the | |
428 | caller to refresh the screen if necessary. */ | |
429 | ||
430 | void | |
431 | tui_write (const char *buf, size_t length) | |
1d1d0bf7 TT |
432 | { |
433 | /* We need this to be \0-terminated for the regexp matching. */ | |
434 | std::string copy (buf, length); | |
435 | tui_puts (copy.c_str ()); | |
436 | } | |
437 | ||
2c72d5e5 TT |
438 | /* Print a string in the curses command window. The output is |
439 | buffered. It is up to the caller to refresh the screen if | |
440 | necessary. */ | |
441 | ||
442 | void | |
443 | tui_puts (const char *string, WINDOW *w) | |
444 | { | |
445 | if (w == nullptr) | |
446 | w = TUI_CMD_WIN->handle.get (); | |
447 | ||
448 | while (true) | |
449 | { | |
450 | const char *next = strpbrk (string, "\n\1\2\033\t"); | |
451 | ||
452 | /* Print the plain text prefix. */ | |
453 | size_t n_chars = next == nullptr ? strlen (string) : next - string; | |
454 | if (n_chars > 0) | |
455 | waddnstr (w, string, n_chars); | |
456 | ||
457 | /* We finished. */ | |
458 | if (next == nullptr) | |
459 | break; | |
460 | ||
461 | char c = *next; | |
462 | switch (c) | |
463 | { | |
464 | case '\1': | |
465 | case '\2': | |
466 | /* Ignore these, they are readline escape-marking | |
467 | sequences. */ | |
468 | ++next; | |
469 | break; | |
470 | ||
471 | case '\n': | |
472 | case '\t': | |
473 | do_tui_putc (w, c); | |
474 | ++next; | |
475 | break; | |
476 | ||
477 | case '\033': | |
478 | { | |
479 | size_t bytes_read = apply_ansi_escape (w, next); | |
480 | if (bytes_read > 0) | |
481 | next += bytes_read; | |
482 | else | |
483 | { | |
484 | /* Just drop the escape. */ | |
485 | ++next; | |
486 | } | |
487 | } | |
488 | break; | |
489 | ||
490 | default: | |
491 | gdb_assert_not_reached ("missing case in tui_puts"); | |
492 | } | |
493 | ||
494 | string = next; | |
495 | } | |
496 | ||
497 | if (TUI_CMD_WIN != nullptr && w == TUI_CMD_WIN->handle.get ()) | |
498 | update_cmdwin_start_line (); | |
499 | } | |
500 | ||
1d1d0bf7 | 501 | static void |
62f29fda | 502 | tui_puts_internal (WINDOW *w, const char *string, int *height) |
9753a2f6 | 503 | { |
1d1d0bf7 TT |
504 | char c; |
505 | int prev_col = 0; | |
88b7e7cc | 506 | bool saw_nl = false; |
9753a2f6 | 507 | |
1d1d0bf7 TT |
508 | while ((c = *string++) != 0) |
509 | { | |
88b7e7cc TT |
510 | if (c == '\n') |
511 | saw_nl = true; | |
512 | ||
1d1d0bf7 TT |
513 | if (c == '\1' || c == '\2') |
514 | { | |
515 | /* Ignore these, they are readline escape-marking | |
516 | sequences. */ | |
517 | } | |
518 | else | |
519 | { | |
520 | if (c == '\033') | |
521 | { | |
522 | size_t bytes_read = apply_ansi_escape (w, string - 1); | |
523 | if (bytes_read > 0) | |
524 | { | |
525 | string = string + bytes_read - 1; | |
526 | continue; | |
527 | } | |
528 | } | |
529 | do_tui_putc (w, c); | |
530 | ||
531 | if (height != nullptr) | |
532 | { | |
533 | int col = getcurx (w); | |
534 | if (col <= prev_col) | |
535 | ++*height; | |
536 | prev_col = col; | |
537 | } | |
538 | } | |
539 | } | |
7523da63 | 540 | if (TUI_CMD_WIN != nullptr && w == TUI_CMD_WIN->handle.get ()) |
3df505f6 | 541 | update_cmdwin_start_line (); |
88b7e7cc TT |
542 | if (saw_nl) |
543 | wrefresh (w); | |
9753a2f6 PA |
544 | } |
545 | ||
a198b876 SC |
546 | /* Readline callback. |
547 | Redisplay the command line with its prompt after readline has | |
548 | changed the edited text. */ | |
e09d2eba | 549 | void |
a198b876 SC |
550 | tui_redisplay_readline (void) |
551 | { | |
552 | int prev_col; | |
553 | int height; | |
cecc8b99 | 554 | int col; |
a198b876 SC |
555 | int c_pos; |
556 | int c_line; | |
557 | int in; | |
558 | WINDOW *w; | |
e6a959d6 | 559 | const char *prompt; |
a198b876 | 560 | int start_line; |
e3da6fc5 SC |
561 | |
562 | /* Detect when we temporarily left SingleKey and now the readline | |
1cc6d956 | 563 | edit buffer is empty, automatically restore the SingleKey |
9b8d6827 SC |
564 | mode. The restore must only be done if the command has finished. |
565 | The command could call prompt_for_continue and we must not | |
566 | restore SingleKey so that the prompt and normal keymap are used. */ | |
567 | if (tui_current_key_mode == TUI_ONE_COMMAND_MODE && rl_end == 0 | |
dbf30ca3 | 568 | && !gdb_in_secondary_prompt_p (current_ui)) |
6d012f14 | 569 | tui_set_key_mode (TUI_SINGLE_KEY_MODE); |
e3da6fc5 | 570 | |
6d012f14 | 571 | if (tui_current_key_mode == TUI_SINGLE_KEY_MODE) |
e09d2eba SC |
572 | prompt = ""; |
573 | else | |
364d7104 | 574 | prompt = rl_display_prompt; |
a198b876 SC |
575 | |
576 | c_pos = -1; | |
577 | c_line = -1; | |
7523da63 | 578 | w = TUI_CMD_WIN->handle.get (); |
81491aa0 | 579 | start_line = TUI_CMD_WIN->start_line; |
a198b876 SC |
580 | wmove (w, start_line, 0); |
581 | prev_col = 0; | |
582 | height = 1; | |
1d1d0bf7 | 583 | if (prompt != nullptr) |
7523da63 | 584 | tui_puts_internal (w, prompt, &height); |
1d1d0bf7 TT |
585 | |
586 | prev_col = getcurx (w); | |
588dcc3e | 587 | for (in = 0; in <= rl_end; in++) |
a198b876 SC |
588 | { |
589 | unsigned char c; | |
590 | ||
a198b876 SC |
591 | if (in == rl_point) |
592 | { | |
593 | getyx (w, c_line, c_pos); | |
594 | } | |
595 | ||
588dcc3e PP |
596 | if (in == rl_end) |
597 | break; | |
598 | ||
599 | c = (unsigned char) rl_line_buffer[in]; | |
a198b876 SC |
600 | if (CTRL_CHAR (c) || c == RUBOUT) |
601 | { | |
602 | waddch (w, '^'); | |
603 | waddch (w, CTRL_CHAR (c) ? UNCTRL (c) : '?'); | |
604 | } | |
312809f8 EZ |
605 | else if (c == '\t') |
606 | { | |
607 | /* Expand TABs, since ncurses on MS-Windows doesn't. */ | |
cecc8b99 | 608 | col = getcurx (w); |
312809f8 EZ |
609 | do |
610 | { | |
611 | waddch (w, ' '); | |
612 | col++; | |
613 | } while ((col % 8) != 0); | |
614 | } | |
c906108c SS |
615 | else |
616 | { | |
a198b876 | 617 | waddch (w, c); |
c906108c | 618 | } |
a198b876 | 619 | if (c == '\n') |
81491aa0 | 620 | TUI_CMD_WIN->start_line = getcury (w); |
cecc8b99 | 621 | col = getcurx (w); |
a198b876 SC |
622 | if (col < prev_col) |
623 | height++; | |
624 | prev_col = col; | |
c906108c | 625 | } |
a198b876 | 626 | wclrtobot (w); |
81491aa0 | 627 | TUI_CMD_WIN->start_line = getcury (w); |
a198b876 | 628 | if (c_line >= 0) |
6f1cb6ea | 629 | wmove (w, c_line, c_pos); |
81491aa0 | 630 | TUI_CMD_WIN->start_line -= height - 1; |
a198b876 | 631 | |
a198b876 SC |
632 | wrefresh (w); |
633 | fflush(stdout); | |
634 | } | |
635 | ||
1cc6d956 MS |
636 | /* Readline callback to prepare the terminal. It is called once each |
637 | time we enter readline. Terminal is already setup in curses | |
638 | mode. */ | |
a198b876 | 639 | static void |
88fa91b4 | 640 | tui_prep_terminal (int notused1) |
c906108c | 641 | { |
a198b876 | 642 | } |
c906108c | 643 | |
1cc6d956 MS |
644 | /* Readline callback to restore the terminal. It is called once each |
645 | time we leave readline. There is nothing to do in curses mode. */ | |
a198b876 SC |
646 | static void |
647 | tui_deprep_terminal (void) | |
648 | { | |
649 | } | |
c906108c | 650 | |
8cee930b | 651 | #ifdef TUI_USE_PIPE_FOR_READLINE |
a198b876 SC |
652 | /* Read readline output pipe and feed the command window with it. |
653 | Should be removed when readline is clean. */ | |
654 | static void | |
01f69b38 | 655 | tui_readline_output (int error, gdb_client_data data) |
a198b876 SC |
656 | { |
657 | int size; | |
658 | char buf[256]; | |
c906108c | 659 | |
a198b876 SC |
660 | size = read (tui_readline_pipe[0], buf, sizeof (buf) - 1); |
661 | if (size > 0 && tui_active) | |
c906108c | 662 | { |
a198b876 SC |
663 | buf[size] = 0; |
664 | tui_puts (buf); | |
c906108c | 665 | } |
a198b876 | 666 | } |
8cee930b SC |
667 | #endif |
668 | ||
82083d6d | 669 | /* TUI version of displayer.crlf. */ |
8cee930b | 670 | |
82083d6d DE |
671 | static void |
672 | tui_mld_crlf (const struct match_list_displayer *displayer) | |
8cee930b | 673 | { |
82083d6d | 674 | tui_putc ('\n'); |
8cee930b SC |
675 | } |
676 | ||
82083d6d | 677 | /* TUI version of displayer.putch. */ |
8cee930b | 678 | |
82083d6d DE |
679 | static void |
680 | tui_mld_putch (const struct match_list_displayer *displayer, int ch) | |
8cee930b | 681 | { |
82083d6d | 682 | tui_putc (ch); |
8cee930b SC |
683 | } |
684 | ||
82083d6d DE |
685 | /* TUI version of displayer.puts. */ |
686 | ||
687 | static void | |
688 | tui_mld_puts (const struct match_list_displayer *displayer, const char *s) | |
8cee930b | 689 | { |
82083d6d DE |
690 | tui_puts (s); |
691 | } | |
8cee930b | 692 | |
82083d6d DE |
693 | /* TUI version of displayer.flush. */ |
694 | ||
695 | static void | |
696 | tui_mld_flush (const struct match_list_displayer *displayer) | |
697 | { | |
7523da63 | 698 | wrefresh (TUI_CMD_WIN->handle.get ()); |
8cee930b SC |
699 | } |
700 | ||
82083d6d | 701 | /* TUI version of displayer.erase_entire_line. */ |
8cee930b | 702 | |
8cee930b | 703 | static void |
82083d6d | 704 | tui_mld_erase_entire_line (const struct match_list_displayer *displayer) |
8cee930b | 705 | { |
7523da63 | 706 | WINDOW *w = TUI_CMD_WIN->handle.get (); |
6f1cb6ea | 707 | int cur_y = getcury (w); |
8cee930b | 708 | |
6f1cb6ea | 709 | wmove (w, cur_y, 0); |
82083d6d | 710 | wclrtoeol (w); |
6f1cb6ea | 711 | wmove (w, cur_y, 0); |
82083d6d | 712 | } |
8cee930b | 713 | |
82083d6d | 714 | /* TUI version of displayer.beep. */ |
8cee930b | 715 | |
82083d6d DE |
716 | static void |
717 | tui_mld_beep (const struct match_list_displayer *displayer) | |
718 | { | |
719 | beep (); | |
720 | } | |
721 | ||
7a956928 TT |
722 | /* A wrapper for wgetch that enters nonl mode. We We normally want |
723 | curses' "nl" mode, but when reading from the user, we'd like to | |
724 | differentiate between C-j and C-m, because some users bind these | |
725 | keys differently in their .inputrc. So, put curses into nonl mode | |
726 | just when reading from the user. See PR tui/20819. */ | |
727 | ||
728 | static int | |
729 | gdb_wgetch (WINDOW *win) | |
730 | { | |
731 | nonl (); | |
732 | int r = wgetch (win); | |
733 | nl (); | |
734 | return r; | |
735 | } | |
736 | ||
82083d6d DE |
737 | /* Helper function for tui_mld_read_key. |
738 | This temporarily replaces tui_getc for use during tab-completion | |
739 | match list display. */ | |
740 | ||
741 | static int | |
742 | tui_mld_getc (FILE *fp) | |
743 | { | |
7523da63 | 744 | WINDOW *w = TUI_CMD_WIN->handle.get (); |
7a956928 | 745 | int c = gdb_wgetch (w); |
8cee930b | 746 | |
82083d6d DE |
747 | return c; |
748 | } | |
8cee930b | 749 | |
82083d6d | 750 | /* TUI version of displayer.read_key. */ |
8cee930b | 751 | |
82083d6d DE |
752 | static int |
753 | tui_mld_read_key (const struct match_list_displayer *displayer) | |
754 | { | |
755 | rl_getc_func_t *prev = rl_getc_function; | |
756 | int c; | |
8cee930b | 757 | |
82083d6d DE |
758 | /* We can't use tui_getc as we need NEWLINE to not get emitted. */ |
759 | rl_getc_function = tui_mld_getc; | |
760 | c = rl_read_key (); | |
761 | rl_getc_function = prev; | |
762 | return c; | |
763 | } | |
8cee930b | 764 | |
82083d6d DE |
765 | /* TUI version of rl_completion_display_matches_hook. |
766 | See gdb_display_match_list for a description of the arguments. */ | |
8cee930b | 767 | |
82083d6d DE |
768 | static void |
769 | tui_rl_display_match_list (char **matches, int len, int max) | |
770 | { | |
771 | struct match_list_displayer displayer; | |
772 | ||
773 | rl_get_screen_size (&displayer.height, &displayer.width); | |
774 | displayer.crlf = tui_mld_crlf; | |
775 | displayer.putch = tui_mld_putch; | |
776 | displayer.puts = tui_mld_puts; | |
777 | displayer.flush = tui_mld_flush; | |
778 | displayer.erase_entire_line = tui_mld_erase_entire_line; | |
779 | displayer.beep = tui_mld_beep; | |
780 | displayer.read_key = tui_mld_read_key; | |
781 | ||
782 | gdb_display_match_list (matches, len, max, &displayer); | |
8cee930b | 783 | } |
a198b876 SC |
784 | |
785 | /* Setup the IO for curses or non-curses mode. | |
786 | - In non-curses mode, readline and gdb use the standard input and | |
787 | standard output/error directly. | |
788 | - In curses mode, the standard output/error is controlled by TUI | |
789 | with the tui_stdout and tui_stderr. The output is redirected in | |
790 | the curses command window. Several readline callbacks are installed | |
791 | so that readline asks for its input to the curses command window | |
792 | with wgetch(). */ | |
793 | void | |
794 | tui_setup_io (int mode) | |
795 | { | |
cc88a640 JK |
796 | extern int _rl_echoing_p; |
797 | ||
a198b876 | 798 | if (mode) |
c906108c | 799 | { |
a350efd4 TT |
800 | /* Ensure that readline has been initialized before saving any |
801 | of its variables. */ | |
802 | tui_ensure_readline_initialized (); | |
803 | ||
a198b876 SC |
804 | /* Redirect readline to TUI. */ |
805 | tui_old_rl_redisplay_function = rl_redisplay_function; | |
806 | tui_old_rl_deprep_terminal = rl_deprep_term_function; | |
807 | tui_old_rl_prep_terminal = rl_prep_term_function; | |
808 | tui_old_rl_getc_function = rl_getc_function; | |
ef0b411a | 809 | tui_old_rl_display_matches_hook = rl_completion_display_matches_hook; |
a198b876 | 810 | tui_old_rl_outstream = rl_outstream; |
cc88a640 | 811 | tui_old_rl_echoing_p = _rl_echoing_p; |
a198b876 SC |
812 | rl_redisplay_function = tui_redisplay_readline; |
813 | rl_deprep_term_function = tui_deprep_terminal; | |
814 | rl_prep_term_function = tui_prep_terminal; | |
815 | rl_getc_function = tui_getc; | |
cc88a640 | 816 | _rl_echoing_p = 0; |
a198b876 SC |
817 | rl_outstream = tui_rl_outstream; |
818 | rl_prompt = 0; | |
8cee930b SC |
819 | rl_completion_display_matches_hook = tui_rl_display_match_list; |
820 | rl_already_prompted = 0; | |
a198b876 SC |
821 | |
822 | /* Keep track of previous gdb output. */ | |
823 | tui_old_stdout = gdb_stdout; | |
824 | tui_old_stderr = gdb_stderr; | |
112e8700 SM |
825 | tui_old_uiout = dynamic_cast<cli_ui_out *> (current_uiout); |
826 | gdb_assert (tui_old_uiout != nullptr); | |
a198b876 SC |
827 | |
828 | /* Reconfigure gdb output. */ | |
829 | gdb_stdout = tui_stdout; | |
830 | gdb_stderr = tui_stderr; | |
831 | gdb_stdlog = gdb_stdout; /* for moment */ | |
832 | gdb_stdtarg = gdb_stderr; /* for moment */ | |
8d4d924b | 833 | gdb_stdtargerr = gdb_stderr; /* for moment */ |
79a45e25 | 834 | current_uiout = tui_out; |
9d876a16 SC |
835 | |
836 | /* Save tty for SIGCONT. */ | |
837 | savetty (); | |
c906108c | 838 | } |
a198b876 | 839 | else |
c906108c | 840 | { |
a198b876 SC |
841 | /* Restore gdb output. */ |
842 | gdb_stdout = tui_old_stdout; | |
843 | gdb_stderr = tui_old_stderr; | |
844 | gdb_stdlog = gdb_stdout; /* for moment */ | |
845 | gdb_stdtarg = gdb_stderr; /* for moment */ | |
8d4d924b | 846 | gdb_stdtargerr = gdb_stderr; /* for moment */ |
79a45e25 | 847 | current_uiout = tui_old_uiout; |
a198b876 SC |
848 | |
849 | /* Restore readline. */ | |
850 | rl_redisplay_function = tui_old_rl_redisplay_function; | |
851 | rl_deprep_term_function = tui_old_rl_deprep_terminal; | |
852 | rl_prep_term_function = tui_old_rl_prep_terminal; | |
853 | rl_getc_function = tui_old_rl_getc_function; | |
ef0b411a | 854 | rl_completion_display_matches_hook = tui_old_rl_display_matches_hook; |
a198b876 | 855 | rl_outstream = tui_old_rl_outstream; |
cc88a640 | 856 | _rl_echoing_p = tui_old_rl_echoing_p; |
bd9b0abf | 857 | rl_already_prompted = 0; |
9d876a16 SC |
858 | |
859 | /* Save tty for SIGCONT. */ | |
860 | savetty (); | |
1d1d0bf7 TT |
861 | |
862 | /* Clean up color information. */ | |
863 | last_color_pair = -1; | |
864 | last_style = ui_file_style (); | |
865 | color_map.clear (); | |
866 | color_pair_map.clear (); | |
9d876a16 SC |
867 | } |
868 | } | |
869 | ||
870 | #ifdef SIGCONT | |
871 | /* Catch SIGCONT to restore the terminal and refresh the screen. */ | |
872 | static void | |
873 | tui_cont_sig (int sig) | |
874 | { | |
875 | if (tui_active) | |
876 | { | |
877 | /* Restore the terminal setting because another process (shell) | |
878 | might have changed it. */ | |
879 | resetty (); | |
880 | ||
881 | /* Force a refresh of the screen. */ | |
a21fcd8f | 882 | tui_refresh_all_win (); |
c906108c | 883 | } |
9d876a16 | 884 | signal (sig, tui_cont_sig); |
a198b876 | 885 | } |
9d876a16 | 886 | #endif |
c906108c | 887 | |
a198b876 SC |
888 | /* Initialize the IO for gdb in curses mode. */ |
889 | void | |
d02c80cd | 890 | tui_initialize_io (void) |
a198b876 | 891 | { |
9d876a16 SC |
892 | #ifdef SIGCONT |
893 | signal (SIGCONT, tui_cont_sig); | |
894 | #endif | |
895 | ||
a198b876 | 896 | /* Create tui output streams. */ |
d7e74731 PA |
897 | tui_stdout = new tui_file (stdout); |
898 | tui_stderr = new tui_file (stderr); | |
a198b876 SC |
899 | tui_out = tui_out_new (tui_stdout); |
900 | ||
43df09d9 | 901 | /* Create the default UI. */ |
4801a9a3 | 902 | tui_old_uiout = cli_out_new (gdb_stdout); |
a198b876 | 903 | |
8cee930b | 904 | #ifdef TUI_USE_PIPE_FOR_READLINE |
1cc6d956 MS |
905 | /* Temporary solution for readline writing to stdout: redirect |
906 | readline output in a pipe, read that pipe and output the content | |
907 | in the curses command window. */ | |
614c279d | 908 | if (gdb_pipe_cloexec (tui_readline_pipe) != 0) |
e0e6bcab GB |
909 | error (_("Cannot create pipe for readline")); |
910 | ||
a198b876 SC |
911 | tui_rl_outstream = fdopen (tui_readline_pipe[1], "w"); |
912 | if (tui_rl_outstream == 0) | |
e0e6bcab GB |
913 | error (_("Cannot redirect readline output")); |
914 | ||
cafb3438 | 915 | setvbuf (tui_rl_outstream, NULL, _IOLBF, 0); |
c906108c | 916 | |
a198b876 SC |
917 | #ifdef O_NONBLOCK |
918 | (void) fcntl (tui_readline_pipe[0], F_SETFL, O_NONBLOCK); | |
c906108c | 919 | #else |
a198b876 SC |
920 | #ifdef O_NDELAY |
921 | (void) fcntl (tui_readline_pipe[0], F_SETFL, O_NDELAY); | |
c906108c | 922 | #endif |
a198b876 | 923 | #endif |
a198b876 | 924 | add_file_handler (tui_readline_pipe[0], tui_readline_output, 0); |
8cee930b SC |
925 | #else |
926 | tui_rl_outstream = stdout; | |
927 | #endif | |
3fff2c37 EZ |
928 | |
929 | #ifdef __MINGW32__ | |
930 | /* MS-Windows port of ncurses doesn't support default foreground and | |
931 | background colors, so we must record the default colors at startup. */ | |
932 | HANDLE hstdout = (HANDLE)_get_osfhandle (fileno (stdout)); | |
933 | DWORD cmode; | |
934 | CONSOLE_SCREEN_BUFFER_INFO csbi; | |
935 | ||
936 | if (hstdout != INVALID_HANDLE_VALUE | |
937 | && GetConsoleMode (hstdout, &cmode) != 0 | |
938 | && GetConsoleScreenBufferInfo (hstdout, &csbi)) | |
939 | ncurses_norm_attr = csbi.wAttributes; | |
940 | #endif | |
a198b876 SC |
941 | } |
942 | ||
2d8b51cb TT |
943 | /* Dispatch the correct tui function based upon the control |
944 | character. */ | |
945 | static unsigned int | |
946 | tui_dispatch_ctrl_char (unsigned int ch) | |
947 | { | |
948 | struct tui_win_info *win_info = tui_win_with_focus (); | |
949 | ||
950 | /* Handle the CTRL-L refresh for each window. */ | |
951 | if (ch == '\f') | |
952 | tui_refresh_all_win (); | |
953 | ||
954 | /* If no window has the focus, or if the focus window can't scroll, | |
955 | just pass the character through. */ | |
956 | if (win_info == NULL || !win_info->can_scroll ()) | |
957 | return ch; | |
958 | ||
959 | switch (ch) | |
960 | { | |
961 | case KEY_NPAGE: | |
962 | win_info->forward_scroll (0); | |
963 | break; | |
964 | case KEY_PPAGE: | |
965 | win_info->backward_scroll (0); | |
966 | break; | |
967 | case KEY_DOWN: | |
968 | case KEY_SF: | |
969 | win_info->forward_scroll (1); | |
970 | break; | |
971 | case KEY_UP: | |
972 | case KEY_SR: | |
973 | win_info->backward_scroll (1); | |
974 | break; | |
975 | case KEY_RIGHT: | |
976 | win_info->left_scroll (1); | |
977 | break; | |
978 | case KEY_LEFT: | |
979 | win_info->right_scroll (1); | |
980 | break; | |
981 | case '\f': | |
982 | break; | |
983 | default: | |
984 | /* We didn't recognize the character as a control character, so pass it | |
985 | through. */ | |
986 | return ch; | |
987 | } | |
988 | ||
989 | /* We intercepted the control character, so return 0 (which readline | |
990 | will interpret as a no-op). */ | |
991 | return 0; | |
992 | } | |
993 | ||
2f267673 PA |
994 | /* Main worker for tui_getc. Get a character from the command window. |
995 | This is called from the readline package, but wrapped in a | |
996 | try/catch by tui_getc. */ | |
997 | ||
84371624 | 998 | static int |
2f267673 | 999 | tui_getc_1 (FILE *fp) |
a198b876 SC |
1000 | { |
1001 | int ch; | |
1002 | WINDOW *w; | |
1003 | ||
7523da63 | 1004 | w = TUI_CMD_WIN->handle.get (); |
a198b876 | 1005 | |
8cee930b | 1006 | #ifdef TUI_USE_PIPE_FOR_READLINE |
a198b876 | 1007 | /* Flush readline output. */ |
01f69b38 | 1008 | tui_readline_output (0, 0); |
8cee930b SC |
1009 | #endif |
1010 | ||
7a956928 | 1011 | ch = gdb_wgetch (w); |
c906108c | 1012 | |
1cc6d956 MS |
1013 | /* The \n must be echoed because it will not be printed by |
1014 | readline. */ | |
b17c4cd0 | 1015 | if (ch == '\n' || ch == '\r') |
a198b876 SC |
1016 | { |
1017 | /* When hitting return with an empty input, gdb executes the last | |
1018 | command. If we emit a newline, this fills up the command window | |
1019 | with empty lines with gdb prompt at beginning. Instead of that, | |
1020 | stay on the same line but provide a visual effect to show the | |
1021 | user we recognized the command. */ | |
dbf30ca3 | 1022 | if (rl_end == 0 && !gdb_in_secondary_prompt_p (current_ui)) |
a198b876 | 1023 | { |
6f1cb6ea | 1024 | wmove (w, getcury (w), 0); |
a198b876 SC |
1025 | |
1026 | /* Clear the line. This will blink the gdb prompt since | |
1027 | it will be redrawn at the same line. */ | |
1028 | wclrtoeol (w); | |
1029 | wrefresh (w); | |
1030 | napms (20); | |
1031 | } | |
1032 | else | |
1033 | { | |
d9080678 PP |
1034 | /* Move cursor to the end of the command line before emitting the |
1035 | newline. We need to do so because when ncurses outputs a newline | |
1036 | it truncates any text that appears past the end of the cursor. */ | |
6f1cb6ea PP |
1037 | int px, py; |
1038 | getyx (w, py, px); | |
d9080678 | 1039 | px += rl_end - rl_point; |
cb2ce893 TT |
1040 | py += px / TUI_CMD_WIN->width; |
1041 | px %= TUI_CMD_WIN->width; | |
d9080678 | 1042 | wmove (w, py, px); |
7a8bcb88 | 1043 | tui_putc ('\n'); |
a198b876 SC |
1044 | } |
1045 | } | |
1046 | ||
69efdff1 PP |
1047 | /* Handle prev/next/up/down here. */ |
1048 | ch = tui_dispatch_ctrl_char (ch); | |
a198b876 | 1049 | |
a198b876 SC |
1050 | if (ch == KEY_BACKSPACE) |
1051 | return '\b'; | |
d64e57fa | 1052 | |
3c216924 | 1053 | if (current_ui->command_editing && key_is_start_sequence (ch)) |
d64e57fa PP |
1054 | { |
1055 | int ch_pending; | |
1056 | ||
1057 | nodelay (w, TRUE); | |
7a956928 | 1058 | ch_pending = gdb_wgetch (w); |
d64e57fa PP |
1059 | nodelay (w, FALSE); |
1060 | ||
1061 | /* If we have pending input following a start sequence, call the stdin | |
1062 | event handler again because ncurses may have already read and stored | |
1063 | the input into its internal buffer, meaning that we won't get an stdin | |
1064 | event for it. If we don't compensate for this missed stdin event, key | |
1065 | sequences as Alt_F (^[f) will not behave promptly. | |
1066 | ||
1067 | (We only compensates for the missed 2nd byte of a key sequence because | |
1068 | 2-byte sequences are by far the most commonly used. ncurses may have | |
1069 | buffered a larger, 3+-byte key sequence though it remains to be seen | |
1070 | whether it is useful to compensate for all the bytes of such | |
1071 | sequences.) */ | |
1072 | if (ch_pending != ERR) | |
1073 | { | |
1074 | ungetch (ch_pending); | |
1075 | call_stdin_event_handler_again_p = 1; | |
1076 | } | |
1077 | } | |
1078 | ||
c906108c | 1079 | return ch; |
a198b876 | 1080 | } |
c906108c | 1081 | |
2f267673 PA |
1082 | /* Get a character from the command window. This is called from the |
1083 | readline package. */ | |
1084 | ||
1085 | static int | |
1086 | tui_getc (FILE *fp) | |
1087 | { | |
1088 | try | |
1089 | { | |
1090 | return tui_getc_1 (fp); | |
1091 | } | |
1092 | catch (const gdb_exception &ex) | |
1093 | { | |
1094 | /* Just in case, don't ever let an exception escape to readline. | |
1095 | This shouldn't ever happen, but if it does, print the | |
1096 | exception instead of just crashing GDB. */ | |
1097 | exception_print (gdb_stderr, ex); | |
1098 | ||
1099 | /* If we threw an exception, it's because we recognized the | |
1100 | character. */ | |
1101 | return 0; | |
1102 | } | |
1103 | } |