1 /* Cache of styled source file text
2 Copyright (C) 2018-2022 Free Software Foundation, Inc.
4 This file is part of GDB.
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 3 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program. If not, see <http://www.gnu.org/licenses/>. */
20 #include "source-cache.h"
21 #include "gdbsupport/scoped_fd.h"
23 #include "cli/cli-style.h"
25 #include "gdbsupport/selftest.h"
28 #include "cli/cli-cmds.h"
30 #ifdef HAVE_SOURCE_HIGHLIGHT
31 /* If Gnulib redirects 'open' and 'close' to its replacements
32 'rpl_open' and 'rpl_close' via cpp macros, including <fstream>
33 below with those macros in effect will cause unresolved externals
34 when GDB is linked. Happens, e.g., in the MinGW build. */
38 #include <srchilite/sourcehighlight.h>
39 #include <srchilite/langmap.h>
42 /* The number of source files we'll cache. */
46 /* See source-cache.h. */
48 source_cache g_source_cache
;
50 /* When this is true we will use the GNU Source Highlight to add styling to
51 source code (assuming the library is available). This is initialized to
52 true (if appropriate) in _initialize_source_cache below. */
54 static bool use_gnu_source_highlight
;
56 /* The "maint show gnu-source-highlight enabled" command. */
59 show_use_gnu_source_highlight_enabled (struct ui_file
*file
, int from_tty
,
60 struct cmd_list_element
*c
,
64 _("Use of GNU Source Highlight library is \"%s\".\n"),
68 /* The "maint set gnu-source-highlight enabled" command. */
71 set_use_gnu_source_highlight_enabled (const char *ignore_args
,
73 struct cmd_list_element
*c
)
75 #ifndef HAVE_SOURCE_HIGHLIGHT
76 /* If the library is not available and the user tried to enable use of
77 the library, then disable use of the library, and give an error. */
78 if (use_gnu_source_highlight
)
80 use_gnu_source_highlight
= false;
81 error (_("the GNU Source Highlight library is not available"));
84 /* We (might) have just changed how we style source code, discard any
85 previously cached contents. */
86 forget_cached_source_info ();
90 /* See source-cache.h. */
93 source_cache::get_plain_source_lines (struct symtab
*s
,
94 const std::string
&fullname
)
96 scoped_fd
desc (open_source_file (s
));
98 perror_with_name (symtab_to_filename_for_display (s
));
101 if (fstat (desc
.get (), &st
) < 0)
102 perror_with_name (symtab_to_filename_for_display (s
));
105 lines
.resize (st
.st_size
);
106 if (myread (desc
.get (), &lines
[0], lines
.size ()) < 0)
107 perror_with_name (symtab_to_filename_for_display (s
));
110 if (s
->objfile () != NULL
&& s
->objfile ()->obfd
!= NULL
)
111 mtime
= s
->objfile ()->mtime
;
112 else if (current_program_space
->exec_bfd ())
113 mtime
= current_program_space
->ebfd_mtime
;
115 if (mtime
&& mtime
< st
.st_mtime
)
116 warning (_("Source file is more recent than executable."));
118 std::vector
<off_t
> offsets
;
119 offsets
.push_back (0);
120 for (size_t offset
= lines
.find ('\n');
121 offset
!= std::string::npos
;
122 offset
= lines
.find ('\n', offset
))
125 /* A newline at the end does not start a new line. It would
126 seem simpler to just strip the newline in this function, but
127 then "list" won't print the final newline. */
128 if (offset
!= lines
.size ())
129 offsets
.push_back (offset
);
132 offsets
.shrink_to_fit ();
133 m_offset_cache
.emplace (fullname
, std::move (offsets
));
138 #ifdef HAVE_SOURCE_HIGHLIGHT
140 /* Return the Source Highlight language name, given a gdb language
141 LANG. Returns NULL if the language is not known. */
144 get_language_name (enum language lang
)
161 case language_fortran
:
162 return "fortran.lang";
165 /* Not handled by Source Highlight. */
171 case language_pascal
:
172 return "pascal.lang";
174 case language_opencl
:
175 /* Not handled by Source Highlight. */
191 #endif /* HAVE_SOURCE_HIGHLIGHT */
193 /* See source-cache.h. */
196 source_cache::ensure (struct symtab
*s
)
198 std::string fullname
= symtab_to_fullname (s
);
200 size_t size
= m_source_map
.size ();
201 for (int i
= 0; i
< size
; ++i
)
203 if (m_source_map
[i
].fullname
== fullname
)
205 /* This should always hold, because we create the file offsets
206 when reading the file. */
207 gdb_assert (m_offset_cache
.find (fullname
)
208 != m_offset_cache
.end ());
209 /* Not strictly LRU, but at least ensure that the most
210 recently used entry is always the last candidate for
211 deletion. Note that this property is relied upon by at
214 std::swap (m_source_map
[i
], m_source_map
[size
- 1]);
219 std::string contents
;
222 contents
= get_plain_source_lines (s
, fullname
);
224 catch (const gdb_exception_error
&e
)
226 /* If 's' is not found, an exception is thrown. */
230 if (source_styling
&& gdb_stdout
->can_emit_style_escape ())
232 #ifdef HAVE_SOURCE_HIGHLIGHT
233 bool already_styled
= false;
234 const char *lang_name
= get_language_name (s
->language ());
235 if (lang_name
!= nullptr && use_gnu_source_highlight
)
237 /* The global source highlight object, or null if one was
238 never constructed. This is stored here rather than in
239 the class so that we don't need to include anything or do
240 conditional compilation in source-cache.h. */
241 static srchilite::SourceHighlight
*highlighter
;
245 if (highlighter
== nullptr)
247 highlighter
= new srchilite::SourceHighlight ("esc.outlang");
248 highlighter
->setStyleFile ("esc.style");
251 std::istringstream
input (contents
);
252 std::ostringstream output
;
253 highlighter
->highlight (input
, output
, lang_name
, fullname
);
254 contents
= output
.str ();
255 already_styled
= true;
259 /* Source Highlight will throw an exception if
260 highlighting fails. One possible reason it can fail
261 is if the language is unknown -- which matters to gdb
262 because Rust support wasn't added until after 3.1.8.
263 Ignore exceptions here and fall back to
264 un-highlighted text. */
269 #endif /* HAVE_SOURCE_HIGHLIGHT */
271 gdb::optional
<std::string
> ext_contents
;
272 ext_contents
= ext_lang_colorize (fullname
, contents
);
273 if (ext_contents
.has_value ())
274 contents
= std::move (*ext_contents
);
278 source_text result
= { std::move (fullname
), std::move (contents
) };
279 m_source_map
.push_back (std::move (result
));
281 if (m_source_map
.size () > MAX_ENTRIES
)
283 auto iter
= m_source_map
.begin ();
284 m_offset_cache
.erase (iter
->fullname
);
285 m_source_map
.erase (iter
);
291 /* See source-cache.h. */
294 source_cache::get_line_charpos (struct symtab
*s
,
295 const std::vector
<off_t
> **offsets
)
297 std::string fullname
= symtab_to_fullname (s
);
299 auto iter
= m_offset_cache
.find (fullname
);
300 if (iter
== m_offset_cache
.end ())
304 iter
= m_offset_cache
.find (fullname
);
305 /* cache_source_text ensured this was entered. */
306 gdb_assert (iter
!= m_offset_cache
.end ());
309 *offsets
= &iter
->second
;
313 /* A helper function that extracts the desired source lines from TEXT,
314 putting them into LINES_OUT. The arguments are as for
315 get_source_lines. Returns true on success, false if the line
316 numbers are invalid. */
319 extract_lines (const std::string
&text
, int first_line
, int last_line
,
320 std::string
*lines_out
)
323 std::string::size_type pos
= 0;
324 std::string::size_type first_pos
= std::string::npos
;
326 while (pos
!= std::string::npos
&& lineno
<= last_line
)
328 std::string::size_type new_pos
= text
.find ('\n', pos
);
330 if (lineno
== first_line
)
334 if (lineno
== last_line
|| pos
== std::string::npos
)
336 /* A newline at the end does not start a new line. */
337 if (first_pos
== std::string::npos
338 || first_pos
== text
.size ())
340 if (pos
== std::string::npos
)
344 *lines_out
= text
.substr (first_pos
, pos
- first_pos
);
354 /* See source-cache.h. */
357 source_cache::get_source_lines (struct symtab
*s
, int first_line
,
358 int last_line
, std::string
*lines
)
360 if (first_line
< 1 || last_line
< 1 || first_line
> last_line
)
366 return extract_lines (m_source_map
.back ().contents
,
367 first_line
, last_line
, lines
);
370 /* Implement 'maint flush source-cache' command. */
373 source_cache_flush_command (const char *command
, int from_tty
)
375 forget_cached_source_info ();
376 gdb_printf (_("Source cache flushed.\n"));
382 static void extract_lines_test ()
384 std::string input_text
= "abc\ndef\nghi\njkl\n";
387 SELF_CHECK (extract_lines (input_text
, 1, 1, &result
)
388 && result
== "abc\n");
389 SELF_CHECK (!extract_lines (input_text
, 2, 1, &result
));
390 SELF_CHECK (extract_lines (input_text
, 1, 2, &result
)
391 && result
== "abc\ndef\n");
392 SELF_CHECK (extract_lines ("abc", 1, 1, &result
)
398 void _initialize_source_cache ();
400 _initialize_source_cache ()
402 add_cmd ("source-cache", class_maintenance
, source_cache_flush_command
,
403 _("Force gdb to flush its source code cache."),
404 &maintenanceflushlist
);
406 /* All the 'maint set|show gnu-source-highlight' sub-commands. */
407 static struct cmd_list_element
*maint_set_gnu_source_highlight_cmdlist
;
408 static struct cmd_list_element
*maint_show_gnu_source_highlight_cmdlist
;
410 /* Adds 'maint set|show gnu-source-highlight'. */
411 add_setshow_prefix_cmd ("gnu-source-highlight", class_maintenance
,
412 _("Set gnu-source-highlight specific variables."),
413 _("Show gnu-source-highlight specific variables."),
414 &maint_set_gnu_source_highlight_cmdlist
,
415 &maint_show_gnu_source_highlight_cmdlist
,
416 &maintenance_set_cmdlist
,
417 &maintenance_show_cmdlist
);
419 /* Adds 'maint set|show gnu-source-highlight enabled'. */
420 add_setshow_boolean_cmd ("enabled", class_maintenance
,
421 &use_gnu_source_highlight
, _("\
422 Set whether the GNU Source Highlight library should be used."), _("\
423 Show whether the GNU Source Highlight library is being used."),_("\
424 When enabled, GDB will use the GNU Source Highlight library to apply\n\
425 styling to source code lines that are shown."),
426 set_use_gnu_source_highlight_enabled
,
427 show_use_gnu_source_highlight_enabled
,
428 &maint_set_gnu_source_highlight_cmdlist
,
429 &maint_show_gnu_source_highlight_cmdlist
);
431 /* Enable use of GNU Source Highlight library, if we have it. */
432 #ifdef HAVE_SOURCE_HIGHLIGHT
433 use_gnu_source_highlight
= true;
437 selftests::register_test ("source-cache", selftests::extract_lines_test
);