1 /* TUI display source/assembly window.
3 Copyright (C) 1998-2020 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_WINSOURCE_H
23 #define TUI_TUI_WINSOURCE_H
25 #include "tui/tui-data.h"
28 /* Flags to tell what kind of breakpoint is at current line. */
31 TUI_BP_ENABLED
= 0x01,
32 TUI_BP_DISABLED
= 0x02,
34 TUI_BP_CONDITIONAL
= 0x08,
35 TUI_BP_HARDWARE
= 0x10
38 DEF_ENUM_FLAGS_TYPE (enum tui_bp_flag
, tui_bp_flags
);
40 /* Position of breakpoint markers in the exec info string. */
41 #define TUI_BP_HIT_POS 0
42 #define TUI_BP_BREAK_POS 1
43 #define TUI_EXEC_POS 2
44 #define TUI_EXECINFO_SIZE 4
46 /* Elements in the Source/Disassembly Window. */
47 struct tui_source_element
51 line_or_addr
.loa
= LOA_LINE
;
52 line_or_addr
.u
.line_no
= 0;
55 DISABLE_COPY_AND_ASSIGN (tui_source_element
);
57 tui_source_element (tui_source_element
&&other
)
58 : line (std::move (other
.line
)),
59 line_or_addr (other
.line_or_addr
),
60 is_exec_point (other
.is_exec_point
),
61 break_mode (other
.break_mode
)
66 struct tui_line_or_address line_or_addr
;
67 bool is_exec_point
= false;
68 tui_bp_flags break_mode
= 0;
72 /* The base class for all source-like windows, namely the source and
73 disassembly windows. */
75 struct tui_source_window_base
: public tui_win_info
78 tui_source_window_base ();
79 ~tui_source_window_base ();
81 DISABLE_COPY_AND_ASSIGN (tui_source_window_base
);
83 void do_scroll_horizontal (int num_to_scroll
) override
;
85 /* Erase the content and display STRING. */
86 void do_erase_source_content (const char *string
);
88 void rerender () override
;
90 virtual bool set_contents (struct gdbarch
*gdbarch
,
91 const struct symtab_and_line
&sal
) = 0;
93 /* Redraw the complete line of a source or disassembly window. */
94 void show_source_line (int lineno
);
96 /* Used for horizontal scroll. */
97 int m_horizontal_offset
= 0;
98 struct tui_line_or_address m_start_line_or_addr
;
100 /* Architecture associated with code at this location. */
101 struct gdbarch
*m_gdbarch
= nullptr;
103 std::vector
<tui_source_element
> m_content
;
107 /* Refill the source window's source cache and update it. If this
108 is a disassembly window, then just update it. */
111 /* Set the location of the execution point. */
112 void set_is_exec_point_at (struct tui_line_or_address l
);
114 void update_tab_width () override
;
116 virtual bool location_matches_p (struct bp_location
*loc
, int line_no
) = 0;
118 void update_exec_info ();
120 /* Update the window to display the given location. Does nothing if
121 the location is already displayed. */
122 virtual void maybe_update (struct frame_info
*fi
, symtab_and_line sal
) = 0;
124 void update_source_window_as_is (struct gdbarch
*gdbarch
,
125 const struct symtab_and_line
&sal
);
126 void update_source_window (struct gdbarch
*gdbarch
,
127 const struct symtab_and_line
&sal
);
129 /* Scan the source window and the breakpoints to update the
130 break_mode information for each line. Returns true if something
131 changed and the execution window must be refreshed. See
132 tui_update_all_breakpoint_info for a description of
134 bool update_breakpoint_info (struct breakpoint
*being_deleted
,
137 /* Erase the source content. */
138 virtual void erase_source_content () = 0;
140 /* Return the start address and gdbarch. */
141 virtual void display_start_addr (struct gdbarch
**gdbarch_p
,
142 CORE_ADDR
*addr_p
) = 0;
146 void show_source_content ();
148 /* Called when the user "set style enabled" setting is changed. */
149 void style_changed ();
151 /* A token used to register and unregister an observer. */
152 gdb::observers::token m_observable
;
156 /* A wrapper for a TUI window iterator that only iterates over source
159 struct tui_source_window_iterator
163 typedef std::vector
<tui_win_info
*>::iterator inner_iterator
;
165 typedef tui_source_window_iterator self_type
;
166 typedef struct tui_source_window_base
*value_type
;
167 typedef struct tui_source_window_base
*&reference
;
168 typedef struct tui_source_window_base
**pointer
;
169 typedef std::forward_iterator_tag iterator_category
;
170 typedef int difference_type
;
172 explicit tui_source_window_iterator (const inner_iterator
&it
,
173 const inner_iterator
&end
)
180 explicit tui_source_window_iterator (const inner_iterator
&it
)
185 bool operator!= (const self_type
&other
) const
187 return m_iter
!= other
.m_iter
;
190 value_type
operator* () const
192 return dynamic_cast<tui_source_window_base
*> (*m_iter
);
195 self_type
&operator++ ()
206 while (m_iter
!= m_end
207 && dynamic_cast<tui_source_window_base
*> (*m_iter
) == nullptr)
211 inner_iterator m_iter
;
212 inner_iterator m_end
;
215 /* A range adapter for source windows. */
217 struct tui_source_windows
219 tui_source_window_iterator
begin () const
221 return tui_source_window_iterator (tui_windows
.begin (),
225 tui_source_window_iterator
end () const
227 return tui_source_window_iterator (tui_windows
.end ());
231 /* Update the execution windows to show the active breakpoints. This
232 is called whenever a breakpoint is inserted, removed or has its
233 state changed. Normally BEING_DELETED is nullptr; if not nullptr,
234 it indicates a breakpoint that is in the process of being deleted,
235 and which should therefore be ignored by the update. This is done
236 because the relevant observer is notified before the breakpoint is
237 removed from the list of breakpoints. */
238 extern void tui_update_all_breakpoint_info (struct breakpoint
*being_deleted
);
240 /* Function to display the "main" routine. */
241 extern void tui_display_main (void);
242 extern void tui_update_source_windows_with_addr (struct gdbarch
*, CORE_ADDR
);
243 extern void tui_update_source_windows_with_line (struct symtab_and_line sal
);
245 /* Extract some source text from PTR. LINE_NO is the line number. If
246 it is positive, it is printed at the start of the line. FIRST_COL
247 is the first column to extract, and LINE_WIDTH is the number of
248 characters to display. NDIGITS is used to format the line number
249 (if it is positive). If NDIGITS is greater than 0, then that many
250 digits are used; otherwise the line number is formatted with 6
251 digits and the text is aligned to the next tab stop. Returns a
252 string holding the desired text. PTR is updated to point to the
253 start of the next line. */
255 extern std::string
tui_copy_source_line (const char **ptr
,
256 int line_no
, int first_col
,
257 int line_width
, int ndigits
);
259 /* Constant definitions. */
260 #define SCROLL_THRESHOLD 2 /* Threshold for lazy scroll. */
262 #endif /* TUI_TUI_WINSOURCE_H */