Commit | Line | Data |
---|---|---|
f377b406 | 1 | /* TUI display source/assembly window. |
f80bda8e | 2 | |
b811d2c2 | 3 | Copyright (C) 1998-2020 Free Software Foundation, Inc. |
f80bda8e | 4 | |
f377b406 SC |
5 | Contributed by Hewlett-Packard Company. |
6 | ||
7 | This file is part of GDB. | |
8 | ||
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 | |
a9762ec7 | 11 | the Free Software Foundation; either version 3 of the License, or |
f377b406 SC |
12 | (at your option) any later version. |
13 | ||
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. | |
18 | ||
19 | You should have received a copy of the GNU General Public License | |
a9762ec7 | 20 | along with this program. If not, see <http://www.gnu.org/licenses/>. */ |
f377b406 | 21 | |
1a5c2598 TT |
22 | #ifndef TUI_TUI_WINSOURCE_H |
23 | #define TUI_TUI_WINSOURCE_H | |
f80bda8e AC |
24 | |
25 | #include "tui/tui-data.h" | |
a54700c6 | 26 | #include "symtab.h" |
f80bda8e | 27 | |
7b56485d TT |
28 | /* Flags to tell what kind of breakpoint is at current line. */ |
29 | enum tui_bp_flag | |
30 | { | |
31 | TUI_BP_ENABLED = 0x01, | |
32 | TUI_BP_DISABLED = 0x02, | |
33 | TUI_BP_HIT = 0x04, | |
34 | TUI_BP_CONDITIONAL = 0x08, | |
35 | TUI_BP_HARDWARE = 0x10 | |
36 | }; | |
37 | ||
38 | DEF_ENUM_FLAGS_TYPE (enum tui_bp_flag, tui_bp_flags); | |
39 | ||
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 | |
45 | ||
7b56485d TT |
46 | /* Elements in the Source/Disassembly Window. */ |
47 | struct tui_source_element | |
48 | { | |
49 | tui_source_element () | |
50 | { | |
51 | line_or_addr.loa = LOA_LINE; | |
52 | line_or_addr.u.line_no = 0; | |
53 | } | |
54 | ||
002f15c2 TT |
55 | DISABLE_COPY_AND_ASSIGN (tui_source_element); |
56 | ||
57 | tui_source_element (tui_source_element &&other) | |
f14bec58 | 58 | : line (std::move (other.line)), |
002f15c2 TT |
59 | line_or_addr (other.line_or_addr), |
60 | is_exec_point (other.is_exec_point), | |
61 | break_mode (other.break_mode) | |
62 | { | |
002f15c2 TT |
63 | } |
64 | ||
5d051055 | 65 | std::string line; |
7b56485d TT |
66 | struct tui_line_or_address line_or_addr; |
67 | bool is_exec_point = false; | |
68 | tui_bp_flags break_mode = 0; | |
69 | }; | |
70 | ||
71 | ||
5104fe36 TT |
72 | /* The base class for all source-like windows, namely the source and |
73 | disassembly windows. */ | |
74 | ||
75 | struct tui_source_window_base : public tui_win_info | |
76 | { | |
77 | protected: | |
78 | explicit tui_source_window_base (enum tui_win_type type); | |
1df2f9ef | 79 | ~tui_source_window_base (); |
2d81b349 | 80 | |
5104fe36 TT |
81 | DISABLE_COPY_AND_ASSIGN (tui_source_window_base); |
82 | ||
83 | void do_scroll_horizontal (int num_to_scroll) override; | |
5104fe36 | 84 | |
e25d2004 TT |
85 | /* Erase the content and display STRING. */ |
86 | void do_erase_source_content (const char *string); | |
87 | ||
3df505f6 TT |
88 | void rerender () override; |
89 | ||
61c33f10 | 90 | virtual bool set_contents (struct gdbarch *gdbarch, |
9f7540a5 | 91 | const struct symtab_and_line &sal) = 0; |
81c82c4b | 92 | |
5104fe36 TT |
93 | public: |
94 | ||
5104fe36 TT |
95 | /* Refill the source window's source cache and update it. If this |
96 | is a disassembly window, then just update it. */ | |
97 | void refill (); | |
98 | ||
99 | /* Set the location of the execution point. */ | |
100 | void set_is_exec_point_at (struct tui_line_or_address l); | |
101 | ||
5104fe36 TT |
102 | void update_tab_width () override; |
103 | ||
104 | virtual bool location_matches_p (struct bp_location *loc, int line_no) = 0; | |
105 | ||
7ba913dc | 106 | void update_exec_info (); |
37a4a131 | 107 | |
a54700c6 TT |
108 | /* Update the window to display the given location. Does nothing if |
109 | the location is already displayed. */ | |
1ae58f0c | 110 | virtual void maybe_update (struct frame_info *fi, symtab_and_line sal) = 0; |
a54700c6 | 111 | |
ed8358e9 | 112 | void update_source_window_as_is (struct gdbarch *gdbarch, |
9f7540a5 | 113 | const struct symtab_and_line &sal); |
017f9828 | 114 | void update_source_window (struct gdbarch *gdbarch, |
9f7540a5 | 115 | const struct symtab_and_line &sal); |
ed8358e9 | 116 | |
2ddaf614 TT |
117 | /* Scan the source window and the breakpoints to update the |
118 | break_mode information for each line. Returns true if something | |
119 | changed and the execution window must be refreshed. See | |
120 | tui_update_all_breakpoint_info for a description of | |
121 | BEING_DELETED. */ | |
122 | bool update_breakpoint_info (struct breakpoint *being_deleted, | |
123 | bool current_only); | |
124 | ||
e25d2004 TT |
125 | /* Erase the source content. */ |
126 | virtual void erase_source_content () = 0; | |
127 | ||
5104fe36 TT |
128 | /* Used for horizontal scroll. */ |
129 | int horizontal_offset = 0; | |
130 | struct tui_line_or_address start_line_or_addr; | |
131 | ||
5104fe36 TT |
132 | /* Architecture associated with code at this location. */ |
133 | struct gdbarch *gdbarch = nullptr; | |
134 | ||
135 | std::vector<tui_source_element> content; | |
1df2f9ef TT |
136 | |
137 | private: | |
138 | ||
139 | void show_source_content (); | |
140 | ||
141 | /* Called when the user "set style enabled" setting is changed. */ | |
142 | void style_changed (); | |
143 | ||
144 | /* A token used to register and unregister an observer. */ | |
145 | gdb::observers::token m_observable; | |
5104fe36 | 146 | }; |
c906108c | 147 | |
3891b65e TT |
148 | |
149 | /* A wrapper for a TUI window iterator that only iterates over source | |
150 | windows. */ | |
151 | ||
152 | struct tui_source_window_iterator | |
153 | { | |
154 | public: | |
155 | ||
156 | typedef tui_source_window_iterator self_type; | |
157 | typedef struct tui_source_window_base *value_type; | |
158 | typedef struct tui_source_window_base *&reference; | |
159 | typedef struct tui_source_window_base **pointer; | |
160 | typedef std::forward_iterator_tag iterator_category; | |
161 | typedef int difference_type; | |
162 | ||
163 | explicit tui_source_window_iterator (bool dummy) | |
164 | : m_iter (SRC_WIN) | |
165 | { | |
166 | advance (); | |
167 | } | |
168 | ||
169 | tui_source_window_iterator () | |
170 | : m_iter (tui_win_type (DISASSEM_WIN + 1)) | |
171 | { | |
172 | } | |
173 | ||
174 | bool operator!= (const self_type &other) const | |
175 | { | |
176 | return m_iter != other.m_iter; | |
177 | } | |
178 | ||
179 | value_type operator* () const | |
180 | { | |
181 | return (value_type) *m_iter; | |
182 | } | |
183 | ||
184 | self_type &operator++ () | |
185 | { | |
186 | ++m_iter; | |
187 | advance (); | |
188 | return *this; | |
189 | } | |
190 | ||
191 | private: | |
192 | ||
193 | void advance () | |
194 | { | |
195 | tui_window_iterator end; | |
196 | while (m_iter != end && *m_iter == nullptr) | |
197 | ++m_iter; | |
198 | } | |
199 | ||
200 | tui_window_iterator m_iter; | |
201 | }; | |
202 | ||
203 | /* A range adapter for source windows. */ | |
204 | ||
205 | struct tui_source_windows | |
206 | { | |
207 | tui_source_window_iterator begin () const | |
208 | { | |
209 | return tui_source_window_iterator (true); | |
210 | } | |
211 | ||
212 | tui_source_window_iterator end () const | |
213 | { | |
214 | return tui_source_window_iterator (); | |
215 | } | |
216 | }; | |
217 | ||
f80bda8e AC |
218 | /* Update the execution windows to show the active breakpoints. This |
219 | is called whenever a breakpoint is inserted, removed or has its | |
0807ab7b TT |
220 | state changed. Normally BEING_DELETED is nullptr; if not nullptr, |
221 | it indicates a breakpoint that is in the process of being deleted, | |
222 | and which should therefore be ignored by the update. This is done | |
223 | because the relevant observer is notified before the breakpoint is | |
224 | removed from the list of breakpoints. */ | |
225 | extern void tui_update_all_breakpoint_info (struct breakpoint *being_deleted); | |
00b2bad4 | 226 | |
1f393769 SC |
227 | /* Function to display the "main" routine. */ |
228 | extern void tui_display_main (void); | |
13274fc3 | 229 | extern void tui_update_source_windows_with_addr (struct gdbarch *, CORE_ADDR); |
5d49bf1b | 230 | extern void tui_update_source_windows_with_line (struct symtab_and_line sal); |
f80bda8e | 231 | |
1df2f9ef TT |
232 | /* Extract some source text from PTR. LINE_NO is the line number. If |
233 | it is positive, it is printed at the start of the line. FIRST_COL | |
234 | is the first column to extract, and LINE_WIDTH is the number of | |
d1da6b01 TT |
235 | characters to display. NDIGITS is used to format the line number |
236 | (if it is positive). If NDIGITS is greater than 0, then that many | |
237 | digits are used; otherwise the line number is formatted with 6 | |
238 | digits and the text is aligned to the next tab stop. Returns a | |
239 | string holding the desired text. PTR is updated to point to the | |
240 | start of the next line. */ | |
1df2f9ef TT |
241 | |
242 | extern std::string tui_copy_source_line (const char **ptr, | |
243 | int line_no, int first_col, | |
d1da6b01 | 244 | int line_width, int ndigits); |
1df2f9ef | 245 | |
f80bda8e | 246 | /* Constant definitions. */ |
1cc6d956 | 247 | #define SCROLL_THRESHOLD 2 /* Threshold for lazy scroll. */ |
c906108c | 248 | |
1a5c2598 | 249 | #endif /* TUI_TUI_WINSOURCE_H */ |