| 1 | /* TUI data manipulation routines. |
| 2 | |
| 3 | Copyright (C) 1998-2019 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" /* For enum tui_win_type. */ |
| 26 | #include "gdb_curses.h" /* For WINDOW. */ |
| 27 | #include "observable.h" |
| 28 | |
| 29 | struct tui_cmd_window; |
| 30 | struct tui_source_window_base; |
| 31 | struct tui_source_window; |
| 32 | |
| 33 | /* This is a point definition. */ |
| 34 | struct tui_point |
| 35 | { |
| 36 | int x, y; |
| 37 | }; |
| 38 | |
| 39 | /* A deleter that calls delwin. */ |
| 40 | struct curses_deleter |
| 41 | { |
| 42 | void operator() (WINDOW *win) const |
| 43 | { |
| 44 | delwin (win); |
| 45 | } |
| 46 | }; |
| 47 | |
| 48 | /* Generic window information. */ |
| 49 | struct tui_gen_win_info |
| 50 | { |
| 51 | protected: |
| 52 | |
| 53 | explicit tui_gen_win_info (enum tui_win_type t) |
| 54 | : type (t) |
| 55 | { |
| 56 | } |
| 57 | |
| 58 | /* This is called after the window is resized, and should update the |
| 59 | window's contents. */ |
| 60 | virtual void rerender () |
| 61 | { |
| 62 | } |
| 63 | |
| 64 | virtual void make_window (); |
| 65 | |
| 66 | public: |
| 67 | tui_gen_win_info (tui_gen_win_info &&) = default; |
| 68 | |
| 69 | virtual ~tui_gen_win_info () |
| 70 | { |
| 71 | } |
| 72 | |
| 73 | /* Call to refresh this window. */ |
| 74 | virtual void refresh_window (); |
| 75 | |
| 76 | /* Make this window visible or invisible. */ |
| 77 | virtual void make_visible (bool visible); |
| 78 | |
| 79 | /* Return the name of this type of window. */ |
| 80 | virtual const char *name () const |
| 81 | { |
| 82 | return ""; |
| 83 | } |
| 84 | |
| 85 | /* Compute the maximum height of this window. */ |
| 86 | virtual int max_height () const = 0; |
| 87 | |
| 88 | /* Resize this window. The parameters are used to set the window's |
| 89 | size and position. */ |
| 90 | virtual void resize (int height, int width, |
| 91 | int origin_x, int origin_y); |
| 92 | |
| 93 | /* Return true if this window is visible. */ |
| 94 | bool is_visible () const |
| 95 | { |
| 96 | return handle != nullptr; |
| 97 | } |
| 98 | |
| 99 | /* Window handle. */ |
| 100 | std::unique_ptr<WINDOW, curses_deleter> handle; |
| 101 | /* Type of window. */ |
| 102 | enum tui_win_type type; |
| 103 | /* Window width. */ |
| 104 | int width = 0; |
| 105 | /* Window height. */ |
| 106 | int height = 0; |
| 107 | /* Origin of window. */ |
| 108 | struct tui_point origin = {0, 0}; |
| 109 | /* Viewport height. */ |
| 110 | int viewport_height = 0; |
| 111 | }; |
| 112 | |
| 113 | /* Constant definitions. */ |
| 114 | #define DEFAULT_TAB_LEN 8 |
| 115 | #define SRC_NAME "src" |
| 116 | #define CMD_NAME "cmd" |
| 117 | #define DATA_NAME "regs" |
| 118 | #define DISASSEM_NAME "asm" |
| 119 | #define MIN_WIN_HEIGHT 3 |
| 120 | #define MIN_CMD_WIN_HEIGHT 3 |
| 121 | |
| 122 | /* Strings to display in the TUI status line. */ |
| 123 | #define SINGLE_KEY "(SingleKey)" |
| 124 | |
| 125 | /* The kinds of layouts available. */ |
| 126 | enum tui_layout_type |
| 127 | { |
| 128 | SRC_COMMAND, |
| 129 | DISASSEM_COMMAND, |
| 130 | SRC_DISASSEM_COMMAND, |
| 131 | SRC_DATA_COMMAND, |
| 132 | DISASSEM_DATA_COMMAND, |
| 133 | UNDEFINED_LAYOUT |
| 134 | }; |
| 135 | |
| 136 | enum tui_line_or_address_kind |
| 137 | { |
| 138 | LOA_LINE, |
| 139 | LOA_ADDRESS |
| 140 | }; |
| 141 | |
| 142 | /* Structure describing source line or line address. */ |
| 143 | struct tui_line_or_address |
| 144 | { |
| 145 | enum tui_line_or_address_kind loa; |
| 146 | union |
| 147 | { |
| 148 | int line_no; |
| 149 | CORE_ADDR addr; |
| 150 | } u; |
| 151 | }; |
| 152 | |
| 153 | /* This defines information about each logical window. */ |
| 154 | struct tui_win_info : public tui_gen_win_info |
| 155 | { |
| 156 | protected: |
| 157 | |
| 158 | explicit tui_win_info (enum tui_win_type type); |
| 159 | DISABLE_COPY_AND_ASSIGN (tui_win_info); |
| 160 | |
| 161 | /* Scroll the contents vertically. This is only called via |
| 162 | forward_scroll and backward_scroll. */ |
| 163 | virtual void do_scroll_vertical (int num_to_scroll) = 0; |
| 164 | |
| 165 | /* Scroll the contents horizontally. This is only called via |
| 166 | left_scroll and right_scroll. */ |
| 167 | virtual void do_scroll_horizontal (int num_to_scroll) = 0; |
| 168 | |
| 169 | void rerender () override; |
| 170 | |
| 171 | void make_window () override; |
| 172 | |
| 173 | public: |
| 174 | |
| 175 | ~tui_win_info () override |
| 176 | { |
| 177 | } |
| 178 | |
| 179 | int max_height () const override; |
| 180 | |
| 181 | /* Called after the tab width has been changed. */ |
| 182 | virtual void update_tab_width () |
| 183 | { |
| 184 | } |
| 185 | |
| 186 | /* Set whether this window is highlighted. */ |
| 187 | void set_highlight (bool highlight) |
| 188 | { |
| 189 | is_highlighted = highlight; |
| 190 | } |
| 191 | |
| 192 | /* Methods to scroll the contents of this window. Note that they |
| 193 | are named with "_scroll" coming at the end because the more |
| 194 | obvious "scroll_forward" is defined as a macro in term.h. */ |
| 195 | void forward_scroll (int num_to_scroll); |
| 196 | void backward_scroll (int num_to_scroll); |
| 197 | void left_scroll (int num_to_scroll); |
| 198 | void right_scroll (int num_to_scroll); |
| 199 | |
| 200 | /* Return true if this window can be scrolled, false otherwise. */ |
| 201 | virtual bool can_scroll () const |
| 202 | { |
| 203 | return true; |
| 204 | } |
| 205 | |
| 206 | virtual bool can_box () const |
| 207 | { |
| 208 | return true; |
| 209 | } |
| 210 | |
| 211 | void check_and_display_highlight_if_needed (); |
| 212 | |
| 213 | /* Window title to display. */ |
| 214 | std::string title; |
| 215 | |
| 216 | /* Is this window highlighted? */ |
| 217 | bool is_highlighted = false; |
| 218 | }; |
| 219 | |
| 220 | |
| 221 | /* Global Data. */ |
| 222 | extern struct tui_win_info *tui_win_list[MAX_MAJOR_WINDOWS]; |
| 223 | |
| 224 | #define TUI_SRC_WIN ((tui_source_window *) tui_win_list[SRC_WIN]) |
| 225 | #define TUI_DISASM_WIN ((tui_source_window_base *) tui_win_list[DISASSEM_WIN]) |
| 226 | #define TUI_DATA_WIN ((tui_data_window *) tui_win_list[DATA_WIN]) |
| 227 | #define TUI_CMD_WIN ((tui_cmd_window *) tui_win_list[CMD_WIN]) |
| 228 | |
| 229 | /* An iterator that iterates over all windows. */ |
| 230 | |
| 231 | class tui_window_iterator |
| 232 | { |
| 233 | public: |
| 234 | |
| 235 | typedef tui_window_iterator self_type; |
| 236 | typedef struct tui_win_info *value_type; |
| 237 | typedef struct tui_win_info *&reference; |
| 238 | typedef struct tui_win_info **pointer; |
| 239 | typedef std::forward_iterator_tag iterator_category; |
| 240 | typedef int difference_type; |
| 241 | |
| 242 | explicit tui_window_iterator (enum tui_win_type type) |
| 243 | : m_type (type) |
| 244 | { |
| 245 | advance (); |
| 246 | } |
| 247 | |
| 248 | tui_window_iterator () |
| 249 | : m_type (MAX_MAJOR_WINDOWS) |
| 250 | { |
| 251 | } |
| 252 | |
| 253 | bool operator!= (const self_type &other) const |
| 254 | { |
| 255 | return m_type != other.m_type; |
| 256 | } |
| 257 | |
| 258 | value_type operator* () const |
| 259 | { |
| 260 | gdb_assert (m_type < MAX_MAJOR_WINDOWS); |
| 261 | return tui_win_list[m_type]; |
| 262 | } |
| 263 | |
| 264 | self_type &operator++ () |
| 265 | { |
| 266 | ++m_type; |
| 267 | advance (); |
| 268 | return *this; |
| 269 | } |
| 270 | |
| 271 | private: |
| 272 | |
| 273 | void advance () |
| 274 | { |
| 275 | while (m_type < MAX_MAJOR_WINDOWS && tui_win_list[m_type] == nullptr) |
| 276 | ++m_type; |
| 277 | } |
| 278 | |
| 279 | int m_type; |
| 280 | }; |
| 281 | |
| 282 | /* A range adapter for iterating over TUI windows. */ |
| 283 | |
| 284 | struct all_tui_windows |
| 285 | { |
| 286 | tui_window_iterator begin () const |
| 287 | { |
| 288 | return tui_window_iterator (SRC_WIN); |
| 289 | } |
| 290 | |
| 291 | tui_window_iterator end () const |
| 292 | { |
| 293 | return tui_window_iterator (); |
| 294 | } |
| 295 | }; |
| 296 | |
| 297 | |
| 298 | /* Data Manipulation Functions. */ |
| 299 | extern enum tui_layout_type tui_current_layout (void); |
| 300 | extern int tui_term_height (void); |
| 301 | extern void tui_set_term_height_to (int); |
| 302 | extern int tui_term_width (void); |
| 303 | extern void tui_set_term_width_to (int); |
| 304 | extern struct tui_locator_window *tui_locator_win_info_ptr (void); |
| 305 | extern struct tui_win_info *tui_win_with_focus (void); |
| 306 | extern void tui_set_win_with_focus (struct tui_win_info *); |
| 307 | extern bool tui_win_resized (); |
| 308 | extern void tui_set_win_resized_to (bool); |
| 309 | |
| 310 | extern struct tui_win_info *tui_next_win (struct tui_win_info *); |
| 311 | extern struct tui_win_info *tui_prev_win (struct tui_win_info *); |
| 312 | |
| 313 | /* Delete all the invisible windows. Note that it is an error to call |
| 314 | this when the command window is invisible -- we don't allow the |
| 315 | command window to be removed from the layout. */ |
| 316 | extern void tui_delete_invisible_windows (); |
| 317 | |
| 318 | extern unsigned int tui_tab_width; |
| 319 | |
| 320 | #endif /* TUI_TUI_DATA_H */ |