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