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