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 /* A helper function for tui_set_source_content that extracts some
  41    source text from PTR.  LINE_NO is the line number; FIRST_COL is the
  42    first column to extract, and LINE_WIDTH is the number of characters
  43    to display.  Returns a string holding the desired text.  */
  44
  45 static std::string
  46 copy_source_line (const char **ptr, int line_no, int first_col,
  47                   int line_width)
  48 {
  49   const char *lineptr = *ptr;
  50
  51   /* Init the line with the line number.  */
  52   std::string result = string_printf ("%-6d", line_no);
  53   int len = result.size ();
  54   len = len - ((len / tui_tab_width) * tui_tab_width);
  55   result.append (len, ' ');
  56
  57   int column = 0;
  58   char c;
  59   do
  60     {
  61       int skip_bytes;
  62
  63       c = *lineptr;
  64       if (c == '\033' && skip_ansi_escape (lineptr, &skip_bytes))
  65         {
  66           /* We always have to preserve escapes.  */
  67           result.append (lineptr, lineptr + skip_bytes);
  68           lineptr += skip_bytes;
  69           continue;
  70         }
  71
  72       ++lineptr;
  73       ++column;
  74
  75       auto process_tab = [&] ()
  76         {
  77           int max_tab_len = tui_tab_width;
  78
  79           --column;
  80           for (int j = column % max_tab_len;
  81                j < max_tab_len && column < first_col + line_width;
  82                column++, j++)
  83             if (column >= first_col)
  84               result.push_back (' ');
  85         };
  86
  87       /* We have to process all the text in order to pick up all the
  88          escapes.  */
  89       if (column <= first_col || column > first_col + line_width)
  90         {
  91           if (c == '\t')
  92             process_tab ();
  93           continue;
  94         }
  95
  96       if (c == '\n' || c == '\r' || c == '\0')
  97         {
  98           /* Nothing.  */
  99         }
 100       else if (c < 040 && c != '\t')
 101         {
 102           result.push_back ('^');
 103           result.push_back (c + 0100);
 104         }
 105       else if (c == 0177)
 106         {
 107           result.push_back ('^');
 108           result.push_back ('?');
 109         }
 110       else if (c == '\t')
 111         process_tab ();
 112       else
 113         result.push_back (c);
 114     }
 115   while (c != '\0' && c != '\n' && c != '\r');
 116
 117   if (c == '\r' && *lineptr == '\n')
 118     ++lineptr;
 119   *ptr = lineptr;
 120
 121   return result;
 122 }
 123
 124 /* Function to display source in the source window.  */
 125 enum tui_status
 126 tui_source_window::set_contents (struct gdbarch *arch,
 127                                  struct symtab *s,
 128                                  struct tui_line_or_address line_or_addr)
 129 {
 130   gdb_assert (line_or_addr.loa == LOA_LINE);
 131   int line_no = line_or_addr.u.line_no;
 132
 133   enum tui_status ret = TUI_FAILURE;
 134
 135   if (s != NULL)
 136     {
 137       int line_width, nlines;
 138
 139       ret = TUI_SUCCESS;
 140       line_width = width - TUI_EXECINFO_SIZE - 1;
 141       /* Take hilite (window border) into account, when
 142          calculating the number of lines.  */
 143       nlines = (line_no + (height - 2)) - line_no;
 144
 145       std::string srclines;
 146       if (!g_source_cache.get_source_lines (s, line_no, line_no + nlines,
 147                                             &srclines))
 148         ret = TUI_FAILURE;
 149       else
 150         {
 151           int cur_line_no, cur_line;
 152           struct tui_locator_window *locator
 153             = tui_locator_win_info_ptr ();
 154           const char *s_filename = symtab_to_filename_for_display (s);
 155
 156           title = s_filename;
 157
 158           m_fullname = make_unique_xstrdup (symtab_to_fullname (s));
 159
 160           cur_line = 0;
 161           gdbarch = get_objfile_arch (SYMTAB_OBJFILE (s));
 162           start_line_or_addr.loa = LOA_LINE;
 163           cur_line_no = start_line_or_addr.u.line_no = line_no;
 164
 165           const char *iter = srclines.c_str ();
 166           content.resize (nlines);
 167           while (cur_line < nlines)
 168             {
 169               struct tui_source_element *element
 170                 = &content[cur_line];
 171
 172               std::string text;
 173               if (*iter != '\0')
 174                 text = copy_source_line (&iter, cur_line_no, horizontal_offset,
 175                                          line_width);
 176
 177               /* Set whether element is the execution point
 178                  and whether there is a break point on it.  */
 179               element->line_or_addr.loa = LOA_LINE;
 180               element->line_or_addr.u.line_no = cur_line_no;
 181               element->is_exec_point
 182                 = (filename_cmp (locator->full_name.c_str (),
 183                                  symtab_to_fullname (s)) == 0
 184                    && cur_line_no == locator->line_no);
 185
 186               content[cur_line].line = std::move (text);
 187
 188               cur_line++;
 189               cur_line_no++;
 190             }
 191           ret = TUI_SUCCESS;
 192         }
 193     }
 194   return ret;
 195 }
 196
 197
 198 /* Function to display source in the source window.  This function
 199    initializes the horizontal scroll to 0.  */
 200 void
 201 tui_source_window::show_symtab_source (struct gdbarch *gdbarch,
 202                                        struct symtab *s,
 203                                        struct tui_line_or_address line)
 204 {
 205   horizontal_offset = 0;
 206   update_source_window_as_is (gdbarch, s, line);
 207 }
 208
 209
 210 /* Answer whether the source is currently displayed in the source
 211    window.  */
 212 bool
 213 tui_source_window::showing_source_p (const char *fullname) const
 214 {
 215   return (!content.empty ()
 216           && (filename_cmp (tui_locator_win_info_ptr ()->full_name.c_str (),
 217                             fullname) == 0));
 218 }
 219
 220
 221 /* Scroll the source forward or backward vertically.  */
 222 void
 223 tui_source_window::do_scroll_vertical (int num_to_scroll)
 224 {
 225   if (!content.empty ())
 226     {
 227       struct tui_line_or_address l;
 228       struct symtab *s;
 229       struct symtab_and_line cursal = get_current_source_symtab_and_line ();
 230
 231       if (cursal.symtab == NULL)
 232         s = find_pc_line_symtab (get_frame_pc (get_selected_frame (NULL)));
 233       else
 234         s = cursal.symtab;
 235
 236       l.loa = LOA_LINE;
 237       l.u.line_no = content[0].line_or_addr.u.line_no
 238         + num_to_scroll;
 239       const std::vector<off_t> *offsets;
 240       if (g_source_cache.get_line_charpos (s, &offsets)
 241           && l.u.line_no > offsets->size ())
 242         /* line = s->nlines - win_info->content_size + 1; */
 243         /* elz: fix for dts 23398.  */
 244         l.u.line_no = content[0].line_or_addr.u.line_no;
 245       if (l.u.line_no <= 0)
 246         l.u.line_no = 1;
 247
 248       print_source_lines (s, l.u.line_no, l.u.line_no + 1, 0);
 249     }
 250 }
 251
 252 tui_source_window::tui_source_window ()
 253   : tui_source_window_base (SRC_WIN)
 254 {
 255   gdb::observers::source_styling_changed.attach
 256     (std::bind (&tui_source_window::style_changed, this),
 257      m_observable);
 258 }
 259
 260 tui_source_window::~tui_source_window ()
 261 {
 262   gdb::observers::source_styling_changed.detach (m_observable);
 263 }
 264
 265 void
 266 tui_source_window::style_changed ()
 267 {
 268   if (tui_active && is_visible ())
 269     refill ();
 270 }
 271
 272 bool
 273 tui_source_window::location_matches_p (struct bp_location *loc, int line_no)
 274 {
 275   return (content[line_no].line_or_addr.loa == LOA_LINE
 276           && content[line_no].line_or_addr.u.line_no == loc->line_number
 277           && loc->symtab != NULL
 278           && filename_cmp (m_fullname.get (),
 279                            symtab_to_fullname (loc->symtab)) == 0);
 280 }
 281
 282 /* See tui-source.h.  */
 283
 284 bool
 285 tui_source_window::line_is_displayed (int line) const
 286 {
 287   bool is_displayed = false;
 288   int threshold = SCROLL_THRESHOLD;
 289   int i = 0;
 290   while (i < content.size () - threshold && !is_displayed)
 291     {
 292       is_displayed
 293         = (content[i].line_or_addr.loa == LOA_LINE
 294            && content[i].line_or_addr.u.line_no == line);
 295       i++;
 296     }
 297
 298   return is_displayed;
 299 }
 300
 301 void
 302 tui_source_window::maybe_update (struct frame_info *fi, symtab_and_line sal,
 303                                  int line_no, CORE_ADDR addr)
 304 {
 305   int start_line = (line_no - (viewport_height / 2)) + 1;
 306   if (start_line <= 0)
 307     start_line = 1;
 308
 309   bool source_already_displayed = (sal.symtab != 0
 310                                    && showing_source_p (m_fullname.get ()));
 311
 312   struct tui_line_or_address l;
 313
 314   l.loa = LOA_LINE;
 315   l.u.line_no = start_line;
 316   if (!(source_already_displayed
 317         && line_is_displayed (line_no)))
 318     update_source_window (get_frame_arch (fi), sal.symtab, l);
 319   else
 320     {
 321       l.u.line_no = line_no;
 322       set_is_exec_point_at (l);
 323     }
 324 }