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