gdb/tui/tui-source.c

   1 /* TUI display source window.
   2
   3    Copyright (C) 1998-2023 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 #include "defs.h"
  23 #include <math.h>
  24 #include <ctype.h>
  25 #include "symtab.h"
  26 #include "frame.h"
  27 #include "breakpoint.h"
  28 #include "source.h"
  29 #include "objfiles.h"
  30 #include "filenames.h"
  31 #include "source-cache.h"
  32
  33 #include "tui/tui.h"
  34 #include "tui/tui-data.h"
  35 #include "tui/tui-io.h"
  36 #include "tui/tui-stack.h"
  37 #include "tui/tui-win.h"
  38 #include "tui/tui-winsource.h"
  39 #include "tui/tui-source.h"
  40 #include "tui/tui-location.h"
  41 #include "gdb_curses.h"
  42
  43 /* Function to display source in the source window.  */
  44 bool
  45 tui_source_window::set_contents (struct gdbarch *arch,
  46                                  const struct symtab_and_line &sal)
  47 {
  48   struct symtab *s = sal.symtab;
  49   int line_no = sal.line;
  50
  51   if (s == NULL)
  52     return false;
  53
  54   /* Take hilite (window border) into account, when
  55      calculating the number of lines.  */
  56   int nlines = height - box_size ();
  57
  58   std::string srclines;
  59   const std::vector<off_t> *offsets;
  60   if (!g_source_cache.get_source_lines (s, line_no, line_no + nlines,
  61                                         &srclines)
  62       || !g_source_cache.get_line_charpos (s, &offsets))
  63     return false;
  64
  65   int cur_line_no, cur_line;
  66   const char *s_filename = symtab_to_filename_for_display (s);
  67
  68   set_title (s_filename);
  69
  70   m_fullname = make_unique_xstrdup (symtab_to_fullname (s));
  71
  72   cur_line = 0;
  73   m_gdbarch = s->compunit ()->objfile ()->arch ();
  74   m_start_line_or_addr.loa = LOA_LINE;
  75   cur_line_no = m_start_line_or_addr.u.line_no = line_no;
  76
  77   m_digits = 7;
  78   if (compact_source)
  79     {
  80       /* Solaris 11+gcc 5.5 has ambiguous overloads of log10, so we
  81          cast to double to get the right one.  */
  82       int lines_in_file = offsets->size ();
  83       int max_line_nr = lines_in_file;
  84       int digits_needed = 1 + (int)log10 ((double) max_line_nr);
  85       int trailing_space = 1;
  86       m_digits = digits_needed + trailing_space;
  87     }
  88
  89   m_max_length = -1;
  90   const char *iter = srclines.c_str ();
  91   m_content.resize (nlines);
  92   while (cur_line < nlines)
  93     {
  94       struct tui_source_element *element = &m_content[cur_line];
  95
  96       std::string text;
  97       if (*iter != '\0')
  98         {
  99           int line_len;
 100           text = tui_copy_source_line (&iter, &line_len);
 101           m_max_length = std::max (m_max_length, line_len);
 102         }
 103       else
 104         {
 105           /* Line not in source file.  */
 106           cur_line_no = -1;
 107         }
 108
 109       /* Set whether element is the execution point
 110          and whether there is a break point on it.  */
 111       element->line_or_addr.loa = LOA_LINE;
 112       element->line_or_addr.u.line_no = cur_line_no;
 113       element->is_exec_point
 114         = (filename_cmp (tui_location.full_name ().c_str (),
 115                          symtab_to_fullname (s)) == 0
 116            && cur_line_no == tui_location.line_no ());
 117
 118       m_content[cur_line].line = std::move (text);
 119
 120       cur_line++;
 121       cur_line_no++;
 122     }
 123
 124   return true;
 125 }
 126
 127
 128 /* Answer whether the source is currently displayed in the source
 129    window.  */
 130 bool
 131 tui_source_window::showing_source_p (const char *fullname) const
 132 {
 133   return (!m_content.empty ()
 134           && (filename_cmp (tui_location.full_name ().c_str (),
 135                             fullname) == 0));
 136 }
 137
 138
 139 /* Scroll the source forward or backward vertically.  */
 140 void
 141 tui_source_window::do_scroll_vertical (int num_to_scroll)
 142 {
 143   if (!m_content.empty ())
 144     {
 145       struct symtab *s;
 146       struct symtab_and_line cursal = get_current_source_symtab_and_line ();
 147       struct gdbarch *arch = m_gdbarch;
 148
 149       if (cursal.symtab == NULL)
 150         {
 151           frame_info_ptr fi = get_selected_frame (NULL);
 152           s = find_pc_line_symtab (get_frame_pc (fi));
 153           arch = get_frame_arch (fi);
 154         }
 155       else
 156         s = cursal.symtab;
 157
 158       int line_no = m_start_line_or_addr.u.line_no + num_to_scroll;
 159       const std::vector<off_t> *offsets;
 160       if (g_source_cache.get_line_charpos (s, &offsets)
 161           && line_no > offsets->size ())
 162         line_no = m_start_line_or_addr.u.line_no;
 163       if (line_no <= 0)
 164         line_no = 1;
 165
 166       cursal.line = line_no;
 167       find_line_pc (cursal.symtab, cursal.line, &cursal.pc);
 168       for (struct tui_source_window_base *win_info : tui_source_windows ())
 169         win_info->update_source_window_as_is (arch, cursal);
 170     }
 171 }
 172
 173 bool
 174 tui_source_window::location_matches_p (struct bp_location *loc, int line_no)
 175 {
 176   return (m_content[line_no].line_or_addr.loa == LOA_LINE
 177           && m_content[line_no].line_or_addr.u.line_no == loc->line_number
 178           && loc->symtab != NULL
 179           && filename_cmp (m_fullname.get (),
 180                            symtab_to_fullname (loc->symtab)) == 0);
 181 }
 182
 183 /* See tui-source.h.  */
 184
 185 bool
 186 tui_source_window::line_is_displayed (int line) const
 187 {
 188   if (m_content.size () < SCROLL_THRESHOLD)
 189     return false;
 190
 191   for (size_t i = 0; i < m_content.size () - SCROLL_THRESHOLD; ++i)
 192     {
 193       if (m_content[i].line_or_addr.loa == LOA_LINE
 194           && m_content[i].line_or_addr.u.line_no == line)
 195         return true;
 196     }
 197
 198   return false;
 199 }
 200
 201 void
 202 tui_source_window::maybe_update (frame_info_ptr fi, symtab_and_line sal)
 203 {
 204   int start_line = (sal.line - ((height - box_size ()) / 2)) + 1;
 205   if (start_line <= 0)
 206     start_line = 1;
 207
 208   bool source_already_displayed = (sal.symtab != 0
 209                                    && showing_source_p (m_fullname.get ()));
 210
 211   if (!(source_already_displayed && line_is_displayed (sal.line)))
 212     {
 213       sal.line = start_line;
 214       update_source_window (get_frame_arch (fi), sal);
 215     }
 216   else
 217     {
 218       struct tui_line_or_address l;
 219
 220       l.loa = LOA_LINE;
 221       l.u.line_no = sal.line;
 222       set_is_exec_point_at (l);
 223     }
 224 }
 225
 226 void
 227 tui_source_window::display_start_addr (struct gdbarch **gdbarch_p,
 228                                        CORE_ADDR *addr_p)
 229 {
 230   struct symtab_and_line cursal = get_current_source_symtab_and_line ();
 231
 232   *gdbarch_p = m_gdbarch;
 233   find_line_pc (cursal.symtab, m_start_line_or_addr.u.line_no, addr_p);
 234 }
 235
 236 /* See tui-winsource.h.  */
 237
 238 void
 239 tui_source_window::show_line_number (int offset) const
 240 {
 241   int lineno = m_content[offset].line_or_addr.u.line_no;
 242   char text[20];
 243   char space = tui_left_margin_verbose ? '_' : ' ';
 244   if (lineno == -1)
 245     {
 246       /* Line not in source file, don't show line number.  */
 247       for (int i = 0; i <= m_digits; ++i)
 248         text[i] = (i == m_digits) ? '\0' : space;
 249     }
 250   else
 251     {
 252       xsnprintf (text, sizeof (text),
 253                  tui_left_margin_verbose ? "%0*d%c" : "%*d%c", m_digits - 1,
 254                  lineno, space);
 255     }
 256   waddstr (handle.get (), text);
 257 }