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