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. */
27 #include "observable.h"
29 struct tui_cmd_window
;
30 struct tui_source_window_base
;
31 struct tui_source_window
;
33 /* This is a point definition. */
39 /* Generic window information. */
40 struct tui_gen_win_info
44 explicit tui_gen_win_info (enum tui_win_type t
)
51 virtual ~tui_gen_win_info ();
53 /* Call to refresh this window. */
54 virtual void refresh_window ();
56 /* Make this window visible or invisible. */
57 virtual void make_visible (bool visible
);
59 /* Return the name of this type of window. */
60 virtual const char *name () const
65 /* Reset this window. The parameters are used to set the window's
67 virtual void reset (int height
, int width
,
68 int origin_x
, int origin_y
);
71 WINDOW
*handle
= nullptr;
73 enum tui_win_type type
;
78 /* Origin of window. */
79 struct tui_point origin
= {0, 0};
80 /* Viewport height. */
81 int viewport_height
= 0;
82 /* Index of last visible line. */
83 int last_visible_line
= 0;
84 /* Whether the window is visible or not. */
85 bool is_visible
= false;
86 /* Window title to display. */
87 char *title
= nullptr;
90 /* Whether or not a window should be drawn with a box. */
97 /* Constant definitions. */
98 #define DEFAULT_TAB_LEN 8
99 #define NO_SRC_STRING "[ No Source Available ]"
100 #define NO_DISASSEM_STRING "[ No Assembly Available ]"
101 #define NO_REGS_STRING "[ Register Values Unavailable ]"
102 #define NO_DATA_STRING "[ No Data Values Displayed ]"
103 #define SRC_NAME "src"
104 #define CMD_NAME "cmd"
105 #define DATA_NAME "regs"
106 #define DISASSEM_NAME "asm"
108 #define NO_HILITE FALSE
109 #define MIN_WIN_HEIGHT 3
110 #define MIN_CMD_WIN_HEIGHT 3
112 /* Strings to display in the TUI status line. */
113 #define PROC_PREFIX "In: "
114 #define LINE_PREFIX "L"
115 #define PC_PREFIX "PC: "
116 #define SINGLE_KEY "(SingleKey)"
118 /* Minimum/Maximum length of some fields displayed in the TUI status
120 #define MIN_LINE_WIDTH 4 /* Use at least 4 digits for line
122 #define MIN_PROC_WIDTH 12
123 #define MAX_TARGET_WIDTH 10
124 #define MAX_PID_WIDTH 19
126 /* The kinds of layouts available. */
131 SRC_DISASSEM_COMMAND
,
133 DISASSEM_DATA_COMMAND
,
137 enum tui_line_or_address_kind
143 /* Structure describing source line or line address. */
144 struct tui_line_or_address
146 enum tui_line_or_address_kind loa
;
154 /* Flags to tell what kind of breakpoint is at current line. */
157 TUI_BP_ENABLED
= 0x01,
158 TUI_BP_DISABLED
= 0x02,
160 TUI_BP_CONDITIONAL
= 0x08,
161 TUI_BP_HARDWARE
= 0x10
164 DEF_ENUM_FLAGS_TYPE (enum tui_bp_flag
, tui_bp_flags
);
166 /* Elements in the Source/Disassembly Window. */
167 struct tui_source_element
169 tui_source_element ()
171 line_or_addr
.loa
= LOA_LINE
;
172 line_or_addr
.u
.line_no
= 0;
175 ~tui_source_element ()
180 char *line
= nullptr;
181 struct tui_line_or_address line_or_addr
;
182 bool is_exec_point
= false;
183 tui_bp_flags break_mode
= 0;
188 # define MAX_LOCATOR_ELEMENT_LEN PATH_MAX
190 # define MAX_LOCATOR_ELEMENT_LEN 1024
193 /* Position of breakpoint markers in the exec info string. */
194 #define TUI_BP_HIT_POS 0
195 #define TUI_BP_BREAK_POS 1
196 #define TUI_EXEC_POS 2
197 #define TUI_EXECINFO_SIZE 4
199 typedef char tui_exec_info_content
[TUI_EXECINFO_SIZE
];
201 /* Locator window class. */
203 struct tui_locator_window
: public tui_gen_win_info
205 tui_locator_window ()
206 : tui_gen_win_info (LOCATOR_WIN
)
212 char full_name
[MAX_LOCATOR_ELEMENT_LEN
];
213 char proc_name
[MAX_LOCATOR_ELEMENT_LEN
];
216 /* Architecture associated with code at this location. */
217 struct gdbarch
*gdbarch
= nullptr;
220 /* This defines information about each logical window. */
221 struct tui_win_info
: public tui_gen_win_info
225 explicit tui_win_info (enum tui_win_type type
);
226 DISABLE_COPY_AND_ASSIGN (tui_win_info
);
228 /* Scroll the contents vertically. This is only called via
229 forward_scroll and backward_scroll. */
230 virtual void do_scroll_vertical (int num_to_scroll
) = 0;
232 /* Scroll the contents horizontally. This is only called via
233 left_scroll and right_scroll. */
234 virtual void do_scroll_horizontal (int num_to_scroll
) = 0;
236 /* Called after make_visible_with_new_height sets the new height.
237 Should update the window. */
238 virtual void do_make_visible_with_new_height () = 0;
242 ~tui_win_info () override
246 /* Called after all the TUI windows are refreshed, to let this
247 window have a chance to update itself further. */
248 virtual void refresh_all ()
252 /* Called after a TUI window is given a new height; this updates any
253 related auxiliary windows. */
254 virtual void set_new_height (int height
)
258 /* Compute the maximum height of this window. */
259 virtual int max_height () const;
261 /* Called after the tab width has been changed. */
262 virtual void update_tab_width ()
266 /* Function make the target window (and auxiliary windows associated
267 with the target) invisible, and set the new height and
269 void make_invisible_and_set_new_height (int height
);
271 /* Make the window visible after the height has been changed. */
272 void make_visible_with_new_height ();
274 /* Set whether this window is highglighted. */
275 void set_highlight (bool highlight
)
277 is_highlighted
= highlight
;
280 /* Methods to scroll the contents of this window. Note that they
281 are named with "_scroll" coming at the end because the more
282 obvious "scroll_forward" is defined as a macro in term.h. */
283 void forward_scroll (int num_to_scroll
);
284 void backward_scroll (int num_to_scroll
);
285 void left_scroll (int num_to_scroll
);
286 void right_scroll (int num_to_scroll
);
288 /* Return true if this window can be scrolled, false otherwise. */
289 virtual bool can_scroll () const
294 /* Can this window ever be highlighted? */
295 bool can_highlight
= true;
297 /* Is this window highlighted? */
298 bool is_highlighted
= false;
301 extern int tui_win_is_auxiliary (enum tui_win_type win_type
);
305 extern struct tui_win_info
*tui_win_list
[MAX_MAJOR_WINDOWS
];
307 #define TUI_SRC_WIN ((tui_source_window *) tui_win_list[SRC_WIN])
308 #define TUI_DISASM_WIN ((tui_source_window_base *) tui_win_list[DISASSEM_WIN])
309 #define TUI_DATA_WIN ((tui_data_window *) tui_win_list[DATA_WIN])
310 #define TUI_CMD_WIN ((tui_cmd_window *) tui_win_list[CMD_WIN])
312 /* An iterator that iterates over all windows. */
314 class tui_window_iterator
318 typedef tui_window_iterator self_type
;
319 typedef struct tui_win_info
*value_type
;
320 typedef struct tui_win_info
*&reference
;
321 typedef struct tui_win_info
**pointer
;
322 typedef std::forward_iterator_tag iterator_category
;
323 typedef int difference_type
;
325 explicit tui_window_iterator (enum tui_win_type type
)
331 tui_window_iterator ()
332 : m_type (MAX_MAJOR_WINDOWS
)
336 bool operator!= (const self_type
&other
) const
338 return m_type
!= other
.m_type
;
341 value_type
operator* () const
343 gdb_assert (m_type
< MAX_MAJOR_WINDOWS
);
344 return tui_win_list
[m_type
];
347 self_type
&operator++ ()
358 while (m_type
< MAX_MAJOR_WINDOWS
&& tui_win_list
[m_type
] == nullptr)
365 /* A range adapter for iterating over TUI windows. */
367 struct all_tui_windows
369 tui_window_iterator
begin () const
371 return tui_window_iterator (SRC_WIN
);
374 tui_window_iterator
end () const
376 return tui_window_iterator ();
381 /* Data Manipulation Functions. */
382 extern void tui_initialize_static_data (void);
383 extern struct tui_win_info
*tui_partial_win_by_name (const char *);
384 extern enum tui_layout_type
tui_current_layout (void);
385 extern int tui_term_height (void);
386 extern void tui_set_term_height_to (int);
387 extern int tui_term_width (void);
388 extern void tui_set_term_width_to (int);
389 extern struct tui_locator_window
*tui_locator_win_info_ptr (void);
390 extern std::vector
<tui_source_window_base
*> &tui_source_windows ();
391 extern void tui_clear_source_windows (void);
392 extern void tui_clear_source_windows_detail (void);
393 extern void tui_add_to_source_windows (struct tui_source_window_base
*);
394 extern struct tui_win_info
*tui_win_with_focus (void);
395 extern void tui_set_win_with_focus (struct tui_win_info
*);
396 extern int tui_win_resized (void);
397 extern void tui_set_win_resized_to (int);
399 extern struct tui_win_info
*tui_next_win (struct tui_win_info
*);
400 extern struct tui_win_info
*tui_prev_win (struct tui_win_info
*);
402 /* Delete all the invisible windows. Note that it is an error to call
403 this when the command window is invisible -- we don't allow the
404 command window to be removed from the layout. */
405 extern void tui_delete_invisible_windows ();
407 extern unsigned int tui_tab_width
;
409 #endif /* TUI_TUI_DATA_H */