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
  27 /* Execution info window class.  */
  28
  29 struct tui_exec_info_window : public tui_gen_win_info
  30 {
  31   tui_exec_info_window ()
  32     : tui_gen_win_info (EXEC_INFO_WIN)
  33   {
  34   }
  35
  36   ~tui_exec_info_window () override
  37   {
  38     xfree (m_content);
  39   }
  40
  41   /* Get or allocate contents.  */
  42   tui_exec_info_content *maybe_allocate_content (int n_elements);
  43
  44   /* Return the contents.  */
  45   const tui_exec_info_content *get_content () const
  46   {
  47     return m_content;
  48   }
  49
  50 private:
  51
  52   tui_exec_info_content *m_content = nullptr;
  53 };
  54
  55 /* The base class for all source-like windows, namely the source and
  56    disassembly windows.  */
  57
  58 struct tui_source_window_base : public tui_win_info
  59 {
  60 protected:
  61   explicit tui_source_window_base (enum tui_win_type type);
  62   ~tui_source_window_base () override;
  63   DISABLE_COPY_AND_ASSIGN (tui_source_window_base);
  64
  65   void do_scroll_horizontal (int num_to_scroll) override;
  66   void do_make_visible_with_new_height () override;
  67
  68 public:
  69
  70   void clear_detail ();
  71
  72   void make_visible (bool visible) override;
  73   void refresh_window () override;
  74   void refresh_all () override;
  75
  76   /* Refill the source window's source cache and update it.  If this
  77      is a disassembly window, then just update it.  */
  78   void refill ();
  79
  80   /* Set the location of the execution point.  */
  81   void set_is_exec_point_at (struct tui_line_or_address l);
  82
  83   void set_new_height (int height) override;
  84
  85   void update_tab_width () override;
  86
  87   virtual bool location_matches_p (struct bp_location *loc, int line_no) = 0;
  88
  89   void reset (int height, int width,
  90               int origin_x, int origin_y) override;
  91
  92   void show_source_content ();
  93
  94   /* Does the locator belong to this window?  */
  95   bool m_has_locator = false;
  96   /* Execution information window.  */
  97   struct tui_exec_info_window *execution_info;
  98   /* Used for horizontal scroll.  */
  99   int horizontal_offset = 0;
 100   struct tui_line_or_address start_line_or_addr;
 101
 102   /* It is the resolved form as returned by symtab_to_fullname.  */
 103   char *fullname = nullptr;
 104
 105   /* Architecture associated with code at this location.  */
 106   struct gdbarch *gdbarch = nullptr;
 107
 108   std::vector<tui_source_element> content;
 109 };
 110
 111 /* Update the execution windows to show the active breakpoints.  This
 112    is called whenever a breakpoint is inserted, removed or has its
 113    state changed.  Normally BEING_DELETED is nullptr; if not nullptr,
 114    it indicates a breakpoint that is in the process of being deleted,
 115    and which should therefore be ignored by the update.  This is done
 116    because the relevant observer is notified before the breakpoint is
 117    removed from the list of breakpoints.  */
 118 extern void tui_update_all_breakpoint_info (struct breakpoint *being_deleted);
 119
 120 /* Scan the source window and the breakpoints to update the break_mode
 121    information for each line.  Returns true if something changed and
 122    the execution window must be refreshed.  See
 123    tui_update_all_breakpoint_info for a description of
 124    BEING_DELETED.  */
 125 extern bool tui_update_breakpoint_info (struct tui_source_window_base *win,
 126                                         struct breakpoint *being_deleted,
 127                                         bool current_only);
 128
 129 /* Function to display the "main" routine.  */
 130 extern void tui_display_main (void);
 131 extern void tui_update_source_window (struct tui_source_window_base *,
 132                                       struct gdbarch *, struct symtab *,
 133                                       struct tui_line_or_address,
 134                                       int);
 135 extern void tui_update_source_window_as_is (struct tui_source_window_base *,
 136                                             struct gdbarch *, struct symtab *,
 137                                             struct tui_line_or_address,
 138                                             int);
 139 extern void tui_update_source_windows_with_addr (struct gdbarch *, CORE_ADDR);
 140 extern void tui_update_source_windows_with_line (struct symtab *,
 141                                                  int);
 142 extern void tui_clear_source_content (struct tui_source_window_base *);
 143 extern void tui_erase_source_content (struct tui_source_window_base *);
 144 extern void tui_set_exec_info_content (struct tui_source_window_base *);
 145 extern void tui_show_exec_info_content (struct tui_source_window_base *);
 146 extern void tui_erase_exec_info_content (struct tui_source_window_base *);
 147 extern void tui_clear_exec_info_content (struct tui_source_window_base *);
 148 extern void tui_update_exec_info (struct tui_source_window_base *);
 149
 150 extern void tui_alloc_source_buffer (struct tui_source_window_base *);
 151 extern int tui_line_is_displayed (int,
 152                                   struct tui_source_window_base *,
 153                                   int);
 154 extern int tui_addr_is_displayed (CORE_ADDR,
 155                                   struct tui_source_window_base *,
 156                                   int);
 157
 158
 159 /* Constant definitions. */
 160 #define SCROLL_THRESHOLD 2      /* Threshold for lazy scroll.  */
 161
 162 #endif /* TUI_TUI_WINSOURCE_H */