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 #include "observable.h"
  28
  29 /* This is a point definition.  */
  30 struct tui_point
  31 {
  32   int x, y;
  33 };
  34
  35 /* Generic window information.  */
  36 struct tui_gen_win_info
  37 {
  38 protected:
  39
  40   explicit tui_gen_win_info (enum tui_win_type t)
  41     : type (t)
  42   {
  43   }
  44
  45 public:
  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   /* Viewport height.  */
  79   int viewport_height = 0;
  80   /* Index of last visible line.  */
  81   int last_visible_line = 0;
  82   /* Whether the window is visible or not.  */
  83   bool is_visible = false;
  84   /* Window title to display.  */
  85   char *title = nullptr;
  86 };
  87
  88 /* Whether or not a window should be drawn with a box.  */
  89 enum tui_box
  90 {
  91   DONT_BOX_WINDOW = 0,
  92   BOX_WINDOW
  93 };
  94
  95 /* Constant definitions.  */
  96 #define DEFAULT_TAB_LEN         8
  97 #define NO_SRC_STRING           "[ No Source Available ]"
  98 #define NO_DISASSEM_STRING      "[ No Assembly Available ]"
  99 #define NO_REGS_STRING          "[ Register Values Unavailable ]"
 100 #define NO_DATA_STRING          "[ No Data Values Displayed ]"
 101 #define MAX_CONTENT_COUNT       100
 102 #define SRC_NAME                "src"
 103 #define CMD_NAME                "cmd"
 104 #define DATA_NAME               "regs"
 105 #define DISASSEM_NAME           "asm"
 106 #define TUI_NULL_STR            ""
 107 #define DEFAULT_HISTORY_COUNT   25
 108 #define HILITE                  TRUE
 109 #define NO_HILITE               FALSE
 110 #define WITH_LOCATOR            TRUE
 111 #define NO_LOCATOR              FALSE
 112 #define EMPTY_SOURCE_PROMPT     TRUE
 113 #define NO_EMPTY_SOURCE_PROMPT  FALSE
 114 #define UNDEFINED_ITEM          -1
 115 #define MIN_WIN_HEIGHT          3
 116 #define MIN_CMD_WIN_HEIGHT      3
 117
 118 /* Strings to display in the TUI status line.  */
 119 #define PROC_PREFIX             "In: "
 120 #define LINE_PREFIX             "L"
 121 #define PC_PREFIX               "PC: "
 122 #define SINGLE_KEY              "(SingleKey)"
 123
 124 /* Minimum/Maximum length of some fields displayed in the TUI status
 125    line.  */
 126 #define MIN_LINE_WIDTH     4    /* Use at least 4 digits for line
 127                                    numbers.  */
 128 #define MIN_PROC_WIDTH    12
 129 #define MAX_TARGET_WIDTH  10
 130 #define MAX_PID_WIDTH     19
 131
 132 /* The kinds of layouts available.  */
 133 enum tui_layout_type
 134 {
 135   SRC_COMMAND,
 136   DISASSEM_COMMAND,
 137   SRC_DISASSEM_COMMAND,
 138   SRC_DATA_COMMAND,
 139   DISASSEM_DATA_COMMAND,
 140   UNDEFINED_LAYOUT
 141 };
 142
 143 enum tui_line_or_address_kind
 144 {
 145   LOA_LINE,
 146   LOA_ADDRESS
 147 };
 148
 149 /* Structure describing source line or line address.  */
 150 struct tui_line_or_address
 151 {
 152   enum tui_line_or_address_kind loa;
 153   union
 154     {
 155       int line_no;
 156       CORE_ADDR addr;
 157     } u;
 158 };
 159
 160 /* Current Layout definition.  */
 161 struct tui_layout_def
 162 {
 163   enum tui_win_type display_mode;
 164 };
 165
 166 /* Flags to tell what kind of breakpoint is at current line.  */
 167 enum tui_bp_flag
 168 {
 169   TUI_BP_ENABLED = 0x01,
 170   TUI_BP_DISABLED = 0x02,
 171   TUI_BP_HIT = 0x04,
 172   TUI_BP_CONDITIONAL = 0x08,
 173   TUI_BP_HARDWARE = 0x10
 174 };
 175
 176 DEF_ENUM_FLAGS_TYPE (enum tui_bp_flag, tui_bp_flags);
 177
 178 /* Elements in the Source/Disassembly Window.  */
 179 struct tui_source_element
 180 {
 181   tui_source_element ()
 182   {
 183     line_or_addr.loa = LOA_LINE;
 184     line_or_addr.u.line_no = 0;
 185   }
 186
 187   ~tui_source_element ()
 188   {
 189     xfree (line);
 190   }
 191
 192   char *line = nullptr;
 193   struct tui_line_or_address line_or_addr;
 194   bool is_exec_point = false;
 195   tui_bp_flags break_mode = 0;
 196 };
 197
 198
 199 #ifdef PATH_MAX
 200 # define MAX_LOCATOR_ELEMENT_LEN        PATH_MAX
 201 #else
 202 # define MAX_LOCATOR_ELEMENT_LEN        1024
 203 #endif
 204
 205 /* Position of breakpoint markers in the exec info string.  */
 206 #define TUI_BP_HIT_POS      0
 207 #define TUI_BP_BREAK_POS    1
 208 #define TUI_EXEC_POS        2
 209 #define TUI_EXECINFO_SIZE   4
 210
 211 typedef char tui_exec_info_content[TUI_EXECINFO_SIZE];
 212
 213 /* Execution info window class.  */
 214
 215 struct tui_exec_info_window : public tui_gen_win_info
 216 {
 217   tui_exec_info_window ()
 218     : tui_gen_win_info (EXEC_INFO_WIN)
 219   {
 220   }
 221
 222   ~tui_exec_info_window () override
 223   {
 224     xfree (m_content);
 225   }
 226
 227   /* Get or allocate contents.  */
 228   tui_exec_info_content *maybe_allocate_content (int n_elements);
 229
 230   /* Return the contents.  */
 231   const tui_exec_info_content *get_content () const
 232   {
 233     return m_content;
 234   }
 235
 236 private:
 237
 238   tui_exec_info_content *m_content = nullptr;
 239 };
 240
 241 /* Locator window class.  */
 242
 243 struct tui_locator_window : public tui_gen_win_info
 244 {
 245   tui_locator_window ()
 246     : tui_gen_win_info (LOCATOR_WIN)
 247   {
 248     full_name[0] = 0;
 249     proc_name[0] = 0;
 250   }
 251
 252   char full_name[MAX_LOCATOR_ELEMENT_LEN];
 253   char proc_name[MAX_LOCATOR_ELEMENT_LEN];
 254   int line_no = 0;
 255   CORE_ADDR addr = 0;
 256   /* Architecture associated with code at this location.  */
 257   struct gdbarch *gdbarch = nullptr;
 258 };
 259
 260 /* A data item window.  */
 261
 262 struct tui_data_item_window : public tui_gen_win_info
 263 {
 264   tui_data_item_window ()
 265     : tui_gen_win_info (DATA_ITEM_WIN)
 266   {
 267   }
 268
 269   ~tui_data_item_window () override;
 270
 271   const char *name = nullptr;
 272   /* The register number, or data display number.  */
 273   int item_no = UNDEFINED_ITEM;
 274   void *value = nullptr;
 275   bool highlight = false;
 276   char *content = nullptr;
 277 };
 278
 279 /* This defines information about each logical window.  */
 280 struct tui_win_info : public tui_gen_win_info
 281 {
 282 protected:
 283
 284   explicit tui_win_info (enum tui_win_type type);
 285   DISABLE_COPY_AND_ASSIGN (tui_win_info);
 286
 287   /* Scroll the contents vertically.  This is only called via
 288      forward_scroll and backward_scroll.  */
 289   virtual void do_scroll_vertical (int num_to_scroll) = 0;
 290
 291   /* Scroll the contents horizontally.  This is only called via
 292      left_scroll and right_scroll.  */
 293   virtual void do_scroll_horizontal (int num_to_scroll) = 0;
 294
 295   /* Called after make_visible_with_new_height sets the new height.
 296      Should update the window.  */
 297   virtual void do_make_visible_with_new_height () = 0;
 298
 299 public:
 300
 301   ~tui_win_info () override
 302   {
 303   }
 304
 305   /* Clear the pertinent detail in the window.  */
 306   virtual void clear_detail () = 0;
 307
 308   /* Return true if this window has the locator.  */
 309   virtual bool has_locator () const
 310   {
 311     return false;
 312   }
 313
 314   /* Refresh this window and any associated windows.  */
 315   virtual void refresh ();
 316
 317   /* Called after all the TUI windows are refreshed, to let this
 318      window have a chance to update itself further.  */
 319   virtual void refresh_all ()
 320   {
 321   }
 322
 323   /* Called after a TUI window is given a new height; this updates any
 324      related auxiliary windows.  */
 325   virtual void set_new_height (int height)
 326   {
 327   }
 328
 329   /* Compute the maximum height of this window.  */
 330   virtual int max_height () const;
 331
 332   /* Called after the tab width has been changed.  */
 333   virtual void update_tab_width ()
 334   {
 335   }
 336
 337   /* Make the window visible after the height has been changed.  */
 338   void make_visible_with_new_height ();
 339
 340   /* Set whether this window is highglighted.  */
 341   void set_highlight (bool highlight)
 342   {
 343     is_highlighted = highlight;
 344   }
 345
 346   /* Methods to scroll the contents of this window.  Note that they
 347      are named with "_scroll" coming at the end because the more
 348      obvious "scroll_forward" is defined as a macro in term.h.  */
 349   void forward_scroll (int num_to_scroll);
 350   void backward_scroll (int num_to_scroll);
 351   void left_scroll (int num_to_scroll);
 352   void right_scroll (int num_to_scroll);
 353
 354   /* Return true if this window can be scrolled, false otherwise.  */
 355   virtual bool can_scroll () const
 356   {
 357     return true;
 358   }
 359
 360   /* Can this window ever be highlighted?  */
 361   bool can_highlight = true;
 362
 363   /* Is this window highlighted?  */
 364   bool is_highlighted = false;
 365 };
 366
 367 /* The base class for all source-like windows, namely the source and
 368    disassembly windows.  */
 369
 370 struct tui_source_window_base : public tui_win_info
 371 {
 372 protected:
 373   explicit tui_source_window_base (enum tui_win_type type);
 374   ~tui_source_window_base () override;
 375   DISABLE_COPY_AND_ASSIGN (tui_source_window_base);
 376
 377   void do_scroll_horizontal (int num_to_scroll) override;
 378   void do_make_visible_with_new_height () override;
 379
 380 public:
 381
 382   void clear_detail () override;
 383
 384   /* Return true if this window has the locator.  */
 385   bool has_locator () const override
 386   {
 387     return m_has_locator;
 388   }
 389
 390   void make_visible (bool visible) override;
 391   void refresh () override;
 392   void refresh_all () override;
 393
 394   /* Refill the source window's source cache and update it.  If this
 395      is a disassembly window, then just update it.  */
 396   void refill ();
 397
 398   /* Set the location of the execution point.  */
 399   void set_is_exec_point_at (struct tui_line_or_address l);
 400
 401   void set_new_height (int height) override;
 402
 403   void update_tab_width () override;
 404
 405   /* Return true if the location LOC corresponds to the line number
 406      LINE_NO in this source window; false otherwise.  */
 407   virtual bool location_matches_p (struct bp_location *loc, int line_no) = 0;
 408
 409   /* Can it be used, or is it already used?  */
 410   bool content_in_use = false;
 411   /* Does the locator belong to this window?  */
 412   bool m_has_locator = false;
 413   /* Execution information window.  */
 414   struct tui_exec_info_window *execution_info = nullptr;
 415   /* Used for horizontal scroll.  */
 416   int horizontal_offset = 0;
 417   struct tui_line_or_address start_line_or_addr;
 418
 419   /* It is the resolved form as returned by symtab_to_fullname.  */
 420   char *fullname = nullptr;
 421
 422   /* Architecture associated with code at this location.  */
 423   struct gdbarch *gdbarch = nullptr;
 424
 425   std::vector<tui_source_element> content;
 426 };
 427
 428 /* A TUI source window.  */
 429
 430 struct tui_source_window : public tui_source_window_base
 431 {
 432   tui_source_window ();
 433   ~tui_source_window ();
 434
 435   DISABLE_COPY_AND_ASSIGN (tui_source_window);
 436
 437   const char *name () const override
 438   {
 439     return SRC_NAME;
 440   }
 441
 442   bool location_matches_p (struct bp_location *loc, int line_no) override;
 443
 444   bool showing_source_p (const char *filename) const;
 445
 446 protected:
 447
 448   void do_scroll_vertical (int num_to_scroll) override;
 449
 450 private:
 451
 452   void style_changed ();
 453
 454   /* A token used to register and unregister an observer.  */
 455   gdb::observers::token m_observable;
 456 };
 457
 458 /* A TUI disassembly window.  */
 459
 460 struct tui_disasm_window : public tui_source_window_base
 461 {
 462   tui_disasm_window ()
 463     : tui_source_window_base (DISASSEM_WIN)
 464   {
 465   }
 466
 467   DISABLE_COPY_AND_ASSIGN (tui_disasm_window);
 468
 469   const char *name () const override
 470   {
 471     return DISASSEM_NAME;
 472   }
 473
 474   bool location_matches_p (struct bp_location *loc, int line_no) override;
 475
 476 protected:
 477
 478   void do_scroll_vertical (int num_to_scroll) override;
 479 };
 480
 481 struct tui_data_window : public tui_win_info
 482 {
 483   tui_data_window ()
 484     : tui_win_info (DATA_WIN)
 485   {
 486   }
 487
 488   DISABLE_COPY_AND_ASSIGN (tui_data_window);
 489
 490   void clear_detail () override;
 491   void refresh_all () override;
 492
 493   void set_new_height (int height) override;
 494
 495   void refresh_window () override;
 496
 497   const char *name () const override
 498   {
 499     return DATA_NAME;
 500   }
 501
 502   /* Windows that are used to display registers.  */
 503   std::vector<std::unique_ptr<tui_data_item_window>> regs_content;
 504   int regs_column_count = 0;
 505   /* Should regs be displayed at all?  */
 506   bool display_regs = false;
 507   struct reggroup *current_group = nullptr;
 508
 509   /* Answer the number of the last line in the regs display.  If there
 510      are no registers (-1) is returned.  */
 511   int last_regs_line_no () const;
 512
 513   /* Answer the line number that the register element at element_no is
 514      on.  If element_no is greater than the number of register
 515      elements there are, -1 is returned.  */
 516   int line_from_reg_element_no (int element_no) const;
 517
 518   /* Answer the index of the first element in line_no.  If line_no is
 519      past the register area (-1) is returned.  */
 520   int first_reg_element_no_inline (int line_no) const;
 521
 522   /* Displays the data that is in the data window's content.  It does
 523      not set the content.  */
 524   void display_all_data ();
 525
 526   /* Delete all the item windows in the data window.  This is usually
 527      done when the data window is scrolled.  */
 528   void delete_data_content_windows ();
 529
 530   void erase_data_content (const char *prompt);
 531
 532   /* Display the registers in the content from 'start_element_no'
 533      until the end of the register content or the end of the display
 534      height.  No checking for displaying past the end of the registers
 535      is done here.  */
 536   void display_registers_from (int start_element_no);
 537
 538   /* Display the registers starting at line line_no in the data
 539      window.  Answers the line number that the display actually
 540      started from.  If nothing is displayed (-1) is returned.  */
 541   int display_registers_from_line (int line_no);
 542
 543 protected:
 544
 545   void do_scroll_vertical (int num_to_scroll) override;
 546   void do_scroll_horizontal (int num_to_scroll) override
 547   {
 548   }
 549   void do_make_visible_with_new_height () override;
 550
 551   /* Return the index of the first element displayed.  If none are
 552      displayed, then return -1.  */
 553   int first_data_item_displayed ();
 554
 555   /* Display the registers in the content from 'start_element_no' on
 556      'start_line_no' until the end of the register content or the end
 557      of the display height.  This function checks that we won't
 558      display off the end of the register display.  */
 559   void display_reg_element_at_line (int start_element_no, int start_line_no);
 560 };
 561
 562 struct tui_cmd_window : public tui_win_info
 563 {
 564   tui_cmd_window ()
 565     : tui_win_info (CMD_WIN)
 566   {
 567     can_highlight = false;
 568   }
 569
 570   DISABLE_COPY_AND_ASSIGN (tui_cmd_window);
 571
 572   void clear_detail () override;
 573
 574   void make_visible (bool visible) override
 575   {
 576   }
 577
 578   int max_height () const override;
 579
 580   void refresh_window () override
 581   {
 582   }
 583
 584   const char *name () const override
 585   {
 586     return CMD_NAME;
 587   }
 588
 589   bool can_scroll () const override
 590   {
 591     return false;
 592   }
 593
 594   int start_line = 0;
 595
 596 protected:
 597
 598   void do_scroll_vertical (int num_to_scroll) override
 599   {
 600   }
 601
 602   void do_scroll_horizontal (int num_to_scroll) override
 603   {
 604   }
 605
 606   void do_make_visible_with_new_height () override;
 607 };
 608
 609 extern int tui_win_is_auxiliary (enum tui_win_type win_type);
 610
 611
 612 /* Global Data.  */
 613 extern struct tui_win_info *tui_win_list[MAX_MAJOR_WINDOWS];
 614
 615 #define TUI_SRC_WIN     ((tui_source_window *) tui_win_list[SRC_WIN])
 616 #define TUI_DISASM_WIN  ((tui_source_window_base *) tui_win_list[DISASSEM_WIN])
 617 #define TUI_DATA_WIN    ((tui_data_window *) tui_win_list[DATA_WIN])
 618 #define TUI_CMD_WIN     ((tui_cmd_window *) tui_win_list[CMD_WIN])
 619
 620 /* An iterator that iterates over all windows.  */
 621
 622 class tui_window_iterator
 623 {
 624 public:
 625
 626   typedef tui_window_iterator self_type;
 627   typedef struct tui_win_info *value_type;
 628   typedef struct tui_win_info *&reference;
 629   typedef struct tui_win_info **pointer;
 630   typedef std::forward_iterator_tag iterator_category;
 631   typedef int difference_type;
 632
 633   explicit tui_window_iterator (enum tui_win_type type)
 634     : m_type (type)
 635   {
 636     advance ();
 637   }
 638
 639   tui_window_iterator ()
 640     : m_type (MAX_MAJOR_WINDOWS)
 641   {
 642   }
 643
 644   bool operator!= (const self_type &other) const
 645   {
 646     return m_type != other.m_type;
 647   }
 648
 649   value_type operator* () const
 650   {
 651     gdb_assert (m_type < MAX_MAJOR_WINDOWS);
 652     return tui_win_list[m_type];
 653   }
 654
 655   self_type &operator++ ()
 656   {
 657     ++m_type;
 658     advance ();
 659     return *this;
 660   }
 661
 662 private:
 663
 664   void advance ()
 665   {
 666     while (m_type < MAX_MAJOR_WINDOWS && tui_win_list[m_type] == nullptr)
 667       ++m_type;
 668   }
 669
 670   int m_type;
 671 };
 672
 673 /* A range adapter for iterating over TUI windows.  */
 674
 675 struct all_tui_windows
 676 {
 677   tui_window_iterator begin () const
 678   {
 679     return tui_window_iterator (SRC_WIN);
 680   }
 681
 682   tui_window_iterator end () const
 683   {
 684     return tui_window_iterator ();
 685   }
 686 };
 687
 688
 689 /* Data Manipulation Functions.  */
 690 extern void tui_initialize_static_data (void);
 691 extern struct tui_win_info *tui_partial_win_by_name (const char *);
 692 extern enum tui_layout_type tui_current_layout (void);
 693 extern void tui_set_current_layout_to (enum tui_layout_type);
 694 extern int tui_term_height (void);
 695 extern void tui_set_term_height_to (int);
 696 extern int tui_term_width (void);
 697 extern void tui_set_term_width_to (int);
 698 extern struct tui_locator_window *tui_locator_win_info_ptr (void);
 699 extern std::vector<tui_source_window_base *> &tui_source_windows ();
 700 extern void tui_clear_source_windows (void);
 701 extern void tui_clear_source_windows_detail (void);
 702 extern void tui_add_to_source_windows (struct tui_source_window_base *);
 703 extern struct tui_win_info *tui_win_with_focus (void);
 704 extern void tui_set_win_with_focus (struct tui_win_info *);
 705 extern struct tui_layout_def *tui_layout_def (void);
 706 extern int tui_win_resized (void);
 707 extern void tui_set_win_resized_to (int);
 708
 709 extern struct tui_win_info *tui_next_win (struct tui_win_info *);
 710 extern struct tui_win_info *tui_prev_win (struct tui_win_info *);
 711
 712 extern unsigned int tui_tab_width;
 713
 714 #endif /* TUI_TUI_DATA_H */