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