]>
Commit | Line | Data |
---|---|---|
f377b406 | 1 | /* External/Public TUI Header File. |
65f05602 | 2 | |
213516ef | 3 | Copyright (C) 1998-2023 Free Software Foundation, Inc. |
65f05602 | 4 | |
f377b406 SC |
5 | Contributed by Hewlett-Packard Company. |
6 | ||
7 | This file is part of GDB. | |
8 | ||
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 | |
a9762ec7 | 11 | the Free Software Foundation; either version 3 of the License, or |
f377b406 SC |
12 | (at your option) any later version. |
13 | ||
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. | |
18 | ||
19 | You should have received a copy of the GNU General Public License | |
a9762ec7 | 20 | along with this program. If not, see <http://www.gnu.org/licenses/>. */ |
c906108c | 21 | |
1a5c2598 TT |
22 | #ifndef TUI_TUI_H |
23 | #define TUI_TUI_H | |
c906108c | 24 | |
7421ccda AB |
25 | /* Flag to control tui debugging. */ |
26 | ||
27 | extern bool debug_tui; | |
28 | ||
29 | /* Print a "tui" debug statement. */ | |
30 | ||
31 | #define tui_debug_printf(fmt, ...) \ | |
32 | debug_prefixed_printf_cond (debug_tui, "tui", fmt, ##__VA_ARGS__) | |
33 | ||
34 | /* Print "tui" enter/exit debug statements. */ | |
35 | ||
36 | #define TUI_SCOPED_DEBUG_ENTER_EXIT \ | |
37 | scoped_debug_enter_exit (debug_tui, "tui") | |
38 | ||
2d46b103 AB |
39 | #define TUI_SCOPED_DEBUG_START_END(fmt, ...) \ |
40 | scoped_debug_start_end (debug_tui, "tui", fmt, ##__VA_ARGS__) | |
41 | ||
4a4b3fed AC |
42 | struct ui_file; |
43 | ||
22940a24 AC |
44 | /* Types of error returns. */ |
45 | enum tui_status | |
46 | { | |
47 | TUI_SUCCESS, | |
48 | TUI_FAILURE | |
49 | }; | |
c906108c | 50 | |
1cc6d956 | 51 | /* Types of windows. */ |
22940a24 AC |
52 | enum tui_win_type |
53 | { | |
54 | SRC_WIN = 0, | |
55 | DISASSEM_WIN, | |
56 | DATA_WIN, | |
57 | CMD_WIN, | |
f237f998 | 58 | STATUS_WIN, |
22940a24 AC |
59 | /* This must ALWAYS be AFTER the major windows last. */ |
60 | MAX_MAJOR_WINDOWS, | |
22940a24 AC |
61 | }; |
62 | ||
13274fc3 UW |
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); | |
56122977 | 66 | extern bool tui_is_window_visible (enum tui_win_type type); |
87d557ae TT |
67 | extern bool tui_get_command_dimension (unsigned int *width, |
68 | unsigned int *height); | |
39db33d6 | 69 | |
a350efd4 TT |
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 (); | |
39db33d6 SC |
73 | |
74 | /* Enter in the tui mode (curses). */ | |
75 | extern void tui_enable (void); | |
76 | ||
77 | /* Leave the tui mode. */ | |
78 | extern void tui_disable (void); | |
c906108c | 79 | |
e09d2eba SC |
80 | enum tui_key_mode |
81 | { | |
82 | /* Plain command mode to enter gdb commands. */ | |
6d012f14 | 83 | TUI_COMMAND_MODE, |
e09d2eba SC |
84 | |
85 | /* SingleKey mode with some keys bound to gdb commands. */ | |
6d012f14 | 86 | TUI_SINGLE_KEY_MODE, |
e09d2eba | 87 | |
1cc6d956 MS |
88 | /* Read/edit one command and return to SingleKey after it's |
89 | processed. */ | |
6d012f14 | 90 | TUI_ONE_COMMAND_MODE |
e09d2eba SC |
91 | }; |
92 | ||
93 | extern enum tui_key_mode tui_current_key_mode; | |
94 | ||
1cc6d956 MS |
95 | /* Change the TUI key mode by installing the appropriate readline |
96 | keymap. */ | |
e09d2eba SC |
97 | extern void tui_set_key_mode (enum tui_key_mode mode); |
98 | ||
a1e4dee4 | 99 | extern bool tui_active; |
c6f60bcd | 100 | |
1a5c2598 | 101 | #endif /* TUI_TUI_H */ |