| 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 | |
| 27 | /* Flags to tell what kind of breakpoint is at current line. */ |
| 28 | enum tui_bp_flag |
| 29 | { |
| 30 | TUI_BP_ENABLED = 0x01, |
| 31 | TUI_BP_DISABLED = 0x02, |
| 32 | TUI_BP_HIT = 0x04, |
| 33 | TUI_BP_CONDITIONAL = 0x08, |
| 34 | TUI_BP_HARDWARE = 0x10 |
| 35 | }; |
| 36 | |
| 37 | DEF_ENUM_FLAGS_TYPE (enum tui_bp_flag, tui_bp_flags); |
| 38 | |
| 39 | /* Position of breakpoint markers in the exec info string. */ |
| 40 | #define TUI_BP_HIT_POS 0 |
| 41 | #define TUI_BP_BREAK_POS 1 |
| 42 | #define TUI_EXEC_POS 2 |
| 43 | #define TUI_EXECINFO_SIZE 4 |
| 44 | |
| 45 | typedef char tui_exec_info_content[TUI_EXECINFO_SIZE]; |
| 46 | |
| 47 | /* Execution info window class. */ |
| 48 | |
| 49 | struct tui_exec_info_window : public tui_gen_win_info |
| 50 | { |
| 51 | tui_exec_info_window () |
| 52 | : tui_gen_win_info (EXEC_INFO_WIN) |
| 53 | { |
| 54 | } |
| 55 | }; |
| 56 | |
| 57 | /* Elements in the Source/Disassembly Window. */ |
| 58 | struct tui_source_element |
| 59 | { |
| 60 | tui_source_element () |
| 61 | { |
| 62 | line_or_addr.loa = LOA_LINE; |
| 63 | line_or_addr.u.line_no = 0; |
| 64 | } |
| 65 | |
| 66 | ~tui_source_element () |
| 67 | { |
| 68 | xfree (line); |
| 69 | } |
| 70 | |
| 71 | char *line = nullptr; |
| 72 | struct tui_line_or_address line_or_addr; |
| 73 | bool is_exec_point = false; |
| 74 | tui_bp_flags break_mode = 0; |
| 75 | }; |
| 76 | |
| 77 | |
| 78 | /* The base class for all source-like windows, namely the source and |
| 79 | disassembly windows. */ |
| 80 | |
| 81 | struct tui_source_window_base : public tui_win_info |
| 82 | { |
| 83 | protected: |
| 84 | explicit tui_source_window_base (enum tui_win_type type); |
| 85 | ~tui_source_window_base () override; |
| 86 | DISABLE_COPY_AND_ASSIGN (tui_source_window_base); |
| 87 | |
| 88 | void do_scroll_horizontal (int num_to_scroll) override; |
| 89 | void do_make_visible_with_new_height () override; |
| 90 | |
| 91 | public: |
| 92 | |
| 93 | void clear_detail (); |
| 94 | |
| 95 | void make_visible (bool visible) override; |
| 96 | void refresh_window () override; |
| 97 | void refresh_all () override; |
| 98 | |
| 99 | /* Refill the source window's source cache and update it. If this |
| 100 | is a disassembly window, then just update it. */ |
| 101 | void refill (); |
| 102 | |
| 103 | /* Set the location of the execution point. */ |
| 104 | void set_is_exec_point_at (struct tui_line_or_address l); |
| 105 | |
| 106 | void set_new_height (int height) override; |
| 107 | |
| 108 | void update_tab_width () override; |
| 109 | |
| 110 | virtual bool location_matches_p (struct bp_location *loc, int line_no) = 0; |
| 111 | |
| 112 | void reset (int height, int width, |
| 113 | int origin_x, int origin_y) override; |
| 114 | |
| 115 | void show_source_content (); |
| 116 | |
| 117 | void update_exec_info (); |
| 118 | |
| 119 | /* Does the locator belong to this window? */ |
| 120 | bool m_has_locator = false; |
| 121 | /* Execution information window. */ |
| 122 | struct tui_exec_info_window *execution_info; |
| 123 | /* Used for horizontal scroll. */ |
| 124 | int horizontal_offset = 0; |
| 125 | struct tui_line_or_address start_line_or_addr; |
| 126 | |
| 127 | /* It is the resolved form as returned by symtab_to_fullname. */ |
| 128 | char *fullname = nullptr; |
| 129 | |
| 130 | /* Architecture associated with code at this location. */ |
| 131 | struct gdbarch *gdbarch = nullptr; |
| 132 | |
| 133 | std::vector<tui_source_element> content; |
| 134 | }; |
| 135 | |
| 136 | /* Update the execution windows to show the active breakpoints. This |
| 137 | is called whenever a breakpoint is inserted, removed or has its |
| 138 | state changed. Normally BEING_DELETED is nullptr; if not nullptr, |
| 139 | it indicates a breakpoint that is in the process of being deleted, |
| 140 | and which should therefore be ignored by the update. This is done |
| 141 | because the relevant observer is notified before the breakpoint is |
| 142 | removed from the list of breakpoints. */ |
| 143 | extern void tui_update_all_breakpoint_info (struct breakpoint *being_deleted); |
| 144 | |
| 145 | /* Scan the source window and the breakpoints to update the break_mode |
| 146 | information for each line. Returns true if something changed and |
| 147 | the execution window must be refreshed. See |
| 148 | tui_update_all_breakpoint_info for a description of |
| 149 | BEING_DELETED. */ |
| 150 | extern bool tui_update_breakpoint_info (struct tui_source_window_base *win, |
| 151 | struct breakpoint *being_deleted, |
| 152 | bool current_only); |
| 153 | |
| 154 | /* Function to display the "main" routine. */ |
| 155 | extern void tui_display_main (void); |
| 156 | extern void tui_update_source_window (struct tui_source_window_base *, |
| 157 | struct gdbarch *, struct symtab *, |
| 158 | struct tui_line_or_address, |
| 159 | int); |
| 160 | extern void tui_update_source_window_as_is (struct tui_source_window_base *, |
| 161 | struct gdbarch *, struct symtab *, |
| 162 | struct tui_line_or_address, |
| 163 | int); |
| 164 | extern void tui_update_source_windows_with_addr (struct gdbarch *, CORE_ADDR); |
| 165 | extern void tui_update_source_windows_with_line (struct symtab *, |
| 166 | int); |
| 167 | extern void tui_clear_source_content (struct tui_source_window_base *); |
| 168 | extern void tui_erase_source_content (struct tui_source_window_base *); |
| 169 | |
| 170 | extern void tui_alloc_source_buffer (struct tui_source_window_base *); |
| 171 | extern int tui_line_is_displayed (int, |
| 172 | struct tui_source_window_base *, |
| 173 | int); |
| 174 | extern int tui_addr_is_displayed (CORE_ADDR, |
| 175 | struct tui_source_window_base *, |
| 176 | int); |
| 177 | |
| 178 | |
| 179 | /* Constant definitions. */ |
| 180 | #define SCROLL_THRESHOLD 2 /* Threshold for lazy scroll. */ |
| 181 | |
| 182 | #endif /* TUI_TUI_WINSOURCE_H */ |