1 /* TUI data manipulation routines.
3 Copyright (C) 1998-2019 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/>. */
22 #ifndef TUI_TUI_DATA_H
23 #define TUI_TUI_DATA_H
25 #include "tui/tui.h" /* For enum tui_win_type. */
26 #include "gdb_curses.h" /* For WINDOW. */
28 /* This is a point definition. */
34 struct tui_win_element
;
36 /* This describes the content of the window. */
37 typedef struct tui_win_element
**tui_win_content
;
39 /* Generic window information. */
40 struct tui_gen_win_info
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. */
47 tui_win_content content
; /* Content of window. */
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. */
52 bool is_visible
; /* Whether the window is visible or not. */
53 char *title
; /* Window title to display. */
56 /* Constant definitions. */
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
63 #define SRC_NAME "src"
64 #define CMD_NAME "cmd"
65 #define DATA_NAME "regs"
66 #define DISASSEM_NAME "asm"
67 #define TUI_NULL_STR ""
68 #define DEFAULT_HISTORY_COUNT 25
69 #define BOX_WINDOW TRUE
70 #define DONT_BOX_WINDOW FALSE
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
81 /* Strings to display in the TUI status line. */
82 #define PROC_PREFIX "In: "
83 #define LINE_PREFIX "L"
84 #define PC_PREFIX "PC: "
85 #define SINGLE_KEY "(SingleKey)"
87 /* Minimum/Maximum length of some fields displayed in the TUI status
89 #define MIN_LINE_WIDTH 4 /* Use at least 4 digits for line
91 #define MIN_PROC_WIDTH 12
92 #define MAX_TARGET_WIDTH 10
93 #define MAX_PID_WIDTH 19
95 /* Scroll direction enum. */
96 enum tui_scroll_direction
105 /* The kinds of layouts available. */
110 SRC_DISASSEM_COMMAND
,
112 DISASSEM_DATA_COMMAND
,
116 /* Basic data types that can be displayed in the data window. */
125 enum tui_line_or_address_kind
131 /* Structure describing source line or line address. */
132 struct tui_line_or_address
134 enum tui_line_or_address_kind loa
;
142 /* Current Layout definition. */
143 struct tui_layout_def
145 enum tui_win_type display_mode
;
149 /* Elements in the Source/Disassembly Window. */
150 struct tui_source_element
153 struct tui_line_or_address line_or_addr
;
159 /* Elements in the data display window content. */
160 struct tui_data_element
163 int item_no
; /* The register number, or data display
165 enum tui_data_type type
;
172 /* Elements in the command window content. */
173 struct tui_command_element
179 # define MAX_LOCATOR_ELEMENT_LEN PATH_MAX
181 # define MAX_LOCATOR_ELEMENT_LEN 1024
184 /* Elements in the locator window content. */
185 struct tui_locator_element
187 /* Resolved absolute filename as returned by symtab_to_fullname. */
188 char full_name
[MAX_LOCATOR_ELEMENT_LEN
];
189 char proc_name
[MAX_LOCATOR_ELEMENT_LEN
];
192 /* Architecture associated with code at this location. */
193 struct gdbarch
*gdbarch
;
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
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
209 typedef char tui_exec_info_content
[TUI_EXECINFO_SIZE
];
211 /* An content element in a window. */
212 union tui_which_element
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. */
222 struct tui_win_element
224 union tui_which_element which_element
;
227 /* This defines information about each logical window. */
232 explicit tui_win_info (enum tui_win_type type
);
233 DISABLE_COPY_AND_ASSIGN (tui_win_info
);
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;
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;
247 virtual ~tui_win_info ();
249 /* Clear the pertinent detail in the window. */
250 virtual void clear_detail () = 0;
252 /* Return true if this window has the locator. */
253 virtual bool has_locator () const
258 /* Make this window visible or invisible. */
259 virtual void make_visible (bool visible
);
261 /* Refresh this window and any associated windows. */
262 virtual void refresh ();
264 /* Called after all the TUI windows are refreshed, to let this
265 window have a chance to update itself further. */
266 virtual void refresh_all ()
270 /* Called after a TUI window is given a new height; this updates any
271 related auxiliary windows. */
272 virtual void set_new_height (int height
)
276 /* Methods to scroll the contents of this window. Note that they
277 are named with "_scroll" coming at the end because the more
278 obvious "scroll_forward" is defined as a macro in term.h. */
279 void forward_scroll (int num_to_scroll
);
280 void backward_scroll (int num_to_scroll
);
281 void left_scroll (int num_to_scroll
);
282 void right_scroll (int num_to_scroll
);
284 struct tui_gen_win_info generic
; /* General window information. */
286 /* Can this window ever be highlighted? */
287 int can_highlight
= 0;
289 /* Is this window highlighted? */
290 int is_highlighted
= 0;
293 /* The base class for all source-like windows, namely the source and
294 disassembly windows. */
296 struct tui_source_window_base
: public tui_win_info
299 explicit tui_source_window_base (enum tui_win_type type
);
300 ~tui_source_window_base () override
;
301 DISABLE_COPY_AND_ASSIGN (tui_source_window_base
);
303 void do_scroll_horizontal (enum tui_scroll_direction
,
304 int num_to_scroll
) override
;
308 void clear_detail () override
;
310 /* Return true if this window has the locator. */
311 bool has_locator () const override
313 return m_has_locator
;
316 void make_visible (bool visible
) override
;
317 void refresh () override
;
318 void refresh_all () override
;
320 /* Refill the source window's source cache and update it. If this
321 is a disassembly window, then just update it. */
324 /* Set the location of the execution point. */
325 void set_is_exec_point_at (struct tui_line_or_address l
);
327 void set_new_height (int height
) override
;
329 /* Does the locator belong to this window? */
330 bool m_has_locator
= false;
331 /* Execution information window. */
332 struct tui_gen_win_info
*execution_info
= nullptr;
333 /* Used for horizontal scroll. */
334 int horizontal_offset
= 0;
335 struct tui_line_or_address start_line_or_addr
;
337 /* It is the resolved form as returned by symtab_to_fullname. */
338 char *fullname
= nullptr;
340 /* Architecture associated with code at this location. */
341 struct gdbarch
*gdbarch
= nullptr;
344 /* A TUI source window. */
346 struct tui_source_window
: public tui_source_window_base
349 : tui_source_window_base (SRC_WIN
)
353 DISABLE_COPY_AND_ASSIGN (tui_source_window
);
357 void do_scroll_vertical (enum tui_scroll_direction
,
358 int num_to_scroll
) override
;
361 /* A TUI disassembly window. */
363 struct tui_disasm_window
: public tui_source_window_base
366 : tui_source_window_base (DISASSEM_WIN
)
370 DISABLE_COPY_AND_ASSIGN (tui_disasm_window
);
374 void do_scroll_vertical (enum tui_scroll_direction
,
375 int num_to_scroll
) override
;
378 struct tui_data_window
: public tui_win_info
381 : tui_win_info (DATA_WIN
)
385 ~tui_data_window () override
;
386 DISABLE_COPY_AND_ASSIGN (tui_data_window
);
388 void clear_detail () override
;
389 void refresh_all () override
;
391 void set_new_height (int height
) override
;
393 /* Start of data display content. */
394 tui_win_content data_content
= NULL
;
395 int data_content_count
= 0;
396 /* Start of regs display content. */
397 tui_win_content regs_content
= NULL
;
398 int regs_content_count
= 0;
399 int regs_column_count
= 0;
400 /* Should regs be displayed at all? */
401 bool display_regs
= false;
402 struct reggroup
*current_group
= nullptr;
406 void do_scroll_vertical (enum tui_scroll_direction
,
407 int num_to_scroll
) override
;
408 void do_scroll_horizontal (enum tui_scroll_direction
,
409 int num_to_scroll
) override
414 struct tui_cmd_window
: public tui_win_info
417 : tui_win_info (CMD_WIN
)
421 DISABLE_COPY_AND_ASSIGN (tui_cmd_window
);
423 void clear_detail () override
;
425 void make_visible (bool visible
) override
433 void do_scroll_vertical (enum tui_scroll_direction
,
434 int num_to_scroll
) override
438 void do_scroll_horizontal (enum tui_scroll_direction
,
439 int num_to_scroll
) override
444 extern int tui_win_is_auxillary (enum tui_win_type win_type
);
445 extern void tui_set_win_highlight (struct tui_win_info
*win_info
,
450 extern struct tui_win_info
*tui_win_list
[MAX_MAJOR_WINDOWS
];
452 #define TUI_SRC_WIN ((tui_source_window_base *) tui_win_list[SRC_WIN])
453 #define TUI_DISASM_WIN ((tui_source_window_base *) tui_win_list[DISASSEM_WIN])
454 #define TUI_DATA_WIN ((tui_data_window *) tui_win_list[DATA_WIN])
455 #define TUI_CMD_WIN ((tui_cmd_window *) tui_win_list[CMD_WIN])
457 /* Data Manipulation Functions. */
458 extern void tui_initialize_static_data (void);
459 extern struct tui_gen_win_info
*tui_alloc_generic_win_info (void);
460 extern struct tui_win_info
*tui_alloc_win_info (enum tui_win_type
);
461 extern void tui_init_generic_part (struct tui_gen_win_info
*);
462 extern tui_win_content
tui_alloc_content (int, enum tui_win_type
);
463 extern int tui_add_content_elements (struct tui_gen_win_info
*,
465 extern void tui_free_win_content (struct tui_gen_win_info
*);
466 extern void tui_free_data_content (tui_win_content
, int);
467 extern void tui_free_all_source_wins_content (void);
468 extern struct tui_win_info
*tui_partial_win_by_name (const char *);
469 extern const char *tui_win_name (const struct tui_gen_win_info
*);
470 extern enum tui_layout_type
tui_current_layout (void);
471 extern void tui_set_current_layout_to (enum tui_layout_type
);
472 extern int tui_term_height (void);
473 extern void tui_set_term_height_to (int);
474 extern int tui_term_width (void);
475 extern void tui_set_term_width_to (int);
476 extern struct tui_gen_win_info
*tui_locator_win_info_ptr (void);
477 extern struct tui_gen_win_info
*tui_source_exec_info_win_ptr (void);
478 extern struct tui_gen_win_info
*tui_disassem_exec_info_win_ptr (void);
479 extern std::vector
<tui_source_window_base
*> &tui_source_windows ();
480 extern void tui_clear_source_windows (void);
481 extern void tui_clear_source_windows_detail (void);
482 extern void tui_add_to_source_windows (struct tui_source_window_base
*);
483 extern struct tui_win_info
*tui_win_with_focus (void);
484 extern void tui_set_win_with_focus (struct tui_win_info
*);
485 extern struct tui_layout_def
*tui_layout_def (void);
486 extern int tui_win_resized (void);
487 extern void tui_set_win_resized_to (int);
489 extern struct tui_win_info
*tui_next_win (struct tui_win_info
*);
490 extern struct tui_win_info
*tui_prev_win (struct tui_win_info
*);
492 extern unsigned int tui_tab_width
;
494 #endif /* TUI_TUI_DATA_H */