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