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
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 tui_gen_win_info () = default;
49 /* This is called after the window is resized, and should update the
51 virtual void rerender ()
55 virtual void make_window ();
58 tui_gen_win_info (tui_gen_win_info
&&) = default;
60 virtual ~tui_gen_win_info ()
64 /* Call to refresh this window. */
65 virtual void refresh_window ();
67 /* Make this window visible or invisible. */
68 virtual void make_visible (bool visible
);
70 /* Return the name of this type of window. */
71 virtual const char *name () const
76 /* Compute the maximum height of this window. */
77 virtual int max_height () const = 0;
79 /* Compute the minimum height of this window. */
80 virtual int min_height () const = 0;
82 /* Compute the maximum width of this window. */
83 int max_width () const;
85 /* Compute the minimum width of this window. */
86 int min_width () const
91 /* Return true if this window can be boxed. */
92 virtual bool can_box () const
97 /* Resize this window. The parameters are used to set the window's
99 virtual void resize (int height
, int width
,
100 int origin_x
, int origin_y
);
102 /* Return true if this window is visible. */
103 bool is_visible () const
105 return handle
!= nullptr;
108 /* Disable output until the next call to doupdate. */
109 virtual void no_refresh ()
111 if (handle
!= nullptr)
112 wnoutrefresh (handle
.get ());
116 std::unique_ptr
<WINDOW
, curses_deleter
> handle
;
121 /* Origin of window. */
126 /* Constant definitions. */
127 #define DEFAULT_TAB_LEN 8
128 #define SRC_NAME "src"
129 #define CMD_NAME "cmd"
130 #define DATA_NAME "regs"
131 #define DISASSEM_NAME "asm"
132 #define MIN_WIN_HEIGHT 3
133 #define MIN_CMD_WIN_HEIGHT 3
135 /* Strings to display in the TUI status line. */
136 #define SINGLE_KEY "(SingleKey)"
138 enum tui_line_or_address_kind
144 /* Structure describing source line or line address. */
145 struct tui_line_or_address
147 enum tui_line_or_address_kind loa
;
155 /* This defines information about each logical window. */
156 struct tui_win_info
: public tui_gen_win_info
160 tui_win_info () = default;
161 DISABLE_COPY_AND_ASSIGN (tui_win_info
);
163 /* Scroll the contents vertically. This is only called via
164 forward_scroll and backward_scroll. */
165 virtual void do_scroll_vertical (int num_to_scroll
) = 0;
167 /* Scroll the contents horizontally. This is only called via
168 left_scroll and right_scroll. */
169 virtual void do_scroll_horizontal (int num_to_scroll
) = 0;
171 void rerender () override
;
173 void make_window () override
;
177 ~tui_win_info () override
181 int max_height () const override
;
183 int min_height () const override
185 return MIN_WIN_HEIGHT
;
188 /* Called after the tab width has been changed. */
189 virtual void update_tab_width ()
193 /* Set whether this window is highlighted. */
194 void set_highlight (bool highlight
)
196 is_highlighted
= highlight
;
199 /* Methods to scroll the contents of this window. Note that they
200 are named with "_scroll" coming at the end because the more
201 obvious "scroll_forward" is defined as a macro in term.h. */
202 void forward_scroll (int num_to_scroll
);
203 void backward_scroll (int num_to_scroll
);
204 void left_scroll (int num_to_scroll
);
205 void right_scroll (int num_to_scroll
);
207 /* Return true if this window can be scrolled, false otherwise. */
208 virtual bool can_scroll () const
213 bool can_box () const override
218 void check_and_display_highlight_if_needed ();
220 /* Window title to display. */
223 /* Is this window highlighted? */
224 bool is_highlighted
= false;
229 extern struct tui_win_info
*tui_win_list
[MAX_MAJOR_WINDOWS
];
231 #define TUI_SRC_WIN ((tui_source_window *) tui_win_list[SRC_WIN])
232 #define TUI_DISASM_WIN ((tui_source_window_base *) tui_win_list[DISASSEM_WIN])
233 #define TUI_DATA_WIN ((tui_data_window *) tui_win_list[DATA_WIN])
234 #define TUI_CMD_WIN ((tui_cmd_window *) tui_win_list[CMD_WIN])
236 /* All the windows that are currently instantiated, in layout
238 extern std::vector
<tui_win_info
*> tui_windows
;
240 /* Return a range adapter for iterating over TUI windows. */
241 static inline std::vector
<tui_win_info
*> &
247 /* Data Manipulation Functions. */
248 extern int tui_term_height (void);
249 extern void tui_set_term_height_to (int);
250 extern int tui_term_width (void);
251 extern void tui_set_term_width_to (int);
252 extern struct tui_locator_window
*tui_locator_win_info_ptr (void);
253 extern struct tui_win_info
*tui_win_with_focus (void);
254 extern bool tui_win_resized ();
255 extern void tui_set_win_resized_to (bool);
257 extern struct tui_win_info
*tui_next_win (struct tui_win_info
*);
258 extern struct tui_win_info
*tui_prev_win (struct tui_win_info
*);
260 extern unsigned int tui_tab_width
;
262 #endif /* TUI_TUI_DATA_H */