2007-08-14 Michael Snyder <msnyder@access-company.com>
[deliverable/binutils-gdb.git] / gdb / tui / tui-data.h
CommitLineData
f377b406 1/* TUI data manipulation routines.
55fb0713 2
6aba47ca 3 Copyright (C) 1998, 1999, 2000, 2001, 2002, 2004, 2006, 2007
48426bc2 4 Free Software Foundation, Inc.
55fb0713 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
88d83552
EZ
22 Foundation, Inc., 51 Franklin Street, Fifth Floor,
23 Boston, MA 02110-1301, USA. */
f377b406 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 36
1cc6d956 37/* Generic window information. */
2a8854a7
AC
38struct tui_gen_win_info
39{
1cc6d956
MS
40 WINDOW *handle; /* Window handle. */
41 enum tui_win_type type; /* Type of window. */
42 int width; /* Window width. */
43 int height; /* Window height. */
44 struct tui_point origin; /* Origin of window. */
45 void **content; /* Content of window. */
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
1cc6d956 54/* Constant definitions. */
c906108c
SS
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
1cc6d956
MS
85/* Minimum/Maximum length of some fields displayed in the TUI status
86 line. */
87#define MIN_LINE_WIDTH 4 /* Use at least 4 digits for line
88 numbers. */
50265402
SC
89#define MIN_PROC_WIDTH 12
90#define MAX_TARGET_WIDTH 10
91#define MAX_PID_WIDTH 14
c906108c
SS
92
93#define TUI_FLOAT_REGS_NAME "$FREGS"
94#define TUI_FLOAT_REGS_NAME_LOWER "$fregs"
95#define TUI_GENERAL_REGS_NAME "$GREGS"
96#define TUI_GENERAL_REGS_NAME_LOWER "$gregs"
97#define TUI_SPECIAL_REGS_NAME "$SREGS"
98#define TUI_SPECIAL_REGS_NAME_LOWER "$sregs"
99#define TUI_GENERAL_SPECIAL_REGS_NAME "$REGS"
100#define TUI_GENERAL_SPECIAL_REGS_NAME_LOWER "$regs"
101
2a8854a7
AC
102/* Scroll direction enum. */
103enum tui_scroll_direction
104{
105 FORWARD_SCROLL,
106 BACKWARD_SCROLL,
107 LEFT_SCROLL,
108 RIGHT_SCROLL
109};
c906108c
SS
110
111
2a8854a7
AC
112/* General list struct. */
113struct tui_list
114{
96c1eda2 115 struct tui_win_info **list;
2a8854a7
AC
116 int count;
117};
c906108c
SS
118
119
1cc6d956 120/* The kinds of layouts available. */
2a8854a7
AC
121enum tui_layout_type
122{
123 SRC_COMMAND,
124 DISASSEM_COMMAND,
125 SRC_DISASSEM_COMMAND,
126 SRC_DATA_COMMAND,
127 DISASSEM_DATA_COMMAND,
128 UNDEFINED_LAYOUT
129};
c906108c 130
1cc6d956 131/* Basic data types that can be displayed in the data window. */
2a8854a7
AC
132enum tui_data_type
133{
134 TUI_REGISTER,
135 TUI_SCALAR,
136 TUI_COMPLEX,
137 TUI_STRUCT
138};
c906108c 139
1cc6d956 140/* Types of register displays. */
2a8854a7
AC
141enum tui_register_display_type
142{
143 TUI_UNDEFINED_REGS,
144 TUI_GENERAL_REGS,
145 TUI_SFLOAT_REGS,
146 TUI_DFLOAT_REGS,
147 TUI_SPECIAL_REGS,
148 TUI_GENERAL_AND_SPECIAL_REGS
149};
c906108c 150
1cc6d956 151/* Structure describing source line or line address. */
362c05fe 152struct tui_line_or_address
2a8854a7 153{
362c05fe
AS
154 enum { LOA_LINE, LOA_ADDRESS } loa;
155 union
156 {
157 int line_no;
158 CORE_ADDR addr;
159 } u;
2a8854a7 160};
c906108c 161
1cc6d956 162/* Current Layout definition. */
2a8854a7
AC
163struct tui_layout_def
164{
6d012f14 165 enum tui_win_type display_mode;
2a8854a7 166 int split;
6d012f14
AC
167 enum tui_register_display_type regs_display_type;
168 enum tui_register_display_type float_regs_display_type;
2a8854a7 169};
c906108c 170
1cc6d956 171/* Elements in the Source/Disassembly Window. */
2a8854a7
AC
172struct tui_source_element
173{
174 char *line;
362c05fe 175 struct tui_line_or_address line_or_addr;
6d012f14
AC
176 int is_exec_point;
177 int has_break;
2a8854a7 178};
c906108c
SS
179
180
1cc6d956 181/* Elements in the data display window content. */
2a8854a7
AC
182struct tui_data_element
183{
184 const char *name;
1cc6d956 185 int item_no; /* The register number, or data display number. */
2a8854a7 186 enum tui_data_type type;
22940a24 187 void *value;
2a8854a7 188 int highlight;
10f59415 189 char *content;
2a8854a7 190};
c906108c
SS
191
192
1cc6d956 193/* Elements in the command window content. */
2a8854a7
AC
194struct tui_command_element
195{
196 char *line;
197};
c906108c
SS
198
199
200#define MAX_LOCATOR_ELEMENT_LEN 100
201
1cc6d956 202/* Elements in the locator window content. */
2a8854a7
AC
203struct tui_locator_element
204{
6d012f14
AC
205 char file_name[MAX_LOCATOR_ELEMENT_LEN];
206 char proc_name[MAX_LOCATOR_ELEMENT_LEN];
207 int line_no;
2a8854a7
AC
208 CORE_ADDR addr;
209};
c906108c 210
00b2bad4
SC
211/* Flags to tell what kind of breakpoint is at current line. */
212#define TUI_BP_ENABLED 0x01
213#define TUI_BP_DISABLED 0x02
214#define TUI_BP_HIT 0x04
215#define TUI_BP_CONDITIONAL 0x08
216#define TUI_BP_HARDWARE 0x10
217
218/* Position of breakpoint markers in the exec info string. */
219#define TUI_BP_HIT_POS 0
220#define TUI_BP_BREAK_POS 1
221#define TUI_EXEC_POS 2
222#define TUI_EXECINFO_SIZE 4
223
2a8854a7 224typedef char tui_exec_info_content[TUI_EXECINFO_SIZE];
c906108c 225
1cc6d956 226/* An content element in a window. */
2a8854a7
AC
227union tui_which_element
228{
1cc6d956
MS
229 struct tui_source_element source; /* The source elements. */
230 struct tui_gen_win_info data_window; /* Data display elements. */
231 struct tui_data_element data; /* Elements of data_window. */
232 struct tui_command_element command; /* Command elements. */
233 struct tui_locator_element locator; /* Locator elements. */
234 tui_exec_info_content simple_string; /* Simple char based elements. */
2a8854a7
AC
235};
236
237struct tui_win_element
238{
239 int highlight;
6d012f14 240 union tui_which_element which_element;
2a8854a7 241};
c906108c
SS
242
243
1cc6d956 244/* This describes the content of the window. */
2a8854a7 245typedef struct tui_win_element **tui_win_content;
c906108c
SS
246
247
1cc6d956
MS
248/* This struct defines the specific information about a data display
249 window. */
2a8854a7
AC
250struct tui_data_info
251{
1cc6d956 252 tui_win_content data_content; /* Start of data display content. */
6d012f14 253 int data_content_count;
1cc6d956 254 tui_win_content regs_content; /* Start of regs display content. */
6d012f14
AC
255 int regs_content_count;
256 enum tui_register_display_type regs_display_type;
257 int regs_column_count;
1cc6d956 258 int display_regs; /* Should regs be displayed at all? */
10f59415 259 struct reggroup *current_group;
2a8854a7
AC
260};
261
262
263struct tui_source_info
264{
1cc6d956 265 int has_locator; /* Does locator belongs to this window? */
2a8854a7 266 /* Execution information window. */
6d012f14 267 struct tui_gen_win_info *execution_info;
1cc6d956 268 int horizontal_offset; /* Used for horizontal scroll. */
362c05fe 269 struct tui_line_or_address start_line_or_addr;
5b6fe301 270 char *filename;
2a8854a7
AC
271};
272
273
274struct tui_command_info
275{
1cc6d956
MS
276 int cur_line; /* The current line position. */
277 int curch; /* The current cursor position. */
2a8854a7
AC
278 int start_line;
279};
c906108c
SS
280
281
1cc6d956 282/* This defines information about each logical window. */
2a8854a7
AC
283struct tui_win_info
284{
1cc6d956 285 struct tui_gen_win_info generic; /* General window information. */
2a8854a7 286 union
c5aa993b 287 {
6d012f14
AC
288 struct tui_source_info source_info;
289 struct tui_data_info data_display_info;
290 struct tui_command_info command_info;
22940a24 291 void *opaque;
c5aa993b 292 }
2a8854a7 293 detail;
1cc6d956
MS
294 int can_highlight; /* Can this window ever be highlighted? */
295 int is_highlighted; /* Is this window highlighted? */
2a8854a7 296};
c906108c 297
6d012f14
AC
298extern int tui_win_is_source_type (enum tui_win_type win_type);
299extern int tui_win_is_auxillary (enum tui_win_type win_type);
300extern int tui_win_has_locator (struct tui_win_info *win_info);
301extern void tui_set_win_highlight (struct tui_win_info *win_info,
302 int highlight);
c906108c
SS
303
304
1cc6d956 305/* Global Data. */
6d012f14 306extern struct tui_win_info *(tui_win_list[MAX_MAJOR_WINDOWS]);
c906108c 307
1cc6d956
MS
308#define TUI_SRC_WIN tui_win_list[SRC_WIN]
309#define TUI_DISASM_WIN tui_win_list[DISASSEM_WIN]
310#define TUI_DATA_WIN tui_win_list[DATA_WIN]
311#define TUI_CMD_WIN tui_win_list[CMD_WIN]
c906108c 312
1cc6d956 313/* Data Manipulation Functions. */
dd1abb8c
AC
314extern void tui_initialize_static_data (void);
315extern struct tui_gen_win_info *tui_alloc_generic_win_info (void);
22940a24 316extern struct tui_win_info *tui_alloc_win_info (enum tui_win_type);
dd1abb8c
AC
317extern void tui_init_generic_part (struct tui_gen_win_info *);
318extern void tui_init_win_info (struct tui_win_info *);
2a8854a7 319extern tui_win_content tui_alloc_content (int, enum tui_win_type);
dd1abb8c
AC
320extern int tui_add_content_elements (struct tui_gen_win_info *, int);
321extern void tui_init_content_element (struct tui_win_element *, enum tui_win_type);
322extern void tui_free_window (struct tui_win_info *);
323extern void tui_free_win_content (struct tui_gen_win_info *);
2a8854a7 324extern void tui_free_data_content (tui_win_content, int);
dd1abb8c
AC
325extern void tui_free_all_source_wins_content (void);
326extern void tui_del_window (struct tui_win_info *);
2a8854a7 327extern void tui_del_data_windows (tui_win_content, int);
dd1abb8c
AC
328extern struct tui_win_info *tui_partial_win_by_name (char *);
329extern char *tui_win_name (struct tui_gen_win_info *);
2a8854a7
AC
330extern enum tui_layout_type tui_current_layout (void);
331extern void tui_set_current_layout_to (enum tui_layout_type);
dd1abb8c
AC
332extern int tui_term_height (void);
333extern void tui_set_term_height_to (int);
334extern int tui_term_width (void);
335extern void tui_set_term_width_to (int);
336extern void tui_set_gen_win_origin (struct tui_gen_win_info *, int, int);
337extern struct tui_gen_win_info *tui_locator_win_info_ptr (void);
338extern struct tui_gen_win_info *tui_source_exec_info_win_ptr (void);
339extern struct tui_gen_win_info *tui_disassem_exec_info_win_ptr (void);
5b6fe301 340extern struct tui_list *tui_source_windows (void);
dd1abb8c
AC
341extern void tui_clear_source_windows (void);
342extern void tui_clear_source_windows_detail (void);
5b6fe301 343extern void tui_clear_win_detail (struct tui_win_info *win_info);
dd1abb8c
AC
344extern void tui_add_to_source_windows (struct tui_win_info *);
345extern int tui_default_tab_len (void);
346extern void tui_set_default_tab_len (int);
347extern struct tui_win_info *tui_win_with_focus (void);
348extern void tui_set_win_with_focus (struct tui_win_info *);
5b6fe301 349extern struct tui_layout_def *tui_layout_def (void);
dd1abb8c
AC
350extern int tui_win_resized (void);
351extern void tui_set_win_resized_to (int);
352
353extern struct tui_win_info *tui_next_win (struct tui_win_info *);
354extern struct tui_win_info *tui_prev_win (struct tui_win_info *);
355
5b6fe301 356extern void tui_add_to_source_windows (struct tui_win_info *win_info);
c7c228ed 357
c906108c 358#endif /* TUI_DATA_H */
This page took 0.750118 seconds and 4 git commands to generate.