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