diff options
author | Tom Tromey <tom@tromey.com> | 2018-09-03 22:56:33 -0600 |
---|---|---|
committer | Tom Tromey <tom@tromey.com> | 2018-12-28 12:49:49 -0700 |
commit | cbe5657196d0d3acbeca39973f93f333ecedacda (patch) | |
tree | 4d7545de22d1941cb820ae9e078e8be7f78b96b6 /gdb/utils.c | |
parent | 9162a27c5f5828240b53379d735679e2a69a9f41 (diff) | |
download | gdb-cbe5657196d0d3acbeca39973f93f333ecedacda.zip gdb-cbe5657196d0d3acbeca39973f93f333ecedacda.tar.gz gdb-cbe5657196d0d3acbeca39973f93f333ecedacda.tar.bz2 |
Add output styles to gdb
This adds some output styling to the CLI.
A style is currently a foreground color, a background color, and an
intensity (dim or bold). (This list could be expanded depending on
terminal capabilities.)
A style can be applied while printing. For ui-out, this is done by
passing the style constant as an argument. For low-level cases,
fprintf_styled and fputs_styled are provided.
Users can control the style via a number of new set/show commands. In
the interest of not typing many nearly-identical documentation
strings, I automated this. On the down side, this is not very
i18n-friendly.
I've chose some default colors to use. I think it would be good to
enable this by default, so that when users start the new gdb, they
will see the new feature.
Stylizing is done if TERM is set and is not "dumb". This could be
improved when the TUI is available by using the curses has_colors
call. That is, the lowest layer could call this without committing to
using curses everywhere; see my other patch for TUI colorizing.
I considered adding a new "set_style" method to ui_file. However,
because the implementation had to interact with the pager code, I
didn't take this approach. But, one idea might be to put the isatty
check there and then have it defer to the lower layers.
gdb/ChangeLog
2018-12-28 Tom Tromey <tom@tromey.com>
* utils.h (set_output_style, fprintf_styled)
(fputs_styled): Declare.
* utils.c (applied_style, desired_style): New globals.
(emit_style_escape, set_output_style): New function.
(prompt_for_continue): Emit style escapes.
(fputs_maybe_filtered): Likewise.
(fputs_styled, fprintf_styled): New functions.
* ui-out.h (enum class ui_out_style_kind): New.
(class ui_out) <field_string, field_stream, do_field_string>: Add
style parameter.
* ui-out.c (ui_out::field_stream, ui_out::field_string): Add style
parameter.
* tui/tui-out.h (class tui_ui_out) <do_field_string>: Add style
parameter.
* tui/tui-out.c (tui_ui_out::do_field_string): Add style
parameter.
(tui_ui_out::do_field_string): Update.
* tracepoint.c (print_one_static_tracepoint_marker): Style
output.
* stack.c (print_frame_info, print_frame): Style output.
* source.c (print_source_lines_base): Style output.
* skip.c (info_skip_command): Style output.
* record-btrace.c (btrace_call_history_src_line): Style output.
(btrace_call_history): Likewise.
* python/py-framefilter.c (py_print_frame): Style output.
* mi/mi-out.h (class mi_ui_out) <do_field_string>: Add style
parameter.
* mi/mi-out.c (mi_ui_out::do_table_header)
(mi_ui_out::do_field_int): Update.
(mi_ui_out::do_field_string): Update.
* disasm.c (gdb_pretty_print_disassembler::pretty_print_insn):
Style output.
* cli/cli-style.h: New file.
* cli/cli-style.c: New file.
* cli-out.h (class cli_ui_out) <do_field_string>: Add style
parameter.
* cli-out.c (cli_ui_out::do_table_header)
(cli_ui_out::do_field_int, cli_ui_out::do_field_skip): Update.
(cli_ui_out::do_field_string): Add style parameter. Style the
output.
* breakpoint.c (print_breakpoint_location): Style output.
(update_static_tracepoint): Likewise.
* Makefile.in (SUBDIR_CLI_SRCS): Add cli-style.c.
(HFILES_NO_SRCDIR): Add cli-style.h.
gdb/testsuite/ChangeLog
2018-12-28 Tom Tromey <tom@tromey.com>
* gdb.base/style.exp: New file.
* gdb.base/style.c: New file.
Diffstat (limited to 'gdb/utils.c')
-rw-r--r-- | gdb/utils.c | 80 |
1 files changed, 79 insertions, 1 deletions
diff --git a/gdb/utils.c b/gdb/utils.c index 2019e20..2fb7476 100644 --- a/gdb/utils.c +++ b/gdb/utils.c @@ -71,6 +71,7 @@ #include "cp-support.h" #include <algorithm> #include "common/pathstuff.h" +#include "cli/cli-style.h" void (*deprecated_error_begin_hook) (void); @@ -1422,6 +1423,46 @@ set_screen_width_and_height (int width, int height) set_width (); } +/* The currently applied style. */ + +static ui_file_style applied_style; + +/* The currently desired style. This can differ from the applied + style when showing the pagination prompt. */ + +static ui_file_style desired_style; + +/* Emit an ANSI style escape for STYLE to the wrap buffer. */ + +static void +emit_style_escape (const ui_file_style &style) +{ + if (applied_style == style) + return; + applied_style = style; + + wrap_buffer.append (style.to_ansi ()); +} + +/* Set the current output style. This will affect future uses of the + _filtered output functions. */ + +static void +set_output_style (struct ui_file *stream, const ui_file_style &style) +{ + if (stream != gdb_stdout + || !cli_styling + || style == desired_style + || !ui_file_isatty (stream)) + return; + const char *term = getenv ("TERM"); + if (term == nullptr || !strcmp (term, "dumb")) + return; + + desired_style = style; + emit_style_escape (style); +} + /* Wait, so the user can read what's on the screen. Prompt the user to continue by pressing RETURN. 'q' is also provided because telling users what to do in the prompt is more user-friendly than @@ -1437,6 +1478,9 @@ prompt_for_continue (void) steady_clock::time_point prompt_started = steady_clock::now (); bool disable_pagination = pagination_disabled_for_command; + /* Clear the current styling. */ + emit_style_escape (ui_file_style ()); + if (annotation_level > 1) printf_unfiltered (("\n\032\032pre-prompt-for-continue\n")); @@ -1481,6 +1525,9 @@ prompt_for_continue (void) reinitialize_more_filter (); pagination_disabled_for_command = disable_pagination; + /* Restore the current styling. */ + emit_style_escape (desired_style); + dont_repeat (); /* Forget prev cmd -- CR won't repeat it. */ } @@ -1714,7 +1761,11 @@ fputs_maybe_filtered (const char *linebuffer, struct ui_file *stream, if chars_per_line is right, we probably just overflowed anyway; if it's wrong, let us keep going. */ if (wrap_column) - fputc_unfiltered ('\n', stream); + { + emit_style_escape (ui_file_style ()); + flush_wrap_buffer (stream); + fputc_unfiltered ('\n', stream); + } /* Possible new page. Note that PAGINATION_DISABLED_FOR_COMMAND might be set during @@ -1727,6 +1778,7 @@ fputs_maybe_filtered (const char *linebuffer, struct ui_file *stream, if (wrap_column) { fputs_unfiltered (wrap_indent, stream); + emit_style_escape (desired_style); flush_wrap_buffer (stream); /* FIXME, this strlen is what prevents wrap_indent from containing tabs. However, if we recurse to print it @@ -1759,6 +1811,17 @@ fputs_filtered (const char *linebuffer, struct ui_file *stream) fputs_maybe_filtered (linebuffer, stream, 1); } +/* See utils.h. */ + +void +fputs_styled (const char *linebuffer, const ui_file_style &style, + struct ui_file *stream) +{ + set_output_style (stream, style); + fputs_maybe_filtered (linebuffer, stream, 1); + set_output_style (stream, ui_file_style ()); +} + int putchar_unfiltered (int c) { @@ -1986,6 +2049,21 @@ fprintfi_filtered (int spaces, struct ui_file *stream, const char *format, va_end (args); } +/* See utils.h. */ + +void +fprintf_styled (struct ui_file *stream, const ui_file_style &style, + const char *format, ...) +{ + va_list args; + + set_output_style (stream, style); + va_start (args, format); + vfprintf_filtered (stream, format, args); + va_end (args); + set_output_style (stream, ui_file_style ()); +} + void printf_filtered (const char *format, ...) |