1 /* TUI data manipulation routines.
3 Copyright 1998, 1999, 2000, 2001, 2002, 2004 Free Software
6 Contributed by Hewlett-Packard Company.
8 This file is part of GDB.
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.
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.
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. */
28 #if defined (HAVE_NCURSES_H)
30 #elif defined (HAVE_CURSES_H)
34 /* Generic window information */
35 struct tui_gen_win_info
37 WINDOW *handle; /* window handle */
38 enum tui_win_type type; /* type of window */
39 int width; /* window width */
40 int height; /* window height */
41 struct tui_point origin; /* origin of window */
42 void **content; /* content of window */
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. */
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
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
76 /* Strings to display in the TUI status line. */
77 #define PROC_PREFIX "In: "
78 #define LINE_PREFIX "Line: "
79 #define PC_PREFIX "PC: "
80 #define SINGLE_KEY "(SingleKey)"
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
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"
97 /* Scroll direction enum. */
98 enum tui_scroll_direction
107 /* General list struct. */
115 /* The kinds of layouts available */
120 SRC_DISASSEM_COMMAND,
122 DISASSEM_DATA_COMMAND,
126 /* Basic data types that can be displayed in the data window. */
135 /* Types of register displays */
136 enum tui_register_display_type
143 TUI_GENERAL_AND_SPECIAL_REGS
146 /* Structure describing source line or line address */
147 union tui_line_or_address
153 /* Current Layout definition */
154 struct tui_layout_def
156 enum tui_win_type display_mode;
158 enum tui_register_display_type regs_display_type;
159 enum tui_register_display_type float_regs_display_type;
162 /* Elements in the Source/Disassembly Window */
163 struct tui_source_element
166 union tui_line_or_address line_or_addr;
172 /* Elements in the data display window content */
173 struct tui_data_element
176 int item_no; /* the register number, or data display number */
177 enum tui_data_type type;
183 /* Elements in the command window content */
184 struct tui_command_element
190 #define MAX_LOCATOR_ELEMENT_LEN 100
192 /* Elements in the locator window content */
193 struct tui_locator_element
195 char file_name[MAX_LOCATOR_ELEMENT_LEN];
196 char proc_name[MAX_LOCATOR_ELEMENT_LEN];
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
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
214 typedef char tui_exec_info_content[TUI_EXECINFO_SIZE];
216 /* An content element in a window */
217 union tui_which_element
219 struct tui_source_element source; /* the source elements */
220 struct tui_gen_win_info data_window; /* data display elements */
221 struct tui_data_element data; /* elements of data_window */
222 struct tui_command_element command; /* command elements */
223 struct tui_locator_element locator; /* locator elements */
224 tui_exec_info_content simple_string; /* simple char based elements */
227 struct tui_win_element
230 union tui_which_element which_element;
234 /* This describes the content of the window. */
235 typedef struct tui_win_element **tui_win_content;
238 /* This struct defines the specific information about a data display window */
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? */
251 struct tui_source_info
253 int has_locator; /* Does locator belongs to this window? */
254 /* Execution information window. */
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;
262 struct tui_command_info
264 int cur_line; /* The current line position */
265 int curch; /* The current cursor position */
270 /* This defines information about each logical window */
273 struct tui_gen_win_info generic; /* general window information */
276 struct tui_source_info source_info;
277 struct tui_data_info data_display_info;
278 struct tui_command_info command_info;
282 int can_highlight; /* Can this window ever be highlighted? */
283 int is_highlighted; /* Is this window highlighted? */
286 extern int tui_win_is_source_type (enum tui_win_type win_type);
287 extern int tui_win_is_auxillary (enum tui_win_type win_type);
288 extern int tui_win_has_locator (struct tui_win_info *win_info);
289 extern void tui_set_win_highlight (struct tui_win_info *win_info,
294 extern struct tui_win_info *(tui_win_list[MAX_MAJOR_WINDOWS]);
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]
301 /* Data Manipulation Functions */
302 extern void tui_initialize_static_data (void);
303 extern struct tui_gen_win_info *tui_alloc_generic_win_info (void);
304 extern struct tui_win_info *tui_alloc_win_info (enum tui_win_type);
305 extern void tui_init_generic_part (struct tui_gen_win_info *);
306 extern void tui_init_win_info (struct tui_win_info *);
307 extern tui_win_content tui_alloc_content (int, enum tui_win_type);
308 extern int tui_add_content_elements (struct tui_gen_win_info *, int);
309 extern void tui_init_content_element (struct tui_win_element *, enum tui_win_type);
310 extern void tui_free_window (struct tui_win_info *);
311 extern void tui_free_win_content (struct tui_gen_win_info *);
312 extern void tui_free_data_content (tui_win_content, int);
313 extern void tui_free_all_source_wins_content (void);
314 extern void tui_del_window (struct tui_win_info *);
315 extern void tui_del_data_windows (tui_win_content, int);
316 extern struct tui_win_info *tui_partial_win_by_name (char *);
317 extern char *tui_win_name (struct tui_gen_win_info *);
318 extern enum tui_layout_type tui_current_layout (void);
319 extern void tui_set_current_layout_to (enum tui_layout_type);
320 extern int tui_term_height (void);
321 extern void tui_set_term_height_to (int);
322 extern int tui_term_width (void);
323 extern void tui_set_term_width_to (int);
324 extern void tui_set_gen_win_origin (struct tui_gen_win_info *, int, int);
325 extern struct tui_gen_win_info *tui_locator_win_info_ptr (void);
326 extern struct tui_gen_win_info *tui_source_exec_info_win_ptr (void);
327 extern struct tui_gen_win_info *tui_disassem_exec_info_win_ptr (void);
328 extern struct tui_list * tui_source_windows (void);
329 extern void tui_clear_source_windows (void);
330 extern void tui_clear_source_windows_detail (void);
331 extern void tui_clear_win_detail (struct tui_win_info * win_info);
332 extern void tui_add_to_source_windows (struct tui_win_info *);
333 extern int tui_default_tab_len (void);
334 extern void tui_set_default_tab_len (int);
335 extern struct tui_win_info *tui_win_with_focus (void);
336 extern void tui_set_win_with_focus (struct tui_win_info *);
337 extern struct tui_layout_def * tui_layout_def (void);
338 extern int tui_win_resized (void);
339 extern void tui_set_win_resized_to (int);
341 extern struct tui_win_info *tui_next_win (struct tui_win_info *);
342 extern struct tui_win_info *tui_prev_win (struct tui_win_info *);
344 extern void tui_add_to_source_windows (struct tui_win_info * win_info);
346 #endif /* TUI_DATA_H */