1 /* External/Public TUI Header File. 2 3 Copyright (C) 1998-2024 Free Software Foundation, Inc. 4 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 11 the Free Software Foundation; either version 3 of the License, or 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 20 along with this program. If not, see <http://www.gnu.org/licenses/>. */ 21 22 #ifndef TUI_TUI_H 23 #define TUI_TUI_H 24 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 39 #define TUI_SCOPED_DEBUG_START_END(fmt, ...) \ 40 scoped_debug_start_end (debug_tui, "tui", fmt, ##__VA_ARGS__) 41 42 /* Types of error returns. */ 43 enum tui_status 44 { 45 TUI_SUCCESS, 46 TUI_FAILURE 47 }; 48 49 /* Types of windows. */ 50 enum tui_win_type 51 { 52 SRC_WIN = 0, 53 DISASSEM_WIN, 54 DATA_WIN, 55 CMD_WIN, 56 STATUS_WIN, 57 /* This must ALWAYS be AFTER the major windows last. */ 58 MAX_MAJOR_WINDOWS, 59 }; 60 61 extern CORE_ADDR tui_get_low_disassembly_address (struct gdbarch *, 62 CORE_ADDR, CORE_ADDR); 63 extern void tui_show_assembly (struct gdbarch *gdbarch, CORE_ADDR addr); 64 extern bool tui_is_window_visible (enum tui_win_type type); 65 extern bool tui_get_command_dimension (unsigned int *width, 66 unsigned int *height); 67 68 /* Initialize readline and configure the keymap for the switching key 69 shortcut. May be called more than once without issue. */ 70 extern void tui_ensure_readline_initialized (); 71 72 /* Enter in the tui mode (curses). */ 73 extern void tui_enable (void); 74 75 /* Leave the tui mode. */ 76 extern void tui_disable (void); 77 78 enum tui_key_mode 79 { 80 /* Plain command mode to enter gdb commands. */ 81 TUI_COMMAND_MODE, 82 83 /* SingleKey mode with some keys bound to gdb commands. */ 84 TUI_SINGLE_KEY_MODE, 85 86 /* Read/edit one command and return to SingleKey after it's 87 processed. */ 88 TUI_ONE_COMMAND_MODE 89 }; 90 91 extern enum tui_key_mode tui_current_key_mode; 92 93 /* Change the TUI key mode by installing the appropriate readline 94 keymap. */ 95 extern void tui_set_key_mode (enum tui_key_mode mode); 96 97 extern bool tui_active; 98 99 #endif /* TUI_TUI_H */ 100