1 /* TUI display source window.
3 Copyright (C) 1998-2019 Free Software Foundation, Inc.
5 Contributed by Hewlett-Packard Company.
7 This file is part of GDB.
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.
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.
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/>. */
26 #include "breakpoint.h"
29 #include "filenames.h"
30 #include "source-cache.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"
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. */
46 copy_source_line (const char **ptr, int line_no, int first_col,
49 const char *lineptr = *ptr;
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, ' ');
64 if (c == '\033' && skip_ansi_escape (lineptr, &skip_bytes))
66 /* We always have to preserve escapes. */
67 result.append (lineptr, lineptr + skip_bytes);
68 lineptr += skip_bytes;
75 auto process_tab = [&] ()
77 int max_tab_len = tui_tab_width;
80 for (int j = column % max_tab_len;
81 j < max_tab_len && column < first_col + line_width;
83 if (column >= first_col)
84 result.push_back (' ');
87 /* We have to process all the text in order to pick up all the
89 if (column <= first_col || column > first_col + line_width)
96 if (c == '\n' || c == '\r' || c == '\0')
100 else if (c < 040 && c != '\t')
102 result.push_back ('^');
103 result.push_back (c + 0100);
107 result.push_back ('^');
108 result.push_back ('?');
113 result.push_back (c);
115 while (c != '\0' && c != '\n' && c != '\r');
117 if (c == '\r' && *lineptr == '\n')
124 /* Function to display source in the source window. */
126 tui_source_window::set_contents (struct gdbarch *arch,
128 struct tui_line_or_address line_or_addr)
130 gdb_assert (line_or_addr.loa == LOA_LINE);
131 int line_no = line_or_addr.u.line_no;
133 enum tui_status ret = TUI_FAILURE;
137 int line_width, nlines;
140 line_width = width - 1;
141 /* Take hilite (window border) into account, when
142 calculating the number of lines. */
143 nlines = (line_no + (height - 2)) - line_no;
145 std::string srclines;
146 if (!g_source_cache.get_source_lines (s, line_no, line_no + nlines,
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);
157 title = xstrdup (s_filename);
160 fullname = xstrdup (symtab_to_fullname (s));
163 gdbarch = get_objfile_arch (SYMTAB_OBJFILE (s));
164 start_line_or_addr.loa = LOA_LINE;
165 cur_line_no = start_line_or_addr.u.line_no = line_no;
167 const char *iter = srclines.c_str ();
168 content.resize (nlines);
169 while (cur_line < nlines)
171 struct tui_source_element *element
172 = &content[cur_line];
176 text = copy_source_line (&iter, cur_line_no, horizontal_offset,
179 /* Set whether element is the execution point
180 and whether there is a break point on it. */
181 element->line_or_addr.loa = LOA_LINE;
182 element->line_or_addr.u.line_no = cur_line_no;
183 element->is_exec_point
184 = (filename_cmp (locator->full_name,
185 symtab_to_fullname (s)) == 0
186 && cur_line_no == locator->line_no);
188 xfree (content[cur_line].line);
189 content[cur_line].line
190 = xstrdup (text.c_str ());
202 /* Function to display source in the source window. This function
203 initializes the horizontal scroll to 0. */
205 tui_show_symtab_source (tui_source_window_base *win_info,
206 struct gdbarch *gdbarch, struct symtab *s,
207 struct tui_line_or_address line)
209 win_info->horizontal_offset = 0;
210 win_info->update_source_window_as_is (gdbarch, s, line);
214 /* Answer whether the source is currently displayed in the source
217 tui_source_window::showing_source_p (const char *fullname) const
219 return (!content.empty ()
220 && (filename_cmp (tui_locator_win_info_ptr ()->full_name,
225 /* Scroll the source forward or backward vertically. */
227 tui_source_window::do_scroll_vertical (int num_to_scroll)
229 if (!content.empty ())
231 struct tui_line_or_address l;
233 struct symtab_and_line cursal = get_current_source_symtab_and_line ();
235 if (cursal.symtab == NULL)
236 s = find_pc_line_symtab (get_frame_pc (get_selected_frame (NULL)));
241 l.u.line_no = content[0].line_or_addr.u.line_no
243 const std::vector<off_t> *offsets;
244 if (g_source_cache.get_line_charpos (s, &offsets)
245 && l.u.line_no > offsets->size ())
246 /* line = s->nlines - win_info->content_size + 1; */
247 /* elz: fix for dts 23398. */
248 l.u.line_no = content[0].line_or_addr.u.line_no;
249 if (l.u.line_no <= 0)
252 print_source_lines (s, l.u.line_no, l.u.line_no + 1, 0);
256 tui_source_window::tui_source_window ()
257 : tui_source_window_base (SRC_WIN)
259 gdb::observers::source_styling_changed.attach
260 (std::bind (&tui_source_window::style_changed, this),
264 tui_source_window::~tui_source_window ()
266 gdb::observers::source_styling_changed.detach (m_observable);
270 tui_source_window::style_changed ()
272 if (tui_active && is_visible ())
277 tui_source_window::location_matches_p (struct bp_location *loc, int line_no)
279 return (content[line_no].line_or_addr.loa == LOA_LINE
280 && content[line_no].line_or_addr.u.line_no == loc->line_number
281 && loc->symtab != NULL
282 && filename_cmp (fullname,
283 symtab_to_fullname (loc->symtab)) == 0);
286 /* See tui-source.h. */
289 tui_source_window::line_is_displayed (int line) const
291 bool is_displayed = false;
292 int threshold = SCROLL_THRESHOLD;
294 while (i < content.size () - threshold && !is_displayed)
297 = (content[i].line_or_addr.loa == LOA_LINE
298 && content[i].line_or_addr.u.line_no == line);
306 tui_source_window::maybe_update (struct frame_info *fi, symtab_and_line sal,
307 int line_no, CORE_ADDR addr)
309 int start_line = (line_no - (viewport_height / 2)) + 1;
313 bool source_already_displayed = (sal.symtab != 0
314 && showing_source_p (fullname));
316 struct tui_line_or_address l;
319 l.u.line_no = start_line;
320 if (!(source_already_displayed
321 && line_is_displayed (line_no)))
322 update_source_window (get_frame_arch (fi), sal.symtab, l);
325 l.u.line_no = line_no;
326 set_is_exec_point_at (l);