gdb/tui/tui-winsource.h

   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   ~tui_exec_info_window () override
  57   {
  58     xfree (m_content);
  59   }
  60
  61   /* Get or allocate contents.  */
  62   tui_exec_info_content *maybe_allocate_content (int n_elements);
  63
  64   /* Return the contents.  */
  65   const tui_exec_info_content *get_content () const
  66   {
  67     return m_content;
  68   }
  69
  70 private:
  71
  72   tui_exec_info_content *m_content = nullptr;
  73 };
  74
  75 /* Elements in the Source/Disassembly Window.  */
  76 struct tui_source_element
  77 {
  78   tui_source_element ()
  79   {
  80     line_or_addr.loa = LOA_LINE;
  81     line_or_addr.u.line_no = 0;
  82   }
  83
  84   ~tui_source_element ()
  85   {
  86     xfree (line);
  87   }
  88
  89   char *line = nullptr;
  90   struct tui_line_or_address line_or_addr;
  91   bool is_exec_point = false;
  92   tui_bp_flags break_mode = 0;
  93 };
  94
  95
  96 /* The base class for all source-like windows, namely the source and
  97    disassembly windows.  */
  98
  99 struct tui_source_window_base : public tui_win_info
 100 {
 101 protected:
 102   explicit tui_source_window_base (enum tui_win_type type);
 103   ~tui_source_window_base () override;
 104   DISABLE_COPY_AND_ASSIGN (tui_source_window_base);
 105
 106   void do_scroll_horizontal (int num_to_scroll) override;
 107   void do_make_visible_with_new_height () override;
 108
 109 public:
 110
 111   void clear_detail ();
 112
 113   void make_visible (bool visible) override;
 114   void refresh_window () override;
 115   void refresh_all () override;
 116
 117   /* Refill the source window's source cache and update it.  If this
 118      is a disassembly window, then just update it.  */
 119   void refill ();
 120
 121   /* Set the location of the execution point.  */
 122   void set_is_exec_point_at (struct tui_line_or_address l);
 123
 124   void set_new_height (int height) override;
 125
 126   void update_tab_width () override;
 127
 128   virtual bool location_matches_p (struct bp_location *loc, int line_no) = 0;
 129
 130   void reset (int height, int width,
 131               int origin_x, int origin_y) override;
 132
 133   void show_source_content ();
 134
 135   void set_exec_info_content ();
 136   void update_exec_info ();
 137
 138   /* Does the locator belong to this window?  */
 139   bool m_has_locator = false;
 140   /* Execution information window.  */
 141   struct tui_exec_info_window *execution_info;
 142   /* Used for horizontal scroll.  */
 143   int horizontal_offset = 0;
 144   struct tui_line_or_address start_line_or_addr;
 145
 146   /* It is the resolved form as returned by symtab_to_fullname.  */
 147   char *fullname = nullptr;
 148
 149   /* Architecture associated with code at this location.  */
 150   struct gdbarch *gdbarch = nullptr;
 151
 152   std::vector<tui_source_element> content;
 153
 154 private:
 155   void show_exec_info_content ();
 156 };
 157
 158 /* Update the execution windows to show the active breakpoints.  This
 159    is called whenever a breakpoint is inserted, removed or has its
 160    state changed.  Normally BEING_DELETED is nullptr; if not nullptr,
 161    it indicates a breakpoint that is in the process of being deleted,
 162    and which should therefore be ignored by the update.  This is done
 163    because the relevant observer is notified before the breakpoint is
 164    removed from the list of breakpoints.  */
 165 extern void tui_update_all_breakpoint_info (struct breakpoint *being_deleted);
 166
 167 /* Scan the source window and the breakpoints to update the break_mode
 168    information for each line.  Returns true if something changed and
 169    the execution window must be refreshed.  See
 170    tui_update_all_breakpoint_info for a description of
 171    BEING_DELETED.  */
 172 extern bool tui_update_breakpoint_info (struct tui_source_window_base *win,
 173                                         struct breakpoint *being_deleted,
 174                                         bool current_only);
 175
 176 /* Function to display the "main" routine.  */
 177 extern void tui_display_main (void);
 178 extern void tui_update_source_window (struct tui_source_window_base *,
 179                                       struct gdbarch *, struct symtab *,
 180                                       struct tui_line_or_address,
 181                                       int);
 182 extern void tui_update_source_window_as_is (struct tui_source_window_base *,
 183                                             struct gdbarch *, struct symtab *,
 184                                             struct tui_line_or_address,
 185                                             int);
 186 extern void tui_update_source_windows_with_addr (struct gdbarch *, CORE_ADDR);
 187 extern void tui_update_source_windows_with_line (struct symtab *,
 188                                                  int);
 189 extern void tui_clear_source_content (struct tui_source_window_base *);
 190 extern void tui_erase_source_content (struct tui_source_window_base *);
 191 extern void tui_erase_exec_info_content (struct tui_source_window_base *);
 192 extern void tui_clear_exec_info_content (struct tui_source_window_base *);
 193
 194 extern void tui_alloc_source_buffer (struct tui_source_window_base *);
 195 extern int tui_line_is_displayed (int,
 196                                   struct tui_source_window_base *,
 197                                   int);
 198 extern int tui_addr_is_displayed (CORE_ADDR,
 199                                   struct tui_source_window_base *,
 200                                   int);
 201
 202
 203 /* Constant definitions. */
 204 #define SCROLL_THRESHOLD 2      /* Threshold for lazy scroll.  */
 205
 206 #endif /* TUI_TUI_WINSOURCE_H */