| 1 | /* TUI display source/assembly window. |
| 2 | |
| 3 | Copyright (C) 1998-2019 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 | /* 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 | |
| 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 | |
| 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 | |
| 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 | |
| 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; |
| 91 | |
| 92 | /* Erase the content and display STRING. */ |
| 93 | void do_erase_source_content (const char *string); |
| 94 | |
| 95 | void rerender () override; |
| 96 | |
| 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 | |
| 102 | public: |
| 103 | |
| 104 | void clear_detail (); |
| 105 | |
| 106 | /* Refill the source window's source cache and update it. If this |
| 107 | is a disassembly window, then just update it. */ |
| 108 | void refill (); |
| 109 | |
| 110 | /* Set the location of the execution point. */ |
| 111 | void set_is_exec_point_at (struct tui_line_or_address l); |
| 112 | |
| 113 | void update_tab_width () override; |
| 114 | |
| 115 | virtual bool location_matches_p (struct bp_location *loc, int line_no) = 0; |
| 116 | |
| 117 | void show_source_content (); |
| 118 | |
| 119 | void update_exec_info (); |
| 120 | |
| 121 | /* Update the window to display the given location. Does nothing if |
| 122 | the location is already displayed. */ |
| 123 | virtual void maybe_update (struct frame_info *fi, symtab_and_line sal, |
| 124 | int line_no, CORE_ADDR addr) = 0; |
| 125 | |
| 126 | void update_source_window_as_is (struct gdbarch *gdbarch, |
| 127 | struct symtab *s, |
| 128 | struct tui_line_or_address line_or_addr); |
| 129 | void update_source_window (struct gdbarch *gdbarch, |
| 130 | struct symtab *s, |
| 131 | struct tui_line_or_address line_or_addr); |
| 132 | |
| 133 | /* Scan the source window and the breakpoints to update the |
| 134 | break_mode information for each line. Returns true if something |
| 135 | changed and the execution window must be refreshed. See |
| 136 | tui_update_all_breakpoint_info for a description of |
| 137 | BEING_DELETED. */ |
| 138 | bool update_breakpoint_info (struct breakpoint *being_deleted, |
| 139 | bool current_only); |
| 140 | |
| 141 | /* Erase the source content. */ |
| 142 | virtual void erase_source_content () = 0; |
| 143 | |
| 144 | /* Used for horizontal scroll. */ |
| 145 | int horizontal_offset = 0; |
| 146 | struct tui_line_or_address start_line_or_addr; |
| 147 | |
| 148 | /* It is the resolved form as returned by symtab_to_fullname. */ |
| 149 | char *fullname = nullptr; |
| 150 | |
| 151 | /* Architecture associated with code at this location. */ |
| 152 | struct gdbarch *gdbarch = nullptr; |
| 153 | |
| 154 | std::vector<tui_source_element> content; |
| 155 | }; |
| 156 | |
| 157 | |
| 158 | /* A wrapper for a TUI window iterator that only iterates over source |
| 159 | windows. */ |
| 160 | |
| 161 | struct tui_source_window_iterator |
| 162 | { |
| 163 | public: |
| 164 | |
| 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; |
| 171 | |
| 172 | explicit tui_source_window_iterator (bool dummy) |
| 173 | : m_iter (SRC_WIN) |
| 174 | { |
| 175 | advance (); |
| 176 | } |
| 177 | |
| 178 | tui_source_window_iterator () |
| 179 | : m_iter (tui_win_type (DISASSEM_WIN + 1)) |
| 180 | { |
| 181 | } |
| 182 | |
| 183 | bool operator!= (const self_type &other) const |
| 184 | { |
| 185 | return m_iter != other.m_iter; |
| 186 | } |
| 187 | |
| 188 | value_type operator* () const |
| 189 | { |
| 190 | return (value_type) *m_iter; |
| 191 | } |
| 192 | |
| 193 | self_type &operator++ () |
| 194 | { |
| 195 | ++m_iter; |
| 196 | advance (); |
| 197 | return *this; |
| 198 | } |
| 199 | |
| 200 | private: |
| 201 | |
| 202 | void advance () |
| 203 | { |
| 204 | tui_window_iterator end; |
| 205 | while (m_iter != end && *m_iter == nullptr) |
| 206 | ++m_iter; |
| 207 | } |
| 208 | |
| 209 | tui_window_iterator m_iter; |
| 210 | }; |
| 211 | |
| 212 | /* A range adapter for source windows. */ |
| 213 | |
| 214 | struct tui_source_windows |
| 215 | { |
| 216 | tui_source_window_iterator begin () const |
| 217 | { |
| 218 | return tui_source_window_iterator (true); |
| 219 | } |
| 220 | |
| 221 | tui_source_window_iterator end () const |
| 222 | { |
| 223 | return tui_source_window_iterator (); |
| 224 | } |
| 225 | }; |
| 226 | |
| 227 | /* Update the execution windows to show the active breakpoints. This |
| 228 | is called whenever a breakpoint is inserted, removed or has its |
| 229 | state changed. Normally BEING_DELETED is nullptr; if not nullptr, |
| 230 | it indicates a breakpoint that is in the process of being deleted, |
| 231 | and which should therefore be ignored by the update. This is done |
| 232 | because the relevant observer is notified before the breakpoint is |
| 233 | removed from the list of breakpoints. */ |
| 234 | extern void tui_update_all_breakpoint_info (struct breakpoint *being_deleted); |
| 235 | |
| 236 | /* Function to display the "main" routine. */ |
| 237 | extern void tui_display_main (void); |
| 238 | extern void tui_update_source_windows_with_addr (struct gdbarch *, CORE_ADDR); |
| 239 | extern void tui_update_source_windows_with_line (struct symtab *, |
| 240 | int); |
| 241 | |
| 242 | /* Constant definitions. */ |
| 243 | #define SCROLL_THRESHOLD 2 /* Threshold for lazy scroll. */ |
| 244 | |
| 245 | #endif /* TUI_TUI_WINSOURCE_H */ |