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_set_source_content (tui_source_window_base *win_info,
 127                         struct symtab *s,
 128                         int line_no,
 129                         int noerror)
 130 {
 131   enum tui_status ret = TUI_FAILURE;
 132
 133   if (s != NULL)
 134     {
 135       int line_width, nlines;
 136
 137       ret = TUI_SUCCESS;
 138       tui_alloc_source_buffer (win_info);
 139       line_width = win_info->width - 1;
 140       /* Take hilite (window border) into account, when
 141          calculating the number of lines.  */
 142       nlines = (line_no + (win_info->height - 2)) - line_no;
 143
 144       std::string srclines;
 145       if (!g_source_cache.get_source_lines (s, line_no, line_no + nlines,
 146                                             &srclines))
 147         {
 148           if (!noerror)
 149             {
 150               const char *filename = symtab_to_filename_for_display (s);
 151               char *name = (char *) alloca (strlen (filename) + 100);
 152
 153               sprintf (name, "%s:%d", filename, line_no);
 154               print_sys_errmsg (name, errno);
 155             }
 156           ret = TUI_FAILURE;
 157         }
 158       else
 159         {
 160           int cur_line_no, cur_line;
 161           struct tui_locator_window *locator
 162             = tui_locator_win_info_ptr ();
 163           const char *s_filename = symtab_to_filename_for_display (s);
 164
 165           xfree (win_info->title);
 166           win_info->title = xstrdup (s_filename);
 167
 168           xfree (win_info->fullname);
 169           win_info->fullname = xstrdup (symtab_to_fullname (s));
 170
 171           cur_line = 0;
 172           win_info->gdbarch = get_objfile_arch (SYMTAB_OBJFILE (s));
 173           win_info->start_line_or_addr.loa = LOA_LINE;
 174           cur_line_no = win_info->start_line_or_addr.u.line_no = line_no;
 175
 176           const char *iter = srclines.c_str ();
 177           win_info->content.resize (nlines);
 178           while (cur_line < nlines)
 179             {
 180               struct tui_source_element *element
 181                 = &win_info->content[cur_line];
 182
 183               std::string text;
 184               if (*iter != '\0')
 185                 text = copy_source_line (&iter, cur_line_no,
 186                                          win_info->horizontal_offset,
 187                                          line_width);
 188
 189               /* Set whether element is the execution point
 190                  and whether there is a break point on it.  */
 191               element->line_or_addr.loa = LOA_LINE;
 192               element->line_or_addr.u.line_no = cur_line_no;
 193               element->is_exec_point
 194                 = (filename_cmp (locator->full_name,
 195                                  symtab_to_fullname (s)) == 0
 196                    && cur_line_no == locator->line_no);
 197
 198               xfree (win_info->content[cur_line].line);
 199               win_info->content[cur_line].line
 200                 = xstrdup (text.c_str ());
 201
 202               cur_line++;
 203               cur_line_no++;
 204             }
 205           ret = TUI_SUCCESS;
 206         }
 207     }
 208   return ret;
 209 }
 210
 211
 212 /* elz: This function sets the contents of the source window to empty
 213    except for a line in the middle with a warning message about the
 214    source not being available.  This function is called by
 215    tui_erase_source_contents(), which in turn is invoked when the
 216    source files cannot be accessed.  */
 217
 218 void
 219 tui_set_source_content_nil (struct tui_source_window_base *win_info,
 220                             const char *warning_string)
 221 {
 222   int line_width;
 223   int n_lines;
 224   int curr_line = 0;
 225
 226   line_width = win_info->width - 1;
 227   n_lines = win_info->height - 2;
 228
 229   /* Set to empty each line in the window, except for the one which
 230      contains the message.  */
 231   while (curr_line < win_info->content.size ())
 232     {
 233       /* Set the information related to each displayed line to null:
 234          i.e. the line number is 0, there is no bp, it is not where
 235          the program is stopped.  */
 236
 237       struct tui_source_element *element = &win_info->content[curr_line];
 238
 239       element->line_or_addr.loa = LOA_LINE;
 240       element->line_or_addr.u.line_no = 0;
 241       element->is_exec_point = false;
 242       element->break_mode = 0;
 243
 244       /* Set the contents of the line to blank.  */
 245       element->line[0] = (char) 0;
 246
 247       /* If the current line is in the middle of the screen, then we
 248          want to display the 'no source available' message in it.
 249          Note: the 'weird' arithmetic with the line width and height
 250          comes from the function tui_erase_source_content().  We need
 251          to keep the screen and the window's actual contents in
 252          synch.  */
 253
 254       if (curr_line == (n_lines / 2 + 1))
 255         {
 256           int xpos;
 257           int warning_length = strlen (warning_string);
 258           char *src_line;
 259
 260           if (warning_length >= ((line_width - 1) / 2))
 261             xpos = 1;
 262           else
 263             xpos = (line_width - 1) / 2 - warning_length;
 264
 265           src_line = xstrprintf ("%s%s", n_spaces (xpos), warning_string);
 266           xfree (element->line);
 267           element->line = src_line;
 268         }
 269
 270       curr_line++;
 271     }
 272 }
 273
 274
 275 /* Function to display source in the source window.  This function
 276    initializes the horizontal scroll to 0.  */
 277 void
 278 tui_show_symtab_source (tui_source_window_base *win_info,
 279                         struct gdbarch *gdbarch, struct symtab *s,
 280                         struct tui_line_or_address line,
 281                         int noerror)
 282 {
 283   win_info->horizontal_offset = 0;
 284   tui_update_source_window_as_is (win_info, gdbarch, s, line, noerror);
 285 }
 286
 287
 288 /* Answer whether the source is currently displayed in the source
 289    window.  */
 290 bool
 291 tui_source_window::showing_source_p (const char *fullname) const
 292 {
 293   return (content_in_use
 294           && (filename_cmp (tui_locator_win_info_ptr ()->full_name,
 295                             fullname) == 0));
 296 }
 297
 298
 299 /* Scroll the source forward or backward vertically.  */
 300 void
 301 tui_source_window::do_scroll_vertical (int num_to_scroll)
 302 {
 303   if (!content.empty ())
 304     {
 305       struct tui_line_or_address l;
 306       struct symtab *s;
 307       struct symtab_and_line cursal = get_current_source_symtab_and_line ();
 308
 309       if (cursal.symtab == NULL)
 310         s = find_pc_line_symtab (get_frame_pc (get_selected_frame (NULL)));
 311       else
 312         s = cursal.symtab;
 313
 314       l.loa = LOA_LINE;
 315       l.u.line_no = content[0].line_or_addr.u.line_no
 316         + num_to_scroll;
 317       if (l.u.line_no > s->nlines)
 318         /* line = s->nlines - win_info->content_size + 1; */
 319         /* elz: fix for dts 23398.  */
 320         l.u.line_no = content[0].line_or_addr.u.line_no;
 321       if (l.u.line_no <= 0)
 322         l.u.line_no = 1;
 323
 324       print_source_lines (s, l.u.line_no, l.u.line_no + 1, 0);
 325     }
 326 }
 327
 328 tui_source_window::tui_source_window ()
 329   : tui_source_window_base (SRC_WIN)
 330 {
 331   gdb::observers::source_styling_changed.attach
 332     (std::bind (&tui_source_window::style_changed, this),
 333      m_observable);
 334 }
 335
 336 tui_source_window::~tui_source_window ()
 337 {
 338   gdb::observers::source_styling_changed.detach (m_observable);
 339 }
 340
 341 void
 342 tui_source_window::style_changed ()
 343 {
 344   if (tui_active && is_visible)
 345     refill ();
 346 }
 347
 348 bool
 349 tui_source_window::location_matches_p (struct bp_location *loc, int line_no)
 350 {
 351   return (content[line_no].line_or_addr.loa == LOA_LINE
 352           && content[line_no].line_or_addr.u.line_no == loc->line_number
 353           && loc->symtab != NULL
 354           && filename_cmp (fullname,
 355                            symtab_to_fullname (loc->symtab)) == 0);
 356 }