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-data.h"
40 #include "tui/tui-wingeneral.h"
41 #include "tui/tui-stack.h"
42 #include "tui/tui-regs.h"
43 #include "tui/tui-disasm.h"
44 #include "tui/tui-source.h"
45 #include "tui/tui-winsource.h"
46 #include "tui/tui-windata.h"
47 #include "tui/tui-win.h"
49 #include "gdb_curses.h"
51 #include "readline/readline.h"
55 /*******************************
57 ********************************/
58 static void make_invisible_and_set_new_height (struct tui_win_info
*,
60 static enum tui_status
tui_adjust_win_heights (struct tui_win_info
*,
62 static int new_height_ok (struct tui_win_info
*, int);
63 static void tui_set_tab_width_command (const char *, int);
64 static void tui_refresh_all_command (const char *, int);
65 static void tui_set_win_height_command (const char *, int);
66 static void tui_all_windows_info (const char *, int);
67 static void tui_set_focus_command (const char *, int);
68 static void tui_scroll_forward_command (const char *, int);
69 static void tui_scroll_backward_command (const char *, int);
70 static void tui_scroll_left_command (const char *, int);
71 static void tui_scroll_right_command (const char *, int);
72 static void parse_scrolling_args (const char *,
73 struct tui_win_info
**,
77 /***************************************
79 ***************************************/
80 #define WIN_HEIGHT_USAGE "Usage: winheight WINDOW-NAME [+ | -] NUM-LINES\n"
81 #define FOCUS_USAGE "Usage: focus [WINDOW-NAME | next | prev]\n"
83 /***************************************
85 ***************************************/
88 # define ACS_LRCORNER '+'
91 # define ACS_LLCORNER '+'
94 # define ACS_ULCORNER '+'
97 # define ACS_URCORNER '+'
100 # define ACS_HLINE '-'
103 # define ACS_VLINE '|'
106 /* Possible values for tui-border-kind variable. */
107 static const char *const tui_border_kind_enums
[] = {
114 /* Possible values for tui-border-mode and tui-active-border-mode. */
115 static const char *const tui_border_mode_enums
[] = {
132 /* Translation table for border-mode variables.
133 The list of values must be terminated by a NULL.
134 After the NULL value, an entry defines the default. */
135 struct tui_translate tui_border_mode_translate
[] = {
136 { "normal", A_NORMAL
},
137 { "standout", A_STANDOUT
},
138 { "reverse", A_REVERSE
},
140 { "half-standout", A_DIM
| A_STANDOUT
},
142 { "bold-standout", A_BOLD
| A_STANDOUT
},
144 { "normal", A_NORMAL
}
147 /* Translation tables for border-kind, one for each border
148 character (see wborder, border curses operations).
149 -1 is used to indicate the ACS because ACS characters
150 are determined at run time by curses (depends on terminal). */
151 struct tui_translate tui_border_kind_translate_vline
[] = {
159 struct tui_translate tui_border_kind_translate_hline
[] = {
167 struct tui_translate tui_border_kind_translate_ulcorner
[] = {
175 struct tui_translate tui_border_kind_translate_urcorner
[] = {
183 struct tui_translate tui_border_kind_translate_llcorner
[] = {
191 struct tui_translate tui_border_kind_translate_lrcorner
[] = {
200 /* Tui configuration variables controlled with set/show command. */
201 const char *tui_active_border_mode
= "bold-standout";
203 show_tui_active_border_mode (struct ui_file
*file
,
205 struct cmd_list_element
*c
,
208 fprintf_filtered (file
, _("\
209 The attribute mode to use for the active TUI window border is \"%s\".\n"),
213 const char *tui_border_mode
= "normal";
215 show_tui_border_mode (struct ui_file
*file
,
217 struct cmd_list_element
*c
,
220 fprintf_filtered (file
, _("\
221 The attribute mode to use for the TUI window borders is \"%s\".\n"),
225 const char *tui_border_kind
= "acs";
227 show_tui_border_kind (struct ui_file
*file
,
229 struct cmd_list_element
*c
,
232 fprintf_filtered (file
, _("The kind of border for TUI windows is \"%s\".\n"),
237 /* Tui internal configuration variables. These variables are updated
238 by tui_update_variables to reflect the tui configuration
240 chtype tui_border_vline
;
241 chtype tui_border_hline
;
242 chtype tui_border_ulcorner
;
243 chtype tui_border_urcorner
;
244 chtype tui_border_llcorner
;
245 chtype tui_border_lrcorner
;
247 int tui_border_attrs
;
248 int tui_active_border_attrs
;
250 /* Identify the item in the translation table.
251 When the item is not recognized, use the default entry. */
252 static struct tui_translate
*
253 translate (const char *name
, struct tui_translate
*table
)
257 if (name
&& strcmp (table
->name
, name
) == 0)
262 /* Not found, return default entry. */
267 /* Update the tui internal configuration according to gdb settings.
268 Returns 1 if the configuration has changed and the screen should
271 tui_update_variables (void)
274 struct tui_translate
*entry
;
276 entry
= translate (tui_border_mode
, tui_border_mode_translate
);
277 if (tui_border_attrs
!= entry
->value
)
279 tui_border_attrs
= entry
->value
;
282 entry
= translate (tui_active_border_mode
, tui_border_mode_translate
);
283 if (tui_active_border_attrs
!= entry
->value
)
285 tui_active_border_attrs
= entry
->value
;
289 /* If one corner changes, all characters are changed.
290 Only check the first one. The ACS characters are determined at
291 run time by curses terminal management. */
292 entry
= translate (tui_border_kind
, tui_border_kind_translate_lrcorner
);
293 if (tui_border_lrcorner
!= (chtype
) entry
->value
)
295 tui_border_lrcorner
= (entry
->value
< 0) ? ACS_LRCORNER
: entry
->value
;
298 entry
= translate (tui_border_kind
, tui_border_kind_translate_llcorner
);
299 tui_border_llcorner
= (entry
->value
< 0) ? ACS_LLCORNER
: entry
->value
;
301 entry
= translate (tui_border_kind
, tui_border_kind_translate_ulcorner
);
302 tui_border_ulcorner
= (entry
->value
< 0) ? ACS_ULCORNER
: entry
->value
;
304 entry
= translate (tui_border_kind
, tui_border_kind_translate_urcorner
);
305 tui_border_urcorner
= (entry
->value
< 0) ? ACS_URCORNER
: entry
->value
;
307 entry
= translate (tui_border_kind
, tui_border_kind_translate_hline
);
308 tui_border_hline
= (entry
->value
< 0) ? ACS_HLINE
: entry
->value
;
310 entry
= translate (tui_border_kind
, tui_border_kind_translate_vline
);
311 tui_border_vline
= (entry
->value
< 0) ? ACS_VLINE
: entry
->value
;
317 set_tui_cmd (const char *args
, int from_tty
)
322 show_tui_cmd (const char *args
, int from_tty
)
326 static struct cmd_list_element
*tuilist
;
329 tui_command (const char *args
, int from_tty
)
331 printf_unfiltered (_("\"tui\" must be followed by the name of a "
333 help_list (tuilist
, "tui ", all_commands
, gdb_stdout
);
336 struct cmd_list_element
**
337 tui_get_cmd_list (void)
340 add_prefix_cmd ("tui", class_tui
, tui_command
,
341 _("Text User Interface commands."),
342 &tuilist
, "tui ", 0, &cmdlist
);
346 /* The set_func hook of "set tui ..." commands that affect the window
347 borders on the TUI display. */
349 tui_set_var_cmd (const char *null_args
,
350 int from_tty
, struct cmd_list_element
*c
)
352 if (tui_update_variables () && tui_active
)
353 tui_rehighlight_all ();
356 /* Generic window name completion function. Complete window name pointed
357 to by TEXT and WORD. If INCLUDE_NEXT_PREV_P is true then the special
358 window names 'next' and 'prev' will also be considered as possible
359 completions of the window name. */
362 window_name_completer (completion_tracker
&tracker
,
363 int include_next_prev_p
,
364 const char *text
, const char *word
)
366 std::vector
<const char *> completion_name_vec
;
368 for (tui_win_info
*win_info
: all_tui_windows ())
370 const char *completion_name
= NULL
;
372 /* We can't focus on an invisible window. */
373 if (!win_info
->is_visible
)
376 completion_name
= win_info
->name ();
377 gdb_assert (completion_name
!= NULL
);
378 completion_name_vec
.push_back (completion_name
);
381 /* If no windows are considered visible then the TUI has not yet been
382 initialized. But still "focus src" and "focus cmd" will work because
383 invoking the focus command will entail initializing the TUI which sets the
384 default layout to SRC_COMMAND. */
385 if (completion_name_vec
.empty ())
387 completion_name_vec
.push_back (SRC_NAME
);
388 completion_name_vec
.push_back (CMD_NAME
);
391 if (include_next_prev_p
)
393 completion_name_vec
.push_back ("next");
394 completion_name_vec
.push_back ("prev");
398 completion_name_vec
.push_back (NULL
);
399 complete_on_enum (tracker
, completion_name_vec
.data (), text
, word
);
402 /* Complete possible window names to focus on. TEXT is the complete text
403 entered so far, WORD is the word currently being completed. */
406 focus_completer (struct cmd_list_element
*ignore
,
407 completion_tracker
&tracker
,
408 const char *text
, const char *word
)
410 window_name_completer (tracker
, 1, text
, word
);
413 /* Complete possible window names for winheight command. TEXT is the
414 complete text entered so far, WORD is the word currently being
418 winheight_completer (struct cmd_list_element
*ignore
,
419 completion_tracker
&tracker
,
420 const char *text
, const char *word
)
422 /* The first word is the window name. That we can complete. Subsequent
423 words can't be completed. */
427 window_name_completer (tracker
, 0, text
, word
);
430 /* Update gdb's knowledge of the terminal size. */
432 tui_update_gdb_sizes (void)
438 width
= TUI_CMD_WIN
->width
;
439 height
= TUI_CMD_WIN
->height
;
443 width
= tui_term_width ();
444 height
= tui_term_height ();
447 set_screen_width_and_height (width
, height
);
451 /* Set the logical focus to win_info. */
453 tui_set_win_focus_to (struct tui_win_info
*win_info
)
455 if (win_info
!= NULL
)
457 struct tui_win_info
*win_with_focus
= tui_win_with_focus ();
459 tui_unhighlight_win (win_with_focus
);
460 tui_set_win_with_focus (win_info
);
461 tui_highlight_win (win_info
);
467 tui_win_info::forward_scroll (int num_to_scroll
)
469 if (num_to_scroll
== 0)
470 num_to_scroll
= height
- 3;
472 do_scroll_vertical (num_to_scroll
);
476 tui_win_info::backward_scroll (int num_to_scroll
)
478 if (num_to_scroll
== 0)
479 num_to_scroll
= height
- 3;
481 do_scroll_vertical (-num_to_scroll
);
486 tui_win_info::left_scroll (int num_to_scroll
)
488 if (num_to_scroll
== 0)
491 do_scroll_horizontal (num_to_scroll
);
496 tui_win_info::right_scroll (int num_to_scroll
)
498 if (num_to_scroll
== 0)
501 do_scroll_horizontal (-num_to_scroll
);
505 /* See tui-data.h. */
508 tui_source_window_base::refresh_all ()
510 tui_show_source_content (this);
511 tui_check_and_display_highlight_if_needed (this);
512 tui_erase_exec_info_content (this);
513 tui_update_exec_info (this);
517 tui_refresh_all_win (void)
519 clearok (curscr
, TRUE
);
521 for (tui_win_info
*win_info
: all_tui_windows ())
523 if (win_info
->is_visible
)
524 win_info
->refresh_all ();
526 tui_show_locator_content ();
530 tui_rehighlight_all (void)
532 for (tui_win_info
*win_info
: all_tui_windows ())
533 tui_check_and_display_highlight_if_needed (win_info
);
536 /* Resize all the windows based on the terminal size. This function
537 gets called from within the readline SIGWINCH handler. */
539 tui_resize_all (void)
541 int height_diff
, width_diff
;
542 int screenheight
, screenwidth
;
544 rl_get_screen_size (&screenheight
, &screenwidth
);
545 width_diff
= screenwidth
- tui_term_width ();
546 height_diff
= screenheight
- tui_term_height ();
547 if (height_diff
|| width_diff
)
549 enum tui_layout_type cur_layout
= tui_current_layout ();
550 struct tui_win_info
*win_with_focus
= tui_win_with_focus ();
551 struct tui_win_info
*first_win
;
552 struct tui_win_info
*second_win
;
553 tui_source_window_base
*src_win
;
554 struct tui_locator_window
*locator
= tui_locator_win_info_ptr ();
556 int new_height
, split_diff
, cmd_split_diff
, num_wins_displayed
= 2;
558 #ifdef HAVE_RESIZE_TERM
559 resize_term (screenheight
, screenwidth
);
561 /* Turn keypad off while we resize. */
562 if (win_with_focus
!= TUI_CMD_WIN
)
563 keypad (TUI_CMD_WIN
->handle
, FALSE
);
564 tui_update_gdb_sizes ();
565 tui_set_term_height_to (screenheight
);
566 tui_set_term_width_to (screenwidth
);
567 if (cur_layout
== SRC_DISASSEM_COMMAND
568 || cur_layout
== SRC_DATA_COMMAND
569 || cur_layout
== DISASSEM_DATA_COMMAND
)
570 num_wins_displayed
++;
571 split_diff
= height_diff
/ num_wins_displayed
;
572 cmd_split_diff
= split_diff
;
573 if (height_diff
% num_wins_displayed
)
580 /* Now adjust each window. */
581 /* erase + clearok are used instead of a straightforward clear as
582 AIX 5.3 does not define clear. */
584 clearok (curscr
, TRUE
);
589 case DISASSEM_COMMAND
:
590 src_win
= tui_source_windows ()[0];
592 first_win
->width
+= width_diff
;
593 locator
->width
+= width_diff
;
594 /* Check for invalid heights. */
595 if (height_diff
== 0)
596 new_height
= first_win
->height
;
597 else if ((first_win
->height
+ split_diff
) >=
598 (screenheight
- MIN_CMD_WIN_HEIGHT
- 1))
599 new_height
= screenheight
- MIN_CMD_WIN_HEIGHT
- 1;
600 else if ((first_win
->height
+ split_diff
) <= 0)
601 new_height
= MIN_WIN_HEIGHT
;
603 new_height
= first_win
->height
+ split_diff
;
605 locator
->origin
.y
= new_height
+ 1;
606 make_invisible_and_set_new_height (first_win
, new_height
);
607 TUI_CMD_WIN
->origin
.y
= locator
->origin
.y
+ 1;
608 TUI_CMD_WIN
->width
+= width_diff
;
609 new_height
= screenheight
- TUI_CMD_WIN
->origin
.y
;
610 make_invisible_and_set_new_height (TUI_CMD_WIN
, new_height
);
611 first_win
->make_visible_with_new_height ();
612 TUI_CMD_WIN
->make_visible_with_new_height ();
613 if (src_win
->content
.empty ())
614 tui_erase_source_content (src_win
, EMPTY_SOURCE_PROMPT
);
617 if (cur_layout
== SRC_DISASSEM_COMMAND
)
619 src_win
= TUI_SRC_WIN
;
621 first_win
->width
+= width_diff
;
622 second_win
= TUI_DISASM_WIN
;
623 second_win
->width
+= width_diff
;
627 first_win
= TUI_DATA_WIN
;
628 first_win
->width
+= width_diff
;
629 src_win
= tui_source_windows ()[0];
630 second_win
= src_win
;
631 second_win
->width
+= width_diff
;
633 /* Change the first window's height/width. */
634 /* Check for invalid heights. */
635 if (height_diff
== 0)
636 new_height
= first_win
->height
;
637 else if ((first_win
->height
+
638 second_win
->height
+ (split_diff
* 2)) >=
639 (screenheight
- MIN_CMD_WIN_HEIGHT
- 1))
640 new_height
= (screenheight
- MIN_CMD_WIN_HEIGHT
- 1) / 2;
641 else if ((first_win
->height
+ split_diff
) <= 0)
642 new_height
= MIN_WIN_HEIGHT
;
644 new_height
= first_win
->height
+ split_diff
;
645 make_invisible_and_set_new_height (first_win
, new_height
);
647 locator
->width
+= width_diff
;
649 /* Change the second window's height/width. */
650 /* Check for invalid heights. */
651 if (height_diff
== 0)
652 new_height
= second_win
->height
;
653 else if ((first_win
->height
+
654 second_win
->height
+ (split_diff
* 2)) >=
655 (screenheight
- MIN_CMD_WIN_HEIGHT
- 1))
657 new_height
= screenheight
- MIN_CMD_WIN_HEIGHT
- 1;
659 new_height
= (new_height
/ 2) + 1;
663 else if ((second_win
->height
+ split_diff
) <= 0)
664 new_height
= MIN_WIN_HEIGHT
;
666 new_height
= second_win
->height
+ split_diff
;
667 second_win
->origin
.y
= first_win
->height
- 1;
668 make_invisible_and_set_new_height (second_win
, new_height
);
670 /* Change the command window's height/width. */
671 TUI_CMD_WIN
->origin
.y
= locator
->origin
.y
+ 1;
672 make_invisible_and_set_new_height (TUI_CMD_WIN
,
675 first_win
->make_visible_with_new_height ();
676 second_win
->make_visible_with_new_height ();
677 TUI_CMD_WIN
->make_visible_with_new_height ();
678 if (src_win
->content
.empty ())
679 tui_erase_source_content (src_win
, EMPTY_SOURCE_PROMPT
);
682 /* Now remove all invisible windows, and their content so that
683 they get created again when called for with the new size. */
684 for (win_type
= SRC_WIN
; (win_type
< MAX_MAJOR_WINDOWS
); win_type
++)
686 if (win_type
!= CMD_WIN
687 && (tui_win_list
[win_type
] != NULL
)
688 && !tui_win_list
[win_type
]->is_visible
)
690 delete tui_win_list
[win_type
];
691 tui_win_list
[win_type
] = NULL
;
694 /* Turn keypad back on, unless focus is in the command
696 if (win_with_focus
!= TUI_CMD_WIN
)
697 keypad (TUI_CMD_WIN
->handle
, TRUE
);
702 /* Token for use by TUI's asynchronous SIGWINCH handler. */
703 static struct async_signal_handler
*tui_sigwinch_token
;
705 /* TUI's SIGWINCH signal handler. */
707 tui_sigwinch_handler (int signal
)
709 mark_async_signal_handler (tui_sigwinch_token
);
710 tui_set_win_resized_to (TRUE
);
713 /* Callback for asynchronously resizing TUI following a SIGWINCH signal. */
715 tui_async_resize_screen (gdb_client_data arg
)
717 rl_resize_terminal ();
721 int screen_height
, screen_width
;
723 rl_get_screen_size (&screen_height
, &screen_width
);
724 set_screen_width_and_height (screen_width
, screen_height
);
726 /* win_resized is left set so that the next call to tui_enable()
727 resizes the TUI windows. */
731 tui_set_win_resized_to (FALSE
);
733 tui_refresh_all_win ();
734 tui_update_gdb_sizes ();
735 tui_redisplay_readline ();
740 /* Initialize TUI's SIGWINCH signal handler. Note that the handler is not
741 uninstalled when we exit TUI, so the handler should not assume that TUI is
744 tui_initialize_win (void)
748 = create_async_signal_handler (tui_async_resize_screen
, NULL
);
751 #ifdef HAVE_SIGACTION
752 struct sigaction old_winch
;
754 memset (&old_winch
, 0, sizeof (old_winch
));
755 old_winch
.sa_handler
= &tui_sigwinch_handler
;
757 old_winch
.sa_flags
= SA_RESTART
;
759 sigaction (SIGWINCH
, &old_winch
, NULL
);
761 signal (SIGWINCH
, &tui_sigwinch_handler
);
768 /*************************
769 ** STATIC LOCAL FUNCTIONS
770 **************************/
774 tui_scroll_forward_command (const char *arg
, int from_tty
)
776 int num_to_scroll
= 1;
777 struct tui_win_info
*win_to_scroll
;
779 /* Make sure the curses mode is enabled. */
782 parse_scrolling_args (arg
, &win_to_scroll
, NULL
);
784 parse_scrolling_args (arg
, &win_to_scroll
, &num_to_scroll
);
785 win_to_scroll
->forward_scroll (num_to_scroll
);
790 tui_scroll_backward_command (const char *arg
, int from_tty
)
792 int num_to_scroll
= 1;
793 struct tui_win_info
*win_to_scroll
;
795 /* Make sure the curses mode is enabled. */
798 parse_scrolling_args (arg
, &win_to_scroll
, NULL
);
800 parse_scrolling_args (arg
, &win_to_scroll
, &num_to_scroll
);
801 win_to_scroll
->backward_scroll (num_to_scroll
);
806 tui_scroll_left_command (const char *arg
, int from_tty
)
809 struct tui_win_info
*win_to_scroll
;
811 /* Make sure the curses mode is enabled. */
813 parse_scrolling_args (arg
, &win_to_scroll
, &num_to_scroll
);
814 win_to_scroll
->left_scroll (num_to_scroll
);
819 tui_scroll_right_command (const char *arg
, int from_tty
)
822 struct tui_win_info
*win_to_scroll
;
824 /* Make sure the curses mode is enabled. */
826 parse_scrolling_args (arg
, &win_to_scroll
, &num_to_scroll
);
827 win_to_scroll
->right_scroll (num_to_scroll
);
831 /* Set focus to the window named by 'arg'. */
833 tui_set_focus (const char *arg
, int from_tty
)
837 char *buf_ptr
= xstrdup (arg
);
839 struct tui_win_info
*win_info
= NULL
;
841 for (i
= 0; (i
< strlen (buf_ptr
)); i
++)
842 buf_ptr
[i
] = tolower (arg
[i
]);
844 if (subset_compare (buf_ptr
, "next"))
845 win_info
= tui_next_win (tui_win_with_focus ());
846 else if (subset_compare (buf_ptr
, "prev"))
847 win_info
= tui_prev_win (tui_win_with_focus ());
849 win_info
= tui_partial_win_by_name (buf_ptr
);
851 if (win_info
== NULL
|| !win_info
->is_visible
)
852 warning (_("Invalid window specified. \n\
853 The window name specified must be valid and visible.\n"));
856 tui_set_win_focus_to (win_info
);
857 keypad (TUI_CMD_WIN
->handle
, (win_info
!= TUI_CMD_WIN
));
860 if (TUI_DATA_WIN
&& TUI_DATA_WIN
->is_visible
)
861 TUI_DATA_WIN
->refresh_all ();
863 printf_filtered (_("Focus set to %s window.\n"),
864 tui_win_with_focus ()->name ());
867 warning (_("Incorrect Number of Arguments.\n%s"), FOCUS_USAGE
);
871 tui_set_focus_command (const char *arg
, int from_tty
)
873 /* Make sure the curses mode is enabled. */
875 tui_set_focus (arg
, from_tty
);
880 tui_all_windows_info (const char *arg
, int from_tty
)
882 struct tui_win_info
*win_with_focus
= tui_win_with_focus ();
884 for (tui_win_info
*win_info
: all_tui_windows ())
885 if (win_info
->is_visible
)
887 if (win_with_focus
== win_info
)
888 printf_filtered (" %s\t(%d lines) <has focus>\n",
892 printf_filtered (" %s\t(%d lines)\n",
900 tui_refresh_all_command (const char *arg
, int from_tty
)
902 /* Make sure the curses mode is enabled. */
905 tui_refresh_all_win ();
908 /* The tab width that should be used by the TUI. */
910 unsigned int tui_tab_width
= DEFAULT_TAB_LEN
;
912 /* The tab width as set by the user. */
914 static unsigned int internal_tab_width
= DEFAULT_TAB_LEN
;
916 /* See tui-data.h. */
919 tui_source_window_base::update_tab_width ()
921 /* We don't really change the height of any windows, but
922 calling these 2 functions causes a complete regeneration
923 and redisplay of the window's contents, which will take
924 the new tab width into account. */
925 make_invisible_and_set_new_height (this, height
);
926 make_visible_with_new_height ();
929 /* After the tab width is set, call this to update the relevant
935 for (tui_win_info
*win_info
: all_tui_windows ())
937 if (win_info
->is_visible
)
938 win_info
->update_tab_width ();
942 /* Callback for "set tui tab-width". */
945 tui_set_tab_width (const char *ignore
,
946 int from_tty
, struct cmd_list_element
*c
)
948 if (internal_tab_width
== 0)
950 internal_tab_width
= tui_tab_width
;
951 error (_("Tab width must not be 0"));
954 tui_tab_width
= internal_tab_width
;
958 /* Callback for "show tui tab-width". */
961 tui_show_tab_width (struct ui_file
*file
, int from_tty
,
962 struct cmd_list_element
*c
, const char *value
)
964 fprintf_filtered (gdb_stdout
, _("TUI tab width is %s spaces.\n"), value
);
968 /* Set the tab width of the specified window. */
970 tui_set_tab_width_command (const char *arg
, int from_tty
)
972 /* Make sure the curses mode is enabled. */
980 warning (_("Tab widths greater than 0 must be specified."));
983 internal_tab_width
= ts
;
992 /* Set the height of the specified window. */
994 tui_set_win_height (const char *arg
, int from_tty
)
996 /* Make sure the curses mode is enabled. */
1000 std::string copy
= arg
;
1001 char *buf
= ©
[0];
1002 char *buf_ptr
= buf
;
1005 struct tui_win_info
*win_info
;
1008 buf_ptr
= strchr (buf_ptr
, ' ');
1009 if (buf_ptr
!= NULL
)
1011 *buf_ptr
= (char) 0;
1013 /* Validate the window name. */
1014 for (i
= 0; i
< strlen (wname
); i
++)
1015 wname
[i
] = tolower (wname
[i
]);
1016 win_info
= tui_partial_win_by_name (wname
);
1018 if (win_info
== NULL
|| !win_info
->is_visible
)
1019 warning (_("Invalid window specified. \n\
1020 The window name specified must be valid and visible.\n"));
1023 /* Process the size. */
1024 while (*(++buf_ptr
) == ' ')
1027 if (*buf_ptr
!= (char) 0)
1030 int fixed_size
= TRUE
;
1033 if (*buf_ptr
== '+' || *buf_ptr
== '-')
1035 if (*buf_ptr
== '-')
1040 input_no
= atoi (buf_ptr
);
1046 new_height
= input_no
;
1048 new_height
= win_info
->height
+ input_no
;
1050 /* Now change the window's height, and adjust
1051 all other windows around it. */
1052 if (tui_adjust_win_heights (win_info
,
1053 new_height
) == TUI_FAILURE
)
1054 warning (_("Invalid window height specified.\n%s"),
1057 tui_update_gdb_sizes ();
1060 warning (_("Invalid window height specified.\n%s"),
1066 printf_filtered (WIN_HEIGHT_USAGE
);
1069 printf_filtered (WIN_HEIGHT_USAGE
);
1072 /* Set the height of the specified window, with va_list. */
1074 tui_set_win_height_command (const char *arg
, int from_tty
)
1076 /* Make sure the curses mode is enabled. */
1078 tui_set_win_height (arg
, from_tty
);
1081 /* Function to adjust all window heights around the primary. */
1082 static enum tui_status
1083 tui_adjust_win_heights (struct tui_win_info
*primary_win_info
,
1086 enum tui_status status
= TUI_FAILURE
;
1088 if (new_height_ok (primary_win_info
, new_height
))
1090 status
= TUI_SUCCESS
;
1091 if (new_height
!= primary_win_info
->height
)
1094 struct tui_win_info
*win_info
;
1095 struct tui_locator_window
*locator
= tui_locator_win_info_ptr ();
1096 enum tui_layout_type cur_layout
= tui_current_layout ();
1098 diff
= (new_height
- primary_win_info
->height
) * (-1);
1099 if (cur_layout
== SRC_COMMAND
1100 || cur_layout
== DISASSEM_COMMAND
)
1102 struct tui_win_info
*src_win_info
;
1104 make_invisible_and_set_new_height (primary_win_info
, new_height
);
1105 if (primary_win_info
->type
== CMD_WIN
)
1107 win_info
= tui_source_windows ()[0];
1108 src_win_info
= win_info
;
1112 win_info
= tui_win_list
[CMD_WIN
];
1113 src_win_info
= primary_win_info
;
1115 make_invisible_and_set_new_height (win_info
,
1116 win_info
->height
+ diff
);
1117 TUI_CMD_WIN
->origin
.y
= locator
->origin
.y
+ 1;
1118 win_info
->make_visible_with_new_height ();
1119 primary_win_info
->make_visible_with_new_height ();
1120 if ((src_win_info
->type
== SRC_WIN
1121 || src_win_info
->type
== DISASSEM_WIN
))
1123 tui_source_window_base
*src_base
1124 = (tui_source_window_base
*) src_win_info
;
1125 if (src_base
->content
.empty ())
1126 tui_erase_source_content (src_base
,
1127 EMPTY_SOURCE_PROMPT
);
1132 struct tui_win_info
*first_win
;
1133 struct tui_source_window_base
*second_win
;
1134 tui_source_window_base
*src1
;
1136 if (cur_layout
== SRC_DISASSEM_COMMAND
)
1140 second_win
= TUI_DISASM_WIN
;
1145 first_win
= TUI_DATA_WIN
;
1146 second_win
= tui_source_windows ()[0];
1148 if (primary_win_info
== TUI_CMD_WIN
)
1149 { /* Split the change in height accross the 1st & 2nd
1150 windows, adjusting them as well. */
1151 /* Subtract the locator. */
1152 int first_split_diff
= diff
/ 2;
1153 int second_split_diff
= first_split_diff
;
1157 if (first_win
->height
>
1166 second_split_diff
--;
1168 second_split_diff
++;
1171 /* Make sure that the minimum hieghts are
1173 while ((first_win
->height
+ first_split_diff
) < 3)
1176 second_split_diff
--;
1178 while ((second_win
->height
+ second_split_diff
) < 3)
1180 second_split_diff
++;
1183 make_invisible_and_set_new_height (
1185 first_win
->height
+ first_split_diff
);
1186 second_win
->origin
.y
= first_win
->height
- 1;
1187 make_invisible_and_set_new_height (second_win
,
1189 + second_split_diff
);
1190 TUI_CMD_WIN
->origin
.y
= locator
->origin
.y
+ 1;
1191 make_invisible_and_set_new_height (TUI_CMD_WIN
, new_height
);
1195 if ((TUI_CMD_WIN
->height
+ diff
) < 1)
1196 { /* If there is no way to increase the command
1197 window take real estate from the 1st or 2nd
1199 if ((TUI_CMD_WIN
->height
+ diff
) < 1)
1203 for (i
= TUI_CMD_WIN
->height
+ diff
;
1205 if (primary_win_info
== first_win
)
1206 second_win
->height
--;
1208 first_win
->height
--;
1211 if (primary_win_info
== first_win
)
1212 make_invisible_and_set_new_height (first_win
, new_height
);
1214 make_invisible_and_set_new_height (
1217 second_win
->origin
.y
= first_win
->height
- 1;
1218 if (primary_win_info
== second_win
)
1219 make_invisible_and_set_new_height (second_win
, new_height
);
1221 make_invisible_and_set_new_height (
1222 second_win
, second_win
->height
);
1223 TUI_CMD_WIN
->origin
.y
= locator
->origin
.y
+ 1;
1224 if ((TUI_CMD_WIN
->height
+ diff
) < 1)
1225 make_invisible_and_set_new_height (TUI_CMD_WIN
, 1);
1227 make_invisible_and_set_new_height (TUI_CMD_WIN
,
1228 TUI_CMD_WIN
->height
+ diff
);
1230 TUI_CMD_WIN
->make_visible_with_new_height ();
1231 second_win
->make_visible_with_new_height ();
1232 first_win
->make_visible_with_new_height ();
1233 if (src1
!= nullptr && src1
->content
.empty ())
1234 tui_erase_source_content (src1
, EMPTY_SOURCE_PROMPT
);
1235 if (second_win
->content
.empty ())
1236 tui_erase_source_content (second_win
, EMPTY_SOURCE_PROMPT
);
1245 /* See tui-data.h. */
1248 tui_source_window_base::set_new_height (int height
)
1250 tui_make_invisible (execution_info
);
1251 execution_info
->height
= height
;
1252 execution_info
->origin
.y
= origin
.y
;
1254 execution_info
->viewport_height
= height
- 1;
1256 execution_info
->viewport_height
= height
;
1257 execution_info
->viewport_height
--;
1261 tui_locator_window
*gen_win_info
= tui_locator_win_info_ptr ();
1262 tui_make_invisible (gen_win_info
);
1263 gen_win_info
->origin
.y
= origin
.y
+ height
;
1267 /* See tui-data.h. */
1270 tui_data_window::set_new_height (int height
)
1272 /* Delete all data item windows. */
1273 for (auto &&win
: regs_content
)
1275 tui_delete_win (win
->handle
);
1280 /* Function make the target window (and auxiliary windows associated
1281 with the targer) invisible, and set the new height and
1284 make_invisible_and_set_new_height (struct tui_win_info
*win_info
,
1287 tui_make_invisible (win_info
);
1288 win_info
->height
= height
;
1290 win_info
->viewport_height
= height
- 1;
1292 win_info
->viewport_height
= height
;
1293 if (win_info
!= TUI_CMD_WIN
)
1294 win_info
->viewport_height
--;
1296 /* Now deal with the auxiliary windows associated with win_info. */
1297 win_info
->set_new_height (height
);
1301 /* See tui-data.h. */
1304 tui_win_info::make_visible_with_new_height ()
1306 make_visible (true);
1307 tui_check_and_display_highlight_if_needed (this);
1308 do_make_visible_with_new_height ();
1311 /* See tui-data.h. */
1314 tui_source_window_base::do_make_visible_with_new_height ()
1316 tui_make_visible (execution_info
);
1317 if (!content
.empty ())
1319 struct tui_line_or_address line_or_addr
;
1320 struct symtab_and_line cursal
1321 = get_current_source_symtab_and_line ();
1323 line_or_addr
= start_line_or_addr
;
1324 tui_update_source_window (this, gdbarch
,
1325 cursal
.symtab
, line_or_addr
, TRUE
);
1327 else if (deprecated_safe_get_selected_frame () != NULL
)
1329 struct tui_line_or_address line
;
1330 struct symtab_and_line cursal
1331 = get_current_source_symtab_and_line ();
1332 struct frame_info
*frame
= deprecated_safe_get_selected_frame ();
1333 struct gdbarch
*gdbarch
= get_frame_arch (frame
);
1335 struct symtab
*s
= find_pc_line_symtab (get_frame_pc (frame
));
1336 if (type
== SRC_WIN
)
1338 line
.loa
= LOA_LINE
;
1339 line
.u
.line_no
= cursal
.line
;
1343 line
.loa
= LOA_ADDRESS
;
1344 find_line_pc (s
, cursal
.line
, &line
.u
.addr
);
1346 tui_update_source_window (this, gdbarch
, s
, line
, TRUE
);
1350 tui_make_visible (tui_locator_win_info_ptr ());
1351 tui_show_locator_content ();
1355 /* See tui-data.h. */
1358 tui_data_window::do_make_visible_with_new_height ()
1360 display_all_data ();
1363 /* See tui-data.h. */
1366 tui_cmd_window::do_make_visible_with_new_height ()
1369 wresize (handle
, height
, width
);
1371 mvwin (handle
, origin
.y
, origin
.x
);
1372 wmove (handle
, 0, 0);
1375 /* See tui-data.h. */
1378 tui_win_info::max_height () const
1380 return tui_term_height () - 2;
1383 /* See tui-data.h. */
1386 tui_cmd_window::max_height () const
1388 return tui_term_height () - 4;
1392 new_height_ok (struct tui_win_info
*primary_win_info
,
1395 int ok
= (new_height
< tui_term_height ());
1400 enum tui_layout_type cur_layout
= tui_current_layout ();
1402 diff
= (new_height
- primary_win_info
->height
) * (-1);
1403 if (cur_layout
== SRC_COMMAND
|| cur_layout
== DISASSEM_COMMAND
)
1405 ok
= (new_height
<= primary_win_info
->max_height ()
1406 && new_height
>= MIN_CMD_WIN_HEIGHT
);
1408 { /* Check the total height. */
1409 struct tui_win_info
*win_info
;
1411 if (primary_win_info
== TUI_CMD_WIN
)
1412 win_info
= tui_source_windows ()[0];
1414 win_info
= TUI_CMD_WIN
;
1416 (win_info
->height
+ diff
)) <= tui_term_height ());
1421 int cur_total_height
, total_height
, min_height
= 0;
1422 struct tui_win_info
*first_win
;
1423 struct tui_win_info
*second_win
;
1425 if (cur_layout
== SRC_DISASSEM_COMMAND
)
1427 first_win
= TUI_SRC_WIN
;
1428 second_win
= TUI_DISASM_WIN
;
1432 first_win
= TUI_DATA_WIN
;
1433 second_win
= tui_source_windows ()[0];
1435 /* We could simply add all the heights to obtain the same
1436 result but below is more explicit since we subtract 1 for
1437 the line that the first and second windows share, and add
1438 one for the locator. */
1439 total_height
= cur_total_height
=
1440 (first_win
->height
+ second_win
->height
- 1)
1441 + TUI_CMD_WIN
->height
+ 1; /* Locator. */
1442 if (primary_win_info
== TUI_CMD_WIN
)
1444 /* Locator included since first & second win share a line. */
1445 ok
= ((first_win
->height
+
1446 second_win
->height
+ diff
) >=
1447 (MIN_WIN_HEIGHT
* 2)
1448 && new_height
>= MIN_CMD_WIN_HEIGHT
);
1451 total_height
= new_height
+
1452 (first_win
->height
+
1453 second_win
->height
+ diff
);
1454 min_height
= MIN_CMD_WIN_HEIGHT
;
1459 min_height
= MIN_WIN_HEIGHT
;
1461 /* First see if we can increase/decrease the command
1462 window. And make sure that the command window is at
1464 ok
= ((TUI_CMD_WIN
->height
+ diff
) > 0);
1466 { /* Looks like we have to increase/decrease one of
1467 the other windows. */
1468 if (primary_win_info
== first_win
)
1469 ok
= (second_win
->height
+ diff
) >= min_height
;
1471 ok
= (first_win
->height
+ diff
) >= min_height
;
1475 if (primary_win_info
== first_win
)
1476 total_height
= new_height
+
1477 second_win
->height
+
1478 TUI_CMD_WIN
->height
+ diff
;
1480 total_height
= new_height
+
1482 TUI_CMD_WIN
->height
+ diff
;
1485 /* Now make sure that the proposed total height doesn't
1486 exceed the old total height. */
1488 ok
= (new_height
>= min_height
1489 && total_height
<= cur_total_height
);
1498 parse_scrolling_args (const char *arg
,
1499 struct tui_win_info
**win_to_scroll
,
1504 *win_to_scroll
= tui_win_with_focus ();
1506 /* First set up the default window to scroll, in case there is no
1512 /* Process the number of lines to scroll. */
1513 std::string copy
= arg
;
1515 if (isdigit (*buf_ptr
))
1520 buf_ptr
= strchr (buf_ptr
, ' ');
1521 if (buf_ptr
!= NULL
)
1523 *buf_ptr
= (char) 0;
1525 *num_to_scroll
= atoi (num_str
);
1528 else if (num_to_scroll
)
1529 *num_to_scroll
= atoi (num_str
);
1532 /* Process the window name if one is specified. */
1533 if (buf_ptr
!= NULL
)
1537 if (*buf_ptr
== ' ')
1538 while (*(++buf_ptr
) == ' ')
1541 if (*buf_ptr
!= (char) 0)
1543 /* Validate the window name. */
1544 for (char *p
= buf_ptr
; *p
!= '\0'; p
++)
1552 *win_to_scroll
= tui_partial_win_by_name (wname
);
1554 if (*win_to_scroll
== NULL
1555 || !(*win_to_scroll
)->is_visible
)
1556 error (_("Invalid window specified. \n\
1557 The window name specified must be valid and visible.\n"));
1558 else if (*win_to_scroll
== TUI_CMD_WIN
)
1559 *win_to_scroll
= tui_source_windows ()[0];
1564 /* Function to initialize gdb commands, for tui window
1568 _initialize_tui_win (void)
1570 static struct cmd_list_element
*tui_setlist
;
1571 static struct cmd_list_element
*tui_showlist
;
1572 struct cmd_list_element
*cmd
;
1574 /* Define the classes of commands.
1575 They will appear in the help list in the reverse of this order. */
1576 add_prefix_cmd ("tui", class_tui
, set_tui_cmd
,
1577 _("TUI configuration variables"),
1578 &tui_setlist
, "set tui ",
1579 0 /* allow-unknown */, &setlist
);
1580 add_prefix_cmd ("tui", class_tui
, show_tui_cmd
,
1581 _("TUI configuration variables"),
1582 &tui_showlist
, "show tui ",
1583 0 /* allow-unknown */, &showlist
);
1585 add_com ("refresh", class_tui
, tui_refresh_all_command
,
1586 _("Refresh the terminal display."));
1588 cmd
= add_com ("tabset", class_tui
, tui_set_tab_width_command
, _("\
1589 Set the width (in characters) of tab stops.\n\
1591 deprecate_cmd (cmd
, "set tui tab-width");
1593 cmd
= add_com ("winheight", class_tui
, tui_set_win_height_command
, _("\
1594 Set or modify the height of a specified window.\n"
1596 "Window names are:\n\
1597 src : the source window\n\
1598 cmd : the command window\n\
1599 asm : the disassembly window\n\
1600 regs : the register display"));
1601 add_com_alias ("wh", "winheight", class_tui
, 0);
1602 set_cmd_completer (cmd
, winheight_completer
);
1603 add_info ("win", tui_all_windows_info
,
1604 _("List of all displayed windows."));
1605 cmd
= add_com ("focus", class_tui
, tui_set_focus_command
, _("\
1606 Set focus to named window or next/prev window.\n"
1608 "Valid Window names are:\n\
1609 src : the source window\n\
1610 asm : the disassembly window\n\
1611 regs : the register display\n\
1612 cmd : the command window"));
1613 add_com_alias ("fs", "focus", class_tui
, 0);
1614 set_cmd_completer (cmd
, focus_completer
);
1615 add_com ("+", class_tui
, tui_scroll_forward_command
, _("\
1616 Scroll window forward.\n\
1617 Usage: + [WIN] [N]"));
1618 add_com ("-", class_tui
, tui_scroll_backward_command
, _("\
1619 Scroll window backward.\n\
1620 Usage: - [WIN] [N]"));
1621 add_com ("<", class_tui
, tui_scroll_left_command
, _("\
1622 Scroll window text to the left.\n\
1623 Usage: < [WIN] [N]"));
1624 add_com (">", class_tui
, tui_scroll_right_command
, _("\
1625 Scroll window text to the right.\n\
1626 Usage: > [WIN] [N]"));
1628 /* Define the tui control variables. */
1629 add_setshow_enum_cmd ("border-kind", no_class
, tui_border_kind_enums
,
1630 &tui_border_kind
, _("\
1631 Set the kind of border for TUI windows."), _("\
1632 Show the kind of border for TUI windows."), _("\
1633 This variable controls the border of TUI windows:\n\
1634 space use a white space\n\
1635 ascii use ascii characters + - | for the border\n\
1636 acs use the Alternate Character Set"),
1638 show_tui_border_kind
,
1639 &tui_setlist
, &tui_showlist
);
1641 add_setshow_enum_cmd ("border-mode", no_class
, tui_border_mode_enums
,
1642 &tui_border_mode
, _("\
1643 Set the attribute mode to use for the TUI window borders."), _("\
1644 Show the attribute mode to use for the TUI window borders."), _("\
1645 This variable controls the attributes to use for the window borders:\n\
1646 normal normal display\n\
1647 standout use highlight mode of terminal\n\
1648 reverse use reverse video mode\n\
1649 half use half bright\n\
1650 half-standout use half bright and standout mode\n\
1651 bold use extra bright or bold\n\
1652 bold-standout use extra bright or bold with standout mode"),
1654 show_tui_border_mode
,
1655 &tui_setlist
, &tui_showlist
);
1657 add_setshow_enum_cmd ("active-border-mode", no_class
, tui_border_mode_enums
,
1658 &tui_active_border_mode
, _("\
1659 Set the attribute mode to use for the active TUI window border."), _("\
1660 Show the attribute mode to use for the active TUI window border."), _("\
1661 This variable controls the attributes to use for the active window border:\n\
1662 normal normal display\n\
1663 standout use highlight mode of terminal\n\
1664 reverse use reverse video mode\n\
1665 half use half bright\n\
1666 half-standout use half bright and standout mode\n\
1667 bold use extra bright or bold\n\
1668 bold-standout use extra bright or bold with standout mode"),
1670 show_tui_active_border_mode
,
1671 &tui_setlist
, &tui_showlist
);
1673 add_setshow_zuinteger_cmd ("tab-width", no_class
,
1674 &internal_tab_width
, _("\
1675 Set the tab width, in characters, for the TUI."), _("\
1676 Show the tab witdh, in characters, for the TUI"), _("\
1677 This variable controls how many spaces are used to display a tab character."),
1678 tui_set_tab_width
, tui_show_tab_width
,
1679 &tui_setlist
, &tui_showlist
);