gdb/tui/tui-data.h

   1 /* TUI data manipulation routines.
   2
   3    Copyright (C) 1998, 1999, 2000, 2001, 2002, 2004, 2006, 2007
   4    Free Software Foundation, Inc.
   5
   6    Contributed by Hewlett-Packard Company.
   7
   8    This file is part of GDB.
   9
  10    This program is free software; you can redistribute it and/or modify
  11    it under the terms of the GNU General Public License as published by
  12    the Free Software Foundation; either version 2 of the License, or
  13    (at your option) any later version.
  14
  15    This program is distributed in the hope that it will be useful,
  16    but WITHOUT ANY WARRANTY; without even the implied warranty of
  17    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18    GNU General Public License for more details.
  19
  20    You should have received a copy of the GNU General Public License
  21    along with this program; if not, write to the Free Software
  22    Foundation, Inc., 51 Franklin Street, Fifth Floor,
  23    Boston, MA 02110-1301, USA.  */
  24
  25 #ifndef TUI_DATA_H
  26 #define TUI_DATA_H
  27
  28 #include "tui/tui.h"    /* For enum tui_win_type.  */
  29 #include "gdb_curses.h" /* For WINDOW.  */
  30
  31 /* This is a point definition.  */
  32 struct tui_point
  33 {
  34   int x, y;
  35 };
  36
  37 /* Generic window information.  */
  38 struct tui_gen_win_info
  39 {
  40   WINDOW *handle;           /* Window handle.  */
  41   enum tui_win_type type;   /* Type of window.  */
  42   int width;                /* Window width.  */
  43   int height;               /* Window height.  */
  44   struct tui_point origin;  /* Origin of window.  */
  45   void **content;           /* Content of window.  */
  46   int content_size;         /* Size of content (# of elements).  */
  47   int content_in_use;       /* Can it be used, or is it already used?  */
  48   int viewport_height;      /* Viewport height.  */
  49   int last_visible_line;    /* Index of last visible line.  */
  50   int is_visible;           /* Whether the window is visible or not.  */
  51   char *title;              /* Window title to display.  */
  52 };
  53
  54 /* Constant definitions.  */
  55 #define DEFAULT_TAB_LEN         8
  56 #define NO_SRC_STRING           "[ No Source Available ]"
  57 #define NO_DISASSEM_STRING      "[ No Assembly Available ]"
  58 #define NO_REGS_STRING          "[ Register Values Unavailable ]"
  59 #define NO_DATA_STRING          "[ No Data Values Displayed ]"
  60 #define MAX_CONTENT_COUNT       100
  61 #define SRC_NAME                "SRC"
  62 #define CMD_NAME                "CMD"
  63 #define DATA_NAME               "REGS"
  64 #define DISASSEM_NAME           "ASM"
  65 #define TUI_NULL_STR            ""
  66 #define DEFAULT_HISTORY_COUNT   25
  67 #define BOX_WINDOW              TRUE
  68 #define DONT_BOX_WINDOW         FALSE
  69 #define HILITE                  TRUE
  70 #define NO_HILITE               FALSE
  71 #define WITH_LOCATOR            TRUE
  72 #define NO_LOCATOR              FALSE
  73 #define EMPTY_SOURCE_PROMPT     TRUE
  74 #define NO_EMPTY_SOURCE_PROMPT  FALSE
  75 #define UNDEFINED_ITEM          -1
  76 #define MIN_WIN_HEIGHT          3
  77 #define MIN_CMD_WIN_HEIGHT      3
  78
  79 /* Strings to display in the TUI status line.  */
  80 #define PROC_PREFIX             "In: "
  81 #define LINE_PREFIX             "Line: "
  82 #define PC_PREFIX               "PC: "
  83 #define SINGLE_KEY              "(SingleKey)"
  84
  85 /* Minimum/Maximum length of some fields displayed in the TUI status
  86    line.  */
  87 #define MIN_LINE_WIDTH     4    /* Use at least 4 digits for line
  88                                    numbers.  */
  89 #define MIN_PROC_WIDTH    12
  90 #define MAX_TARGET_WIDTH  10
  91 #define MAX_PID_WIDTH     14
  92
  93 #define TUI_FLOAT_REGS_NAME                  "$FREGS"
  94 #define TUI_FLOAT_REGS_NAME_LOWER            "$fregs"
  95 #define TUI_GENERAL_REGS_NAME                "$GREGS"
  96 #define TUI_GENERAL_REGS_NAME_LOWER          "$gregs"
  97 #define TUI_SPECIAL_REGS_NAME                "$SREGS"
  98 #define TUI_SPECIAL_REGS_NAME_LOWER          "$sregs"
  99 #define TUI_GENERAL_SPECIAL_REGS_NAME        "$REGS"
 100 #define TUI_GENERAL_SPECIAL_REGS_NAME_LOWER  "$regs"
 101
 102 /* Scroll direction enum.  */
 103 enum tui_scroll_direction
 104 {
 105   FORWARD_SCROLL,
 106   BACKWARD_SCROLL,
 107   LEFT_SCROLL,
 108   RIGHT_SCROLL
 109 };
 110
 111
 112 /* General list struct.  */
 113 struct tui_list
 114 {
 115   struct tui_win_info **list;
 116   int count;
 117 };
 118
 119
 120 /* The kinds of layouts available.  */
 121 enum tui_layout_type
 122 {
 123   SRC_COMMAND,
 124   DISASSEM_COMMAND,
 125   SRC_DISASSEM_COMMAND,
 126   SRC_DATA_COMMAND,
 127   DISASSEM_DATA_COMMAND,
 128   UNDEFINED_LAYOUT
 129 };
 130
 131 /* Basic data types that can be displayed in the data window.  */
 132 enum tui_data_type
 133 {
 134   TUI_REGISTER,
 135   TUI_SCALAR,
 136   TUI_COMPLEX,
 137   TUI_STRUCT
 138 };
 139
 140 /* Types of register displays.  */
 141 enum tui_register_display_type
 142 {
 143   TUI_UNDEFINED_REGS,
 144   TUI_GENERAL_REGS,
 145   TUI_SFLOAT_REGS,
 146   TUI_DFLOAT_REGS,
 147   TUI_SPECIAL_REGS,
 148   TUI_GENERAL_AND_SPECIAL_REGS
 149 };
 150
 151 /* Structure describing source line or line address.  */
 152 struct tui_line_or_address
 153 {
 154   enum { LOA_LINE, LOA_ADDRESS } loa;
 155   union
 156     {
 157       int line_no;
 158       CORE_ADDR addr;
 159     } u;
 160 };
 161
 162 /* Current Layout definition.  */
 163 struct tui_layout_def
 164 {
 165   enum tui_win_type display_mode;
 166   int split;
 167   enum tui_register_display_type regs_display_type;
 168   enum tui_register_display_type float_regs_display_type;
 169 };
 170
 171 /* Elements in the Source/Disassembly Window.  */
 172 struct tui_source_element
 173 {
 174   char *line;
 175   struct tui_line_or_address line_or_addr;
 176   int is_exec_point;
 177   int has_break;
 178 };
 179
 180
 181 /* Elements in the data display window content.  */
 182 struct tui_data_element
 183 {
 184   const char *name;
 185   int item_no;          /* The register number, or data display
 186                            number.  */
 187   enum tui_data_type type;
 188   void *value;
 189   int highlight;
 190   char *content;
 191 };
 192
 193
 194 /* Elements in the command window content.  */
 195 struct tui_command_element
 196 {
 197   char *line;
 198 };
 199
 200
 201 #define MAX_LOCATOR_ELEMENT_LEN        100
 202
 203 /* Elements in the locator window content.  */
 204 struct tui_locator_element
 205 {
 206   char file_name[MAX_LOCATOR_ELEMENT_LEN];
 207   char proc_name[MAX_LOCATOR_ELEMENT_LEN];
 208   int line_no;
 209   CORE_ADDR addr;
 210 };
 211
 212 /* Flags to tell what kind of breakpoint is at current line.  */
 213 #define TUI_BP_ENABLED      0x01
 214 #define TUI_BP_DISABLED     0x02
 215 #define TUI_BP_HIT          0x04
 216 #define TUI_BP_CONDITIONAL  0x08
 217 #define TUI_BP_HARDWARE     0x10
 218
 219 /* Position of breakpoint markers in the exec info string.  */
 220 #define TUI_BP_HIT_POS      0
 221 #define TUI_BP_BREAK_POS    1
 222 #define TUI_EXEC_POS        2
 223 #define TUI_EXECINFO_SIZE   4
 224
 225 typedef char tui_exec_info_content[TUI_EXECINFO_SIZE];
 226
 227 /* An content element in a window.  */
 228 union tui_which_element
 229 {
 230   struct tui_source_element source;     /* The source elements.  */
 231   struct tui_gen_win_info data_window;  /* Data display elements.  */
 232   struct tui_data_element data;         /* Elements of data_window.  */
 233   struct tui_command_element command;   /* Command elements.  */
 234   struct tui_locator_element locator;   /* Locator elements.  */
 235   tui_exec_info_content simple_string;  /* Simple char based elements.  */
 236 };
 237
 238 struct tui_win_element
 239 {
 240   int highlight;
 241   union tui_which_element which_element;
 242 };
 243
 244
 245 /* This describes the content of the window.  */
 246 typedef struct tui_win_element **tui_win_content;
 247
 248
 249 /* This struct defines the specific information about a data display
 250    window.  */
 251 struct tui_data_info
 252 {
 253   tui_win_content data_content; /* Start of data display content.  */
 254   int data_content_count;
 255   tui_win_content regs_content; /* Start of regs display content.  */
 256   int regs_content_count;
 257   enum tui_register_display_type regs_display_type;
 258   int regs_column_count;
 259   int display_regs;             /* Should regs be displayed at all?  */
 260   struct reggroup *current_group;
 261 };
 262
 263
 264 struct tui_source_info
 265 {
 266   int has_locator;              /* Does locator belongs to this window?  */
 267   /* Execution information window.  */
 268   struct tui_gen_win_info *execution_info;
 269   int horizontal_offset;        /* Used for horizontal scroll.  */
 270   struct tui_line_or_address start_line_or_addr;
 271   char *filename;
 272 };
 273
 274
 275 struct tui_command_info
 276 {
 277   int cur_line;                 /* The current line position.  */
 278   int curch;                    /* The current cursor position.  */
 279   int start_line;
 280 };
 281
 282
 283 /* This defines information about each logical window.  */
 284 struct tui_win_info
 285 {
 286   struct tui_gen_win_info generic;      /* General window information.  */
 287   union
 288   {
 289     struct tui_source_info source_info;
 290     struct tui_data_info data_display_info;
 291     struct tui_command_info command_info;
 292     void *opaque;
 293   }
 294   detail;
 295   int can_highlight;    /* Can this window ever be highlighted?  */
 296   int is_highlighted;   /* Is this window highlighted?  */
 297 };
 298
 299 extern int tui_win_is_source_type (enum tui_win_type win_type);
 300 extern int tui_win_is_auxillary (enum tui_win_type win_type);
 301 extern int tui_win_has_locator (struct tui_win_info *win_info);
 302 extern void tui_set_win_highlight (struct tui_win_info *win_info,
 303                                    int highlight);
 304
 305
 306 /* Global Data.  */
 307 extern struct tui_win_info *(tui_win_list[MAX_MAJOR_WINDOWS]);
 308
 309 #define TUI_SRC_WIN     tui_win_list[SRC_WIN]
 310 #define TUI_DISASM_WIN  tui_win_list[DISASSEM_WIN]
 311 #define TUI_DATA_WIN    tui_win_list[DATA_WIN]
 312 #define TUI_CMD_WIN     tui_win_list[CMD_WIN]
 313
 314 /* Data Manipulation Functions.  */
 315 extern void tui_initialize_static_data (void);
 316 extern struct tui_gen_win_info *tui_alloc_generic_win_info (void);
 317 extern struct tui_win_info *tui_alloc_win_info (enum tui_win_type);
 318 extern void tui_init_generic_part (struct tui_gen_win_info *);
 319 extern void tui_init_win_info (struct tui_win_info *);
 320 extern tui_win_content tui_alloc_content (int, enum tui_win_type);
 321 extern int tui_add_content_elements (struct tui_gen_win_info *,
 322                                      int);
 323 extern void tui_init_content_element (struct tui_win_element *,
 324                                       enum tui_win_type);
 325 extern void tui_free_window (struct tui_win_info *);
 326 extern void tui_free_win_content (struct tui_gen_win_info *);
 327 extern void tui_free_data_content (tui_win_content, int);
 328 extern void tui_free_all_source_wins_content (void);
 329 extern void tui_del_window (struct tui_win_info *);
 330 extern void tui_del_data_windows (tui_win_content, int);
 331 extern struct tui_win_info *tui_partial_win_by_name (char *);
 332 extern char *tui_win_name (struct tui_gen_win_info *);
 333 extern enum tui_layout_type tui_current_layout (void);
 334 extern void tui_set_current_layout_to (enum tui_layout_type);
 335 extern int tui_term_height (void);
 336 extern void tui_set_term_height_to (int);
 337 extern int tui_term_width (void);
 338 extern void tui_set_term_width_to (int);
 339 extern void tui_set_gen_win_origin (struct tui_gen_win_info *,
 340                                     int, int);
 341 extern struct tui_gen_win_info *tui_locator_win_info_ptr (void);
 342 extern struct tui_gen_win_info *tui_source_exec_info_win_ptr (void);
 343 extern struct tui_gen_win_info *tui_disassem_exec_info_win_ptr (void);
 344 extern struct tui_list *tui_source_windows (void);
 345 extern void tui_clear_source_windows (void);
 346 extern void tui_clear_source_windows_detail (void);
 347 extern void tui_clear_win_detail (struct tui_win_info *);
 348 extern void tui_add_to_source_windows (struct tui_win_info *);
 349 extern int tui_default_tab_len (void);
 350 extern void tui_set_default_tab_len (int);
 351 extern struct tui_win_info *tui_win_with_focus (void);
 352 extern void tui_set_win_with_focus (struct tui_win_info *);
 353 extern struct tui_layout_def *tui_layout_def (void);
 354 extern int tui_win_resized (void);
 355 extern void tui_set_win_resized_to (int);
 356
 357 extern struct tui_win_info *tui_next_win (struct tui_win_info *);
 358 extern struct tui_win_info *tui_prev_win (struct tui_win_info *);
 359
 360 extern void tui_add_to_source_windows (struct tui_win_info *);
 361
 362 #endif /* TUI_DATA_H */