1 /* TUI layout window management.
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_LAYOUT_H
23 #define TUI_TUI_LAYOUT_H
26 #include "tui/tui-data.h"
28 /* The basic object in a TUI layout. This represents a single piece
29 of screen real estate. Subclasses determine the exact
35 DISABLE_COPY_AND_ASSIGN (tui_layout_base
);
37 virtual ~tui_layout_base () = default;
39 /* Clone this object. Ordinarily a layout is cloned before it is
40 used, so that any necessary modifications do not affect the
42 virtual std::unique_ptr
<tui_layout_base
> clone () const = 0;
44 /* Change the size and location of this layout. */
45 virtual void apply (int x
, int y
, int width
, int height
) = 0;
47 /* Return the minimum and maximum height of this layout. */
48 virtual void get_sizes (int *min_height
, int *max_height
) = 0;
50 /* True if the topmost item in this layout is boxed. */
51 virtual bool top_boxed_p () const = 0;
53 /* True if the bottommost item in this layout is boxed. */
54 virtual bool bottom_boxed_p () const = 0;
56 /* Return the name of this layout's window, or nullptr if this
57 layout does not represent a single window. */
58 virtual const char *get_name () const
63 /* Adjust the size of the window named NAME to NEW_HEIGHT, updating
64 the sizes of the other windows around it. */
65 virtual bool adjust_size (const char *name
, int new_height
) = 0;
67 /* The most recent space allocation. */
75 tui_layout_base () = default;
78 /* A TUI layout object that displays a single window. The window is
80 class tui_layout_window
: public tui_layout_base
84 explicit tui_layout_window (const char *name
)
89 DISABLE_COPY_AND_ASSIGN (tui_layout_window
);
91 std::unique_ptr
<tui_layout_base
> clone () const override
;
93 void apply (int x
, int y
, int width
, int height
) override
;
95 const char *get_name () const override
97 return m_contents
.c_str ();
100 bool adjust_size (const char *name
, int new_height
) override
105 bool top_boxed_p () const override
;
107 bool bottom_boxed_p () const override
;
111 void get_sizes (int *min_height
, int *max_height
) override
;
115 /* Type of content to display. */
116 std::string m_contents
;
118 /* When a layout is applied, this is updated to point to the window
120 tui_gen_win_info
*m_window
= nullptr;
123 /* A TUI layout that holds other layouts. */
124 class tui_layout_split
: public tui_layout_base
128 tui_layout_split () = default;
130 DISABLE_COPY_AND_ASSIGN (tui_layout_split
);
132 /* Add a new split layout to this layout. WEIGHT is the desired
133 size, which is relative to the other weights given in this
135 tui_layout_split
*add_split (int weight
);
137 /* Add a new window to this layout. NAME is the name of the window
138 to add. WEIGHT is the desired size, which is relative to the
139 other weights given in this layout. */
140 void add_window (const char *name
, int weight
);
142 std::unique_ptr
<tui_layout_base
> clone () const override
;
144 void apply (int x
, int y
, int width
, int height
) override
;
146 bool adjust_size (const char *name
, int new_height
) override
;
148 bool top_boxed_p () const override
;
150 bool bottom_boxed_p () const override
;
154 void get_sizes (int *min_height
, int *max_height
) override
;
158 /* Set the weights from the current heights. */
159 void set_weights_from_heights ();
163 /* The requested weight. */
166 std::unique_ptr
<tui_layout_base
> layout
;
170 std::vector
<split
> m_splits
;
172 /* True if this layout has already been applied at least once. */
173 bool m_applied
= false;
176 extern void tui_add_win_to_layout (enum tui_win_type
);
177 extern void tui_set_layout (enum tui_layout_type
);
179 /* Apply the current layout. */
180 extern void tui_apply_current_layout ();
182 /* Adjust the window height of WIN to NEW_HEIGHT. */
183 extern void tui_adjust_window_height (struct tui_win_info
*win
,
186 #endif /* TUI_TUI_LAYOUT_H */