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