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