1 /* TUI layout window management.
3 Copyright (C) 1998-2022 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_LAYOUT_H
23 #define TUI_TUI_LAYOUT_H
28 #include "tui/tui-data.h"
30 /* Values that can be returned when handling a request to adjust a
32 enum tui_adjust_result
34 /* Requested window was not found here. */
36 /* Window was found but not handled. */
38 /* Window was found and handled. */
42 /* The basic object in a TUI layout. This represents a single piece
43 of screen real estate. Subclasses determine the exact
49 DISABLE_COPY_AND_ASSIGN (tui_layout_base
);
51 virtual ~tui_layout_base () = default;
53 /* Clone this object. Ordinarily a layout is cloned before it is
54 used, so that any necessary modifications do not affect the
56 virtual std::unique_ptr
<tui_layout_base
> clone () const = 0;
58 /* Change the size and location of this layout. When
59 PRESERVE_CMD_WIN_SIZE_P is true the current size of the TUI_CMD_WIN
60 is preserved, otherwise, the TUI_CMD_WIN will resize just like any
62 virtual void apply (int x
, int y
, int width
, int height
,
63 bool preserve_cmd_win_size_p
) = 0;
65 /* Return the minimum and maximum height or width of this layout.
66 HEIGHT is true to fetch height, false to fetch width. */
67 virtual void get_sizes (bool height
, int *min_value
, int *max_value
) = 0;
69 /* True if the topmost (for vertical layouts), or the leftmost (for
70 horizontal layouts) item in this layout is boxed. */
71 virtual bool first_edge_has_border_p () const = 0;
73 /* True if the bottommost (for vertical layouts), or the rightmost (for
74 horizontal layouts) item in this layout is boxed. */
75 virtual bool last_edge_has_border_p () const = 0;
77 /* Return the name of this layout's window, or nullptr if this
78 layout does not represent a single window. */
79 virtual const char *get_name () const
84 /* Set the height of the window named NAME to NEW_HEIGHT, updating
85 the sizes of the other windows around it. */
86 virtual tui_adjust_result
set_height (const char *name
, int new_height
) = 0;
88 /* Set the width of the window named NAME to NEW_WIDTH, updating
89 the sizes of the other windows around it. */
90 virtual tui_adjust_result
set_width (const char *name
, int new_width
) = 0;
92 /* Remove some windows from the layout, leaving the command window
93 and the window being passed in here. */
94 virtual void remove_windows (const char *name
) = 0;
96 /* Replace the window named NAME in the layout with the window named
98 virtual void replace_window (const char *name
, const char *new_window
) = 0;
100 /* Append the specification to this window to OUTPUT. DEPTH is the
101 depth of this layout in the hierarchy (zero-based). */
102 virtual void specification (ui_file
*output
, int depth
) = 0;
104 /* Return a FINGERPRINT string containing an abstract representation of
105 the location of the cmd window in this layout.
107 When called on a complete, top-level layout, the fingerprint will be a
108 non-empty string made of 'V' and 'H' characters, followed by a single
109 'C' character. Each 'V' and 'H' represents a vertical or horizontal
110 layout that must be passed through in order to find the cmd
113 Of course, layouts are built recursively, so, when called on a partial
114 layout, if this object represents a single window, then either the
115 empty string is returned (for non-cmd windows), or a string
116 containing a single 'C' is returned.
118 For object representing layouts, if the layout contains the cmd
119 window then we will get back a valid fingerprint string (contains 'V'
120 and 'H', ends with 'C'), or, if this layout doesn't contain the cmd
121 window, an empty string is returned. */
122 virtual std::string
layout_fingerprint () const = 0;
124 /* Add all windows to the WINDOWS vector. */
125 virtual void get_windows (std::vector
<tui_win_info
*> *windows
) = 0;
127 /* The most recent space allocation. */
135 tui_layout_base () = default;
138 /* A TUI layout object that displays a single window. The window is
140 class tui_layout_window
: public tui_layout_base
144 explicit tui_layout_window (const char *name
)
149 DISABLE_COPY_AND_ASSIGN (tui_layout_window
);
151 std::unique_ptr
<tui_layout_base
> clone () const override
;
153 void apply (int x
, int y
, int width
, int height
,
154 bool preserve_cmd_win_size_p
) override
;
156 const char *get_name () const override
158 return m_contents
.c_str ();
161 tui_adjust_result
set_height (const char *name
, int new_height
) override
163 return m_contents
== name
? FOUND
: NOT_FOUND
;
166 tui_adjust_result
set_width (const char *name
, int new_width
) override
168 return m_contents
== name
? FOUND
: NOT_FOUND
;
171 bool first_edge_has_border_p () const override
;
173 bool last_edge_has_border_p () const override
;
175 void remove_windows (const char *name
) override
179 void replace_window (const char *name
, const char *new_window
) override
;
181 void specification (ui_file
*output
, int depth
) override
;
183 std::string
layout_fingerprint () const override
;
185 /* See tui_layout_base::get_windows. */
186 void get_windows (std::vector
<tui_win_info
*> *windows
) override
188 windows
->push_back (m_window
);
193 void get_sizes (bool height
, int *min_value
, int *max_value
) override
;
197 /* Type of content to display. */
198 std::string m_contents
;
200 /* When a layout is applied, this is updated to point to the window
202 tui_win_info
*m_window
= nullptr;
205 /* A TUI layout that holds other layouts. */
206 class tui_layout_split
: public tui_layout_base
210 /* Create a new layout. If VERTICAL is true, then windows in this
211 layout will be arranged vertically. */
212 explicit tui_layout_split (bool vertical
= true)
213 : m_vertical (vertical
)
217 DISABLE_COPY_AND_ASSIGN (tui_layout_split
);
219 /* Add a new split layout to this layout. WEIGHT is the desired
220 size, which is relative to the other weights given in this
222 void add_split (std::unique_ptr
<tui_layout_split
> &&layout
, int weight
);
224 /* Add a new window to this layout. NAME is the name of the window
225 to add. WEIGHT is the desired size, which is relative to the
226 other weights given in this layout. */
227 void add_window (const char *name
, int weight
);
229 std::unique_ptr
<tui_layout_base
> clone () const override
;
231 void apply (int x
, int y
, int width
, int height
,
232 bool preserve_cmd_win_size_p
) override
;
234 tui_adjust_result
set_height (const char *name
, int new_height
) override
236 /* Pass false as the final argument to indicate change of height. */
237 return set_size (name
, new_height
, false);
240 tui_adjust_result
set_width (const char *name
, int new_width
) override
242 /* Pass true as the final argument to indicate change of width. */
243 return set_size (name
, new_width
, true);
246 bool first_edge_has_border_p () const override
;
248 bool last_edge_has_border_p () const override
;
250 void remove_windows (const char *name
) override
;
252 void replace_window (const char *name
, const char *new_window
) override
;
254 void specification (ui_file
*output
, int depth
) override
;
256 std::string
layout_fingerprint () const override
;
258 /* See tui_layout_base::get_windows. */
259 void get_windows (std::vector
<tui_win_info
*> *windows
) override
261 for (auto &item
: m_splits
)
262 item
.layout
->get_windows (windows
);
267 void get_sizes (bool height
, int *min_value
, int *max_value
) override
;
271 /* Used to implement set_height and set_width member functions. When
272 SET_WIDTH_P is true, set the width, otherwise, set the height of the
273 window named NAME to NEW_SIZE, updating the sizes of the other windows
274 around it as needed. The result indicates if the window NAME was
275 found and had its size adjusted, was found but was not adjusted, or
276 was not found at all. */
277 tui_adjust_result
set_size (const char *name
, int new_size
,
280 /* Set the weights from the current heights (when m_vertical is true) or
281 widths (when m_vertical is false). */
282 void set_weights_from_sizes ();
284 /* Structure used when resizing, or applying a layout. An instance of
285 this structure is created for each sub-layout. */
288 /* The calculated size for this sub-layout. */
291 /* The minimum and maximum sizes for this sub-layout, obtained by
292 calling the get_sizes member function. */
296 /* True if this window will share a box border with the previous
297 window in the list. */
301 /* Used for debug, prints the contents of INFO using tui_debug_printf.
302 Only call this when the global debug_tui is true. */
303 static void tui_debug_print_size_info (const std::vector
<size_info
> &info
);
305 /* Used for debug, returns a string describing the current weight of each
307 std::string
tui_debug_weights_to_string () const;
311 /* The requested weight. */
314 std::unique_ptr
<tui_layout_base
> layout
;
318 std::vector
<split
> m_splits
;
320 /* True if the windows in this split are arranged vertically. */
324 /* Add the specified window to the layout in a logical way. This
325 means setting up the most logical layout given the window to be
326 added. Only the source or disassembly window can be added this
328 extern void tui_add_win_to_layout (enum tui_win_type
);
330 /* Set the initial layout. */
331 extern void tui_set_initial_layout ();
333 /* Switch to the next layout. */
334 extern void tui_next_layout ();
336 /* Show the register window. Like "layout regs". */
337 extern void tui_regs_layout ();
339 /* Remove some windows from the layout, leaving only the focused
340 window and the command window; if no window has the focus, then
341 some other window is chosen to remain. */
342 extern void tui_remove_some_windows ();
344 /* Apply the current layout. When PRESERVE_CMD_WIN_SIZE_P is true the
345 current size of the TUI_CMD_WIN is preserved, otherwise, the TUI_CMD_WIN
346 will resize just like any other window. */
347 extern void tui_apply_current_layout (bool);
349 /* Adjust the window height of WIN to NEW_HEIGHT. */
350 extern void tui_adjust_window_height (struct tui_win_info
*win
,
353 /* Adjust the window width of WIN to NEW_WIDTH. */
354 extern void tui_adjust_window_width (struct tui_win_info
*win
,
357 /* The type of a function that is used to create a TUI window. */
359 typedef std::function
<tui_win_info
* (const char *name
)> window_factory
;
361 /* Register a new TUI window type. NAME is the name of the window
362 type. FACTORY is a function that can be called to instantiate the
365 extern void tui_register_window (const char *name
, window_factory
&&factory
);
367 #endif /* TUI_TUI_LAYOUT_H */