Truncate long TUI window titles
[deliverable/binutils-gdb.git] / gdb / tui / tui-win.c
1 /* TUI window generic functions.
2
3 Copyright (C) 1998-2019 Free Software Foundation, Inc.
4
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
11 the Free Software Foundation; either version 3 of the License, or
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
20 along with this program. If not, see <http://www.gnu.org/licenses/>. */
21
22 /* This module contains procedures for handling tui window functions
23 like resize, scrolling, scrolling, changing focus, etc.
24
25 Author: Susan B. Macchia */
26
27 #include "defs.h"
28 #include "command.h"
29 #include "symtab.h"
30 #include "breakpoint.h"
31 #include "frame.h"
32 #include "cli/cli-cmds.h"
33 #include "top.h"
34 #include "source.h"
35 #include "event-loop.h"
36
37 #include "tui/tui.h"
38 #include "tui/tui-io.h"
39 #include "tui/tui-command.h"
40 #include "tui/tui-data.h"
41 #include "tui/tui-layout.h"
42 #include "tui/tui-wingeneral.h"
43 #include "tui/tui-stack.h"
44 #include "tui/tui-regs.h"
45 #include "tui/tui-disasm.h"
46 #include "tui/tui-source.h"
47 #include "tui/tui-winsource.h"
48 #include "tui/tui-win.h"
49
50 #include "gdb_curses.h"
51 #include <ctype.h>
52 #include "readline/readline.h"
53
54 #include <signal.h>
55
56 /*******************************
57 ** Static Local Decls
58 ********************************/
59 static enum tui_status tui_adjust_win_heights (struct tui_win_info *,
60 int);
61 static int new_height_ok (struct tui_win_info *, int);
62 static void tui_set_tab_width_command (const char *, int);
63 static void tui_refresh_all_command (const char *, int);
64 static void tui_all_windows_info (const char *, int);
65 static void tui_scroll_forward_command (const char *, int);
66 static void tui_scroll_backward_command (const char *, int);
67 static void tui_scroll_left_command (const char *, int);
68 static void tui_scroll_right_command (const char *, int);
69 static void parse_scrolling_args (const char *,
70 struct tui_win_info **,
71 int *);
72
73
74 /***************************************
75 ** DEFINITIONS
76 ***************************************/
77 #define WIN_HEIGHT_USAGE "Usage: winheight WINDOW-NAME [+ | -] NUM-LINES\n"
78 #define FOCUS_USAGE "Usage: focus [WINDOW-NAME | next | prev]\n"
79
80 /***************************************
81 ** PUBLIC FUNCTIONS
82 ***************************************/
83
84 #ifndef ACS_LRCORNER
85 # define ACS_LRCORNER '+'
86 #endif
87 #ifndef ACS_LLCORNER
88 # define ACS_LLCORNER '+'
89 #endif
90 #ifndef ACS_ULCORNER
91 # define ACS_ULCORNER '+'
92 #endif
93 #ifndef ACS_URCORNER
94 # define ACS_URCORNER '+'
95 #endif
96 #ifndef ACS_HLINE
97 # define ACS_HLINE '-'
98 #endif
99 #ifndef ACS_VLINE
100 # define ACS_VLINE '|'
101 #endif
102
103 /* Possible values for tui-border-kind variable. */
104 static const char *const tui_border_kind_enums[] = {
105 "space",
106 "ascii",
107 "acs",
108 NULL
109 };
110
111 /* Possible values for tui-border-mode and tui-active-border-mode. */
112 static const char *const tui_border_mode_enums[] = {
113 "normal",
114 "standout",
115 "reverse",
116 "half",
117 "half-standout",
118 "bold",
119 "bold-standout",
120 NULL
121 };
122
123 struct tui_translate
124 {
125 const char *name;
126 int value;
127 };
128
129 /* Translation table for border-mode variables.
130 The list of values must be terminated by a NULL.
131 After the NULL value, an entry defines the default. */
132 struct tui_translate tui_border_mode_translate[] = {
133 { "normal", A_NORMAL },
134 { "standout", A_STANDOUT },
135 { "reverse", A_REVERSE },
136 { "half", A_DIM },
137 { "half-standout", A_DIM | A_STANDOUT },
138 { "bold", A_BOLD },
139 { "bold-standout", A_BOLD | A_STANDOUT },
140 { 0, 0 },
141 { "normal", A_NORMAL }
142 };
143
144 /* Translation tables for border-kind, one for each border
145 character (see wborder, border curses operations).
146 -1 is used to indicate the ACS because ACS characters
147 are determined at run time by curses (depends on terminal). */
148 struct tui_translate tui_border_kind_translate_vline[] = {
149 { "space", ' ' },
150 { "ascii", '|' },
151 { "acs", -1 },
152 { 0, 0 },
153 { "ascii", '|' }
154 };
155
156 struct tui_translate tui_border_kind_translate_hline[] = {
157 { "space", ' ' },
158 { "ascii", '-' },
159 { "acs", -1 },
160 { 0, 0 },
161 { "ascii", '-' }
162 };
163
164 struct tui_translate tui_border_kind_translate_ulcorner[] = {
165 { "space", ' ' },
166 { "ascii", '+' },
167 { "acs", -1 },
168 { 0, 0 },
169 { "ascii", '+' }
170 };
171
172 struct tui_translate tui_border_kind_translate_urcorner[] = {
173 { "space", ' ' },
174 { "ascii", '+' },
175 { "acs", -1 },
176 { 0, 0 },
177 { "ascii", '+' }
178 };
179
180 struct tui_translate tui_border_kind_translate_llcorner[] = {
181 { "space", ' ' },
182 { "ascii", '+' },
183 { "acs", -1 },
184 { 0, 0 },
185 { "ascii", '+' }
186 };
187
188 struct tui_translate tui_border_kind_translate_lrcorner[] = {
189 { "space", ' ' },
190 { "ascii", '+' },
191 { "acs", -1 },
192 { 0, 0 },
193 { "ascii", '+' }
194 };
195
196
197 /* Tui configuration variables controlled with set/show command. */
198 const char *tui_active_border_mode = "bold-standout";
199 static void
200 show_tui_active_border_mode (struct ui_file *file,
201 int from_tty,
202 struct cmd_list_element *c,
203 const char *value)
204 {
205 fprintf_filtered (file, _("\
206 The attribute mode to use for the active TUI window border is \"%s\".\n"),
207 value);
208 }
209
210 const char *tui_border_mode = "normal";
211 static void
212 show_tui_border_mode (struct ui_file *file,
213 int from_tty,
214 struct cmd_list_element *c,
215 const char *value)
216 {
217 fprintf_filtered (file, _("\
218 The attribute mode to use for the TUI window borders is \"%s\".\n"),
219 value);
220 }
221
222 const char *tui_border_kind = "acs";
223 static void
224 show_tui_border_kind (struct ui_file *file,
225 int from_tty,
226 struct cmd_list_element *c,
227 const char *value)
228 {
229 fprintf_filtered (file, _("The kind of border for TUI windows is \"%s\".\n"),
230 value);
231 }
232
233
234 /* Tui internal configuration variables. These variables are updated
235 by tui_update_variables to reflect the tui configuration
236 variables. */
237 chtype tui_border_vline;
238 chtype tui_border_hline;
239 chtype tui_border_ulcorner;
240 chtype tui_border_urcorner;
241 chtype tui_border_llcorner;
242 chtype tui_border_lrcorner;
243
244 int tui_border_attrs;
245 int tui_active_border_attrs;
246
247 /* Identify the item in the translation table.
248 When the item is not recognized, use the default entry. */
249 static struct tui_translate *
250 translate (const char *name, struct tui_translate *table)
251 {
252 while (table->name)
253 {
254 if (name && strcmp (table->name, name) == 0)
255 return table;
256 table++;
257 }
258
259 /* Not found, return default entry. */
260 table++;
261 return table;
262 }
263
264 /* Update the tui internal configuration according to gdb settings.
265 Returns 1 if the configuration has changed and the screen should
266 be redrawn. */
267 int
268 tui_update_variables (void)
269 {
270 int need_redraw = 0;
271 struct tui_translate *entry;
272
273 entry = translate (tui_border_mode, tui_border_mode_translate);
274 if (tui_border_attrs != entry->value)
275 {
276 tui_border_attrs = entry->value;
277 need_redraw = 1;
278 }
279 entry = translate (tui_active_border_mode, tui_border_mode_translate);
280 if (tui_active_border_attrs != entry->value)
281 {
282 tui_active_border_attrs = entry->value;
283 need_redraw = 1;
284 }
285
286 /* If one corner changes, all characters are changed.
287 Only check the first one. The ACS characters are determined at
288 run time by curses terminal management. */
289 entry = translate (tui_border_kind, tui_border_kind_translate_lrcorner);
290 if (tui_border_lrcorner != (chtype) entry->value)
291 {
292 tui_border_lrcorner = (entry->value < 0) ? ACS_LRCORNER : entry->value;
293 need_redraw = 1;
294 }
295 entry = translate (tui_border_kind, tui_border_kind_translate_llcorner);
296 tui_border_llcorner = (entry->value < 0) ? ACS_LLCORNER : entry->value;
297
298 entry = translate (tui_border_kind, tui_border_kind_translate_ulcorner);
299 tui_border_ulcorner = (entry->value < 0) ? ACS_ULCORNER : entry->value;
300
301 entry = translate (tui_border_kind, tui_border_kind_translate_urcorner);
302 tui_border_urcorner = (entry->value < 0) ? ACS_URCORNER : entry->value;
303
304 entry = translate (tui_border_kind, tui_border_kind_translate_hline);
305 tui_border_hline = (entry->value < 0) ? ACS_HLINE : entry->value;
306
307 entry = translate (tui_border_kind, tui_border_kind_translate_vline);
308 tui_border_vline = (entry->value < 0) ? ACS_VLINE : entry->value;
309
310 return need_redraw;
311 }
312
313 static void
314 set_tui_cmd (const char *args, int from_tty)
315 {
316 }
317
318 static void
319 show_tui_cmd (const char *args, int from_tty)
320 {
321 }
322
323 static struct cmd_list_element *tuilist;
324
325 static void
326 tui_command (const char *args, int from_tty)
327 {
328 printf_unfiltered (_("\"tui\" must be followed by the name of a "
329 "tui command.\n"));
330 help_list (tuilist, "tui ", all_commands, gdb_stdout);
331 }
332
333 struct cmd_list_element **
334 tui_get_cmd_list (void)
335 {
336 if (tuilist == 0)
337 add_prefix_cmd ("tui", class_tui, tui_command,
338 _("Text User Interface commands."),
339 &tuilist, "tui ", 0, &cmdlist);
340 return &tuilist;
341 }
342
343 /* The set_func hook of "set tui ..." commands that affect the window
344 borders on the TUI display. */
345 void
346 tui_set_var_cmd (const char *null_args,
347 int from_tty, struct cmd_list_element *c)
348 {
349 if (tui_update_variables () && tui_active)
350 tui_rehighlight_all ();
351 }
352
353 /* Generic window name completion function. Complete window name pointed
354 to by TEXT and WORD. If INCLUDE_NEXT_PREV_P is true then the special
355 window names 'next' and 'prev' will also be considered as possible
356 completions of the window name. */
357
358 static void
359 window_name_completer (completion_tracker &tracker,
360 int include_next_prev_p,
361 const char *text, const char *word)
362 {
363 std::vector<const char *> completion_name_vec;
364
365 for (tui_win_info *win_info : all_tui_windows ())
366 {
367 const char *completion_name = NULL;
368
369 /* We can't focus on an invisible window. */
370 if (!win_info->is_visible ())
371 continue;
372
373 completion_name = win_info->name ();
374 gdb_assert (completion_name != NULL);
375 completion_name_vec.push_back (completion_name);
376 }
377
378 /* If no windows are considered visible then the TUI has not yet been
379 initialized. But still "focus src" and "focus cmd" will work because
380 invoking the focus command will entail initializing the TUI which sets the
381 default layout to SRC_COMMAND. */
382 if (completion_name_vec.empty ())
383 {
384 completion_name_vec.push_back (SRC_NAME);
385 completion_name_vec.push_back (CMD_NAME);
386 }
387
388 if (include_next_prev_p)
389 {
390 completion_name_vec.push_back ("next");
391 completion_name_vec.push_back ("prev");
392 }
393
394
395 completion_name_vec.push_back (NULL);
396 complete_on_enum (tracker, completion_name_vec.data (), text, word);
397 }
398
399 /* Complete possible window names to focus on. TEXT is the complete text
400 entered so far, WORD is the word currently being completed. */
401
402 static void
403 focus_completer (struct cmd_list_element *ignore,
404 completion_tracker &tracker,
405 const char *text, const char *word)
406 {
407 window_name_completer (tracker, 1, text, word);
408 }
409
410 /* Complete possible window names for winheight command. TEXT is the
411 complete text entered so far, WORD is the word currently being
412 completed. */
413
414 static void
415 winheight_completer (struct cmd_list_element *ignore,
416 completion_tracker &tracker,
417 const char *text, const char *word)
418 {
419 /* The first word is the window name. That we can complete. Subsequent
420 words can't be completed. */
421 if (word != text)
422 return;
423
424 window_name_completer (tracker, 0, text, word);
425 }
426
427 /* Update gdb's knowledge of the terminal size. */
428 void
429 tui_update_gdb_sizes (void)
430 {
431 int width, height;
432
433 if (tui_active)
434 {
435 width = TUI_CMD_WIN->width;
436 height = TUI_CMD_WIN->height;
437 }
438 else
439 {
440 width = tui_term_width ();
441 height = tui_term_height ();
442 }
443
444 set_screen_width_and_height (width, height);
445 }
446
447
448 /* Set the logical focus to win_info. */
449 void
450 tui_set_win_focus_to (struct tui_win_info *win_info)
451 {
452 if (win_info != NULL)
453 {
454 struct tui_win_info *win_with_focus = tui_win_with_focus ();
455
456 tui_unhighlight_win (win_with_focus);
457 tui_set_win_with_focus (win_info);
458 tui_highlight_win (win_info);
459 }
460 }
461
462
463 void
464 tui_win_info::forward_scroll (int num_to_scroll)
465 {
466 if (num_to_scroll == 0)
467 num_to_scroll = height - 3;
468
469 do_scroll_vertical (num_to_scroll);
470 }
471
472 void
473 tui_win_info::backward_scroll (int num_to_scroll)
474 {
475 if (num_to_scroll == 0)
476 num_to_scroll = height - 3;
477
478 do_scroll_vertical (-num_to_scroll);
479 }
480
481
482 void
483 tui_win_info::left_scroll (int num_to_scroll)
484 {
485 if (num_to_scroll == 0)
486 num_to_scroll = 1;
487
488 do_scroll_horizontal (num_to_scroll);
489 }
490
491
492 void
493 tui_win_info::right_scroll (int num_to_scroll)
494 {
495 if (num_to_scroll == 0)
496 num_to_scroll = 1;
497
498 do_scroll_horizontal (-num_to_scroll);
499 }
500
501
502 void
503 tui_refresh_all_win (void)
504 {
505 clearok (curscr, TRUE);
506 tui_refresh_all ();
507 }
508
509 void
510 tui_rehighlight_all (void)
511 {
512 for (tui_win_info *win_info : all_tui_windows ())
513 win_info->check_and_display_highlight_if_needed ();
514 }
515
516 /* Resize all the windows based on the terminal size. This function
517 gets called from within the readline SIGWINCH handler. */
518 void
519 tui_resize_all (void)
520 {
521 int height_diff, width_diff;
522 int screenheight, screenwidth;
523
524 rl_get_screen_size (&screenheight, &screenwidth);
525 width_diff = screenwidth - tui_term_width ();
526 height_diff = screenheight - tui_term_height ();
527 if (height_diff || width_diff)
528 {
529 enum tui_layout_type cur_layout = tui_current_layout ();
530 struct tui_win_info *win_with_focus = tui_win_with_focus ();
531 struct tui_win_info *first_win;
532 struct tui_win_info *second_win;
533 tui_source_window_base *src_win;
534 struct tui_locator_window *locator = tui_locator_win_info_ptr ();
535 int new_height, split_diff, cmd_split_diff, num_wins_displayed = 2;
536
537 #ifdef HAVE_RESIZE_TERM
538 resize_term (screenheight, screenwidth);
539 #endif
540 /* Turn keypad off while we resize. */
541 if (win_with_focus != TUI_CMD_WIN)
542 keypad (TUI_CMD_WIN->handle, FALSE);
543 tui_update_gdb_sizes ();
544 tui_set_term_height_to (screenheight);
545 tui_set_term_width_to (screenwidth);
546 if (cur_layout == SRC_DISASSEM_COMMAND
547 || cur_layout == SRC_DATA_COMMAND
548 || cur_layout == DISASSEM_DATA_COMMAND)
549 num_wins_displayed++;
550 split_diff = height_diff / num_wins_displayed;
551 cmd_split_diff = split_diff;
552 if (height_diff % num_wins_displayed)
553 {
554 if (height_diff < 0)
555 cmd_split_diff--;
556 else
557 cmd_split_diff++;
558 }
559 /* Now adjust each window. */
560 /* erase + clearok are used instead of a straightforward clear as
561 AIX 5.3 does not define clear. */
562 erase ();
563 clearok (curscr, TRUE);
564 refresh ();
565 switch (cur_layout)
566 {
567 case SRC_COMMAND:
568 case DISASSEM_COMMAND:
569 src_win = *(tui_source_windows ().begin ());
570 /* Check for invalid heights. */
571 if (height_diff == 0)
572 new_height = src_win->height;
573 else if ((src_win->height + split_diff) >=
574 (screenheight - MIN_CMD_WIN_HEIGHT - 1))
575 new_height = screenheight - MIN_CMD_WIN_HEIGHT - 1;
576 else if ((src_win->height + split_diff) <= 0)
577 new_height = MIN_WIN_HEIGHT;
578 else
579 new_height = src_win->height + split_diff;
580
581 src_win->resize (new_height, screenwidth, 0, 0);
582
583 locator->resize (2 /* 1 */, screenwidth,
584 0, new_height);
585
586 new_height = screenheight - (new_height + 1);
587 TUI_CMD_WIN->resize (new_height, screenwidth,
588 0, locator->origin.y + 1);
589 break;
590 default:
591 if (cur_layout == SRC_DISASSEM_COMMAND)
592 {
593 src_win = TUI_SRC_WIN;
594 first_win = src_win;
595 second_win = TUI_DISASM_WIN;
596 }
597 else
598 {
599 first_win = TUI_DATA_WIN;
600 src_win = *(tui_source_windows ().begin ());
601 second_win = src_win;
602 }
603 /* Change the first window's height/width. */
604 /* Check for invalid heights. */
605 if (height_diff == 0)
606 new_height = first_win->height;
607 else if ((first_win->height +
608 second_win->height + (split_diff * 2)) >=
609 (screenheight - MIN_CMD_WIN_HEIGHT - 1))
610 new_height = (screenheight - MIN_CMD_WIN_HEIGHT - 1) / 2;
611 else if ((first_win->height + split_diff) <= 0)
612 new_height = MIN_WIN_HEIGHT;
613 else
614 new_height = first_win->height + split_diff;
615
616 first_win->resize (new_height, screenwidth, 0, 0);
617
618 /* Change the second window's height/width. */
619 /* Check for invalid heights. */
620 if (height_diff == 0)
621 new_height = second_win->height;
622 else if ((first_win->height +
623 second_win->height + (split_diff * 2)) >=
624 (screenheight - MIN_CMD_WIN_HEIGHT - 1))
625 {
626 new_height = screenheight - MIN_CMD_WIN_HEIGHT - 1;
627 if (new_height % 2)
628 new_height = (new_height / 2) + 1;
629 else
630 new_height /= 2;
631 }
632 else if ((second_win->height + split_diff) <= 0)
633 new_height = MIN_WIN_HEIGHT;
634 else
635 new_height = second_win->height + split_diff;
636
637 second_win->resize (new_height, screenwidth,
638 0, first_win->height - 1);
639
640 locator->resize (2 /* 1 */, screenwidth,
641 0, second_win->origin.y + new_height);
642
643 /* Change the command window's height/width. */
644 new_height = screenheight - (locator->origin.y + 1);
645 TUI_CMD_WIN->resize (new_height, screenwidth,
646 0, locator->origin.y + 1);
647 break;
648 }
649
650 tui_delete_invisible_windows ();
651 /* Turn keypad back on, unless focus is in the command
652 window. */
653 if (win_with_focus != TUI_CMD_WIN)
654 keypad (TUI_CMD_WIN->handle, TRUE);
655 }
656 }
657
658 #ifdef SIGWINCH
659 /* Token for use by TUI's asynchronous SIGWINCH handler. */
660 static struct async_signal_handler *tui_sigwinch_token;
661
662 /* TUI's SIGWINCH signal handler. */
663 static void
664 tui_sigwinch_handler (int signal)
665 {
666 mark_async_signal_handler (tui_sigwinch_token);
667 tui_set_win_resized_to (TRUE);
668 }
669
670 /* Callback for asynchronously resizing TUI following a SIGWINCH signal. */
671 static void
672 tui_async_resize_screen (gdb_client_data arg)
673 {
674 rl_resize_terminal ();
675
676 if (!tui_active)
677 {
678 int screen_height, screen_width;
679
680 rl_get_screen_size (&screen_height, &screen_width);
681 set_screen_width_and_height (screen_width, screen_height);
682
683 /* win_resized is left set so that the next call to tui_enable()
684 resizes the TUI windows. */
685 }
686 else
687 {
688 tui_set_win_resized_to (FALSE);
689 tui_resize_all ();
690 tui_refresh_all_win ();
691 tui_update_gdb_sizes ();
692 tui_redisplay_readline ();
693 }
694 }
695 #endif
696
697 /* Initialize TUI's SIGWINCH signal handler. Note that the handler is not
698 uninstalled when we exit TUI, so the handler should not assume that TUI is
699 always active. */
700 void
701 tui_initialize_win (void)
702 {
703 #ifdef SIGWINCH
704 tui_sigwinch_token
705 = create_async_signal_handler (tui_async_resize_screen, NULL);
706
707 {
708 #ifdef HAVE_SIGACTION
709 struct sigaction old_winch;
710
711 memset (&old_winch, 0, sizeof (old_winch));
712 old_winch.sa_handler = &tui_sigwinch_handler;
713 #ifdef SA_RESTART
714 old_winch.sa_flags = SA_RESTART;
715 #endif
716 sigaction (SIGWINCH, &old_winch, NULL);
717 #else
718 signal (SIGWINCH, &tui_sigwinch_handler);
719 #endif
720 }
721 #endif
722 }
723
724
725 /*************************
726 ** STATIC LOCAL FUNCTIONS
727 **************************/
728
729
730 static void
731 tui_scroll_forward_command (const char *arg, int from_tty)
732 {
733 int num_to_scroll = 1;
734 struct tui_win_info *win_to_scroll;
735
736 /* Make sure the curses mode is enabled. */
737 tui_enable ();
738 if (arg == NULL)
739 parse_scrolling_args (arg, &win_to_scroll, NULL);
740 else
741 parse_scrolling_args (arg, &win_to_scroll, &num_to_scroll);
742 win_to_scroll->forward_scroll (num_to_scroll);
743 }
744
745
746 static void
747 tui_scroll_backward_command (const char *arg, int from_tty)
748 {
749 int num_to_scroll = 1;
750 struct tui_win_info *win_to_scroll;
751
752 /* Make sure the curses mode is enabled. */
753 tui_enable ();
754 if (arg == NULL)
755 parse_scrolling_args (arg, &win_to_scroll, NULL);
756 else
757 parse_scrolling_args (arg, &win_to_scroll, &num_to_scroll);
758 win_to_scroll->backward_scroll (num_to_scroll);
759 }
760
761
762 static void
763 tui_scroll_left_command (const char *arg, int from_tty)
764 {
765 int num_to_scroll;
766 struct tui_win_info *win_to_scroll;
767
768 /* Make sure the curses mode is enabled. */
769 tui_enable ();
770 parse_scrolling_args (arg, &win_to_scroll, &num_to_scroll);
771 win_to_scroll->left_scroll (num_to_scroll);
772 }
773
774
775 static void
776 tui_scroll_right_command (const char *arg, int from_tty)
777 {
778 int num_to_scroll;
779 struct tui_win_info *win_to_scroll;
780
781 /* Make sure the curses mode is enabled. */
782 tui_enable ();
783 parse_scrolling_args (arg, &win_to_scroll, &num_to_scroll);
784 win_to_scroll->right_scroll (num_to_scroll);
785 }
786
787
788 /* Set focus to the window named by 'arg'. */
789 static void
790 tui_set_focus_command (const char *arg, int from_tty)
791 {
792 tui_enable ();
793
794 if (arg != NULL)
795 {
796 char *buf_ptr = xstrdup (arg);
797 int i;
798 struct tui_win_info *win_info = NULL;
799
800 for (i = 0; (i < strlen (buf_ptr)); i++)
801 buf_ptr[i] = tolower (arg[i]);
802
803 if (subset_compare (buf_ptr, "next"))
804 win_info = tui_next_win (tui_win_with_focus ());
805 else if (subset_compare (buf_ptr, "prev"))
806 win_info = tui_prev_win (tui_win_with_focus ());
807 else
808 win_info = tui_partial_win_by_name (buf_ptr);
809
810 if (win_info == NULL || !win_info->is_visible ())
811 warning (_("Invalid window specified. \n\
812 The window name specified must be valid and visible.\n"));
813 else
814 {
815 tui_set_win_focus_to (win_info);
816 keypad (TUI_CMD_WIN->handle, (win_info != TUI_CMD_WIN));
817 }
818
819 xfree (buf_ptr);
820 printf_filtered (_("Focus set to %s window.\n"),
821 tui_win_with_focus ()->name ());
822 }
823 else
824 warning (_("Incorrect Number of Arguments.\n%s"), FOCUS_USAGE);
825 }
826
827 static void
828 tui_all_windows_info (const char *arg, int from_tty)
829 {
830 struct tui_win_info *win_with_focus = tui_win_with_focus ();
831
832 for (tui_win_info *win_info : all_tui_windows ())
833 if (win_info->is_visible ())
834 {
835 if (win_with_focus == win_info)
836 printf_filtered (" %s\t(%d lines) <has focus>\n",
837 win_info->name (),
838 win_info->height);
839 else
840 printf_filtered (" %s\t(%d lines)\n",
841 win_info->name (),
842 win_info->height);
843 }
844 }
845
846
847 static void
848 tui_refresh_all_command (const char *arg, int from_tty)
849 {
850 /* Make sure the curses mode is enabled. */
851 tui_enable ();
852
853 tui_refresh_all_win ();
854 }
855
856 /* The tab width that should be used by the TUI. */
857
858 unsigned int tui_tab_width = DEFAULT_TAB_LEN;
859
860 /* The tab width as set by the user. */
861
862 static unsigned int internal_tab_width = DEFAULT_TAB_LEN;
863
864 /* After the tab width is set, call this to update the relevant
865 windows. */
866
867 static void
868 update_tab_width ()
869 {
870 for (tui_win_info *win_info : all_tui_windows ())
871 {
872 if (win_info->is_visible ())
873 win_info->update_tab_width ();
874 }
875 }
876
877 /* Callback for "set tui tab-width". */
878
879 static void
880 tui_set_tab_width (const char *ignore,
881 int from_tty, struct cmd_list_element *c)
882 {
883 if (internal_tab_width == 0)
884 {
885 internal_tab_width = tui_tab_width;
886 error (_("Tab width must not be 0"));
887 }
888
889 tui_tab_width = internal_tab_width;
890 update_tab_width ();
891 }
892
893 /* Callback for "show tui tab-width". */
894
895 static void
896 tui_show_tab_width (struct ui_file *file, int from_tty,
897 struct cmd_list_element *c, const char *value)
898 {
899 fprintf_filtered (gdb_stdout, _("TUI tab width is %s spaces.\n"), value);
900
901 }
902
903 /* Set the tab width of the specified window. */
904 static void
905 tui_set_tab_width_command (const char *arg, int from_tty)
906 {
907 /* Make sure the curses mode is enabled. */
908 tui_enable ();
909 if (arg != NULL)
910 {
911 int ts;
912
913 ts = atoi (arg);
914 if (ts <= 0)
915 warning (_("Tab widths greater than 0 must be specified."));
916 else
917 {
918 internal_tab_width = ts;
919 tui_tab_width = ts;
920
921 update_tab_width ();
922 }
923 }
924 }
925
926
927 /* Set the height of the specified window. */
928 static void
929 tui_set_win_height_command (const char *arg, int from_tty)
930 {
931 /* Make sure the curses mode is enabled. */
932 tui_enable ();
933 if (arg != NULL)
934 {
935 std::string copy = arg;
936 char *buf = &copy[0];
937 char *buf_ptr = buf;
938 char *wname = NULL;
939 int new_height, i;
940 struct tui_win_info *win_info;
941
942 wname = buf_ptr;
943 buf_ptr = strchr (buf_ptr, ' ');
944 if (buf_ptr != NULL)
945 {
946 *buf_ptr = (char) 0;
947
948 /* Validate the window name. */
949 for (i = 0; i < strlen (wname); i++)
950 wname[i] = tolower (wname[i]);
951 win_info = tui_partial_win_by_name (wname);
952
953 if (win_info == NULL || !win_info->is_visible ())
954 warning (_("Invalid window specified. \n\
955 The window name specified must be valid and visible.\n"));
956 else
957 {
958 /* Process the size. */
959 while (*(++buf_ptr) == ' ')
960 ;
961
962 if (*buf_ptr != (char) 0)
963 {
964 int negate = FALSE;
965 int fixed_size = TRUE;
966 int input_no;;
967
968 if (*buf_ptr == '+' || *buf_ptr == '-')
969 {
970 if (*buf_ptr == '-')
971 negate = TRUE;
972 fixed_size = FALSE;
973 buf_ptr++;
974 }
975 input_no = atoi (buf_ptr);
976 if (input_no > 0)
977 {
978 if (negate)
979 input_no *= (-1);
980 if (fixed_size)
981 new_height = input_no;
982 else
983 new_height = win_info->height + input_no;
984
985 /* Now change the window's height, and adjust
986 all other windows around it. */
987 if (tui_adjust_win_heights (win_info,
988 new_height) == TUI_FAILURE)
989 warning (_("Invalid window height specified.\n%s"),
990 WIN_HEIGHT_USAGE);
991 else
992 tui_update_gdb_sizes ();
993 }
994 else
995 warning (_("Invalid window height specified.\n%s"),
996 WIN_HEIGHT_USAGE);
997 }
998 }
999 }
1000 else
1001 printf_filtered (WIN_HEIGHT_USAGE);
1002 }
1003 else
1004 printf_filtered (WIN_HEIGHT_USAGE);
1005 }
1006
1007 /* Function to adjust all window heights around the primary. */
1008 static enum tui_status
1009 tui_adjust_win_heights (struct tui_win_info *primary_win_info,
1010 int new_height)
1011 {
1012 enum tui_status status = TUI_FAILURE;
1013
1014 if (new_height_ok (primary_win_info, new_height))
1015 {
1016 status = TUI_SUCCESS;
1017 if (new_height != primary_win_info->height)
1018 {
1019 int diff;
1020 struct tui_win_info *win_info;
1021 struct tui_locator_window *locator = tui_locator_win_info_ptr ();
1022 enum tui_layout_type cur_layout = tui_current_layout ();
1023 int width = tui_term_width ();
1024
1025 diff = (new_height - primary_win_info->height) * (-1);
1026 if (cur_layout == SRC_COMMAND
1027 || cur_layout == DISASSEM_COMMAND)
1028 {
1029 struct tui_win_info *src_win_info;
1030
1031 primary_win_info->resize (new_height, width,
1032 0, primary_win_info->origin.y);
1033 if (primary_win_info->type == CMD_WIN)
1034 {
1035 win_info = *(tui_source_windows ().begin ());
1036 src_win_info = win_info;
1037 }
1038 else
1039 {
1040 win_info = tui_win_list[CMD_WIN];
1041 src_win_info = primary_win_info;
1042 }
1043 win_info->resize (win_info->height + diff, width,
1044 0, win_info->origin.y);
1045 TUI_CMD_WIN->origin.y = locator->origin.y + 1;
1046 if ((src_win_info->type == SRC_WIN
1047 || src_win_info->type == DISASSEM_WIN))
1048 {
1049 tui_source_window_base *src_base
1050 = (tui_source_window_base *) src_win_info;
1051 if (src_base->content.empty ())
1052 src_base->erase_source_content ();
1053 }
1054 }
1055 else
1056 {
1057 struct tui_win_info *first_win;
1058 struct tui_source_window_base *second_win;
1059 tui_source_window_base *src1;
1060
1061 if (cur_layout == SRC_DISASSEM_COMMAND)
1062 {
1063 src1 = TUI_SRC_WIN;
1064 first_win = src1;
1065 second_win = TUI_DISASM_WIN;
1066 }
1067 else
1068 {
1069 src1 = nullptr;
1070 first_win = TUI_DATA_WIN;
1071 second_win = *(tui_source_windows ().begin ());
1072 }
1073 if (primary_win_info == TUI_CMD_WIN)
1074 { /* Split the change in height accross the 1st & 2nd
1075 windows, adjusting them as well. */
1076 /* Subtract the locator. */
1077 int first_split_diff = diff / 2;
1078 int second_split_diff = first_split_diff;
1079
1080 if (diff % 2)
1081 {
1082 if (first_win->height >
1083 second_win->height)
1084 if (diff < 0)
1085 first_split_diff--;
1086 else
1087 first_split_diff++;
1088 else
1089 {
1090 if (diff < 0)
1091 second_split_diff--;
1092 else
1093 second_split_diff++;
1094 }
1095 }
1096 /* Make sure that the minimum hieghts are
1097 honored. */
1098 while ((first_win->height + first_split_diff) < 3)
1099 {
1100 first_split_diff++;
1101 second_split_diff--;
1102 }
1103 while ((second_win->height + second_split_diff) < 3)
1104 {
1105 second_split_diff++;
1106 first_split_diff--;
1107 }
1108 first_win->resize (first_win->height + first_split_diff,
1109 width,
1110 0, first_win->origin.y);
1111 second_win->resize (second_win->height + second_split_diff,
1112 width,
1113 0, first_win->height - 1);
1114 locator->resize (2 /* 1 */, width,
1115 0, (second_win->origin.y
1116 + second_win->height + 1));
1117
1118 TUI_CMD_WIN->resize (new_height, width,
1119 0, locator->origin.y + 1);
1120 }
1121 else
1122 {
1123 if ((TUI_CMD_WIN->height + diff) < 1)
1124 { /* If there is no way to increase the command
1125 window take real estate from the 1st or 2nd
1126 window. */
1127 if ((TUI_CMD_WIN->height + diff) < 1)
1128 {
1129 int i;
1130
1131 for (i = TUI_CMD_WIN->height + diff;
1132 (i < 1); i++)
1133 if (primary_win_info == first_win)
1134 second_win->height--;
1135 else
1136 first_win->height--;
1137 }
1138 }
1139 if (primary_win_info == first_win)
1140 first_win->resize (new_height, width, 0, 0);
1141 else
1142 first_win->resize (first_win->height, width, 0, 0);
1143 second_win->origin.y = first_win->height - 1;
1144 if (primary_win_info == second_win)
1145 second_win->resize (new_height, width,
1146 0, first_win->height - 1);
1147 else
1148 second_win->resize (second_win->height, width,
1149 0, first_win->height - 1);
1150 locator->resize (2 /* 1 */, width,
1151 0, (second_win->origin.y
1152 + second_win->height + 1));
1153 TUI_CMD_WIN->origin.y = locator->origin.y + 1;
1154 if ((TUI_CMD_WIN->height + diff) < 1)
1155 TUI_CMD_WIN->resize (1, width, 0, locator->origin.y + 1);
1156 else
1157 TUI_CMD_WIN->resize (TUI_CMD_WIN->height + diff, width,
1158 0, locator->origin.y + 1);
1159 }
1160 if (src1 != nullptr && src1->content.empty ())
1161 src1->erase_source_content ();
1162 if (second_win->content.empty ())
1163 second_win->erase_source_content ();
1164 }
1165 }
1166 }
1167
1168 return status;
1169 }
1170
1171 /* See tui-data.h. */
1172
1173 int
1174 tui_win_info::max_height () const
1175 {
1176 return tui_term_height () - 2;
1177 }
1178
1179 static int
1180 new_height_ok (struct tui_win_info *primary_win_info,
1181 int new_height)
1182 {
1183 int ok = (new_height < tui_term_height ());
1184
1185 if (ok)
1186 {
1187 int diff;
1188 enum tui_layout_type cur_layout = tui_current_layout ();
1189
1190 diff = (new_height - primary_win_info->height) * (-1);
1191 if (cur_layout == SRC_COMMAND || cur_layout == DISASSEM_COMMAND)
1192 {
1193 ok = (new_height <= primary_win_info->max_height ()
1194 && new_height >= MIN_CMD_WIN_HEIGHT);
1195 if (ok)
1196 { /* Check the total height. */
1197 struct tui_win_info *win_info;
1198
1199 if (primary_win_info == TUI_CMD_WIN)
1200 win_info = *(tui_source_windows ().begin ());
1201 else
1202 win_info = TUI_CMD_WIN;
1203 ok = ((new_height +
1204 (win_info->height + diff)) <= tui_term_height ());
1205 }
1206 }
1207 else
1208 {
1209 int cur_total_height, total_height, min_height = 0;
1210 struct tui_win_info *first_win;
1211 struct tui_win_info *second_win;
1212
1213 if (cur_layout == SRC_DISASSEM_COMMAND)
1214 {
1215 first_win = TUI_SRC_WIN;
1216 second_win = TUI_DISASM_WIN;
1217 }
1218 else
1219 {
1220 first_win = TUI_DATA_WIN;
1221 second_win = *(tui_source_windows ().begin ());
1222 }
1223 /* We could simply add all the heights to obtain the same
1224 result but below is more explicit since we subtract 1 for
1225 the line that the first and second windows share, and add
1226 one for the locator. */
1227 total_height = cur_total_height =
1228 (first_win->height + second_win->height - 1)
1229 + TUI_CMD_WIN->height + 1; /* Locator. */
1230 if (primary_win_info == TUI_CMD_WIN)
1231 {
1232 /* Locator included since first & second win share a line. */
1233 ok = ((first_win->height +
1234 second_win->height + diff) >=
1235 (MIN_WIN_HEIGHT * 2)
1236 && new_height >= MIN_CMD_WIN_HEIGHT);
1237 if (ok)
1238 {
1239 total_height = new_height +
1240 (first_win->height +
1241 second_win->height + diff);
1242 min_height = MIN_CMD_WIN_HEIGHT;
1243 }
1244 }
1245 else
1246 {
1247 min_height = MIN_WIN_HEIGHT;
1248
1249 /* First see if we can increase/decrease the command
1250 window. And make sure that the command window is at
1251 least 1 line. */
1252 ok = ((TUI_CMD_WIN->height + diff) > 0);
1253 if (!ok)
1254 { /* Looks like we have to increase/decrease one of
1255 the other windows. */
1256 if (primary_win_info == first_win)
1257 ok = (second_win->height + diff) >= min_height;
1258 else
1259 ok = (first_win->height + diff) >= min_height;
1260 }
1261 if (ok)
1262 {
1263 if (primary_win_info == first_win)
1264 total_height = new_height +
1265 second_win->height +
1266 TUI_CMD_WIN->height + diff;
1267 else
1268 total_height = new_height +
1269 first_win->height +
1270 TUI_CMD_WIN->height + diff;
1271 }
1272 }
1273 /* Now make sure that the proposed total height doesn't
1274 exceed the old total height. */
1275 if (ok)
1276 ok = (new_height >= min_height
1277 && total_height <= cur_total_height);
1278 }
1279 }
1280
1281 return ok;
1282 }
1283
1284
1285 static void
1286 parse_scrolling_args (const char *arg,
1287 struct tui_win_info **win_to_scroll,
1288 int *num_to_scroll)
1289 {
1290 if (num_to_scroll)
1291 *num_to_scroll = 0;
1292 *win_to_scroll = tui_win_with_focus ();
1293
1294 /* First set up the default window to scroll, in case there is no
1295 window name arg. */
1296 if (arg != NULL)
1297 {
1298 char *buf_ptr;
1299
1300 /* Process the number of lines to scroll. */
1301 std::string copy = arg;
1302 buf_ptr = &copy[0];
1303 if (isdigit (*buf_ptr))
1304 {
1305 char *num_str;
1306
1307 num_str = buf_ptr;
1308 buf_ptr = strchr (buf_ptr, ' ');
1309 if (buf_ptr != NULL)
1310 {
1311 *buf_ptr = (char) 0;
1312 if (num_to_scroll)
1313 *num_to_scroll = atoi (num_str);
1314 buf_ptr++;
1315 }
1316 else if (num_to_scroll)
1317 *num_to_scroll = atoi (num_str);
1318 }
1319
1320 /* Process the window name if one is specified. */
1321 if (buf_ptr != NULL)
1322 {
1323 const char *wname;
1324
1325 if (*buf_ptr == ' ')
1326 while (*(++buf_ptr) == ' ')
1327 ;
1328
1329 if (*buf_ptr != (char) 0)
1330 {
1331 /* Validate the window name. */
1332 for (char *p = buf_ptr; *p != '\0'; p++)
1333 *p = tolower (*p);
1334
1335 wname = buf_ptr;
1336 }
1337 else
1338 wname = "?";
1339
1340 *win_to_scroll = tui_partial_win_by_name (wname);
1341
1342 if (*win_to_scroll == NULL)
1343 error (_("Unrecognized window `%s'"), wname);
1344 if (!(*win_to_scroll)->is_visible ())
1345 error (_("Window is not visible"));
1346 else if (*win_to_scroll == TUI_CMD_WIN)
1347 *win_to_scroll = *(tui_source_windows ().begin ());
1348 }
1349 }
1350 }
1351
1352 /* Function to initialize gdb commands, for tui window
1353 manipulation. */
1354
1355 void
1356 _initialize_tui_win (void)
1357 {
1358 static struct cmd_list_element *tui_setlist;
1359 static struct cmd_list_element *tui_showlist;
1360 struct cmd_list_element *cmd;
1361
1362 /* Define the classes of commands.
1363 They will appear in the help list in the reverse of this order. */
1364 add_prefix_cmd ("tui", class_tui, set_tui_cmd,
1365 _("TUI configuration variables."),
1366 &tui_setlist, "set tui ",
1367 0 /* allow-unknown */, &setlist);
1368 add_prefix_cmd ("tui", class_tui, show_tui_cmd,
1369 _("TUI configuration variables."),
1370 &tui_showlist, "show tui ",
1371 0 /* allow-unknown */, &showlist);
1372
1373 add_com ("refresh", class_tui, tui_refresh_all_command,
1374 _("Refresh the terminal display."));
1375
1376 cmd = add_com ("tabset", class_tui, tui_set_tab_width_command, _("\
1377 Set the width (in characters) of tab stops.\n\
1378 Usage: tabset N"));
1379 deprecate_cmd (cmd, "set tui tab-width");
1380
1381 cmd = add_com ("winheight", class_tui, tui_set_win_height_command, _("\
1382 Set or modify the height of a specified window.\n"
1383 WIN_HEIGHT_USAGE
1384 "Window names are:\n\
1385 src : the source window\n\
1386 cmd : the command window\n\
1387 asm : the disassembly window\n\
1388 regs : the register display"));
1389 add_com_alias ("wh", "winheight", class_tui, 0);
1390 set_cmd_completer (cmd, winheight_completer);
1391 add_info ("win", tui_all_windows_info,
1392 _("List of all displayed windows."));
1393 cmd = add_com ("focus", class_tui, tui_set_focus_command, _("\
1394 Set focus to named window or next/prev window.\n"
1395 FOCUS_USAGE
1396 "Valid Window names are:\n\
1397 src : the source window\n\
1398 asm : the disassembly window\n\
1399 regs : the register display\n\
1400 cmd : the command window"));
1401 add_com_alias ("fs", "focus", class_tui, 0);
1402 set_cmd_completer (cmd, focus_completer);
1403 add_com ("+", class_tui, tui_scroll_forward_command, _("\
1404 Scroll window forward.\n\
1405 Usage: + [WIN] [N]"));
1406 add_com ("-", class_tui, tui_scroll_backward_command, _("\
1407 Scroll window backward.\n\
1408 Usage: - [WIN] [N]"));
1409 add_com ("<", class_tui, tui_scroll_left_command, _("\
1410 Scroll window text to the left.\n\
1411 Usage: < [WIN] [N]"));
1412 add_com (">", class_tui, tui_scroll_right_command, _("\
1413 Scroll window text to the right.\n\
1414 Usage: > [WIN] [N]"));
1415
1416 /* Define the tui control variables. */
1417 add_setshow_enum_cmd ("border-kind", no_class, tui_border_kind_enums,
1418 &tui_border_kind, _("\
1419 Set the kind of border for TUI windows."), _("\
1420 Show the kind of border for TUI windows."), _("\
1421 This variable controls the border of TUI windows:\n\
1422 space use a white space\n\
1423 ascii use ascii characters + - | for the border\n\
1424 acs use the Alternate Character Set"),
1425 tui_set_var_cmd,
1426 show_tui_border_kind,
1427 &tui_setlist, &tui_showlist);
1428
1429 add_setshow_enum_cmd ("border-mode", no_class, tui_border_mode_enums,
1430 &tui_border_mode, _("\
1431 Set the attribute mode to use for the TUI window borders."), _("\
1432 Show the attribute mode to use for the TUI window borders."), _("\
1433 This variable controls the attributes to use for the window borders:\n\
1434 normal normal display\n\
1435 standout use highlight mode of terminal\n\
1436 reverse use reverse video mode\n\
1437 half use half bright\n\
1438 half-standout use half bright and standout mode\n\
1439 bold use extra bright or bold\n\
1440 bold-standout use extra bright or bold with standout mode"),
1441 tui_set_var_cmd,
1442 show_tui_border_mode,
1443 &tui_setlist, &tui_showlist);
1444
1445 add_setshow_enum_cmd ("active-border-mode", no_class, tui_border_mode_enums,
1446 &tui_active_border_mode, _("\
1447 Set the attribute mode to use for the active TUI window border."), _("\
1448 Show the attribute mode to use for the active TUI window border."), _("\
1449 This variable controls the attributes to use for the active window border:\n\
1450 normal normal display\n\
1451 standout use highlight mode of terminal\n\
1452 reverse use reverse video mode\n\
1453 half use half bright\n\
1454 half-standout use half bright and standout mode\n\
1455 bold use extra bright or bold\n\
1456 bold-standout use extra bright or bold with standout mode"),
1457 tui_set_var_cmd,
1458 show_tui_active_border_mode,
1459 &tui_setlist, &tui_showlist);
1460
1461 add_setshow_zuinteger_cmd ("tab-width", no_class,
1462 &internal_tab_width, _("\
1463 Set the tab width, in characters, for the TUI."), _("\
1464 Show the tab witdh, in characters, for the TUI."), _("\
1465 This variable controls how many spaces are used to display a tab character."),
1466 tui_set_tab_width, tui_show_tab_width,
1467 &tui_setlist, &tui_showlist);
1468 }
This page took 0.060806 seconds and 4 git commands to generate.