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