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