]> git.ipfire.org Git - thirdparty/binutils-gdb.git/blame - gdb/tui/tuiData.h
import gdb-1999-07-07 post reformat
[thirdparty/binutils-gdb.git] / gdb / tui / tuiData.h
CommitLineData
c906108c
SS
1#ifndef TUI_DATA_H
2#define TUI_DATA_H
3
4/* Constant definitions */
5#define DEFAULT_TAB_LEN 8
6#define NO_SRC_STRING "[ No Source Available ]"
7#define NO_DISASSEM_STRING "[ No Assembly Available ]"
8#define NO_REGS_STRING "[ Register Values Unavailable ]"
9#define NO_DATA_STRING "[ No Data Values Displayed ]"
10#define MAX_CONTENT_COUNT 100
11#define SRC_NAME "SRC"
12#define CMD_NAME "CMD"
13#define DATA_NAME "REGS"
14#define DISASSEM_NAME "ASM"
15#define TUI_NULL_STR ""
16#define DEFAULT_HISTORY_COUNT 25
17#define BOX_WINDOW TRUE
18#define DONT_BOX_WINDOW FALSE
19#define HILITE TRUE
20#define NO_HILITE FALSE
21#define WITH_LOCATOR TRUE
22#define NO_LOCATOR FALSE
23#define EMPTY_SOURCE_PROMPT TRUE
24#define NO_EMPTY_SOURCE_PROMPT FALSE
25#define UNDEFINED_ITEM -1
26#define MIN_WIN_HEIGHT 3
27#define MIN_CMD_WIN_HEIGHT 3
28
29#define FILE_PREFIX "File: "
30#define PROC_PREFIX "Procedure: "
31#define LINE_PREFIX "Line: "
32#define PC_PREFIX "pc: "
33
34#define TUI_FLOAT_REGS_NAME "$FREGS"
35#define TUI_FLOAT_REGS_NAME_LOWER "$fregs"
36#define TUI_GENERAL_REGS_NAME "$GREGS"
37#define TUI_GENERAL_REGS_NAME_LOWER "$gregs"
38#define TUI_SPECIAL_REGS_NAME "$SREGS"
39#define TUI_SPECIAL_REGS_NAME_LOWER "$sregs"
40#define TUI_GENERAL_SPECIAL_REGS_NAME "$REGS"
41#define TUI_GENERAL_SPECIAL_REGS_NAME_LOWER "$regs"
42
43/* Scroll direction enum */
c5aa993b
JM
44typedef enum
45 {
c906108c
SS
46 FORWARD_SCROLL,
47 BACKWARD_SCROLL,
48 LEFT_SCROLL,
49 RIGHT_SCROLL
c5aa993b
JM
50 }
51TuiScrollDirection, *TuiScrollDirectionPtr;
c906108c
SS
52
53
54/* General list struct */
c5aa993b
JM
55typedef struct _TuiList
56 {
57 OpaqueList list;
58 int count;
59 }
60TuiList, *TuiListPtr;
c906108c
SS
61
62
63/* The kinds of layouts available */
c5aa993b
JM
64typedef enum
65 {
c906108c
SS
66 SRC_COMMAND,
67 DISASSEM_COMMAND,
68 SRC_DISASSEM_COMMAND,
69 SRC_DATA_COMMAND,
70 DISASSEM_DATA_COMMAND,
71 UNDEFINED_LAYOUT
c5aa993b
JM
72 }
73TuiLayoutType, *TuiLayoutTypePtr;
c906108c
SS
74
75/* Basic data types that can be displayed in the data window. */
c5aa993b
JM
76typedef enum _TuiDataType
77 {
c906108c
SS
78 TUI_REGISTER,
79 TUI_SCALAR,
80 TUI_COMPLEX,
81 TUI_STRUCT
c5aa993b
JM
82 }
83TuiDataType, TuiDataTypePtr;
c906108c
SS
84
85/* Types of register displays */
c5aa993b
JM
86typedef enum _TuiRegisterDisplayType
87 {
c906108c
SS
88 TUI_UNDEFINED_REGS,
89 TUI_GENERAL_REGS,
90 TUI_SFLOAT_REGS,
91 TUI_DFLOAT_REGS,
92 TUI_SPECIAL_REGS,
93 TUI_GENERAL_AND_SPECIAL_REGS
c5aa993b
JM
94 }
95TuiRegisterDisplayType, *TuiRegisterDisplayTypePtr;
c906108c
SS
96
97/* Structure describing source line or line address */
c5aa993b
JM
98typedef union _TuiLineOrAddress
99 {
100 int lineNo;
101 Opaque addr;
102 }
103TuiLineOrAddress, *TuiLineOrAddressPtr;
c906108c
SS
104
105/* Current Layout definition */
c5aa993b
JM
106typedef struct _TuiLayoutDef
107 {
108 TuiWinType displayMode;
109 int split;
110 TuiRegisterDisplayType regsDisplayType;
111 TuiRegisterDisplayType floatRegsDisplayType;
112 }
113TuiLayoutDef, *TuiLayoutDefPtr;
c906108c
SS
114
115/* Elements in the Source/Disassembly Window */
116typedef struct _TuiSourceElement
c5aa993b
JM
117 {
118 char *line;
119 TuiLineOrAddress lineOrAddr;
120 int isExecPoint;
121 int hasBreak;
122 }
123TuiSourceElement, *TuiSourceElementPtr;
c906108c
SS
124
125
126/* Elements in the data display window content */
127typedef struct _TuiDataElement
c5aa993b
JM
128 {
129 char *name;
130 int itemNo; /* the register number, or data display number */
c906108c 131 TuiDataType type;
c5aa993b
JM
132 Opaque value;
133 int highlight;
134 }
135TuiDataElement, *TuiDataElementPtr;
c906108c
SS
136
137
138/* Elements in the command window content */
139typedef struct _TuiCommandElement
c5aa993b
JM
140 {
141 char *line;
142 }
143TuiCommandElement, *TuiCommandElementPtr;
c906108c
SS
144
145
146#define MAX_LOCATOR_ELEMENT_LEN 100
147
148/* Elements in the locator window content */
149typedef struct _TuiLocatorElement
c5aa993b
JM
150 {
151 char fileName[MAX_LOCATOR_ELEMENT_LEN];
152 char procName[MAX_LOCATOR_ELEMENT_LEN];
153 int lineNo;
154 Opaque addr;
155 }
156TuiLocatorElement, *TuiLocatorElementPtr;
c906108c
SS
157
158
159/* An content element in a window */
160typedef union
c5aa993b
JM
161 {
162 TuiSourceElement source; /* the source elements */
163 TuiGenWinInfo dataWindow; /* data display elements */
164 TuiDataElement data; /* elements of dataWindow */
165 TuiCommandElement command; /* command elements */
166 TuiLocatorElement locator; /* locator elements */
167 char *simpleString; /* simple char based elements */
168 }
169TuiWhichElement, *TuiWhichElementPtr;
c906108c
SS
170
171typedef struct _TuiWinElement
c5aa993b
JM
172 {
173 int highlight;
c906108c 174 TuiWhichElement whichElement;
c5aa993b
JM
175 }
176TuiWinElement, *TuiWinElementPtr;
c906108c
SS
177
178
179/* This describes the content of the window. */
c5aa993b 180typedef TuiWinElementPtr *TuiWinContent;
c906108c
SS
181
182
183/* This struct defines the specific information about a data display window */
c5aa993b
JM
184typedef struct _TuiDataInfo
185 {
186 TuiWinContent dataContent; /* start of data display content */
187 int dataContentCount;
188 TuiWinContent regsContent; /* start of regs display content */
189 int regsContentCount;
190 TuiRegisterDisplayType regsDisplayType;
191 int regsColumnCount;
192 int displayRegs; /* Should regs be displayed at all? */
193 }
194TuiDataInfo, *TuiDataInfoPtr;
195
196
197typedef struct _TuiSourceInfo
198 {
199 int hasLocator; /* Does locator belongs to this window? */
200 TuiGenWinInfoPtr executionInfo; /* execution information window */
201 int horizontalOffset; /* used for horizontal scroll */
202 TuiLineOrAddress startLineOrAddr;
203 }
204TuiSourceInfo, *TuiSourceInfoPtr;
205
206
207typedef struct _TuiCommandInfo
208 {
209 int curLine; /* The current line position */
210 int curch; /* The current cursor position */
211 }
212TuiCommandInfo, *TuiCommandInfoPtr;
c906108c
SS
213
214
215/* This defines information about each logical window */
c5aa993b
JM
216typedef struct _TuiWinInfo
217 {
218 TuiGenWinInfo generic; /* general window information */
219 union
220 {
221 TuiSourceInfo sourceInfo;
222 TuiDataInfo dataDisplayInfo;
223 TuiCommandInfo commandInfo;
224 Opaque opaque;
225 }
226 detail;
227 int canHighlight; /* Can this window ever be highlighted? */
228 int isHighlighted; /* Is this window highlighted? */
229 }
230TuiWinInfo, *TuiWinInfoPtr;
c906108c
SS
231
232/* MACROS (prefixed with m_) */
233
234/* Testing macros */
235#define m_genWinPtrIsNull(winInfo) \
236 ((winInfo) == (TuiGenWinInfoPtr)NULL)
237#define m_genWinPtrNotNull(winInfo) \
238 ((winInfo) != (TuiGenWinInfoPtr)NULL)
239#define m_winPtrIsNull(winInfo) \
240 ((winInfo) == (TuiWinInfoPtr)NULL)
241#define m_winPtrNotNull(winInfo) \
242 ((winInfo) != (TuiWinInfoPtr)NULL)
243
244#define m_winIsSourceType(type) \
245 (type == SRC_WIN || type == DISASSEM_WIN)
246#define m_winIsAuxillary(winType) \
247 (winType > MAX_MAJOR_WINDOWS)
248#define m_hasLocator(winInfo) \
249 ( ((winInfo) != (TuiWinInfoPtr)NULL) ? \
250 (winInfo->detail.sourceInfo.hasLocator) : \
251 FALSE )
252
253#define m_setWinHighlightOn(winInfo) \
254 if ((winInfo) != (TuiWinInfoPtr)NULL) \
255 (winInfo)->isHighlighted = TRUE
256#define m_setWinHighlightOff(winInfo) \
257 if ((winInfo) != (TuiWinInfoPtr)NULL) \
258 (winInfo)->isHighlighted = FALSE
259
260
261/* Global Data */
c5aa993b
JM
262extern TuiWinInfoPtr winList[MAX_MAJOR_WINDOWS];
263extern int tui_version;
c906108c
SS
264
265/* Macros */
266#define srcWin winList[SRC_WIN]
267#define disassemWin winList[DISASSEM_WIN]
268#define dataWin winList[DATA_WIN]
269#define cmdWin winList[CMD_WIN]
270
271/* Data Manipulation Functions */
c5aa993b
JM
272extern void initializeStaticData PARAMS ((void));
273extern TuiGenWinInfoPtr allocGenericWinInfo PARAMS ((void));
274extern TuiWinInfoPtr allocWinInfo PARAMS ((TuiWinType));
275extern void initGenericPart PARAMS ((TuiGenWinInfoPtr));
276extern void initWinInfo PARAMS ((TuiWinInfoPtr));
277extern TuiWinContent allocContent PARAMS ((int, TuiWinType));
278extern int addContentElements
279 PARAMS ((TuiGenWinInfoPtr, int));
280extern void initContentElement
281 PARAMS ((TuiWinElementPtr, TuiWinType));
282extern void freeWindow PARAMS ((TuiWinInfoPtr));
283extern void freeAllWindows PARAMS ((void));
284extern void freeWinContent PARAMS ((TuiGenWinInfoPtr));
285extern void freeDataContent PARAMS ((TuiWinContent, int));
286extern void freeAllSourceWinsContent PARAMS ((void));
287extern void tuiDelWindow PARAMS ((TuiWinInfoPtr));
288extern void tuiDelDataWindows PARAMS ((TuiWinContent, int));
289extern TuiWinInfoPtr winByName PARAMS ((char *));
290extern TuiWinInfoPtr partialWinByName PARAMS ((char *));
291extern char *winName PARAMS ((TuiGenWinInfoPtr));
292extern char *displayableWinContentOf
293 PARAMS ((TuiGenWinInfoPtr, TuiWinElementPtr));
294extern char *displayableWinContentAt
295 PARAMS ((TuiGenWinInfoPtr, int));
296extern int winElementHeight
297 PARAMS ((TuiGenWinInfoPtr, TuiWinElementPtr));
298extern TuiLayoutType currentLayout PARAMS ((void));
299extern void setCurrentLayoutTo PARAMS ((TuiLayoutType));
300extern int termHeight PARAMS ((void));
301extern void setTermHeight PARAMS ((int));
302extern int termWidth PARAMS ((void));
303extern void setTermWidth PARAMS ((int));
304extern int historyLimit PARAMS ((void));
305extern void setHistoryLimit PARAMS ((int));
306extern void setGenWinOrigin PARAMS ((TuiGenWinInfoPtr, int, int));
307extern TuiGenWinInfoPtr locatorWinInfoPtr PARAMS ((void));
308extern TuiGenWinInfoPtr sourceExecInfoWinPtr PARAMS ((void));
309extern TuiGenWinInfoPtr disassemExecInfoWinPtr PARAMS ((void));
310extern char *nullStr PARAMS ((void));
311extern char *blankStr PARAMS ((void));
312extern char *locationStr PARAMS ((void));
313extern char *breakStr PARAMS ((void));
314extern char *breakLocationStr PARAMS ((void));
315extern TuiListPtr sourceWindows PARAMS ((void));
316extern void clearSourceWindows PARAMS ((void));
317extern void clearSourceWindowsDetail PARAMS ((void));
318extern void clearWinDetail PARAMS ((TuiWinInfoPtr winInfo));
319extern void tuiAddToSourceWindows PARAMS ((TuiWinInfoPtr));
320extern int tuiDefaultTabLen PARAMS ((void));
321extern void tuiSetDefaultTabLen PARAMS ((int));
322extern TuiWinInfoPtr tuiWinWithFocus PARAMS ((void));
323extern void tuiSetWinWithFocus PARAMS ((TuiWinInfoPtr));
324extern TuiLayoutDefPtr tuiLayoutDef PARAMS ((void));
325extern int tuiWinResized PARAMS ((void));
326extern void tuiSetWinResizedTo PARAMS ((int));
327
328extern TuiWinInfoPtr tuiNextWin PARAMS ((TuiWinInfoPtr));
329extern TuiWinInfoPtr tuiPrevWin PARAMS ((TuiWinInfoPtr));
c906108c
SS
330
331
332#endif /* TUI_DATA_H */