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 };
 253
 254 struct tui_win_element
 255 {
 256   union tui_which_element which_element;
 257 };
 258
 259 /* Execution info window class.  */
 260
 261 struct tui_exec_info_window : public tui_gen_win_info
 262 {
 263   tui_exec_info_window ()
 264     : tui_gen_win_info (EXEC_INFO_WIN)
 265   {
 266   }
 267
 268   ~tui_exec_info_window () override
 269   {
 270     xfree (m_content);
 271   }
 272
 273   /* Get or allocate contents.  */
 274   tui_exec_info_content *maybe_allocate_content (int n_elements);
 275
 276   /* Return the contents.  */
 277   const tui_exec_info_content *get_content () const
 278   {
 279     return m_content;
 280   }
 281
 282 private:
 283
 284   tui_exec_info_content *m_content = nullptr;
 285 };
 286
 287 /* This defines information about each logical window.  */
 288 struct tui_win_info : public tui_gen_win_info
 289 {
 290 protected:
 291
 292   explicit tui_win_info (enum tui_win_type type);
 293   DISABLE_COPY_AND_ASSIGN (tui_win_info);
 294
 295   /* Scroll the contents vertically.  This is only called via
 296      forward_scroll and backward_scroll.  */
 297   virtual void do_scroll_vertical (int num_to_scroll) = 0;
 298
 299   /* Scroll the contents horizontally.  This is only called via
 300      left_scroll and right_scroll.  */
 301   virtual void do_scroll_horizontal (int num_to_scroll) = 0;
 302
 303   /* Called after make_visible_with_new_height sets the new height.
 304      Should update the window.  */
 305   virtual void do_make_visible_with_new_height () = 0;
 306
 307 public:
 308
 309   ~tui_win_info () override
 310   {
 311   }
 312
 313   /* Clear the pertinent detail in the window.  */
 314   virtual void clear_detail () = 0;
 315
 316   /* Return true if this window has the locator.  */
 317   virtual bool has_locator () const
 318   {
 319     return false;
 320   }
 321
 322   /* Refresh this window and any associated windows.  */
 323   virtual void refresh ();
 324
 325   /* Called after all the TUI windows are refreshed, to let this
 326      window have a chance to update itself further.  */
 327   virtual void refresh_all ()
 328   {
 329   }
 330
 331   /* Called after a TUI window is given a new height; this updates any
 332      related auxiliary windows.  */
 333   virtual void set_new_height (int height)
 334   {
 335   }
 336
 337   /* Compute the maximum height of this window.  */
 338   virtual int max_height () const;
 339
 340   /* Called after the tab width has been changed.  */
 341   virtual void update_tab_width ()
 342   {
 343   }
 344
 345   /* Make the window visible after the height has been changed.  */
 346   void make_visible_with_new_height ();
 347
 348   /* Set whether this window is highglighted.  */
 349   void set_highlight (bool highlight)
 350   {
 351     is_highlighted = highlight;
 352   }
 353
 354   /* Methods to scroll the contents of this window.  Note that they
 355      are named with "_scroll" coming at the end because the more
 356      obvious "scroll_forward" is defined as a macro in term.h.  */
 357   void forward_scroll (int num_to_scroll);
 358   void backward_scroll (int num_to_scroll);
 359   void left_scroll (int num_to_scroll);
 360   void right_scroll (int num_to_scroll);
 361
 362   /* Can this window ever be highlighted?  */
 363   bool can_highlight = true;
 364
 365   /* Is this window highlighted?  */
 366   bool is_highlighted = false;
 367 };
 368
 369 /* The base class for all source-like windows, namely the source and
 370    disassembly windows.  */
 371
 372 struct tui_source_window_base : public tui_win_info
 373 {
 374 protected:
 375   explicit tui_source_window_base (enum tui_win_type type);
 376   ~tui_source_window_base () override;
 377   DISABLE_COPY_AND_ASSIGN (tui_source_window_base);
 378
 379   void do_scroll_horizontal (int num_to_scroll) override;
 380   void do_make_visible_with_new_height () override;
 381
 382 public:
 383
 384   void clear_detail () override;
 385
 386   /* Return true if this window has the locator.  */
 387   bool has_locator () const override
 388   {
 389     return m_has_locator;
 390   }
 391
 392   void make_visible (bool visible) override;
 393   void refresh () override;
 394   void refresh_all () override;
 395
 396   /* Refill the source window's source cache and update it.  If this
 397      is a disassembly window, then just update it.  */
 398   void refill ();
 399
 400   /* Set the location of the execution point.  */
 401   void set_is_exec_point_at (struct tui_line_or_address l);
 402
 403   void set_new_height (int height) override;
 404
 405   void update_tab_width () override;
 406
 407   /* Does the locator belong to this window?  */
 408   bool m_has_locator = false;
 409   /* Execution information window.  */
 410   struct tui_exec_info_window *execution_info = nullptr;
 411   /* Used for horizontal scroll.  */
 412   int horizontal_offset = 0;
 413   struct tui_line_or_address start_line_or_addr;
 414
 415   /* It is the resolved form as returned by symtab_to_fullname.  */
 416   char *fullname = nullptr;
 417
 418   /* Architecture associated with code at this location.  */
 419   struct gdbarch *gdbarch = nullptr;
 420 };
 421
 422 /* A TUI source window.  */
 423
 424 struct tui_source_window : public tui_source_window_base
 425 {
 426   tui_source_window ()
 427     : tui_source_window_base (SRC_WIN)
 428   {
 429   }
 430
 431   DISABLE_COPY_AND_ASSIGN (tui_source_window);
 432
 433   const char *name () const override
 434   {
 435     return SRC_NAME;
 436   }
 437
 438 protected:
 439
 440   void do_scroll_vertical (int num_to_scroll) override;
 441 };
 442
 443 /* A TUI disassembly window.  */
 444
 445 struct tui_disasm_window : public tui_source_window_base
 446 {
 447   tui_disasm_window ()
 448     : tui_source_window_base (DISASSEM_WIN)
 449   {
 450   }
 451
 452   DISABLE_COPY_AND_ASSIGN (tui_disasm_window);
 453
 454   const char *name () const override
 455   {
 456     return DISASSEM_NAME;
 457   }
 458
 459 protected:
 460
 461   void do_scroll_vertical (int num_to_scroll) override;
 462 };
 463
 464 struct tui_data_window : public tui_win_info
 465 {
 466   tui_data_window ()
 467     : tui_win_info (DATA_WIN)
 468   {
 469   }
 470
 471   ~tui_data_window () override;
 472   DISABLE_COPY_AND_ASSIGN (tui_data_window);
 473
 474   void clear_detail () override;
 475   void refresh_all () override;
 476
 477   void set_new_height (int height) override;
 478
 479   void refresh_window () override;
 480
 481   const char *name () const override
 482   {
 483     return DATA_NAME;
 484   }
 485
 486   /* Start of data display content.  */
 487   tui_win_content data_content = NULL;
 488   int data_content_count = 0;
 489   /* Start of regs display content.  */
 490   tui_win_content regs_content = NULL;
 491   int regs_content_count = 0;
 492   int regs_column_count = 0;
 493   /* Should regs be displayed at all?  */
 494   bool display_regs = false;
 495   struct reggroup *current_group = nullptr;
 496
 497 protected:
 498
 499   void do_scroll_vertical (int num_to_scroll) override;
 500   void do_scroll_horizontal (int num_to_scroll) override
 501   {
 502   }
 503   void do_make_visible_with_new_height () override;
 504 };
 505
 506 struct tui_cmd_window : public tui_win_info
 507 {
 508   tui_cmd_window ()
 509     : tui_win_info (CMD_WIN)
 510   {
 511     can_highlight = false;
 512   }
 513
 514   DISABLE_COPY_AND_ASSIGN (tui_cmd_window);
 515
 516   void clear_detail () override;
 517
 518   void make_visible (bool visible) override
 519   {
 520   }
 521
 522   int max_height () const override;
 523
 524   void refresh_window () override
 525   {
 526   }
 527
 528   const char *name () const override
 529   {
 530     return CMD_NAME;
 531   }
 532
 533   int start_line = 0;
 534
 535 protected:
 536
 537   void do_scroll_vertical (int num_to_scroll) override
 538   {
 539   }
 540
 541   void do_scroll_horizontal (int num_to_scroll) override
 542   {
 543   }
 544
 545   void do_make_visible_with_new_height () override;
 546 };
 547
 548 extern int tui_win_is_auxillary (enum tui_win_type win_type);
 549
 550
 551 /* Global Data.  */
 552 extern struct tui_win_info *tui_win_list[MAX_MAJOR_WINDOWS];
 553
 554 #define TUI_SRC_WIN     ((tui_source_window_base *) tui_win_list[SRC_WIN])
 555 #define TUI_DISASM_WIN  ((tui_source_window_base *) tui_win_list[DISASSEM_WIN])
 556 #define TUI_DATA_WIN    ((tui_data_window *) tui_win_list[DATA_WIN])
 557 #define TUI_CMD_WIN     ((tui_cmd_window *) tui_win_list[CMD_WIN])
 558
 559 /* Data Manipulation Functions.  */
 560 extern void tui_initialize_static_data (void);
 561 extern void tui_init_generic_part (struct tui_gen_win_info *);
 562 extern tui_win_content tui_alloc_content (int, enum tui_win_type);
 563 extern int tui_add_content_elements (struct tui_gen_win_info *,
 564                                      int);
 565 extern void tui_free_win_content (struct tui_gen_win_info *);
 566 extern void tui_free_data_content (tui_win_content, int);
 567 extern void tui_free_all_source_wins_content (void);
 568 extern struct tui_win_info *tui_partial_win_by_name (const char *);
 569 extern enum tui_layout_type tui_current_layout (void);
 570 extern void tui_set_current_layout_to (enum tui_layout_type);
 571 extern int tui_term_height (void);
 572 extern void tui_set_term_height_to (int);
 573 extern int tui_term_width (void);
 574 extern void tui_set_term_width_to (int);
 575 extern struct tui_gen_win_info *tui_locator_win_info_ptr (void);
 576 extern std::vector<tui_source_window_base *> &tui_source_windows ();
 577 extern void tui_clear_source_windows (void);
 578 extern void tui_clear_source_windows_detail (void);
 579 extern void tui_add_to_source_windows (struct tui_source_window_base *);
 580 extern struct tui_win_info *tui_win_with_focus (void);
 581 extern void tui_set_win_with_focus (struct tui_win_info *);
 582 extern struct tui_layout_def *tui_layout_def (void);
 583 extern int tui_win_resized (void);
 584 extern void tui_set_win_resized_to (int);
 585
 586 extern struct tui_win_info *tui_next_win (struct tui_win_info *);
 587 extern struct tui_win_info *tui_prev_win (struct tui_win_info *);
 588
 589 extern unsigned int tui_tab_width;
 590
 591 #endif /* TUI_TUI_DATA_H */