1 /* TUI data manipulation routines.
3 Copyright (C) 1998-2013 Free Software Foundation, Inc.
5 Contributed by Hewlett-Packard Company.
7 This file is part of GDB.
9 This program is free software; you can redistribute it and/or modify
10 it under the terms of the GNU General Public License as published by
11 the Free Software Foundation; either version 3 of the License, or
12 (at your option) any later version.
14 This program is distributed in the hope that it will be useful,
15 but WITHOUT ANY WARRANTY; without even the implied warranty of
16 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 GNU General Public License for more details.
19 You should have received a copy of the GNU General Public License
20 along with this program. If not, see <http://www.gnu.org/licenses/>. */
25 #include "tui/tui.h" /* For enum tui_win_type. */
26 #include "gdb_curses.h" /* For WINDOW. */
28 /* This is a point definition. */
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
84 #define MIN_LINE_WIDTH 4 /* Use at least 4 digits for line
86 #define MIN_PROC_WIDTH 12
87 #define MAX_TARGET_WIDTH 10
88 #define MAX_PID_WIDTH 14
90 #define TUI_FLOAT_REGS_NAME "$FREGS"
91 #define TUI_FLOAT_REGS_NAME_LOWER "$fregs"
92 #define TUI_GENERAL_REGS_NAME "$GREGS"
93 #define TUI_GENERAL_REGS_NAME_LOWER "$gregs"
94 #define TUI_SPECIAL_REGS_NAME "$SREGS"
95 #define TUI_SPECIAL_REGS_NAME_LOWER "$sregs"
96 #define TUI_GENERAL_SPECIAL_REGS_NAME "$REGS"
97 #define TUI_GENERAL_SPECIAL_REGS_NAME_LOWER "$regs"
99 /* Scroll direction enum. */
100 enum tui_scroll_direction
109 /* General list struct. */
112 struct tui_win_info **list;
117 /* The kinds of layouts available. */
122 SRC_DISASSEM_COMMAND,
124 DISASSEM_DATA_COMMAND,
128 /* Basic data types that can be displayed in the data window. */
137 /* Types of register displays. */
138 enum tui_register_display_type
145 TUI_GENERAL_AND_SPECIAL_REGS
148 /* Structure describing source line or line address. */
149 struct tui_line_or_address
151 enum { LOA_LINE, LOA_ADDRESS } loa;
159 /* Current Layout definition. */
160 struct tui_layout_def
162 enum tui_win_type display_mode;
164 enum tui_register_display_type regs_display_type;
165 enum tui_register_display_type float_regs_display_type;
168 /* Elements in the Source/Disassembly Window. */
169 struct tui_source_element
172 struct tui_line_or_address line_or_addr;
178 /* Elements in the data display window content. */
179 struct tui_data_element
182 int item_no; /* The register number, or data display
184 enum tui_data_type type;
191 /* Elements in the command window content. */
192 struct tui_command_element
198 # define MAX_LOCATOR_ELEMENT_LEN PATH_MAX
200 # define MAX_LOCATOR_ELEMENT_LEN 1024
203 /* Elements in the locator window content. */
204 struct tui_locator_element
206 char file_name[MAX_LOCATOR_ELEMENT_LEN];
207 char proc_name[MAX_LOCATOR_ELEMENT_LEN];
210 /* Architecture associated with code at this location. */
211 struct gdbarch *gdbarch;
214 /* Flags to tell what kind of breakpoint is at current line. */
215 #define TUI_BP_ENABLED 0x01
216 #define TUI_BP_DISABLED 0x02
217 #define TUI_BP_HIT 0x04
218 #define TUI_BP_CONDITIONAL 0x08
219 #define TUI_BP_HARDWARE 0x10
221 /* Position of breakpoint markers in the exec info string. */
222 #define TUI_BP_HIT_POS 0
223 #define TUI_BP_BREAK_POS 1
224 #define TUI_EXEC_POS 2
225 #define TUI_EXECINFO_SIZE 4
227 typedef char tui_exec_info_content[TUI_EXECINFO_SIZE];
229 /* An content element in a window. */
230 union tui_which_element
232 struct tui_source_element source; /* The source elements. */
233 struct tui_gen_win_info data_window; /* Data display elements. */
234 struct tui_data_element data; /* Elements of data_window. */
235 struct tui_command_element command; /* Command elements. */
236 struct tui_locator_element locator; /* Locator elements. */
237 tui_exec_info_content simple_string; /* Simple char based elements. */
240 struct tui_win_element
243 union tui_which_element which_element;
247 /* This describes the content of the window. */
248 typedef struct tui_win_element **tui_win_content;
251 /* This struct defines the specific information about a data display
255 tui_win_content data_content; /* Start of data display content. */
256 int data_content_count;
257 tui_win_content regs_content; /* Start of regs display content. */
258 int regs_content_count;
259 enum tui_register_display_type regs_display_type;
260 int regs_column_count;
261 int display_regs; /* Should regs be displayed at all? */
262 struct reggroup *current_group;
266 struct tui_source_info
268 int has_locator; /* Does locator belongs to this window? */
269 /* Execution information window. */
270 struct tui_gen_win_info *execution_info;
271 int horizontal_offset; /* Used for horizontal scroll. */
272 struct tui_line_or_address start_line_or_addr;
274 /* Architecture associated with code at this location. */
275 struct gdbarch *gdbarch;
279 struct tui_command_info
281 int cur_line; /* The current line position. */
282 int curch; /* The current cursor position. */
287 /* This defines information about each logical window. */
290 struct tui_gen_win_info generic; /* General window information. */
293 struct tui_source_info source_info;
294 struct tui_data_info data_display_info;
295 struct tui_command_info command_info;
299 int can_highlight; /* Can this window ever be highlighted? */
300 int is_highlighted; /* Is this window highlighted? */
303 extern int tui_win_is_source_type (enum tui_win_type win_type);
304 extern int tui_win_is_auxillary (enum tui_win_type win_type);
305 extern int tui_win_has_locator (struct tui_win_info *win_info);
306 extern void tui_set_win_highlight (struct tui_win_info *win_info,
311 extern struct tui_win_info *(tui_win_list[MAX_MAJOR_WINDOWS]);
313 #define TUI_SRC_WIN tui_win_list[SRC_WIN]
314 #define TUI_DISASM_WIN tui_win_list[DISASSEM_WIN]
315 #define TUI_DATA_WIN tui_win_list[DATA_WIN]
316 #define TUI_CMD_WIN tui_win_list[CMD_WIN]
318 /* Data Manipulation Functions. */
319 extern void tui_initialize_static_data (void);
320 extern struct tui_gen_win_info *tui_alloc_generic_win_info (void);
321 extern struct tui_win_info *tui_alloc_win_info (enum tui_win_type);
322 extern void tui_init_generic_part (struct tui_gen_win_info *);
323 extern void tui_init_win_info (struct tui_win_info *);
324 extern tui_win_content tui_alloc_content (int, enum tui_win_type);
325 extern int tui_add_content_elements (struct tui_gen_win_info *,
327 extern void tui_init_content_element (struct tui_win_element *,
329 extern void tui_free_window (struct tui_win_info *);
330 extern void tui_free_win_content (struct tui_gen_win_info *);
331 extern void tui_free_data_content (tui_win_content, int);
332 extern void tui_free_all_source_wins_content (void);
333 extern void tui_del_window (struct tui_win_info *);
334 extern void tui_del_data_windows (tui_win_content, int);
335 extern struct tui_win_info *tui_partial_win_by_name (char *);
336 extern char *tui_win_name (struct tui_gen_win_info *);
337 extern enum tui_layout_type tui_current_layout (void);
338 extern void tui_set_current_layout_to (enum tui_layout_type);
339 extern int tui_term_height (void);
340 extern void tui_set_term_height_to (int);
341 extern int tui_term_width (void);
342 extern void tui_set_term_width_to (int);
343 extern struct tui_gen_win_info *tui_locator_win_info_ptr (void);
344 extern struct tui_gen_win_info *tui_source_exec_info_win_ptr (void);
345 extern struct tui_gen_win_info *tui_disassem_exec_info_win_ptr (void);
346 extern struct tui_list *tui_source_windows (void);
347 extern void tui_clear_source_windows (void);
348 extern void tui_clear_source_windows_detail (void);
349 extern void tui_clear_win_detail (struct tui_win_info *);
350 extern void tui_add_to_source_windows (struct tui_win_info *);
351 extern int tui_default_tab_len (void);
352 extern void tui_set_default_tab_len (int);
353 extern struct tui_win_info *tui_win_with_focus (void);
354 extern void tui_set_win_with_focus (struct tui_win_info *);
355 extern struct tui_layout_def *tui_layout_def (void);
356 extern int tui_win_resized (void);
357 extern void tui_set_win_resized_to (int);
359 extern struct tui_win_info *tui_next_win (struct tui_win_info *);
360 extern struct tui_win_info *tui_prev_win (struct tui_win_info *);
362 extern void tui_add_to_source_windows (struct tui_win_info *);
364 #endif /* TUI_DATA_H */