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