gdb/tui/tui-source.h

   1 /* TUI display source window.
   2
   3    Copyright (C) 1998-2024 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 GDB_TUI_TUI_SOURCE_H
  23 #define GDB_TUI_TUI_SOURCE_H
  24
  25 #include "gdbsupport/gdb-checked-static-cast.h"
  26 #include "tui/tui-data.h"
  27 #include "tui-winsource.h"
  28
  29 /* A TUI source window.  */
  30
  31 struct tui_source_window : public tui_source_window_base
  32 {
  33   tui_source_window ();
  34   ~tui_source_window ();
  35
  36   DISABLE_COPY_AND_ASSIGN (tui_source_window);
  37
  38   const char *name () const override
  39   {
  40     return SRC_NAME;
  41   }
  42
  43   /* Return true if the location LOC corresponds to the line number
  44      LINE_NO in this source window; false otherwise.  */
  45   bool location_matches_p (struct bp_location *loc, int line_no) override;
  46
  47   bool showing_source_p (const char *filename) const;
  48
  49   void maybe_update (const frame_info_ptr &fi, symtab_and_line sal) override;
  50
  51   void erase_source_content () override
  52   {
  53     do_erase_source_content (_("[ No Source Available ]"));
  54   }
  55
  56   void display_start_addr (struct gdbarch **gdbarch_p,
  57                            CORE_ADDR *addr_p) override;
  58
  59 protected:
  60
  61   void do_scroll_vertical (int num_to_scroll) override;
  62
  63   bool set_contents (struct gdbarch *gdbarch,
  64                      const struct symtab_and_line &sal) override;
  65
  66   int extra_margin () const override
  67   {
  68     return m_digits;
  69   }
  70
  71   void show_line_number (int lineno) const override;
  72
  73 private:
  74
  75   /* Answer whether a particular line number or address is displayed
  76      in the current source window.  */
  77   bool line_is_displayed (int line) const;
  78
  79   /* How many digits to use when formatting the line number.  This
  80      includes the trailing space.  */
  81   int m_digits;
  82
  83   /* It is the resolved form as returned by symtab_to_fullname.  */
  84   gdb::unique_xmalloc_ptr<char> m_fullname;
  85
  86   /* A token used to register and unregister an observer.  */
  87   gdb::observers::token m_src_observable;
  88 };
  89
  90 /* Return the instance of the source window.  */
  91
  92 inline tui_source_window *
  93 tui_src_win ()
  94 {
  95   return gdb::checked_static_cast<tui_source_window *> (tui_win_list[SRC_WIN]);
  96 }
  97
  98 #endif /* GDB_TUI_TUI_SOURCE_H */