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 explicit tui_gen_win_info (enum tui_win_type t
)
47 virtual ~tui_gen_win_info ()
51 /* Call to refresh this window. */
52 virtual void refresh_window ();
54 /* Return the name of this type of window. */
55 virtual const char *name () const
61 WINDOW
*handle
= nullptr;
63 enum tui_win_type type
;
68 /* Origin of window. */
69 struct tui_point origin
= {0, 0};
70 /* Content of window. */
71 tui_win_content content
= nullptr;
72 /* Size of content (# of elements). */
74 /* Can it be used, or is it already used? */
75 int content_in_use
= FALSE
;
76 /* Viewport height. */
77 int viewport_height
= 0;
78 /* Index of last visible line. */
79 int last_visible_line
= 0;
80 /* Whether the window is visible or not. */
81 bool is_visible
= false;
82 /* Window title to display. */
83 char *title
= nullptr;
86 /* Constant definitions. */
87 #define DEFAULT_TAB_LEN 8
88 #define NO_SRC_STRING "[ No Source Available ]"
89 #define NO_DISASSEM_STRING "[ No Assembly Available ]"
90 #define NO_REGS_STRING "[ Register Values Unavailable ]"
91 #define NO_DATA_STRING "[ No Data Values Displayed ]"
92 #define MAX_CONTENT_COUNT 100
93 #define SRC_NAME "src"
94 #define CMD_NAME "cmd"
95 #define DATA_NAME "regs"
96 #define DISASSEM_NAME "asm"
97 #define TUI_NULL_STR ""
98 #define DEFAULT_HISTORY_COUNT 25
99 #define BOX_WINDOW TRUE
100 #define DONT_BOX_WINDOW FALSE
102 #define NO_HILITE FALSE
103 #define WITH_LOCATOR TRUE
104 #define NO_LOCATOR FALSE
105 #define EMPTY_SOURCE_PROMPT TRUE
106 #define NO_EMPTY_SOURCE_PROMPT FALSE
107 #define UNDEFINED_ITEM -1
108 #define MIN_WIN_HEIGHT 3
109 #define MIN_CMD_WIN_HEIGHT 3
111 /* Strings to display in the TUI status line. */
112 #define PROC_PREFIX "In: "
113 #define LINE_PREFIX "L"
114 #define PC_PREFIX "PC: "
115 #define SINGLE_KEY "(SingleKey)"
117 /* Minimum/Maximum length of some fields displayed in the TUI status
119 #define MIN_LINE_WIDTH 4 /* Use at least 4 digits for line
121 #define MIN_PROC_WIDTH 12
122 #define MAX_TARGET_WIDTH 10
123 #define MAX_PID_WIDTH 19
125 /* The kinds of layouts available. */
130 SRC_DISASSEM_COMMAND
,
132 DISASSEM_DATA_COMMAND
,
136 /* Basic data types that can be displayed in the data window. */
145 enum tui_line_or_address_kind
151 /* Structure describing source line or line address. */
152 struct tui_line_or_address
154 enum tui_line_or_address_kind loa
;
162 /* Current Layout definition. */
163 struct tui_layout_def
165 enum tui_win_type display_mode
;
169 /* Elements in the Source/Disassembly Window. */
170 struct tui_source_element
173 struct tui_line_or_address line_or_addr
;
179 /* Elements in the data display window content. */
180 struct tui_data_element
183 int item_no
; /* The register number, or data display
185 enum tui_data_type type
;
192 /* Elements in the command window content. */
193 struct tui_command_element
199 # define MAX_LOCATOR_ELEMENT_LEN PATH_MAX
201 # define MAX_LOCATOR_ELEMENT_LEN 1024
204 /* Elements in the locator window content. */
205 struct tui_locator_element
207 /* Resolved absolute filename as returned by symtab_to_fullname. */
208 char full_name
[MAX_LOCATOR_ELEMENT_LEN
];
209 char proc_name
[MAX_LOCATOR_ELEMENT_LEN
];
212 /* Architecture associated with code at this location. */
213 struct gdbarch
*gdbarch
;
216 /* Flags to tell what kind of breakpoint is at current line. */
217 #define TUI_BP_ENABLED 0x01
218 #define TUI_BP_DISABLED 0x02
219 #define TUI_BP_HIT 0x04
220 #define TUI_BP_CONDITIONAL 0x08
221 #define TUI_BP_HARDWARE 0x10
223 /* Position of breakpoint markers in the exec info string. */
224 #define TUI_BP_HIT_POS 0
225 #define TUI_BP_BREAK_POS 1
226 #define TUI_EXEC_POS 2
227 #define TUI_EXECINFO_SIZE 4
229 typedef char tui_exec_info_content
[TUI_EXECINFO_SIZE
];
231 /* An content element in a window. */
232 union tui_which_element
234 struct tui_source_element source
; /* The source elements. */
235 struct tui_gen_win_info
*data_window
; /* Data display elements. */
236 struct tui_data_element data
; /* Elements of data_window. */
237 struct tui_command_element command
; /* Command elements. */
238 struct tui_locator_element locator
; /* Locator elements. */
239 tui_exec_info_content simple_string
; /* Simple char based elements. */
242 struct tui_win_element
244 union tui_which_element which_element
;
247 /* This defines information about each logical window. */
248 struct tui_win_info
: public tui_gen_win_info
252 explicit tui_win_info (enum tui_win_type type
);
253 DISABLE_COPY_AND_ASSIGN (tui_win_info
);
255 /* Scroll the contents vertically. This is only called via
256 forward_scroll and backward_scroll. */
257 virtual void do_scroll_vertical (int num_to_scroll
) = 0;
259 /* Scroll the contents horizontally. This is only called via
260 left_scroll and right_scroll. */
261 virtual void do_scroll_horizontal (int num_to_scroll
) = 0;
265 ~tui_win_info () override
;
267 /* Clear the pertinent detail in the window. */
268 virtual void clear_detail () = 0;
270 /* Return true if this window has the locator. */
271 virtual bool has_locator () const
276 /* Make this window visible or invisible. */
277 virtual void make_visible (bool visible
);
279 /* Refresh this window and any associated windows. */
280 virtual void refresh ();
282 /* Called after all the TUI windows are refreshed, to let this
283 window have a chance to update itself further. */
284 virtual void refresh_all ()
288 /* Called after a TUI window is given a new height; this updates any
289 related auxiliary windows. */
290 virtual void set_new_height (int height
)
294 /* Compute the maximum height of this window. */
295 virtual int max_height () const;
297 /* Set whether this window is highglighted. */
298 void set_highlight (bool highlight
)
300 is_highlighted
= highlight
;
303 /* Methods to scroll the contents of this window. Note that they
304 are named with "_scroll" coming at the end because the more
305 obvious "scroll_forward" is defined as a macro in term.h. */
306 void forward_scroll (int num_to_scroll
);
307 void backward_scroll (int num_to_scroll
);
308 void left_scroll (int num_to_scroll
);
309 void right_scroll (int num_to_scroll
);
311 /* Can this window ever be highlighted? */
312 bool can_highlight
= false;
314 /* Is this window highlighted? */
315 bool is_highlighted
= false;
318 /* The base class for all source-like windows, namely the source and
319 disassembly windows. */
321 struct tui_source_window_base
: public tui_win_info
324 explicit tui_source_window_base (enum tui_win_type type
);
325 ~tui_source_window_base () override
;
326 DISABLE_COPY_AND_ASSIGN (tui_source_window_base
);
328 void do_scroll_horizontal (int num_to_scroll
) override
;
332 void clear_detail () override
;
334 /* Return true if this window has the locator. */
335 bool has_locator () const override
337 return m_has_locator
;
340 void make_visible (bool visible
) override
;
341 void refresh () override
;
342 void refresh_all () override
;
344 /* Refill the source window's source cache and update it. If this
345 is a disassembly window, then just update it. */
348 /* Set the location of the execution point. */
349 void set_is_exec_point_at (struct tui_line_or_address l
);
351 void set_new_height (int height
) override
;
353 /* Does the locator belong to this window? */
354 bool m_has_locator
= false;
355 /* Execution information window. */
356 struct tui_gen_win_info
*execution_info
= nullptr;
357 /* Used for horizontal scroll. */
358 int horizontal_offset
= 0;
359 struct tui_line_or_address start_line_or_addr
;
361 /* It is the resolved form as returned by symtab_to_fullname. */
362 char *fullname
= nullptr;
364 /* Architecture associated with code at this location. */
365 struct gdbarch
*gdbarch
= nullptr;
368 /* A TUI source window. */
370 struct tui_source_window
: public tui_source_window_base
373 : tui_source_window_base (SRC_WIN
)
377 DISABLE_COPY_AND_ASSIGN (tui_source_window
);
379 const char *name () const override
386 void do_scroll_vertical (int num_to_scroll
) override
;
389 /* A TUI disassembly window. */
391 struct tui_disasm_window
: public tui_source_window_base
394 : tui_source_window_base (DISASSEM_WIN
)
398 DISABLE_COPY_AND_ASSIGN (tui_disasm_window
);
400 const char *name () const override
402 return DISASSEM_NAME
;
407 void do_scroll_vertical (int num_to_scroll
) override
;
410 struct tui_data_window
: public tui_win_info
413 : tui_win_info (DATA_WIN
)
417 ~tui_data_window () override
;
418 DISABLE_COPY_AND_ASSIGN (tui_data_window
);
420 void clear_detail () override
;
421 void refresh_all () override
;
423 void set_new_height (int height
) override
;
425 void refresh_window () override
;
427 const char *name () const override
432 /* Start of data display content. */
433 tui_win_content data_content
= NULL
;
434 int data_content_count
= 0;
435 /* Start of regs display content. */
436 tui_win_content regs_content
= NULL
;
437 int regs_content_count
= 0;
438 int regs_column_count
= 0;
439 /* Should regs be displayed at all? */
440 bool display_regs
= false;
441 struct reggroup
*current_group
= nullptr;
445 void do_scroll_vertical (int num_to_scroll
) override
;
446 void do_scroll_horizontal (int num_to_scroll
) override
451 struct tui_cmd_window
: public tui_win_info
454 : tui_win_info (CMD_WIN
)
458 DISABLE_COPY_AND_ASSIGN (tui_cmd_window
);
460 void clear_detail () override
;
462 void make_visible (bool visible
) override
466 int max_height () const override
;
468 void refresh_window () override
472 const char *name () const override
481 void do_scroll_vertical (int num_to_scroll
) override
485 void do_scroll_horizontal (int num_to_scroll
) override
490 extern int tui_win_is_auxillary (enum tui_win_type win_type
);
494 extern struct tui_win_info
*tui_win_list
[MAX_MAJOR_WINDOWS
];
496 #define TUI_SRC_WIN ((tui_source_window_base *) tui_win_list[SRC_WIN])
497 #define TUI_DISASM_WIN ((tui_source_window_base *) tui_win_list[DISASSEM_WIN])
498 #define TUI_DATA_WIN ((tui_data_window *) tui_win_list[DATA_WIN])
499 #define TUI_CMD_WIN ((tui_cmd_window *) tui_win_list[CMD_WIN])
501 /* Data Manipulation Functions. */
502 extern void tui_initialize_static_data (void);
503 extern struct tui_win_info
*tui_alloc_win_info (enum tui_win_type
);
504 extern void tui_init_generic_part (struct tui_gen_win_info
*);
505 extern tui_win_content
tui_alloc_content (int, enum tui_win_type
);
506 extern int tui_add_content_elements (struct tui_gen_win_info
*,
508 extern void tui_free_win_content (struct tui_gen_win_info
*);
509 extern void tui_free_data_content (tui_win_content
, int);
510 extern void tui_free_all_source_wins_content (void);
511 extern struct tui_win_info
*tui_partial_win_by_name (const char *);
512 extern enum tui_layout_type
tui_current_layout (void);
513 extern void tui_set_current_layout_to (enum tui_layout_type
);
514 extern int tui_term_height (void);
515 extern void tui_set_term_height_to (int);
516 extern int tui_term_width (void);
517 extern void tui_set_term_width_to (int);
518 extern struct tui_gen_win_info
*tui_locator_win_info_ptr (void);
519 extern struct tui_gen_win_info
*tui_source_exec_info_win_ptr (void);
520 extern struct tui_gen_win_info
*tui_disassem_exec_info_win_ptr (void);
521 extern std::vector
<tui_source_window_base
*> &tui_source_windows ();
522 extern void tui_clear_source_windows (void);
523 extern void tui_clear_source_windows_detail (void);
524 extern void tui_add_to_source_windows (struct tui_source_window_base
*);
525 extern struct tui_win_info
*tui_win_with_focus (void);
526 extern void tui_set_win_with_focus (struct tui_win_info
*);
527 extern struct tui_layout_def
*tui_layout_def (void);
528 extern int tui_win_resized (void);
529 extern void tui_set_win_resized_to (int);
531 extern struct tui_win_info
*tui_next_win (struct tui_win_info
*);
532 extern struct tui_win_info
*tui_prev_win (struct tui_win_info
*);
534 extern unsigned int tui_tab_width
;
536 #endif /* TUI_TUI_DATA_H */