1 /* TUI display source/assembly window.
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_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 typedef char tui_exec_info_content[TUI_EXECINFO_SIZE];
48 /* Execution info window class. */
50 struct tui_exec_info_window : public tui_gen_win_info
52 tui_exec_info_window ()
53 : tui_gen_win_info (EXEC_INFO_WIN)
58 /* Elements in the Source/Disassembly Window. */
59 struct tui_source_element
63 line_or_addr.loa = LOA_LINE;
64 line_or_addr.u.line_no = 0;
67 ~tui_source_element ()
72 DISABLE_COPY_AND_ASSIGN (tui_source_element);
74 tui_source_element (tui_source_element &&other)
76 line_or_addr (other.line_or_addr),
77 is_exec_point (other.is_exec_point),
78 break_mode (other.break_mode)
84 struct tui_line_or_address line_or_addr;
85 bool is_exec_point = false;
86 tui_bp_flags break_mode = 0;
90 /* The base class for all source-like windows, namely the source and
91 disassembly windows. */
93 struct tui_source_window_base : public tui_win_info
96 explicit tui_source_window_base (enum tui_win_type type);
97 ~tui_source_window_base () override;
98 DISABLE_COPY_AND_ASSIGN (tui_source_window_base);
100 void do_scroll_horizontal (int num_to_scroll) override;
102 /* Erase the content and display STRING. */
103 void do_erase_source_content (const char *string);
105 void rerender () override;
109 void clear_detail ();
111 void make_visible (bool visible) override;
112 void refresh_window () override;
113 void refresh_all () override;
115 /* Refill the source window's source cache and update it. If this
116 is a disassembly window, then just update it. */
119 /* Set the location of the execution point. */
120 void set_is_exec_point_at (struct tui_line_or_address l);
122 void update_tab_width () override;
124 virtual bool location_matches_p (struct bp_location *loc, int line_no) = 0;
126 void resize (int height, int width,
127 int origin_x, int origin_y) override;
129 void show_source_content ();
131 void update_exec_info ();
133 /* Update the window to display the given location. Does nothing if
134 the location is already displayed. */
135 virtual void maybe_update (struct frame_info *fi, symtab_and_line sal,
136 int line_no, CORE_ADDR addr) = 0;
138 void update_source_window_as_is (struct gdbarch *gdbarch,
140 struct tui_line_or_address line_or_addr);
141 void update_source_window (struct gdbarch *gdbarch,
143 struct tui_line_or_address line_or_addr);
145 /* Erase the source content. */
146 virtual void erase_source_content () = 0;
148 /* Execution information window. */
149 struct tui_exec_info_window *execution_info;
150 /* Used for horizontal scroll. */
151 int horizontal_offset = 0;
152 struct tui_line_or_address start_line_or_addr;
154 /* It is the resolved form as returned by symtab_to_fullname. */
155 char *fullname = nullptr;
157 /* Architecture associated with code at this location. */
158 struct gdbarch *gdbarch = nullptr;
160 std::vector<tui_source_element> content;
164 /* A wrapper for a TUI window iterator that only iterates over source
167 struct tui_source_window_iterator
171 typedef tui_source_window_iterator self_type;
172 typedef struct tui_source_window_base *value_type;
173 typedef struct tui_source_window_base *&reference;
174 typedef struct tui_source_window_base **pointer;
175 typedef std::forward_iterator_tag iterator_category;
176 typedef int difference_type;
178 explicit tui_source_window_iterator (bool dummy)
184 tui_source_window_iterator ()
185 : m_iter (tui_win_type (DISASSEM_WIN + 1))
189 bool operator!= (const self_type &other) const
191 return m_iter != other.m_iter;
194 value_type operator* () const
196 return (value_type) *m_iter;
199 self_type &operator++ ()
210 tui_window_iterator end;
211 while (m_iter != end && *m_iter == nullptr)
215 tui_window_iterator m_iter;
218 /* A range adapter for source windows. */
220 struct tui_source_windows
222 tui_source_window_iterator begin () const
224 return tui_source_window_iterator (true);
227 tui_source_window_iterator end () const
229 return tui_source_window_iterator ();
233 /* Update the execution windows to show the active breakpoints. This
234 is called whenever a breakpoint is inserted, removed or has its
235 state changed. Normally BEING_DELETED is nullptr; if not nullptr,
236 it indicates a breakpoint that is in the process of being deleted,
237 and which should therefore be ignored by the update. This is done
238 because the relevant observer is notified before the breakpoint is
239 removed from the list of breakpoints. */
240 extern void tui_update_all_breakpoint_info (struct breakpoint *being_deleted);
242 /* Scan the source window and the breakpoints to update the break_mode
243 information for each line. Returns true if something changed and
244 the execution window must be refreshed. See
245 tui_update_all_breakpoint_info for a description of
247 extern bool tui_update_breakpoint_info (struct tui_source_window_base *win,
248 struct breakpoint *being_deleted,
251 /* Function to display the "main" routine. */
252 extern void tui_display_main (void);
253 extern void tui_update_source_windows_with_addr (struct gdbarch *, CORE_ADDR);
254 extern void tui_update_source_windows_with_line (struct symtab *,
257 /* Constant definitions. */
258 #define SCROLL_THRESHOLD 2 /* Threshold for lazy scroll. */
260 #endif /* TUI_TUI_WINSOURCE_H */