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