Honour PRIVATE keyword
[deliverable/binutils-gdb.git] / gdb / tui / tui-data.h
CommitLineData
f377b406 1/* TUI data manipulation routines.
55fb0713
AC
2
3 Copyright 1998, 1999, 2000, 2001, 2002, 2004 Free Software
4 Foundation, Inc.
5
f377b406
SC
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
c906108c
SS
25#ifndef TUI_DATA_H
26#define TUI_DATA_H
27
6a83354a
AC
28#include "tui/tui.h" /* For enum tui_win_type. */
29#include "gdb_curses.h" /* For WINDOW. */
30
31/* This is a point definition. */
32struct tui_point
33{
34 int x, y;
35};
2a5127c4
SC
36
37/* Generic window information */
2a8854a7
AC
38struct tui_gen_win_info
39{
40 WINDOW *handle; /* window handle */
22940a24 41 enum tui_win_type type; /* type of window */
2a8854a7
AC
42 int width; /* window width */
43 int height; /* window height */
22940a24
AC
44 struct tui_point origin; /* origin of window */
45 void **content; /* content of window */
6d012f14
AC
46 int content_size; /* Size of content (# of elements) */
47 int content_in_use; /* Can it be used, or is it already used? */
48 int viewport_height; /* viewport height */
49 int last_visible_line; /* index of last visible line */
50 int is_visible; /* whether the window is visible or not */
51 char *title; /* Window title to display. */
2a8854a7 52};
2a5127c4 53
c906108c
SS
54/* Constant definitions */
55#define DEFAULT_TAB_LEN 8
56#define NO_SRC_STRING "[ No Source Available ]"
57#define NO_DISASSEM_STRING "[ No Assembly Available ]"
58#define NO_REGS_STRING "[ Register Values Unavailable ]"
59#define NO_DATA_STRING "[ No Data Values Displayed ]"
60#define MAX_CONTENT_COUNT 100
61#define SRC_NAME "SRC"
62#define CMD_NAME "CMD"
63#define DATA_NAME "REGS"
64#define DISASSEM_NAME "ASM"
65#define TUI_NULL_STR ""
66#define DEFAULT_HISTORY_COUNT 25
67#define BOX_WINDOW TRUE
68#define DONT_BOX_WINDOW FALSE
69#define HILITE TRUE
70#define NO_HILITE FALSE
71#define WITH_LOCATOR TRUE
72#define NO_LOCATOR FALSE
73#define EMPTY_SOURCE_PROMPT TRUE
74#define NO_EMPTY_SOURCE_PROMPT FALSE
75#define UNDEFINED_ITEM -1
76#define MIN_WIN_HEIGHT 3
77#define MIN_CMD_WIN_HEIGHT 3
78
50265402 79/* Strings to display in the TUI status line. */
50265402 80#define PROC_PREFIX "In: "
c906108c 81#define LINE_PREFIX "Line: "
50265402
SC
82#define PC_PREFIX "PC: "
83#define SINGLE_KEY "(SingleKey)"
84
85/* Minimum/Maximum length of some fields displayed in the TUI status line. */
86#define MIN_LINE_WIDTH 4 /* Use at least 4 digits for line numbers. */
87#define MIN_PROC_WIDTH 12
88#define MAX_TARGET_WIDTH 10
89#define MAX_PID_WIDTH 14
c906108c
SS
90
91#define TUI_FLOAT_REGS_NAME "$FREGS"
92#define TUI_FLOAT_REGS_NAME_LOWER "$fregs"
93#define TUI_GENERAL_REGS_NAME "$GREGS"
94#define TUI_GENERAL_REGS_NAME_LOWER "$gregs"
95#define TUI_SPECIAL_REGS_NAME "$SREGS"
96#define TUI_SPECIAL_REGS_NAME_LOWER "$sregs"
97#define TUI_GENERAL_SPECIAL_REGS_NAME "$REGS"
98#define TUI_GENERAL_SPECIAL_REGS_NAME_LOWER "$regs"
99
2a8854a7
AC
100/* Scroll direction enum. */
101enum tui_scroll_direction
102{
103 FORWARD_SCROLL,
104 BACKWARD_SCROLL,
105 LEFT_SCROLL,
106 RIGHT_SCROLL
107};
c906108c
SS
108
109
2a8854a7
AC
110/* General list struct. */
111struct tui_list
112{
22940a24 113 void **list;
2a8854a7
AC
114 int count;
115};
c906108c
SS
116
117
118/* The kinds of layouts available */
2a8854a7
AC
119enum tui_layout_type
120{
121 SRC_COMMAND,
122 DISASSEM_COMMAND,
123 SRC_DISASSEM_COMMAND,
124 SRC_DATA_COMMAND,
125 DISASSEM_DATA_COMMAND,
126 UNDEFINED_LAYOUT
127};
c906108c
SS
128
129/* Basic data types that can be displayed in the data window. */
2a8854a7
AC
130enum tui_data_type
131{
132 TUI_REGISTER,
133 TUI_SCALAR,
134 TUI_COMPLEX,
135 TUI_STRUCT
136};
c906108c
SS
137
138/* Types of register displays */
2a8854a7
AC
139enum tui_register_display_type
140{
141 TUI_UNDEFINED_REGS,
142 TUI_GENERAL_REGS,
143 TUI_SFLOAT_REGS,
144 TUI_DFLOAT_REGS,
145 TUI_SPECIAL_REGS,
146 TUI_GENERAL_AND_SPECIAL_REGS
147};
c906108c
SS
148
149/* Structure describing source line or line address */
2a8854a7
AC
150union tui_line_or_address
151{
6d012f14 152 int line_no;
2a8854a7
AC
153 CORE_ADDR addr;
154};
c906108c
SS
155
156/* Current Layout definition */
2a8854a7
AC
157struct tui_layout_def
158{
6d012f14 159 enum tui_win_type display_mode;
2a8854a7 160 int split;
6d012f14
AC
161 enum tui_register_display_type regs_display_type;
162 enum tui_register_display_type float_regs_display_type;
2a8854a7 163};
c906108c
SS
164
165/* Elements in the Source/Disassembly Window */
2a8854a7
AC
166struct tui_source_element
167{
168 char *line;
6d012f14
AC
169 union tui_line_or_address line_or_addr;
170 int is_exec_point;
171 int has_break;
2a8854a7 172};
c906108c
SS
173
174
175/* Elements in the data display window content */
2a8854a7
AC
176struct tui_data_element
177{
178 const char *name;
6d012f14 179 int item_no; /* the register number, or data display number */
2a8854a7 180 enum tui_data_type type;
22940a24 181 void *value;
2a8854a7
AC
182 int highlight;
183};
c906108c
SS
184
185
186/* Elements in the command window content */
2a8854a7
AC
187struct tui_command_element
188{
189 char *line;
190};
c906108c
SS
191
192
193#define MAX_LOCATOR_ELEMENT_LEN 100
194
195/* Elements in the locator window content */
2a8854a7
AC
196struct tui_locator_element
197{
6d012f14
AC
198 char file_name[MAX_LOCATOR_ELEMENT_LEN];
199 char proc_name[MAX_LOCATOR_ELEMENT_LEN];
200 int line_no;
2a8854a7
AC
201 CORE_ADDR addr;
202};
c906108c 203
00b2bad4
SC
204/* Flags to tell what kind of breakpoint is at current line. */
205#define TUI_BP_ENABLED 0x01
206#define TUI_BP_DISABLED 0x02
207#define TUI_BP_HIT 0x04
208#define TUI_BP_CONDITIONAL 0x08
209#define TUI_BP_HARDWARE 0x10
210
211/* Position of breakpoint markers in the exec info string. */
212#define TUI_BP_HIT_POS 0
213#define TUI_BP_BREAK_POS 1
214#define TUI_EXEC_POS 2
215#define TUI_EXECINFO_SIZE 4
216
2a8854a7 217typedef char tui_exec_info_content[TUI_EXECINFO_SIZE];
c906108c
SS
218
219/* An content element in a window */
2a8854a7
AC
220union tui_which_element
221{
222 struct tui_source_element source; /* the source elements */
6d012f14
AC
223 struct tui_gen_win_info data_window; /* data display elements */
224 struct tui_data_element data; /* elements of data_window */
2a8854a7
AC
225 struct tui_command_element command; /* command elements */
226 struct tui_locator_element locator; /* locator elements */
6d012f14 227 tui_exec_info_content simple_string; /* simple char based elements */
2a8854a7
AC
228};
229
230struct tui_win_element
231{
232 int highlight;
6d012f14 233 union tui_which_element which_element;
2a8854a7 234};
c906108c
SS
235
236
237/* This describes the content of the window. */
2a8854a7 238typedef struct tui_win_element **tui_win_content;
c906108c
SS
239
240
241/* This struct defines the specific information about a data display window */
2a8854a7
AC
242struct tui_data_info
243{
6d012f14
AC
244 tui_win_content data_content; /* start of data display content */
245 int data_content_count;
246 tui_win_content regs_content; /* start of regs display content */
247 int regs_content_count;
248 enum tui_register_display_type regs_display_type;
249 int regs_column_count;
250 int display_regs; /* Should regs be displayed at all? */
2a8854a7
AC
251};
252
253
254struct tui_source_info
255{
6d012f14 256 int has_locator; /* Does locator belongs to this window? */
2a8854a7 257 /* Execution information window. */
6d012f14
AC
258 struct tui_gen_win_info *execution_info;
259 int horizontal_offset; /* used for horizontal scroll */
260 union tui_line_or_address start_line_or_addr;
2a8854a7
AC
261 char* filename;
262};
263
264
265struct tui_command_info
266{
6d012f14 267 int cur_line; /* The current line position */
2a8854a7
AC
268 int curch; /* The current cursor position */
269 int start_line;
270};
c906108c
SS
271
272
273/* This defines information about each logical window */
2a8854a7
AC
274struct tui_win_info
275{
276 struct tui_gen_win_info generic; /* general window information */
277 union
c5aa993b 278 {
6d012f14
AC
279 struct tui_source_info source_info;
280 struct tui_data_info data_display_info;
281 struct tui_command_info command_info;
22940a24 282 void *opaque;
c5aa993b 283 }
2a8854a7 284 detail;
6d012f14
AC
285 int can_highlight; /* Can this window ever be highlighted? */
286 int is_highlighted; /* Is this window highlighted? */
2a8854a7 287};
c906108c 288
6d012f14
AC
289extern int tui_win_is_source_type (enum tui_win_type win_type);
290extern int tui_win_is_auxillary (enum tui_win_type win_type);
291extern int tui_win_has_locator (struct tui_win_info *win_info);
292extern void tui_set_win_highlight (struct tui_win_info *win_info,
293 int highlight);
c906108c
SS
294
295
296/* Global Data */
6d012f14 297extern struct tui_win_info *(tui_win_list[MAX_MAJOR_WINDOWS]);
c906108c 298
6d012f14
AC
299#define TUI_SRC_WIN tui_win_list[SRC_WIN]
300#define TUI_DISASM_WIN tui_win_list[DISASSEM_WIN]
301#define TUI_DATA_WIN tui_win_list[DATA_WIN]
302#define TUI_CMD_WIN tui_win_list[CMD_WIN]
c906108c
SS
303
304/* Data Manipulation Functions */
dd1abb8c
AC
305extern void tui_initialize_static_data (void);
306extern struct tui_gen_win_info *tui_alloc_generic_win_info (void);
22940a24 307extern struct tui_win_info *tui_alloc_win_info (enum tui_win_type);
dd1abb8c
AC
308extern void tui_init_generic_part (struct tui_gen_win_info *);
309extern void tui_init_win_info (struct tui_win_info *);
2a8854a7 310extern tui_win_content tui_alloc_content (int, enum tui_win_type);
dd1abb8c
AC
311extern int tui_add_content_elements (struct tui_gen_win_info *, int);
312extern void tui_init_content_element (struct tui_win_element *, enum tui_win_type);
313extern void tui_free_window (struct tui_win_info *);
314extern void tui_free_win_content (struct tui_gen_win_info *);
2a8854a7 315extern void tui_free_data_content (tui_win_content, int);
dd1abb8c
AC
316extern void tui_free_all_source_wins_content (void);
317extern void tui_del_window (struct tui_win_info *);
2a8854a7 318extern void tui_del_data_windows (tui_win_content, int);
dd1abb8c
AC
319extern struct tui_win_info *tui_partial_win_by_name (char *);
320extern char *tui_win_name (struct tui_gen_win_info *);
2a8854a7
AC
321extern enum tui_layout_type tui_current_layout (void);
322extern void tui_set_current_layout_to (enum tui_layout_type);
dd1abb8c
AC
323extern int tui_term_height (void);
324extern void tui_set_term_height_to (int);
325extern int tui_term_width (void);
326extern void tui_set_term_width_to (int);
327extern void tui_set_gen_win_origin (struct tui_gen_win_info *, int, int);
328extern struct tui_gen_win_info *tui_locator_win_info_ptr (void);
329extern struct tui_gen_win_info *tui_source_exec_info_win_ptr (void);
330extern struct tui_gen_win_info *tui_disassem_exec_info_win_ptr (void);
2a8854a7 331extern struct tui_list * tui_source_windows (void);
dd1abb8c
AC
332extern void tui_clear_source_windows (void);
333extern void tui_clear_source_windows_detail (void);
6d012f14 334extern void tui_clear_win_detail (struct tui_win_info * win_info);
dd1abb8c
AC
335extern void tui_add_to_source_windows (struct tui_win_info *);
336extern int tui_default_tab_len (void);
337extern void tui_set_default_tab_len (int);
338extern struct tui_win_info *tui_win_with_focus (void);
339extern void tui_set_win_with_focus (struct tui_win_info *);
2a8854a7 340extern struct tui_layout_def * tui_layout_def (void);
dd1abb8c
AC
341extern int tui_win_resized (void);
342extern void tui_set_win_resized_to (int);
343
344extern struct tui_win_info *tui_next_win (struct tui_win_info *);
345extern struct tui_win_info *tui_prev_win (struct tui_win_info *);
346
6d012f14 347extern void tui_add_to_source_windows (struct tui_win_info * win_info);
c7c228ed 348
c906108c 349#endif /* TUI_DATA_H */
This page took 0.448091 seconds and 4 git commands to generate.