GDB (xrefs)
Loading...
Searching...
No Matches
tui-data.h
Go to the documentation of this file.
1/* TUI data manipulation routines.
2
3 Copyright (C) 1998-2023 Free Software Foundation, Inc.
4
5 Contributed by Hewlett-Packard Company.
6
7 This file is part of GDB.
8
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.
13
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.
18
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/>. */
21
22#ifndef TUI_TUI_DATA_H
23#define TUI_TUI_DATA_H
24
25#include "tui/tui.h"
26#include "gdb_curses.h"
27#include "observable.h"
28
29/* A deleter that calls delwin. */
31{
32 void operator() (WINDOW *win) const
33 {
34 delwin (win);
35 }
36};
37
38#define MIN_WIN_HEIGHT 3
39
40/* Generic window information. */
42{
43protected:
44
45 tui_win_info () = default;
47
48 /* This is called after the window is resized, and should update the
49 window's contents. */
50 virtual void rerender ();
51
52 virtual void make_window ();
53
54public:
55 tui_win_info (tui_win_info &&) = default;
56 virtual ~tui_win_info () = default;
57
58 /* Call to refresh this window. */
59 virtual void refresh_window ();
60
61 /* Make this window visible or invisible. */
62 virtual void make_visible (bool visible);
63
64 /* Return the name of this type of window. */
65 virtual const char *name () const = 0;
66
67 /* Compute the maximum height of this window. */
68 virtual int max_height () const;
69
70 /* Compute the minimum height of this window. */
71 virtual int min_height () const
72 {
73 return MIN_WIN_HEIGHT;
74 }
75
76 /* Compute the maximum width of this window. */
77 int max_width () const;
78
79 /* Compute the minimum width of this window. */
80 int min_width () const
81 {
82 return 3;
83 }
84
85 /* Return true if this window can be boxed. */
86 virtual bool can_box () const
87 {
88 return true;
89 }
90
91 /* Resize this window. The parameters are used to set the window's
92 size and position. */
93 virtual void resize (int height, int width,
94 int origin_x, int origin_y);
95
96 /* Return true if this window is visible. */
97 bool is_visible () const
98 {
99 return handle != nullptr && tui_active;
100 }
101
102 /* Return true if this window can accept the focus. */
103 virtual bool can_focus () const
104 {
105 return true;
106 }
107
108 /* Disable output until the next call to doupdate. */
110 {
111 if (handle != nullptr)
112 wnoutrefresh (handle.get ());
113 }
114
115 /* Called after the tab width has been changed. */
116 virtual void update_tab_width ()
117 {
118 }
119
120 /* Set whether this window is highlighted. */
121 void set_highlight (bool highlight)
122 {
123 is_highlighted = highlight;
124 }
125
126 /* Methods to scroll the contents of this window. Note that they
127 are named with "_scroll" coming at the end because the more
128 obvious "scroll_forward" is defined as a macro in term.h. */
129 void forward_scroll (int num_to_scroll);
130 void backward_scroll (int num_to_scroll);
131 void left_scroll (int num_to_scroll);
132 void right_scroll (int num_to_scroll);
133
134 /* Return true if this window can be scrolled, false otherwise. */
135 virtual bool can_scroll () const
136 {
137 return true;
138 }
139
140 /* Called for each mouse click inside this window. Coordinates MOUSE_X
141 and MOUSE_Y are 0-based relative to the window, and MOUSE_BUTTON can
142 be 1 (left), 2 (middle), or 3 (right). */
143 virtual void click (int mouse_x, int mouse_y, int mouse_button)
144 {
145 }
146
148
149 /* A helper function to change the title and then redraw the
150 surrounding box, if needed. */
151 void set_title (std::string &&new_title);
152
153 /* Return a reference to the current window title. */
154 const std::string &title () const
155 { return m_title; }
156
157 /* Window handle. */
158 std::unique_ptr<WINDOW, curses_deleter> handle;
159 /* Window width. */
160 int width = 0;
161 /* Window height. */
162 int height = 0;
163 /* Origin of window. */
164 int x = 0;
165 int y = 0;
166
167 /* Is this window highlighted? */
168 bool is_highlighted = false;
169
170protected:
171
172 /* Scroll the contents vertically. This is only called via
173 forward_scroll and backward_scroll. */
174 virtual void do_scroll_vertical (int num_to_scroll) = 0;
175
176 /* Scroll the contents horizontally. This is only called via
177 left_scroll and right_scroll. */
178 virtual void do_scroll_horizontal (int num_to_scroll) = 0;
179
180private:
181 /* Window title to display. */
182 std::string m_title;
183};
184
185/* Constant definitions. */
186#define SRC_NAME "src"
187#define CMD_NAME "cmd"
188#define DATA_NAME "regs"
189#define DISASSEM_NAME "asm"
190#define STATUS_NAME "status"
191
192/* Global Data. */
194
195#define TUI_SRC_WIN ((tui_source_window *) tui_win_list[SRC_WIN])
196#define TUI_DISASM_WIN ((tui_disasm_window *) tui_win_list[DISASSEM_WIN])
197#define TUI_DATA_WIN ((tui_data_window *) tui_win_list[DATA_WIN])
198#define TUI_CMD_WIN ((tui_cmd_window *) tui_win_list[CMD_WIN])
199#define TUI_STATUS_WIN ((tui_locator_window *) tui_win_list[STATUS_WIN])
200
201/* All the windows that are currently instantiated, in layout
202 order. */
203extern std::vector<tui_win_info *> tui_windows;
204
205/* Return a range adapter for iterating over TUI windows. */
206static inline std::vector<tui_win_info *> &
208{
209 return tui_windows;
210}
211
212/* Data Manipulation Functions. */
213extern int tui_term_height (void);
214extern void tui_set_term_height_to (int);
215extern int tui_term_width (void);
216extern void tui_set_term_width_to (int);
217extern struct tui_win_info *tui_win_with_focus (void);
218extern bool tui_win_resized ();
219extern void tui_set_win_resized_to (bool);
220
221extern struct tui_win_info *tui_next_win (struct tui_win_info *);
222extern struct tui_win_info *tui_prev_win (struct tui_win_info *);
223
224extern unsigned int tui_tab_width;
225
226#endif /* TUI_TUI_DATA_H */
void operator()(WINDOW *win) const
Definition tui-data.h:32
tui_win_info()=default
const std::string & title() const
Definition tui-data.h:154
virtual bool can_focus() const
Definition tui-data.h:103
void check_and_display_highlight_if_needed()
void right_scroll(int num_to_scroll)
Definition tui-win.c:471
virtual bool can_scroll() const
Definition tui-data.h:135
void left_scroll(int num_to_scroll)
Definition tui-win.c:461
virtual bool can_box() const
Definition tui-data.h:86
void backward_scroll(int num_to_scroll)
Definition tui-win.c:451
void set_highlight(bool highlight)
Definition tui-data.h:121
DISABLE_COPY_AND_ASSIGN(tui_win_info)
std::string m_title
Definition tui-data.h:182
virtual void resize(int height, int width, int origin_x, int origin_y)
Definition tui-layout.c:302
virtual void rerender()
Definition tui-data.c:168
void no_refresh()
Definition tui-data.h:109
int min_width() const
Definition tui-data.h:80
tui_win_info(tui_win_info &&)=default
virtual void do_scroll_horizontal(int num_to_scroll)=0
virtual const char * name() const =0
void forward_scroll(int num_to_scroll)
Definition tui-win.c:442
virtual void make_visible(bool visible)
virtual ~tui_win_info()=default
virtual void click(int mouse_x, int mouse_y, int mouse_button)
Definition tui-data.h:143
bool is_visible() const
Definition tui-data.h:97
void set_title(std::string &&new_title)
Definition tui-data.c:158
virtual void update_tab_width()
Definition tui-data.h:116
virtual int min_height() const
Definition tui-data.h:71
virtual void do_scroll_vertical(int num_to_scroll)=0
int max_width() const
Definition tui-win.c:1026
virtual void make_window()
std::unique_ptr< WINDOW, curses_deleter > handle
Definition tui-data.h:158
bool is_highlighted
Definition tui-data.h:168
virtual int max_height() const
Definition tui-win.c:1018
virtual void refresh_window()
struct tui_win_info * tui_prev_win(struct tui_win_info *)
Definition tui-data.c:135
int tui_term_height(void)
Definition tui-data.c:78
int tui_term_width(void)
Definition tui-data.c:94
unsigned int tui_tab_width
Definition tui-win.c:807
void tui_set_term_width_to(int)
Definition tui-data.c:102
#define MIN_WIN_HEIGHT
Definition tui-data.h:38
void tui_set_win_resized_to(bool)
Definition tui-data.c:49
std::vector< tui_win_info * > tui_windows
Definition tui-layout.c:65
struct tui_win_info * tui_win_list[MAX_MAJOR_WINDOWS]
Definition tui-data.c:32
struct tui_win_info * tui_next_win(struct tui_win_info *)
Definition tui-data.c:111
static std::vector< tui_win_info * > & all_tui_windows()
Definition tui-data.h:207
bool tui_win_resized()
Definition tui-data.c:41
void tui_set_term_height_to(int)
Definition tui-data.c:86
struct tui_win_info * tui_win_with_focus(void)
Definition tui-data.c:57
bool tui_active
Definition tui.c:73
@ MAX_MAJOR_WINDOWS
Definition tui.h:60