gdb/tui/tui-source.h

   1 /* TUI display source 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_SOURCE_H
  23 #define TUI_TUI_SOURCE_H
  24
  25 #include "tui/tui-data.h"
  26 #include "tui-winsource.h"
  27
  28 struct symtab;
  29
  30 /* A TUI source window.  */
  31
  32 struct tui_source_window : public tui_source_window_base
  33 {
  34   tui_source_window ();
  35   ~tui_source_window ();
  36
  37   DISABLE_COPY_AND_ASSIGN (tui_source_window);
  38
  39   const char *name () const override
  40   {
  41     return SRC_NAME;
  42   }
  43
  44   /* Return true if the location LOC corresponds to the line number
  45      LINE_NO in this source window; false otherwise.  */
  46   bool location_matches_p (struct bp_location *loc, int line_no) override;
  47
  48   bool showing_source_p (const char *filename) const;
  49
  50   void maybe_update (struct frame_info *fi, symtab_and_line sal,
  51                      int line_no, CORE_ADDR addr)
  52     override;
  53
  54   void erase_source_content () override
  55   {
  56     do_erase_source_content (NO_SRC_STRING);
  57   }
  58
  59 protected:
  60
  61   void do_scroll_vertical (int num_to_scroll) override;
  62
  63   enum tui_status set_contents
  64     (struct gdbarch *gdbarch,
  65      struct symtab *s,
  66      struct tui_line_or_address line_or_addr) override;
  67
  68 private:
  69
  70   void style_changed ();
  71
  72   /* Answer whether a particular line number or address is displayed
  73      in the current source window.  */
  74   bool line_is_displayed (int line) const;
  75
  76   /* A token used to register and unregister an observer.  */
  77   gdb::observers::token m_observable;
  78 };
  79
  80 extern void tui_show_symtab_source (tui_source_window_base *,
  81                                     struct gdbarch *, struct symtab *,
  82                                     struct tui_line_or_address);
  83
  84 #endif /* TUI_TUI_SOURCE_H */