gdb/tui/tui-source.c

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