gdb/tui/tui-data.h

   1 /* TUI data manipulation routines.
   2
   3    Copyright (C) 1998-2020 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"
  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 struct tui_disasm_window;
  33
  34 /* A deleter that calls delwin.  */
  35 struct curses_deleter
  36 {
  37   void operator() (WINDOW *win) const
  38   {
  39     delwin (win);
  40   }
  41 };
  42
  43 /* Generic window information.  */
  44 struct tui_gen_win_info
  45 {
  46 protected:
  47
  48   tui_gen_win_info () = default;
  49
  50   /* This is called after the window is resized, and should update the
  51      window's contents.  */
  52   virtual void rerender ()
  53   {
  54   }
  55
  56   virtual void make_window ();
  57
  58 public:
  59   tui_gen_win_info (tui_gen_win_info &&) = default;
  60
  61   virtual ~tui_gen_win_info ()
  62   {
  63   }
  64
  65   /* Call to refresh this window.  */
  66   virtual void refresh_window ();
  67
  68   /* Make this window visible or invisible.  */
  69   virtual void make_visible (bool visible);
  70
  71   /* Return the name of this type of window.  */
  72   virtual const char *name () const
  73   {
  74     return "";
  75   }
  76
  77   /* Compute the maximum height of this window.  */
  78   virtual int max_height () const = 0;
  79
  80   /* Compute the minimum height of this window.  */
  81   virtual int min_height () const = 0;
  82
  83   /* Compute the maximum width of this window.  */
  84   int max_width () const;
  85
  86   /* Compute the minimum width of this window.  */
  87   int min_width () const
  88   {
  89     return 3;
  90   }
  91
  92   /* Return true if this window can be boxed.  */
  93   virtual bool can_box () const
  94   {
  95     return false;
  96   }
  97
  98   /* Resize this window.  The parameters are used to set the window's
  99      size and position.  */
 100   virtual void resize (int height, int width,
 101                        int origin_x, int origin_y);
 102
 103   /* Return true if this window is visible.  */
 104   bool is_visible () const
 105   {
 106     return handle != nullptr;
 107   }
 108
 109   /* Disable output until the next call to doupdate.  */
 110   virtual void no_refresh ()
 111   {
 112     if (handle != nullptr)
 113       wnoutrefresh (handle.get ());
 114   }
 115
 116   /* Window handle.  */
 117   std::unique_ptr<WINDOW, curses_deleter> handle;
 118   /* Window width.  */
 119   int width = 0;
 120   /* Window height.  */
 121   int height = 0;
 122   /* Origin of window.  */
 123   int x = 0;
 124   int y = 0;
 125 };
 126
 127 /* Constant definitions.  */
 128 #define DEFAULT_TAB_LEN         8
 129 #define SRC_NAME                "src"
 130 #define CMD_NAME                "cmd"
 131 #define DATA_NAME               "regs"
 132 #define DISASSEM_NAME           "asm"
 133 #define STATUS_NAME             "status"
 134 #define MIN_WIN_HEIGHT          3
 135 #define MIN_CMD_WIN_HEIGHT      3
 136
 137 /* Strings to display in the TUI status line.  */
 138 #define SINGLE_KEY              "(SingleKey)"
 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   tui_win_info () = default;
 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_disasm_window *) 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 /* All the windows that are currently instantiated, in layout
 239    order.  */
 240 extern std::vector<tui_win_info *> tui_windows;
 241
 242 /* Return a range adapter for iterating over TUI windows.  */
 243 static inline std::vector<tui_win_info *> &
 244 all_tui_windows ()
 245 {
 246   return tui_windows;
 247 }
 248
 249 /* Data Manipulation Functions.  */
 250 extern int tui_term_height (void);
 251 extern void tui_set_term_height_to (int);
 252 extern int tui_term_width (void);
 253 extern void tui_set_term_width_to (int);
 254 extern struct tui_locator_window *tui_locator_win_info_ptr (void);
 255 extern struct tui_win_info *tui_win_with_focus (void);
 256 extern bool tui_win_resized ();
 257 extern void tui_set_win_resized_to (bool);
 258
 259 extern struct tui_win_info *tui_next_win (struct tui_win_info *);
 260 extern struct tui_win_info *tui_prev_win (struct tui_win_info *);
 261
 262 extern unsigned int tui_tab_width;
 263
 264 #endif /* TUI_TUI_DATA_H */