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 /* Generic window information. */
35 struct tui_gen_win_info
39 explicit tui_gen_win_info (enum tui_win_type t
)
46 virtual ~tui_gen_win_info ();
48 /* Call to refresh this window. */
49 virtual void refresh_window ();
51 /* Make this window visible or invisible. */
52 virtual void make_visible (bool visible
);
54 /* Return the name of this type of window. */
55 virtual const char *name () const
60 /* Reset this window. WIN_TYPE must match the existing type of this
61 window (it is only passed for self-test purposes). The other
62 parameters are used to set the window's size and position. */
63 void reset (enum tui_win_type win_type
,
64 int height
, int width
,
65 int origin_x
, int origin_y
);
68 WINDOW
*handle
= nullptr;
70 enum tui_win_type type
;
75 /* Origin of window. */
76 struct tui_point origin
= {0, 0};
77 /* Can it be used, or is it already used? */
78 int content_in_use
= FALSE
;
79 /* Viewport height. */
80 int viewport_height
= 0;
81 /* Index of last visible line. */
82 int last_visible_line
= 0;
83 /* Whether the window is visible or not. */
84 bool is_visible
= false;
85 /* Window title to display. */
86 char *title
= nullptr;
89 /* Whether or not a window should be drawn with a box. */
96 /* Constant definitions. */
97 #define DEFAULT_TAB_LEN 8
98 #define NO_SRC_STRING "[ No Source Available ]"
99 #define NO_DISASSEM_STRING "[ No Assembly Available ]"
100 #define NO_REGS_STRING "[ Register Values Unavailable ]"
101 #define NO_DATA_STRING "[ No Data Values Displayed ]"
102 #define MAX_CONTENT_COUNT 100
103 #define SRC_NAME "src"
104 #define CMD_NAME "cmd"
105 #define DATA_NAME "regs"
106 #define DISASSEM_NAME "asm"
107 #define TUI_NULL_STR ""
108 #define DEFAULT_HISTORY_COUNT 25
110 #define NO_HILITE FALSE
111 #define WITH_LOCATOR TRUE
112 #define NO_LOCATOR FALSE
113 #define EMPTY_SOURCE_PROMPT TRUE
114 #define NO_EMPTY_SOURCE_PROMPT FALSE
115 #define UNDEFINED_ITEM -1
116 #define MIN_WIN_HEIGHT 3
117 #define MIN_CMD_WIN_HEIGHT 3
119 /* Strings to display in the TUI status line. */
120 #define PROC_PREFIX "In: "
121 #define LINE_PREFIX "L"
122 #define PC_PREFIX "PC: "
123 #define SINGLE_KEY "(SingleKey)"
125 /* Minimum/Maximum length of some fields displayed in the TUI status
127 #define MIN_LINE_WIDTH 4 /* Use at least 4 digits for line
129 #define MIN_PROC_WIDTH 12
130 #define MAX_TARGET_WIDTH 10
131 #define MAX_PID_WIDTH 19
133 /* The kinds of layouts available. */
138 SRC_DISASSEM_COMMAND
,
140 DISASSEM_DATA_COMMAND
,
144 enum tui_line_or_address_kind
150 /* Structure describing source line or line address. */
151 struct tui_line_or_address
153 enum tui_line_or_address_kind loa
;
161 /* Current Layout definition. */
162 struct tui_layout_def
164 enum tui_win_type display_mode
;
167 /* Flags to tell what kind of breakpoint is at current line. */
170 TUI_BP_ENABLED
= 0x01,
171 TUI_BP_DISABLED
= 0x02,
173 TUI_BP_CONDITIONAL
= 0x08,
174 TUI_BP_HARDWARE
= 0x10
177 DEF_ENUM_FLAGS_TYPE (enum tui_bp_flag
, tui_bp_flags
);
179 /* Elements in the Source/Disassembly Window. */
180 struct tui_source_element
182 tui_source_element ()
184 line_or_addr
.loa
= LOA_LINE
;
185 line_or_addr
.u
.line_no
= 0;
188 ~tui_source_element ()
193 char *line
= nullptr;
194 struct tui_line_or_address line_or_addr
;
195 bool is_exec_point
= false;
196 tui_bp_flags break_mode
= 0;
201 # define MAX_LOCATOR_ELEMENT_LEN PATH_MAX
203 # define MAX_LOCATOR_ELEMENT_LEN 1024
206 /* Position of breakpoint markers in the exec info string. */
207 #define TUI_BP_HIT_POS 0
208 #define TUI_BP_BREAK_POS 1
209 #define TUI_EXEC_POS 2
210 #define TUI_EXECINFO_SIZE 4
212 typedef char tui_exec_info_content
[TUI_EXECINFO_SIZE
];
214 /* Execution info window class. */
216 struct tui_exec_info_window
: public tui_gen_win_info
218 tui_exec_info_window ()
219 : tui_gen_win_info (EXEC_INFO_WIN
)
223 ~tui_exec_info_window () override
228 /* Get or allocate contents. */
229 tui_exec_info_content
*maybe_allocate_content (int n_elements
);
231 /* Return the contents. */
232 const tui_exec_info_content
*get_content () const
239 tui_exec_info_content
*m_content
= nullptr;
242 /* Locator window class. */
244 struct tui_locator_window
: public tui_gen_win_info
246 tui_locator_window ()
247 : tui_gen_win_info (LOCATOR_WIN
)
253 char full_name
[MAX_LOCATOR_ELEMENT_LEN
];
254 char proc_name
[MAX_LOCATOR_ELEMENT_LEN
];
257 /* Architecture associated with code at this location. */
258 struct gdbarch
*gdbarch
= nullptr;
261 /* A data item window. */
263 struct tui_data_item_window
: public tui_gen_win_info
265 tui_data_item_window ()
266 : tui_gen_win_info (DATA_ITEM_WIN
)
270 ~tui_data_item_window () override
;
272 const char *name
= nullptr;
273 /* The register number, or data display number. */
274 int item_no
= UNDEFINED_ITEM
;
275 void *value
= nullptr;
276 bool highlight
= false;
277 char *content
= nullptr;
280 /* This defines information about each logical window. */
281 struct tui_win_info
: public tui_gen_win_info
285 explicit tui_win_info (enum tui_win_type type
);
286 DISABLE_COPY_AND_ASSIGN (tui_win_info
);
288 /* Scroll the contents vertically. This is only called via
289 forward_scroll and backward_scroll. */
290 virtual void do_scroll_vertical (int num_to_scroll
) = 0;
292 /* Scroll the contents horizontally. This is only called via
293 left_scroll and right_scroll. */
294 virtual void do_scroll_horizontal (int num_to_scroll
) = 0;
296 /* Called after make_visible_with_new_height sets the new height.
297 Should update the window. */
298 virtual void do_make_visible_with_new_height () = 0;
302 ~tui_win_info () override
306 /* Clear the pertinent detail in the window. */
307 virtual void clear_detail () = 0;
309 /* Return true if this window has the locator. */
310 virtual bool has_locator () const
315 /* Refresh this window and any associated windows. */
316 virtual void refresh ();
318 /* Called after all the TUI windows are refreshed, to let this
319 window have a chance to update itself further. */
320 virtual void refresh_all ()
324 /* Called after a TUI window is given a new height; this updates any
325 related auxiliary windows. */
326 virtual void set_new_height (int height
)
330 /* Compute the maximum height of this window. */
331 virtual int max_height () const;
333 /* Called after the tab width has been changed. */
334 virtual void update_tab_width ()
338 /* Make the window visible after the height has been changed. */
339 void make_visible_with_new_height ();
341 /* Set whether this window is highglighted. */
342 void set_highlight (bool highlight
)
344 is_highlighted
= highlight
;
347 /* Methods to scroll the contents of this window. Note that they
348 are named with "_scroll" coming at the end because the more
349 obvious "scroll_forward" is defined as a macro in term.h. */
350 void forward_scroll (int num_to_scroll
);
351 void backward_scroll (int num_to_scroll
);
352 void left_scroll (int num_to_scroll
);
353 void right_scroll (int num_to_scroll
);
355 /* Return true if this window can be scrolled, false otherwise. */
356 virtual bool can_scroll () const
361 /* Can this window ever be highlighted? */
362 bool can_highlight
= true;
364 /* Is this window highlighted? */
365 bool is_highlighted
= false;
368 /* The base class for all source-like windows, namely the source and
369 disassembly windows. */
371 struct tui_source_window_base
: public tui_win_info
374 explicit tui_source_window_base (enum tui_win_type type
);
375 ~tui_source_window_base () override
;
376 DISABLE_COPY_AND_ASSIGN (tui_source_window_base
);
378 void do_scroll_horizontal (int num_to_scroll
) override
;
379 void do_make_visible_with_new_height () override
;
383 void clear_detail () override
;
385 /* Return true if this window has the locator. */
386 bool has_locator () const override
388 return m_has_locator
;
391 void make_visible (bool visible
) override
;
392 void refresh () override
;
393 void refresh_all () override
;
395 /* Refill the source window's source cache and update it. If this
396 is a disassembly window, then just update it. */
399 /* Set the location of the execution point. */
400 void set_is_exec_point_at (struct tui_line_or_address l
);
402 void set_new_height (int height
) override
;
404 void update_tab_width () override
;
406 /* Does the locator belong to this window? */
407 bool m_has_locator
= false;
408 /* Execution information window. */
409 struct tui_exec_info_window
*execution_info
= nullptr;
410 /* Used for horizontal scroll. */
411 int horizontal_offset
= 0;
412 struct tui_line_or_address start_line_or_addr
;
414 /* It is the resolved form as returned by symtab_to_fullname. */
415 char *fullname
= nullptr;
417 /* Architecture associated with code at this location. */
418 struct gdbarch
*gdbarch
= nullptr;
420 std::vector
<tui_source_element
> content
;
423 /* A TUI source window. */
425 struct tui_source_window
: public tui_source_window_base
428 : tui_source_window_base (SRC_WIN
)
432 DISABLE_COPY_AND_ASSIGN (tui_source_window
);
434 const char *name () const override
441 void do_scroll_vertical (int num_to_scroll
) override
;
444 /* A TUI disassembly window. */
446 struct tui_disasm_window
: public tui_source_window_base
449 : tui_source_window_base (DISASSEM_WIN
)
453 DISABLE_COPY_AND_ASSIGN (tui_disasm_window
);
455 const char *name () const override
457 return DISASSEM_NAME
;
462 void do_scroll_vertical (int num_to_scroll
) override
;
465 struct tui_data_window
: public tui_win_info
468 : tui_win_info (DATA_WIN
)
472 DISABLE_COPY_AND_ASSIGN (tui_data_window
);
474 void clear_detail () override
;
475 void refresh_all () override
;
477 void set_new_height (int height
) override
;
479 void refresh_window () override
;
481 const char *name () const override
486 /* Windows that are used to display registers. */
487 std::vector
<std::unique_ptr
<tui_data_item_window
>> regs_content
;
488 int regs_column_count
= 0;
489 /* Should regs be displayed at all? */
490 bool display_regs
= false;
491 struct reggroup
*current_group
= nullptr;
493 /* Answer the number of the last line in the regs display. If there
494 are no registers (-1) is returned. */
495 int last_regs_line_no () const;
497 /* Answer the line number that the register element at element_no is
498 on. If element_no is greater than the number of register
499 elements there are, -1 is returned. */
500 int line_from_reg_element_no (int element_no
) const;
502 /* Answer the index of the first element in line_no. If line_no is
503 past the register area (-1) is returned. */
504 int first_reg_element_no_inline (int line_no
) const;
506 /* Displays the data that is in the data window's content. It does
507 not set the content. */
508 void display_all_data ();
510 /* Delete all the item windows in the data window. This is usually
511 done when the data window is scrolled. */
512 void delete_data_content_windows ();
514 void erase_data_content (const char *prompt
);
516 /* Display the registers in the content from 'start_element_no'
517 until the end of the register content or the end of the display
518 height. No checking for displaying past the end of the registers
520 void display_registers_from (int start_element_no
);
522 /* Display the registers starting at line line_no in the data
523 window. Answers the line number that the display actually
524 started from. If nothing is displayed (-1) is returned. */
525 int display_registers_from_line (int line_no
);
529 void do_scroll_vertical (int num_to_scroll
) override
;
530 void do_scroll_horizontal (int num_to_scroll
) override
533 void do_make_visible_with_new_height () override
;
535 /* Return the index of the first element displayed. If none are
536 displayed, then return -1. */
537 int first_data_item_displayed ();
539 /* Display the registers in the content from 'start_element_no' on
540 'start_line_no' until the end of the register content or the end
541 of the display height. This function checks that we won't
542 display off the end of the register display. */
543 void display_reg_element_at_line (int start_element_no
, int start_line_no
);
546 struct tui_cmd_window
: public tui_win_info
549 : tui_win_info (CMD_WIN
)
551 can_highlight
= false;
554 DISABLE_COPY_AND_ASSIGN (tui_cmd_window
);
556 void clear_detail () override
;
558 void make_visible (bool visible
) override
562 int max_height () const override
;
564 void refresh_window () override
568 const char *name () const override
573 bool can_scroll () const override
582 void do_scroll_vertical (int num_to_scroll
) override
586 void do_scroll_horizontal (int num_to_scroll
) override
590 void do_make_visible_with_new_height () override
;
593 extern int tui_win_is_auxiliary (enum tui_win_type win_type
);
597 extern struct tui_win_info
*tui_win_list
[MAX_MAJOR_WINDOWS
];
599 #define TUI_SRC_WIN ((tui_source_window_base *) tui_win_list[SRC_WIN])
600 #define TUI_DISASM_WIN ((tui_source_window_base *) tui_win_list[DISASSEM_WIN])
601 #define TUI_DATA_WIN ((tui_data_window *) tui_win_list[DATA_WIN])
602 #define TUI_CMD_WIN ((tui_cmd_window *) tui_win_list[CMD_WIN])
604 /* An iterator that iterates over all windows. */
606 class tui_window_iterator
610 typedef tui_window_iterator self_type
;
611 typedef struct tui_win_info
*value_type
;
612 typedef struct tui_win_info
*&reference
;
613 typedef struct tui_win_info
**pointer
;
614 typedef std::forward_iterator_tag iterator_category
;
615 typedef int difference_type
;
617 explicit tui_window_iterator (enum tui_win_type type
)
623 tui_window_iterator ()
624 : m_type (MAX_MAJOR_WINDOWS
)
628 bool operator!= (const self_type
&other
) const
630 return m_type
!= other
.m_type
;
633 value_type
operator* () const
635 gdb_assert (m_type
< MAX_MAJOR_WINDOWS
);
636 return tui_win_list
[m_type
];
639 self_type
&operator++ ()
650 while (m_type
< MAX_MAJOR_WINDOWS
&& tui_win_list
[m_type
] == nullptr)
657 /* A range adapter for iterating over TUI windows. */
659 struct all_tui_windows
661 tui_window_iterator
begin () const
663 return tui_window_iterator (SRC_WIN
);
666 tui_window_iterator
end () const
668 return tui_window_iterator ();
673 /* Data Manipulation Functions. */
674 extern void tui_initialize_static_data (void);
675 extern struct tui_win_info
*tui_partial_win_by_name (const char *);
676 extern enum tui_layout_type
tui_current_layout (void);
677 extern void tui_set_current_layout_to (enum tui_layout_type
);
678 extern int tui_term_height (void);
679 extern void tui_set_term_height_to (int);
680 extern int tui_term_width (void);
681 extern void tui_set_term_width_to (int);
682 extern struct tui_locator_window
*tui_locator_win_info_ptr (void);
683 extern std::vector
<tui_source_window_base
*> &tui_source_windows ();
684 extern void tui_clear_source_windows (void);
685 extern void tui_clear_source_windows_detail (void);
686 extern void tui_add_to_source_windows (struct tui_source_window_base
*);
687 extern struct tui_win_info
*tui_win_with_focus (void);
688 extern void tui_set_win_with_focus (struct tui_win_info
*);
689 extern struct tui_layout_def
*tui_layout_def (void);
690 extern int tui_win_resized (void);
691 extern void tui_set_win_resized_to (int);
693 extern struct tui_win_info
*tui_next_win (struct tui_win_info
*);
694 extern struct tui_win_info
*tui_prev_win (struct tui_win_info
*);
696 extern unsigned int tui_tab_width
;
698 #endif /* TUI_TUI_DATA_H */