1 /* TUI data manipulation routines.
3 Copyright (C) 1998-2019 Free Software Foundation, Inc.
5 Contributed by Hewlett-Packard Company.
7 This file is part of GDB.
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.
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.
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/>. */
22 #ifndef TUI_TUI_DATA_H
23 #define TUI_TUI_DATA_H
25 #include "tui/tui.h" /* For enum tui_win_type. */
26 #include "gdb_curses.h" /* For WINDOW. */
28 /* This is a point definition. */
34 struct tui_win_element;
36 /* This describes the content of the window. */
37 typedef struct tui_win_element **tui_win_content;
39 /* Generic window information. */
40 struct tui_gen_win_info
42 explicit tui_gen_win_info (enum tui_win_type t)
47 virtual ~tui_gen_win_info ();
49 /* Call to refresh this window. */
50 virtual void refresh_window ();
52 /* Make this window visible or invisible. */
53 virtual void make_visible (bool visible);
55 /* Return the name of this type of window. */
56 virtual const char *name () const
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);
69 WINDOW *handle = nullptr;
71 enum tui_win_type type;
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). */
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;
94 /* Whether or not a window should be drawn with a box. */
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
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
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)"
130 /* Minimum/Maximum length of some fields displayed in the TUI status
132 #define MIN_LINE_WIDTH 4 /* Use at least 4 digits for line
134 #define MIN_PROC_WIDTH 12
135 #define MAX_TARGET_WIDTH 10
136 #define MAX_PID_WIDTH 19
138 /* The kinds of layouts available. */
143 SRC_DISASSEM_COMMAND,
145 DISASSEM_DATA_COMMAND,
149 enum tui_line_or_address_kind
155 /* Structure describing source line or line address. */
156 struct tui_line_or_address
158 enum tui_line_or_address_kind loa;
166 /* Current Layout definition. */
167 struct tui_layout_def
169 enum tui_win_type display_mode;
172 /* Elements in the Source/Disassembly Window. */
173 struct tui_source_element
176 struct tui_line_or_address line_or_addr;
183 # define MAX_LOCATOR_ELEMENT_LEN PATH_MAX
185 # define MAX_LOCATOR_ELEMENT_LEN 1024
188 /* Flags to tell what kind of breakpoint is at current line. */
189 #define TUI_BP_ENABLED 0x01
190 #define TUI_BP_DISABLED 0x02
191 #define TUI_BP_HIT 0x04
192 #define TUI_BP_CONDITIONAL 0x08
193 #define TUI_BP_HARDWARE 0x10
195 /* Position of breakpoint markers in the exec info string. */
196 #define TUI_BP_HIT_POS 0
197 #define TUI_BP_BREAK_POS 1
198 #define TUI_EXEC_POS 2
199 #define TUI_EXECINFO_SIZE 4
201 typedef char tui_exec_info_content[TUI_EXECINFO_SIZE];
203 /* An content element in a window. */
204 union tui_which_element
206 struct tui_source_element source; /* The source elements. */
207 struct tui_data_item_window *data_window; /* Data display elements. */
210 struct tui_win_element
212 union tui_which_element which_element;
215 /* Execution info window class. */
217 struct tui_exec_info_window : public tui_gen_win_info
219 tui_exec_info_window ()
220 : tui_gen_win_info (EXEC_INFO_WIN)
224 ~tui_exec_info_window () override
229 /* Get or allocate contents. */
230 tui_exec_info_content *maybe_allocate_content (int n_elements);
232 /* Return the contents. */
233 const tui_exec_info_content *get_content () const
240 tui_exec_info_content *m_content = nullptr;
243 /* Locator window class. */
245 struct tui_locator_window : public tui_gen_win_info
247 tui_locator_window ()
248 : tui_gen_win_info (LOCATOR_WIN)
254 char full_name[MAX_LOCATOR_ELEMENT_LEN];
255 char proc_name[MAX_LOCATOR_ELEMENT_LEN];
258 /* Architecture associated with code at this location. */
259 struct gdbarch *gdbarch = nullptr;
262 /* A data item window. */
264 struct tui_data_item_window : public tui_gen_win_info
266 tui_data_item_window ()
267 : tui_gen_win_info (DATA_ITEM_WIN)
271 ~tui_data_item_window () override;
273 const char *name = nullptr;
274 /* The register number, or data display number. */
275 int item_no = UNDEFINED_ITEM;
276 void *value = nullptr;
277 bool highlight = false;
278 char *content = nullptr;
281 /* This defines information about each logical window. */
282 struct tui_win_info : public tui_gen_win_info
286 explicit tui_win_info (enum tui_win_type type);
287 DISABLE_COPY_AND_ASSIGN (tui_win_info);
289 /* Scroll the contents vertically. This is only called via
290 forward_scroll and backward_scroll. */
291 virtual void do_scroll_vertical (int num_to_scroll) = 0;
293 /* Scroll the contents horizontally. This is only called via
294 left_scroll and right_scroll. */
295 virtual void do_scroll_horizontal (int num_to_scroll) = 0;
297 /* Called after make_visible_with_new_height sets the new height.
298 Should update the window. */
299 virtual void do_make_visible_with_new_height () = 0;
303 ~tui_win_info () override
307 /* Clear the pertinent detail in the window. */
308 virtual void clear_detail () = 0;
310 /* Return true if this window has the locator. */
311 virtual bool has_locator () const
316 /* Refresh this window and any associated windows. */
317 virtual void refresh ();
319 /* Called after all the TUI windows are refreshed, to let this
320 window have a chance to update itself further. */
321 virtual void refresh_all ()
325 /* Called after a TUI window is given a new height; this updates any
326 related auxiliary windows. */
327 virtual void set_new_height (int height)
331 /* Compute the maximum height of this window. */
332 virtual int max_height () const;
334 /* Called after the tab width has been changed. */
335 virtual void update_tab_width ()
339 /* Make the window visible after the height has been changed. */
340 void make_visible_with_new_height ();
342 /* Set whether this window is highglighted. */
343 void set_highlight (bool highlight)
345 is_highlighted = highlight;
348 /* Methods to scroll the contents of this window. Note that they
349 are named with "_scroll" coming at the end because the more
350 obvious "scroll_forward" is defined as a macro in term.h. */
351 void forward_scroll (int num_to_scroll);
352 void backward_scroll (int num_to_scroll);
353 void left_scroll (int num_to_scroll);
354 void right_scroll (int num_to_scroll);
356 /* Can this window ever be highlighted? */
357 bool can_highlight = true;
359 /* Is this window highlighted? */
360 bool is_highlighted = false;
363 /* The base class for all source-like windows, namely the source and
364 disassembly windows. */
366 struct tui_source_window_base : public tui_win_info
369 explicit tui_source_window_base (enum tui_win_type type);
370 ~tui_source_window_base () override;
371 DISABLE_COPY_AND_ASSIGN (tui_source_window_base);
373 void do_scroll_horizontal (int num_to_scroll) override;
374 void do_make_visible_with_new_height () override;
378 void clear_detail () override;
380 /* Return true if this window has the locator. */
381 bool has_locator () const override
383 return m_has_locator;
386 void make_visible (bool visible) override;
387 void refresh () override;
388 void refresh_all () override;
390 /* Refill the source window's source cache and update it. If this
391 is a disassembly window, then just update it. */
394 /* Set the location of the execution point. */
395 void set_is_exec_point_at (struct tui_line_or_address l);
397 void set_new_height (int height) override;
399 void update_tab_width () override;
401 /* Does the locator belong to this window? */
402 bool m_has_locator = false;
403 /* Execution information window. */
404 struct tui_exec_info_window *execution_info = nullptr;
405 /* Used for horizontal scroll. */
406 int horizontal_offset = 0;
407 struct tui_line_or_address start_line_or_addr;
409 /* It is the resolved form as returned by symtab_to_fullname. */
410 char *fullname = nullptr;
412 /* Architecture associated with code at this location. */
413 struct gdbarch *gdbarch = nullptr;
416 /* A TUI source window. */
418 struct tui_source_window : public tui_source_window_base
421 : tui_source_window_base (SRC_WIN)
425 DISABLE_COPY_AND_ASSIGN (tui_source_window);
427 const char *name () const override
434 void do_scroll_vertical (int num_to_scroll) override;
437 /* A TUI disassembly window. */
439 struct tui_disasm_window : public tui_source_window_base
442 : tui_source_window_base (DISASSEM_WIN)
446 DISABLE_COPY_AND_ASSIGN (tui_disasm_window);
448 const char *name () const override
450 return DISASSEM_NAME;
455 void do_scroll_vertical (int num_to_scroll) override;
458 struct tui_data_window : public tui_win_info
461 : tui_win_info (DATA_WIN)
465 ~tui_data_window () override;
466 DISABLE_COPY_AND_ASSIGN (tui_data_window);
468 void clear_detail () override;
469 void refresh_all () override;
471 void set_new_height (int height) override;
473 void refresh_window () override;
475 const char *name () const override
480 /* Start of regs display content. */
481 tui_win_content regs_content = NULL;
482 int regs_content_count = 0;
483 int regs_column_count = 0;
484 /* Should regs be displayed at all? */
485 bool display_regs = false;
486 struct reggroup *current_group = nullptr;
490 void do_scroll_vertical (int num_to_scroll) override;
491 void do_scroll_horizontal (int num_to_scroll) override
494 void do_make_visible_with_new_height () override;
496 /* Return the index of the first element displayed. If none are
497 displayed, then return -1. */
498 int first_data_item_displayed ();
501 struct tui_cmd_window : public tui_win_info
504 : tui_win_info (CMD_WIN)
506 can_highlight = false;
509 DISABLE_COPY_AND_ASSIGN (tui_cmd_window);
511 void clear_detail () override;
513 void make_visible (bool visible) override
517 int max_height () const override;
519 void refresh_window () override
523 const char *name () const override
532 void do_scroll_vertical (int num_to_scroll) override
536 void do_scroll_horizontal (int num_to_scroll) override
540 void do_make_visible_with_new_height () override;
543 extern int tui_win_is_auxillary (enum tui_win_type win_type);
547 extern struct tui_win_info *tui_win_list[MAX_MAJOR_WINDOWS];
549 #define TUI_SRC_WIN ((tui_source_window_base *) tui_win_list[SRC_WIN])
550 #define TUI_DISASM_WIN ((tui_source_window_base *) tui_win_list[DISASSEM_WIN])
551 #define TUI_DATA_WIN ((tui_data_window *) tui_win_list[DATA_WIN])
552 #define TUI_CMD_WIN ((tui_cmd_window *) tui_win_list[CMD_WIN])
554 /* Data Manipulation Functions. */
555 extern void tui_initialize_static_data (void);
556 extern tui_win_content tui_alloc_content (int, enum tui_win_type);
557 extern int tui_add_content_elements (struct tui_gen_win_info *,
559 extern void tui_free_win_content (struct tui_gen_win_info *);
560 extern void tui_free_data_content (tui_win_content, int);
561 extern void tui_free_all_source_wins_content (void);
562 extern struct tui_win_info *tui_partial_win_by_name (const char *);
563 extern enum tui_layout_type tui_current_layout (void);
564 extern void tui_set_current_layout_to (enum tui_layout_type);
565 extern int tui_term_height (void);
566 extern void tui_set_term_height_to (int);
567 extern int tui_term_width (void);
568 extern void tui_set_term_width_to (int);
569 extern struct tui_locator_window *tui_locator_win_info_ptr (void);
570 extern std::vector<tui_source_window_base *> &tui_source_windows ();
571 extern void tui_clear_source_windows (void);
572 extern void tui_clear_source_windows_detail (void);
573 extern void tui_add_to_source_windows (struct tui_source_window_base *);
574 extern struct tui_win_info *tui_win_with_focus (void);
575 extern void tui_set_win_with_focus (struct tui_win_info *);
576 extern struct tui_layout_def *tui_layout_def (void);
577 extern int tui_win_resized (void);
578 extern void tui_set_win_resized_to (int);
580 extern struct tui_win_info *tui_next_win (struct tui_win_info *);
581 extern struct tui_win_info *tui_prev_win (struct tui_win_info *);
583 extern unsigned int tui_tab_width;
585 #endif /* TUI_TUI_DATA_H */