3c14b2654eef34c4d83ad296a5cf7ce3d3e9bbe7
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 /* A deleter that calls delwin. */
32 void operator() (WINDOW
*win
) const
38 #define MIN_WIN_HEIGHT 3
40 /* Generic window information. */
45 tui_win_info () = default;
46 DISABLE_COPY_AND_ASSIGN (tui_win_info
);
48 /* This is called after the window is resized, and should update the
50 virtual void rerender ();
52 virtual void make_window ();
55 tui_win_info (tui_win_info
&&) = default;
56 virtual ~tui_win_info () = default;
58 /* Call to refresh this window. */
59 virtual void refresh_window ();
61 /* Make this window visible or invisible. */
62 virtual void make_visible (bool visible
);
64 /* Return the name of this type of window. */
65 virtual const char *name () const
70 /* Compute the maximum height of this window. */
71 virtual int max_height () const;
73 /* Compute the minimum height of this window. */
74 virtual int min_height () const
76 return MIN_WIN_HEIGHT
;
79 /* Compute the maximum width of this window. */
80 int max_width () const;
82 /* Compute the minimum width of this window. */
83 int min_width () const
88 /* Return true if this window can be boxed. */
89 virtual bool can_box () const
94 /* Resize this window. The parameters are used to set the window's
96 virtual void resize (int height
, int width
,
97 int origin_x
, int origin_y
);
99 /* Return true if this window is visible. */
100 bool is_visible () const
102 return handle
!= nullptr;
105 /* Disable output until the next call to doupdate. */
108 if (handle
!= nullptr)
109 wnoutrefresh (handle
.get ());
112 /* Called after the tab width has been changed. */
113 virtual void update_tab_width ()
117 /* Set whether this window is highlighted. */
118 void set_highlight (bool highlight
)
120 is_highlighted
= highlight
;
123 /* Methods to scroll the contents of this window. Note that they
124 are named with "_scroll" coming at the end because the more
125 obvious "scroll_forward" is defined as a macro in term.h. */
126 void forward_scroll (int num_to_scroll
);
127 void backward_scroll (int num_to_scroll
);
128 void left_scroll (int num_to_scroll
);
129 void right_scroll (int num_to_scroll
);
131 /* Return true if this window can be scrolled, false otherwise. */
132 virtual bool can_scroll () const
137 void check_and_display_highlight_if_needed ();
140 std::unique_ptr
<WINDOW
, curses_deleter
> handle
;
145 /* Origin of window. */
149 /* Window title to display. */
152 /* Is this window highlighted? */
153 bool is_highlighted
= false;
157 /* Scroll the contents vertically. This is only called via
158 forward_scroll and backward_scroll. */
159 virtual void do_scroll_vertical (int num_to_scroll
) = 0;
161 /* Scroll the contents horizontally. This is only called via
162 left_scroll and right_scroll. */
163 virtual void do_scroll_horizontal (int num_to_scroll
) = 0;
166 /* Constant definitions. */
167 #define SRC_NAME "src"
168 #define CMD_NAME "cmd"
169 #define DATA_NAME "regs"
170 #define DISASSEM_NAME "asm"
171 #define STATUS_NAME "status"
174 extern struct tui_win_info
*tui_win_list
[MAX_MAJOR_WINDOWS
];
176 #define TUI_SRC_WIN ((tui_source_window *) tui_win_list[SRC_WIN])
177 #define TUI_DISASM_WIN ((tui_disasm_window *) tui_win_list[DISASSEM_WIN])
178 #define TUI_DATA_WIN ((tui_data_window *) tui_win_list[DATA_WIN])
179 #define TUI_CMD_WIN ((tui_cmd_window *) tui_win_list[CMD_WIN])
181 /* All the windows that are currently instantiated, in layout
183 extern std::vector
<tui_win_info
*> tui_windows
;
185 /* Return a range adapter for iterating over TUI windows. */
186 static inline std::vector
<tui_win_info
*> &
192 /* Data Manipulation Functions. */
193 extern int tui_term_height (void);
194 extern void tui_set_term_height_to (int);
195 extern int tui_term_width (void);
196 extern void tui_set_term_width_to (int);
197 extern struct tui_locator_window
*tui_locator_win_info_ptr (void);
198 extern struct tui_win_info
*tui_win_with_focus (void);
199 extern bool tui_win_resized ();
200 extern void tui_set_win_resized_to (bool);
202 extern struct tui_win_info
*tui_next_win (struct tui_win_info
*);
203 extern struct tui_win_info
*tui_prev_win (struct tui_win_info
*);
205 extern unsigned int tui_tab_width
;
207 #endif /* TUI_TUI_DATA_H */
This page took 0.048111 seconds and 3 git commands to generate.