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 enum tui_line_or_address_kind
 150 {
 151   LOA_LINE,
 152   LOA_ADDRESS
 153 };
 154
 155 /* Structure describing source line or line address.  */
 156 struct tui_line_or_address
 157 {
 158   enum tui_line_or_address_kind loa;
 159   union
 160     {
 161       int line_no;
 162       CORE_ADDR addr;
 163     } u;
 164 };
 165
 166 /* Current Layout definition.  */
 167 struct tui_layout_def
 168 {
 169   enum tui_win_type display_mode;
 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 #ifdef PATH_MAX
 183 # define MAX_LOCATOR_ELEMENT_LEN        PATH_MAX
 184 #else
 185 # define MAX_LOCATOR_ELEMENT_LEN        1024
 186 #endif
 187
 188 /* Flags to tell what kind of breakpoint is at current line.  */
 189 #define TUI_BP_ENABLED      0x01
 190 #define TUI_BP_DISABLED     0x02
 191 #define TUI_BP_HIT          0x04
 192 #define TUI_BP_CONDITIONAL  0x08
 193 #define TUI_BP_HARDWARE     0x10
 194
 195 /* Position of breakpoint markers in the exec info string.  */
 196 #define TUI_BP_HIT_POS      0
 197 #define TUI_BP_BREAK_POS    1
 198 #define TUI_EXEC_POS        2
 199 #define TUI_EXECINFO_SIZE   4
 200
 201 typedef char tui_exec_info_content[TUI_EXECINFO_SIZE];
 202
 203 /* An content element in a window.  */
 204 union tui_which_element
 205 {
 206   struct tui_source_element source;     /* The source elements.  */
 207 };
 208
 209 struct tui_win_element
 210 {
 211   union tui_which_element which_element;
 212 };
 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   /* Can this window ever be highlighted?  */
 356   bool can_highlight = true;
 357
 358   /* Is this window highlighted?  */
 359   bool is_highlighted = false;
 360 };
 361
 362 /* The base class for all source-like windows, namely the source and
 363    disassembly windows.  */
 364
 365 struct tui_source_window_base : public tui_win_info
 366 {
 367 protected:
 368   explicit tui_source_window_base (enum tui_win_type type);
 369   ~tui_source_window_base () override;
 370   DISABLE_COPY_AND_ASSIGN (tui_source_window_base);
 371
 372   void do_scroll_horizontal (int num_to_scroll) override;
 373   void do_make_visible_with_new_height () override;
 374
 375 public:
 376
 377   void clear_detail () override;
 378
 379   /* Return true if this window has the locator.  */
 380   bool has_locator () const override
 381   {
 382     return m_has_locator;
 383   }
 384
 385   void make_visible (bool visible) override;
 386   void refresh () override;
 387   void refresh_all () override;
 388
 389   /* Refill the source window's source cache and update it.  If this
 390      is a disassembly window, then just update it.  */
 391   void refill ();
 392
 393   /* Set the location of the execution point.  */
 394   void set_is_exec_point_at (struct tui_line_or_address l);
 395
 396   void set_new_height (int height) override;
 397
 398   void update_tab_width () override;
 399
 400   /* Does the locator belong to this window?  */
 401   bool m_has_locator = false;
 402   /* Execution information window.  */
 403   struct tui_exec_info_window *execution_info = nullptr;
 404   /* Used for horizontal scroll.  */
 405   int horizontal_offset = 0;
 406   struct tui_line_or_address start_line_or_addr;
 407
 408   /* It is the resolved form as returned by symtab_to_fullname.  */
 409   char *fullname = nullptr;
 410
 411   /* Architecture associated with code at this location.  */
 412   struct gdbarch *gdbarch = nullptr;
 413 };
 414
 415 /* A TUI source window.  */
 416
 417 struct tui_source_window : public tui_source_window_base
 418 {
 419   tui_source_window ()
 420     : tui_source_window_base (SRC_WIN)
 421   {
 422   }
 423
 424   DISABLE_COPY_AND_ASSIGN (tui_source_window);
 425
 426   const char *name () const override
 427   {
 428     return SRC_NAME;
 429   }
 430
 431 protected:
 432
 433   void do_scroll_vertical (int num_to_scroll) override;
 434 };
 435
 436 /* A TUI disassembly window.  */
 437
 438 struct tui_disasm_window : public tui_source_window_base
 439 {
 440   tui_disasm_window ()
 441     : tui_source_window_base (DISASSEM_WIN)
 442   {
 443   }
 444
 445   DISABLE_COPY_AND_ASSIGN (tui_disasm_window);
 446
 447   const char *name () const override
 448   {
 449     return DISASSEM_NAME;
 450   }
 451
 452 protected:
 453
 454   void do_scroll_vertical (int num_to_scroll) override;
 455 };
 456
 457 struct tui_data_window : public tui_win_info
 458 {
 459   tui_data_window ()
 460     : tui_win_info (DATA_WIN)
 461   {
 462   }
 463
 464   ~tui_data_window () override;
 465   DISABLE_COPY_AND_ASSIGN (tui_data_window);
 466
 467   void clear_detail () override;
 468   void refresh_all () override;
 469
 470   void set_new_height (int height) override;
 471
 472   void refresh_window () override;
 473
 474   const char *name () const override
 475   {
 476     return DATA_NAME;
 477   }
 478
 479   /* Windows that are used to display registers.  */
 480   std::vector<std::unique_ptr<tui_data_item_window>> regs_content;
 481   int regs_column_count = 0;
 482   /* Should regs be displayed at all?  */
 483   bool display_regs = false;
 484   struct reggroup *current_group = nullptr;
 485
 486 protected:
 487
 488   void do_scroll_vertical (int num_to_scroll) override;
 489   void do_scroll_horizontal (int num_to_scroll) override
 490   {
 491   }
 492   void do_make_visible_with_new_height () override;
 493
 494   /* Return the index of the first element displayed.  If none are
 495      displayed, then return -1.  */
 496   int first_data_item_displayed ();
 497 };
 498
 499 struct tui_cmd_window : public tui_win_info
 500 {
 501   tui_cmd_window ()
 502     : tui_win_info (CMD_WIN)
 503   {
 504     can_highlight = false;
 505   }
 506
 507   DISABLE_COPY_AND_ASSIGN (tui_cmd_window);
 508
 509   void clear_detail () override;
 510
 511   void make_visible (bool visible) override
 512   {
 513   }
 514
 515   int max_height () const override;
 516
 517   void refresh_window () override
 518   {
 519   }
 520
 521   const char *name () const override
 522   {
 523     return CMD_NAME;
 524   }
 525
 526   int start_line = 0;
 527
 528 protected:
 529
 530   void do_scroll_vertical (int num_to_scroll) override
 531   {
 532   }
 533
 534   void do_scroll_horizontal (int num_to_scroll) override
 535   {
 536   }
 537
 538   void do_make_visible_with_new_height () override;
 539 };
 540
 541 extern int tui_win_is_auxiliary (enum tui_win_type win_type);
 542
 543
 544 /* Global Data.  */
 545 extern struct tui_win_info *tui_win_list[MAX_MAJOR_WINDOWS];
 546
 547 #define TUI_SRC_WIN     ((tui_source_window_base *) tui_win_list[SRC_WIN])
 548 #define TUI_DISASM_WIN  ((tui_source_window_base *) tui_win_list[DISASSEM_WIN])
 549 #define TUI_DATA_WIN    ((tui_data_window *) tui_win_list[DATA_WIN])
 550 #define TUI_CMD_WIN     ((tui_cmd_window *) tui_win_list[CMD_WIN])
 551
 552 /* Data Manipulation Functions.  */
 553 extern void tui_initialize_static_data (void);
 554 extern tui_win_content tui_alloc_content (int, enum tui_win_type);
 555 extern void tui_free_win_content (struct tui_gen_win_info *);
 556 extern void tui_free_all_source_wins_content (void);
 557 extern struct tui_win_info *tui_partial_win_by_name (const char *);
 558 extern enum tui_layout_type tui_current_layout (void);
 559 extern void tui_set_current_layout_to (enum tui_layout_type);
 560 extern int tui_term_height (void);
 561 extern void tui_set_term_height_to (int);
 562 extern int tui_term_width (void);
 563 extern void tui_set_term_width_to (int);
 564 extern struct tui_locator_window *tui_locator_win_info_ptr (void);
 565 extern std::vector<tui_source_window_base *> &tui_source_windows ();
 566 extern void tui_clear_source_windows (void);
 567 extern void tui_clear_source_windows_detail (void);
 568 extern void tui_add_to_source_windows (struct tui_source_window_base *);
 569 extern struct tui_win_info *tui_win_with_focus (void);
 570 extern void tui_set_win_with_focus (struct tui_win_info *);
 571 extern struct tui_layout_def *tui_layout_def (void);
 572 extern int tui_win_resized (void);
 573 extern void tui_set_win_resized_to (int);
 574
 575 extern struct tui_win_info *tui_next_win (struct tui_win_info *);
 576 extern struct tui_win_info *tui_prev_win (struct tui_win_info *);
 577
 578 extern unsigned int tui_tab_width;
 579
 580 #endif /* TUI_TUI_DATA_H */