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