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