Commit | Line | Data |
---|---|---|
f377b406 | 1 | /* TUI display source/assembly window. |
f80bda8e | 2 | |
42a4f53d | 3 | Copyright (C) 1998-2019 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 | ||
46 | typedef char tui_exec_info_content[TUI_EXECINFO_SIZE]; | |
47 | ||
7b56485d TT |
48 | /* Elements in the Source/Disassembly Window. */ |
49 | struct tui_source_element | |
50 | { | |
51 | tui_source_element () | |
52 | { | |
53 | line_or_addr.loa = LOA_LINE; | |
54 | line_or_addr.u.line_no = 0; | |
55 | } | |
56 | ||
57 | ~tui_source_element () | |
58 | { | |
59 | xfree (line); | |
60 | } | |
61 | ||
002f15c2 TT |
62 | DISABLE_COPY_AND_ASSIGN (tui_source_element); |
63 | ||
64 | tui_source_element (tui_source_element &&other) | |
65 | : line (other.line), | |
66 | line_or_addr (other.line_or_addr), | |
67 | is_exec_point (other.is_exec_point), | |
68 | break_mode (other.break_mode) | |
69 | { | |
70 | other.line = nullptr; | |
71 | } | |
72 | ||
7b56485d TT |
73 | char *line = nullptr; |
74 | struct tui_line_or_address line_or_addr; | |
75 | bool is_exec_point = false; | |
76 | tui_bp_flags break_mode = 0; | |
77 | }; | |
78 | ||
79 | ||
5104fe36 TT |
80 | /* The base class for all source-like windows, namely the source and |
81 | disassembly windows. */ | |
82 | ||
83 | struct tui_source_window_base : public tui_win_info | |
84 | { | |
85 | protected: | |
86 | explicit tui_source_window_base (enum tui_win_type type); | |
87 | ~tui_source_window_base () override; | |
88 | DISABLE_COPY_AND_ASSIGN (tui_source_window_base); | |
89 | ||
90 | void do_scroll_horizontal (int num_to_scroll) override; | |
5104fe36 | 91 | |
e25d2004 TT |
92 | /* Erase the content and display STRING. */ |
93 | void do_erase_source_content (const char *string); | |
94 | ||
3df505f6 TT |
95 | void rerender () override; |
96 | ||
81c82c4b TT |
97 | virtual enum tui_status set_contents |
98 | (struct gdbarch *gdbarch, | |
99 | struct symtab *s, | |
100 | struct tui_line_or_address line_or_addr) = 0; | |
101 | ||
5104fe36 TT |
102 | public: |
103 | ||
a3504e96 | 104 | void clear_detail (); |
5104fe36 | 105 | |
5104fe36 TT |
106 | void refresh_all () override; |
107 | ||
108 | /* Refill the source window's source cache and update it. If this | |
109 | is a disassembly window, then just update it. */ | |
110 | void refill (); | |
111 | ||
112 | /* Set the location of the execution point. */ | |
113 | void set_is_exec_point_at (struct tui_line_or_address l); | |
114 | ||
5104fe36 TT |
115 | void update_tab_width () override; |
116 | ||
117 | virtual bool location_matches_p (struct bp_location *loc, int line_no) = 0; | |
118 | ||
0bd27e07 TT |
119 | void show_source_content (); |
120 | ||
7ba913dc | 121 | void update_exec_info (); |
37a4a131 | 122 | |
a54700c6 TT |
123 | /* Update the window to display the given location. Does nothing if |
124 | the location is already displayed. */ | |
125 | virtual void maybe_update (struct frame_info *fi, symtab_and_line sal, | |
126 | int line_no, CORE_ADDR addr) = 0; | |
127 | ||
ed8358e9 TT |
128 | void update_source_window_as_is (struct gdbarch *gdbarch, |
129 | struct symtab *s, | |
130 | struct tui_line_or_address line_or_addr); | |
017f9828 TT |
131 | void update_source_window (struct gdbarch *gdbarch, |
132 | struct symtab *s, | |
133 | struct tui_line_or_address line_or_addr); | |
ed8358e9 | 134 | |
2ddaf614 TT |
135 | /* Scan the source window and the breakpoints to update the |
136 | break_mode information for each line. Returns true if something | |
137 | changed and the execution window must be refreshed. See | |
138 | tui_update_all_breakpoint_info for a description of | |
139 | BEING_DELETED. */ | |
140 | bool update_breakpoint_info (struct breakpoint *being_deleted, | |
141 | bool current_only); | |
142 | ||
e25d2004 TT |
143 | /* Erase the source content. */ |
144 | virtual void erase_source_content () = 0; | |
145 | ||
5104fe36 TT |
146 | /* Used for horizontal scroll. */ |
147 | int horizontal_offset = 0; | |
148 | struct tui_line_or_address start_line_or_addr; | |
149 | ||
150 | /* It is the resolved form as returned by symtab_to_fullname. */ | |
151 | char *fullname = nullptr; | |
152 | ||
153 | /* Architecture associated with code at this location. */ | |
154 | struct gdbarch *gdbarch = nullptr; | |
155 | ||
156 | std::vector<tui_source_element> content; | |
157 | }; | |
c906108c | 158 | |
3891b65e TT |
159 | |
160 | /* A wrapper for a TUI window iterator that only iterates over source | |
161 | windows. */ | |
162 | ||
163 | struct tui_source_window_iterator | |
164 | { | |
165 | public: | |
166 | ||
167 | typedef tui_source_window_iterator self_type; | |
168 | typedef struct tui_source_window_base *value_type; | |
169 | typedef struct tui_source_window_base *&reference; | |
170 | typedef struct tui_source_window_base **pointer; | |
171 | typedef std::forward_iterator_tag iterator_category; | |
172 | typedef int difference_type; | |
173 | ||
174 | explicit tui_source_window_iterator (bool dummy) | |
175 | : m_iter (SRC_WIN) | |
176 | { | |
177 | advance (); | |
178 | } | |
179 | ||
180 | tui_source_window_iterator () | |
181 | : m_iter (tui_win_type (DISASSEM_WIN + 1)) | |
182 | { | |
183 | } | |
184 | ||
185 | bool operator!= (const self_type &other) const | |
186 | { | |
187 | return m_iter != other.m_iter; | |
188 | } | |
189 | ||
190 | value_type operator* () const | |
191 | { | |
192 | return (value_type) *m_iter; | |
193 | } | |
194 | ||
195 | self_type &operator++ () | |
196 | { | |
197 | ++m_iter; | |
198 | advance (); | |
199 | return *this; | |
200 | } | |
201 | ||
202 | private: | |
203 | ||
204 | void advance () | |
205 | { | |
206 | tui_window_iterator end; | |
207 | while (m_iter != end && *m_iter == nullptr) | |
208 | ++m_iter; | |
209 | } | |
210 | ||
211 | tui_window_iterator m_iter; | |
212 | }; | |
213 | ||
214 | /* A range adapter for source windows. */ | |
215 | ||
216 | struct tui_source_windows | |
217 | { | |
218 | tui_source_window_iterator begin () const | |
219 | { | |
220 | return tui_source_window_iterator (true); | |
221 | } | |
222 | ||
223 | tui_source_window_iterator end () const | |
224 | { | |
225 | return tui_source_window_iterator (); | |
226 | } | |
227 | }; | |
228 | ||
f80bda8e AC |
229 | /* Update the execution windows to show the active breakpoints. This |
230 | is called whenever a breakpoint is inserted, removed or has its | |
0807ab7b TT |
231 | state changed. Normally BEING_DELETED is nullptr; if not nullptr, |
232 | it indicates a breakpoint that is in the process of being deleted, | |
233 | and which should therefore be ignored by the update. This is done | |
234 | because the relevant observer is notified before the breakpoint is | |
235 | removed from the list of breakpoints. */ | |
236 | extern void tui_update_all_breakpoint_info (struct breakpoint *being_deleted); | |
00b2bad4 | 237 | |
1f393769 SC |
238 | /* Function to display the "main" routine. */ |
239 | extern void tui_display_main (void); | |
13274fc3 | 240 | extern void tui_update_source_windows_with_addr (struct gdbarch *, CORE_ADDR); |
08ef48c5 MS |
241 | extern void tui_update_source_windows_with_line (struct symtab *, |
242 | int); | |
f80bda8e | 243 | |
f80bda8e | 244 | /* Constant definitions. */ |
1cc6d956 | 245 | #define SCROLL_THRESHOLD 2 /* Threshold for lazy scroll. */ |
c906108c | 246 | |
1a5c2598 | 247 | #endif /* TUI_TUI_WINSOURCE_H */ |