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