tui.h revision 1.9 
1/* External/Public TUI Header File.
2
3   Copyright (C) 1998-2020 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
25struct ui_file;
26
27/* Types of error returns.  */
28enum tui_status
29{
30  TUI_SUCCESS,
31  TUI_FAILURE
32};
33
34/* Types of windows.  */
35enum tui_win_type
36{
37  SRC_WIN = 0,
38  DISASSEM_WIN,
39  DATA_WIN,
40  CMD_WIN,
41  /* This must ALWAYS be AFTER the major windows last.  */
42  MAX_MAJOR_WINDOWS,
43};
44
45extern CORE_ADDR tui_get_low_disassembly_address (struct gdbarch *,
46						  CORE_ADDR, CORE_ADDR);
47extern void tui_show_assembly (struct gdbarch *gdbarch, CORE_ADDR addr);
48extern bool tui_is_window_visible (enum tui_win_type type);
49extern bool tui_get_command_dimension (unsigned int *width,
50				       unsigned int *height);
51
52/* Initialize readline and configure the keymap for the switching key
53   shortcut.  May be called more than once without issue.  */
54extern void tui_ensure_readline_initialized ();
55
56/* Enter in the tui mode (curses).  */
57extern void tui_enable (void);
58
59/* Leave the tui mode.  */
60extern void tui_disable (void);
61
62enum tui_key_mode
63{
64  /* Plain command mode to enter gdb commands.  */
65  TUI_COMMAND_MODE,
66
67  /* SingleKey mode with some keys bound to gdb commands.  */
68  TUI_SINGLE_KEY_MODE,
69
70  /* Read/edit one command and return to SingleKey after it's
71     processed.  */
72  TUI_ONE_COMMAND_MODE
73};
74
75extern enum tui_key_mode tui_current_key_mode;
76
77/* Change the TUI key mode by installing the appropriate readline
78   keymap.  */
79extern void tui_set_key_mode (enum tui_key_mode mode);
80
81extern bool tui_active;
82
83#endif /* TUI_TUI_H */
84