1 /* TUI data manipulation routines.
3 Copyright (C) 1998-2020 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 struct tui_cmd_window
;
30 struct tui_source_window_base
;
31 struct tui_source_window
;
33 /* A deleter that calls delwin. */
36 void operator() (WINDOW
*win
) const
42 /* Generic window information. */
43 struct tui_gen_win_info
47 explicit tui_gen_win_info (enum tui_win_type t
)
52 /* This is called after the window is resized, and should update the
54 virtual void rerender ()
58 virtual void make_window ();
61 tui_gen_win_info (tui_gen_win_info
&&) = default;
63 virtual ~tui_gen_win_info ()
67 /* Call to refresh this window. */
68 virtual void refresh_window ();
70 /* Make this window visible or invisible. */
71 virtual void make_visible (bool visible
);
73 /* Return the name of this type of window. */
74 virtual const char *name () const
79 /* Compute the maximum height of this window. */
80 virtual int max_height () const = 0;
82 /* Compute the minimum height of this window. */
83 virtual int min_height () const = 0;
85 /* Return true if this window can be boxed. */
86 virtual bool can_box () const
91 /* Resize this window. The parameters are used to set the window's
93 virtual void resize (int height
, int width
,
94 int origin_x
, int origin_y
);
96 /* Return true if this window is visible. */
97 bool is_visible () const
99 return handle
!= nullptr;
102 /* Disable output until the next call to doupdate. */
103 virtual void no_refresh ()
105 if (handle
!= nullptr)
106 wnoutrefresh (handle
.get ());
110 std::unique_ptr
<WINDOW
, curses_deleter
> handle
;
111 /* Type of window. */
112 enum tui_win_type type
;
117 /* Origin of window. */
122 /* Constant definitions. */
123 #define DEFAULT_TAB_LEN 8
124 #define SRC_NAME "src"
125 #define CMD_NAME "cmd"
126 #define DATA_NAME "regs"
127 #define DISASSEM_NAME "asm"
128 #define MIN_WIN_HEIGHT 3
129 #define MIN_CMD_WIN_HEIGHT 3
131 /* Strings to display in the TUI status line. */
132 #define SINGLE_KEY "(SingleKey)"
134 /* The kinds of layouts available. */
139 SRC_DISASSEM_COMMAND
,
141 DISASSEM_DATA_COMMAND
,
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 /* This defines information about each logical window. */
163 struct tui_win_info
: public tui_gen_win_info
167 explicit tui_win_info (enum tui_win_type type
);
168 DISABLE_COPY_AND_ASSIGN (tui_win_info
);
170 /* Scroll the contents vertically. This is only called via
171 forward_scroll and backward_scroll. */
172 virtual void do_scroll_vertical (int num_to_scroll
) = 0;
174 /* Scroll the contents horizontally. This is only called via
175 left_scroll and right_scroll. */
176 virtual void do_scroll_horizontal (int num_to_scroll
) = 0;
178 void rerender () override
;
180 void make_window () override
;
184 ~tui_win_info () override
188 int max_height () const override
;
190 int min_height () const override
192 return MIN_WIN_HEIGHT
;
195 /* Called after the tab width has been changed. */
196 virtual void update_tab_width ()
200 /* Set whether this window is highlighted. */
201 void set_highlight (bool highlight
)
203 is_highlighted
= highlight
;
206 /* Methods to scroll the contents of this window. Note that they
207 are named with "_scroll" coming at the end because the more
208 obvious "scroll_forward" is defined as a macro in term.h. */
209 void forward_scroll (int num_to_scroll
);
210 void backward_scroll (int num_to_scroll
);
211 void left_scroll (int num_to_scroll
);
212 void right_scroll (int num_to_scroll
);
214 /* Return true if this window can be scrolled, false otherwise. */
215 virtual bool can_scroll () const
220 bool can_box () const override
225 void check_and_display_highlight_if_needed ();
227 /* Window title to display. */
230 /* Is this window highlighted? */
231 bool is_highlighted
= false;
236 extern struct tui_win_info
*tui_win_list
[MAX_MAJOR_WINDOWS
];
238 #define TUI_SRC_WIN ((tui_source_window *) tui_win_list[SRC_WIN])
239 #define TUI_DISASM_WIN ((tui_source_window_base *) tui_win_list[DISASSEM_WIN])
240 #define TUI_DATA_WIN ((tui_data_window *) tui_win_list[DATA_WIN])
241 #define TUI_CMD_WIN ((tui_cmd_window *) tui_win_list[CMD_WIN])
243 /* An iterator that iterates over all windows. */
245 class tui_window_iterator
249 typedef tui_window_iterator self_type
;
250 typedef struct tui_win_info
*value_type
;
251 typedef struct tui_win_info
*&reference
;
252 typedef struct tui_win_info
**pointer
;
253 typedef std::forward_iterator_tag iterator_category
;
254 typedef int difference_type
;
256 explicit tui_window_iterator (enum tui_win_type type
)
262 tui_window_iterator ()
263 : m_type (MAX_MAJOR_WINDOWS
)
267 bool operator!= (const self_type
&other
) const
269 return m_type
!= other
.m_type
;
272 value_type
operator* () const
274 gdb_assert (m_type
< MAX_MAJOR_WINDOWS
);
275 return tui_win_list
[m_type
];
278 self_type
&operator++ ()
289 while (m_type
< MAX_MAJOR_WINDOWS
&& tui_win_list
[m_type
] == nullptr)
296 /* A range adapter for iterating over TUI windows. */
298 struct all_tui_windows
300 tui_window_iterator
begin () const
302 return tui_window_iterator (SRC_WIN
);
305 tui_window_iterator
end () const
307 return tui_window_iterator ();
312 /* Data Manipulation Functions. */
313 extern enum tui_layout_type
tui_current_layout (void);
314 extern int tui_term_height (void);
315 extern void tui_set_term_height_to (int);
316 extern int tui_term_width (void);
317 extern void tui_set_term_width_to (int);
318 extern struct tui_locator_window
*tui_locator_win_info_ptr (void);
319 extern struct tui_win_info
*tui_win_with_focus (void);
320 extern void tui_set_win_with_focus (struct tui_win_info
*);
321 extern bool tui_win_resized ();
322 extern void tui_set_win_resized_to (bool);
324 extern struct tui_win_info
*tui_next_win (struct tui_win_info
*);
325 extern struct tui_win_info
*tui_prev_win (struct tui_win_info
*);
327 /* Delete all the invisible windows. Note that it is an error to call
328 this when the command window is invisible -- we don't allow the
329 command window to be removed from the layout. */
330 extern void tui_delete_invisible_windows ();
332 extern unsigned int tui_tab_width
;
334 #endif /* TUI_TUI_DATA_H */