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. The parameters are used to set the window's
63 virtual void reset (int height
, int width
,
64 int origin_x
, int origin_y
);
67 WINDOW
*handle
= nullptr;
69 enum tui_win_type type
;
74 /* Origin of window. */
75 struct tui_point origin
= {0, 0};
76 /* Viewport height. */
77 int viewport_height
= 0;
78 /* Index of last visible line. */
79 int last_visible_line
= 0;
80 /* Whether the window is visible or not. */
81 bool is_visible
= false;
82 /* Window title to display. */
83 char *title
= nullptr;
86 /* Whether or not a window should be drawn with a box. */
93 /* Constant definitions. */
94 #define DEFAULT_TAB_LEN 8
95 #define NO_SRC_STRING "[ No Source Available ]"
96 #define NO_DISASSEM_STRING "[ No Assembly Available ]"
97 #define NO_REGS_STRING "[ Register Values Unavailable ]"
98 #define NO_DATA_STRING "[ No Data Values Displayed ]"
99 #define SRC_NAME "src"
100 #define CMD_NAME "cmd"
101 #define DATA_NAME "regs"
102 #define DISASSEM_NAME "asm"
104 #define NO_HILITE FALSE
105 #define MIN_WIN_HEIGHT 3
106 #define MIN_CMD_WIN_HEIGHT 3
108 /* Strings to display in the TUI status line. */
109 #define PROC_PREFIX "In: "
110 #define LINE_PREFIX "L"
111 #define PC_PREFIX "PC: "
112 #define SINGLE_KEY "(SingleKey)"
114 /* Minimum/Maximum length of some fields displayed in the TUI status
116 #define MIN_LINE_WIDTH 4 /* Use at least 4 digits for line
118 #define MIN_PROC_WIDTH 12
119 #define MAX_TARGET_WIDTH 10
120 #define MAX_PID_WIDTH 19
122 /* The kinds of layouts available. */
127 SRC_DISASSEM_COMMAND
,
129 DISASSEM_DATA_COMMAND
,
133 enum tui_line_or_address_kind
139 /* Structure describing source line or line address. */
140 struct tui_line_or_address
142 enum tui_line_or_address_kind loa
;
150 /* Current Layout definition. */
151 struct tui_layout_def
153 enum tui_win_type display_mode
;
156 /* Flags to tell what kind of breakpoint is at current line. */
159 TUI_BP_ENABLED
= 0x01,
160 TUI_BP_DISABLED
= 0x02,
162 TUI_BP_CONDITIONAL
= 0x08,
163 TUI_BP_HARDWARE
= 0x10
166 DEF_ENUM_FLAGS_TYPE (enum tui_bp_flag
, tui_bp_flags
);
168 /* Elements in the Source/Disassembly Window. */
169 struct tui_source_element
171 tui_source_element ()
173 line_or_addr
.loa
= LOA_LINE
;
174 line_or_addr
.u
.line_no
= 0;
177 ~tui_source_element ()
182 char *line
= nullptr;
183 struct tui_line_or_address line_or_addr
;
184 bool is_exec_point
= false;
185 tui_bp_flags break_mode
= 0;
190 # define MAX_LOCATOR_ELEMENT_LEN PATH_MAX
192 # define MAX_LOCATOR_ELEMENT_LEN 1024
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 /* Execution info window class. */
205 struct tui_exec_info_window
: public tui_gen_win_info
207 tui_exec_info_window ()
208 : tui_gen_win_info (EXEC_INFO_WIN
)
212 ~tui_exec_info_window () override
217 /* Get or allocate contents. */
218 tui_exec_info_content
*maybe_allocate_content (int n_elements
);
220 /* Return the contents. */
221 const tui_exec_info_content
*get_content () const
228 tui_exec_info_content
*m_content
= nullptr;
231 /* Locator window class. */
233 struct tui_locator_window
: public tui_gen_win_info
235 tui_locator_window ()
236 : tui_gen_win_info (LOCATOR_WIN
)
242 char full_name
[MAX_LOCATOR_ELEMENT_LEN
];
243 char proc_name
[MAX_LOCATOR_ELEMENT_LEN
];
246 /* Architecture associated with code at this location. */
247 struct gdbarch
*gdbarch
= nullptr;
250 /* A data item window. */
252 struct tui_data_item_window
: public tui_gen_win_info
254 tui_data_item_window ()
255 : tui_gen_win_info (DATA_ITEM_WIN
)
259 ~tui_data_item_window () override
;
261 const char *name
= nullptr;
262 /* The register number, or data display number. */
264 void *value
= nullptr;
265 bool highlight
= false;
266 char *content
= nullptr;
269 /* This defines information about each logical window. */
270 struct tui_win_info
: public tui_gen_win_info
274 explicit tui_win_info (enum tui_win_type type
);
275 DISABLE_COPY_AND_ASSIGN (tui_win_info
);
277 /* Scroll the contents vertically. This is only called via
278 forward_scroll and backward_scroll. */
279 virtual void do_scroll_vertical (int num_to_scroll
) = 0;
281 /* Scroll the contents horizontally. This is only called via
282 left_scroll and right_scroll. */
283 virtual void do_scroll_horizontal (int num_to_scroll
) = 0;
285 /* Called after make_visible_with_new_height sets the new height.
286 Should update the window. */
287 virtual void do_make_visible_with_new_height () = 0;
291 ~tui_win_info () override
295 /* Clear the pertinent detail in the window. */
296 virtual void clear_detail () = 0;
298 /* Called after all the TUI windows are refreshed, to let this
299 window have a chance to update itself further. */
300 virtual void refresh_all ()
304 /* Called after a TUI window is given a new height; this updates any
305 related auxiliary windows. */
306 virtual void set_new_height (int height
)
310 /* Compute the maximum height of this window. */
311 virtual int max_height () const;
313 /* Called after the tab width has been changed. */
314 virtual void update_tab_width ()
318 /* Make the window visible after the height has been changed. */
319 void make_visible_with_new_height ();
321 /* Set whether this window is highglighted. */
322 void set_highlight (bool highlight
)
324 is_highlighted
= highlight
;
327 /* Methods to scroll the contents of this window. Note that they
328 are named with "_scroll" coming at the end because the more
329 obvious "scroll_forward" is defined as a macro in term.h. */
330 void forward_scroll (int num_to_scroll
);
331 void backward_scroll (int num_to_scroll
);
332 void left_scroll (int num_to_scroll
);
333 void right_scroll (int num_to_scroll
);
335 /* Return true if this window can be scrolled, false otherwise. */
336 virtual bool can_scroll () const
341 /* Can this window ever be highlighted? */
342 bool can_highlight
= true;
344 /* Is this window highlighted? */
345 bool is_highlighted
= false;
348 /* The base class for all source-like windows, namely the source and
349 disassembly windows. */
351 struct tui_source_window_base
: public tui_win_info
354 explicit tui_source_window_base (enum tui_win_type type
);
355 ~tui_source_window_base () override
;
356 DISABLE_COPY_AND_ASSIGN (tui_source_window_base
);
358 void do_scroll_horizontal (int num_to_scroll
) override
;
359 void do_make_visible_with_new_height () override
;
363 void clear_detail () override
;
365 void make_visible (bool visible
) override
;
366 void refresh_window () override
;
367 void refresh_all () override
;
369 /* Refill the source window's source cache and update it. If this
370 is a disassembly window, then just update it. */
373 /* Set the location of the execution point. */
374 void set_is_exec_point_at (struct tui_line_or_address l
);
376 void set_new_height (int height
) override
;
378 void update_tab_width () override
;
380 /* Return true if the location LOC corresponds to the line number
381 LINE_NO in this source window; false otherwise. */
382 virtual bool location_matches_p (struct bp_location
*loc
, int line_no
) = 0;
384 void reset (int height
, int width
,
385 int origin_x
, int origin_y
) override
;
387 /* Does the locator belong to this window? */
388 bool m_has_locator
= false;
389 /* Execution information window. */
390 struct tui_exec_info_window
*execution_info
;
391 /* Used for horizontal scroll. */
392 int horizontal_offset
= 0;
393 struct tui_line_or_address start_line_or_addr
;
395 /* It is the resolved form as returned by symtab_to_fullname. */
396 char *fullname
= nullptr;
398 /* Architecture associated with code at this location. */
399 struct gdbarch
*gdbarch
= nullptr;
401 std::vector
<tui_source_element
> content
;
404 /* A TUI source window. */
406 struct tui_source_window
: public tui_source_window_base
408 tui_source_window ();
409 ~tui_source_window ();
411 DISABLE_COPY_AND_ASSIGN (tui_source_window
);
413 const char *name () const override
418 bool location_matches_p (struct bp_location
*loc
, int line_no
) override
;
420 bool showing_source_p (const char *filename
) const;
424 void do_scroll_vertical (int num_to_scroll
) override
;
428 void style_changed ();
430 /* A token used to register and unregister an observer. */
431 gdb::observers::token m_observable
;
434 /* A TUI disassembly window. */
436 struct tui_disasm_window
: public tui_source_window_base
439 : tui_source_window_base (DISASSEM_WIN
)
443 DISABLE_COPY_AND_ASSIGN (tui_disasm_window
);
445 const char *name () const override
447 return DISASSEM_NAME
;
450 bool location_matches_p (struct bp_location
*loc
, int line_no
) override
;
454 void do_scroll_vertical (int num_to_scroll
) override
;
457 struct tui_data_window
: public tui_win_info
460 : tui_win_info (DATA_WIN
)
464 DISABLE_COPY_AND_ASSIGN (tui_data_window
);
466 void clear_detail () override
;
467 void refresh_all () override
;
469 void set_new_height (int height
) override
;
471 void refresh_window () override
;
473 const char *name () const override
478 /* Windows that are used to display registers. */
479 std::vector
<std::unique_ptr
<tui_data_item_window
>> regs_content
;
480 int regs_column_count
= 0;
481 /* Should regs be displayed at all? */
482 bool display_regs
= false;
483 struct reggroup
*current_group
= nullptr;
485 /* Answer the number of the last line in the regs display. If there
486 are no registers (-1) is returned. */
487 int last_regs_line_no () const;
489 /* Answer the line number that the register element at element_no is
490 on. If element_no is greater than the number of register
491 elements there are, -1 is returned. */
492 int line_from_reg_element_no (int element_no
) const;
494 /* Answer the index of the first element in line_no. If line_no is
495 past the register area (-1) is returned. */
496 int first_reg_element_no_inline (int line_no
) const;
498 /* Displays the data that is in the data window's content. It does
499 not set the content. */
500 void display_all_data ();
502 /* Delete all the item windows in the data window. This is usually
503 done when the data window is scrolled. */
504 void delete_data_content_windows ();
506 void erase_data_content (const char *prompt
);
508 /* Display the registers in the content from 'start_element_no'
509 until the end of the register content or the end of the display
510 height. No checking for displaying past the end of the registers
512 void display_registers_from (int start_element_no
);
514 /* Display the registers starting at line line_no in the data
515 window. Answers the line number that the display actually
516 started from. If nothing is displayed (-1) is returned. */
517 int display_registers_from_line (int line_no
);
521 void do_scroll_vertical (int num_to_scroll
) override
;
522 void do_scroll_horizontal (int num_to_scroll
) override
525 void do_make_visible_with_new_height () override
;
527 /* Return the index of the first element displayed. If none are
528 displayed, then return -1. */
529 int first_data_item_displayed ();
531 /* Display the registers in the content from 'start_element_no' on
532 'start_line_no' until the end of the register content or the end
533 of the display height. This function checks that we won't
534 display off the end of the register display. */
535 void display_reg_element_at_line (int start_element_no
, int start_line_no
);
538 struct tui_cmd_window
: public tui_win_info
541 : tui_win_info (CMD_WIN
)
543 can_highlight
= false;
546 DISABLE_COPY_AND_ASSIGN (tui_cmd_window
);
548 void clear_detail () override
;
550 void make_visible (bool visible
) override
554 int max_height () const override
;
556 void refresh_window () override
560 const char *name () const override
565 bool can_scroll () const override
574 void do_scroll_vertical (int num_to_scroll
) override
578 void do_scroll_horizontal (int num_to_scroll
) override
582 void do_make_visible_with_new_height () override
;
585 extern int tui_win_is_auxiliary (enum tui_win_type win_type
);
589 extern struct tui_win_info
*tui_win_list
[MAX_MAJOR_WINDOWS
];
591 #define TUI_SRC_WIN ((tui_source_window *) tui_win_list[SRC_WIN])
592 #define TUI_DISASM_WIN ((tui_source_window_base *) tui_win_list[DISASSEM_WIN])
593 #define TUI_DATA_WIN ((tui_data_window *) tui_win_list[DATA_WIN])
594 #define TUI_CMD_WIN ((tui_cmd_window *) tui_win_list[CMD_WIN])
596 /* An iterator that iterates over all windows. */
598 class tui_window_iterator
602 typedef tui_window_iterator self_type
;
603 typedef struct tui_win_info
*value_type
;
604 typedef struct tui_win_info
*&reference
;
605 typedef struct tui_win_info
**pointer
;
606 typedef std::forward_iterator_tag iterator_category
;
607 typedef int difference_type
;
609 explicit tui_window_iterator (enum tui_win_type type
)
615 tui_window_iterator ()
616 : m_type (MAX_MAJOR_WINDOWS
)
620 bool operator!= (const self_type
&other
) const
622 return m_type
!= other
.m_type
;
625 value_type
operator* () const
627 gdb_assert (m_type
< MAX_MAJOR_WINDOWS
);
628 return tui_win_list
[m_type
];
631 self_type
&operator++ ()
642 while (m_type
< MAX_MAJOR_WINDOWS
&& tui_win_list
[m_type
] == nullptr)
649 /* A range adapter for iterating over TUI windows. */
651 struct all_tui_windows
653 tui_window_iterator
begin () const
655 return tui_window_iterator (SRC_WIN
);
658 tui_window_iterator
end () const
660 return tui_window_iterator ();
665 /* Data Manipulation Functions. */
666 extern void tui_initialize_static_data (void);
667 extern struct tui_win_info
*tui_partial_win_by_name (const char *);
668 extern enum tui_layout_type
tui_current_layout (void);
669 extern void tui_set_current_layout_to (enum tui_layout_type
);
670 extern int tui_term_height (void);
671 extern void tui_set_term_height_to (int);
672 extern int tui_term_width (void);
673 extern void tui_set_term_width_to (int);
674 extern struct tui_locator_window
*tui_locator_win_info_ptr (void);
675 extern std::vector
<tui_source_window_base
*> &tui_source_windows ();
676 extern void tui_clear_source_windows (void);
677 extern void tui_clear_source_windows_detail (void);
678 extern void tui_add_to_source_windows (struct tui_source_window_base
*);
679 extern struct tui_win_info
*tui_win_with_focus (void);
680 extern void tui_set_win_with_focus (struct tui_win_info
*);
681 extern struct tui_layout_def
*tui_layout_def (void);
682 extern int tui_win_resized (void);
683 extern void tui_set_win_resized_to (int);
685 extern struct tui_win_info
*tui_next_win (struct tui_win_info
*);
686 extern struct tui_win_info
*tui_prev_win (struct tui_win_info
*);
688 extern unsigned int tui_tab_width
;
690 #endif /* TUI_TUI_DATA_H */