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 };
 180
 181 /* Elements in the Source/Disassembly Window.  */
 182 struct tui_source_element
 183 {
 184   char *line;
 185   struct tui_line_or_address line_or_addr;
 186   int is_exec_point;
 187   int has_break;
 188 };
 189
 190
 191 #ifdef PATH_MAX
 192 # define MAX_LOCATOR_ELEMENT_LEN        PATH_MAX
 193 #else
 194 # define MAX_LOCATOR_ELEMENT_LEN        1024
 195 #endif
 196
 197 /* Flags to tell what kind of breakpoint is at current line.  */
 198 #define TUI_BP_ENABLED      0x01
 199 #define TUI_BP_DISABLED     0x02
 200 #define TUI_BP_HIT          0x04
 201 #define TUI_BP_CONDITIONAL  0x08
 202 #define TUI_BP_HARDWARE     0x10
 203
 204 /* Position of breakpoint markers in the exec info string.  */
 205 #define TUI_BP_HIT_POS      0
 206 #define TUI_BP_BREAK_POS    1
 207 #define TUI_EXEC_POS        2
 208 #define TUI_EXECINFO_SIZE   4
 209
 210 typedef char tui_exec_info_content[TUI_EXECINFO_SIZE];
 211
 212 /* An content element in a window.  */
 213 union tui_which_element
 214 {
 215   struct tui_source_element source;     /* The source elements.  */
 216   struct tui_data_item_window *data_window;     /* Data display elements.  */
 217 };
 218
 219 struct tui_win_element
 220 {
 221   union tui_which_element which_element;
 222 };
 223
 224 /* Execution info window class.  */
 225
 226 struct tui_exec_info_window : public tui_gen_win_info
 227 {
 228   tui_exec_info_window ()
 229     : tui_gen_win_info (EXEC_INFO_WIN)
 230   {
 231   }
 232
 233   ~tui_exec_info_window () override
 234   {
 235     xfree (m_content);
 236   }
 237
 238   /* Get or allocate contents.  */
 239   tui_exec_info_content *maybe_allocate_content (int n_elements);
 240
 241   /* Return the contents.  */
 242   const tui_exec_info_content *get_content () const
 243   {
 244     return m_content;
 245   }
 246
 247 private:
 248
 249   tui_exec_info_content *m_content = nullptr;
 250 };
 251
 252 /* Locator window class.  */
 253
 254 struct tui_locator_window : public tui_gen_win_info
 255 {
 256   tui_locator_window ()
 257     : tui_gen_win_info (LOCATOR_WIN)
 258   {
 259     full_name[0] = 0;
 260     proc_name[0] = 0;
 261   }
 262
 263   char full_name[MAX_LOCATOR_ELEMENT_LEN];
 264   char proc_name[MAX_LOCATOR_ELEMENT_LEN];
 265   int line_no = 0;
 266   CORE_ADDR addr = 0;
 267   /* Architecture associated with code at this location.  */
 268   struct gdbarch *gdbarch = nullptr;
 269 };
 270
 271 /* A data item window.  */
 272
 273 struct tui_data_item_window : public tui_gen_win_info
 274 {
 275   tui_data_item_window ()
 276     : tui_gen_win_info (DATA_ITEM_WIN)
 277   {
 278   }
 279
 280   ~tui_data_item_window () override;
 281
 282   const char *name = nullptr;
 283   /* The register number, or data display number.  */
 284   int item_no = UNDEFINED_ITEM;
 285   enum tui_data_type data_type = TUI_REGISTER;
 286   void *value = nullptr;
 287   bool highlight = false;
 288   char *content = nullptr;
 289 };
 290
 291 /* This defines information about each logical window.  */
 292 struct tui_win_info : public tui_gen_win_info
 293 {
 294 protected:
 295
 296   explicit tui_win_info (enum tui_win_type type);
 297   DISABLE_COPY_AND_ASSIGN (tui_win_info);
 298
 299   /* Scroll the contents vertically.  This is only called via
 300      forward_scroll and backward_scroll.  */
 301   virtual void do_scroll_vertical (int num_to_scroll) = 0;
 302
 303   /* Scroll the contents horizontally.  This is only called via
 304      left_scroll and right_scroll.  */
 305   virtual void do_scroll_horizontal (int num_to_scroll) = 0;
 306
 307   /* Called after make_visible_with_new_height sets the new height.
 308      Should update the window.  */
 309   virtual void do_make_visible_with_new_height () = 0;
 310
 311 public:
 312
 313   ~tui_win_info () override
 314   {
 315   }
 316
 317   /* Clear the pertinent detail in the window.  */
 318   virtual void clear_detail () = 0;
 319
 320   /* Return true if this window has the locator.  */
 321   virtual bool has_locator () const
 322   {
 323     return false;
 324   }
 325
 326   /* Refresh this window and any associated windows.  */
 327   virtual void refresh ();
 328
 329   /* Called after all the TUI windows are refreshed, to let this
 330      window have a chance to update itself further.  */
 331   virtual void refresh_all ()
 332   {
 333   }
 334
 335   /* Called after a TUI window is given a new height; this updates any
 336      related auxiliary windows.  */
 337   virtual void set_new_height (int height)
 338   {
 339   }
 340
 341   /* Compute the maximum height of this window.  */
 342   virtual int max_height () const;
 343
 344   /* Called after the tab width has been changed.  */
 345   virtual void update_tab_width ()
 346   {
 347   }
 348
 349   /* Make the window visible after the height has been changed.  */
 350   void make_visible_with_new_height ();
 351
 352   /* Set whether this window is highglighted.  */
 353   void set_highlight (bool highlight)
 354   {
 355     is_highlighted = highlight;
 356   }
 357
 358   /* Methods to scroll the contents of this window.  Note that they
 359      are named with "_scroll" coming at the end because the more
 360      obvious "scroll_forward" is defined as a macro in term.h.  */
 361   void forward_scroll (int num_to_scroll);
 362   void backward_scroll (int num_to_scroll);
 363   void left_scroll (int num_to_scroll);
 364   void right_scroll (int num_to_scroll);
 365
 366   /* Can this window ever be highlighted?  */
 367   bool can_highlight = true;
 368
 369   /* Is this window highlighted?  */
 370   bool is_highlighted = false;
 371 };
 372
 373 /* The base class for all source-like windows, namely the source and
 374    disassembly windows.  */
 375
 376 struct tui_source_window_base : public tui_win_info
 377 {
 378 protected:
 379   explicit tui_source_window_base (enum tui_win_type type);
 380   ~tui_source_window_base () override;
 381   DISABLE_COPY_AND_ASSIGN (tui_source_window_base);
 382
 383   void do_scroll_horizontal (int num_to_scroll) override;
 384   void do_make_visible_with_new_height () override;
 385
 386 public:
 387
 388   void clear_detail () override;
 389
 390   /* Return true if this window has the locator.  */
 391   bool has_locator () const override
 392   {
 393     return m_has_locator;
 394   }
 395
 396   void make_visible (bool visible) override;
 397   void refresh () override;
 398   void refresh_all () override;
 399
 400   /* Refill the source window's source cache and update it.  If this
 401      is a disassembly window, then just update it.  */
 402   void refill ();
 403
 404   /* Set the location of the execution point.  */
 405   void set_is_exec_point_at (struct tui_line_or_address l);
 406
 407   void set_new_height (int height) override;
 408
 409   void update_tab_width () override;
 410
 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
 426 /* A TUI source window.  */
 427
 428 struct tui_source_window : public tui_source_window_base
 429 {
 430   tui_source_window ()
 431     : tui_source_window_base (SRC_WIN)
 432   {
 433   }
 434
 435   DISABLE_COPY_AND_ASSIGN (tui_source_window);
 436
 437   const char *name () const override
 438   {
 439     return SRC_NAME;
 440   }
 441
 442 protected:
 443
 444   void do_scroll_vertical (int num_to_scroll) override;
 445 };
 446
 447 /* A TUI disassembly window.  */
 448
 449 struct tui_disasm_window : public tui_source_window_base
 450 {
 451   tui_disasm_window ()
 452     : tui_source_window_base (DISASSEM_WIN)
 453   {
 454   }
 455
 456   DISABLE_COPY_AND_ASSIGN (tui_disasm_window);
 457
 458   const char *name () const override
 459   {
 460     return DISASSEM_NAME;
 461   }
 462
 463 protected:
 464
 465   void do_scroll_vertical (int num_to_scroll) override;
 466 };
 467
 468 struct tui_data_window : public tui_win_info
 469 {
 470   tui_data_window ()
 471     : tui_win_info (DATA_WIN)
 472   {
 473   }
 474
 475   ~tui_data_window () override;
 476   DISABLE_COPY_AND_ASSIGN (tui_data_window);
 477
 478   void clear_detail () override;
 479   void refresh_all () override;
 480
 481   void set_new_height (int height) override;
 482
 483   void refresh_window () override;
 484
 485   const char *name () const override
 486   {
 487     return DATA_NAME;
 488   }
 489
 490   /* Start of data display content.  */
 491   tui_win_content data_content = NULL;
 492   int data_content_count = 0;
 493   /* Start of regs display content.  */
 494   tui_win_content regs_content = NULL;
 495   int regs_content_count = 0;
 496   int regs_column_count = 0;
 497   /* Should regs be displayed at all?  */
 498   bool display_regs = false;
 499   struct reggroup *current_group = nullptr;
 500
 501 protected:
 502
 503   void do_scroll_vertical (int num_to_scroll) override;
 504   void do_scroll_horizontal (int num_to_scroll) override
 505   {
 506   }
 507   void do_make_visible_with_new_height () override;
 508 };
 509
 510 struct tui_cmd_window : public tui_win_info
 511 {
 512   tui_cmd_window ()
 513     : tui_win_info (CMD_WIN)
 514   {
 515     can_highlight = false;
 516   }
 517
 518   DISABLE_COPY_AND_ASSIGN (tui_cmd_window);
 519
 520   void clear_detail () override;
 521
 522   void make_visible (bool visible) override
 523   {
 524   }
 525
 526   int max_height () const override;
 527
 528   void refresh_window () override
 529   {
 530   }
 531
 532   const char *name () const override
 533   {
 534     return CMD_NAME;
 535   }
 536
 537   int start_line = 0;
 538
 539 protected:
 540
 541   void do_scroll_vertical (int num_to_scroll) override
 542   {
 543   }
 544
 545   void do_scroll_horizontal (int num_to_scroll) override
 546   {
 547   }
 548
 549   void do_make_visible_with_new_height () override;
 550 };
 551
 552 extern int tui_win_is_auxillary (enum tui_win_type win_type);
 553
 554
 555 /* Global Data.  */
 556 extern struct tui_win_info *tui_win_list[MAX_MAJOR_WINDOWS];
 557
 558 #define TUI_SRC_WIN     ((tui_source_window_base *) tui_win_list[SRC_WIN])
 559 #define TUI_DISASM_WIN  ((tui_source_window_base *) tui_win_list[DISASSEM_WIN])
 560 #define TUI_DATA_WIN    ((tui_data_window *) tui_win_list[DATA_WIN])
 561 #define TUI_CMD_WIN     ((tui_cmd_window *) tui_win_list[CMD_WIN])
 562
 563 /* Data Manipulation Functions.  */
 564 extern void tui_initialize_static_data (void);
 565 extern tui_win_content tui_alloc_content (int, enum tui_win_type);
 566 extern int tui_add_content_elements (struct tui_gen_win_info *,
 567                                      int);
 568 extern void tui_free_win_content (struct tui_gen_win_info *);
 569 extern void tui_free_data_content (tui_win_content, int);
 570 extern void tui_free_all_source_wins_content (void);
 571 extern struct tui_win_info *tui_partial_win_by_name (const char *);
 572 extern enum tui_layout_type tui_current_layout (void);
 573 extern void tui_set_current_layout_to (enum tui_layout_type);
 574 extern int tui_term_height (void);
 575 extern void tui_set_term_height_to (int);
 576 extern int tui_term_width (void);
 577 extern void tui_set_term_width_to (int);
 578 extern struct tui_locator_window *tui_locator_win_info_ptr (void);
 579 extern std::vector<tui_source_window_base *> &tui_source_windows ();
 580 extern void tui_clear_source_windows (void);
 581 extern void tui_clear_source_windows_detail (void);
 582 extern void tui_add_to_source_windows (struct tui_source_window_base *);
 583 extern struct tui_win_info *tui_win_with_focus (void);
 584 extern void tui_set_win_with_focus (struct tui_win_info *);
 585 extern struct tui_layout_def *tui_layout_def (void);
 586 extern int tui_win_resized (void);
 587 extern void tui_set_win_resized_to (int);
 588
 589 extern struct tui_win_info *tui_next_win (struct tui_win_info *);
 590 extern struct tui_win_info *tui_prev_win (struct tui_win_info *);
 591
 592 extern unsigned int tui_tab_width;
 593
 594 #endif /* TUI_TUI_DATA_H */