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