1 /* TUI window generic functions.
3 Copyright (C) 1998-2019 Free Software Foundation, Inc.
5 Contributed by Hewlett-Packard Company.
7 This file is part of GDB.
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.
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.
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/>. */
22 /* This module contains procedures for handling tui window functions
23 like resize, scrolling, scrolling, changing focus, etc.
25 Author: Susan B. Macchia */
30 #include "breakpoint.h"
32 #include "cli/cli-cmds.h"
35 #include "event-loop.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"
50 #include "gdb_curses.h"
52 #include "readline/readline.h"
56 /*******************************
58 ********************************/
59 static enum tui_status
tui_adjust_win_heights (struct tui_win_info
*,
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
**,
74 /***************************************
76 ***************************************/
77 #define WIN_HEIGHT_USAGE "Usage: winheight WINDOW-NAME [+ | -] NUM-LINES\n"
78 #define FOCUS_USAGE "Usage: focus [WINDOW-NAME | next | prev]\n"
80 /***************************************
82 ***************************************/
85 # define ACS_LRCORNER '+'
88 # define ACS_LLCORNER '+'
91 # define ACS_ULCORNER '+'
94 # define ACS_URCORNER '+'
97 # define ACS_HLINE '-'
100 # define ACS_VLINE '|'
103 /* Possible values for tui-border-kind variable. */
104 static const char *const tui_border_kind_enums
[] = {
111 /* Possible values for tui-border-mode and tui-active-border-mode. */
112 static const char *const tui_border_mode_enums
[] = {
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
},
137 { "half-standout", A_DIM
| A_STANDOUT
},
139 { "bold-standout", A_BOLD
| A_STANDOUT
},
141 { "normal", A_NORMAL
}
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
[] = {
156 struct tui_translate tui_border_kind_translate_hline
[] = {
164 struct tui_translate tui_border_kind_translate_ulcorner
[] = {
172 struct tui_translate tui_border_kind_translate_urcorner
[] = {
180 struct tui_translate tui_border_kind_translate_llcorner
[] = {
188 struct tui_translate tui_border_kind_translate_lrcorner
[] = {
197 /* Tui configuration variables controlled with set/show command. */
198 const char *tui_active_border_mode
= "bold-standout";
200 show_tui_active_border_mode (struct ui_file
*file
,
202 struct cmd_list_element
*c
,
205 fprintf_filtered (file
, _("\
206 The attribute mode to use for the active TUI window border is \"%s\".\n"),
210 const char *tui_border_mode
= "normal";
212 show_tui_border_mode (struct ui_file
*file
,
214 struct cmd_list_element
*c
,
217 fprintf_filtered (file
, _("\
218 The attribute mode to use for the TUI window borders is \"%s\".\n"),
222 const char *tui_border_kind
= "acs";
224 show_tui_border_kind (struct ui_file
*file
,
226 struct cmd_list_element
*c
,
229 fprintf_filtered (file
, _("The kind of border for TUI windows is \"%s\".\n"),
234 /* Tui internal configuration variables. These variables are updated
235 by tui_update_variables to reflect the tui configuration
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
;
244 int tui_border_attrs
;
245 int tui_active_border_attrs
;
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
)
254 if (name
&& strcmp (table
->name
, name
) == 0)
259 /* Not found, return default entry. */
264 /* Update the tui internal configuration according to gdb settings.
265 Returns 1 if the configuration has changed and the screen should
268 tui_update_variables (void)
271 struct tui_translate
*entry
;
273 entry
= translate (tui_border_mode
, tui_border_mode_translate
);
274 if (tui_border_attrs
!= entry
->value
)
276 tui_border_attrs
= entry
->value
;
279 entry
= translate (tui_active_border_mode
, tui_border_mode_translate
);
280 if (tui_active_border_attrs
!= entry
->value
)
282 tui_active_border_attrs
= entry
->value
;
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
)
292 tui_border_lrcorner
= (entry
->value
< 0) ? ACS_LRCORNER
: entry
->value
;
295 entry
= translate (tui_border_kind
, tui_border_kind_translate_llcorner
);
296 tui_border_llcorner
= (entry
->value
< 0) ? ACS_LLCORNER
: entry
->value
;
298 entry
= translate (tui_border_kind
, tui_border_kind_translate_ulcorner
);
299 tui_border_ulcorner
= (entry
->value
< 0) ? ACS_ULCORNER
: entry
->value
;
301 entry
= translate (tui_border_kind
, tui_border_kind_translate_urcorner
);
302 tui_border_urcorner
= (entry
->value
< 0) ? ACS_URCORNER
: entry
->value
;
304 entry
= translate (tui_border_kind
, tui_border_kind_translate_hline
);
305 tui_border_hline
= (entry
->value
< 0) ? ACS_HLINE
: entry
->value
;
307 entry
= translate (tui_border_kind
, tui_border_kind_translate_vline
);
308 tui_border_vline
= (entry
->value
< 0) ? ACS_VLINE
: entry
->value
;
314 set_tui_cmd (const char *args
, int from_tty
)
319 show_tui_cmd (const char *args
, int from_tty
)
323 static struct cmd_list_element
*tuilist
;
326 tui_command (const char *args
, int from_tty
)
328 printf_unfiltered (_("\"tui\" must be followed by the name of a "
330 help_list (tuilist
, "tui ", all_commands
, gdb_stdout
);
333 struct cmd_list_element
**
334 tui_get_cmd_list (void)
337 add_prefix_cmd ("tui", class_tui
, tui_command
,
338 _("Text User Interface commands."),
339 &tuilist
, "tui ", 0, &cmdlist
);
343 /* The set_func hook of "set tui ..." commands that affect the window
344 borders on the TUI display. */
346 tui_set_var_cmd (const char *null_args
,
347 int from_tty
, struct cmd_list_element
*c
)
349 if (tui_update_variables () && tui_active
)
350 tui_rehighlight_all ();
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. */
359 window_name_completer (completion_tracker
&tracker
,
360 int include_next_prev_p
,
361 const char *text
, const char *word
)
363 std::vector
<const char *> completion_name_vec
;
365 for (tui_win_info
*win_info
: all_tui_windows ())
367 const char *completion_name
= NULL
;
369 /* We can't focus on an invisible window. */
370 if (!win_info
->is_visible ())
373 completion_name
= win_info
->name ();
374 gdb_assert (completion_name
!= NULL
);
375 completion_name_vec
.push_back (completion_name
);
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 ())
384 completion_name_vec
.push_back (SRC_NAME
);
385 completion_name_vec
.push_back (CMD_NAME
);
388 if (include_next_prev_p
)
390 completion_name_vec
.push_back ("next");
391 completion_name_vec
.push_back ("prev");
395 completion_name_vec
.push_back (NULL
);
396 complete_on_enum (tracker
, completion_name_vec
.data (), text
, word
);
399 /* Complete possible window names to focus on. TEXT is the complete text
400 entered so far, WORD is the word currently being completed. */
403 focus_completer (struct cmd_list_element
*ignore
,
404 completion_tracker
&tracker
,
405 const char *text
, const char *word
)
407 window_name_completer (tracker
, 1, text
, word
);
410 /* Complete possible window names for winheight command. TEXT is the
411 complete text entered so far, WORD is the word currently being
415 winheight_completer (struct cmd_list_element
*ignore
,
416 completion_tracker
&tracker
,
417 const char *text
, const char *word
)
419 /* The first word is the window name. That we can complete. Subsequent
420 words can't be completed. */
424 window_name_completer (tracker
, 0, text
, word
);
427 /* Update gdb's knowledge of the terminal size. */
429 tui_update_gdb_sizes (void)
435 width
= TUI_CMD_WIN
->width
;
436 height
= TUI_CMD_WIN
->height
;
440 width
= tui_term_width ();
441 height
= tui_term_height ();
444 set_screen_width_and_height (width
, height
);
448 /* Set the logical focus to win_info. */
450 tui_set_win_focus_to (struct tui_win_info
*win_info
)
452 if (win_info
!= NULL
)
454 struct tui_win_info
*win_with_focus
= tui_win_with_focus ();
456 tui_unhighlight_win (win_with_focus
);
457 tui_set_win_with_focus (win_info
);
458 tui_highlight_win (win_info
);
464 tui_win_info::forward_scroll (int num_to_scroll
)
466 if (num_to_scroll
== 0)
467 num_to_scroll
= height
- 3;
469 do_scroll_vertical (num_to_scroll
);
473 tui_win_info::backward_scroll (int num_to_scroll
)
475 if (num_to_scroll
== 0)
476 num_to_scroll
= height
- 3;
478 do_scroll_vertical (-num_to_scroll
);
483 tui_win_info::left_scroll (int num_to_scroll
)
485 if (num_to_scroll
== 0)
488 do_scroll_horizontal (num_to_scroll
);
493 tui_win_info::right_scroll (int num_to_scroll
)
495 if (num_to_scroll
== 0)
498 do_scroll_horizontal (-num_to_scroll
);
503 tui_refresh_all_win (void)
505 clearok (curscr
, TRUE
);
510 tui_rehighlight_all (void)
512 for (tui_win_info
*win_info
: all_tui_windows ())
513 win_info
->check_and_display_highlight_if_needed ();
516 /* Resize all the windows based on the terminal size. This function
517 gets called from within the readline SIGWINCH handler. */
519 tui_resize_all (void)
521 int height_diff
, width_diff
;
522 int screenheight
, screenwidth
;
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
)
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;
537 #ifdef HAVE_RESIZE_TERM
538 resize_term (screenheight
, screenwidth
);
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
)
559 /* Now adjust each window. */
560 /* erase + clearok are used instead of a straightforward clear as
561 AIX 5.3 does not define clear. */
563 clearok (curscr
, TRUE
);
567 case DISASSEM_COMMAND
:
568 src_win
= *(tui_source_windows ().begin ());
569 /* Check for invalid heights. */
570 if (height_diff
== 0)
571 new_height
= src_win
->height
;
572 else if ((src_win
->height
+ split_diff
) >=
573 (screenheight
- MIN_CMD_WIN_HEIGHT
- 1))
574 new_height
= screenheight
- MIN_CMD_WIN_HEIGHT
- 1;
575 else if ((src_win
->height
+ split_diff
) <= 0)
576 new_height
= MIN_WIN_HEIGHT
;
578 new_height
= src_win
->height
+ split_diff
;
580 src_win
->resize (new_height
, screenwidth
, 0, 0);
582 locator
->resize (1, screenwidth
, 0, new_height
);
584 new_height
= screenheight
- (new_height
+ 1);
585 TUI_CMD_WIN
->resize (new_height
, screenwidth
,
586 0, locator
->origin
.y
+ 1);
589 if (cur_layout
== SRC_DISASSEM_COMMAND
)
591 src_win
= TUI_SRC_WIN
;
593 second_win
= TUI_DISASM_WIN
;
597 first_win
= TUI_DATA_WIN
;
598 src_win
= *(tui_source_windows ().begin ());
599 second_win
= src_win
;
601 /* Change the first window's height/width. */
602 /* Check for invalid heights. */
603 if (height_diff
== 0)
604 new_height
= first_win
->height
;
605 else if ((first_win
->height
+
606 second_win
->height
+ (split_diff
* 2)) >=
607 (screenheight
- MIN_CMD_WIN_HEIGHT
- 1))
608 new_height
= (screenheight
- MIN_CMD_WIN_HEIGHT
- 1) / 2;
609 else if ((first_win
->height
+ split_diff
) <= 0)
610 new_height
= MIN_WIN_HEIGHT
;
612 new_height
= first_win
->height
+ split_diff
;
614 first_win
->resize (new_height
, screenwidth
, 0, 0);
616 /* Change the second window's height/width. */
617 /* Check for invalid heights. */
618 if (height_diff
== 0)
619 new_height
= second_win
->height
;
620 else if ((first_win
->height
+
621 second_win
->height
+ (split_diff
* 2)) >=
622 (screenheight
- MIN_CMD_WIN_HEIGHT
- 1))
624 new_height
= screenheight
- MIN_CMD_WIN_HEIGHT
- 1;
626 new_height
= (new_height
/ 2) + 1;
630 else if ((second_win
->height
+ split_diff
) <= 0)
631 new_height
= MIN_WIN_HEIGHT
;
633 new_height
= second_win
->height
+ split_diff
;
635 second_win
->resize (new_height
, screenwidth
,
636 0, first_win
->height
- 1);
638 locator
->resize (1, screenwidth
,
639 0, second_win
->origin
.y
+ new_height
);
641 /* Change the command window's height/width. */
642 new_height
= screenheight
- (locator
->origin
.y
+ 1);
643 TUI_CMD_WIN
->resize (new_height
, screenwidth
,
644 0, locator
->origin
.y
+ 1);
648 tui_delete_invisible_windows ();
649 /* Turn keypad back on, unless focus is in the command
651 if (win_with_focus
!= TUI_CMD_WIN
)
652 keypad (TUI_CMD_WIN
->handle
, TRUE
);
657 /* Token for use by TUI's asynchronous SIGWINCH handler. */
658 static struct async_signal_handler
*tui_sigwinch_token
;
660 /* TUI's SIGWINCH signal handler. */
662 tui_sigwinch_handler (int signal
)
664 mark_async_signal_handler (tui_sigwinch_token
);
665 tui_set_win_resized_to (true);
668 /* Callback for asynchronously resizing TUI following a SIGWINCH signal. */
670 tui_async_resize_screen (gdb_client_data arg
)
672 rl_resize_terminal ();
676 int screen_height
, screen_width
;
678 rl_get_screen_size (&screen_height
, &screen_width
);
679 set_screen_width_and_height (screen_width
, screen_height
);
681 /* win_resized is left set so that the next call to tui_enable()
682 resizes the TUI windows. */
686 tui_set_win_resized_to (false);
688 tui_refresh_all_win ();
689 tui_update_gdb_sizes ();
690 tui_redisplay_readline ();
695 /* Initialize TUI's SIGWINCH signal handler. Note that the handler is not
696 uninstalled when we exit TUI, so the handler should not assume that TUI is
699 tui_initialize_win (void)
703 = create_async_signal_handler (tui_async_resize_screen
, NULL
);
706 #ifdef HAVE_SIGACTION
707 struct sigaction old_winch
;
709 memset (&old_winch
, 0, sizeof (old_winch
));
710 old_winch
.sa_handler
= &tui_sigwinch_handler
;
712 old_winch
.sa_flags
= SA_RESTART
;
714 sigaction (SIGWINCH
, &old_winch
, NULL
);
716 signal (SIGWINCH
, &tui_sigwinch_handler
);
723 /*************************
724 ** STATIC LOCAL FUNCTIONS
725 **************************/
729 tui_scroll_forward_command (const char *arg
, int from_tty
)
731 int num_to_scroll
= 1;
732 struct tui_win_info
*win_to_scroll
;
734 /* Make sure the curses mode is enabled. */
737 parse_scrolling_args (arg
, &win_to_scroll
, NULL
);
739 parse_scrolling_args (arg
, &win_to_scroll
, &num_to_scroll
);
740 win_to_scroll
->forward_scroll (num_to_scroll
);
745 tui_scroll_backward_command (const char *arg
, int from_tty
)
747 int num_to_scroll
= 1;
748 struct tui_win_info
*win_to_scroll
;
750 /* Make sure the curses mode is enabled. */
753 parse_scrolling_args (arg
, &win_to_scroll
, NULL
);
755 parse_scrolling_args (arg
, &win_to_scroll
, &num_to_scroll
);
756 win_to_scroll
->backward_scroll (num_to_scroll
);
761 tui_scroll_left_command (const char *arg
, int from_tty
)
764 struct tui_win_info
*win_to_scroll
;
766 /* Make sure the curses mode is enabled. */
768 parse_scrolling_args (arg
, &win_to_scroll
, &num_to_scroll
);
769 win_to_scroll
->left_scroll (num_to_scroll
);
774 tui_scroll_right_command (const char *arg
, int from_tty
)
777 struct tui_win_info
*win_to_scroll
;
779 /* Make sure the curses mode is enabled. */
781 parse_scrolling_args (arg
, &win_to_scroll
, &num_to_scroll
);
782 win_to_scroll
->right_scroll (num_to_scroll
);
786 /* Set focus to the window named by 'arg'. */
788 tui_set_focus_command (const char *arg
, int from_tty
)
794 char *buf_ptr
= xstrdup (arg
);
796 struct tui_win_info
*win_info
= NULL
;
798 for (i
= 0; (i
< strlen (buf_ptr
)); i
++)
799 buf_ptr
[i
] = tolower (arg
[i
]);
801 if (subset_compare (buf_ptr
, "next"))
802 win_info
= tui_next_win (tui_win_with_focus ());
803 else if (subset_compare (buf_ptr
, "prev"))
804 win_info
= tui_prev_win (tui_win_with_focus ());
806 win_info
= tui_partial_win_by_name (buf_ptr
);
808 if (win_info
== NULL
|| !win_info
->is_visible ())
809 warning (_("Invalid window specified. \n\
810 The window name specified must be valid and visible.\n"));
813 tui_set_win_focus_to (win_info
);
814 keypad (TUI_CMD_WIN
->handle
, (win_info
!= TUI_CMD_WIN
));
818 printf_filtered (_("Focus set to %s window.\n"),
819 tui_win_with_focus ()->name ());
822 warning (_("Incorrect Number of Arguments.\n%s"), FOCUS_USAGE
);
826 tui_all_windows_info (const char *arg
, int from_tty
)
828 struct tui_win_info
*win_with_focus
= tui_win_with_focus ();
829 struct ui_out
*uiout
= current_uiout
;
831 ui_out_emit_table
table_emitter (uiout
, 3, -1, "tui-windows");
832 uiout
->table_header (10, ui_left
, "name", "Name");
833 uiout
->table_header (5, ui_right
, "lines", "Lines");
834 uiout
->table_header (10, ui_left
, "focus", "Focus");
835 uiout
->table_body ();
837 for (tui_win_info
*win_info
: all_tui_windows ())
838 if (win_info
->is_visible ())
840 ui_out_emit_tuple
tuple_emitter (uiout
, nullptr);
842 uiout
->field_string ("name", win_info
->name ());
843 uiout
->field_signed ("lines", win_info
->height
);
844 if (win_with_focus
== win_info
)
845 uiout
->field_string ("focus", _("(has focus)"));
847 uiout
->field_skip ("focus");
854 tui_refresh_all_command (const char *arg
, int from_tty
)
856 /* Make sure the curses mode is enabled. */
859 tui_refresh_all_win ();
862 /* The tab width that should be used by the TUI. */
864 unsigned int tui_tab_width
= DEFAULT_TAB_LEN
;
866 /* The tab width as set by the user. */
868 static unsigned int internal_tab_width
= DEFAULT_TAB_LEN
;
870 /* After the tab width is set, call this to update the relevant
876 for (tui_win_info
*win_info
: all_tui_windows ())
878 if (win_info
->is_visible ())
879 win_info
->update_tab_width ();
883 /* Callback for "set tui tab-width". */
886 tui_set_tab_width (const char *ignore
,
887 int from_tty
, struct cmd_list_element
*c
)
889 if (internal_tab_width
== 0)
891 internal_tab_width
= tui_tab_width
;
892 error (_("Tab width must not be 0"));
895 tui_tab_width
= internal_tab_width
;
899 /* Callback for "show tui tab-width". */
902 tui_show_tab_width (struct ui_file
*file
, int from_tty
,
903 struct cmd_list_element
*c
, const char *value
)
905 fprintf_filtered (gdb_stdout
, _("TUI tab width is %s spaces.\n"), value
);
909 /* Set the tab width of the specified window. */
911 tui_set_tab_width_command (const char *arg
, int from_tty
)
913 /* Make sure the curses mode is enabled. */
921 warning (_("Tab widths greater than 0 must be specified."));
924 internal_tab_width
= ts
;
933 /* Set the height of the specified window. */
935 tui_set_win_height_command (const char *arg
, int from_tty
)
937 /* Make sure the curses mode is enabled. */
941 std::string copy
= arg
;
942 char *buf
= ©
[0];
946 struct tui_win_info
*win_info
;
949 buf_ptr
= strchr (buf_ptr
, ' ');
954 /* Validate the window name. */
955 for (i
= 0; i
< strlen (wname
); i
++)
956 wname
[i
] = tolower (wname
[i
]);
957 win_info
= tui_partial_win_by_name (wname
);
959 if (win_info
== NULL
|| !win_info
->is_visible ())
960 warning (_("Invalid window specified. \n\
961 The window name specified must be valid and visible.\n"));
964 /* Process the size. */
965 while (*(++buf_ptr
) == ' ')
968 if (*buf_ptr
!= (char) 0)
971 int fixed_size
= TRUE
;
974 if (*buf_ptr
== '+' || *buf_ptr
== '-')
981 input_no
= atoi (buf_ptr
);
987 new_height
= input_no
;
989 new_height
= win_info
->height
+ input_no
;
991 /* Now change the window's height, and adjust
992 all other windows around it. */
993 if (tui_adjust_win_heights (win_info
,
994 new_height
) == TUI_FAILURE
)
995 warning (_("Invalid window height specified.\n%s"),
998 tui_update_gdb_sizes ();
1001 warning (_("Invalid window height specified.\n%s"),
1007 printf_filtered (WIN_HEIGHT_USAGE
);
1010 printf_filtered (WIN_HEIGHT_USAGE
);
1013 /* Function to adjust all window heights around the primary. */
1014 static enum tui_status
1015 tui_adjust_win_heights (struct tui_win_info
*primary_win_info
,
1018 enum tui_status status
= TUI_FAILURE
;
1020 if (new_height_ok (primary_win_info
, new_height
))
1022 status
= TUI_SUCCESS
;
1023 if (new_height
!= primary_win_info
->height
)
1026 struct tui_win_info
*win_info
;
1027 struct tui_locator_window
*locator
= tui_locator_win_info_ptr ();
1028 enum tui_layout_type cur_layout
= tui_current_layout ();
1029 int width
= tui_term_width ();
1031 diff
= (new_height
- primary_win_info
->height
) * (-1);
1032 if (cur_layout
== SRC_COMMAND
1033 || cur_layout
== DISASSEM_COMMAND
)
1035 struct tui_win_info
*src_win_info
;
1037 primary_win_info
->resize (new_height
, width
,
1038 0, primary_win_info
->origin
.y
);
1039 if (primary_win_info
->type
== CMD_WIN
)
1041 win_info
= *(tui_source_windows ().begin ());
1042 src_win_info
= win_info
;
1046 win_info
= tui_win_list
[CMD_WIN
];
1047 src_win_info
= primary_win_info
;
1049 win_info
->resize (win_info
->height
+ diff
, width
,
1050 0, win_info
->origin
.y
);
1051 TUI_CMD_WIN
->origin
.y
= locator
->origin
.y
+ 1;
1052 if ((src_win_info
->type
== SRC_WIN
1053 || src_win_info
->type
== DISASSEM_WIN
))
1055 tui_source_window_base
*src_base
1056 = (tui_source_window_base
*) src_win_info
;
1057 if (src_base
->content
.empty ())
1058 src_base
->erase_source_content ();
1063 struct tui_win_info
*first_win
;
1064 struct tui_source_window_base
*second_win
;
1065 tui_source_window_base
*src1
;
1067 if (cur_layout
== SRC_DISASSEM_COMMAND
)
1071 second_win
= TUI_DISASM_WIN
;
1076 first_win
= TUI_DATA_WIN
;
1077 second_win
= *(tui_source_windows ().begin ());
1079 if (primary_win_info
== TUI_CMD_WIN
)
1080 { /* Split the change in height accross the 1st & 2nd
1081 windows, adjusting them as well. */
1082 /* Subtract the locator. */
1083 int first_split_diff
= diff
/ 2;
1084 int second_split_diff
= first_split_diff
;
1088 if (first_win
->height
>
1097 second_split_diff
--;
1099 second_split_diff
++;
1102 /* Make sure that the minimum hieghts are
1104 while ((first_win
->height
+ first_split_diff
) < 3)
1107 second_split_diff
--;
1109 while ((second_win
->height
+ second_split_diff
) < 3)
1111 second_split_diff
++;
1114 first_win
->resize (first_win
->height
+ first_split_diff
,
1116 0, first_win
->origin
.y
);
1117 second_win
->resize (second_win
->height
+ second_split_diff
,
1119 0, first_win
->height
- 1);
1120 locator
->resize (1, width
,
1121 0, (second_win
->origin
.y
1122 + second_win
->height
+ 1));
1124 TUI_CMD_WIN
->resize (new_height
, width
,
1125 0, locator
->origin
.y
+ 1);
1129 if ((TUI_CMD_WIN
->height
+ diff
) < 1)
1130 { /* If there is no way to increase the command
1131 window take real estate from the 1st or 2nd
1133 if ((TUI_CMD_WIN
->height
+ diff
) < 1)
1137 for (i
= TUI_CMD_WIN
->height
+ diff
;
1139 if (primary_win_info
== first_win
)
1140 second_win
->height
--;
1142 first_win
->height
--;
1145 if (primary_win_info
== first_win
)
1146 first_win
->resize (new_height
, width
, 0, 0);
1148 first_win
->resize (first_win
->height
, width
, 0, 0);
1149 second_win
->origin
.y
= first_win
->height
- 1;
1150 if (primary_win_info
== second_win
)
1151 second_win
->resize (new_height
, width
,
1152 0, first_win
->height
- 1);
1154 second_win
->resize (second_win
->height
, width
,
1155 0, first_win
->height
- 1);
1156 locator
->resize (1, width
,
1157 0, (second_win
->origin
.y
1158 + second_win
->height
+ 1));
1159 TUI_CMD_WIN
->origin
.y
= locator
->origin
.y
+ 1;
1160 if ((TUI_CMD_WIN
->height
+ diff
) < 1)
1161 TUI_CMD_WIN
->resize (1, width
, 0, locator
->origin
.y
+ 1);
1163 TUI_CMD_WIN
->resize (TUI_CMD_WIN
->height
+ diff
, width
,
1164 0, locator
->origin
.y
+ 1);
1166 if (src1
!= nullptr && src1
->content
.empty ())
1167 src1
->erase_source_content ();
1168 if (second_win
->content
.empty ())
1169 second_win
->erase_source_content ();
1177 /* See tui-data.h. */
1180 tui_win_info::max_height () const
1182 return tui_term_height () - 2;
1186 new_height_ok (struct tui_win_info
*primary_win_info
,
1189 int ok
= (new_height
< tui_term_height ());
1194 enum tui_layout_type cur_layout
= tui_current_layout ();
1196 diff
= (new_height
- primary_win_info
->height
) * (-1);
1197 if (cur_layout
== SRC_COMMAND
|| cur_layout
== DISASSEM_COMMAND
)
1199 ok
= (new_height
<= primary_win_info
->max_height ()
1200 && new_height
>= MIN_CMD_WIN_HEIGHT
);
1202 { /* Check the total height. */
1203 struct tui_win_info
*win_info
;
1205 if (primary_win_info
== TUI_CMD_WIN
)
1206 win_info
= *(tui_source_windows ().begin ());
1208 win_info
= TUI_CMD_WIN
;
1210 (win_info
->height
+ diff
)) <= tui_term_height ());
1215 int cur_total_height
, total_height
, min_height
= 0;
1216 struct tui_win_info
*first_win
;
1217 struct tui_win_info
*second_win
;
1219 if (cur_layout
== SRC_DISASSEM_COMMAND
)
1221 first_win
= TUI_SRC_WIN
;
1222 second_win
= TUI_DISASM_WIN
;
1226 first_win
= TUI_DATA_WIN
;
1227 second_win
= *(tui_source_windows ().begin ());
1229 /* We could simply add all the heights to obtain the same
1230 result but below is more explicit since we subtract 1 for
1231 the line that the first and second windows share, and add
1232 one for the locator. */
1233 total_height
= cur_total_height
=
1234 (first_win
->height
+ second_win
->height
- 1)
1235 + TUI_CMD_WIN
->height
+ 1; /* Locator. */
1236 if (primary_win_info
== TUI_CMD_WIN
)
1238 /* Locator included since first & second win share a line. */
1239 ok
= ((first_win
->height
+
1240 second_win
->height
+ diff
) >=
1241 (MIN_WIN_HEIGHT
* 2)
1242 && new_height
>= MIN_CMD_WIN_HEIGHT
);
1245 total_height
= new_height
+
1246 (first_win
->height
+
1247 second_win
->height
+ diff
);
1248 min_height
= MIN_CMD_WIN_HEIGHT
;
1253 min_height
= MIN_WIN_HEIGHT
;
1255 /* First see if we can increase/decrease the command
1256 window. And make sure that the command window is at
1258 ok
= ((TUI_CMD_WIN
->height
+ diff
) > 0);
1260 { /* Looks like we have to increase/decrease one of
1261 the other windows. */
1262 if (primary_win_info
== first_win
)
1263 ok
= (second_win
->height
+ diff
) >= min_height
;
1265 ok
= (first_win
->height
+ diff
) >= min_height
;
1269 if (primary_win_info
== first_win
)
1270 total_height
= new_height
+
1271 second_win
->height
+
1272 TUI_CMD_WIN
->height
+ diff
;
1274 total_height
= new_height
+
1276 TUI_CMD_WIN
->height
+ diff
;
1279 /* Now make sure that the proposed total height doesn't
1280 exceed the old total height. */
1282 ok
= (new_height
>= min_height
1283 && total_height
<= cur_total_height
);
1292 parse_scrolling_args (const char *arg
,
1293 struct tui_win_info
**win_to_scroll
,
1298 *win_to_scroll
= tui_win_with_focus ();
1300 /* First set up the default window to scroll, in case there is no
1306 /* Process the number of lines to scroll. */
1307 std::string copy
= arg
;
1309 if (isdigit (*buf_ptr
))
1314 buf_ptr
= strchr (buf_ptr
, ' ');
1315 if (buf_ptr
!= NULL
)
1317 *buf_ptr
= (char) 0;
1319 *num_to_scroll
= atoi (num_str
);
1322 else if (num_to_scroll
)
1323 *num_to_scroll
= atoi (num_str
);
1326 /* Process the window name if one is specified. */
1327 if (buf_ptr
!= NULL
)
1331 if (*buf_ptr
== ' ')
1332 while (*(++buf_ptr
) == ' ')
1335 if (*buf_ptr
!= (char) 0)
1337 /* Validate the window name. */
1338 for (char *p
= buf_ptr
; *p
!= '\0'; p
++)
1346 *win_to_scroll
= tui_partial_win_by_name (wname
);
1348 if (*win_to_scroll
== NULL
)
1349 error (_("Unrecognized window `%s'"), wname
);
1350 if (!(*win_to_scroll
)->is_visible ())
1351 error (_("Window is not visible"));
1352 else if (*win_to_scroll
== TUI_CMD_WIN
)
1353 *win_to_scroll
= *(tui_source_windows ().begin ());
1358 /* Function to initialize gdb commands, for tui window
1362 _initialize_tui_win (void)
1364 static struct cmd_list_element
*tui_setlist
;
1365 static struct cmd_list_element
*tui_showlist
;
1366 struct cmd_list_element
*cmd
;
1368 /* Define the classes of commands.
1369 They will appear in the help list in the reverse of this order. */
1370 add_prefix_cmd ("tui", class_tui
, set_tui_cmd
,
1371 _("TUI configuration variables."),
1372 &tui_setlist
, "set tui ",
1373 0 /* allow-unknown */, &setlist
);
1374 add_prefix_cmd ("tui", class_tui
, show_tui_cmd
,
1375 _("TUI configuration variables."),
1376 &tui_showlist
, "show tui ",
1377 0 /* allow-unknown */, &showlist
);
1379 add_com ("refresh", class_tui
, tui_refresh_all_command
,
1380 _("Refresh the terminal display."));
1382 cmd
= add_com ("tabset", class_tui
, tui_set_tab_width_command
, _("\
1383 Set the width (in characters) of tab stops.\n\
1385 deprecate_cmd (cmd
, "set tui tab-width");
1387 cmd
= add_com ("winheight", class_tui
, tui_set_win_height_command
, _("\
1388 Set or modify the height of a specified window.\n"
1390 "Window names are:\n\
1391 src : the source window\n\
1392 cmd : the command window\n\
1393 asm : the disassembly window\n\
1394 regs : the register display"));
1395 add_com_alias ("wh", "winheight", class_tui
, 0);
1396 set_cmd_completer (cmd
, winheight_completer
);
1397 add_info ("win", tui_all_windows_info
,
1398 _("List of all displayed windows."));
1399 cmd
= add_com ("focus", class_tui
, tui_set_focus_command
, _("\
1400 Set focus to named window or next/prev window.\n"
1402 "Valid Window names are:\n\
1403 src : the source window\n\
1404 asm : the disassembly window\n\
1405 regs : the register display\n\
1406 cmd : the command window"));
1407 add_com_alias ("fs", "focus", class_tui
, 0);
1408 set_cmd_completer (cmd
, focus_completer
);
1409 add_com ("+", class_tui
, tui_scroll_forward_command
, _("\
1410 Scroll window forward.\n\
1411 Usage: + [WIN] [N]"));
1412 add_com ("-", class_tui
, tui_scroll_backward_command
, _("\
1413 Scroll window backward.\n\
1414 Usage: - [WIN] [N]"));
1415 add_com ("<", class_tui
, tui_scroll_left_command
, _("\
1416 Scroll window text to the left.\n\
1417 Usage: < [WIN] [N]"));
1418 add_com (">", class_tui
, tui_scroll_right_command
, _("\
1419 Scroll window text to the right.\n\
1420 Usage: > [WIN] [N]"));
1422 /* Define the tui control variables. */
1423 add_setshow_enum_cmd ("border-kind", no_class
, tui_border_kind_enums
,
1424 &tui_border_kind
, _("\
1425 Set the kind of border for TUI windows."), _("\
1426 Show the kind of border for TUI windows."), _("\
1427 This variable controls the border of TUI windows:\n\
1428 space use a white space\n\
1429 ascii use ascii characters + - | for the border\n\
1430 acs use the Alternate Character Set"),
1432 show_tui_border_kind
,
1433 &tui_setlist
, &tui_showlist
);
1435 add_setshow_enum_cmd ("border-mode", no_class
, tui_border_mode_enums
,
1436 &tui_border_mode
, _("\
1437 Set the attribute mode to use for the TUI window borders."), _("\
1438 Show the attribute mode to use for the TUI window borders."), _("\
1439 This variable controls the attributes to use for the window borders:\n\
1440 normal normal display\n\
1441 standout use highlight mode of terminal\n\
1442 reverse use reverse video mode\n\
1443 half use half bright\n\
1444 half-standout use half bright and standout mode\n\
1445 bold use extra bright or bold\n\
1446 bold-standout use extra bright or bold with standout mode"),
1448 show_tui_border_mode
,
1449 &tui_setlist
, &tui_showlist
);
1451 add_setshow_enum_cmd ("active-border-mode", no_class
, tui_border_mode_enums
,
1452 &tui_active_border_mode
, _("\
1453 Set the attribute mode to use for the active TUI window border."), _("\
1454 Show the attribute mode to use for the active TUI window border."), _("\
1455 This variable controls the attributes to use for the active window border:\n\
1456 normal normal display\n\
1457 standout use highlight mode of terminal\n\
1458 reverse use reverse video mode\n\
1459 half use half bright\n\
1460 half-standout use half bright and standout mode\n\
1461 bold use extra bright or bold\n\
1462 bold-standout use extra bright or bold with standout mode"),
1464 show_tui_active_border_mode
,
1465 &tui_setlist
, &tui_showlist
);
1467 add_setshow_zuinteger_cmd ("tab-width", no_class
,
1468 &internal_tab_width
, _("\
1469 Set the tab width, in characters, for the TUI."), _("\
1470 Show the tab witdh, in characters, for the TUI."), _("\
1471 This variable controls how many spaces are used to display a tab character."),
1472 tui_set_tab_width
, tui_show_tab_width
,
1473 &tui_setlist
, &tui_showlist
);