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