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