1 /* TUI window generic functions.
3 Copyright (C) 1998-2023 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"),
221 /* Implementation of the "set/show style tui-current-position" commands. */
223 bool style_tui_current_position
= false;
226 show_style_tui_current_position (ui_file
*file
,
231 gdb_printf (file
, _("\
232 Styling the text highlighted by the TUI's current position indicator is %s.\n"),
237 set_style_tui_current_position (const char *ignore
, int from_tty
,
240 if (TUI_SRC_WIN
!= nullptr)
241 TUI_SRC_WIN
->refill ();
242 if (TUI_DISASM_WIN
!= nullptr)
243 TUI_DISASM_WIN
->refill ();
246 /* Tui internal configuration variables. These variables are updated
247 by tui_update_variables to reflect the tui configuration
249 chtype tui_border_vline
;
250 chtype tui_border_hline
;
251 chtype tui_border_ulcorner
;
252 chtype tui_border_urcorner
;
253 chtype tui_border_llcorner
;
254 chtype tui_border_lrcorner
;
256 int tui_border_attrs
;
257 int tui_active_border_attrs
;
259 /* Identify the item in the translation table.
260 When the item is not recognized, use the default entry. */
261 static struct tui_translate
*
262 translate (const char *name
, struct tui_translate
*table
)
266 if (name
&& strcmp (table
->name
, name
) == 0)
271 /* Not found, return default entry. */
276 /* Update the tui internal configuration according to gdb settings.
277 Returns 1 if the configuration has changed and the screen should
280 tui_update_variables ()
282 bool need_redraw
= false;
283 struct tui_translate
*entry
;
285 entry
= translate (tui_border_mode
, tui_border_mode_translate
);
286 if (tui_border_attrs
!= entry
->value
)
288 tui_border_attrs
= entry
->value
;
291 entry
= translate (tui_active_border_mode
, tui_border_mode_translate
);
292 if (tui_active_border_attrs
!= entry
->value
)
294 tui_active_border_attrs
= entry
->value
;
298 /* If one corner changes, all characters are changed.
299 Only check the first one. The ACS characters are determined at
300 run time by curses terminal management. */
301 entry
= translate (tui_border_kind
, tui_border_kind_translate_lrcorner
);
302 if (tui_border_lrcorner
!= (chtype
) entry
->value
)
304 tui_border_lrcorner
= (entry
->value
< 0) ? ACS_LRCORNER
: entry
->value
;
307 entry
= translate (tui_border_kind
, tui_border_kind_translate_llcorner
);
308 tui_border_llcorner
= (entry
->value
< 0) ? ACS_LLCORNER
: entry
->value
;
310 entry
= translate (tui_border_kind
, tui_border_kind_translate_ulcorner
);
311 tui_border_ulcorner
= (entry
->value
< 0) ? ACS_ULCORNER
: entry
->value
;
313 entry
= translate (tui_border_kind
, tui_border_kind_translate_urcorner
);
314 tui_border_urcorner
= (entry
->value
< 0) ? ACS_URCORNER
: entry
->value
;
316 entry
= translate (tui_border_kind
, tui_border_kind_translate_hline
);
317 tui_border_hline
= (entry
->value
< 0) ? ACS_HLINE
: entry
->value
;
319 entry
= translate (tui_border_kind
, tui_border_kind_translate_vline
);
320 tui_border_vline
= (entry
->value
< 0) ? ACS_VLINE
: entry
->value
;
325 static struct cmd_list_element
*tuilist
;
327 struct cmd_list_element
**
328 tui_get_cmd_list (void)
331 add_basic_prefix_cmd ("tui", class_tui
,
332 _("Text User Interface commands."),
333 &tuilist
, 0, &cmdlist
);
337 /* The set_func hook of "set tui ..." commands that affect the window
338 borders on the TUI display. */
341 tui_set_var_cmd (const char *null_args
,
342 int from_tty
, struct cmd_list_element
*c
)
344 if (tui_update_variables () && tui_active
)
345 tui_rehighlight_all ();
350 /* True if TUI resizes should print a message. This is used by the
353 static bool resize_message
;
356 show_tui_resize_message (struct ui_file
*file
, int from_tty
,
357 struct cmd_list_element
*c
, const char *value
)
359 gdb_printf (file
, _("TUI resize messaging is %s.\n"), value
);
364 /* Generic window name completion function. Complete window name pointed
365 to by TEXT and WORD. If INCLUDE_NEXT_PREV_P is true then the special
366 window names 'next' and 'prev' will also be considered as possible
367 completions of the window name. */
370 window_name_completer (completion_tracker
&tracker
,
371 int include_next_prev_p
,
372 const char *text
, const char *word
)
374 std::vector
<const char *> completion_name_vec
;
376 for (tui_win_info
*win_info
: all_tui_windows ())
378 const char *completion_name
= NULL
;
380 /* We can't focus on an invisible window. */
381 if (!win_info
->is_visible ())
384 completion_name
= win_info
->name ();
385 gdb_assert (completion_name
!= NULL
);
386 completion_name_vec
.push_back (completion_name
);
389 /* If no windows are considered visible then the TUI has not yet been
390 initialized. But still "focus src" and "focus cmd" will work because
391 invoking the focus command will entail initializing the TUI which sets the
392 default layout to "src". */
393 if (completion_name_vec
.empty ())
395 completion_name_vec
.push_back (SRC_NAME
);
396 completion_name_vec
.push_back (CMD_NAME
);
399 if (include_next_prev_p
)
401 completion_name_vec
.push_back ("next");
402 completion_name_vec
.push_back ("prev");
406 completion_name_vec
.push_back (NULL
);
407 complete_on_enum (tracker
, completion_name_vec
.data (), text
, word
);
410 /* Complete possible window names to focus on. TEXT is the complete text
411 entered so far, WORD is the word currently being completed. */
414 focus_completer (struct cmd_list_element
*ignore
,
415 completion_tracker
&tracker
,
416 const char *text
, const char *word
)
418 window_name_completer (tracker
, 1, text
, word
);
421 /* Complete possible window names for winheight command. TEXT is the
422 complete text entered so far, WORD is the word currently being
426 winheight_completer (struct cmd_list_element
*ignore
,
427 completion_tracker
&tracker
,
428 const char *text
, const char *word
)
430 /* The first word is the window name. That we can complete. Subsequent
431 words can't be completed. */
435 window_name_completer (tracker
, 0, text
, word
);
438 /* Update gdb's knowledge of the terminal size. */
440 tui_update_gdb_sizes (void)
446 width
= TUI_CMD_WIN
->width
;
447 height
= TUI_CMD_WIN
->height
;
451 width
= tui_term_width ();
452 height
= tui_term_height ();
455 set_screen_width_and_height (width
, height
);
460 tui_win_info::forward_scroll (int num_to_scroll
)
462 if (num_to_scroll
== 0)
463 num_to_scroll
= height
- 3;
465 do_scroll_vertical (num_to_scroll
);
469 tui_win_info::backward_scroll (int num_to_scroll
)
471 if (num_to_scroll
== 0)
472 num_to_scroll
= height
- 3;
474 do_scroll_vertical (-num_to_scroll
);
479 tui_win_info::left_scroll (int num_to_scroll
)
481 if (num_to_scroll
== 0)
484 do_scroll_horizontal (num_to_scroll
);
489 tui_win_info::right_scroll (int num_to_scroll
)
491 if (num_to_scroll
== 0)
494 do_scroll_horizontal (-num_to_scroll
);
499 tui_refresh_all_win (void)
501 clearok (curscr
, TRUE
);
506 tui_rehighlight_all (void)
508 for (tui_win_info
*win_info
: all_tui_windows ())
509 win_info
->check_and_display_highlight_if_needed ();
512 /* Resize all the windows based on the terminal size. This function
513 gets called from within the readline SIGWINCH handler. */
515 tui_resize_all (void)
517 int height_diff
, width_diff
;
518 int screenheight
, screenwidth
;
520 rl_get_screen_size (&screenheight
, &screenwidth
);
521 width_diff
= screenwidth
- tui_term_width ();
522 height_diff
= screenheight
- tui_term_height ();
523 if (height_diff
|| width_diff
)
525 #ifdef HAVE_RESIZE_TERM
526 resize_term (screenheight
, screenwidth
);
528 /* Turn keypad off while we resize. */
529 keypad (TUI_CMD_WIN
->handle
.get (), FALSE
);
530 tui_update_gdb_sizes ();
531 tui_set_term_height_to (screenheight
);
532 tui_set_term_width_to (screenwidth
);
534 /* erase + clearok are used instead of a straightforward clear as
535 AIX 5.3 does not define clear. */
537 clearok (curscr
, TRUE
);
538 /* Apply the current layout. The 'false' here allows the command
539 window to resize proportionately with containing terminal, rather
540 than maintaining a fixed size. */
541 tui_apply_current_layout (false); /* Turn keypad back on. */
542 keypad (TUI_CMD_WIN
->handle
.get (), TRUE
);
547 /* Token for use by TUI's asynchronous SIGWINCH handler. */
548 static struct async_signal_handler
*tui_sigwinch_token
;
550 /* TUI's SIGWINCH signal handler. */
552 tui_sigwinch_handler (int signal
)
554 mark_async_signal_handler (tui_sigwinch_token
);
555 tui_set_win_resized_to (true);
558 /* Callback for asynchronously resizing TUI following a SIGWINCH signal. */
560 tui_async_resize_screen (gdb_client_data arg
)
562 rl_resize_terminal ();
566 int screen_height
, screen_width
;
568 rl_get_screen_size (&screen_height
, &screen_width
);
569 set_screen_width_and_height (screen_width
, screen_height
);
571 /* win_resized is left set so that the next call to tui_enable()
572 resizes the TUI windows. */
576 tui_set_win_resized_to (false);
578 tui_refresh_all_win ();
579 tui_update_gdb_sizes ();
583 printf_unfiltered ("@@ resize done %d, size = %dx%d\n", count
,
584 tui_term_width (), tui_term_height ());
587 tui_redisplay_readline ();
592 /* Initialize TUI's SIGWINCH signal handler. Note that the handler is not
593 uninstalled when we exit TUI, so the handler should not assume that TUI is
596 tui_initialize_win (void)
600 = create_async_signal_handler (tui_async_resize_screen
, NULL
,
604 #ifdef HAVE_SIGACTION
605 struct sigaction old_winch
;
607 memset (&old_winch
, 0, sizeof (old_winch
));
608 old_winch
.sa_handler
= &tui_sigwinch_handler
;
610 old_winch
.sa_flags
= SA_RESTART
;
612 sigaction (SIGWINCH
, &old_winch
, NULL
);
614 signal (SIGWINCH
, &tui_sigwinch_handler
);
622 tui_scroll_forward_command (const char *arg
, int from_tty
)
624 int num_to_scroll
= 1;
625 struct tui_win_info
*win_to_scroll
;
627 /* Make sure the curses mode is enabled. */
630 parse_scrolling_args (arg
, &win_to_scroll
, NULL
);
632 parse_scrolling_args (arg
, &win_to_scroll
, &num_to_scroll
);
633 win_to_scroll
->forward_scroll (num_to_scroll
);
638 tui_scroll_backward_command (const char *arg
, int from_tty
)
640 int num_to_scroll
= 1;
641 struct tui_win_info
*win_to_scroll
;
643 /* Make sure the curses mode is enabled. */
646 parse_scrolling_args (arg
, &win_to_scroll
, NULL
);
648 parse_scrolling_args (arg
, &win_to_scroll
, &num_to_scroll
);
649 win_to_scroll
->backward_scroll (num_to_scroll
);
654 tui_scroll_left_command (const char *arg
, int from_tty
)
657 struct tui_win_info
*win_to_scroll
;
659 /* Make sure the curses mode is enabled. */
661 parse_scrolling_args (arg
, &win_to_scroll
, &num_to_scroll
);
662 win_to_scroll
->left_scroll (num_to_scroll
);
667 tui_scroll_right_command (const char *arg
, int from_tty
)
670 struct tui_win_info
*win_to_scroll
;
672 /* Make sure the curses mode is enabled. */
674 parse_scrolling_args (arg
, &win_to_scroll
, &num_to_scroll
);
675 win_to_scroll
->right_scroll (num_to_scroll
);
679 /* Answer the window represented by name. */
680 static struct tui_win_info
*
681 tui_partial_win_by_name (gdb::string_view name
)
683 struct tui_win_info
*best
= nullptr;
685 for (tui_win_info
*item
: all_tui_windows ())
687 const char *cur_name
= item
->name ();
689 if (name
== cur_name
)
691 if (startswith (cur_name
, name
))
694 error (_("Window name \"%*s\" is ambiguous"),
695 (int) name
.size (), name
.data ());
703 /* Set focus to the window named by 'arg'. */
705 tui_set_focus_command (const char *arg
, int from_tty
)
710 error_no_arg (_("name of window to focus"));
712 struct tui_win_info
*win_info
= NULL
;
714 if (startswith ("next", arg
))
715 win_info
= tui_next_win (tui_win_with_focus ());
716 else if (startswith ("prev", arg
))
717 win_info
= tui_prev_win (tui_win_with_focus ());
719 win_info
= tui_partial_win_by_name (arg
);
721 if (win_info
== NULL
)
722 error (_("Unrecognized window name \"%s\""), arg
);
723 if (!win_info
->is_visible ())
724 error (_("Window \"%s\" is not visible"), arg
);
726 tui_set_win_focus_to (win_info
);
727 gdb_printf (_("Focus set to %s window.\n"),
728 tui_win_with_focus ()->name ());
732 tui_all_windows_info (const char *arg
, int from_tty
)
736 gdb_printf (_("The TUI is not active.\n"));
740 struct tui_win_info
*win_with_focus
= tui_win_with_focus ();
741 struct ui_out
*uiout
= current_uiout
;
743 ui_out_emit_table
table_emitter (uiout
, 4, -1, "tui-windows");
744 uiout
->table_header (10, ui_left
, "name", "Name");
745 uiout
->table_header (5, ui_right
, "lines", "Lines");
746 uiout
->table_header (7, ui_right
, "columns", "Columns");
747 uiout
->table_header (10, ui_left
, "focus", "Focus");
748 uiout
->table_body ();
750 for (tui_win_info
*win_info
: all_tui_windows ())
751 if (win_info
->is_visible ())
753 ui_out_emit_tuple
tuple_emitter (uiout
, nullptr);
755 uiout
->field_string ("name", win_info
->name ());
756 uiout
->field_signed ("lines", win_info
->height
);
757 uiout
->field_signed ("columns", win_info
->width
);
758 if (win_with_focus
== win_info
)
759 uiout
->field_string ("focus", _("(has focus)"));
761 uiout
->field_skip ("focus");
768 tui_refresh_all_command (const char *arg
, int from_tty
)
770 /* Make sure the curses mode is enabled. */
773 tui_refresh_all_win ();
776 #define DEFAULT_TAB_LEN 8
778 /* The tab width that should be used by the TUI. */
780 unsigned int tui_tab_width
= DEFAULT_TAB_LEN
;
782 /* The tab width as set by the user. */
784 static unsigned int internal_tab_width
= DEFAULT_TAB_LEN
;
786 /* After the tab width is set, call this to update the relevant
792 for (tui_win_info
*win_info
: all_tui_windows ())
794 if (win_info
->is_visible ())
795 win_info
->update_tab_width ();
799 /* Callback for "set tui tab-width". */
802 tui_set_tab_width (const char *ignore
,
803 int from_tty
, struct cmd_list_element
*c
)
805 if (internal_tab_width
== 0)
807 internal_tab_width
= tui_tab_width
;
808 error (_("Tab width must not be 0"));
811 tui_tab_width
= internal_tab_width
;
815 /* Callback for "show tui tab-width". */
818 tui_show_tab_width (struct ui_file
*file
, int from_tty
,
819 struct cmd_list_element
*c
, const char *value
)
821 gdb_printf (file
, _("TUI tab width is %s spaces.\n"), value
);
827 bool compact_source
= false;
829 /* Callback for "set tui compact-source". */
832 tui_set_compact_source (const char *ignore
, int from_tty
,
833 struct cmd_list_element
*c
)
835 if (TUI_SRC_WIN
!= nullptr)
836 TUI_SRC_WIN
->refill ();
839 /* Callback for "show tui compact-source". */
842 tui_show_compact_source (struct ui_file
*file
, int from_tty
,
843 struct cmd_list_element
*c
, const char *value
)
845 gdb_printf (file
, _("TUI source window compactness is %s.\n"), value
);
848 /* Set the tab width of the specified window. */
850 tui_set_tab_width_command (const char *arg
, int from_tty
)
852 /* Make sure the curses mode is enabled. */
860 warning (_("Tab widths greater than 0 must be specified."));
863 internal_tab_width
= ts
;
871 /* Helper function for the user commands to adjust a window's width or
872 height. The ARG string contains the command line arguments from the
873 user, which should give the name of a window, and how to adjust the
876 When SET_WIDTH_P is true the width of the window is adjusted based on
877 ARG, and when SET_WIDTH_P is false, the height of the window is adjusted
880 On invalid input, or if the size can't be adjusted as requested, then an
881 error is thrown, otherwise, the window sizes are adjusted, and the
885 tui_set_win_size (const char *arg
, bool set_width_p
)
887 /* Make sure the curses mode is enabled. */
890 error_no_arg (_("name of window"));
892 const char *buf
= arg
;
893 const char *buf_ptr
= buf
;
895 struct tui_win_info
*win_info
;
897 buf_ptr
= skip_to_space (buf_ptr
);
899 /* Validate the window name. */
900 gdb::string_view
wname (buf
, buf_ptr
- buf
);
901 win_info
= tui_partial_win_by_name (wname
);
903 if (win_info
== NULL
)
904 error (_("Unrecognized window name \"%s\""), arg
);
905 if (!win_info
->is_visible ())
906 error (_("Window \"%s\" is not visible"), arg
);
908 /* Process the size. */
909 buf_ptr
= skip_spaces (buf_ptr
);
911 if (*buf_ptr
!= '\0')
914 bool fixed_size
= true;
917 if (*buf_ptr
== '+' || *buf_ptr
== '-')
924 input_no
= atoi (buf_ptr
);
935 curr_size
= win_info
->width
;
937 curr_size
= win_info
->height
;
938 new_size
= curr_size
+ input_no
;
941 /* Now change the window's height, and adjust
942 all other windows around it. */
944 tui_adjust_window_width (win_info
, new_size
);
946 tui_adjust_window_height (win_info
, new_size
);
947 tui_update_gdb_sizes ();
952 error (_("Invalid window width specified"));
954 error (_("Invalid window height specified"));
959 /* Implement the 'tui window height' command (alias 'winheight'). */
962 tui_set_win_height_command (const char *arg
, int from_tty
)
964 /* Pass false as the final argument to set the height. */
965 tui_set_win_size (arg
, false);
968 /* Implement the 'tui window width' command (alias 'winwidth'). */
971 tui_set_win_width_command (const char *arg
, int from_tty
)
973 /* Pass true as the final argument to set the width. */
974 tui_set_win_size (arg
, true);
977 /* See tui-data.h. */
980 tui_win_info::max_height () const
982 return tui_term_height ();
985 /* See tui-data.h. */
988 tui_win_info::max_width () const
990 return tui_term_width ();
994 parse_scrolling_args (const char *arg
,
995 struct tui_win_info
**win_to_scroll
,
1000 *win_to_scroll
= tui_win_with_focus ();
1002 /* First set up the default window to scroll, in case there is no
1008 /* Process the number of lines to scroll. */
1009 std::string copy
= arg
;
1011 if (isdigit (*buf_ptr
))
1016 buf_ptr
= strchr (buf_ptr
, ' ');
1017 if (buf_ptr
!= NULL
)
1021 *num_to_scroll
= atoi (num_str
);
1024 else if (num_to_scroll
)
1025 *num_to_scroll
= atoi (num_str
);
1028 /* Process the window name if one is specified. */
1029 if (buf_ptr
!= NULL
)
1033 wname
= skip_spaces (buf_ptr
);
1037 *win_to_scroll
= tui_partial_win_by_name (wname
);
1039 if (*win_to_scroll
== NULL
)
1040 error (_("Unrecognized window `%s'"), wname
);
1041 if (!(*win_to_scroll
)->is_visible ())
1042 error (_("Window is not visible"));
1043 else if (*win_to_scroll
== TUI_CMD_WIN
)
1044 *win_to_scroll
= *(tui_source_windows ().begin ());
1050 /* The list of 'tui window' sub-commands. */
1052 static cmd_list_element
*tui_window_cmds
= nullptr;
1054 /* Called to implement 'tui window'. */
1057 tui_window_command (const char *args
, int from_tty
)
1059 help_list (tui_window_cmds
, "tui window ", all_commands
, gdb_stdout
);
1062 /* Function to initialize gdb commands, for tui window
1065 void _initialize_tui_win ();
1067 _initialize_tui_win ()
1069 static struct cmd_list_element
*tui_setlist
;
1070 static struct cmd_list_element
*tui_showlist
;
1072 /* Define the classes of commands.
1073 They will appear in the help list in the reverse of this order. */
1074 add_setshow_prefix_cmd ("tui", class_tui
,
1075 _("TUI configuration variables."),
1076 _("TUI configuration variables."),
1077 &tui_setlist
, &tui_showlist
,
1078 &setlist
, &showlist
);
1080 cmd_list_element
*refresh_cmd
1081 = add_cmd ("refresh", class_tui
, tui_refresh_all_command
,
1082 _("Refresh the terminal display."),
1083 tui_get_cmd_list ());
1084 add_com_alias ("refresh", refresh_cmd
, class_tui
, 0);
1086 cmd_list_element
*tabset_cmd
1087 = add_com ("tabset", class_tui
, tui_set_tab_width_command
, _("\
1088 Set the width (in characters) of tab stops.\n\
1090 deprecate_cmd (tabset_cmd
, "set tui tab-width");
1092 /* Setup the 'tui window' list of command. */
1093 add_prefix_cmd ("window", class_tui
, tui_window_command
,
1094 _("Text User Interface window commands."),
1095 &tui_window_cmds
, 1, tui_get_cmd_list ());
1097 cmd_list_element
*winheight_cmd
1098 = add_cmd ("height", class_tui
, tui_set_win_height_command
, _("\
1099 Set or modify the height of a specified window.\n\
1100 Usage: tui window height WINDOW-NAME [+ | -] NUM-LINES\n\
1101 Use \"info win\" to see the names of the windows currently being displayed."),
1103 add_com_alias ("winheight", winheight_cmd
, class_tui
, 0);
1104 add_com_alias ("wh", winheight_cmd
, class_tui
, 0);
1105 set_cmd_completer (winheight_cmd
, winheight_completer
);
1107 cmd_list_element
*winwidth_cmd
1108 = add_cmd ("width", class_tui
, tui_set_win_width_command
, _("\
1109 Set or modify the width of a specified window.\n\
1110 Usage: tui window width WINDOW-NAME [+ | -] NUM-LINES\n\
1111 Use \"info win\" to see the names of the windows currently being displayed."),
1113 add_com_alias ("winwidth", winwidth_cmd
, class_tui
, 0);
1114 set_cmd_completer (winwidth_cmd
, winheight_completer
);
1116 add_info ("win", tui_all_windows_info
,
1117 _("List of all displayed windows.\n\
1119 cmd_list_element
*focus_cmd
1120 = add_cmd ("focus", class_tui
, tui_set_focus_command
, _("\
1121 Set focus to named window or next/prev window.\n\
1122 Usage: tui focus [WINDOW-NAME | next | prev]\n\
1123 Use \"info win\" to see the names of the windows currently being displayed."),
1124 tui_get_cmd_list ());
1125 add_com_alias ("focus", focus_cmd
, class_tui
, 0);
1126 add_com_alias ("fs", focus_cmd
, class_tui
, 0);
1127 set_cmd_completer (focus_cmd
, focus_completer
);
1128 add_com ("+", class_tui
, tui_scroll_forward_command
, _("\
1129 Scroll window forward.\n\
1130 Usage: + [N] [WIN]\n\
1131 Scroll window WIN N lines forwards. Both WIN and N are optional, N\n\
1132 defaults to 1, and WIN defaults to the currently focused window."));
1133 add_com ("-", class_tui
, tui_scroll_backward_command
, _("\
1134 Scroll window backward.\n\
1135 Usage: - [N] [WIN]\n\
1136 Scroll window WIN N lines backwards. Both WIN and N are optional, N\n\
1137 defaults to 1, and WIN defaults to the currently focused window."));
1138 add_com ("<", class_tui
, tui_scroll_left_command
, _("\
1139 Scroll window text to the left.\n\
1140 Usage: < [N] [WIN]\n\
1141 Scroll window WIN N characters left. Both WIN and N are optional, N\n\
1142 defaults to 1, and WIN defaults to the currently focused window."));
1143 add_com (">", class_tui
, tui_scroll_right_command
, _("\
1144 Scroll window text to the right.\n\
1145 Usage: > [N] [WIN]\n\
1146 Scroll window WIN N characters right. Both WIN and N are optional, N\n\
1147 defaults to 1, and WIN defaults to the currently focused window."));
1149 /* Define the tui control variables. */
1150 add_setshow_enum_cmd ("border-kind", no_class
, tui_border_kind_enums
,
1151 &tui_border_kind
, _("\
1152 Set the kind of border for TUI windows."), _("\
1153 Show the kind of border for TUI windows."), _("\
1154 This variable controls the border of TUI windows:\n\
1155 space use a white space\n\
1156 ascii use ascii characters + - | for the border\n\
1157 acs use the Alternate Character Set"),
1159 show_tui_border_kind
,
1160 &tui_setlist
, &tui_showlist
);
1162 add_setshow_enum_cmd ("border-mode", no_class
, tui_border_mode_enums
,
1163 &tui_border_mode
, _("\
1164 Set the attribute mode to use for the TUI window borders."), _("\
1165 Show the attribute mode to use for the TUI window borders."), _("\
1166 This variable controls the attributes to use for the window borders:\n\
1167 normal normal display\n\
1168 standout use highlight mode of terminal\n\
1169 reverse use reverse video mode\n\
1170 half use half bright\n\
1171 half-standout use half bright and standout mode\n\
1172 bold use extra bright or bold\n\
1173 bold-standout use extra bright or bold with standout mode"),
1175 show_tui_border_mode
,
1176 &tui_setlist
, &tui_showlist
);
1178 add_setshow_enum_cmd ("active-border-mode", no_class
, tui_border_mode_enums
,
1179 &tui_active_border_mode
, _("\
1180 Set the attribute mode to use for the active TUI window border."), _("\
1181 Show the attribute mode to use for the active TUI window border."), _("\
1182 This variable controls the attributes to use for the active window border:\n\
1183 normal normal display\n\
1184 standout use highlight mode of terminal\n\
1185 reverse use reverse video mode\n\
1186 half use half bright\n\
1187 half-standout use half bright and standout mode\n\
1188 bold use extra bright or bold\n\
1189 bold-standout use extra bright or bold with standout mode"),
1191 show_tui_active_border_mode
,
1192 &tui_setlist
, &tui_showlist
);
1194 add_setshow_zuinteger_cmd ("tab-width", no_class
,
1195 &internal_tab_width
, _("\
1196 Set the tab width, in characters, for the TUI."), _("\
1197 Show the tab witdh, in characters, for the TUI."), _("\
1198 This variable controls how many spaces are used to display a tab character."),
1199 tui_set_tab_width
, tui_show_tab_width
,
1200 &tui_setlist
, &tui_showlist
);
1202 add_setshow_boolean_cmd ("tui-resize-message", class_maintenance
,
1203 &resize_message
, _("\
1204 Set TUI resize messaging."), _("\
1205 Show TUI resize messaging."), _("\
1206 When enabled GDB will print a message when the terminal is resized."),
1208 show_tui_resize_message
,
1209 &maintenance_set_cmdlist
,
1210 &maintenance_show_cmdlist
);
1212 add_setshow_boolean_cmd ("compact-source", class_tui
,
1213 &compact_source
, _("\
1214 Set whether the TUI source window is compact."), _("\
1215 Show whether the TUI source window is compact."), _("\
1216 This variable controls whether the TUI source window is shown\n\
1217 in a compact form. The compact form puts the source closer to\n\
1218 the line numbers and uses less horizontal space."),
1219 tui_set_compact_source
, tui_show_compact_source
,
1220 &tui_setlist
, &tui_showlist
);
1222 add_setshow_boolean_cmd ("tui-current-position", class_maintenance
,
1223 &style_tui_current_position
, _("\
1224 Set whether to style text highlighted by the TUI's current position indicator."),
1226 Show whether to style text highlighted by the TUI's current position indicator."),
1228 When enabled, the source and assembly code highlighted by the TUI's current\n\
1229 position indicator is styled."),
1230 set_style_tui_current_position
,
1231 show_style_tui_current_position
,
1235 tui_border_style
.changed
.attach (tui_rehighlight_all
, "tui-win");
1236 tui_active_border_style
.changed
.attach (tui_rehighlight_all
, "tui-win");