b2ed4aa07ee56f5a2e1536a2b16ae47b3befc2fe
[binutils-gdb.git] / gdb / tui / tui.h
1 /* External/Public TUI Header File.
2 Copyright 1998, 1999, 2000, 2001 Free Software Foundation, Inc.
3 Contributed by Hewlett-Packard Company.
4
5 This file is part of GDB.
6
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2 of the License, or
10 (at your option) any later version.
11
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
16
17 You should have received a copy of the GNU General Public License
18 along with this program; if not, write to the Free Software
19 Foundation, Inc., 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
21
22 #ifndef TUI_H
23 #define TUI_H
24
25 #include <stdarg.h>
26 #include <string.h>
27 #include "ansidecl.h"
28
29 #if defined(reg)
30 #undef reg
31 #endif
32 #if defined(chtype)
33 #undef chtype
34 #endif
35
36 /* Opaque data type */
37 typedef char *Opaque;
38 typedef
39 Opaque (*OpaqueFuncPtr) (va_list);
40 typedef char **OpaqueList;
41 typedef OpaqueList OpaquePtr;
42
43 /* Generic function pointer */
44 typedef void (*TuiVoidFuncPtr) (va_list);
45 typedef int (*TuiIntFuncPtr) (va_list);
46 /*
47 typedef Opaque (*TuiOpaqueFuncPtr) (va_list);
48 */
49 typedef OpaqueFuncPtr TuiOpaqueFuncPtr;
50
51 extern void strcat_to_buf (char *, int, const char *);
52
53 /* Types of error returns */
54 typedef enum
55 {
56 TUI_SUCCESS,
57 TUI_FAILURE
58 }
59 TuiStatus, *TuiStatusPtr;
60
61 /* Types of windows */
62 typedef enum
63 {
64 SRC_WIN = 0,
65 DISASSEM_WIN,
66 DATA_WIN,
67 CMD_WIN,
68 /* This must ALWAYS be AFTER the major windows last */
69 MAX_MAJOR_WINDOWS,
70 /* auxillary windows */
71 LOCATOR_WIN,
72 EXEC_INFO_WIN,
73 DATA_ITEM_WIN,
74 /* This must ALWAYS be next to last */
75 MAX_WINDOWS,
76 UNDEFINED_WIN /* LAST */
77 }
78 TuiWinType, *TuiWinTypePtr;
79
80 /* This is a point definition */
81 typedef struct _TuiPoint
82 {
83 int x, y;
84 }
85 TuiPoint, *TuiPointPtr;
86
87 /* GENERAL TUI FUNCTIONS */
88 /* tui.c */
89 extern void tuiFree (char *);
90 extern CORE_ADDR tuiGetLowDisassemblyAddress (CORE_ADDR, CORE_ADDR);
91 extern void tui_show_assembly (CORE_ADDR addr);
92 extern int tui_is_window_visible (TuiWinType type);
93 extern int tui_get_command_dimension (int *width, int *height);
94
95 /* Initialize readline and configure the keymap for the switching
96 key shortcut. */
97 extern void tui_initialize_readline (void);
98
99 /* Enter in the tui mode (curses). */
100 extern void tui_enable (void);
101
102 /* Leave the tui mode. */
103 extern void tui_disable (void);
104
105 extern void tui_initialize_io (void);
106
107 extern void tui_initialize_readline (void);
108
109 extern int tui_active;
110
111 extern void tui_install_hooks (void);
112 extern void tui_remove_hooks (void);
113
114 extern void tui_show_source (const char *file, int line);
115
116 extern struct ui_out *tui_out_new (struct ui_file *stream);
117
118 /* tuiDataWin.c */
119 extern void tui_vCheckDataValues (va_list);
120
121 /* tuiIO.c */
122 extern void tui_vStartNewLines (va_list);
123
124 /* tuiLayout.c */
125 extern TuiStatus tui_set_layout (const char *);
126
127 /* tuiSourceWin.c */
128 extern void tuiDisplayMainFunction (void);
129 extern void tuiUpdateAllExecInfos (void);
130 extern void tui_vAllSetHasBreakAt (va_list);
131 extern void tui_vUpdateSourceWindowsWithAddr (va_list);
132
133 /* tuiStack.c */
134 extern void tui_vShowFrameInfo (va_list);
135 extern void tui_vUpdateLocatorFilename (va_list);
136 #endif /* TUI_H */