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 #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 /* Elements in the Source/Disassembly Window.  */
  47 struct tui_source_element
  48 {
  49   tui_source_element ()
  50   {
  51     line_or_addr.loa = LOA_LINE;
  52     line_or_addr.u.line_no = 0;
  53   }
  54
  55   DISABLE_COPY_AND_ASSIGN (tui_source_element);
  56
  57   tui_source_element (tui_source_element &&other)
  58     : line (std::move (other.line)),
  59       line_or_addr (other.line_or_addr),
  60       is_exec_point (other.is_exec_point),
  61       break_mode (other.break_mode)
  62   {
  63   }
  64
  65   std::string line;
  66   struct tui_line_or_address line_or_addr;
  67   bool is_exec_point = false;
  68   tui_bp_flags break_mode = 0;
  69 };
  70
  71
  72 /* The base class for all source-like windows, namely the source and
  73    disassembly windows.  */
  74
  75 struct tui_source_window_base : public tui_win_info
  76 {
  77 protected:
  78   explicit tui_source_window_base (enum tui_win_type type);
  79   ~tui_source_window_base ();
  80
  81   DISABLE_COPY_AND_ASSIGN (tui_source_window_base);
  82
  83   void do_scroll_horizontal (int num_to_scroll) override;
  84
  85   /* Erase the content and display STRING.  */
  86   void do_erase_source_content (const char *string);
  87
  88   void rerender () override;
  89
  90   virtual enum tui_status set_contents
  91     (struct gdbarch *gdbarch,
  92      struct symtab *s,
  93      struct tui_line_or_address line_or_addr) = 0;
  94
  95 public:
  96
  97   /* Refill the source window's source cache and update it.  If this
  98      is a disassembly window, then just update it.  */
  99   void refill ();
 100
 101   /* Set the location of the execution point.  */
 102   void set_is_exec_point_at (struct tui_line_or_address l);
 103
 104   void update_tab_width () override;
 105
 106   virtual bool location_matches_p (struct bp_location *loc, int line_no) = 0;
 107
 108   void update_exec_info ();
 109
 110   /* Update the window to display the given location.  Does nothing if
 111      the location is already displayed.  */
 112   virtual void maybe_update (struct frame_info *fi, symtab_and_line sal,
 113                              int line_no, CORE_ADDR addr) = 0;
 114
 115   void update_source_window_as_is  (struct gdbarch *gdbarch,
 116                                     struct symtab *s,
 117                                     struct tui_line_or_address line_or_addr);
 118   void update_source_window (struct gdbarch *gdbarch,
 119                              struct symtab *s,
 120                              struct tui_line_or_address line_or_addr);
 121
 122   /* Scan the source window and the breakpoints to update the
 123      break_mode information for each line.  Returns true if something
 124      changed and the execution window must be refreshed.  See
 125      tui_update_all_breakpoint_info for a description of
 126      BEING_DELETED.  */
 127   bool update_breakpoint_info (struct breakpoint *being_deleted,
 128                                bool current_only);
 129
 130   /* Erase the source content.  */
 131   virtual void erase_source_content () = 0;
 132
 133   /* Used for horizontal scroll.  */
 134   int horizontal_offset = 0;
 135   struct tui_line_or_address start_line_or_addr;
 136
 137   /* Architecture associated with code at this location.  */
 138   struct gdbarch *gdbarch = nullptr;
 139
 140   std::vector<tui_source_element> content;
 141
 142 private:
 143
 144   void show_source_content ();
 145
 146   /* Called when the user "set style enabled" setting is changed.  */
 147   void style_changed ();
 148
 149   /* A token used to register and unregister an observer.  */
 150   gdb::observers::token m_observable;
 151 };
 152
 153
 154 /* A wrapper for a TUI window iterator that only iterates over source
 155    windows.  */
 156
 157 struct tui_source_window_iterator
 158 {
 159 public:
 160
 161   typedef tui_source_window_iterator self_type;
 162   typedef struct tui_source_window_base *value_type;
 163   typedef struct tui_source_window_base *&reference;
 164   typedef struct tui_source_window_base **pointer;
 165   typedef std::forward_iterator_tag iterator_category;
 166   typedef int difference_type;
 167
 168   explicit tui_source_window_iterator (bool dummy)
 169     : m_iter (SRC_WIN)
 170   {
 171     advance ();
 172   }
 173
 174   tui_source_window_iterator ()
 175     : m_iter (tui_win_type (DISASSEM_WIN + 1))
 176   {
 177   }
 178
 179   bool operator!= (const self_type &other) const
 180   {
 181     return m_iter != other.m_iter;
 182   }
 183
 184   value_type operator* () const
 185   {
 186     return (value_type) *m_iter;
 187   }
 188
 189   self_type &operator++ ()
 190   {
 191     ++m_iter;
 192     advance ();
 193     return *this;
 194   }
 195
 196 private:
 197
 198   void advance ()
 199   {
 200     tui_window_iterator end;
 201     while (m_iter != end && *m_iter == nullptr)
 202       ++m_iter;
 203   }
 204
 205   tui_window_iterator m_iter;
 206 };
 207
 208 /* A range adapter for source windows.  */
 209
 210 struct tui_source_windows
 211 {
 212   tui_source_window_iterator begin () const
 213   {
 214     return tui_source_window_iterator (true);
 215   }
 216
 217   tui_source_window_iterator end () const
 218   {
 219     return tui_source_window_iterator ();
 220   }
 221 };
 222
 223 /* Update the execution windows to show the active breakpoints.  This
 224    is called whenever a breakpoint is inserted, removed or has its
 225    state changed.  Normally BEING_DELETED is nullptr; if not nullptr,
 226    it indicates a breakpoint that is in the process of being deleted,
 227    and which should therefore be ignored by the update.  This is done
 228    because the relevant observer is notified before the breakpoint is
 229    removed from the list of breakpoints.  */
 230 extern void tui_update_all_breakpoint_info (struct breakpoint *being_deleted);
 231
 232 /* Function to display the "main" routine.  */
 233 extern void tui_display_main (void);
 234 extern void tui_update_source_windows_with_addr (struct gdbarch *, CORE_ADDR);
 235 extern void tui_update_source_windows_with_line (struct symtab *,
 236                                                  int);
 237
 238 /* Extract some source text from PTR.  LINE_NO is the line number.  If
 239    it is positive, it is printed at the start of the line.  FIRST_COL
 240    is the first column to extract, and LINE_WIDTH is the number of
 241    characters to display.  Returns a string holding the desired text.
 242    PTR is updated to point to the start of the next line.  */
 243
 244 extern std::string tui_copy_source_line (const char **ptr,
 245                                          int line_no, int first_col,
 246                                          int line_width);
 247
 248 /* Constant definitions. */
 249 #define SCROLL_THRESHOLD 2      /* Threshold for lazy scroll.  */
 250
 251 #endif /* TUI_TUI_WINSOURCE_H */