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 /* Flags to tell what kind of breakpoint is at current line.  */
 155 enum tui_bp_flag
 156 {
 157   TUI_BP_ENABLED = 0x01,
 158   TUI_BP_DISABLED = 0x02,
 159   TUI_BP_HIT = 0x04,
 160   TUI_BP_CONDITIONAL = 0x08,
 161   TUI_BP_HARDWARE = 0x10
 162 };
 163
 164 DEF_ENUM_FLAGS_TYPE (enum tui_bp_flag, tui_bp_flags);
 165
 166 /* Elements in the Source/Disassembly Window.  */
 167 struct tui_source_element
 168 {
 169   tui_source_element ()
 170   {
 171     line_or_addr.loa = LOA_LINE;
 172     line_or_addr.u.line_no = 0;
 173   }
 174
 175   ~tui_source_element ()
 176   {
 177     xfree (line);
 178   }
 179
 180   char *line = nullptr;
 181   struct tui_line_or_address line_or_addr;
 182   bool is_exec_point = false;
 183   tui_bp_flags break_mode = 0;
 184 };
 185
 186
 187 #ifdef PATH_MAX
 188 # define MAX_LOCATOR_ELEMENT_LEN        PATH_MAX
 189 #else
 190 # define MAX_LOCATOR_ELEMENT_LEN        1024
 191 #endif
 192
 193 /* Position of breakpoint markers in the exec info string.  */
 194 #define TUI_BP_HIT_POS      0
 195 #define TUI_BP_BREAK_POS    1
 196 #define TUI_EXEC_POS        2
 197 #define TUI_EXECINFO_SIZE   4
 198
 199 typedef char tui_exec_info_content[TUI_EXECINFO_SIZE];
 200
 201 /* Locator window class.  */
 202
 203 struct tui_locator_window : public tui_gen_win_info
 204 {
 205   tui_locator_window ()
 206     : tui_gen_win_info (LOCATOR_WIN)
 207   {
 208     full_name[0] = 0;
 209     proc_name[0] = 0;
 210   }
 211
 212   char full_name[MAX_LOCATOR_ELEMENT_LEN];
 213   char proc_name[MAX_LOCATOR_ELEMENT_LEN];
 214   int line_no = 0;
 215   CORE_ADDR addr = 0;
 216   /* Architecture associated with code at this location.  */
 217   struct gdbarch *gdbarch = nullptr;
 218 };
 219
 220 /* This defines information about each logical window.  */
 221 struct tui_win_info : public tui_gen_win_info
 222 {
 223 protected:
 224
 225   explicit tui_win_info (enum tui_win_type type);
 226   DISABLE_COPY_AND_ASSIGN (tui_win_info);
 227
 228   /* Scroll the contents vertically.  This is only called via
 229      forward_scroll and backward_scroll.  */
 230   virtual void do_scroll_vertical (int num_to_scroll) = 0;
 231
 232   /* Scroll the contents horizontally.  This is only called via
 233      left_scroll and right_scroll.  */
 234   virtual void do_scroll_horizontal (int num_to_scroll) = 0;
 235
 236   /* Called after make_visible_with_new_height sets the new height.
 237      Should update the window.  */
 238   virtual void do_make_visible_with_new_height () = 0;
 239
 240 public:
 241
 242   ~tui_win_info () override
 243   {
 244   }
 245
 246   /* Called after all the TUI windows are refreshed, to let this
 247      window have a chance to update itself further.  */
 248   virtual void refresh_all ()
 249   {
 250   }
 251
 252   /* Called after a TUI window is given a new height; this updates any
 253      related auxiliary windows.  */
 254   virtual void set_new_height (int height)
 255   {
 256   }
 257
 258   /* Compute the maximum height of this window.  */
 259   virtual int max_height () const;
 260
 261   /* Called after the tab width has been changed.  */
 262   virtual void update_tab_width ()
 263   {
 264   }
 265
 266   /* Function make the target window (and auxiliary windows associated
 267      with the target) invisible, and set the new height and
 268      location.  */
 269   void make_invisible_and_set_new_height (int height);
 270
 271   /* Make the window visible after the height has been changed.  */
 272   void make_visible_with_new_height ();
 273
 274   /* Set whether this window is highglighted.  */
 275   void set_highlight (bool highlight)
 276   {
 277     is_highlighted = highlight;
 278   }
 279
 280   /* Methods to scroll the contents of this window.  Note that they
 281      are named with "_scroll" coming at the end because the more
 282      obvious "scroll_forward" is defined as a macro in term.h.  */
 283   void forward_scroll (int num_to_scroll);
 284   void backward_scroll (int num_to_scroll);
 285   void left_scroll (int num_to_scroll);
 286   void right_scroll (int num_to_scroll);
 287
 288   /* Return true if this window can be scrolled, false otherwise.  */
 289   virtual bool can_scroll () const
 290   {
 291     return true;
 292   }
 293
 294   void check_and_display_highlight_if_needed ();
 295
 296   /* Can this window ever be highlighted?  */
 297   bool can_highlight = true;
 298
 299   /* Is this window highlighted?  */
 300   bool is_highlighted = false;
 301 };
 302
 303 extern int tui_win_is_auxiliary (enum tui_win_type win_type);
 304
 305
 306 /* Global Data.  */
 307 extern struct tui_win_info *tui_win_list[MAX_MAJOR_WINDOWS];
 308
 309 #define TUI_SRC_WIN     ((tui_source_window *) tui_win_list[SRC_WIN])
 310 #define TUI_DISASM_WIN  ((tui_source_window_base *) tui_win_list[DISASSEM_WIN])
 311 #define TUI_DATA_WIN    ((tui_data_window *) tui_win_list[DATA_WIN])
 312 #define TUI_CMD_WIN     ((tui_cmd_window *) tui_win_list[CMD_WIN])
 313
 314 /* An iterator that iterates over all windows.  */
 315
 316 class tui_window_iterator
 317 {
 318 public:
 319
 320   typedef tui_window_iterator self_type;
 321   typedef struct tui_win_info *value_type;
 322   typedef struct tui_win_info *&reference;
 323   typedef struct tui_win_info **pointer;
 324   typedef std::forward_iterator_tag iterator_category;
 325   typedef int difference_type;
 326
 327   explicit tui_window_iterator (enum tui_win_type type)
 328     : m_type (type)
 329   {
 330     advance ();
 331   }
 332
 333   tui_window_iterator ()
 334     : m_type (MAX_MAJOR_WINDOWS)
 335   {
 336   }
 337
 338   bool operator!= (const self_type &other) const
 339   {
 340     return m_type != other.m_type;
 341   }
 342
 343   value_type operator* () const
 344   {
 345     gdb_assert (m_type < MAX_MAJOR_WINDOWS);
 346     return tui_win_list[m_type];
 347   }
 348
 349   self_type &operator++ ()
 350   {
 351     ++m_type;
 352     advance ();
 353     return *this;
 354   }
 355
 356 private:
 357
 358   void advance ()
 359   {
 360     while (m_type < MAX_MAJOR_WINDOWS && tui_win_list[m_type] == nullptr)
 361       ++m_type;
 362   }
 363
 364   int m_type;
 365 };
 366
 367 /* A range adapter for iterating over TUI windows.  */
 368
 369 struct all_tui_windows
 370 {
 371   tui_window_iterator begin () const
 372   {
 373     return tui_window_iterator (SRC_WIN);
 374   }
 375
 376   tui_window_iterator end () const
 377   {
 378     return tui_window_iterator ();
 379   }
 380 };
 381
 382
 383 /* Data Manipulation Functions.  */
 384 extern void tui_initialize_static_data (void);
 385 extern struct tui_win_info *tui_partial_win_by_name (const char *);
 386 extern enum tui_layout_type tui_current_layout (void);
 387 extern int tui_term_height (void);
 388 extern void tui_set_term_height_to (int);
 389 extern int tui_term_width (void);
 390 extern void tui_set_term_width_to (int);
 391 extern struct tui_locator_window *tui_locator_win_info_ptr (void);
 392 extern std::vector<tui_source_window_base *> &tui_source_windows ();
 393 extern void tui_clear_source_windows (void);
 394 extern void tui_clear_source_windows_detail (void);
 395 extern void tui_add_to_source_windows (struct tui_source_window_base *);
 396 extern struct tui_win_info *tui_win_with_focus (void);
 397 extern void tui_set_win_with_focus (struct tui_win_info *);
 398 extern int tui_win_resized (void);
 399 extern void tui_set_win_resized_to (int);
 400
 401 extern struct tui_win_info *tui_next_win (struct tui_win_info *);
 402 extern struct tui_win_info *tui_prev_win (struct tui_win_info *);
 403
 404 /* Delete all the invisible windows.  Note that it is an error to call
 405    this when the command window is invisible -- we don't allow the
 406    command window to be removed from the layout.  */
 407 extern void tui_delete_invisible_windows ();
 408
 409 extern unsigned int tui_tab_width;
 410
 411 #endif /* TUI_TUI_DATA_H */