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