gdb/tui/tui-source.c

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