1 /* External/Public TUI Header File.
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/>. */
25 /* Flag to control tui debugging. */
27 extern bool debug_tui
;
29 /* Print a "tui" debug statement. */
31 #define tui_debug_printf(fmt, ...) \
32 debug_prefixed_printf_cond (debug_tui, "tui", fmt, ##__VA_ARGS__)
34 /* Print "tui" enter/exit debug statements. */
36 #define TUI_SCOPED_DEBUG_ENTER_EXIT \
37 scoped_debug_enter_exit (debug_tui, "tui")
39 #define TUI_SCOPED_DEBUG_START_END(fmt, ...) \
40 scoped_debug_start_end (debug_tui, "tui", fmt, ##__VA_ARGS__)
44 /* Types of error returns. */
51 /* Types of windows. */
59 /* This must ALWAYS be AFTER the major windows last. */
63 extern CORE_ADDR
tui_get_low_disassembly_address (struct gdbarch
*,
64 CORE_ADDR
, CORE_ADDR
);
65 extern void tui_show_assembly (struct gdbarch
*gdbarch
, CORE_ADDR addr
);
66 extern bool tui_is_window_visible (enum tui_win_type type
);
67 extern bool tui_get_command_dimension (unsigned int *width
,
68 unsigned int *height
);
70 /* Initialize readline and configure the keymap for the switching key
71 shortcut. May be called more than once without issue. */
72 extern void tui_ensure_readline_initialized ();
74 /* Enter in the tui mode (curses). */
75 extern void tui_enable (void);
77 /* Leave the tui mode. */
78 extern void tui_disable (void);
82 /* Plain command mode to enter gdb commands. */
85 /* SingleKey mode with some keys bound to gdb commands. */
88 /* Read/edit one command and return to SingleKey after it's
93 extern enum tui_key_mode tui_current_key_mode
;
95 /* Change the TUI key mode by installing the appropriate readline
97 extern void tui_set_key_mode (enum tui_key_mode mode
);
99 extern bool tui_active
;
101 #endif /* TUI_TUI_H */