Commit | Line | Data |
---|---|---|
f377b406 | 1 | /* TUI data manipulation routines. |
55fb0713 | 2 | |
42a4f53d | 3 | Copyright (C) 1998-2019 Free Software Foundation, Inc. |
55fb0713 | 4 | |
f377b406 SC |
5 | Contributed by Hewlett-Packard Company. |
6 | ||
7 | This file is part of GDB. | |
8 | ||
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 | |
a9762ec7 | 11 | the Free Software Foundation; either version 3 of the License, or |
f377b406 SC |
12 | (at your option) any later version. |
13 | ||
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. | |
18 | ||
19 | You should have received a copy of the GNU General Public License | |
a9762ec7 | 20 | along with this program. If not, see <http://www.gnu.org/licenses/>. */ |
f377b406 | 21 | |
1a5c2598 TT |
22 | #ifndef TUI_TUI_DATA_H |
23 | #define TUI_TUI_DATA_H | |
c906108c | 24 | |
6a83354a AC |
25 | #include "tui/tui.h" /* For enum tui_win_type. */ |
26 | #include "gdb_curses.h" /* For WINDOW. */ | |
27 | ||
28 | /* This is a point definition. */ | |
29 | struct tui_point | |
30 | { | |
31 | int x, y; | |
32 | }; | |
2a5127c4 | 33 | |
63ed8182 PP |
34 | struct tui_win_element; |
35 | ||
36 | /* This describes the content of the window. */ | |
37 | typedef struct tui_win_element **tui_win_content; | |
38 | ||
1cc6d956 | 39 | /* Generic window information. */ |
2a8854a7 AC |
40 | struct tui_gen_win_info |
41 | { | |
08ef48c5 MS |
42 | WINDOW *handle; /* Window handle. */ |
43 | enum tui_win_type type; /* Type of window. */ | |
44 | int width; /* Window width. */ | |
45 | int height; /* Window height. */ | |
46 | struct tui_point origin; /* Origin of window. */ | |
63ed8182 | 47 | tui_win_content content; /* Content of window. */ |
08ef48c5 MS |
48 | int content_size; /* Size of content (# of elements). */ |
49 | int content_in_use; /* Can it be used, or is it already used? */ | |
50 | int viewport_height; /* Viewport height. */ | |
51 | int last_visible_line; /* Index of last visible line. */ | |
56122977 | 52 | bool is_visible; /* Whether the window is visible or not. */ |
08ef48c5 | 53 | char *title; /* Window title to display. */ |
2a8854a7 | 54 | }; |
2a5127c4 | 55 | |
1cc6d956 | 56 | /* Constant definitions. */ |
08ef48c5 MS |
57 | #define DEFAULT_TAB_LEN 8 |
58 | #define NO_SRC_STRING "[ No Source Available ]" | |
59 | #define NO_DISASSEM_STRING "[ No Assembly Available ]" | |
60 | #define NO_REGS_STRING "[ Register Values Unavailable ]" | |
61 | #define NO_DATA_STRING "[ No Data Values Displayed ]" | |
62 | #define MAX_CONTENT_COUNT 100 | |
6dce28e4 AB |
63 | #define SRC_NAME "src" |
64 | #define CMD_NAME "cmd" | |
65 | #define DATA_NAME "regs" | |
66 | #define DISASSEM_NAME "asm" | |
08ef48c5 MS |
67 | #define TUI_NULL_STR "" |
68 | #define DEFAULT_HISTORY_COUNT 25 | |
69 | #define BOX_WINDOW TRUE | |
70 | #define DONT_BOX_WINDOW FALSE | |
71 | #define HILITE TRUE | |
72 | #define NO_HILITE FALSE | |
73 | #define WITH_LOCATOR TRUE | |
74 | #define NO_LOCATOR FALSE | |
75 | #define EMPTY_SOURCE_PROMPT TRUE | |
76 | #define NO_EMPTY_SOURCE_PROMPT FALSE | |
77 | #define UNDEFINED_ITEM -1 | |
78 | #define MIN_WIN_HEIGHT 3 | |
79 | #define MIN_CMD_WIN_HEIGHT 3 | |
c906108c | 80 | |
50265402 | 81 | /* Strings to display in the TUI status line. */ |
08ef48c5 | 82 | #define PROC_PREFIX "In: " |
9f2850ba | 83 | #define LINE_PREFIX "L" |
08ef48c5 MS |
84 | #define PC_PREFIX "PC: " |
85 | #define SINGLE_KEY "(SingleKey)" | |
50265402 | 86 | |
1cc6d956 MS |
87 | /* Minimum/Maximum length of some fields displayed in the TUI status |
88 | line. */ | |
89 | #define MIN_LINE_WIDTH 4 /* Use at least 4 digits for line | |
90 | numbers. */ | |
50265402 SC |
91 | #define MIN_PROC_WIDTH 12 |
92 | #define MAX_TARGET_WIDTH 10 | |
9f2850ba | 93 | #define MAX_PID_WIDTH 19 |
c906108c | 94 | |
2a8854a7 AC |
95 | /* Scroll direction enum. */ |
96 | enum tui_scroll_direction | |
97 | { | |
98 | FORWARD_SCROLL, | |
99 | BACKWARD_SCROLL, | |
100 | LEFT_SCROLL, | |
101 | RIGHT_SCROLL | |
102 | }; | |
c906108c SS |
103 | |
104 | ||
1cc6d956 | 105 | /* The kinds of layouts available. */ |
2a8854a7 AC |
106 | enum tui_layout_type |
107 | { | |
108 | SRC_COMMAND, | |
109 | DISASSEM_COMMAND, | |
110 | SRC_DISASSEM_COMMAND, | |
111 | SRC_DATA_COMMAND, | |
112 | DISASSEM_DATA_COMMAND, | |
113 | UNDEFINED_LAYOUT | |
114 | }; | |
c906108c | 115 | |
1cc6d956 | 116 | /* Basic data types that can be displayed in the data window. */ |
2a8854a7 AC |
117 | enum tui_data_type |
118 | { | |
119 | TUI_REGISTER, | |
120 | TUI_SCALAR, | |
121 | TUI_COMPLEX, | |
122 | TUI_STRUCT | |
123 | }; | |
c906108c | 124 | |
52059ffd TT |
125 | enum tui_line_or_address_kind |
126 | { | |
127 | LOA_LINE, | |
128 | LOA_ADDRESS | |
129 | }; | |
130 | ||
1cc6d956 | 131 | /* Structure describing source line or line address. */ |
362c05fe | 132 | struct tui_line_or_address |
2a8854a7 | 133 | { |
52059ffd | 134 | enum tui_line_or_address_kind loa; |
362c05fe AS |
135 | union |
136 | { | |
137 | int line_no; | |
138 | CORE_ADDR addr; | |
139 | } u; | |
2a8854a7 | 140 | }; |
c906108c | 141 | |
1cc6d956 | 142 | /* Current Layout definition. */ |
2a8854a7 AC |
143 | struct tui_layout_def |
144 | { | |
6d012f14 | 145 | enum tui_win_type display_mode; |
2a8854a7 | 146 | int split; |
2a8854a7 | 147 | }; |
c906108c | 148 | |
1cc6d956 | 149 | /* Elements in the Source/Disassembly Window. */ |
2a8854a7 AC |
150 | struct tui_source_element |
151 | { | |
152 | char *line; | |
362c05fe | 153 | struct tui_line_or_address line_or_addr; |
6d012f14 AC |
154 | int is_exec_point; |
155 | int has_break; | |
2a8854a7 | 156 | }; |
c906108c SS |
157 | |
158 | ||
1cc6d956 | 159 | /* Elements in the data display window content. */ |
2a8854a7 AC |
160 | struct tui_data_element |
161 | { | |
162 | const char *name; | |
08ef48c5 MS |
163 | int item_no; /* The register number, or data display |
164 | number. */ | |
2a8854a7 | 165 | enum tui_data_type type; |
22940a24 | 166 | void *value; |
2a8854a7 | 167 | int highlight; |
10f59415 | 168 | char *content; |
2a8854a7 | 169 | }; |
c906108c SS |
170 | |
171 | ||
1cc6d956 | 172 | /* Elements in the command window content. */ |
2a8854a7 AC |
173 | struct tui_command_element |
174 | { | |
175 | char *line; | |
176 | }; | |
c906108c | 177 | |
2d42f9a8 JB |
178 | #ifdef PATH_MAX |
179 | # define MAX_LOCATOR_ELEMENT_LEN PATH_MAX | |
180 | #else | |
181 | # define MAX_LOCATOR_ELEMENT_LEN 1024 | |
182 | #endif | |
c906108c | 183 | |
1cc6d956 | 184 | /* Elements in the locator window content. */ |
2a8854a7 AC |
185 | struct tui_locator_element |
186 | { | |
56d397a3 JK |
187 | /* Resolved absolute filename as returned by symtab_to_fullname. */ |
188 | char full_name[MAX_LOCATOR_ELEMENT_LEN]; | |
6d012f14 AC |
189 | char proc_name[MAX_LOCATOR_ELEMENT_LEN]; |
190 | int line_no; | |
2a8854a7 | 191 | CORE_ADDR addr; |
13274fc3 UW |
192 | /* Architecture associated with code at this location. */ |
193 | struct gdbarch *gdbarch; | |
2a8854a7 | 194 | }; |
c906108c | 195 | |
00b2bad4 SC |
196 | /* Flags to tell what kind of breakpoint is at current line. */ |
197 | #define TUI_BP_ENABLED 0x01 | |
198 | #define TUI_BP_DISABLED 0x02 | |
199 | #define TUI_BP_HIT 0x04 | |
200 | #define TUI_BP_CONDITIONAL 0x08 | |
201 | #define TUI_BP_HARDWARE 0x10 | |
202 | ||
203 | /* Position of breakpoint markers in the exec info string. */ | |
204 | #define TUI_BP_HIT_POS 0 | |
205 | #define TUI_BP_BREAK_POS 1 | |
206 | #define TUI_EXEC_POS 2 | |
207 | #define TUI_EXECINFO_SIZE 4 | |
208 | ||
2a8854a7 | 209 | typedef char tui_exec_info_content[TUI_EXECINFO_SIZE]; |
c906108c | 210 | |
1cc6d956 | 211 | /* An content element in a window. */ |
2a8854a7 AC |
212 | union tui_which_element |
213 | { | |
1cc6d956 MS |
214 | struct tui_source_element source; /* The source elements. */ |
215 | struct tui_gen_win_info data_window; /* Data display elements. */ | |
216 | struct tui_data_element data; /* Elements of data_window. */ | |
217 | struct tui_command_element command; /* Command elements. */ | |
218 | struct tui_locator_element locator; /* Locator elements. */ | |
219 | tui_exec_info_content simple_string; /* Simple char based elements. */ | |
2a8854a7 AC |
220 | }; |
221 | ||
222 | struct tui_win_element | |
223 | { | |
6d012f14 | 224 | union tui_which_element which_element; |
2a8854a7 | 225 | }; |
c906108c | 226 | |
1cc6d956 | 227 | /* This defines information about each logical window. */ |
2a8854a7 AC |
228 | struct tui_win_info |
229 | { | |
33b906ab | 230 | protected: |
e7e11af4 | 231 | |
33b906ab | 232 | explicit tui_win_info (enum tui_win_type type); |
6792b55e TT |
233 | DISABLE_COPY_AND_ASSIGN (tui_win_info); |
234 | ||
13446e05 TT |
235 | /* Scroll the contents vertically. This is only called via |
236 | forward_scroll and backward_scroll. */ | |
237 | virtual void do_scroll_vertical (enum tui_scroll_direction, | |
238 | int num_to_scroll) = 0; | |
239 | ||
240 | /* Scroll the contents horizontally. This is only called via | |
241 | left_scroll and right_scroll. */ | |
242 | virtual void do_scroll_horizontal (enum tui_scroll_direction, | |
243 | int num_to_scroll) = 0; | |
244 | ||
33b906ab TT |
245 | public: |
246 | ||
247 | virtual ~tui_win_info (); | |
248 | ||
8761a91b TT |
249 | /* Clear the pertinent detail in the window. */ |
250 | virtual void clear_detail () = 0; | |
251 | ||
44f0e208 TT |
252 | /* Return true if this window has the locator. */ |
253 | virtual bool has_locator () const | |
254 | { | |
255 | return false; | |
256 | } | |
257 | ||
cda37efb | 258 | /* Make this window visible or invisible. */ |
56122977 | 259 | virtual void make_visible (bool visible); |
cda37efb | 260 | |
2042b506 TT |
261 | /* Refresh this window and any associated windows. */ |
262 | virtual void refresh (); | |
263 | ||
13446e05 TT |
264 | /* Methods to scroll the contents of this window. Note that they |
265 | are named with "_scroll" coming at the end because the more | |
266 | obvious "scroll_forward" is defined as a macro in term.h. */ | |
267 | void forward_scroll (int num_to_scroll); | |
268 | void backward_scroll (int num_to_scroll); | |
269 | void left_scroll (int num_to_scroll); | |
270 | void right_scroll (int num_to_scroll); | |
271 | ||
1cc6d956 | 272 | struct tui_gen_win_info generic; /* General window information. */ |
33b906ab TT |
273 | |
274 | /* Can this window ever be highlighted? */ | |
275 | int can_highlight = 0; | |
276 | ||
277 | /* Is this window highlighted? */ | |
278 | int is_highlighted = 0; | |
279 | }; | |
280 | ||
5cf82909 TT |
281 | /* The base class for all source-like windows, namely the source and |
282 | disassembly windows. */ | |
283 | ||
284 | struct tui_source_window_base : public tui_win_info | |
33b906ab | 285 | { |
5cf82909 TT |
286 | protected: |
287 | explicit tui_source_window_base (enum tui_win_type type); | |
288 | ~tui_source_window_base () override; | |
289 | DISABLE_COPY_AND_ASSIGN (tui_source_window_base); | |
290 | ||
13446e05 TT |
291 | void do_scroll_horizontal (enum tui_scroll_direction, |
292 | int num_to_scroll) override; | |
293 | ||
5cf82909 | 294 | public: |
8761a91b TT |
295 | |
296 | void clear_detail () override; | |
44f0e208 TT |
297 | |
298 | /* Return true if this window has the locator. */ | |
e6e41501 TT |
299 | bool has_locator () const override |
300 | { | |
301 | return m_has_locator; | |
302 | } | |
303 | ||
56122977 | 304 | void make_visible (bool visible) override; |
2042b506 | 305 | void refresh () override; |
cda37efb | 306 | |
ad54d15b TT |
307 | /* Refill the source window's source cache and update it. If this |
308 | is a disassembly window, then just update it. */ | |
309 | void refill (); | |
310 | ||
311 | /* Set the location of the execution point. */ | |
312 | void set_is_exec_point_at (struct tui_line_or_address l); | |
313 | ||
e6e41501 TT |
314 | /* Does the locator belong to this window? */ |
315 | bool m_has_locator = false; | |
316 | /* Execution information window. */ | |
317 | struct tui_gen_win_info *execution_info = nullptr; | |
318 | /* Used for horizontal scroll. */ | |
319 | int horizontal_offset = 0; | |
320 | struct tui_line_or_address start_line_or_addr; | |
321 | ||
322 | /* It is the resolved form as returned by symtab_to_fullname. */ | |
323 | char *fullname = nullptr; | |
324 | ||
325 | /* Architecture associated with code at this location. */ | |
326 | struct gdbarch *gdbarch = nullptr; | |
33b906ab TT |
327 | }; |
328 | ||
5cf82909 TT |
329 | /* A TUI source window. */ |
330 | ||
331 | struct tui_source_window : public tui_source_window_base | |
332 | { | |
333 | tui_source_window () | |
334 | : tui_source_window_base (SRC_WIN) | |
335 | { | |
336 | } | |
337 | ||
338 | DISABLE_COPY_AND_ASSIGN (tui_source_window); | |
13446e05 TT |
339 | |
340 | protected: | |
341 | ||
342 | void do_scroll_vertical (enum tui_scroll_direction, | |
343 | int num_to_scroll) override; | |
5cf82909 TT |
344 | }; |
345 | ||
346 | /* A TUI disassembly window. */ | |
347 | ||
348 | struct tui_disasm_window : public tui_source_window_base | |
349 | { | |
350 | tui_disasm_window () | |
351 | : tui_source_window_base (DISASSEM_WIN) | |
352 | { | |
353 | } | |
354 | ||
355 | DISABLE_COPY_AND_ASSIGN (tui_disasm_window); | |
13446e05 TT |
356 | |
357 | protected: | |
358 | ||
359 | void do_scroll_vertical (enum tui_scroll_direction, | |
360 | int num_to_scroll) override; | |
5cf82909 TT |
361 | }; |
362 | ||
33b906ab TT |
363 | struct tui_data_window : public tui_win_info |
364 | { | |
63901aec TT |
365 | tui_data_window () |
366 | : tui_win_info (DATA_WIN) | |
367 | { | |
368 | } | |
369 | ||
ee1d42d6 | 370 | ~tui_data_window () override; |
33b906ab | 371 | DISABLE_COPY_AND_ASSIGN (tui_data_window); |
8761a91b TT |
372 | |
373 | void clear_detail () override; | |
13446e05 | 374 | |
63901aec TT |
375 | /* Start of data display content. */ |
376 | tui_win_content data_content = NULL; | |
377 | int data_content_count = 0; | |
378 | /* Start of regs display content. */ | |
379 | tui_win_content regs_content = NULL; | |
380 | int regs_content_count = 0; | |
381 | int regs_column_count = 0; | |
382 | /* Should regs be displayed at all? */ | |
383 | bool display_regs = false; | |
384 | struct reggroup *current_group = nullptr; | |
238eb706 | 385 | |
13446e05 TT |
386 | protected: |
387 | ||
388 | void do_scroll_vertical (enum tui_scroll_direction, | |
389 | int num_to_scroll) override; | |
390 | void do_scroll_horizontal (enum tui_scroll_direction, | |
391 | int num_to_scroll) override | |
392 | { | |
393 | } | |
33b906ab TT |
394 | }; |
395 | ||
396 | struct tui_cmd_window : public tui_win_info | |
397 | { | |
63901aec TT |
398 | tui_cmd_window () |
399 | : tui_win_info (CMD_WIN) | |
400 | { | |
401 | } | |
402 | ||
33b906ab | 403 | DISABLE_COPY_AND_ASSIGN (tui_cmd_window); |
8761a91b TT |
404 | |
405 | void clear_detail () override; | |
13446e05 | 406 | |
56122977 | 407 | void make_visible (bool visible) override |
cda37efb TT |
408 | { |
409 | } | |
410 | ||
63901aec | 411 | int start_line = 0; |
81491aa0 | 412 | |
13446e05 TT |
413 | protected: |
414 | ||
415 | void do_scroll_vertical (enum tui_scroll_direction, | |
416 | int num_to_scroll) override | |
417 | { | |
418 | } | |
419 | ||
420 | void do_scroll_horizontal (enum tui_scroll_direction, | |
421 | int num_to_scroll) override | |
422 | { | |
423 | } | |
2a8854a7 | 424 | }; |
c906108c | 425 | |
6d012f14 | 426 | extern int tui_win_is_auxillary (enum tui_win_type win_type); |
6d012f14 AC |
427 | extern void tui_set_win_highlight (struct tui_win_info *win_info, |
428 | int highlight); | |
c906108c SS |
429 | |
430 | ||
1cc6d956 | 431 | /* Global Data. */ |
7fa29be9 | 432 | extern struct tui_win_info *tui_win_list[MAX_MAJOR_WINDOWS]; |
c906108c | 433 | |
e6e41501 TT |
434 | #define TUI_SRC_WIN ((tui_source_window_base *) tui_win_list[SRC_WIN]) |
435 | #define TUI_DISASM_WIN ((tui_source_window_base *) tui_win_list[DISASSEM_WIN]) | |
238eb706 | 436 | #define TUI_DATA_WIN ((tui_data_window *) tui_win_list[DATA_WIN]) |
81491aa0 | 437 | #define TUI_CMD_WIN ((tui_cmd_window *) tui_win_list[CMD_WIN]) |
c906108c | 438 | |
1cc6d956 | 439 | /* Data Manipulation Functions. */ |
dd1abb8c AC |
440 | extern void tui_initialize_static_data (void); |
441 | extern struct tui_gen_win_info *tui_alloc_generic_win_info (void); | |
22940a24 | 442 | extern struct tui_win_info *tui_alloc_win_info (enum tui_win_type); |
dd1abb8c | 443 | extern void tui_init_generic_part (struct tui_gen_win_info *); |
2a8854a7 | 444 | extern tui_win_content tui_alloc_content (int, enum tui_win_type); |
08ef48c5 MS |
445 | extern int tui_add_content_elements (struct tui_gen_win_info *, |
446 | int); | |
dd1abb8c | 447 | extern void tui_free_win_content (struct tui_gen_win_info *); |
2a8854a7 | 448 | extern void tui_free_data_content (tui_win_content, int); |
dd1abb8c | 449 | extern void tui_free_all_source_wins_content (void); |
a121b7c1 | 450 | extern struct tui_win_info *tui_partial_win_by_name (const char *); |
f41cbf58 | 451 | extern const char *tui_win_name (const struct tui_gen_win_info *); |
2a8854a7 AC |
452 | extern enum tui_layout_type tui_current_layout (void); |
453 | extern void tui_set_current_layout_to (enum tui_layout_type); | |
dd1abb8c AC |
454 | extern int tui_term_height (void); |
455 | extern void tui_set_term_height_to (int); | |
456 | extern int tui_term_width (void); | |
457 | extern void tui_set_term_width_to (int); | |
dd1abb8c AC |
458 | extern struct tui_gen_win_info *tui_locator_win_info_ptr (void); |
459 | extern struct tui_gen_win_info *tui_source_exec_info_win_ptr (void); | |
460 | extern struct tui_gen_win_info *tui_disassem_exec_info_win_ptr (void); | |
ad54d15b | 461 | extern std::vector<tui_source_window_base *> &tui_source_windows (); |
dd1abb8c AC |
462 | extern void tui_clear_source_windows (void); |
463 | extern void tui_clear_source_windows_detail (void); | |
ad54d15b | 464 | extern void tui_add_to_source_windows (struct tui_source_window_base *); |
dd1abb8c AC |
465 | extern struct tui_win_info *tui_win_with_focus (void); |
466 | extern void tui_set_win_with_focus (struct tui_win_info *); | |
5b6fe301 | 467 | extern struct tui_layout_def *tui_layout_def (void); |
dd1abb8c AC |
468 | extern int tui_win_resized (void); |
469 | extern void tui_set_win_resized_to (int); | |
470 | ||
471 | extern struct tui_win_info *tui_next_win (struct tui_win_info *); | |
472 | extern struct tui_win_info *tui_prev_win (struct tui_win_info *); | |
473 | ||
7806cea7 TT |
474 | extern unsigned int tui_tab_width; |
475 | ||
1a5c2598 | 476 | #endif /* TUI_TUI_DATA_H */ |