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 /* This is a point definition. */
35 /* Generic window information. */
36 struct tui_gen_win_info
40 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 /* 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 /* A data item window. */
254 struct tui_data_item_window
: public tui_gen_win_info
256 tui_data_item_window ()
257 : tui_gen_win_info (DATA_ITEM_WIN
)
261 ~tui_data_item_window () override
;
263 const char *name
= nullptr;
264 /* The register number, or data display number. */
266 void *value
= nullptr;
267 bool highlight
= false;
268 char *content
= nullptr;
271 /* This defines information about each logical window. */
272 struct tui_win_info
: public tui_gen_win_info
276 explicit tui_win_info (enum tui_win_type type
);
277 DISABLE_COPY_AND_ASSIGN (tui_win_info
);
279 /* Scroll the contents vertically. This is only called via
280 forward_scroll and backward_scroll. */
281 virtual void do_scroll_vertical (int num_to_scroll
) = 0;
283 /* Scroll the contents horizontally. This is only called via
284 left_scroll and right_scroll. */
285 virtual void do_scroll_horizontal (int num_to_scroll
) = 0;
287 /* Called after make_visible_with_new_height sets the new height.
288 Should update the window. */
289 virtual void do_make_visible_with_new_height () = 0;
293 ~tui_win_info () override
297 /* Clear the pertinent detail in the window. */
298 virtual void clear_detail () = 0;
300 /* Return true if this window has the locator. */
301 virtual bool has_locator () const
306 /* Refresh this window and any associated windows. */
307 virtual void refresh ();
309 /* Called after all the TUI windows are refreshed, to let this
310 window have a chance to update itself further. */
311 virtual void refresh_all ()
315 /* Called after a TUI window is given a new height; this updates any
316 related auxiliary windows. */
317 virtual void set_new_height (int height
)
321 /* Compute the maximum height of this window. */
322 virtual int max_height () const;
324 /* Called after the tab width has been changed. */
325 virtual void update_tab_width ()
329 /* Make the window visible after the height has been changed. */
330 void make_visible_with_new_height ();
332 /* Set whether this window is highglighted. */
333 void set_highlight (bool highlight
)
335 is_highlighted
= highlight
;
338 /* Methods to scroll the contents of this window. Note that they
339 are named with "_scroll" coming at the end because the more
340 obvious "scroll_forward" is defined as a macro in term.h. */
341 void forward_scroll (int num_to_scroll
);
342 void backward_scroll (int num_to_scroll
);
343 void left_scroll (int num_to_scroll
);
344 void right_scroll (int num_to_scroll
);
346 /* Return true if this window can be scrolled, false otherwise. */
347 virtual bool can_scroll () const
352 /* Can this window ever be highlighted? */
353 bool can_highlight
= true;
355 /* Is this window highlighted? */
356 bool is_highlighted
= false;
359 /* The base class for all source-like windows, namely the source and
360 disassembly windows. */
362 struct tui_source_window_base
: public tui_win_info
365 explicit tui_source_window_base (enum tui_win_type type
);
366 ~tui_source_window_base () override
;
367 DISABLE_COPY_AND_ASSIGN (tui_source_window_base
);
369 void do_scroll_horizontal (int num_to_scroll
) override
;
370 void do_make_visible_with_new_height () override
;
374 void clear_detail () override
;
376 /* Return true if this window has the locator. */
377 bool has_locator () const override
379 return m_has_locator
;
382 void make_visible (bool visible
) override
;
383 void refresh () override
;
384 void refresh_all () override
;
386 /* Refill the source window's source cache and update it. If this
387 is a disassembly window, then just update it. */
390 /* Set the location of the execution point. */
391 void set_is_exec_point_at (struct tui_line_or_address l
);
393 void set_new_height (int height
) override
;
395 void update_tab_width () override
;
397 /* Return true if the location LOC corresponds to the line number
398 LINE_NO in this source window; false otherwise. */
399 virtual bool location_matches_p (struct bp_location
*loc
, int line_no
) = 0;
401 /* Can it be used, or is it already used? */
402 bool content_in_use
= false;
403 /* Does the locator belong to this window? */
404 bool m_has_locator
= false;
405 /* Execution information window. */
406 struct tui_exec_info_window
*execution_info
= nullptr;
407 /* Used for horizontal scroll. */
408 int horizontal_offset
= 0;
409 struct tui_line_or_address start_line_or_addr
;
411 /* It is the resolved form as returned by symtab_to_fullname. */
412 char *fullname
= nullptr;
414 /* Architecture associated with code at this location. */
415 struct gdbarch
*gdbarch
= nullptr;
417 std::vector
<tui_source_element
> content
;
420 /* A TUI source window. */
422 struct tui_source_window
: public tui_source_window_base
424 tui_source_window ();
425 ~tui_source_window ();
427 DISABLE_COPY_AND_ASSIGN (tui_source_window
);
429 const char *name () const override
434 bool location_matches_p (struct bp_location
*loc
, int line_no
) override
;
436 bool showing_source_p (const char *filename
) const;
440 void do_scroll_vertical (int num_to_scroll
) override
;
444 void style_changed ();
446 /* A token used to register and unregister an observer. */
447 gdb::observers::token m_observable
;
450 /* A TUI disassembly window. */
452 struct tui_disasm_window
: public tui_source_window_base
455 : tui_source_window_base (DISASSEM_WIN
)
459 DISABLE_COPY_AND_ASSIGN (tui_disasm_window
);
461 const char *name () const override
463 return DISASSEM_NAME
;
466 bool location_matches_p (struct bp_location
*loc
, int line_no
) override
;
470 void do_scroll_vertical (int num_to_scroll
) override
;
473 struct tui_data_window
: public tui_win_info
476 : tui_win_info (DATA_WIN
)
480 DISABLE_COPY_AND_ASSIGN (tui_data_window
);
482 void clear_detail () override
;
483 void refresh_all () override
;
485 void set_new_height (int height
) override
;
487 void refresh_window () override
;
489 const char *name () const override
494 /* Windows that are used to display registers. */
495 std::vector
<std::unique_ptr
<tui_data_item_window
>> regs_content
;
496 int regs_column_count
= 0;
497 /* Should regs be displayed at all? */
498 bool display_regs
= false;
499 struct reggroup
*current_group
= nullptr;
501 /* Answer the number of the last line in the regs display. If there
502 are no registers (-1) is returned. */
503 int last_regs_line_no () const;
505 /* Answer the line number that the register element at element_no is
506 on. If element_no is greater than the number of register
507 elements there are, -1 is returned. */
508 int line_from_reg_element_no (int element_no
) const;
510 /* Answer the index of the first element in line_no. If line_no is
511 past the register area (-1) is returned. */
512 int first_reg_element_no_inline (int line_no
) const;
514 /* Displays the data that is in the data window's content. It does
515 not set the content. */
516 void display_all_data ();
518 /* Delete all the item windows in the data window. This is usually
519 done when the data window is scrolled. */
520 void delete_data_content_windows ();
522 void erase_data_content (const char *prompt
);
524 /* Display the registers in the content from 'start_element_no'
525 until the end of the register content or the end of the display
526 height. No checking for displaying past the end of the registers
528 void display_registers_from (int start_element_no
);
530 /* Display the registers starting at line line_no in the data
531 window. Answers the line number that the display actually
532 started from. If nothing is displayed (-1) is returned. */
533 int display_registers_from_line (int line_no
);
537 void do_scroll_vertical (int num_to_scroll
) override
;
538 void do_scroll_horizontal (int num_to_scroll
) override
541 void do_make_visible_with_new_height () override
;
543 /* Return the index of the first element displayed. If none are
544 displayed, then return -1. */
545 int first_data_item_displayed ();
547 /* Display the registers in the content from 'start_element_no' on
548 'start_line_no' until the end of the register content or the end
549 of the display height. This function checks that we won't
550 display off the end of the register display. */
551 void display_reg_element_at_line (int start_element_no
, int start_line_no
);
554 struct tui_cmd_window
: public tui_win_info
557 : tui_win_info (CMD_WIN
)
559 can_highlight
= false;
562 DISABLE_COPY_AND_ASSIGN (tui_cmd_window
);
564 void clear_detail () override
;
566 void make_visible (bool visible
) override
570 int max_height () const override
;
572 void refresh_window () override
576 const char *name () const override
581 bool can_scroll () const override
590 void do_scroll_vertical (int num_to_scroll
) override
594 void do_scroll_horizontal (int num_to_scroll
) override
598 void do_make_visible_with_new_height () override
;
601 extern int tui_win_is_auxiliary (enum tui_win_type win_type
);
605 extern struct tui_win_info
*tui_win_list
[MAX_MAJOR_WINDOWS
];
607 #define TUI_SRC_WIN ((tui_source_window *) tui_win_list[SRC_WIN])
608 #define TUI_DISASM_WIN ((tui_source_window_base *) tui_win_list[DISASSEM_WIN])
609 #define TUI_DATA_WIN ((tui_data_window *) tui_win_list[DATA_WIN])
610 #define TUI_CMD_WIN ((tui_cmd_window *) tui_win_list[CMD_WIN])
612 /* An iterator that iterates over all windows. */
614 class tui_window_iterator
618 typedef tui_window_iterator self_type
;
619 typedef struct tui_win_info
*value_type
;
620 typedef struct tui_win_info
*&reference
;
621 typedef struct tui_win_info
**pointer
;
622 typedef std::forward_iterator_tag iterator_category
;
623 typedef int difference_type
;
625 explicit tui_window_iterator (enum tui_win_type type
)
631 tui_window_iterator ()
632 : m_type (MAX_MAJOR_WINDOWS
)
636 bool operator!= (const self_type
&other
) const
638 return m_type
!= other
.m_type
;
641 value_type
operator* () const
643 gdb_assert (m_type
< MAX_MAJOR_WINDOWS
);
644 return tui_win_list
[m_type
];
647 self_type
&operator++ ()
658 while (m_type
< MAX_MAJOR_WINDOWS
&& tui_win_list
[m_type
] == nullptr)
665 /* A range adapter for iterating over TUI windows. */
667 struct all_tui_windows
669 tui_window_iterator
begin () const
671 return tui_window_iterator (SRC_WIN
);
674 tui_window_iterator
end () const
676 return tui_window_iterator ();
681 /* Data Manipulation Functions. */
682 extern void tui_initialize_static_data (void);
683 extern struct tui_win_info
*tui_partial_win_by_name (const char *);
684 extern enum tui_layout_type
tui_current_layout (void);
685 extern void tui_set_current_layout_to (enum tui_layout_type
);
686 extern int tui_term_height (void);
687 extern void tui_set_term_height_to (int);
688 extern int tui_term_width (void);
689 extern void tui_set_term_width_to (int);
690 extern struct tui_locator_window
*tui_locator_win_info_ptr (void);
691 extern std::vector
<tui_source_window_base
*> &tui_source_windows ();
692 extern void tui_clear_source_windows (void);
693 extern void tui_clear_source_windows_detail (void);
694 extern void tui_add_to_source_windows (struct tui_source_window_base
*);
695 extern struct tui_win_info
*tui_win_with_focus (void);
696 extern void tui_set_win_with_focus (struct tui_win_info
*);
697 extern struct tui_layout_def
*tui_layout_def (void);
698 extern int tui_win_resized (void);
699 extern void tui_set_win_resized_to (int);
701 extern struct tui_win_info
*tui_next_win (struct tui_win_info
*);
702 extern struct tui_win_info
*tui_prev_win (struct tui_win_info
*);
704 extern unsigned int tui_tab_width
;
706 #endif /* TUI_TUI_DATA_H */