gdb/tui/tui-data.h

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