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