tui.h revision 302408 
1/* External/Public TUI Header File.
2
3   Copyright 1998, 1999, 2000, 2001, 2004 Free Software Foundation,
4   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 2 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, write to the Free Software
22   Foundation, Inc., 59 Temple Place - Suite 330,
23   Boston, MA 02111-1307, USA.  */
24
25#ifndef TUI_H
26#define TUI_H
27
28struct ui_file;
29
30extern void strcat_to_buf (char *, int, const char *);
31
32/* Types of error returns.  */
33enum tui_status
34{
35  TUI_SUCCESS,
36  TUI_FAILURE
37};
38
39/* Types of windows */
40enum tui_win_type
41{
42  SRC_WIN = 0,
43  DISASSEM_WIN,
44  DATA_WIN,
45  CMD_WIN,
46  /* This must ALWAYS be AFTER the major windows last.  */
47  MAX_MAJOR_WINDOWS,
48  /* Auxillary windows.  */
49  LOCATOR_WIN,
50  EXEC_INFO_WIN,
51  DATA_ITEM_WIN,
52  /* This must ALWAYS be next to last.  */
53  MAX_WINDOWS,
54  UNDEFINED_WIN		/* LAST */
55};
56
57/* GENERAL TUI FUNCTIONS */
58/* tui.c */
59extern CORE_ADDR tui_get_low_disassembly_address (CORE_ADDR, CORE_ADDR);
60extern void tui_show_assembly (CORE_ADDR addr);
61extern int tui_is_window_visible (enum tui_win_type type);
62extern int tui_get_command_dimension (int *width, int *height);
63
64/* Initialize readline and configure the keymap for the switching
65   key shortcut.  */
66extern void tui_initialize_readline (void);
67
68/* Enter in the tui mode (curses).  */
69extern void tui_enable (void);
70
71/* Leave the tui mode.  */
72extern void tui_disable (void);
73
74enum 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 processed.  */
83  TUI_ONE_COMMAND_MODE
84};
85
86extern enum tui_key_mode tui_current_key_mode;
87
88/* Change the TUI key mode by installing the appropriate readline keymap.  */
89extern void tui_set_key_mode (enum tui_key_mode mode);
90
91extern int tui_active;
92
93extern void tui_show_source (const char *file, int line);
94
95extern struct ui_out *tui_out_new (struct ui_file *stream);
96
97/* tui-layout.c */
98extern enum tui_status tui_set_layout_for_display_command (const char *name);
99
100#endif
101