1 /* TUI window generic functions.
3 Copyright (C) 1998-2022 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"
33 #include "cli/cli-style.h"
36 #include "gdbsupport/event-loop.h"
38 #include "async-event.h"
41 #include "tui/tui-io.h"
42 #include "tui/tui-command.h"
43 #include "tui/tui-data.h"
44 #include "tui/tui-layout.h"
45 #include "tui/tui-wingeneral.h"
46 #include "tui/tui-stack.h"
47 #include "tui/tui-regs.h"
48 #include "tui/tui-disasm.h"
49 #include "tui/tui-source.h"
50 #include "tui/tui-winsource.h"
51 #include "tui/tui-win.h"
53 #include "gdb_curses.h"
55 #include "readline/readline.h"
56 #include "gdbsupport/gdb_string_view.h"
60 static void tui_set_tab_width_command (const char *, int);
61 static void tui_refresh_all_command (const char *, int);
62 static void tui_all_windows_info (const char *, int);
63 static void tui_scroll_forward_command (const char *, int);
64 static void tui_scroll_backward_command (const char *, int);
65 static void tui_scroll_left_command (const char *, int);
66 static void tui_scroll_right_command (const char *, int);
67 static void parse_scrolling_args (const char *,
68 struct tui_win_info
**,
73 # define ACS_LRCORNER '+'
76 # define ACS_LLCORNER '+'
79 # define ACS_ULCORNER '+'
82 # define ACS_URCORNER '+'
85 # define ACS_HLINE '-'
88 # define ACS_VLINE '|'
91 /* Possible values for tui-border-kind variable. */
92 static const char *const tui_border_kind_enums
[] = {
99 /* Possible values for tui-border-mode and tui-active-border-mode. */
100 static const char *const tui_border_mode_enums
[] = {
117 /* Translation table for border-mode variables.
118 The list of values must be terminated by a NULL.
119 After the NULL value, an entry defines the default. */
120 static struct tui_translate tui_border_mode_translate
[] = {
121 { "normal", A_NORMAL
},
122 { "standout", A_STANDOUT
},
123 { "reverse", A_REVERSE
},
125 { "half-standout", A_DIM
| A_STANDOUT
},
127 { "bold-standout", A_BOLD
| A_STANDOUT
},
129 { "normal", A_NORMAL
}
132 /* Translation tables for border-kind, one for each border
133 character (see wborder, border curses operations).
134 -1 is used to indicate the ACS because ACS characters
135 are determined at run time by curses (depends on terminal). */
136 static struct tui_translate tui_border_kind_translate_vline
[] = {
144 static struct tui_translate tui_border_kind_translate_hline
[] = {
152 static struct tui_translate tui_border_kind_translate_ulcorner
[] = {
160 static struct tui_translate tui_border_kind_translate_urcorner
[] = {
168 static struct tui_translate tui_border_kind_translate_llcorner
[] = {
176 static struct tui_translate tui_border_kind_translate_lrcorner
[] = {
185 /* Tui configuration variables controlled with set/show command. */
186 static const char *tui_active_border_mode
= "bold-standout";
188 show_tui_active_border_mode (struct ui_file
*file
,
190 struct cmd_list_element
*c
,
193 gdb_printf (file
, _("\
194 The attribute mode to use for the active TUI window border is \"%s\".\n"),
198 static const char *tui_border_mode
= "normal";
200 show_tui_border_mode (struct ui_file
*file
,
202 struct cmd_list_element
*c
,
205 gdb_printf (file
, _("\
206 The attribute mode to use for the TUI window borders is \"%s\".\n"),
210 static const char *tui_border_kind
= "acs";
212 show_tui_border_kind (struct ui_file
*file
,
214 struct cmd_list_element
*c
,
217 gdb_printf (file
, _("The kind of border for TUI windows is \"%s\".\n"),
222 /* Tui internal configuration variables. These variables are updated
223 by tui_update_variables to reflect the tui configuration
225 chtype tui_border_vline
;
226 chtype tui_border_hline
;
227 chtype tui_border_ulcorner
;
228 chtype tui_border_urcorner
;
229 chtype tui_border_llcorner
;
230 chtype tui_border_lrcorner
;
232 int tui_border_attrs
;
233 int tui_active_border_attrs
;
235 /* Identify the item in the translation table.
236 When the item is not recognized, use the default entry. */
237 static struct tui_translate
*
238 translate (const char *name
, struct tui_translate
*table
)
242 if (name
&& strcmp (table
->name
, name
) == 0)
247 /* Not found, return default entry. */
252 /* Update the tui internal configuration according to gdb settings.
253 Returns 1 if the configuration has changed and the screen should
256 tui_update_variables ()
258 bool need_redraw
= false;
259 struct tui_translate
*entry
;
261 entry
= translate (tui_border_mode
, tui_border_mode_translate
);
262 if (tui_border_attrs
!= entry
->value
)
264 tui_border_attrs
= entry
->value
;
267 entry
= translate (tui_active_border_mode
, tui_border_mode_translate
);
268 if (tui_active_border_attrs
!= entry
->value
)
270 tui_active_border_attrs
= entry
->value
;
274 /* If one corner changes, all characters are changed.
275 Only check the first one. The ACS characters are determined at
276 run time by curses terminal management. */
277 entry
= translate (tui_border_kind
, tui_border_kind_translate_lrcorner
);
278 if (tui_border_lrcorner
!= (chtype
) entry
->value
)
280 tui_border_lrcorner
= (entry
->value
< 0) ? ACS_LRCORNER
: entry
->value
;
283 entry
= translate (tui_border_kind
, tui_border_kind_translate_llcorner
);
284 tui_border_llcorner
= (entry
->value
< 0) ? ACS_LLCORNER
: entry
->value
;
286 entry
= translate (tui_border_kind
, tui_border_kind_translate_ulcorner
);
287 tui_border_ulcorner
= (entry
->value
< 0) ? ACS_ULCORNER
: entry
->value
;
289 entry
= translate (tui_border_kind
, tui_border_kind_translate_urcorner
);
290 tui_border_urcorner
= (entry
->value
< 0) ? ACS_URCORNER
: entry
->value
;
292 entry
= translate (tui_border_kind
, tui_border_kind_translate_hline
);
293 tui_border_hline
= (entry
->value
< 0) ? ACS_HLINE
: entry
->value
;
295 entry
= translate (tui_border_kind
, tui_border_kind_translate_vline
);
296 tui_border_vline
= (entry
->value
< 0) ? ACS_VLINE
: entry
->value
;
301 static struct cmd_list_element
*tuilist
;
303 struct cmd_list_element
**
304 tui_get_cmd_list (void)
307 add_basic_prefix_cmd ("tui", class_tui
,
308 _("Text User Interface commands."),
309 &tuilist
, 0, &cmdlist
);
313 /* The set_func hook of "set tui ..." commands that affect the window
314 borders on the TUI display. */
317 tui_set_var_cmd (const char *null_args
,
318 int from_tty
, struct cmd_list_element
*c
)
320 if (tui_update_variables () && tui_active
)
321 tui_rehighlight_all ();
326 /* True if TUI resizes should print a message. This is used by the
329 static bool resize_message
;
332 show_tui_resize_message (struct ui_file
*file
, int from_tty
,
333 struct cmd_list_element
*c
, const char *value
)
335 gdb_printf (file
, _("TUI resize messaging is %s.\n"), value
);
340 /* Generic window name completion function. Complete window name pointed
341 to by TEXT and WORD. If INCLUDE_NEXT_PREV_P is true then the special
342 window names 'next' and 'prev' will also be considered as possible
343 completions of the window name. */
346 window_name_completer (completion_tracker
&tracker
,
347 int include_next_prev_p
,
348 const char *text
, const char *word
)
350 std::vector
<const char *> completion_name_vec
;
352 for (tui_win_info
*win_info
: all_tui_windows ())
354 const char *completion_name
= NULL
;
356 /* We can't focus on an invisible window. */
357 if (!win_info
->is_visible ())
360 completion_name
= win_info
->name ();
361 gdb_assert (completion_name
!= NULL
);
362 completion_name_vec
.push_back (completion_name
);
365 /* If no windows are considered visible then the TUI has not yet been
366 initialized. But still "focus src" and "focus cmd" will work because
367 invoking the focus command will entail initializing the TUI which sets the
368 default layout to "src". */
369 if (completion_name_vec
.empty ())
371 completion_name_vec
.push_back (SRC_NAME
);
372 completion_name_vec
.push_back (CMD_NAME
);
375 if (include_next_prev_p
)
377 completion_name_vec
.push_back ("next");
378 completion_name_vec
.push_back ("prev");
382 completion_name_vec
.push_back (NULL
);
383 complete_on_enum (tracker
, completion_name_vec
.data (), text
, word
);
386 /* Complete possible window names to focus on. TEXT is the complete text
387 entered so far, WORD is the word currently being completed. */
390 focus_completer (struct cmd_list_element
*ignore
,
391 completion_tracker
&tracker
,
392 const char *text
, const char *word
)
394 window_name_completer (tracker
, 1, text
, word
);
397 /* Complete possible window names for winheight command. TEXT is the
398 complete text entered so far, WORD is the word currently being
402 winheight_completer (struct cmd_list_element
*ignore
,
403 completion_tracker
&tracker
,
404 const char *text
, const char *word
)
406 /* The first word is the window name. That we can complete. Subsequent
407 words can't be completed. */
411 window_name_completer (tracker
, 0, text
, word
);
414 /* Update gdb's knowledge of the terminal size. */
416 tui_update_gdb_sizes (void)
422 width
= TUI_CMD_WIN
->width
;
423 height
= TUI_CMD_WIN
->height
;
427 width
= tui_term_width ();
428 height
= tui_term_height ();
431 set_screen_width_and_height (width
, height
);
436 tui_win_info::forward_scroll (int num_to_scroll
)
438 if (num_to_scroll
== 0)
439 num_to_scroll
= height
- 3;
441 do_scroll_vertical (num_to_scroll
);
445 tui_win_info::backward_scroll (int num_to_scroll
)
447 if (num_to_scroll
== 0)
448 num_to_scroll
= height
- 3;
450 do_scroll_vertical (-num_to_scroll
);
455 tui_win_info::left_scroll (int num_to_scroll
)
457 if (num_to_scroll
== 0)
460 do_scroll_horizontal (num_to_scroll
);
465 tui_win_info::right_scroll (int num_to_scroll
)
467 if (num_to_scroll
== 0)
470 do_scroll_horizontal (-num_to_scroll
);
475 tui_refresh_all_win (void)
477 clearok (curscr
, TRUE
);
482 tui_rehighlight_all (void)
484 for (tui_win_info
*win_info
: all_tui_windows ())
485 win_info
->check_and_display_highlight_if_needed ();
488 /* Resize all the windows based on the terminal size. This function
489 gets called from within the readline SIGWINCH handler. */
491 tui_resize_all (void)
493 int height_diff
, width_diff
;
494 int screenheight
, screenwidth
;
496 rl_get_screen_size (&screenheight
, &screenwidth
);
497 width_diff
= screenwidth
- tui_term_width ();
498 height_diff
= screenheight
- tui_term_height ();
499 if (height_diff
|| width_diff
)
501 #ifdef HAVE_RESIZE_TERM
502 resize_term (screenheight
, screenwidth
);
504 /* Turn keypad off while we resize. */
505 keypad (TUI_CMD_WIN
->handle
.get (), FALSE
);
506 tui_update_gdb_sizes ();
507 tui_set_term_height_to (screenheight
);
508 tui_set_term_width_to (screenwidth
);
510 /* erase + clearok are used instead of a straightforward clear as
511 AIX 5.3 does not define clear. */
513 clearok (curscr
, TRUE
);
514 tui_apply_current_layout ();
515 /* Turn keypad back on. */
516 keypad (TUI_CMD_WIN
->handle
.get (), TRUE
);
521 /* Token for use by TUI's asynchronous SIGWINCH handler. */
522 static struct async_signal_handler
*tui_sigwinch_token
;
524 /* TUI's SIGWINCH signal handler. */
526 tui_sigwinch_handler (int signal
)
528 mark_async_signal_handler (tui_sigwinch_token
);
529 tui_set_win_resized_to (true);
532 /* Callback for asynchronously resizing TUI following a SIGWINCH signal. */
534 tui_async_resize_screen (gdb_client_data arg
)
536 rl_resize_terminal ();
540 int screen_height
, screen_width
;
542 rl_get_screen_size (&screen_height
, &screen_width
);
543 set_screen_width_and_height (screen_width
, screen_height
);
545 /* win_resized is left set so that the next call to tui_enable()
546 resizes the TUI windows. */
550 tui_set_win_resized_to (false);
552 tui_refresh_all_win ();
553 tui_update_gdb_sizes ();
557 printf_unfiltered ("@@ resize done %d, size = %dx%d\n", count
,
558 tui_term_width (), tui_term_height ());
561 tui_redisplay_readline ();
566 /* Initialize TUI's SIGWINCH signal handler. Note that the handler is not
567 uninstalled when we exit TUI, so the handler should not assume that TUI is
570 tui_initialize_win (void)
574 = create_async_signal_handler (tui_async_resize_screen
, NULL
,
578 #ifdef HAVE_SIGACTION
579 struct sigaction old_winch
;
581 memset (&old_winch
, 0, sizeof (old_winch
));
582 old_winch
.sa_handler
= &tui_sigwinch_handler
;
584 old_winch
.sa_flags
= SA_RESTART
;
586 sigaction (SIGWINCH
, &old_winch
, NULL
);
588 signal (SIGWINCH
, &tui_sigwinch_handler
);
596 tui_scroll_forward_command (const char *arg
, int from_tty
)
598 int num_to_scroll
= 1;
599 struct tui_win_info
*win_to_scroll
;
601 /* Make sure the curses mode is enabled. */
604 parse_scrolling_args (arg
, &win_to_scroll
, NULL
);
606 parse_scrolling_args (arg
, &win_to_scroll
, &num_to_scroll
);
607 win_to_scroll
->forward_scroll (num_to_scroll
);
612 tui_scroll_backward_command (const char *arg
, int from_tty
)
614 int num_to_scroll
= 1;
615 struct tui_win_info
*win_to_scroll
;
617 /* Make sure the curses mode is enabled. */
620 parse_scrolling_args (arg
, &win_to_scroll
, NULL
);
622 parse_scrolling_args (arg
, &win_to_scroll
, &num_to_scroll
);
623 win_to_scroll
->backward_scroll (num_to_scroll
);
628 tui_scroll_left_command (const char *arg
, int from_tty
)
631 struct tui_win_info
*win_to_scroll
;
633 /* Make sure the curses mode is enabled. */
635 parse_scrolling_args (arg
, &win_to_scroll
, &num_to_scroll
);
636 win_to_scroll
->left_scroll (num_to_scroll
);
641 tui_scroll_right_command (const char *arg
, int from_tty
)
644 struct tui_win_info
*win_to_scroll
;
646 /* Make sure the curses mode is enabled. */
648 parse_scrolling_args (arg
, &win_to_scroll
, &num_to_scroll
);
649 win_to_scroll
->right_scroll (num_to_scroll
);
653 /* Answer the window represented by name. */
654 static struct tui_win_info
*
655 tui_partial_win_by_name (gdb::string_view name
)
657 struct tui_win_info
*best
= nullptr;
659 for (tui_win_info
*item
: all_tui_windows ())
661 const char *cur_name
= item
->name ();
663 if (name
== cur_name
)
665 if (startswith (cur_name
, name
))
668 error (_("Window name \"%*s\" is ambiguous"),
669 (int) name
.size (), name
.data ());
677 /* Set focus to the window named by 'arg'. */
679 tui_set_focus_command (const char *arg
, int from_tty
)
684 error_no_arg (_("name of window to focus"));
686 struct tui_win_info
*win_info
= NULL
;
688 if (subset_compare (arg
, "next"))
689 win_info
= tui_next_win (tui_win_with_focus ());
690 else if (subset_compare (arg
, "prev"))
691 win_info
= tui_prev_win (tui_win_with_focus ());
693 win_info
= tui_partial_win_by_name (arg
);
695 if (win_info
== NULL
)
696 error (_("Unrecognized window name \"%s\""), arg
);
697 if (!win_info
->is_visible ())
698 error (_("Window \"%s\" is not visible"), arg
);
700 tui_set_win_focus_to (win_info
);
701 gdb_printf (_("Focus set to %s window.\n"),
702 tui_win_with_focus ()->name ());
706 tui_all_windows_info (const char *arg
, int from_tty
)
710 gdb_printf (_("The TUI is not active.\n"));
714 struct tui_win_info
*win_with_focus
= tui_win_with_focus ();
715 struct ui_out
*uiout
= current_uiout
;
717 ui_out_emit_table
table_emitter (uiout
, 4, -1, "tui-windows");
718 uiout
->table_header (10, ui_left
, "name", "Name");
719 uiout
->table_header (5, ui_right
, "lines", "Lines");
720 uiout
->table_header (7, ui_right
, "columns", "Columns");
721 uiout
->table_header (10, ui_left
, "focus", "Focus");
722 uiout
->table_body ();
724 for (tui_win_info
*win_info
: all_tui_windows ())
725 if (win_info
->is_visible ())
727 ui_out_emit_tuple
tuple_emitter (uiout
, nullptr);
729 uiout
->field_string ("name", win_info
->name ());
730 uiout
->field_signed ("lines", win_info
->height
);
731 uiout
->field_signed ("columns", win_info
->width
);
732 if (win_with_focus
== win_info
)
733 uiout
->field_string ("focus", _("(has focus)"));
735 uiout
->field_skip ("focus");
742 tui_refresh_all_command (const char *arg
, int from_tty
)
744 /* Make sure the curses mode is enabled. */
747 tui_refresh_all_win ();
750 #define DEFAULT_TAB_LEN 8
752 /* The tab width that should be used by the TUI. */
754 unsigned int tui_tab_width
= DEFAULT_TAB_LEN
;
756 /* The tab width as set by the user. */
758 static unsigned int internal_tab_width
= DEFAULT_TAB_LEN
;
760 /* After the tab width is set, call this to update the relevant
766 for (tui_win_info
*win_info
: all_tui_windows ())
768 if (win_info
->is_visible ())
769 win_info
->update_tab_width ();
773 /* Callback for "set tui tab-width". */
776 tui_set_tab_width (const char *ignore
,
777 int from_tty
, struct cmd_list_element
*c
)
779 if (internal_tab_width
== 0)
781 internal_tab_width
= tui_tab_width
;
782 error (_("Tab width must not be 0"));
785 tui_tab_width
= internal_tab_width
;
789 /* Callback for "show tui tab-width". */
792 tui_show_tab_width (struct ui_file
*file
, int from_tty
,
793 struct cmd_list_element
*c
, const char *value
)
795 gdb_printf (file
, _("TUI tab width is %s spaces.\n"), value
);
801 bool compact_source
= false;
803 /* Callback for "set tui compact-source". */
806 tui_set_compact_source (const char *ignore
, int from_tty
,
807 struct cmd_list_element
*c
)
809 if (TUI_SRC_WIN
!= nullptr)
810 TUI_SRC_WIN
->refill ();
813 /* Callback for "show tui compact-source". */
816 tui_show_compact_source (struct ui_file
*file
, int from_tty
,
817 struct cmd_list_element
*c
, const char *value
)
819 gdb_printf (file
, _("TUI source window compactness is %s.\n"), value
);
822 /* Set the tab width of the specified window. */
824 tui_set_tab_width_command (const char *arg
, int from_tty
)
826 /* Make sure the curses mode is enabled. */
834 warning (_("Tab widths greater than 0 must be specified."));
837 internal_tab_width
= ts
;
846 /* Set the height of the specified window. */
848 tui_set_win_height_command (const char *arg
, int from_tty
)
850 /* Make sure the curses mode is enabled. */
853 error_no_arg (_("name of window"));
855 const char *buf
= arg
;
856 const char *buf_ptr
= buf
;
858 struct tui_win_info
*win_info
;
860 buf_ptr
= skip_to_space (buf_ptr
);
862 /* Validate the window name. */
863 gdb::string_view
wname (buf
, buf_ptr
- buf
);
864 win_info
= tui_partial_win_by_name (wname
);
866 if (win_info
== NULL
)
867 error (_("Unrecognized window name \"%s\""), arg
);
868 if (!win_info
->is_visible ())
869 error (_("Window \"%s\" is not visible"), arg
);
871 /* Process the size. */
872 buf_ptr
= skip_spaces (buf_ptr
);
874 if (*buf_ptr
!= '\0')
877 bool fixed_size
= true;
880 if (*buf_ptr
== '+' || *buf_ptr
== '-')
887 input_no
= atoi (buf_ptr
);
893 new_height
= input_no
;
895 new_height
= win_info
->height
+ input_no
;
897 /* Now change the window's height, and adjust
898 all other windows around it. */
899 tui_adjust_window_height (win_info
, new_height
);
900 tui_update_gdb_sizes ();
903 error (_("Invalid window height specified"));
907 /* See tui-data.h. */
910 tui_win_info::max_height () const
912 return tui_term_height () - 2;
915 /* See tui-data.h. */
918 tui_win_info::max_width () const
920 return tui_term_width () - 2;
924 parse_scrolling_args (const char *arg
,
925 struct tui_win_info
**win_to_scroll
,
930 *win_to_scroll
= tui_win_with_focus ();
932 /* First set up the default window to scroll, in case there is no
938 /* Process the number of lines to scroll. */
939 std::string copy
= arg
;
941 if (isdigit (*buf_ptr
))
946 buf_ptr
= strchr (buf_ptr
, ' ');
951 *num_to_scroll
= atoi (num_str
);
954 else if (num_to_scroll
)
955 *num_to_scroll
= atoi (num_str
);
958 /* Process the window name if one is specified. */
963 wname
= skip_spaces (buf_ptr
);
967 *win_to_scroll
= tui_partial_win_by_name (wname
);
969 if (*win_to_scroll
== NULL
)
970 error (_("Unrecognized window `%s'"), wname
);
971 if (!(*win_to_scroll
)->is_visible ())
972 error (_("Window is not visible"));
973 else if (*win_to_scroll
== TUI_CMD_WIN
)
974 *win_to_scroll
= *(tui_source_windows ().begin ());
980 /* The list of 'tui window' sub-commands. */
982 static cmd_list_element
*tui_window_cmds
= nullptr;
984 /* Called to implement 'tui window'. */
987 tui_window_command (const char *args
, int from_tty
)
989 help_list (tui_window_cmds
, "tui window ", all_commands
, gdb_stdout
);
992 /* Function to initialize gdb commands, for tui window
995 void _initialize_tui_win ();
997 _initialize_tui_win ()
999 static struct cmd_list_element
*tui_setlist
;
1000 static struct cmd_list_element
*tui_showlist
;
1002 /* Define the classes of commands.
1003 They will appear in the help list in the reverse of this order. */
1004 add_setshow_prefix_cmd ("tui", class_tui
,
1005 _("TUI configuration variables."),
1006 _("TUI configuration variables."),
1007 &tui_setlist
, &tui_showlist
,
1008 &setlist
, &showlist
);
1010 cmd_list_element
*refresh_cmd
1011 = add_cmd ("refresh", class_tui
, tui_refresh_all_command
,
1012 _("Refresh the terminal display."),
1013 tui_get_cmd_list ());
1014 add_com_alias ("refresh", refresh_cmd
, class_tui
, 0);
1016 cmd_list_element
*tabset_cmd
1017 = add_com ("tabset", class_tui
, tui_set_tab_width_command
, _("\
1018 Set the width (in characters) of tab stops.\n\
1020 deprecate_cmd (tabset_cmd
, "set tui tab-width");
1022 /* Setup the 'tui window' list of command. */
1023 add_prefix_cmd ("window", class_tui
, tui_window_command
,
1024 _("Text User Interface window commands."),
1025 &tui_window_cmds
, 1, tui_get_cmd_list ());
1027 cmd_list_element
*winheight_cmd
1028 = add_cmd ("height", class_tui
, tui_set_win_height_command
, _("\
1029 Set or modify the height of a specified window.\n\
1030 Usage: tui window height WINDOW-NAME [+ | -] NUM-LINES\n\
1031 Use \"info win\" to see the names of the windows currently being displayed."),
1033 add_com_alias ("winheight", winheight_cmd
, class_tui
, 0);
1034 add_com_alias ("wh", winheight_cmd
, class_tui
, 0);
1035 set_cmd_completer (winheight_cmd
, winheight_completer
);
1036 add_info ("win", tui_all_windows_info
,
1037 _("List of all displayed windows.\n\
1039 cmd_list_element
*focus_cmd
1040 = add_cmd ("focus", class_tui
, tui_set_focus_command
, _("\
1041 Set focus to named window or next/prev window.\n\
1042 Usage: tui focus [WINDOW-NAME | next | prev]\n\
1043 Use \"info win\" to see the names of the windows currently being displayed."),
1044 tui_get_cmd_list ());
1045 add_com_alias ("focus", focus_cmd
, class_tui
, 0);
1046 add_com_alias ("fs", focus_cmd
, class_tui
, 0);
1047 set_cmd_completer (focus_cmd
, focus_completer
);
1048 add_com ("+", class_tui
, tui_scroll_forward_command
, _("\
1049 Scroll window forward.\n\
1050 Usage: + [N] [WIN]\n\
1051 Scroll window WIN N lines forwards. Both WIN and N are optional, N\n\
1052 defaults to 1, and WIN defaults to the currently focused window."));
1053 add_com ("-", class_tui
, tui_scroll_backward_command
, _("\
1054 Scroll window backward.\n\
1055 Usage: - [N] [WIN]\n\
1056 Scroll window WIN N lines backwards. Both WIN and N are optional, N\n\
1057 defaults to 1, and WIN defaults to the currently focused window."));
1058 add_com ("<", class_tui
, tui_scroll_left_command
, _("\
1059 Scroll window text to the left.\n\
1060 Usage: < [N] [WIN]\n\
1061 Scroll window WIN N characters left. Both WIN and N are optional, N\n\
1062 defaults to 1, and WIN defaults to the currently focused window."));
1063 add_com (">", class_tui
, tui_scroll_right_command
, _("\
1064 Scroll window text to the right.\n\
1065 Usage: > [N] [WIN]\n\
1066 Scroll window WIN N characters right. Both WIN and N are optional, N\n\
1067 defaults to 1, and WIN defaults to the currently focused window."));
1069 /* Define the tui control variables. */
1070 add_setshow_enum_cmd ("border-kind", no_class
, tui_border_kind_enums
,
1071 &tui_border_kind
, _("\
1072 Set the kind of border for TUI windows."), _("\
1073 Show the kind of border for TUI windows."), _("\
1074 This variable controls the border of TUI windows:\n\
1075 space use a white space\n\
1076 ascii use ascii characters + - | for the border\n\
1077 acs use the Alternate Character Set"),
1079 show_tui_border_kind
,
1080 &tui_setlist
, &tui_showlist
);
1082 add_setshow_enum_cmd ("border-mode", no_class
, tui_border_mode_enums
,
1083 &tui_border_mode
, _("\
1084 Set the attribute mode to use for the TUI window borders."), _("\
1085 Show the attribute mode to use for the TUI window borders."), _("\
1086 This variable controls the attributes to use for the window borders:\n\
1087 normal normal display\n\
1088 standout use highlight mode of terminal\n\
1089 reverse use reverse video mode\n\
1090 half use half bright\n\
1091 half-standout use half bright and standout mode\n\
1092 bold use extra bright or bold\n\
1093 bold-standout use extra bright or bold with standout mode"),
1095 show_tui_border_mode
,
1096 &tui_setlist
, &tui_showlist
);
1098 add_setshow_enum_cmd ("active-border-mode", no_class
, tui_border_mode_enums
,
1099 &tui_active_border_mode
, _("\
1100 Set the attribute mode to use for the active TUI window border."), _("\
1101 Show the attribute mode to use for the active TUI window border."), _("\
1102 This variable controls the attributes to use for the active window border:\n\
1103 normal normal display\n\
1104 standout use highlight mode of terminal\n\
1105 reverse use reverse video mode\n\
1106 half use half bright\n\
1107 half-standout use half bright and standout mode\n\
1108 bold use extra bright or bold\n\
1109 bold-standout use extra bright or bold with standout mode"),
1111 show_tui_active_border_mode
,
1112 &tui_setlist
, &tui_showlist
);
1114 add_setshow_zuinteger_cmd ("tab-width", no_class
,
1115 &internal_tab_width
, _("\
1116 Set the tab width, in characters, for the TUI."), _("\
1117 Show the tab witdh, in characters, for the TUI."), _("\
1118 This variable controls how many spaces are used to display a tab character."),
1119 tui_set_tab_width
, tui_show_tab_width
,
1120 &tui_setlist
, &tui_showlist
);
1122 add_setshow_boolean_cmd ("tui-resize-message", class_maintenance
,
1123 &resize_message
, _("\
1124 Set TUI resize messaging."), _("\
1125 Show TUI resize messaging."), _("\
1126 When enabled GDB will print a message when the terminal is resized."),
1128 show_tui_resize_message
,
1129 &maintenance_set_cmdlist
,
1130 &maintenance_show_cmdlist
);
1132 add_setshow_boolean_cmd ("compact-source", class_tui
,
1133 &compact_source
, _("\
1134 Set whether the TUI source window is compact."), _("\
1135 Show whether the TUI source window is compact."), _("\
1136 This variable controls whether the TUI source window is shown\n\
1137 in a compact form. The compact form puts the source closer to\n\
1138 the line numbers and uses less horizontal space."),
1139 tui_set_compact_source
, tui_show_compact_source
,
1140 &tui_setlist
, &tui_showlist
);
1142 tui_border_style
.changed
.attach (tui_rehighlight_all
, "tui-win");
1143 tui_active_border_style
.changed
.attach (tui_rehighlight_all
, "tui-win");