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