1 /* TUI display source/assembly window. 2 3 Copyright (C) 1998-2020 Free Software Foundation, Inc. 4 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 11 the Free Software Foundation; either version 3 of the License, or 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 20 along with this program. If not, see <http://www.gnu.org/licenses/>. */ 21 22 #ifndef TUI_TUI_WINSOURCE_H 23 #define TUI_TUI_WINSOURCE_H 24 25 #include "tui/tui-data.h" 26 #include "symtab.h" 27 28 enum tui_line_or_address_kind 29 { 30 LOA_LINE, 31 LOA_ADDRESS 32 }; 33 34 /* Structure describing source line or line address. */ 35 struct tui_line_or_address 36 { 37 enum tui_line_or_address_kind loa; 38 union 39 { 40 int line_no; 41 CORE_ADDR addr; 42 } u; 43 }; 44 45 /* Flags to tell what kind of breakpoint is at current line. */ 46 enum tui_bp_flag 47 { 48 TUI_BP_ENABLED = 0x01, 49 TUI_BP_DISABLED = 0x02, 50 TUI_BP_HIT = 0x04, 51 TUI_BP_CONDITIONAL = 0x08, 52 TUI_BP_HARDWARE = 0x10 53 }; 54 55 DEF_ENUM_FLAGS_TYPE (enum tui_bp_flag, tui_bp_flags); 56 57 /* Position of breakpoint markers in the exec info string. */ 58 #define TUI_BP_HIT_POS 0 59 #define TUI_BP_BREAK_POS 1 60 #define TUI_EXEC_POS 2 61 #define TUI_EXECINFO_SIZE 4 62 63 /* Elements in the Source/Disassembly Window. */ 64 struct tui_source_element 65 { 66 tui_source_element () 67 { 68 line_or_addr.loa = LOA_LINE; 69 line_or_addr.u.line_no = 0; 70 } 71 72 DISABLE_COPY_AND_ASSIGN (tui_source_element); 73 74 tui_source_element (tui_source_element &&other) 75 : line (std::move (other.line)), 76 line_or_addr (other.line_or_addr), 77 is_exec_point (other.is_exec_point), 78 break_mode (other.break_mode) 79 { 80 } 81 82 std::string line; 83 struct tui_line_or_address line_or_addr; 84 bool is_exec_point = false; 85 tui_bp_flags break_mode = 0; 86 }; 87 88 89 /* The base class for all source-like windows, namely the source and 90 disassembly windows. */ 91 92 struct tui_source_window_base : public tui_win_info 93 { 94 protected: 95 tui_source_window_base (); 96 ~tui_source_window_base (); 97 98 DISABLE_COPY_AND_ASSIGN (tui_source_window_base); 99 100 void do_scroll_horizontal (int num_to_scroll) override; 101 102 /* Erase the content and display STRING. */ 103 void do_erase_source_content (const char *string); 104 105 void rerender () override; 106 107 virtual bool set_contents (struct gdbarch *gdbarch, 108 const struct symtab_and_line &sal) = 0; 109 110 /* Redraw the complete line of a source or disassembly window. */ 111 void show_source_line (int lineno); 112 113 /* Used for horizontal scroll. */ 114 int m_horizontal_offset = 0; 115 struct tui_line_or_address m_start_line_or_addr; 116 117 /* Architecture associated with code at this location. */ 118 struct gdbarch *m_gdbarch = nullptr; 119 120 std::vector<tui_source_element> m_content; 121 122 public: 123 124 /* Refill the source window's source cache and update it. If this 125 is a disassembly window, then just update it. */ 126 void refill (); 127 128 /* Set the location of the execution point. */ 129 void set_is_exec_point_at (struct tui_line_or_address l); 130 131 void update_tab_width () override; 132 133 virtual bool location_matches_p (struct bp_location *loc, int line_no) = 0; 134 135 void update_exec_info (); 136 137 /* Update the window to display the given location. Does nothing if 138 the location is already displayed. */ 139 virtual void maybe_update (struct frame_info *fi, symtab_and_line sal) = 0; 140 141 void update_source_window_as_is (struct gdbarch *gdbarch, 142 const struct symtab_and_line &sal); 143 void update_source_window (struct gdbarch *gdbarch, 144 const struct symtab_and_line &sal); 145 146 /* Scan the source window and the breakpoints to update the 147 break_mode information for each line. Returns true if something 148 changed and the execution window must be refreshed. See 149 tui_update_all_breakpoint_info for a description of 150 BEING_DELETED. */ 151 bool update_breakpoint_info (struct breakpoint *being_deleted, 152 bool current_only); 153 154 /* Erase the source content. */ 155 virtual void erase_source_content () = 0; 156 157 /* Return the start address and gdbarch. */ 158 virtual void display_start_addr (struct gdbarch **gdbarch_p, 159 CORE_ADDR *addr_p) = 0; 160 161 private: 162 163 void show_source_content (); 164 165 /* Called when the user "set style enabled" setting is changed. */ 166 void style_changed (); 167 168 /* A token used to register and unregister an observer. */ 169 gdb::observers::token m_observable; 170 }; 171 172 173 /* A wrapper for a TUI window iterator that only iterates over source 174 windows. */ 175 176 struct tui_source_window_iterator 177 { 178 public: 179 180 typedef std::vector<tui_win_info *>::iterator inner_iterator; 181 182 typedef tui_source_window_iterator self_type; 183 typedef struct tui_source_window_base *value_type; 184 typedef struct tui_source_window_base *&reference; 185 typedef struct tui_source_window_base **pointer; 186 typedef std::forward_iterator_tag iterator_category; 187 typedef int difference_type; 188 189 explicit tui_source_window_iterator (const inner_iterator &it, 190 const inner_iterator &end) 191 : m_iter (it), 192 m_end (end) 193 { 194 advance (); 195 } 196 197 explicit tui_source_window_iterator (const inner_iterator &it) 198 : m_iter (it) 199 { 200 } 201 202 bool operator!= (const self_type &other) const 203 { 204 return m_iter != other.m_iter; 205 } 206 207 value_type operator* () const 208 { 209 return dynamic_cast<tui_source_window_base *> (*m_iter); 210 } 211 212 self_type &operator++ () 213 { 214 ++m_iter; 215 advance (); 216 return *this; 217 } 218 219 private: 220 221 void advance () 222 { 223 while (m_iter != m_end 224 && dynamic_cast<tui_source_window_base *> (*m_iter) == nullptr) 225 ++m_iter; 226 } 227 228 inner_iterator m_iter; 229 inner_iterator m_end; 230 }; 231 232 /* A range adapter for source windows. */ 233 234 struct tui_source_windows 235 { 236 /* Work around Wmaybe-uninitalized warning with g++ 11.0.0, see also 237 PR gcc/96295. Note that "tui_source_windows () = default" doesn't work 238 around the warning. */ 239 tui_source_windows () {} 240 241 tui_source_window_iterator begin () const 242 { 243 return tui_source_window_iterator (tui_windows.begin (), 244 tui_windows.end ()); 245 } 246 247 tui_source_window_iterator end () const 248 { 249 return tui_source_window_iterator (tui_windows.end ()); 250 } 251 }; 252 253 /* Update the execution windows to show the active breakpoints. This 254 is called whenever a breakpoint is inserted, removed or has its 255 state changed. Normally BEING_DELETED is nullptr; if not nullptr, 256 it indicates a breakpoint that is in the process of being deleted, 257 and which should therefore be ignored by the update. This is done 258 because the relevant observer is notified before the breakpoint is 259 removed from the list of breakpoints. */ 260 extern void tui_update_all_breakpoint_info (struct breakpoint *being_deleted); 261 262 /* Function to display the "main" routine. */ 263 extern void tui_display_main (void); 264 extern void tui_update_source_windows_with_addr (struct gdbarch *, CORE_ADDR); 265 extern void tui_update_source_windows_with_line (struct symtab_and_line sal); 266 267 /* Extract some source text from PTR. LINE_NO is the line number. If 268 it is positive, it is printed at the start of the line. FIRST_COL 269 is the first column to extract, and LINE_WIDTH is the number of 270 characters to display. NDIGITS is used to format the line number 271 (if it is positive). If NDIGITS is greater than 0, then that many 272 digits are used; otherwise the line number is formatted with 6 273 digits and the text is aligned to the next tab stop. Returns a 274 string holding the desired text. PTR is updated to point to the 275 start of the next line. */ 276 277 extern std::string tui_copy_source_line (const char **ptr, 278 int line_no, int first_col, 279 int line_width, int ndigits); 280 281 /* Constant definitions. */ 282 #define SCROLL_THRESHOLD 2 /* Threshold for lazy scroll. */ 283 284 #endif /* TUI_TUI_WINSOURCE_H */ 285