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