mirror of
https://sourceware.org/git/binutils-gdb.git
synced 2024-12-09 04:21:49 +08:00
9d2d8a16e1
This commit adds a new 'version' style, which replaces the hard coded styling currently used for GDB's version string. GDB's version number is displayed: 1. In the output of 'show version', and 2. When GDB starts up (without the --quiet option). This new style can only ever affect the first of these two cases as the second case is printed before GDB has processed any initialization files, or processed any GDB commands passed on the command line. However, because the first case exists I think this commit makes sense, it means the style is no longer hard coded into GDB, and we can add some tests that the style can be enabled/disabled correctly. This commit is an alternative to a patch Tom posted here: https://sourceware.org/pipermail/gdb-patches/2020-June/169820.html I've used the style name 'version' instead of 'startup' to reflect what the style is actually used for. If other parts of the startup text end up being highlighted I imagine they would get their own styles based on what is being highlighted. I feel this is more inline with the other style names that are already in use within GDB. I also decoupled adding this style from the idea of startup options, and the possibility of auto-saving startup options. Those ideas can be explored in later patches. This commit should probably be considered only a partial solution to issue PR cli/25956. The colours of the style are no longer hard coded, however, it is still impossible to change the styling of the version string displayed during startup, so in one sense, the styling of that string is still "hard coded". A later patch will hopefully extend GDB to allow it to adjust the version styling before the initial version string is printed. gdb/ChangeLog: PR cli/25956 * cli/cli-style.c: Add 'cli/cli-setshow.h' include. (version_style): Define. (cli_style_option::cli_style_option): Add intensity parameter, and use as appropriate. (_initialize_cli_style): Register version style set/show commands. * cli/cli-style.h (cli_style_option): Add intensity parameter. (version_style): Declare. * top.c (print_gdb_version): Use version_stype, and styled_string to print the GDB version string. gdb/doc/ChangeLog: PR cli/25956 * gdb.texinfo (Output Styling): Document version style. gdb/testsuite/ChangeLog: PR cli/25956 * gdb.base/style.exp (run_style_tests): Add version string test. (test_startup_version_string): Use version style name. * lib/gdb-utils.exp (style): Handle version style name.
399 lines
11 KiB
C
399 lines
11 KiB
C
/* CLI colorizing
|
|
|
|
Copyright (C) 2018-2021 Free Software Foundation, Inc.
|
|
|
|
This file is part of GDB.
|
|
|
|
This program is free software; you can redistribute it and/or modify
|
|
it under the terms of the GNU General Public License as published by
|
|
the Free Software Foundation; either version 3 of the License, or
|
|
(at your option) any later version.
|
|
|
|
This program is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
GNU General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with this program. If not, see <http://www.gnu.org/licenses/>. */
|
|
|
|
#include "defs.h"
|
|
#include "cli/cli-cmds.h"
|
|
#include "cli/cli-setshow.h"
|
|
#include "cli/cli-style.h"
|
|
#include "source-cache.h"
|
|
#include "observable.h"
|
|
|
|
/* True if styling is enabled. */
|
|
|
|
#if defined (__MSDOS__)
|
|
bool cli_styling = false;
|
|
#else
|
|
bool cli_styling = true;
|
|
#endif
|
|
|
|
/* True if source styling is enabled. Note that this is only
|
|
consulted when cli_styling is true. */
|
|
|
|
bool source_styling = true;
|
|
|
|
/* Name of colors; must correspond to ui_file_style::basic_color. */
|
|
static const char * const cli_colors[] = {
|
|
"none",
|
|
"black",
|
|
"red",
|
|
"green",
|
|
"yellow",
|
|
"blue",
|
|
"magenta",
|
|
"cyan",
|
|
"white",
|
|
nullptr
|
|
};
|
|
|
|
/* Names of intensities; must correspond to
|
|
ui_file_style::intensity. */
|
|
static const char * const cli_intensities[] = {
|
|
"normal",
|
|
"bold",
|
|
"dim",
|
|
nullptr
|
|
};
|
|
|
|
/* See cli-style.h. */
|
|
|
|
cli_style_option file_name_style ("filename", ui_file_style::GREEN);
|
|
|
|
/* See cli-style.h. */
|
|
|
|
cli_style_option function_name_style ("function", ui_file_style::YELLOW);
|
|
|
|
/* See cli-style.h. */
|
|
|
|
cli_style_option variable_name_style ("variable", ui_file_style::CYAN);
|
|
|
|
/* See cli-style.h. */
|
|
|
|
cli_style_option address_style ("address", ui_file_style::BLUE);
|
|
|
|
/* See cli-style.h. */
|
|
|
|
cli_style_option highlight_style ("highlight", ui_file_style::RED);
|
|
|
|
/* See cli-style.h. */
|
|
|
|
cli_style_option title_style ("title", ui_file_style::BOLD);
|
|
|
|
/* See cli-style.h. */
|
|
|
|
cli_style_option tui_border_style ("tui-border", ui_file_style::CYAN);
|
|
|
|
/* See cli-style.h. */
|
|
|
|
cli_style_option tui_active_border_style ("tui-active-border",
|
|
ui_file_style::CYAN);
|
|
|
|
/* See cli-style.h. */
|
|
|
|
cli_style_option metadata_style ("metadata", ui_file_style::DIM);
|
|
|
|
/* See cli-style.h. */
|
|
|
|
cli_style_option version_style ("version", ui_file_style::MAGENTA,
|
|
ui_file_style::BOLD);
|
|
|
|
/* See cli-style.h. */
|
|
|
|
cli_style_option::cli_style_option (const char *name,
|
|
ui_file_style::basic_color fg,
|
|
ui_file_style::intensity intensity)
|
|
: changed (name),
|
|
m_name (name),
|
|
m_foreground (cli_colors[fg - ui_file_style::NONE]),
|
|
m_background (cli_colors[0]),
|
|
m_intensity (cli_intensities[intensity])
|
|
{
|
|
}
|
|
|
|
/* See cli-style.h. */
|
|
|
|
cli_style_option::cli_style_option (const char *name,
|
|
ui_file_style::intensity i)
|
|
: changed (name),
|
|
m_name (name),
|
|
m_foreground (cli_colors[0]),
|
|
m_background (cli_colors[0]),
|
|
m_intensity (cli_intensities[i])
|
|
{
|
|
}
|
|
|
|
/* Return the color number corresponding to COLOR. */
|
|
|
|
static int
|
|
color_number (const char *color)
|
|
{
|
|
for (int i = 0; i < ARRAY_SIZE (cli_colors); ++i)
|
|
{
|
|
if (color == cli_colors[i])
|
|
return i - 1;
|
|
}
|
|
gdb_assert_not_reached ("color not found");
|
|
}
|
|
|
|
/* See cli-style.h. */
|
|
|
|
ui_file_style
|
|
cli_style_option::style () const
|
|
{
|
|
int fg = color_number (m_foreground);
|
|
int bg = color_number (m_background);
|
|
ui_file_style::intensity intensity = ui_file_style::NORMAL;
|
|
|
|
for (int i = 0; i < ARRAY_SIZE (cli_intensities); ++i)
|
|
{
|
|
if (m_intensity == cli_intensities[i])
|
|
{
|
|
intensity = (ui_file_style::intensity) i;
|
|
break;
|
|
}
|
|
}
|
|
|
|
return ui_file_style (fg, bg, intensity);
|
|
}
|
|
|
|
/* See cli-style.h. */
|
|
|
|
void
|
|
cli_style_option::do_set_value (const char *ignore, int from_tty,
|
|
struct cmd_list_element *cmd)
|
|
{
|
|
cli_style_option *cso = (cli_style_option *) get_cmd_context (cmd);
|
|
cso->changed.notify ();
|
|
}
|
|
|
|
/* Implements the cli_style_option::do_show_* functions.
|
|
WHAT and VALUE are the property and value to show.
|
|
The style for which WHAT is shown is retrieved from CMD context. */
|
|
|
|
static void
|
|
do_show (const char *what, struct ui_file *file,
|
|
struct cmd_list_element *cmd,
|
|
const char *value)
|
|
{
|
|
cli_style_option *cso = (cli_style_option *) get_cmd_context (cmd);
|
|
fputs_filtered (_("The "), file);
|
|
fprintf_styled (file, cso->style (), _("\"%s\" style"), cso->name ());
|
|
fprintf_filtered (file, _(" %s is: %s\n"), what, value);
|
|
}
|
|
|
|
/* See cli-style.h. */
|
|
|
|
void
|
|
cli_style_option::do_show_foreground (struct ui_file *file, int from_tty,
|
|
struct cmd_list_element *cmd,
|
|
const char *value)
|
|
{
|
|
do_show (_("foreground color"), file, cmd, value);
|
|
}
|
|
|
|
/* See cli-style.h. */
|
|
|
|
void
|
|
cli_style_option::do_show_background (struct ui_file *file, int from_tty,
|
|
struct cmd_list_element *cmd,
|
|
const char *value)
|
|
{
|
|
do_show (_("background color"), file, cmd, value);
|
|
}
|
|
|
|
/* See cli-style.h. */
|
|
|
|
void
|
|
cli_style_option::do_show_intensity (struct ui_file *file, int from_tty,
|
|
struct cmd_list_element *cmd,
|
|
const char *value)
|
|
{
|
|
do_show (_("display intensity"), file, cmd, value);
|
|
}
|
|
|
|
/* See cli-style.h. */
|
|
|
|
void
|
|
cli_style_option::add_setshow_commands (enum command_class theclass,
|
|
const char *prefix_doc,
|
|
struct cmd_list_element **set_list,
|
|
struct cmd_list_element **show_list,
|
|
bool skip_intensity)
|
|
{
|
|
m_set_prefix = std::string ("set style ") + m_name + " ";
|
|
m_show_prefix = std::string ("show style ") + m_name + " ";
|
|
|
|
add_basic_prefix_cmd (m_name, no_class, prefix_doc, &m_set_list,
|
|
m_set_prefix.c_str (), 0, set_list);
|
|
add_show_prefix_cmd (m_name, no_class, prefix_doc, &m_show_list,
|
|
m_show_prefix.c_str (), 0, show_list);
|
|
|
|
add_setshow_enum_cmd ("foreground", theclass, cli_colors,
|
|
&m_foreground,
|
|
_("Set the foreground color for this property."),
|
|
_("Show the foreground color for this property."),
|
|
nullptr,
|
|
do_set_value,
|
|
do_show_foreground,
|
|
&m_set_list, &m_show_list, (void *) this);
|
|
add_setshow_enum_cmd ("background", theclass, cli_colors,
|
|
&m_background,
|
|
_("Set the background color for this property."),
|
|
_("Show the background color for this property."),
|
|
nullptr,
|
|
do_set_value,
|
|
do_show_background,
|
|
&m_set_list, &m_show_list, (void *) this);
|
|
if (!skip_intensity)
|
|
add_setshow_enum_cmd ("intensity", theclass, cli_intensities,
|
|
&m_intensity,
|
|
_("Set the display intensity for this property."),
|
|
_("Show the display intensity for this property."),
|
|
nullptr,
|
|
do_set_value,
|
|
do_show_intensity,
|
|
&m_set_list, &m_show_list, (void *) this);
|
|
}
|
|
|
|
static cmd_list_element *style_set_list;
|
|
static cmd_list_element *style_show_list;
|
|
|
|
static void
|
|
set_style_enabled (const char *args, int from_tty, struct cmd_list_element *c)
|
|
{
|
|
g_source_cache.clear ();
|
|
gdb::observers::source_styling_changed.notify ();
|
|
}
|
|
|
|
static void
|
|
show_style_enabled (struct ui_file *file, int from_tty,
|
|
struct cmd_list_element *c, const char *value)
|
|
{
|
|
if (cli_styling)
|
|
fprintf_filtered (file, _("CLI output styling is enabled.\n"));
|
|
else
|
|
fprintf_filtered (file, _("CLI output styling is disabled.\n"));
|
|
}
|
|
|
|
static void
|
|
show_style_sources (struct ui_file *file, int from_tty,
|
|
struct cmd_list_element *c, const char *value)
|
|
{
|
|
if (source_styling)
|
|
fprintf_filtered (file, _("Source code styling is enabled.\n"));
|
|
else
|
|
fprintf_filtered (file, _("Source code styling is disabled.\n"));
|
|
}
|
|
|
|
void _initialize_cli_style ();
|
|
void
|
|
_initialize_cli_style ()
|
|
{
|
|
add_basic_prefix_cmd ("style", no_class, _("\
|
|
Style-specific settings.\n\
|
|
Configure various style-related variables, such as colors"),
|
|
&style_set_list, "set style ", 0, &setlist);
|
|
add_show_prefix_cmd ("style", no_class, _("\
|
|
Style-specific settings.\n\
|
|
Configure various style-related variables, such as colors"),
|
|
&style_show_list, "show style ", 0, &showlist);
|
|
|
|
add_setshow_boolean_cmd ("enabled", no_class, &cli_styling, _("\
|
|
Set whether CLI styling is enabled."), _("\
|
|
Show whether CLI is enabled."), _("\
|
|
If enabled, output to the terminal is styled."),
|
|
set_style_enabled, show_style_enabled,
|
|
&style_set_list, &style_show_list);
|
|
|
|
add_setshow_boolean_cmd ("sources", no_class, &source_styling, _("\
|
|
Set whether source code styling is enabled."), _("\
|
|
Show whether source code styling is enabled."), _("\
|
|
If enabled, source code is styled.\n"
|
|
#ifdef HAVE_SOURCE_HIGHLIGHT
|
|
"Note that source styling only works if styling in general is enabled,\n\
|
|
see \"show style enabled\"."
|
|
#else
|
|
"Source highlighting may be disabled in this installation of gdb, because\n\
|
|
it was not linked against GNU Source Highlight. However, it might still be\n\
|
|
available if the appropriate extension is available at runtime."
|
|
#endif
|
|
), set_style_enabled, show_style_sources,
|
|
&style_set_list, &style_show_list);
|
|
|
|
file_name_style.add_setshow_commands (no_class, _("\
|
|
Filename display styling.\n\
|
|
Configure filename colors and display intensity."),
|
|
&style_set_list, &style_show_list,
|
|
false);
|
|
|
|
function_name_style.add_setshow_commands (no_class, _("\
|
|
Function name display styling.\n\
|
|
Configure function name colors and display intensity"),
|
|
&style_set_list, &style_show_list,
|
|
false);
|
|
|
|
variable_name_style.add_setshow_commands (no_class, _("\
|
|
Variable name display styling.\n\
|
|
Configure variable name colors and display intensity"),
|
|
&style_set_list, &style_show_list,
|
|
false);
|
|
|
|
address_style.add_setshow_commands (no_class, _("\
|
|
Address display styling.\n\
|
|
Configure address colors and display intensity"),
|
|
&style_set_list, &style_show_list,
|
|
false);
|
|
|
|
title_style.add_setshow_commands (no_class, _("\
|
|
Title display styling.\n\
|
|
Configure title colors and display intensity\n\
|
|
Some commands (such as \"apropos -v REGEXP\") use the title style to improve\n\
|
|
readability."),
|
|
&style_set_list, &style_show_list,
|
|
false);
|
|
|
|
highlight_style.add_setshow_commands (no_class, _("\
|
|
Highlight display styling.\n\
|
|
Configure highlight colors and display intensity\n\
|
|
Some commands use the highlight style to draw the attention to a part\n\
|
|
of their output."),
|
|
&style_set_list, &style_show_list,
|
|
false);
|
|
|
|
metadata_style.add_setshow_commands (no_class, _("\
|
|
Metadata display styling.\n\
|
|
Configure metadata colors and display intensity\n\
|
|
The \"metadata\" style is used when GDB displays information about\n\
|
|
your data, for example \"<unavailable>\""),
|
|
&style_set_list, &style_show_list,
|
|
false);
|
|
|
|
tui_border_style.add_setshow_commands (no_class, _("\
|
|
TUI border display styling.\n\
|
|
Configure TUI border colors\n\
|
|
The \"tui-border\" style is used when GDB displays the border of a\n\
|
|
TUI window that does not have the focus."),
|
|
&style_set_list, &style_show_list,
|
|
true);
|
|
|
|
tui_active_border_style.add_setshow_commands (no_class, _("\
|
|
TUI active border display styling.\n\
|
|
Configure TUI active border colors\n\
|
|
The \"tui-active-border\" style is used when GDB displays the border of a\n\
|
|
TUI window that does have the focus."),
|
|
&style_set_list,
|
|
&style_show_list,
|
|
true);
|
|
|
|
version_style.add_setshow_commands (no_class, _("\
|
|
Version string display styling.\n\
|
|
Configure colors used to display the GDB version string."),
|
|
&style_set_list, &style_show_list,
|
|
false);
|
|
}
|