contrib/gdb/gdb/tui/tui-data.h

   1 /* TUI data manipulation routines.
   2
   3    Copyright 1998, 1999, 2000, 2001, 2002, 2004 Free Software
   4    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., 59 Temple Place - Suite 330,
  23    Boston, MA 02111-1307, 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 line.  */
  86 #define MIN_LINE_WIDTH     4 /* Use at least 4 digits for line numbers.  */
  87 #define MIN_PROC_WIDTH    12
  88 #define MAX_TARGET_WIDTH  10
  89 #define MAX_PID_WIDTH     14
  90
  91 #define TUI_FLOAT_REGS_NAME                  "$FREGS"
  92 #define TUI_FLOAT_REGS_NAME_LOWER            "$fregs"
  93 #define TUI_GENERAL_REGS_NAME                "$GREGS"
  94 #define TUI_GENERAL_REGS_NAME_LOWER          "$gregs"
  95 #define TUI_SPECIAL_REGS_NAME                "$SREGS"
  96 #define TUI_SPECIAL_REGS_NAME_LOWER          "$sregs"
  97 #define TUI_GENERAL_SPECIAL_REGS_NAME        "$REGS"
  98 #define TUI_GENERAL_SPECIAL_REGS_NAME_LOWER  "$regs"
  99
 100 /* Scroll direction enum.  */
 101 enum tui_scroll_direction
 102 {
 103   FORWARD_SCROLL,
 104   BACKWARD_SCROLL,
 105   LEFT_SCROLL,
 106   RIGHT_SCROLL
 107 };
 108
 109
 110 /* General list struct.  */
 111 struct tui_list
 112 {
 113   void **list;
 114   int count;
 115 };
 116
 117
 118 /* The kinds of layouts available */
 119 enum tui_layout_type
 120 {
 121   SRC_COMMAND,
 122   DISASSEM_COMMAND,
 123   SRC_DISASSEM_COMMAND,
 124   SRC_DATA_COMMAND,
 125   DISASSEM_DATA_COMMAND,
 126   UNDEFINED_LAYOUT
 127 };
 128
 129 /* Basic data types that can be displayed in the data window. */
 130 enum tui_data_type
 131 {
 132   TUI_REGISTER,
 133   TUI_SCALAR,
 134   TUI_COMPLEX,
 135   TUI_STRUCT
 136 };
 137
 138 /* Types of register displays */
 139 enum tui_register_display_type
 140 {
 141   TUI_UNDEFINED_REGS,
 142   TUI_GENERAL_REGS,
 143   TUI_SFLOAT_REGS,
 144   TUI_DFLOAT_REGS,
 145   TUI_SPECIAL_REGS,
 146   TUI_GENERAL_AND_SPECIAL_REGS
 147 };
 148
 149 /* Structure describing source line or line address */
 150 union tui_line_or_address
 151 {
 152   int line_no;
 153   CORE_ADDR addr;
 154 };
 155
 156 /* Current Layout definition */
 157 struct tui_layout_def
 158 {
 159   enum tui_win_type display_mode;
 160   int split;
 161   enum tui_register_display_type regs_display_type;
 162   enum tui_register_display_type float_regs_display_type;
 163 };
 164
 165 /* Elements in the Source/Disassembly Window */
 166 struct tui_source_element
 167 {
 168   char *line;
 169   union tui_line_or_address line_or_addr;
 170   int is_exec_point;
 171   int has_break;
 172 };
 173
 174
 175 /* Elements in the data display window content */
 176 struct tui_data_element
 177 {
 178   const char *name;
 179   int item_no;                  /* the register number, or data display number */
 180   enum tui_data_type type;
 181   void *value;
 182   int highlight;
 183   char *content;
 184 };
 185
 186
 187 /* Elements in the command window content */
 188 struct tui_command_element
 189 {
 190   char *line;
 191 };
 192
 193
 194 #define MAX_LOCATOR_ELEMENT_LEN        100
 195
 196 /* Elements in the locator window content */
 197 struct tui_locator_element
 198 {
 199   char file_name[MAX_LOCATOR_ELEMENT_LEN];
 200   char proc_name[MAX_LOCATOR_ELEMENT_LEN];
 201   int line_no;
 202   CORE_ADDR addr;
 203 };
 204
 205 /* Flags to tell what kind of breakpoint is at current line.  */
 206 #define TUI_BP_ENABLED      0x01
 207 #define TUI_BP_DISABLED     0x02
 208 #define TUI_BP_HIT          0x04
 209 #define TUI_BP_CONDITIONAL  0x08
 210 #define TUI_BP_HARDWARE     0x10
 211
 212 /* Position of breakpoint markers in the exec info string.  */
 213 #define TUI_BP_HIT_POS      0
 214 #define TUI_BP_BREAK_POS    1
 215 #define TUI_EXEC_POS        2
 216 #define TUI_EXECINFO_SIZE   4
 217
 218 typedef char tui_exec_info_content[TUI_EXECINFO_SIZE];
 219
 220 /* An content element in a window */
 221 union tui_which_element
 222 {
 223   struct tui_source_element source;     /* the source elements */
 224   struct tui_gen_win_info data_window;  /* data display elements */
 225   struct tui_data_element data; /* elements of data_window */
 226   struct tui_command_element command;   /* command elements */
 227   struct tui_locator_element locator;   /* locator elements */
 228   tui_exec_info_content simple_string;  /* simple char based elements */
 229 };
 230
 231 struct tui_win_element
 232 {
 233   int highlight;
 234   union tui_which_element which_element;
 235 };
 236
 237
 238 /* This describes the content of the window. */
 239 typedef struct tui_win_element **tui_win_content;
 240
 241
 242 /* This struct defines the specific information about a data display window */
 243 struct tui_data_info
 244 {
 245   tui_win_content data_content; /* start of data display content */
 246   int data_content_count;
 247   tui_win_content regs_content; /* start of regs display content */
 248   int regs_content_count;
 249   enum tui_register_display_type regs_display_type;
 250   int regs_column_count;
 251   int display_regs;             /* Should regs be displayed at all? */
 252   struct reggroup *current_group;
 253 };
 254
 255
 256 struct tui_source_info
 257 {
 258   int has_locator;              /* Does locator belongs to this window? */
 259   /* Execution information window.  */
 260   struct tui_gen_win_info *execution_info;
 261   int horizontal_offset;        /* used for horizontal scroll */
 262   union tui_line_or_address start_line_or_addr;
 263   char* filename;
 264 };
 265
 266
 267 struct tui_command_info
 268 {
 269   int cur_line;         /* The current line position */
 270   int curch;                    /* The current cursor position */
 271   int start_line;
 272 };
 273
 274
 275 /* This defines information about each logical window */
 276 struct tui_win_info
 277 {
 278   struct tui_gen_win_info generic;      /* general window information */
 279   union
 280   {
 281     struct tui_source_info source_info;
 282     struct tui_data_info data_display_info;
 283     struct tui_command_info command_info;
 284     void *opaque;
 285   }
 286   detail;
 287   int can_highlight;            /* Can this window ever be highlighted? */
 288   int is_highlighted;           /* Is this window highlighted? */
 289 };
 290
 291 extern int tui_win_is_source_type (enum tui_win_type win_type);
 292 extern int tui_win_is_auxillary (enum tui_win_type win_type);
 293 extern int tui_win_has_locator (struct tui_win_info *win_info);
 294 extern void tui_set_win_highlight (struct tui_win_info *win_info,
 295                                    int highlight);
 296
 297
 298 /* Global Data */
 299 extern struct tui_win_info *(tui_win_list[MAX_MAJOR_WINDOWS]);
 300
 301 #define TUI_SRC_WIN            tui_win_list[SRC_WIN]
 302 #define TUI_DISASM_WIN       tui_win_list[DISASSEM_WIN]
 303 #define TUI_DATA_WIN           tui_win_list[DATA_WIN]
 304 #define TUI_CMD_WIN            tui_win_list[CMD_WIN]
 305
 306 /* Data Manipulation Functions */
 307 extern void tui_initialize_static_data (void);
 308 extern struct tui_gen_win_info *tui_alloc_generic_win_info (void);
 309 extern struct tui_win_info *tui_alloc_win_info (enum tui_win_type);
 310 extern void tui_init_generic_part (struct tui_gen_win_info *);
 311 extern void tui_init_win_info (struct tui_win_info *);
 312 extern tui_win_content tui_alloc_content (int, enum tui_win_type);
 313 extern int tui_add_content_elements (struct tui_gen_win_info *, int);
 314 extern void tui_init_content_element (struct tui_win_element *, enum tui_win_type);
 315 extern void tui_free_window (struct tui_win_info *);
 316 extern void tui_free_win_content (struct tui_gen_win_info *);
 317 extern void tui_free_data_content (tui_win_content, int);
 318 extern void tui_free_all_source_wins_content (void);
 319 extern void tui_del_window (struct tui_win_info *);
 320 extern void tui_del_data_windows (tui_win_content, int);
 321 extern struct tui_win_info *tui_partial_win_by_name (char *);
 322 extern char *tui_win_name (struct tui_gen_win_info *);
 323 extern enum tui_layout_type tui_current_layout (void);
 324 extern void tui_set_current_layout_to (enum tui_layout_type);
 325 extern int tui_term_height (void);
 326 extern void tui_set_term_height_to (int);
 327 extern int tui_term_width (void);
 328 extern void tui_set_term_width_to (int);
 329 extern void tui_set_gen_win_origin (struct tui_gen_win_info *, int, int);
 330 extern struct tui_gen_win_info *tui_locator_win_info_ptr (void);
 331 extern struct tui_gen_win_info *tui_source_exec_info_win_ptr (void);
 332 extern struct tui_gen_win_info *tui_disassem_exec_info_win_ptr (void);
 333 extern struct tui_list * tui_source_windows (void);
 334 extern void tui_clear_source_windows (void);
 335 extern void tui_clear_source_windows_detail (void);
 336 extern void tui_clear_win_detail (struct tui_win_info * win_info);
 337 extern void tui_add_to_source_windows (struct tui_win_info *);
 338 extern int tui_default_tab_len (void);
 339 extern void tui_set_default_tab_len (int);
 340 extern struct tui_win_info *tui_win_with_focus (void);
 341 extern void tui_set_win_with_focus (struct tui_win_info *);
 342 extern struct tui_layout_def * tui_layout_def (void);
 343 extern int tui_win_resized (void);
 344 extern void tui_set_win_resized_to (int);
 345
 346 extern struct tui_win_info *tui_next_win (struct tui_win_info *);
 347 extern struct tui_win_info *tui_prev_win (struct tui_win_info *);
 348
 349 extern void tui_add_to_source_windows (struct tui_win_info * win_info);
 350
 351 #endif /* TUI_DATA_H */