1 /* External/Public TUI Header File. 2 3 Copyright (C) 1998, 1999, 2000, 2001, 2004, 2007, 2008, 2009 4 Free Software Foundation, Inc. 5 6 Contributed by Hewlett-Packard Company. 7 8 This file is part of GDB. 9 10 This program is free software; you can redistribute it and/or modify 11 it under the terms of the GNU General Public License as published by 12 the Free Software Foundation; either version 3 of the License, or 13 (at your option) any later version. 14 15 This program is distributed in the hope that it will be useful, 16 but WITHOUT ANY WARRANTY; without even the implied warranty of 17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18 GNU General Public License for more details. 19 20 You should have received a copy of the GNU General Public License 21 along with this program. If not, see <http://www.gnu.org/licenses/>. */ 22 23 #ifndef TUI_H 24 #define TUI_H 25 26 struct ui_file; 27 28 extern void strcat_to_buf (char *, int, const char *); 29 30 /* Types of error returns. */ 31 enum tui_status 32 { 33 TUI_SUCCESS, 34 TUI_FAILURE 35 }; 36 37 /* Types of windows. */ 38 enum tui_win_type 39 { 40 SRC_WIN = 0, 41 DISASSEM_WIN, 42 DATA_WIN, 43 CMD_WIN, 44 /* This must ALWAYS be AFTER the major windows last. */ 45 MAX_MAJOR_WINDOWS, 46 /* Auxillary windows. */ 47 LOCATOR_WIN, 48 EXEC_INFO_WIN, 49 DATA_ITEM_WIN, 50 /* This must ALWAYS be next to last. */ 51 MAX_WINDOWS, 52 UNDEFINED_WIN /* LAST */ 53 }; 54 55 /* GENERAL TUI FUNCTIONS */ 56 /* tui.c */ 57 extern CORE_ADDR tui_get_low_disassembly_address (struct gdbarch *, 58 CORE_ADDR, CORE_ADDR); 59 extern void tui_show_assembly (struct gdbarch *gdbarch, CORE_ADDR addr); 60 extern int tui_is_window_visible (enum tui_win_type type); 61 extern int tui_get_command_dimension (unsigned int *width, 62 unsigned int *height); 63 64 /* Initialize readline and configure the keymap for the switching 65 key shortcut. */ 66 extern void tui_initialize_readline (void); 67 68 /* Enter in the tui mode (curses). */ 69 extern void tui_enable (void); 70 71 /* Leave the tui mode. */ 72 extern void tui_disable (void); 73 74 enum tui_key_mode 75 { 76 /* Plain command mode to enter gdb commands. */ 77 TUI_COMMAND_MODE, 78 79 /* SingleKey mode with some keys bound to gdb commands. */ 80 TUI_SINGLE_KEY_MODE, 81 82 /* Read/edit one command and return to SingleKey after it's 83 processed. */ 84 TUI_ONE_COMMAND_MODE 85 }; 86 87 extern enum tui_key_mode tui_current_key_mode; 88 89 /* Change the TUI key mode by installing the appropriate readline 90 keymap. */ 91 extern void tui_set_key_mode (enum tui_key_mode mode); 92 93 extern int tui_active; 94 95 extern void tui_show_source (const char *file, int line); 96 97 extern struct ui_out *tui_out_new (struct ui_file *stream); 98 99 /* tui-layout.c */ 100 extern enum tui_status tui_set_layout_for_display_command (const char *); 101 102 #endif 103