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