/* TUI display source window.
- Copyright (C) 1998-2004, 2007-2012 Free Software Foundation, Inc.
+ Copyright (C) 1998-2019 Free Software Foundation, Inc.
Contributed by Hewlett-Packard Company.
#include "frame.h"
#include "breakpoint.h"
#include "source.h"
-#include "symtab.h"
#include "objfiles.h"
#include "filenames.h"
+#include "source-cache.h"
#include "tui/tui.h"
#include "tui/tui-data.h"
+#include "tui/tui-io.h"
#include "tui/tui-stack.h"
#include "tui/tui-winsource.h"
#include "tui/tui-source.h"
-
-#include "gdb_string.h"
#include "gdb_curses.h"
-/* Function to display source in the source window. */
-enum tui_status
-tui_set_source_content (struct symtab *s,
- int line_no,
- int noerror)
+/* A helper function for tui_set_source_content that extracts some
+ source text from PTR. LINE_NO is the line number; FIRST_COL is the
+ first column to extract, and LINE_WIDTH is the number of characters
+ to display. Returns a string holding the desired text. */
+
+static std::string
+copy_source_line (const char **ptr, int line_no, int first_col,
+ int line_width)
{
- enum tui_status ret = TUI_FAILURE;
+ const char *lineptr = *ptr;
+
+ /* Init the line with the line number. */
+ std::string result = string_printf ("%-6d", line_no);
+ int len = result.size ();
+ len = len - ((len / tui_tab_width) * tui_tab_width);
+ result.append (len, ' ');
- if (s != (struct symtab *) NULL && s->filename != (char *) NULL)
+ int column = 0;
+ char c;
+ do
{
- FILE *stream;
- int i, desc, c, line_width, nlines;
- char *src_line = 0;
+ int skip_bytes;
- if ((ret = tui_alloc_source_buffer (TUI_SRC_WIN)) == TUI_SUCCESS)
+ c = *lineptr;
+ if (c == '\033' && skip_ansi_escape (lineptr, &skip_bytes))
{
- line_width = TUI_SRC_WIN->generic.width - 1;
- /* Take hilite (window border) into account, when
- calculating the number of lines. */
- nlines = (line_no + (TUI_SRC_WIN->generic.height - 2)) - line_no;
- desc = open_source_file (s);
- if (desc < 0)
- {
- if (!noerror)
- {
- char *name = alloca (strlen (s->filename) + 100);
-
- sprintf (name, "%s:%d", s->filename, line_no);
- print_sys_errmsg (name, errno);
- }
- ret = TUI_FAILURE;
- }
- else
- {
- if (s->line_charpos == 0)
- find_source_lines (s, desc);
-
- if (line_no < 1 || line_no > s->nlines)
- {
- close (desc);
- printf_unfiltered (
- "Line number %d out of range; %s has %d lines.\n",
- line_no, s->filename, s->nlines);
- }
- else if (lseek (desc, s->line_charpos[line_no - 1], 0) < 0)
- {
- close (desc);
- perror_with_name (s->filename);
- }
- else
- {
- int offset, cur_line_no, cur_line, cur_len, threshold;
- struct tui_gen_win_info *locator
- = tui_locator_win_info_ptr ();
- struct tui_source_info *src
- = &TUI_SRC_WIN->detail.source_info;
-
- if (TUI_SRC_WIN->generic.title)
- xfree (TUI_SRC_WIN->generic.title);
- TUI_SRC_WIN->generic.title = xstrdup (s->filename);
-
- if (src->filename)
- xfree (src->filename);
- src->filename = xstrdup (s->filename);
-
- /* Determine the threshold for the length of the
- line and the offset to start the display. */
- offset = src->horizontal_offset;
- threshold = (line_width - 1) + offset;
- stream = fdopen (desc, FOPEN_RT);
- clearerr (stream);
- cur_line = 0;
- src->gdbarch = get_objfile_arch (s->objfile);
- src->start_line_or_addr.loa = LOA_LINE;
- cur_line_no = src->start_line_or_addr.u.line_no = line_no;
- if (offset > 0)
- src_line = (char *) xmalloc (
- (threshold + 1) * sizeof (char));
- while (cur_line < nlines)
- {
- struct tui_win_element *element
- = (struct tui_win_element *)
- TUI_SRC_WIN->generic.content[cur_line];
-
- /* Get the first character in the line. */
- c = fgetc (stream);
-
- if (offset == 0)
- src_line = ((struct tui_win_element *)
- TUI_SRC_WIN->generic.content[
- cur_line])->which_element.source.line;
- /* Init the line with the line number. */
- sprintf (src_line, "%-6d", cur_line_no);
- cur_len = strlen (src_line);
- i = cur_len - ((cur_len / tui_default_tab_len ())
- * tui_default_tab_len ());
- while (i < tui_default_tab_len ())
- {
- src_line[cur_len] = ' ';
- i++;
- cur_len++;
- }
- src_line[cur_len] = (char) 0;
-
- /* Set whether element is the execution point
- and whether there is a break point on it. */
- element->which_element.source.line_or_addr.loa =
- LOA_LINE;
- element->which_element.source.line_or_addr.u.line_no =
- cur_line_no;
- element->which_element.source.is_exec_point =
- (filename_cmp (((struct tui_win_element *)
- locator->content[0])->which_element.locator.file_name,
- s->filename) == 0
- && cur_line_no == ((struct tui_win_element *)
- locator->content[0])->which_element.locator.line_no);
- if (c != EOF)
- {
- i = strlen (src_line) - 1;
- do
- {
- if ((c != '\n') && (c != '\r')
- && (++i < threshold))
- {
- if (c < 040 && c != '\t')
- {
- src_line[i++] = '^';
- src_line[i] = c + 0100;
- }
- else if (c == 0177)
- {
- src_line[i++] = '^';
- src_line[i] = '?';
- }
- else
- { /* Store the charcter in the
- line buffer. If it is a tab,
- then translate to the correct
- number of chars so we don't
- overwrite our buffer. */
- if (c == '\t')
- {
- int j, max_tab_len
- = tui_default_tab_len ();
-
- for (j = i - ((i / max_tab_len)
- * max_tab_len);
- j < max_tab_len
- && i < threshold;
- i++, j++)
- src_line[i] = ' ';
- i--;
- }
- else
- src_line[i] = c;
- }
- src_line[i + 1] = 0;
- }
- else
- { /* If we have not reached EOL, then
- eat chars until we do. */
- while (c != EOF && c != '\n' && c != '\r')
- c = fgetc (stream);
- /* Handle non-'\n' end-of-line. */
- if (c == '\r'
- && (c = fgetc (stream)) != '\n'
- && c != EOF)
- {
- ungetc (c, stream);
- c = '\r';
- }
-
- }
- }
- while (c != EOF && c != '\n' && c != '\r'
- && i < threshold
- && (c = fgetc (stream)));
- }
- /* Now copy the line taking the offset into
- account. */
- if (strlen (src_line) > offset)
- strcpy (((struct tui_win_element *)
- TUI_SRC_WIN->generic.content[cur_line])->which_element.source.line,
- &src_line[offset]);
- else
- ((struct tui_win_element *)
- TUI_SRC_WIN->generic.content[
- cur_line])->which_element.source.line[0] = (char) 0;
- cur_line++;
- cur_line_no++;
- }
- if (offset > 0)
- xfree (src_line);
- fclose (stream);
- TUI_SRC_WIN->generic.content_size = nlines;
- ret = TUI_SUCCESS;
- }
- }
+ /* We always have to preserve escapes. */
+ result.append (lineptr, lineptr + skip_bytes);
+ lineptr += skip_bytes;
+ continue;
}
- }
- return ret;
-}
+ ++lineptr;
+ ++column;
-/* elz: This function sets the contents of the source window to empty
- except for a line in the middle with a warning message about the
- source not being available. This function is called by
- tui_erase_source_contents(), which in turn is invoked when the
- source files cannot be accessed. */
-
-void
-tui_set_source_content_nil (struct tui_win_info *win_info,
- char *warning_string)
-{
- int line_width;
- int n_lines;
- int curr_line = 0;
+ auto process_tab = [&] ()
+ {
+ int max_tab_len = tui_tab_width;
+
+ --column;
+ for (int j = column % max_tab_len;
+ j < max_tab_len && column < first_col + line_width;
+ column++, j++)
+ if (column >= first_col)
+ result.push_back (' ');
+ };
+
+ /* We have to process all the text in order to pick up all the
+ escapes. */
+ if (column <= first_col || column > first_col + line_width)
+ {
+ if (c == '\t')
+ process_tab ();
+ continue;
+ }
- line_width = win_info->generic.width - 1;
- n_lines = win_info->generic.height - 2;
+ if (c == '\n' || c == '\r' || c == '\0')
+ {
+ /* Nothing. */
+ }
+ else if (c < 040 && c != '\t')
+ {
+ result.push_back ('^');
+ result.push_back (c + 0100);
+ }
+ else if (c == 0177)
+ {
+ result.push_back ('^');
+ result.push_back ('?');
+ }
+ else if (c == '\t')
+ process_tab ();
+ else
+ result.push_back (c);
+ }
+ while (c != '\0' && c != '\n' && c != '\r');
- /* Set to empty each line in the window, except for the one which
- contains the message. */
- while (curr_line < win_info->generic.content_size)
- {
- /* Set the information related to each displayed line to null:
- i.e. the line number is 0, there is no bp, it is not where
- the program is stopped. */
+ if (c == '\r' && *lineptr == '\n')
+ ++lineptr;
+ *ptr = lineptr;
- struct tui_win_element *element =
- (struct tui_win_element *) win_info->generic.content[curr_line];
+ return result;
+}
- element->which_element.source.line_or_addr.loa = LOA_LINE;
- element->which_element.source.line_or_addr.u.line_no = 0;
- element->which_element.source.is_exec_point = FALSE;
- element->which_element.source.has_break = FALSE;
+/* Function to display source in the source window. */
+enum tui_status
+tui_set_source_content (tui_source_window_base *win_info,
+ struct symtab *s,
+ int line_no,
+ int noerror)
+{
+ enum tui_status ret = TUI_FAILURE;
- /* Set the contents of the line to blank. */
- element->which_element.source.line[0] = (char) 0;
+ if (s != NULL)
+ {
+ int line_width, nlines;
- /* If the current line is in the middle of the screen, then we
- want to display the 'no source available' message in it.
- Note: the 'weird' arithmetic with the line width and height
- comes from the function tui_erase_source_content(). We need
- to keep the screen and the window's actual contents in
- synch. */
+ ret = TUI_SUCCESS;
+ line_width = win_info->width - 1;
+ /* Take hilite (window border) into account, when
+ calculating the number of lines. */
+ nlines = (line_no + (win_info->height - 2)) - line_no;
- if (curr_line == (n_lines / 2 + 1))
+ std::string srclines;
+ if (!g_source_cache.get_source_lines (s, line_no, line_no + nlines,
+ &srclines))
{
- int i;
- int xpos;
- int warning_length = strlen (warning_string);
- char *src_line;
-
- src_line = element->which_element.source.line;
-
- if (warning_length >= ((line_width - 1) / 2))
- xpos = 1;
- else
- xpos = (line_width - 1) / 2 - warning_length;
-
- for (i = 0; i < xpos; i++)
- src_line[i] = ' ';
-
- sprintf (src_line + i, "%s", warning_string);
+ if (!noerror)
+ {
+ const char *filename = symtab_to_filename_for_display (s);
+ char *name = (char *) alloca (strlen (filename) + 100);
- for (i = xpos + warning_length; i < line_width; i++)
- src_line[i] = ' ';
+ sprintf (name, "%s:%d", filename, line_no);
+ print_sys_errmsg (name, errno);
+ }
+ ret = TUI_FAILURE;
+ }
+ else
+ {
+ int cur_line_no, cur_line;
+ struct tui_locator_window *locator
+ = tui_locator_win_info_ptr ();
+ const char *s_filename = symtab_to_filename_for_display (s);
- src_line[i] = '\n';
+ xfree (win_info->title);
+ win_info->title = xstrdup (s_filename);
- } /* end if */
+ xfree (win_info->fullname);
+ win_info->fullname = xstrdup (symtab_to_fullname (s));
- curr_line++;
+ cur_line = 0;
+ win_info->gdbarch = get_objfile_arch (SYMTAB_OBJFILE (s));
+ win_info->start_line_or_addr.loa = LOA_LINE;
+ cur_line_no = win_info->start_line_or_addr.u.line_no = line_no;
- } /* end while */
+ const char *iter = srclines.c_str ();
+ win_info->content.resize (nlines);
+ while (cur_line < nlines)
+ {
+ struct tui_source_element *element
+ = &win_info->content[cur_line];
+
+ std::string text;
+ if (*iter != '\0')
+ text = copy_source_line (&iter, cur_line_no,
+ win_info->horizontal_offset,
+ line_width);
+
+ /* Set whether element is the execution point
+ and whether there is a break point on it. */
+ element->line_or_addr.loa = LOA_LINE;
+ element->line_or_addr.u.line_no = cur_line_no;
+ element->is_exec_point
+ = (filename_cmp (locator->full_name,
+ symtab_to_fullname (s)) == 0
+ && cur_line_no == locator->line_no);
+
+ xfree (win_info->content[cur_line].line);
+ win_info->content[cur_line].line
+ = xstrdup (text.c_str ());
+
+ cur_line++;
+ cur_line_no++;
+ }
+ ret = TUI_SUCCESS;
+ }
+ }
+ return ret;
}
/* Function to display source in the source window. This function
initializes the horizontal scroll to 0. */
void
-tui_show_symtab_source (struct gdbarch *gdbarch, struct symtab *s,
+tui_show_symtab_source (tui_source_window_base *win_info,
+ struct gdbarch *gdbarch, struct symtab *s,
struct tui_line_or_address line,
int noerror)
{
- TUI_SRC_WIN->detail.source_info.horizontal_offset = 0;
- tui_update_source_window_as_is (TUI_SRC_WIN, gdbarch, s, line, noerror);
+ win_info->horizontal_offset = 0;
+ tui_update_source_window_as_is (win_info, gdbarch, s, line, noerror);
}
/* Answer whether the source is currently displayed in the source
window. */
-int
-tui_source_is_displayed (char *fname)
+bool
+tui_source_window::showing_source_p (const char *fullname) const
{
- return (TUI_SRC_WIN->generic.content_in_use
- && (filename_cmp (((struct tui_win_element *)
- (tui_locator_win_info_ptr ())->
- content[0])->which_element.locator.file_name,
- fname) == 0));
+ return (!content.empty ()
+ && (filename_cmp (tui_locator_win_info_ptr ()->full_name,
+ fullname) == 0));
}
/* Scroll the source forward or backward vertically. */
void
-tui_vertical_source_scroll (enum tui_scroll_direction scroll_direction,
- int num_to_scroll)
+tui_source_window::do_scroll_vertical (int num_to_scroll)
{
- if (TUI_SRC_WIN->generic.content != NULL)
+ if (!content.empty ())
{
struct tui_line_or_address l;
struct symtab *s;
- tui_win_content content = (tui_win_content) TUI_SRC_WIN->generic.content;
struct symtab_and_line cursal = get_current_source_symtab_and_line ();
- if (cursal.symtab == (struct symtab *) NULL)
- s = find_pc_symtab (get_frame_pc (get_selected_frame (NULL)));
+ if (cursal.symtab == NULL)
+ s = find_pc_line_symtab (get_frame_pc (get_selected_frame (NULL)));
else
s = cursal.symtab;
l.loa = LOA_LINE;
- if (scroll_direction == FORWARD_SCROLL)
- {
- l.u.line_no = content[0]->which_element.source.line_or_addr.u.line_no
- + num_to_scroll;
- if (l.u.line_no > s->nlines)
- /* line = s->nlines - win_info->generic.content_size + 1; */
- /* elz: fix for dts 23398. */
- l.u.line_no
- = content[0]->which_element.source.line_or_addr.u.line_no;
- }
- else
- {
- l.u.line_no = content[0]->which_element.source.line_or_addr.u.line_no
- - num_to_scroll;
- if (l.u.line_no <= 0)
- l.u.line_no = 1;
- }
+ l.u.line_no = content[0].line_or_addr.u.line_no
+ + num_to_scroll;
+ const std::vector<off_t> *offsets;
+ if (g_source_cache.get_line_charpos (s, &offsets)
+ && l.u.line_no > offsets->size ())
+ /* line = s->nlines - win_info->content_size + 1; */
+ /* elz: fix for dts 23398. */
+ l.u.line_no = content[0].line_or_addr.u.line_no;
+ if (l.u.line_no <= 0)
+ l.u.line_no = 1;
print_source_lines (s, l.u.line_no, l.u.line_no + 1, 0);
}
}
+
+tui_source_window::tui_source_window ()
+ : tui_source_window_base (SRC_WIN)
+{
+ gdb::observers::source_styling_changed.attach
+ (std::bind (&tui_source_window::style_changed, this),
+ m_observable);
+}
+
+tui_source_window::~tui_source_window ()
+{
+ gdb::observers::source_styling_changed.detach (m_observable);
+}
+
+void
+tui_source_window::style_changed ()
+{
+ if (tui_active && is_visible)
+ refill ();
+}
+
+bool
+tui_source_window::location_matches_p (struct bp_location *loc, int line_no)
+{
+ return (content[line_no].line_or_addr.loa == LOA_LINE
+ && content[line_no].line_or_addr.u.line_no == loc->line_number
+ && loc->symtab != NULL
+ && filename_cmp (fullname,
+ symtab_to_fullname (loc->symtab)) == 0);
+}
+
+/* See tui-source.h. */
+
+bool
+tui_source_window::line_is_displayed (int line) const
+{
+ bool is_displayed = false;
+ int threshold = SCROLL_THRESHOLD;
+ int i = 0;
+ while (i < content.size () - threshold && !is_displayed)
+ {
+ is_displayed
+ = (content[i].line_or_addr.loa == LOA_LINE
+ && content[i].line_or_addr.u.line_no == line);
+ i++;
+ }
+
+ return is_displayed;
+}
+
+void
+tui_source_window::maybe_update (struct frame_info *fi, symtab_and_line sal,
+ int line_no, CORE_ADDR addr)
+{
+ int start_line = (line_no - (viewport_height / 2)) + 1;
+ if (start_line <= 0)
+ start_line = 1;
+
+ bool source_already_displayed = (sal.symtab != 0
+ && showing_source_p (fullname));
+
+ struct tui_line_or_address l;
+
+ l.loa = LOA_LINE;
+ l.u.line_no = start_line;
+ if (!(source_already_displayed
+ && line_is_displayed (line_no)))
+ tui_update_source_window (this, get_frame_arch (fi),
+ sal.symtab, l, TRUE);
+ else
+ {
+ l.u.line_no = line_no;
+ set_is_exec_point_at (l);
+ }
+}