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
;
369 for (win_type
= SRC_WIN
; win_type
< MAX_MAJOR_WINDOWS
; win_type
++)
371 const char *completion_name
= NULL
;
373 /* We can't focus on an invisible window. */
374 if (tui_win_list
[win_type
] == NULL
375 || !tui_win_list
[win_type
]->is_visible
)
378 completion_name
= tui_win_list
[win_type
]->name ();
379 gdb_assert (completion_name
!= NULL
);
380 completion_name_vec
.push_back (completion_name
);
383 /* If no windows are considered visible then the TUI has not yet been
384 initialized. But still "focus src" and "focus cmd" will work because
385 invoking the focus command will entail initializing the TUI which sets the
386 default layout to SRC_COMMAND. */
387 if (completion_name_vec
.empty ())
389 completion_name_vec
.push_back (SRC_NAME
);
390 completion_name_vec
.push_back (CMD_NAME
);
393 if (include_next_prev_p
)
395 completion_name_vec
.push_back ("next");
396 completion_name_vec
.push_back ("prev");
400 completion_name_vec
.push_back (NULL
);
401 complete_on_enum (tracker
, completion_name_vec
.data (), text
, word
);
404 /* Complete possible window names to focus on. TEXT is the complete text
405 entered so far, WORD is the word currently being completed. */
408 focus_completer (struct cmd_list_element
*ignore
,
409 completion_tracker
&tracker
,
410 const char *text
, const char *word
)
412 window_name_completer (tracker
, 1, text
, word
);
415 /* Complete possible window names for winheight command. TEXT is the
416 complete text entered so far, WORD is the word currently being
420 winheight_completer (struct cmd_list_element
*ignore
,
421 completion_tracker
&tracker
,
422 const char *text
, const char *word
)
424 /* The first word is the window name. That we can complete. Subsequent
425 words can't be completed. */
429 window_name_completer (tracker
, 0, text
, word
);
432 /* Update gdb's knowledge of the terminal size. */
434 tui_update_gdb_sizes (void)
440 width
= TUI_CMD_WIN
->width
;
441 height
= TUI_CMD_WIN
->height
;
445 width
= tui_term_width ();
446 height
= tui_term_height ();
449 set_screen_width_and_height (width
, height
);
453 /* Set the logical focus to win_info. */
455 tui_set_win_focus_to (struct tui_win_info
*win_info
)
457 if (win_info
!= NULL
)
459 struct tui_win_info
*win_with_focus
= tui_win_with_focus ();
461 tui_unhighlight_win (win_with_focus
);
462 tui_set_win_with_focus (win_info
);
463 tui_highlight_win (win_info
);
469 tui_win_info::forward_scroll (int num_to_scroll
)
471 if (num_to_scroll
== 0)
472 num_to_scroll
= height
- 3;
474 do_scroll_vertical (num_to_scroll
);
478 tui_win_info::backward_scroll (int num_to_scroll
)
480 if (num_to_scroll
== 0)
481 num_to_scroll
= height
- 3;
483 do_scroll_vertical (-num_to_scroll
);
488 tui_win_info::left_scroll (int num_to_scroll
)
490 if (num_to_scroll
== 0)
493 do_scroll_horizontal (num_to_scroll
);
498 tui_win_info::right_scroll (int num_to_scroll
)
500 if (num_to_scroll
== 0)
503 do_scroll_horizontal (-num_to_scroll
);
507 /* See tui-data.h. */
510 tui_source_window_base::refresh_all ()
512 tui_show_source_content (this);
513 tui_check_and_display_highlight_if_needed (this);
514 tui_erase_exec_info_content (this);
515 tui_update_exec_info (this);
519 tui_refresh_all_win (void)
523 clearok (curscr
, TRUE
);
524 tui_refresh_all (tui_win_list
);
525 for (type
= SRC_WIN
; type
< MAX_MAJOR_WINDOWS
; type
++)
527 if (tui_win_list
[type
] && tui_win_list
[type
]->is_visible
)
528 tui_win_list
[type
]->refresh_all ();
530 tui_show_locator_content ();
534 tui_rehighlight_all (void)
538 for (type
= SRC_WIN
; type
< MAX_MAJOR_WINDOWS
; type
++)
539 tui_check_and_display_highlight_if_needed (tui_win_list
[type
]);
542 /* Resize all the windows based on the terminal size. This function
543 gets called from within the readline sinwinch handler. */
545 tui_resize_all (void)
547 int height_diff
, width_diff
;
548 int screenheight
, screenwidth
;
550 rl_get_screen_size (&screenheight
, &screenwidth
);
551 width_diff
= screenwidth
- tui_term_width ();
552 height_diff
= screenheight
- tui_term_height ();
553 if (height_diff
|| width_diff
)
555 enum tui_layout_type cur_layout
= tui_current_layout ();
556 struct tui_win_info
*win_with_focus
= tui_win_with_focus ();
557 struct tui_win_info
*first_win
;
558 struct tui_win_info
*second_win
;
559 tui_source_window_base
*src_win
;
560 struct tui_locator_window
*locator
= tui_locator_win_info_ptr ();
562 int new_height
, split_diff
, cmd_split_diff
, num_wins_displayed
= 2;
564 #ifdef HAVE_RESIZE_TERM
565 resize_term (screenheight
, screenwidth
);
567 /* Turn keypad off while we resize. */
568 if (win_with_focus
!= TUI_CMD_WIN
)
569 keypad (TUI_CMD_WIN
->handle
, FALSE
);
570 tui_update_gdb_sizes ();
571 tui_set_term_height_to (screenheight
);
572 tui_set_term_width_to (screenwidth
);
573 if (cur_layout
== SRC_DISASSEM_COMMAND
574 || cur_layout
== SRC_DATA_COMMAND
575 || cur_layout
== DISASSEM_DATA_COMMAND
)
576 num_wins_displayed
++;
577 split_diff
= height_diff
/ num_wins_displayed
;
578 cmd_split_diff
= split_diff
;
579 if (height_diff
% num_wins_displayed
)
586 /* Now adjust each window. */
587 /* erase + clearok are used instead of a straightforward clear as
588 AIX 5.3 does not define clear. */
590 clearok (curscr
, TRUE
);
595 case DISASSEM_COMMAND
:
596 src_win
= tui_source_windows ()[0];
598 first_win
->width
+= width_diff
;
599 locator
->width
+= width_diff
;
600 /* Check for invalid heights. */
601 if (height_diff
== 0)
602 new_height
= first_win
->height
;
603 else if ((first_win
->height
+ split_diff
) >=
604 (screenheight
- MIN_CMD_WIN_HEIGHT
- 1))
605 new_height
= screenheight
- MIN_CMD_WIN_HEIGHT
- 1;
606 else if ((first_win
->height
+ split_diff
) <= 0)
607 new_height
= MIN_WIN_HEIGHT
;
609 new_height
= first_win
->height
+ split_diff
;
611 locator
->origin
.y
= new_height
+ 1;
612 make_invisible_and_set_new_height (first_win
, new_height
);
613 TUI_CMD_WIN
->origin
.y
= locator
->origin
.y
+ 1;
614 TUI_CMD_WIN
->width
+= width_diff
;
615 new_height
= screenheight
- TUI_CMD_WIN
->origin
.y
;
616 make_invisible_and_set_new_height (TUI_CMD_WIN
, new_height
);
617 first_win
->make_visible_with_new_height ();
618 TUI_CMD_WIN
->make_visible_with_new_height ();
619 if (src_win
->content_size
<= 0)
620 tui_erase_source_content (src_win
, EMPTY_SOURCE_PROMPT
);
623 if (cur_layout
== SRC_DISASSEM_COMMAND
)
625 src_win
= TUI_SRC_WIN
;
627 first_win
->width
+= width_diff
;
628 second_win
= TUI_DISASM_WIN
;
629 second_win
->width
+= width_diff
;
633 first_win
= TUI_DATA_WIN
;
634 first_win
->width
+= width_diff
;
635 src_win
= tui_source_windows ()[0];
636 second_win
= src_win
;
637 second_win
->width
+= width_diff
;
639 /* Change the first window's height/width. */
640 /* Check for invalid heights. */
641 if (height_diff
== 0)
642 new_height
= first_win
->height
;
643 else if ((first_win
->height
+
644 second_win
->height
+ (split_diff
* 2)) >=
645 (screenheight
- MIN_CMD_WIN_HEIGHT
- 1))
646 new_height
= (screenheight
- MIN_CMD_WIN_HEIGHT
- 1) / 2;
647 else if ((first_win
->height
+ split_diff
) <= 0)
648 new_height
= MIN_WIN_HEIGHT
;
650 new_height
= first_win
->height
+ split_diff
;
651 make_invisible_and_set_new_height (first_win
, new_height
);
653 locator
->width
+= width_diff
;
655 /* Change the second window's height/width. */
656 /* Check for invalid heights. */
657 if (height_diff
== 0)
658 new_height
= second_win
->height
;
659 else if ((first_win
->height
+
660 second_win
->height
+ (split_diff
* 2)) >=
661 (screenheight
- MIN_CMD_WIN_HEIGHT
- 1))
663 new_height
= screenheight
- MIN_CMD_WIN_HEIGHT
- 1;
665 new_height
= (new_height
/ 2) + 1;
669 else if ((second_win
->height
+ split_diff
) <= 0)
670 new_height
= MIN_WIN_HEIGHT
;
672 new_height
= second_win
->height
+ split_diff
;
673 second_win
->origin
.y
= first_win
->height
- 1;
674 make_invisible_and_set_new_height (second_win
, new_height
);
676 /* Change the command window's height/width. */
677 TUI_CMD_WIN
->origin
.y
= locator
->origin
.y
+ 1;
678 make_invisible_and_set_new_height (TUI_CMD_WIN
,
681 first_win
->make_visible_with_new_height ();
682 second_win
->make_visible_with_new_height ();
683 TUI_CMD_WIN
->make_visible_with_new_height ();
684 if (src_win
->content_size
<= 0)
685 tui_erase_source_content (src_win
, EMPTY_SOURCE_PROMPT
);
688 /* Now remove all invisible windows, and their content so that
689 they get created again when called for with the new size. */
690 for (win_type
= SRC_WIN
; (win_type
< MAX_MAJOR_WINDOWS
); win_type
++)
692 if (win_type
!= CMD_WIN
693 && (tui_win_list
[win_type
] != NULL
)
694 && !tui_win_list
[win_type
]->is_visible
)
696 delete tui_win_list
[win_type
];
697 tui_win_list
[win_type
] = NULL
;
700 /* Turn keypad back on, unless focus is in the command
702 if (win_with_focus
!= TUI_CMD_WIN
)
703 keypad (TUI_CMD_WIN
->handle
, TRUE
);
708 /* Token for use by TUI's asynchronous SIGWINCH handler. */
709 static struct async_signal_handler
*tui_sigwinch_token
;
711 /* TUI's SIGWINCH signal handler. */
713 tui_sigwinch_handler (int signal
)
715 mark_async_signal_handler (tui_sigwinch_token
);
716 tui_set_win_resized_to (TRUE
);
719 /* Callback for asynchronously resizing TUI following a SIGWINCH signal. */
721 tui_async_resize_screen (gdb_client_data arg
)
723 rl_resize_terminal ();
727 int screen_height
, screen_width
;
729 rl_get_screen_size (&screen_height
, &screen_width
);
730 set_screen_width_and_height (screen_width
, screen_height
);
732 /* win_resized is left set so that the next call to tui_enable()
733 resizes the TUI windows. */
737 tui_set_win_resized_to (FALSE
);
739 tui_refresh_all_win ();
740 tui_update_gdb_sizes ();
741 tui_redisplay_readline ();
746 /* Initialize TUI's SIGWINCH signal handler. Note that the handler is not
747 uninstalled when we exit TUI, so the handler should not assume that TUI is
750 tui_initialize_win (void)
754 = create_async_signal_handler (tui_async_resize_screen
, NULL
);
757 #ifdef HAVE_SIGACTION
758 struct sigaction old_winch
;
760 memset (&old_winch
, 0, sizeof (old_winch
));
761 old_winch
.sa_handler
= &tui_sigwinch_handler
;
763 old_winch
.sa_flags
= SA_RESTART
;
765 sigaction (SIGWINCH
, &old_winch
, NULL
);
767 signal (SIGWINCH
, &tui_sigwinch_handler
);
774 /*************************
775 ** STATIC LOCAL FUNCTIONS
776 **************************/
780 tui_scroll_forward_command (const char *arg
, int from_tty
)
782 int num_to_scroll
= 1;
783 struct tui_win_info
*win_to_scroll
;
785 /* Make sure the curses mode is enabled. */
788 parse_scrolling_args (arg
, &win_to_scroll
, NULL
);
790 parse_scrolling_args (arg
, &win_to_scroll
, &num_to_scroll
);
791 win_to_scroll
->forward_scroll (num_to_scroll
);
796 tui_scroll_backward_command (const char *arg
, int from_tty
)
798 int num_to_scroll
= 1;
799 struct tui_win_info
*win_to_scroll
;
801 /* Make sure the curses mode is enabled. */
804 parse_scrolling_args (arg
, &win_to_scroll
, NULL
);
806 parse_scrolling_args (arg
, &win_to_scroll
, &num_to_scroll
);
807 win_to_scroll
->backward_scroll (num_to_scroll
);
812 tui_scroll_left_command (const char *arg
, int from_tty
)
815 struct tui_win_info
*win_to_scroll
;
817 /* Make sure the curses mode is enabled. */
819 parse_scrolling_args (arg
, &win_to_scroll
, &num_to_scroll
);
820 win_to_scroll
->left_scroll (num_to_scroll
);
825 tui_scroll_right_command (const char *arg
, int from_tty
)
828 struct tui_win_info
*win_to_scroll
;
830 /* Make sure the curses mode is enabled. */
832 parse_scrolling_args (arg
, &win_to_scroll
, &num_to_scroll
);
833 win_to_scroll
->right_scroll (num_to_scroll
);
837 /* Set focus to the window named by 'arg'. */
839 tui_set_focus (const char *arg
, int from_tty
)
843 char *buf_ptr
= xstrdup (arg
);
845 struct tui_win_info
*win_info
= NULL
;
847 for (i
= 0; (i
< strlen (buf_ptr
)); i
++)
848 buf_ptr
[i
] = tolower (arg
[i
]);
850 if (subset_compare (buf_ptr
, "next"))
851 win_info
= tui_next_win (tui_win_with_focus ());
852 else if (subset_compare (buf_ptr
, "prev"))
853 win_info
= tui_prev_win (tui_win_with_focus ());
855 win_info
= tui_partial_win_by_name (buf_ptr
);
857 if (win_info
== NULL
|| !win_info
->is_visible
)
858 warning (_("Invalid window specified. \n\
859 The window name specified must be valid and visible.\n"));
862 tui_set_win_focus_to (win_info
);
863 keypad (TUI_CMD_WIN
->handle
, (win_info
!= TUI_CMD_WIN
));
866 if (TUI_DATA_WIN
&& TUI_DATA_WIN
->is_visible
)
867 TUI_DATA_WIN
->refresh_all ();
869 printf_filtered (_("Focus set to %s window.\n"),
870 tui_win_with_focus ()->name ());
873 warning (_("Incorrect Number of Arguments.\n%s"), FOCUS_USAGE
);
877 tui_set_focus_command (const char *arg
, int from_tty
)
879 /* Make sure the curses mode is enabled. */
881 tui_set_focus (arg
, from_tty
);
886 tui_all_windows_info (const char *arg
, int from_tty
)
889 struct tui_win_info
*win_with_focus
= tui_win_with_focus ();
891 for (type
= SRC_WIN
; (type
< MAX_MAJOR_WINDOWS
); type
++)
892 if (tui_win_list
[type
]
893 && tui_win_list
[type
]->is_visible
)
895 if (win_with_focus
== tui_win_list
[type
])
896 printf_filtered (" %s\t(%d lines) <has focus>\n",
897 tui_win_list
[type
]->name (),
898 tui_win_list
[type
]->height
);
900 printf_filtered (" %s\t(%d lines)\n",
901 tui_win_list
[type
]->name (),
902 tui_win_list
[type
]->height
);
908 tui_refresh_all_command (const char *arg
, int from_tty
)
910 /* Make sure the curses mode is enabled. */
913 tui_refresh_all_win ();
916 /* The tab width that should be used by the TUI. */
918 unsigned int tui_tab_width
= DEFAULT_TAB_LEN
;
920 /* The tab width as set by the user. */
922 static unsigned int internal_tab_width
= DEFAULT_TAB_LEN
;
924 /* See tui-data.h. */
927 tui_source_window_base::update_tab_width ()
929 /* We don't really change the height of any windows, but
930 calling these 2 functions causes a complete regeneration
931 and redisplay of the window's contents, which will take
932 the new tab width into account. */
933 make_invisible_and_set_new_height (this, height
);
934 make_visible_with_new_height ();
937 /* After the tab width is set, call this to update the relevant
943 for (int win_type
= SRC_WIN
; win_type
< MAX_MAJOR_WINDOWS
; win_type
++)
945 if (tui_win_list
[win_type
] != NULL
946 && tui_win_list
[win_type
]->is_visible
)
947 tui_win_list
[win_type
]->update_tab_width ();
951 /* Callback for "set tui tab-width". */
954 tui_set_tab_width (const char *ignore
,
955 int from_tty
, struct cmd_list_element
*c
)
957 if (internal_tab_width
== 0)
959 internal_tab_width
= tui_tab_width
;
960 error (_("Tab width must not be 0"));
963 tui_tab_width
= internal_tab_width
;
967 /* Callback for "show tui tab-width". */
970 tui_show_tab_width (struct ui_file
*file
, int from_tty
,
971 struct cmd_list_element
*c
, const char *value
)
973 fprintf_filtered (gdb_stdout
, _("TUI tab width is %s spaces.\n"), value
);
977 /* Set the tab width of the specified window. */
979 tui_set_tab_width_command (const char *arg
, int from_tty
)
981 /* Make sure the curses mode is enabled. */
989 warning (_("Tab widths greater than 0 must be specified."));
992 internal_tab_width
= ts
;
1001 /* Set the height of the specified window. */
1003 tui_set_win_height (const char *arg
, int from_tty
)
1005 /* Make sure the curses mode is enabled. */
1009 std::string copy
= arg
;
1010 char *buf
= ©
[0];
1011 char *buf_ptr
= buf
;
1014 struct tui_win_info
*win_info
;
1017 buf_ptr
= strchr (buf_ptr
, ' ');
1018 if (buf_ptr
!= NULL
)
1020 *buf_ptr
= (char) 0;
1022 /* Validate the window name. */
1023 for (i
= 0; i
< strlen (wname
); i
++)
1024 wname
[i
] = tolower (wname
[i
]);
1025 win_info
= tui_partial_win_by_name (wname
);
1027 if (win_info
== NULL
|| !win_info
->is_visible
)
1028 warning (_("Invalid window specified. \n\
1029 The window name specified must be valid and visible.\n"));
1032 /* Process the size. */
1033 while (*(++buf_ptr
) == ' ')
1036 if (*buf_ptr
!= (char) 0)
1039 int fixed_size
= TRUE
;
1042 if (*buf_ptr
== '+' || *buf_ptr
== '-')
1044 if (*buf_ptr
== '-')
1049 input_no
= atoi (buf_ptr
);
1055 new_height
= input_no
;
1057 new_height
= win_info
->height
+ input_no
;
1059 /* Now change the window's height, and adjust
1060 all other windows around it. */
1061 if (tui_adjust_win_heights (win_info
,
1062 new_height
) == TUI_FAILURE
)
1063 warning (_("Invalid window height specified.\n%s"),
1066 tui_update_gdb_sizes ();
1069 warning (_("Invalid window height specified.\n%s"),
1075 printf_filtered (WIN_HEIGHT_USAGE
);
1078 printf_filtered (WIN_HEIGHT_USAGE
);
1081 /* Set the height of the specified window, with va_list. */
1083 tui_set_win_height_command (const char *arg
, int from_tty
)
1085 /* Make sure the curses mode is enabled. */
1087 tui_set_win_height (arg
, from_tty
);
1090 /* Function to adjust all window heights around the primary. */
1091 static enum tui_status
1092 tui_adjust_win_heights (struct tui_win_info
*primary_win_info
,
1095 enum tui_status status
= TUI_FAILURE
;
1097 if (new_height_ok (primary_win_info
, new_height
))
1099 status
= TUI_SUCCESS
;
1100 if (new_height
!= primary_win_info
->height
)
1103 struct tui_win_info
*win_info
;
1104 struct tui_locator_window
*locator
= tui_locator_win_info_ptr ();
1105 enum tui_layout_type cur_layout
= tui_current_layout ();
1107 diff
= (new_height
- primary_win_info
->height
) * (-1);
1108 if (cur_layout
== SRC_COMMAND
1109 || cur_layout
== DISASSEM_COMMAND
)
1111 struct tui_win_info
*src_win_info
;
1113 make_invisible_and_set_new_height (primary_win_info
, new_height
);
1114 if (primary_win_info
->type
== CMD_WIN
)
1116 win_info
= tui_source_windows ()[0];
1117 src_win_info
= win_info
;
1121 win_info
= tui_win_list
[CMD_WIN
];
1122 src_win_info
= primary_win_info
;
1124 make_invisible_and_set_new_height (win_info
,
1125 win_info
->height
+ diff
);
1126 TUI_CMD_WIN
->origin
.y
= locator
->origin
.y
+ 1;
1127 win_info
->make_visible_with_new_height ();
1128 primary_win_info
->make_visible_with_new_height ();
1129 if ((src_win_info
->type
== SRC_WIN
1130 || src_win_info
->type
== DISASSEM_WIN
)
1131 && src_win_info
->content_size
<= 0)
1132 tui_erase_source_content
1133 ((tui_source_window_base
*) src_win_info
,
1134 EMPTY_SOURCE_PROMPT
);
1138 struct tui_win_info
*first_win
;
1139 struct tui_source_window_base
*second_win
;
1140 tui_source_window_base
*src1
;
1142 if (cur_layout
== SRC_DISASSEM_COMMAND
)
1146 second_win
= TUI_DISASM_WIN
;
1151 first_win
= TUI_DATA_WIN
;
1152 second_win
= tui_source_windows ()[0];
1154 if (primary_win_info
== TUI_CMD_WIN
)
1155 { /* Split the change in height accross the 1st & 2nd
1156 windows, adjusting them as well. */
1157 /* Subtract the locator. */
1158 int first_split_diff
= diff
/ 2;
1159 int second_split_diff
= first_split_diff
;
1163 if (first_win
->height
>
1172 second_split_diff
--;
1174 second_split_diff
++;
1177 /* Make sure that the minimum hieghts are
1179 while ((first_win
->height
+ first_split_diff
) < 3)
1182 second_split_diff
--;
1184 while ((second_win
->height
+ second_split_diff
) < 3)
1186 second_split_diff
++;
1189 make_invisible_and_set_new_height (
1191 first_win
->height
+ first_split_diff
);
1192 second_win
->origin
.y
= first_win
->height
- 1;
1193 make_invisible_and_set_new_height (second_win
,
1195 + second_split_diff
);
1196 TUI_CMD_WIN
->origin
.y
= locator
->origin
.y
+ 1;
1197 make_invisible_and_set_new_height (TUI_CMD_WIN
, new_height
);
1201 if ((TUI_CMD_WIN
->height
+ diff
) < 1)
1202 { /* If there is no way to increase the command
1203 window take real estate from the 1st or 2nd
1205 if ((TUI_CMD_WIN
->height
+ diff
) < 1)
1209 for (i
= TUI_CMD_WIN
->height
+ diff
;
1211 if (primary_win_info
== first_win
)
1212 second_win
->height
--;
1214 first_win
->height
--;
1217 if (primary_win_info
== first_win
)
1218 make_invisible_and_set_new_height (first_win
, new_height
);
1220 make_invisible_and_set_new_height (
1223 second_win
->origin
.y
= first_win
->height
- 1;
1224 if (primary_win_info
== second_win
)
1225 make_invisible_and_set_new_height (second_win
, new_height
);
1227 make_invisible_and_set_new_height (
1228 second_win
, second_win
->height
);
1229 TUI_CMD_WIN
->origin
.y
= locator
->origin
.y
+ 1;
1230 if ((TUI_CMD_WIN
->height
+ diff
) < 1)
1231 make_invisible_and_set_new_height (TUI_CMD_WIN
, 1);
1233 make_invisible_and_set_new_height (TUI_CMD_WIN
,
1234 TUI_CMD_WIN
->height
+ diff
);
1236 TUI_CMD_WIN
->make_visible_with_new_height ();
1237 second_win
->make_visible_with_new_height ();
1238 first_win
->make_visible_with_new_height ();
1239 if (src1
!= nullptr && src1
->content_size
<= 0)
1240 tui_erase_source_content (src1
, EMPTY_SOURCE_PROMPT
);
1241 if (second_win
->content_size
<= 0)
1242 tui_erase_source_content (second_win
, EMPTY_SOURCE_PROMPT
);
1251 /* See tui-data.h. */
1254 tui_source_window_base::set_new_height (int height
)
1256 tui_make_invisible (execution_info
);
1257 execution_info
->height
= height
;
1258 execution_info
->origin
.y
= origin
.y
;
1260 execution_info
->viewport_height
= height
- 1;
1262 execution_info
->viewport_height
= height
;
1263 execution_info
->viewport_height
--;
1267 tui_locator_window
*gen_win_info
= tui_locator_win_info_ptr ();
1268 tui_make_invisible (gen_win_info
);
1269 gen_win_info
->origin
.y
= origin
.y
+ height
;
1273 /* See tui-data.h. */
1276 tui_data_window::set_new_height (int height
)
1278 /* Delete all data item windows. */
1279 for (auto &&win
: regs_content
)
1281 tui_delete_win (win
->handle
);
1286 /* Function make the target window (and auxiliary windows associated
1287 with the targer) invisible, and set the new height and
1290 make_invisible_and_set_new_height (struct tui_win_info
*win_info
,
1293 tui_make_invisible (win_info
);
1294 win_info
->height
= height
;
1296 win_info
->viewport_height
= height
- 1;
1298 win_info
->viewport_height
= height
;
1299 if (win_info
!= TUI_CMD_WIN
)
1300 win_info
->viewport_height
--;
1302 /* Now deal with the auxiliary windows associated with win_info. */
1303 win_info
->set_new_height (height
);
1307 /* See tui-data.h. */
1310 tui_win_info::make_visible_with_new_height ()
1312 make_visible (true);
1313 tui_check_and_display_highlight_if_needed (this);
1314 do_make_visible_with_new_height ();
1317 /* See tui-data.h. */
1320 tui_source_window_base::do_make_visible_with_new_height ()
1322 tui_free_win_content (execution_info
);
1323 tui_make_visible (execution_info
);
1324 if (content
!= NULL
)
1326 struct tui_line_or_address line_or_addr
;
1327 struct symtab_and_line cursal
1328 = get_current_source_symtab_and_line ();
1330 line_or_addr
= start_line_or_addr
;
1331 tui_free_win_content (this);
1332 tui_update_source_window (this, gdbarch
,
1333 cursal
.symtab
, line_or_addr
, TRUE
);
1335 else if (deprecated_safe_get_selected_frame () != NULL
)
1337 struct tui_line_or_address line
;
1338 struct symtab_and_line cursal
1339 = get_current_source_symtab_and_line ();
1340 struct frame_info
*frame
= deprecated_safe_get_selected_frame ();
1341 struct gdbarch
*gdbarch
= get_frame_arch (frame
);
1343 struct symtab
*s
= find_pc_line_symtab (get_frame_pc (frame
));
1344 if (type
== SRC_WIN
)
1346 line
.loa
= LOA_LINE
;
1347 line
.u
.line_no
= cursal
.line
;
1351 line
.loa
= LOA_ADDRESS
;
1352 find_line_pc (s
, cursal
.line
, &line
.u
.addr
);
1354 tui_update_source_window (this, gdbarch
, s
, line
, TRUE
);
1358 tui_make_visible (tui_locator_win_info_ptr ());
1359 tui_show_locator_content ();
1363 /* See tui-data.h. */
1366 tui_data_window::do_make_visible_with_new_height ()
1368 tui_display_all_data ();
1371 /* See tui-data.h. */
1374 tui_cmd_window::do_make_visible_with_new_height ()
1377 wresize (handle
, height
, width
);
1379 mvwin (handle
, origin
.y
, origin
.x
);
1380 wmove (handle
, 0, 0);
1383 /* See tui-data.h. */
1386 tui_win_info::max_height () const
1388 return tui_term_height () - 2;
1391 /* See tui-data.h. */
1394 tui_cmd_window::max_height () const
1396 return tui_term_height () - 4;
1400 new_height_ok (struct tui_win_info
*primary_win_info
,
1403 int ok
= (new_height
< tui_term_height ());
1408 enum tui_layout_type cur_layout
= tui_current_layout ();
1410 diff
= (new_height
- primary_win_info
->height
) * (-1);
1411 if (cur_layout
== SRC_COMMAND
|| cur_layout
== DISASSEM_COMMAND
)
1413 ok
= (new_height
<= primary_win_info
->max_height ()
1414 && new_height
>= MIN_CMD_WIN_HEIGHT
);
1416 { /* Check the total height. */
1417 struct tui_win_info
*win_info
;
1419 if (primary_win_info
== TUI_CMD_WIN
)
1420 win_info
= tui_source_windows ()[0];
1422 win_info
= TUI_CMD_WIN
;
1424 (win_info
->height
+ diff
)) <= tui_term_height ());
1429 int cur_total_height
, total_height
, min_height
= 0;
1430 struct tui_win_info
*first_win
;
1431 struct tui_win_info
*second_win
;
1433 if (cur_layout
== SRC_DISASSEM_COMMAND
)
1435 first_win
= TUI_SRC_WIN
;
1436 second_win
= TUI_DISASM_WIN
;
1440 first_win
= TUI_DATA_WIN
;
1441 second_win
= tui_source_windows ()[0];
1443 /* We could simply add all the heights to obtain the same
1444 result but below is more explicit since we subtract 1 for
1445 the line that the first and second windows share, and add
1446 one for the locator. */
1447 total_height
= cur_total_height
=
1448 (first_win
->height
+ second_win
->height
- 1)
1449 + TUI_CMD_WIN
->height
+ 1; /* Locator. */
1450 if (primary_win_info
== TUI_CMD_WIN
)
1452 /* Locator included since first & second win share a line. */
1453 ok
= ((first_win
->height
+
1454 second_win
->height
+ diff
) >=
1455 (MIN_WIN_HEIGHT
* 2)
1456 && new_height
>= MIN_CMD_WIN_HEIGHT
);
1459 total_height
= new_height
+
1460 (first_win
->height
+
1461 second_win
->height
+ diff
);
1462 min_height
= MIN_CMD_WIN_HEIGHT
;
1467 min_height
= MIN_WIN_HEIGHT
;
1469 /* First see if we can increase/decrease the command
1470 window. And make sure that the command window is at
1472 ok
= ((TUI_CMD_WIN
->height
+ diff
) > 0);
1474 { /* Looks like we have to increase/decrease one of
1475 the other windows. */
1476 if (primary_win_info
== first_win
)
1477 ok
= (second_win
->height
+ diff
) >= min_height
;
1479 ok
= (first_win
->height
+ diff
) >= min_height
;
1483 if (primary_win_info
== first_win
)
1484 total_height
= new_height
+
1485 second_win
->height
+
1486 TUI_CMD_WIN
->height
+ diff
;
1488 total_height
= new_height
+
1490 TUI_CMD_WIN
->height
+ diff
;
1493 /* Now make sure that the proposed total height doesn't
1494 exceed the old total height. */
1496 ok
= (new_height
>= min_height
1497 && total_height
<= cur_total_height
);
1506 parse_scrolling_args (const char *arg
,
1507 struct tui_win_info
**win_to_scroll
,
1512 *win_to_scroll
= tui_win_with_focus ();
1514 /* First set up the default window to scroll, in case there is no
1520 /* Process the number of lines to scroll. */
1521 std::string copy
= arg
;
1523 if (isdigit (*buf_ptr
))
1528 buf_ptr
= strchr (buf_ptr
, ' ');
1529 if (buf_ptr
!= NULL
)
1531 *buf_ptr
= (char) 0;
1533 *num_to_scroll
= atoi (num_str
);
1536 else if (num_to_scroll
)
1537 *num_to_scroll
= atoi (num_str
);
1540 /* Process the window name if one is specified. */
1541 if (buf_ptr
!= NULL
)
1545 if (*buf_ptr
== ' ')
1546 while (*(++buf_ptr
) == ' ')
1549 if (*buf_ptr
!= (char) 0)
1551 /* Validate the window name. */
1552 for (char *p
= buf_ptr
; *p
!= '\0'; p
++)
1560 *win_to_scroll
= tui_partial_win_by_name (wname
);
1562 if (*win_to_scroll
== NULL
1563 || !(*win_to_scroll
)->is_visible
)
1564 error (_("Invalid window specified. \n\
1565 The window name specified must be valid and visible.\n"));
1566 else if (*win_to_scroll
== TUI_CMD_WIN
)
1567 *win_to_scroll
= tui_source_windows ()[0];
1572 /* Function to initialize gdb commands, for tui window
1576 _initialize_tui_win (void)
1578 static struct cmd_list_element
*tui_setlist
;
1579 static struct cmd_list_element
*tui_showlist
;
1580 struct cmd_list_element
*cmd
;
1582 /* Define the classes of commands.
1583 They will appear in the help list in the reverse of this order. */
1584 add_prefix_cmd ("tui", class_tui
, set_tui_cmd
,
1585 _("TUI configuration variables"),
1586 &tui_setlist
, "set tui ",
1587 0 /* allow-unknown */, &setlist
);
1588 add_prefix_cmd ("tui", class_tui
, show_tui_cmd
,
1589 _("TUI configuration variables"),
1590 &tui_showlist
, "show tui ",
1591 0 /* allow-unknown */, &showlist
);
1593 add_com ("refresh", class_tui
, tui_refresh_all_command
,
1594 _("Refresh the terminal display."));
1596 cmd
= add_com ("tabset", class_tui
, tui_set_tab_width_command
, _("\
1597 Set the width (in characters) of tab stops.\n\
1599 deprecate_cmd (cmd
, "set tui tab-width");
1601 cmd
= add_com ("winheight", class_tui
, tui_set_win_height_command
, _("\
1602 Set or modify the height of a specified window.\n"
1604 "Window names are:\n\
1605 src : the source window\n\
1606 cmd : the command window\n\
1607 asm : the disassembly window\n\
1608 regs : the register display"));
1609 add_com_alias ("wh", "winheight", class_tui
, 0);
1610 set_cmd_completer (cmd
, winheight_completer
);
1611 add_info ("win", tui_all_windows_info
,
1612 _("List of all displayed windows."));
1613 cmd
= add_com ("focus", class_tui
, tui_set_focus_command
, _("\
1614 Set focus to named window or next/prev window.\n"
1616 "Valid Window names are:\n\
1617 src : the source window\n\
1618 asm : the disassembly window\n\
1619 regs : the register display\n\
1620 cmd : the command window"));
1621 add_com_alias ("fs", "focus", class_tui
, 0);
1622 set_cmd_completer (cmd
, focus_completer
);
1623 add_com ("+", class_tui
, tui_scroll_forward_command
, _("\
1624 Scroll window forward.\n\
1625 Usage: + [WIN] [N]"));
1626 add_com ("-", class_tui
, tui_scroll_backward_command
, _("\
1627 Scroll window backward.\n\
1628 Usage: - [WIN] [N]"));
1629 add_com ("<", class_tui
, tui_scroll_left_command
, _("\
1630 Scroll window text to the left.\n\
1631 Usage: < [WIN] [N]"));
1632 add_com (">", class_tui
, tui_scroll_right_command
, _("\
1633 Scroll window text to the right.\n\
1634 Usage: > [WIN] [N]"));
1636 /* Define the tui control variables. */
1637 add_setshow_enum_cmd ("border-kind", no_class
, tui_border_kind_enums
,
1638 &tui_border_kind
, _("\
1639 Set the kind of border for TUI windows."), _("\
1640 Show the kind of border for TUI windows."), _("\
1641 This variable controls the border of TUI windows:\n\
1642 space use a white space\n\
1643 ascii use ascii characters + - | for the border\n\
1644 acs use the Alternate Character Set"),
1646 show_tui_border_kind
,
1647 &tui_setlist
, &tui_showlist
);
1649 add_setshow_enum_cmd ("border-mode", no_class
, tui_border_mode_enums
,
1650 &tui_border_mode
, _("\
1651 Set the attribute mode to use for the TUI window borders."), _("\
1652 Show the attribute mode to use for the TUI window borders."), _("\
1653 This variable controls the attributes to use for the window borders:\n\
1654 normal normal display\n\
1655 standout use highlight mode of terminal\n\
1656 reverse use reverse video mode\n\
1657 half use half bright\n\
1658 half-standout use half bright and standout mode\n\
1659 bold use extra bright or bold\n\
1660 bold-standout use extra bright or bold with standout mode"),
1662 show_tui_border_mode
,
1663 &tui_setlist
, &tui_showlist
);
1665 add_setshow_enum_cmd ("active-border-mode", no_class
, tui_border_mode_enums
,
1666 &tui_active_border_mode
, _("\
1667 Set the attribute mode to use for the active TUI window border."), _("\
1668 Show the attribute mode to use for the active TUI window border."), _("\
1669 This variable controls the attributes to use for the active window border:\n\
1670 normal normal display\n\
1671 standout use highlight mode of terminal\n\
1672 reverse use reverse video mode\n\
1673 half use half bright\n\
1674 half-standout use half bright and standout mode\n\
1675 bold use extra bright or bold\n\
1676 bold-standout use extra bright or bold with standout mode"),
1678 show_tui_active_border_mode
,
1679 &tui_setlist
, &tui_showlist
);
1681 add_setshow_zuinteger_cmd ("tab-width", no_class
,
1682 &internal_tab_width
, _("\
1683 Set the tab width, in characters, for the TUI."), _("\
1684 Show the tab witdh, in characters, for the TUI"), _("\
1685 This variable controls how many spaces are used to display a tab character."),
1686 tui_set_tab_width
, tui_show_tab_width
,
1687 &tui_setlist
, &tui_showlist
);