gdb/tui/tui-data.h

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