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
  28 /* This is a point definition.  */
  29 struct tui_point
  30 {
  31   int x, y;
  32 };
  33
  34 struct tui_win_element;
  35
  36 /* This describes the content of the window.  */
  37 typedef struct tui_win_element **tui_win_content;
  38
  39 /* Generic window information.  */
  40 struct tui_gen_win_info
  41 {
  42   explicit tui_gen_win_info (enum tui_win_type t)
  43     : type (t)
  44   {
  45   }
  46
  47   virtual ~tui_gen_win_info ()
  48   {
  49   }
  50
  51   /* Call to refresh this window.  */
  52   virtual void refresh_window ();
  53
  54   /* Make this window visible or invisible.  */
  55   virtual void make_visible (bool visible);
  56
  57   /* Return the name of this type of window.  */
  58   virtual const char *name () const
  59   {
  60     return "";
  61   }
  62
  63   /* Window handle.  */
  64   WINDOW *handle = nullptr;
  65   /* Type of window.  */
  66   enum tui_win_type type;
  67   /* Window width.  */
  68   int width = 0;
  69   /* Window height.  */
  70   int height = 0;
  71   /* Origin of window.  */
  72   struct tui_point origin = {0, 0};
  73   /* Content of window.  */
  74   tui_win_content content = nullptr;
  75   /* Size of content (# of elements).  */
  76   int content_size = 0;
  77   /* Can it be used, or is it already used?  */
  78   int content_in_use = FALSE;
  79   /* Viewport height.  */
  80   int viewport_height = 0;
  81   /* Index of last visible line.  */
  82   int last_visible_line = 0;
  83   /* Whether the window is visible or not.  */
  84   bool is_visible = false;
  85   /* Window title to display.  */
  86   char *title = nullptr;
  87 };
  88
  89 /* Constant definitions.  */
  90 #define DEFAULT_TAB_LEN         8
  91 #define NO_SRC_STRING           "[ No Source Available ]"
  92 #define NO_DISASSEM_STRING      "[ No Assembly Available ]"
  93 #define NO_REGS_STRING          "[ Register Values Unavailable ]"
  94 #define NO_DATA_STRING          "[ No Data Values Displayed ]"
  95 #define MAX_CONTENT_COUNT       100
  96 #define SRC_NAME                "src"
  97 #define CMD_NAME                "cmd"
  98 #define DATA_NAME               "regs"
  99 #define DISASSEM_NAME           "asm"
 100 #define TUI_NULL_STR            ""
 101 #define DEFAULT_HISTORY_COUNT   25
 102 #define BOX_WINDOW              TRUE
 103 #define DONT_BOX_WINDOW         FALSE
 104 #define HILITE                  TRUE
 105 #define NO_HILITE               FALSE
 106 #define WITH_LOCATOR            TRUE
 107 #define NO_LOCATOR              FALSE
 108 #define EMPTY_SOURCE_PROMPT     TRUE
 109 #define NO_EMPTY_SOURCE_PROMPT  FALSE
 110 #define UNDEFINED_ITEM          -1
 111 #define MIN_WIN_HEIGHT          3
 112 #define MIN_CMD_WIN_HEIGHT      3
 113
 114 /* Strings to display in the TUI status line.  */
 115 #define PROC_PREFIX             "In: "
 116 #define LINE_PREFIX             "L"
 117 #define PC_PREFIX               "PC: "
 118 #define SINGLE_KEY              "(SingleKey)"
 119
 120 /* Minimum/Maximum length of some fields displayed in the TUI status
 121    line.  */
 122 #define MIN_LINE_WIDTH     4    /* Use at least 4 digits for line
 123                                    numbers.  */
 124 #define MIN_PROC_WIDTH    12
 125 #define MAX_TARGET_WIDTH  10
 126 #define MAX_PID_WIDTH     19
 127
 128 /* The kinds of layouts available.  */
 129 enum tui_layout_type
 130 {
 131   SRC_COMMAND,
 132   DISASSEM_COMMAND,
 133   SRC_DISASSEM_COMMAND,
 134   SRC_DATA_COMMAND,
 135   DISASSEM_DATA_COMMAND,
 136   UNDEFINED_LAYOUT
 137 };
 138
 139 /* Basic data types that can be displayed in the data window.  */
 140 enum tui_data_type
 141 {
 142   TUI_REGISTER,
 143   TUI_SCALAR,
 144   TUI_COMPLEX,
 145   TUI_STRUCT
 146 };
 147
 148 enum tui_line_or_address_kind
 149 {
 150   LOA_LINE,
 151   LOA_ADDRESS
 152 };
 153
 154 /* Structure describing source line or line address.  */
 155 struct tui_line_or_address
 156 {
 157   enum tui_line_or_address_kind loa;
 158   union
 159     {
 160       int line_no;
 161       CORE_ADDR addr;
 162     } u;
 163 };
 164
 165 /* Current Layout definition.  */
 166 struct tui_layout_def
 167 {
 168   enum tui_win_type display_mode;
 169   int split;
 170 };
 171
 172 /* Elements in the Source/Disassembly Window.  */
 173 struct tui_source_element
 174 {
 175   char *line;
 176   struct tui_line_or_address line_or_addr;
 177   int is_exec_point;
 178   int has_break;
 179 };
 180
 181
 182 /* Elements in the data display window content.  */
 183 struct tui_data_element
 184 {
 185   const char *name;
 186   int item_no;          /* The register number, or data display
 187                            number.  */
 188   enum tui_data_type type;
 189   void *value;
 190   int highlight;
 191   char *content;
 192 };
 193
 194
 195 /* Elements in the command window content.  */
 196 struct tui_command_element
 197 {
 198   char *line;
 199 };
 200
 201 #ifdef PATH_MAX
 202 # define MAX_LOCATOR_ELEMENT_LEN        PATH_MAX
 203 #else
 204 # define MAX_LOCATOR_ELEMENT_LEN        1024
 205 #endif
 206
 207 /* Elements in the locator window content.  */
 208 struct tui_locator_element
 209 {
 210   /* Resolved absolute filename as returned by symtab_to_fullname.  */
 211   char full_name[MAX_LOCATOR_ELEMENT_LEN];
 212   char proc_name[MAX_LOCATOR_ELEMENT_LEN];
 213   int line_no;
 214   CORE_ADDR addr;
 215   /* Architecture associated with code at this location.  */
 216   struct gdbarch *gdbarch;
 217 };
 218
 219 /* Flags to tell what kind of breakpoint is at current line.  */
 220 #define TUI_BP_ENABLED      0x01
 221 #define TUI_BP_DISABLED     0x02
 222 #define TUI_BP_HIT          0x04
 223 #define TUI_BP_CONDITIONAL  0x08
 224 #define TUI_BP_HARDWARE     0x10
 225
 226 /* Position of breakpoint markers in the exec info string.  */
 227 #define TUI_BP_HIT_POS      0
 228 #define TUI_BP_BREAK_POS    1
 229 #define TUI_EXEC_POS        2
 230 #define TUI_EXECINFO_SIZE   4
 231
 232 typedef char tui_exec_info_content[TUI_EXECINFO_SIZE];
 233
 234 /* An content element in a window.  */
 235 union tui_which_element
 236 {
 237   struct tui_source_element source;     /* The source elements.  */
 238   struct tui_gen_win_info *data_window; /* Data display elements.  */
 239   struct tui_data_element data;         /* Elements of data_window.  */
 240   struct tui_command_element command;   /* Command elements.  */
 241   struct tui_locator_element locator;   /* Locator elements.  */
 242   tui_exec_info_content simple_string;  /* Simple char based elements.  */
 243 };
 244
 245 struct tui_win_element
 246 {
 247   union tui_which_element which_element;
 248 };
 249
 250 /* This defines information about each logical window.  */
 251 struct tui_win_info : public tui_gen_win_info
 252 {
 253 protected:
 254
 255   explicit tui_win_info (enum tui_win_type type);
 256   DISABLE_COPY_AND_ASSIGN (tui_win_info);
 257
 258   /* Scroll the contents vertically.  This is only called via
 259      forward_scroll and backward_scroll.  */
 260   virtual void do_scroll_vertical (int num_to_scroll) = 0;
 261
 262   /* Scroll the contents horizontally.  This is only called via
 263      left_scroll and right_scroll.  */
 264   virtual void do_scroll_horizontal (int num_to_scroll) = 0;
 265
 266 public:
 267
 268   ~tui_win_info () override;
 269
 270   /* Clear the pertinent detail in the window.  */
 271   virtual void clear_detail () = 0;
 272
 273   /* Return true if this window has the locator.  */
 274   virtual bool has_locator () const
 275   {
 276     return false;
 277   }
 278
 279   /* Refresh this window and any associated windows.  */
 280   virtual void refresh ();
 281
 282   /* Called after all the TUI windows are refreshed, to let this
 283      window have a chance to update itself further.  */
 284   virtual void refresh_all ()
 285   {
 286   }
 287
 288   /* Called after a TUI window is given a new height; this updates any
 289      related auxiliary windows.  */
 290   virtual void set_new_height (int height)
 291   {
 292   }
 293
 294   /* Compute the maximum height of this window.  */
 295   virtual int max_height () const;
 296
 297   /* Set whether this window is highglighted.  */
 298   void set_highlight (bool highlight)
 299   {
 300     is_highlighted = highlight;
 301   }
 302
 303   /* Methods to scroll the contents of this window.  Note that they
 304      are named with "_scroll" coming at the end because the more
 305      obvious "scroll_forward" is defined as a macro in term.h.  */
 306   void forward_scroll (int num_to_scroll);
 307   void backward_scroll (int num_to_scroll);
 308   void left_scroll (int num_to_scroll);
 309   void right_scroll (int num_to_scroll);
 310
 311   /* Can this window ever be highlighted?  */
 312   bool can_highlight = false;
 313
 314   /* Is this window highlighted?  */
 315   bool is_highlighted = false;
 316 };
 317
 318 /* The base class for all source-like windows, namely the source and
 319    disassembly windows.  */
 320
 321 struct tui_source_window_base : public tui_win_info
 322 {
 323 protected:
 324   explicit tui_source_window_base (enum tui_win_type type);
 325   ~tui_source_window_base () override;
 326   DISABLE_COPY_AND_ASSIGN (tui_source_window_base);
 327
 328   void do_scroll_horizontal (int num_to_scroll) override;
 329
 330 public:
 331
 332   void clear_detail () override;
 333
 334   /* Return true if this window has the locator.  */
 335   bool has_locator () const override
 336   {
 337     return m_has_locator;
 338   }
 339
 340   void make_visible (bool visible) override;
 341   void refresh () override;
 342   void refresh_all () override;
 343
 344   /* Refill the source window's source cache and update it.  If this
 345      is a disassembly window, then just update it.  */
 346   void refill ();
 347
 348   /* Set the location of the execution point.  */
 349   void set_is_exec_point_at (struct tui_line_or_address l);
 350
 351   void set_new_height (int height) override;
 352
 353   /* Does the locator belong to this window?  */
 354   bool m_has_locator = false;
 355   /* Execution information window.  */
 356   struct tui_gen_win_info *execution_info = nullptr;
 357   /* Used for horizontal scroll.  */
 358   int horizontal_offset = 0;
 359   struct tui_line_or_address start_line_or_addr;
 360
 361   /* It is the resolved form as returned by symtab_to_fullname.  */
 362   char *fullname = nullptr;
 363
 364   /* Architecture associated with code at this location.  */
 365   struct gdbarch *gdbarch = nullptr;
 366 };
 367
 368 /* A TUI source window.  */
 369
 370 struct tui_source_window : public tui_source_window_base
 371 {
 372   tui_source_window ()
 373     : tui_source_window_base (SRC_WIN)
 374   {
 375   }
 376
 377   DISABLE_COPY_AND_ASSIGN (tui_source_window);
 378
 379   const char *name () const override
 380   {
 381     return SRC_NAME;
 382   }
 383
 384 protected:
 385
 386   void do_scroll_vertical (int num_to_scroll) override;
 387 };
 388
 389 /* A TUI disassembly window.  */
 390
 391 struct tui_disasm_window : public tui_source_window_base
 392 {
 393   tui_disasm_window ()
 394     : tui_source_window_base (DISASSEM_WIN)
 395   {
 396   }
 397
 398   DISABLE_COPY_AND_ASSIGN (tui_disasm_window);
 399
 400   const char *name () const override
 401   {
 402     return DISASSEM_NAME;
 403   }
 404
 405 protected:
 406
 407   void do_scroll_vertical (int num_to_scroll) override;
 408 };
 409
 410 struct tui_data_window : public tui_win_info
 411 {
 412   tui_data_window ()
 413     : tui_win_info (DATA_WIN)
 414   {
 415   }
 416
 417   ~tui_data_window () override;
 418   DISABLE_COPY_AND_ASSIGN (tui_data_window);
 419
 420   void clear_detail () override;
 421   void refresh_all () override;
 422
 423   void set_new_height (int height) override;
 424
 425   void refresh_window () override;
 426
 427   const char *name () const override
 428   {
 429     return DATA_NAME;
 430   }
 431
 432   /* Start of data display content.  */
 433   tui_win_content data_content = NULL;
 434   int data_content_count = 0;
 435   /* Start of regs display content.  */
 436   tui_win_content regs_content = NULL;
 437   int regs_content_count = 0;
 438   int regs_column_count = 0;
 439   /* Should regs be displayed at all?  */
 440   bool display_regs = false;
 441   struct reggroup *current_group = nullptr;
 442
 443 protected:
 444
 445   void do_scroll_vertical (int num_to_scroll) override;
 446   void do_scroll_horizontal (int num_to_scroll) override
 447   {
 448   }
 449 };
 450
 451 struct tui_cmd_window : public tui_win_info
 452 {
 453   tui_cmd_window ()
 454     : tui_win_info (CMD_WIN)
 455   {
 456   }
 457
 458   DISABLE_COPY_AND_ASSIGN (tui_cmd_window);
 459
 460   void clear_detail () override;
 461
 462   void make_visible (bool visible) override
 463   {
 464   }
 465
 466   int max_height () const override;
 467
 468   void refresh_window () override
 469   {
 470   }
 471
 472   const char *name () const override
 473   {
 474     return CMD_NAME;
 475   }
 476
 477   int start_line = 0;
 478
 479 protected:
 480
 481   void do_scroll_vertical (int num_to_scroll) override
 482   {
 483   }
 484
 485   void do_scroll_horizontal (int num_to_scroll) override
 486   {
 487   }
 488 };
 489
 490 extern int tui_win_is_auxillary (enum tui_win_type win_type);
 491
 492
 493 /* Global Data.  */
 494 extern struct tui_win_info *tui_win_list[MAX_MAJOR_WINDOWS];
 495
 496 #define TUI_SRC_WIN     ((tui_source_window_base *) tui_win_list[SRC_WIN])
 497 #define TUI_DISASM_WIN  ((tui_source_window_base *) tui_win_list[DISASSEM_WIN])
 498 #define TUI_DATA_WIN    ((tui_data_window *) tui_win_list[DATA_WIN])
 499 #define TUI_CMD_WIN     ((tui_cmd_window *) tui_win_list[CMD_WIN])
 500
 501 /* Data Manipulation Functions.  */
 502 extern void tui_initialize_static_data (void);
 503 extern struct tui_win_info *tui_alloc_win_info (enum tui_win_type);
 504 extern void tui_init_generic_part (struct tui_gen_win_info *);
 505 extern tui_win_content tui_alloc_content (int, enum tui_win_type);
 506 extern int tui_add_content_elements (struct tui_gen_win_info *,
 507                                      int);
 508 extern void tui_free_win_content (struct tui_gen_win_info *);
 509 extern void tui_free_data_content (tui_win_content, int);
 510 extern void tui_free_all_source_wins_content (void);
 511 extern struct tui_win_info *tui_partial_win_by_name (const char *);
 512 extern enum tui_layout_type tui_current_layout (void);
 513 extern void tui_set_current_layout_to (enum tui_layout_type);
 514 extern int tui_term_height (void);
 515 extern void tui_set_term_height_to (int);
 516 extern int tui_term_width (void);
 517 extern void tui_set_term_width_to (int);
 518 extern struct tui_gen_win_info *tui_locator_win_info_ptr (void);
 519 extern struct tui_gen_win_info *tui_source_exec_info_win_ptr (void);
 520 extern struct tui_gen_win_info *tui_disassem_exec_info_win_ptr (void);
 521 extern std::vector<tui_source_window_base *> &tui_source_windows ();
 522 extern void tui_clear_source_windows (void);
 523 extern void tui_clear_source_windows_detail (void);
 524 extern void tui_add_to_source_windows (struct tui_source_window_base *);
 525 extern struct tui_win_info *tui_win_with_focus (void);
 526 extern void tui_set_win_with_focus (struct tui_win_info *);
 527 extern struct tui_layout_def *tui_layout_def (void);
 528 extern int tui_win_resized (void);
 529 extern void tui_set_win_resized_to (int);
 530
 531 extern struct tui_win_info *tui_next_win (struct tui_win_info *);
 532 extern struct tui_win_info *tui_prev_win (struct tui_win_info *);
 533
 534 extern unsigned int tui_tab_width;
 535
 536 #endif /* TUI_TUI_DATA_H */