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. */
27 #include "observable.h"
29 /* This is a point definition. */
35 /* Generic window information. */
36 struct tui_gen_win_info
40 explicit tui_gen_win_info (enum tui_win_type t
)
47 virtual ~tui_gen_win_info ();
49 /* Call to refresh this window. */
50 virtual void refresh_window ();
52 /* Make this window visible or invisible. */
53 virtual void make_visible (bool visible
);
55 /* Return the name of this type of window. */
56 virtual const char *name () const
61 /* Reset this window. The parameters are used to set the window's
63 virtual void reset (int height
, int width
,
64 int origin_x
, int origin_y
);
67 WINDOW
*handle
= nullptr;
69 enum tui_win_type type
;
74 /* Origin of window. */
75 struct tui_point origin
= {0, 0};
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 /* Whether or not a window should be drawn with a box. */
93 /* Constant definitions. */
94 #define DEFAULT_TAB_LEN 8
95 #define NO_SRC_STRING "[ No Source Available ]"
96 #define NO_DISASSEM_STRING "[ No Assembly Available ]"
97 #define NO_REGS_STRING "[ Register Values Unavailable ]"
98 #define NO_DATA_STRING "[ No Data Values Displayed ]"
99 #define SRC_NAME "src"
100 #define CMD_NAME "cmd"
101 #define DATA_NAME "regs"
102 #define DISASSEM_NAME "asm"
104 #define NO_HILITE FALSE
105 #define MIN_WIN_HEIGHT 3
106 #define MIN_CMD_WIN_HEIGHT 3
108 /* Strings to display in the TUI status line. */
109 #define PROC_PREFIX "In: "
110 #define LINE_PREFIX "L"
111 #define PC_PREFIX "PC: "
112 #define SINGLE_KEY "(SingleKey)"
114 /* Minimum/Maximum length of some fields displayed in the TUI status
116 #define MIN_LINE_WIDTH 4 /* Use at least 4 digits for line
118 #define MIN_PROC_WIDTH 12
119 #define MAX_TARGET_WIDTH 10
120 #define MAX_PID_WIDTH 19
122 /* The kinds of layouts available. */
127 SRC_DISASSEM_COMMAND
,
129 DISASSEM_DATA_COMMAND
,
133 enum tui_line_or_address_kind
139 /* Structure describing source line or line address. */
140 struct tui_line_or_address
142 enum tui_line_or_address_kind loa
;
150 /* Current Layout definition. */
151 struct tui_layout_def
153 enum tui_win_type display_mode
;
156 /* Flags to tell what kind of breakpoint is at current line. */
159 TUI_BP_ENABLED
= 0x01,
160 TUI_BP_DISABLED
= 0x02,
162 TUI_BP_CONDITIONAL
= 0x08,
163 TUI_BP_HARDWARE
= 0x10
166 DEF_ENUM_FLAGS_TYPE (enum tui_bp_flag
, tui_bp_flags
);
168 /* Elements in the Source/Disassembly Window. */
169 struct tui_source_element
171 tui_source_element ()
173 line_or_addr
.loa
= LOA_LINE
;
174 line_or_addr
.u
.line_no
= 0;
177 ~tui_source_element ()
182 char *line
= nullptr;
183 struct tui_line_or_address line_or_addr
;
184 bool is_exec_point
= false;
185 tui_bp_flags break_mode
= 0;
190 # define MAX_LOCATOR_ELEMENT_LEN PATH_MAX
192 # define MAX_LOCATOR_ELEMENT_LEN 1024
195 /* Position of breakpoint markers in the exec info string. */
196 #define TUI_BP_HIT_POS 0
197 #define TUI_BP_BREAK_POS 1
198 #define TUI_EXEC_POS 2
199 #define TUI_EXECINFO_SIZE 4
201 typedef char tui_exec_info_content
[TUI_EXECINFO_SIZE
];
203 /* Execution info window class. */
205 struct tui_exec_info_window
: public tui_gen_win_info
207 tui_exec_info_window ()
208 : tui_gen_win_info (EXEC_INFO_WIN
)
212 ~tui_exec_info_window () override
217 /* Get or allocate contents. */
218 tui_exec_info_content
*maybe_allocate_content (int n_elements
);
220 /* Return the contents. */
221 const tui_exec_info_content
*get_content () const
228 tui_exec_info_content
*m_content
= nullptr;
231 /* Locator window class. */
233 struct tui_locator_window
: public tui_gen_win_info
235 tui_locator_window ()
236 : tui_gen_win_info (LOCATOR_WIN
)
242 char full_name
[MAX_LOCATOR_ELEMENT_LEN
];
243 char proc_name
[MAX_LOCATOR_ELEMENT_LEN
];
246 /* Architecture associated with code at this location. */
247 struct gdbarch
*gdbarch
= nullptr;
250 /* A data item window. */
252 struct tui_data_item_window
: public tui_gen_win_info
254 tui_data_item_window ()
255 : tui_gen_win_info (DATA_ITEM_WIN
)
259 ~tui_data_item_window () override
;
261 const char *name
= nullptr;
262 /* The register number, or data display number. */
264 void *value
= nullptr;
265 bool highlight
= false;
266 char *content
= nullptr;
269 /* This defines information about each logical window. */
270 struct tui_win_info
: public tui_gen_win_info
274 explicit tui_win_info (enum tui_win_type type
);
275 DISABLE_COPY_AND_ASSIGN (tui_win_info
);
277 /* Scroll the contents vertically. This is only called via
278 forward_scroll and backward_scroll. */
279 virtual void do_scroll_vertical (int num_to_scroll
) = 0;
281 /* Scroll the contents horizontally. This is only called via
282 left_scroll and right_scroll. */
283 virtual void do_scroll_horizontal (int num_to_scroll
) = 0;
285 /* Called after make_visible_with_new_height sets the new height.
286 Should update the window. */
287 virtual void do_make_visible_with_new_height () = 0;
291 ~tui_win_info () override
295 /* Clear the pertinent detail in the window. */
296 virtual void clear_detail () = 0;
298 /* Return true if this window has the locator. */
299 virtual bool has_locator () const
304 /* Called after all the TUI windows are refreshed, to let this
305 window have a chance to update itself further. */
306 virtual void refresh_all ()
310 /* Called after a TUI window is given a new height; this updates any
311 related auxiliary windows. */
312 virtual void set_new_height (int height
)
316 /* Compute the maximum height of this window. */
317 virtual int max_height () const;
319 /* Called after the tab width has been changed. */
320 virtual void update_tab_width ()
324 /* Make the window visible after the height has been changed. */
325 void make_visible_with_new_height ();
327 /* Set whether this window is highglighted. */
328 void set_highlight (bool highlight
)
330 is_highlighted
= highlight
;
333 /* Methods to scroll the contents of this window. Note that they
334 are named with "_scroll" coming at the end because the more
335 obvious "scroll_forward" is defined as a macro in term.h. */
336 void forward_scroll (int num_to_scroll
);
337 void backward_scroll (int num_to_scroll
);
338 void left_scroll (int num_to_scroll
);
339 void right_scroll (int num_to_scroll
);
341 /* Return true if this window can be scrolled, false otherwise. */
342 virtual bool can_scroll () const
347 /* Can this window ever be highlighted? */
348 bool can_highlight
= true;
350 /* Is this window highlighted? */
351 bool is_highlighted
= false;
354 /* The base class for all source-like windows, namely the source and
355 disassembly windows. */
357 struct tui_source_window_base
: public tui_win_info
360 explicit tui_source_window_base (enum tui_win_type type
);
361 ~tui_source_window_base () override
;
362 DISABLE_COPY_AND_ASSIGN (tui_source_window_base
);
364 void do_scroll_horizontal (int num_to_scroll
) override
;
365 void do_make_visible_with_new_height () override
;
369 void clear_detail () override
;
371 /* Return true if this window has the locator. */
372 bool has_locator () const override
374 return m_has_locator
;
377 void make_visible (bool visible
) override
;
378 void refresh_window () override
;
379 void refresh_all () override
;
381 /* Refill the source window's source cache and update it. If this
382 is a disassembly window, then just update it. */
385 /* Set the location of the execution point. */
386 void set_is_exec_point_at (struct tui_line_or_address l
);
388 void set_new_height (int height
) override
;
390 void update_tab_width () override
;
392 /* Return true if the location LOC corresponds to the line number
393 LINE_NO in this source window; false otherwise. */
394 virtual bool location_matches_p (struct bp_location
*loc
, int line_no
) = 0;
396 void reset (int height
, int width
,
397 int origin_x
, int origin_y
) override
;
399 /* Does the locator belong to this window? */
400 bool m_has_locator
= false;
401 /* Execution information window. */
402 struct tui_exec_info_window
*execution_info
;
403 /* Used for horizontal scroll. */
404 int horizontal_offset
= 0;
405 struct tui_line_or_address start_line_or_addr
;
407 /* It is the resolved form as returned by symtab_to_fullname. */
408 char *fullname
= nullptr;
410 /* Architecture associated with code at this location. */
411 struct gdbarch
*gdbarch
= nullptr;
413 std::vector
<tui_source_element
> content
;
416 /* A TUI source window. */
418 struct tui_source_window
: public tui_source_window_base
420 tui_source_window ();
421 ~tui_source_window ();
423 DISABLE_COPY_AND_ASSIGN (tui_source_window
);
425 const char *name () const override
430 bool location_matches_p (struct bp_location
*loc
, int line_no
) override
;
432 bool showing_source_p (const char *filename
) const;
436 void do_scroll_vertical (int num_to_scroll
) override
;
440 void style_changed ();
442 /* A token used to register and unregister an observer. */
443 gdb::observers::token m_observable
;
446 /* A TUI disassembly window. */
448 struct tui_disasm_window
: public tui_source_window_base
451 : tui_source_window_base (DISASSEM_WIN
)
455 DISABLE_COPY_AND_ASSIGN (tui_disasm_window
);
457 const char *name () const override
459 return DISASSEM_NAME
;
462 bool location_matches_p (struct bp_location
*loc
, int line_no
) override
;
466 void do_scroll_vertical (int num_to_scroll
) override
;
469 struct tui_data_window
: public tui_win_info
472 : tui_win_info (DATA_WIN
)
476 DISABLE_COPY_AND_ASSIGN (tui_data_window
);
478 void clear_detail () override
;
479 void refresh_all () override
;
481 void set_new_height (int height
) override
;
483 void refresh_window () override
;
485 const char *name () const override
490 /* Windows that are used to display registers. */
491 std::vector
<std::unique_ptr
<tui_data_item_window
>> regs_content
;
492 int regs_column_count
= 0;
493 /* Should regs be displayed at all? */
494 bool display_regs
= false;
495 struct reggroup
*current_group
= nullptr;
497 /* Answer the number of the last line in the regs display. If there
498 are no registers (-1) is returned. */
499 int last_regs_line_no () const;
501 /* Answer the line number that the register element at element_no is
502 on. If element_no is greater than the number of register
503 elements there are, -1 is returned. */
504 int line_from_reg_element_no (int element_no
) const;
506 /* Answer the index of the first element in line_no. If line_no is
507 past the register area (-1) is returned. */
508 int first_reg_element_no_inline (int line_no
) const;
510 /* Displays the data that is in the data window's content. It does
511 not set the content. */
512 void display_all_data ();
514 /* Delete all the item windows in the data window. This is usually
515 done when the data window is scrolled. */
516 void delete_data_content_windows ();
518 void erase_data_content (const char *prompt
);
520 /* Display the registers in the content from 'start_element_no'
521 until the end of the register content or the end of the display
522 height. No checking for displaying past the end of the registers
524 void display_registers_from (int start_element_no
);
526 /* Display the registers starting at line line_no in the data
527 window. Answers the line number that the display actually
528 started from. If nothing is displayed (-1) is returned. */
529 int display_registers_from_line (int line_no
);
533 void do_scroll_vertical (int num_to_scroll
) override
;
534 void do_scroll_horizontal (int num_to_scroll
) override
537 void do_make_visible_with_new_height () override
;
539 /* Return the index of the first element displayed. If none are
540 displayed, then return -1. */
541 int first_data_item_displayed ();
543 /* Display the registers in the content from 'start_element_no' on
544 'start_line_no' until the end of the register content or the end
545 of the display height. This function checks that we won't
546 display off the end of the register display. */
547 void display_reg_element_at_line (int start_element_no
, int start_line_no
);
550 struct tui_cmd_window
: public tui_win_info
553 : tui_win_info (CMD_WIN
)
555 can_highlight
= false;
558 DISABLE_COPY_AND_ASSIGN (tui_cmd_window
);
560 void clear_detail () override
;
562 void make_visible (bool visible
) override
566 int max_height () const override
;
568 void refresh_window () override
572 const char *name () const override
577 bool can_scroll () const override
586 void do_scroll_vertical (int num_to_scroll
) override
590 void do_scroll_horizontal (int num_to_scroll
) override
594 void do_make_visible_with_new_height () override
;
597 extern int tui_win_is_auxiliary (enum tui_win_type win_type
);
601 extern struct tui_win_info
*tui_win_list
[MAX_MAJOR_WINDOWS
];
603 #define TUI_SRC_WIN ((tui_source_window *) tui_win_list[SRC_WIN])
604 #define TUI_DISASM_WIN ((tui_source_window_base *) tui_win_list[DISASSEM_WIN])
605 #define TUI_DATA_WIN ((tui_data_window *) tui_win_list[DATA_WIN])
606 #define TUI_CMD_WIN ((tui_cmd_window *) tui_win_list[CMD_WIN])
608 /* An iterator that iterates over all windows. */
610 class tui_window_iterator
614 typedef tui_window_iterator self_type
;
615 typedef struct tui_win_info
*value_type
;
616 typedef struct tui_win_info
*&reference
;
617 typedef struct tui_win_info
**pointer
;
618 typedef std::forward_iterator_tag iterator_category
;
619 typedef int difference_type
;
621 explicit tui_window_iterator (enum tui_win_type type
)
627 tui_window_iterator ()
628 : m_type (MAX_MAJOR_WINDOWS
)
632 bool operator!= (const self_type
&other
) const
634 return m_type
!= other
.m_type
;
637 value_type
operator* () const
639 gdb_assert (m_type
< MAX_MAJOR_WINDOWS
);
640 return tui_win_list
[m_type
];
643 self_type
&operator++ ()
654 while (m_type
< MAX_MAJOR_WINDOWS
&& tui_win_list
[m_type
] == nullptr)
661 /* A range adapter for iterating over TUI windows. */
663 struct all_tui_windows
665 tui_window_iterator
begin () const
667 return tui_window_iterator (SRC_WIN
);
670 tui_window_iterator
end () const
672 return tui_window_iterator ();
677 /* Data Manipulation Functions. */
678 extern void tui_initialize_static_data (void);
679 extern struct tui_win_info
*tui_partial_win_by_name (const char *);
680 extern enum tui_layout_type
tui_current_layout (void);
681 extern void tui_set_current_layout_to (enum tui_layout_type
);
682 extern int tui_term_height (void);
683 extern void tui_set_term_height_to (int);
684 extern int tui_term_width (void);
685 extern void tui_set_term_width_to (int);
686 extern struct tui_locator_window
*tui_locator_win_info_ptr (void);
687 extern std::vector
<tui_source_window_base
*> &tui_source_windows ();
688 extern void tui_clear_source_windows (void);
689 extern void tui_clear_source_windows_detail (void);
690 extern void tui_add_to_source_windows (struct tui_source_window_base
*);
691 extern struct tui_win_info
*tui_win_with_focus (void);
692 extern void tui_set_win_with_focus (struct tui_win_info
*);
693 extern struct tui_layout_def
*tui_layout_def (void);
694 extern int tui_win_resized (void);
695 extern void tui_set_win_resized_to (int);
697 extern struct tui_win_info
*tui_next_win (struct tui_win_info
*);
698 extern struct tui_win_info
*tui_prev_win (struct tui_win_info
*);
700 extern unsigned int tui_tab_width
;
702 #endif /* TUI_TUI_DATA_H */