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
;
32 /* This is a point definition. */
38 /* Generic window information. */
39 struct tui_gen_win_info
43 explicit tui_gen_win_info (enum tui_win_type t
)
50 virtual ~tui_gen_win_info ();
52 /* Call to refresh this window. */
53 virtual void refresh_window ();
55 /* Make this window visible or invisible. */
56 virtual void make_visible (bool visible
);
58 /* Return the name of this type of window. */
59 virtual const char *name () const
64 /* Reset this window. The parameters are used to set the window's
66 virtual void reset (int height
, int width
,
67 int origin_x
, int origin_y
);
70 WINDOW
*handle
= nullptr;
72 enum tui_win_type type
;
77 /* Origin of window. */
78 struct tui_point origin
= {0, 0};
79 /* Viewport height. */
80 int viewport_height
= 0;
81 /* Index of last visible line. */
82 int last_visible_line
= 0;
83 /* Whether the window is visible or not. */
84 bool is_visible
= false;
85 /* Window title to display. */
86 char *title
= nullptr;
89 /* Whether or not a window should be drawn with a box. */
96 /* Constant definitions. */
97 #define DEFAULT_TAB_LEN 8
98 #define NO_SRC_STRING "[ No Source Available ]"
99 #define NO_DISASSEM_STRING "[ No Assembly Available ]"
100 #define NO_REGS_STRING "[ Register Values Unavailable ]"
101 #define NO_DATA_STRING "[ No Data Values Displayed ]"
102 #define SRC_NAME "src"
103 #define CMD_NAME "cmd"
104 #define DATA_NAME "regs"
105 #define DISASSEM_NAME "asm"
107 #define NO_HILITE FALSE
108 #define MIN_WIN_HEIGHT 3
109 #define MIN_CMD_WIN_HEIGHT 3
111 /* Strings to display in the TUI status line. */
112 #define PROC_PREFIX "In: "
113 #define LINE_PREFIX "L"
114 #define PC_PREFIX "PC: "
115 #define SINGLE_KEY "(SingleKey)"
117 /* Minimum/Maximum length of some fields displayed in the TUI status
119 #define MIN_LINE_WIDTH 4 /* Use at least 4 digits for line
121 #define MIN_PROC_WIDTH 12
122 #define MAX_TARGET_WIDTH 10
123 #define MAX_PID_WIDTH 19
125 /* The kinds of layouts available. */
130 SRC_DISASSEM_COMMAND
,
132 DISASSEM_DATA_COMMAND
,
136 enum tui_line_or_address_kind
142 /* Structure describing source line or line address. */
143 struct tui_line_or_address
145 enum tui_line_or_address_kind loa
;
153 /* Current Layout definition. */
154 struct tui_layout_def
156 enum tui_win_type display_mode
;
159 /* Flags to tell what kind of breakpoint is at current line. */
162 TUI_BP_ENABLED
= 0x01,
163 TUI_BP_DISABLED
= 0x02,
165 TUI_BP_CONDITIONAL
= 0x08,
166 TUI_BP_HARDWARE
= 0x10
169 DEF_ENUM_FLAGS_TYPE (enum tui_bp_flag
, tui_bp_flags
);
171 /* Elements in the Source/Disassembly Window. */
172 struct tui_source_element
174 tui_source_element ()
176 line_or_addr
.loa
= LOA_LINE
;
177 line_or_addr
.u
.line_no
= 0;
180 ~tui_source_element ()
185 char *line
= nullptr;
186 struct tui_line_or_address line_or_addr
;
187 bool is_exec_point
= false;
188 tui_bp_flags break_mode
= 0;
193 # define MAX_LOCATOR_ELEMENT_LEN PATH_MAX
195 # define MAX_LOCATOR_ELEMENT_LEN 1024
198 /* Position of breakpoint markers in the exec info string. */
199 #define TUI_BP_HIT_POS 0
200 #define TUI_BP_BREAK_POS 1
201 #define TUI_EXEC_POS 2
202 #define TUI_EXECINFO_SIZE 4
204 typedef char tui_exec_info_content
[TUI_EXECINFO_SIZE
];
206 /* Execution info window class. */
208 struct tui_exec_info_window
: public tui_gen_win_info
210 tui_exec_info_window ()
211 : tui_gen_win_info (EXEC_INFO_WIN
)
215 ~tui_exec_info_window () override
220 /* Get or allocate contents. */
221 tui_exec_info_content
*maybe_allocate_content (int n_elements
);
223 /* Return the contents. */
224 const tui_exec_info_content
*get_content () const
231 tui_exec_info_content
*m_content
= nullptr;
234 /* Locator window class. */
236 struct tui_locator_window
: public tui_gen_win_info
238 tui_locator_window ()
239 : tui_gen_win_info (LOCATOR_WIN
)
245 char full_name
[MAX_LOCATOR_ELEMENT_LEN
];
246 char proc_name
[MAX_LOCATOR_ELEMENT_LEN
];
249 /* Architecture associated with code at this location. */
250 struct gdbarch
*gdbarch
= nullptr;
253 /* This defines information about each logical window. */
254 struct tui_win_info
: public tui_gen_win_info
258 explicit tui_win_info (enum tui_win_type type
);
259 DISABLE_COPY_AND_ASSIGN (tui_win_info
);
261 /* Scroll the contents vertically. This is only called via
262 forward_scroll and backward_scroll. */
263 virtual void do_scroll_vertical (int num_to_scroll
) = 0;
265 /* Scroll the contents horizontally. This is only called via
266 left_scroll and right_scroll. */
267 virtual void do_scroll_horizontal (int num_to_scroll
) = 0;
269 /* Called after make_visible_with_new_height sets the new height.
270 Should update the window. */
271 virtual void do_make_visible_with_new_height () = 0;
275 ~tui_win_info () override
279 /* Clear the pertinent detail in the window. */
280 virtual void clear_detail () = 0;
282 /* Called after all the TUI windows are refreshed, to let this
283 window have a chance to update itself further. */
284 virtual void refresh_all ()
288 /* Called after a TUI window is given a new height; this updates any
289 related auxiliary windows. */
290 virtual void set_new_height (int height
)
294 /* Compute the maximum height of this window. */
295 virtual int max_height () const;
297 /* Called after the tab width has been changed. */
298 virtual void update_tab_width ()
302 /* Function make the target window (and auxiliary windows associated
303 with the target) invisible, and set the new height and
305 void make_invisible_and_set_new_height (int height
);
307 /* Make the window visible after the height has been changed. */
308 void make_visible_with_new_height ();
310 /* Set whether this window is highglighted. */
311 void set_highlight (bool highlight
)
313 is_highlighted
= highlight
;
316 /* Methods to scroll the contents of this window. Note that they
317 are named with "_scroll" coming at the end because the more
318 obvious "scroll_forward" is defined as a macro in term.h. */
319 void forward_scroll (int num_to_scroll
);
320 void backward_scroll (int num_to_scroll
);
321 void left_scroll (int num_to_scroll
);
322 void right_scroll (int num_to_scroll
);
324 /* Return true if this window can be scrolled, false otherwise. */
325 virtual bool can_scroll () const
330 /* Can this window ever be highlighted? */
331 bool can_highlight
= true;
333 /* Is this window highlighted? */
334 bool is_highlighted
= false;
337 /* The base class for all source-like windows, namely the source and
338 disassembly windows. */
340 struct tui_source_window_base
: public tui_win_info
343 explicit tui_source_window_base (enum tui_win_type type
);
344 ~tui_source_window_base () override
;
345 DISABLE_COPY_AND_ASSIGN (tui_source_window_base
);
347 void do_scroll_horizontal (int num_to_scroll
) override
;
348 void do_make_visible_with_new_height () override
;
352 void clear_detail () override
;
354 void make_visible (bool visible
) override
;
355 void refresh_window () override
;
356 void refresh_all () override
;
358 /* Refill the source window's source cache and update it. If this
359 is a disassembly window, then just update it. */
362 /* Set the location of the execution point. */
363 void set_is_exec_point_at (struct tui_line_or_address l
);
365 void set_new_height (int height
) override
;
367 void update_tab_width () override
;
369 /* Return true if the location LOC corresponds to the line number
370 LINE_NO in this source window; false otherwise. */
371 virtual bool location_matches_p (struct bp_location
*loc
, int line_no
) = 0;
373 void reset (int height
, int width
,
374 int origin_x
, int origin_y
) override
;
376 /* Does the locator belong to this window? */
377 bool m_has_locator
= false;
378 /* Execution information window. */
379 struct tui_exec_info_window
*execution_info
;
380 /* Used for horizontal scroll. */
381 int horizontal_offset
= 0;
382 struct tui_line_or_address start_line_or_addr
;
384 /* It is the resolved form as returned by symtab_to_fullname. */
385 char *fullname
= nullptr;
387 /* Architecture associated with code at this location. */
388 struct gdbarch
*gdbarch
= nullptr;
390 std::vector
<tui_source_element
> content
;
393 extern int tui_win_is_auxiliary (enum tui_win_type win_type
);
397 extern struct tui_win_info
*tui_win_list
[MAX_MAJOR_WINDOWS
];
399 #define TUI_SRC_WIN ((tui_source_window *) tui_win_list[SRC_WIN])
400 #define TUI_DISASM_WIN ((tui_source_window_base *) tui_win_list[DISASSEM_WIN])
401 #define TUI_DATA_WIN ((tui_data_window *) tui_win_list[DATA_WIN])
402 #define TUI_CMD_WIN ((tui_cmd_window *) tui_win_list[CMD_WIN])
404 /* An iterator that iterates over all windows. */
406 class tui_window_iterator
410 typedef tui_window_iterator self_type
;
411 typedef struct tui_win_info
*value_type
;
412 typedef struct tui_win_info
*&reference
;
413 typedef struct tui_win_info
**pointer
;
414 typedef std::forward_iterator_tag iterator_category
;
415 typedef int difference_type
;
417 explicit tui_window_iterator (enum tui_win_type type
)
423 tui_window_iterator ()
424 : m_type (MAX_MAJOR_WINDOWS
)
428 bool operator!= (const self_type
&other
) const
430 return m_type
!= other
.m_type
;
433 value_type
operator* () const
435 gdb_assert (m_type
< MAX_MAJOR_WINDOWS
);
436 return tui_win_list
[m_type
];
439 self_type
&operator++ ()
450 while (m_type
< MAX_MAJOR_WINDOWS
&& tui_win_list
[m_type
] == nullptr)
457 /* A range adapter for iterating over TUI windows. */
459 struct all_tui_windows
461 tui_window_iterator
begin () const
463 return tui_window_iterator (SRC_WIN
);
466 tui_window_iterator
end () const
468 return tui_window_iterator ();
473 /* Data Manipulation Functions. */
474 extern void tui_initialize_static_data (void);
475 extern struct tui_win_info
*tui_partial_win_by_name (const char *);
476 extern enum tui_layout_type
tui_current_layout (void);
477 extern void tui_set_current_layout_to (enum tui_layout_type
);
478 extern int tui_term_height (void);
479 extern void tui_set_term_height_to (int);
480 extern int tui_term_width (void);
481 extern void tui_set_term_width_to (int);
482 extern struct tui_locator_window
*tui_locator_win_info_ptr (void);
483 extern std::vector
<tui_source_window_base
*> &tui_source_windows ();
484 extern void tui_clear_source_windows (void);
485 extern void tui_clear_source_windows_detail (void);
486 extern void tui_add_to_source_windows (struct tui_source_window_base
*);
487 extern struct tui_win_info
*tui_win_with_focus (void);
488 extern void tui_set_win_with_focus (struct tui_win_info
*);
489 extern struct tui_layout_def
*tui_layout_def (void);
490 extern int tui_win_resized (void);
491 extern void tui_set_win_resized_to (int);
493 extern struct tui_win_info
*tui_next_win (struct tui_win_info
*);
494 extern struct tui_win_info
*tui_prev_win (struct tui_win_info
*);
496 extern unsigned int tui_tab_width
;
498 #endif /* TUI_TUI_DATA_H */