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
;
31 /* This is a point definition. */
37 /* Generic window information. */
38 struct tui_gen_win_info
42 explicit tui_gen_win_info (enum tui_win_type t
)
49 virtual ~tui_gen_win_info ();
51 /* Call to refresh this window. */
52 virtual void refresh_window ();
54 /* Make this window visible or invisible. */
55 virtual void make_visible (bool visible
);
57 /* Return the name of this type of window. */
58 virtual const char *name () const
63 /* Reset this window. The parameters are used to set the window's
65 virtual void reset (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 /* Viewport height. */
79 int viewport_height
= 0;
80 /* Index of last visible line. */
81 int last_visible_line
= 0;
82 /* Whether the window is visible or not. */
83 bool is_visible
= false;
84 /* Window title to display. */
85 char *title
= nullptr;
88 /* Whether or not a window should be drawn with a box. */
95 /* Constant definitions. */
96 #define DEFAULT_TAB_LEN 8
97 #define NO_SRC_STRING "[ No Source Available ]"
98 #define NO_DISASSEM_STRING "[ No Assembly Available ]"
99 #define NO_REGS_STRING "[ Register Values Unavailable ]"
100 #define NO_DATA_STRING "[ No Data Values Displayed ]"
101 #define SRC_NAME "src"
102 #define CMD_NAME "cmd"
103 #define DATA_NAME "regs"
104 #define DISASSEM_NAME "asm"
106 #define NO_HILITE FALSE
107 #define MIN_WIN_HEIGHT 3
108 #define MIN_CMD_WIN_HEIGHT 3
110 /* Strings to display in the TUI status line. */
111 #define PROC_PREFIX "In: "
112 #define LINE_PREFIX "L"
113 #define PC_PREFIX "PC: "
114 #define SINGLE_KEY "(SingleKey)"
116 /* Minimum/Maximum length of some fields displayed in the TUI status
118 #define MIN_LINE_WIDTH 4 /* Use at least 4 digits for line
120 #define MIN_PROC_WIDTH 12
121 #define MAX_TARGET_WIDTH 10
122 #define MAX_PID_WIDTH 19
124 /* The kinds of layouts available. */
129 SRC_DISASSEM_COMMAND
,
131 DISASSEM_DATA_COMMAND
,
135 enum tui_line_or_address_kind
141 /* Structure describing source line or line address. */
142 struct tui_line_or_address
144 enum tui_line_or_address_kind loa
;
152 /* Current Layout definition. */
153 struct tui_layout_def
155 enum tui_win_type display_mode
;
158 /* Flags to tell what kind of breakpoint is at current line. */
161 TUI_BP_ENABLED
= 0x01,
162 TUI_BP_DISABLED
= 0x02,
164 TUI_BP_CONDITIONAL
= 0x08,
165 TUI_BP_HARDWARE
= 0x10
168 DEF_ENUM_FLAGS_TYPE (enum tui_bp_flag
, tui_bp_flags
);
170 /* Elements in the Source/Disassembly Window. */
171 struct tui_source_element
173 tui_source_element ()
175 line_or_addr
.loa
= LOA_LINE
;
176 line_or_addr
.u
.line_no
= 0;
179 ~tui_source_element ()
184 char *line
= nullptr;
185 struct tui_line_or_address line_or_addr
;
186 bool is_exec_point
= false;
187 tui_bp_flags break_mode
= 0;
192 # define MAX_LOCATOR_ELEMENT_LEN PATH_MAX
194 # define MAX_LOCATOR_ELEMENT_LEN 1024
197 /* Position of breakpoint markers in the exec info string. */
198 #define TUI_BP_HIT_POS 0
199 #define TUI_BP_BREAK_POS 1
200 #define TUI_EXEC_POS 2
201 #define TUI_EXECINFO_SIZE 4
203 typedef char tui_exec_info_content
[TUI_EXECINFO_SIZE
];
205 /* Execution info window class. */
207 struct tui_exec_info_window
: public tui_gen_win_info
209 tui_exec_info_window ()
210 : tui_gen_win_info (EXEC_INFO_WIN
)
214 ~tui_exec_info_window () override
219 /* Get or allocate contents. */
220 tui_exec_info_content
*maybe_allocate_content (int n_elements
);
222 /* Return the contents. */
223 const tui_exec_info_content
*get_content () const
230 tui_exec_info_content
*m_content
= nullptr;
233 /* Locator window class. */
235 struct tui_locator_window
: public tui_gen_win_info
237 tui_locator_window ()
238 : tui_gen_win_info (LOCATOR_WIN
)
244 char full_name
[MAX_LOCATOR_ELEMENT_LEN
];
245 char proc_name
[MAX_LOCATOR_ELEMENT_LEN
];
248 /* Architecture associated with code at this location. */
249 struct gdbarch
*gdbarch
= nullptr;
252 /* This defines information about each logical window. */
253 struct tui_win_info
: public tui_gen_win_info
257 explicit tui_win_info (enum tui_win_type type
);
258 DISABLE_COPY_AND_ASSIGN (tui_win_info
);
260 /* Scroll the contents vertically. This is only called via
261 forward_scroll and backward_scroll. */
262 virtual void do_scroll_vertical (int num_to_scroll
) = 0;
264 /* Scroll the contents horizontally. This is only called via
265 left_scroll and right_scroll. */
266 virtual void do_scroll_horizontal (int num_to_scroll
) = 0;
268 /* Called after make_visible_with_new_height sets the new height.
269 Should update the window. */
270 virtual void do_make_visible_with_new_height () = 0;
274 ~tui_win_info () override
278 /* Clear the pertinent detail in the window. */
279 virtual void clear_detail () = 0;
281 /* Called after all the TUI windows are refreshed, to let this
282 window have a chance to update itself further. */
283 virtual void refresh_all ()
287 /* Called after a TUI window is given a new height; this updates any
288 related auxiliary windows. */
289 virtual void set_new_height (int height
)
293 /* Compute the maximum height of this window. */
294 virtual int max_height () const;
296 /* Called after the tab width has been changed. */
297 virtual void update_tab_width ()
301 /* Make the window visible after the height has been changed. */
302 void make_visible_with_new_height ();
304 /* Set whether this window is highglighted. */
305 void set_highlight (bool highlight
)
307 is_highlighted
= highlight
;
310 /* Methods to scroll the contents of this window. Note that they
311 are named with "_scroll" coming at the end because the more
312 obvious "scroll_forward" is defined as a macro in term.h. */
313 void forward_scroll (int num_to_scroll
);
314 void backward_scroll (int num_to_scroll
);
315 void left_scroll (int num_to_scroll
);
316 void right_scroll (int num_to_scroll
);
318 /* Return true if this window can be scrolled, false otherwise. */
319 virtual bool can_scroll () const
324 /* Can this window ever be highlighted? */
325 bool can_highlight
= true;
327 /* Is this window highlighted? */
328 bool is_highlighted
= false;
331 /* The base class for all source-like windows, namely the source and
332 disassembly windows. */
334 struct tui_source_window_base
: public tui_win_info
337 explicit tui_source_window_base (enum tui_win_type type
);
338 ~tui_source_window_base () override
;
339 DISABLE_COPY_AND_ASSIGN (tui_source_window_base
);
341 void do_scroll_horizontal (int num_to_scroll
) override
;
342 void do_make_visible_with_new_height () override
;
346 void clear_detail () override
;
348 void make_visible (bool visible
) override
;
349 void refresh_window () override
;
350 void refresh_all () override
;
352 /* Refill the source window's source cache and update it. If this
353 is a disassembly window, then just update it. */
356 /* Set the location of the execution point. */
357 void set_is_exec_point_at (struct tui_line_or_address l
);
359 void set_new_height (int height
) override
;
361 void update_tab_width () override
;
363 /* Return true if the location LOC corresponds to the line number
364 LINE_NO in this source window; false otherwise. */
365 virtual bool location_matches_p (struct bp_location
*loc
, int line_no
) = 0;
367 void reset (int height
, int width
,
368 int origin_x
, int origin_y
) override
;
370 /* Does the locator belong to this window? */
371 bool m_has_locator
= false;
372 /* Execution information window. */
373 struct tui_exec_info_window
*execution_info
;
374 /* Used for horizontal scroll. */
375 int horizontal_offset
= 0;
376 struct tui_line_or_address start_line_or_addr
;
378 /* It is the resolved form as returned by symtab_to_fullname. */
379 char *fullname
= nullptr;
381 /* Architecture associated with code at this location. */
382 struct gdbarch
*gdbarch
= nullptr;
384 std::vector
<tui_source_element
> content
;
387 /* A TUI source window. */
389 struct tui_source_window
: public tui_source_window_base
391 tui_source_window ();
392 ~tui_source_window ();
394 DISABLE_COPY_AND_ASSIGN (tui_source_window
);
396 const char *name () const override
401 bool location_matches_p (struct bp_location
*loc
, int line_no
) override
;
403 bool showing_source_p (const char *filename
) const;
407 void do_scroll_vertical (int num_to_scroll
) override
;
411 void style_changed ();
413 /* A token used to register and unregister an observer. */
414 gdb::observers::token m_observable
;
417 extern int tui_win_is_auxiliary (enum tui_win_type win_type
);
421 extern struct tui_win_info
*tui_win_list
[MAX_MAJOR_WINDOWS
];
423 #define TUI_SRC_WIN ((tui_source_window *) tui_win_list[SRC_WIN])
424 #define TUI_DISASM_WIN ((tui_source_window_base *) tui_win_list[DISASSEM_WIN])
425 #define TUI_DATA_WIN ((tui_data_window *) tui_win_list[DATA_WIN])
426 #define TUI_CMD_WIN ((tui_cmd_window *) tui_win_list[CMD_WIN])
428 /* An iterator that iterates over all windows. */
430 class tui_window_iterator
434 typedef tui_window_iterator self_type
;
435 typedef struct tui_win_info
*value_type
;
436 typedef struct tui_win_info
*&reference
;
437 typedef struct tui_win_info
**pointer
;
438 typedef std::forward_iterator_tag iterator_category
;
439 typedef int difference_type
;
441 explicit tui_window_iterator (enum tui_win_type type
)
447 tui_window_iterator ()
448 : m_type (MAX_MAJOR_WINDOWS
)
452 bool operator!= (const self_type
&other
) const
454 return m_type
!= other
.m_type
;
457 value_type
operator* () const
459 gdb_assert (m_type
< MAX_MAJOR_WINDOWS
);
460 return tui_win_list
[m_type
];
463 self_type
&operator++ ()
474 while (m_type
< MAX_MAJOR_WINDOWS
&& tui_win_list
[m_type
] == nullptr)
481 /* A range adapter for iterating over TUI windows. */
483 struct all_tui_windows
485 tui_window_iterator
begin () const
487 return tui_window_iterator (SRC_WIN
);
490 tui_window_iterator
end () const
492 return tui_window_iterator ();
497 /* Data Manipulation Functions. */
498 extern void tui_initialize_static_data (void);
499 extern struct tui_win_info
*tui_partial_win_by_name (const char *);
500 extern enum tui_layout_type
tui_current_layout (void);
501 extern void tui_set_current_layout_to (enum tui_layout_type
);
502 extern int tui_term_height (void);
503 extern void tui_set_term_height_to (int);
504 extern int tui_term_width (void);
505 extern void tui_set_term_width_to (int);
506 extern struct tui_locator_window
*tui_locator_win_info_ptr (void);
507 extern std::vector
<tui_source_window_base
*> &tui_source_windows ();
508 extern void tui_clear_source_windows (void);
509 extern void tui_clear_source_windows_detail (void);
510 extern void tui_add_to_source_windows (struct tui_source_window_base
*);
511 extern struct tui_win_info
*tui_win_with_focus (void);
512 extern void tui_set_win_with_focus (struct tui_win_info
*);
513 extern struct tui_layout_def
*tui_layout_def (void);
514 extern int tui_win_resized (void);
515 extern void tui_set_win_resized_to (int);
517 extern struct tui_win_info
*tui_next_win (struct tui_win_info
*);
518 extern struct tui_win_info
*tui_prev_win (struct tui_win_info
*);
520 extern unsigned int tui_tab_width
;
522 #endif /* TUI_TUI_DATA_H */