]>
git.ipfire.org Git - thirdparty/binutils-gdb.git/blob - gdb/cli/cli-style.c
3 Copyright (C) 2018-2019 Free Software Foundation, Inc.
5 This file is part of GDB.
7 This program is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
21 #include "cli/cli-cmds.h"
22 #include "cli/cli-style.h"
23 #include "source-cache.h"
24 #include "observable.h"
26 /* True if styling is enabled. */
28 #if defined (__MSDOS__) || defined (__CYGWIN__)
29 bool cli_styling
= false;
31 bool cli_styling
= true;
34 /* True if source styling is enabled. Note that this is only
35 consulted when cli_styling is true. */
37 bool source_styling
= true;
39 /* Name of colors; must correspond to ui_file_style::basic_color. */
40 static const char * const cli_colors
[] = {
53 /* Names of intensities; must correspond to
54 ui_file_style::intensity. */
55 static const char * const cli_intensities
[] = {
62 /* See cli-style.h. */
64 cli_style_option
file_name_style ("filename", ui_file_style::GREEN
);
66 /* See cli-style.h. */
68 cli_style_option
function_name_style ("function", ui_file_style::YELLOW
);
70 /* See cli-style.h. */
72 cli_style_option
variable_name_style ("variable", ui_file_style::CYAN
);
74 /* See cli-style.h. */
76 cli_style_option
address_style ("address", ui_file_style::BLUE
);
78 /* See cli-style.h. */
80 cli_style_option
highlight_style ("highlight", ui_file_style::RED
);
82 /* See cli-style.h. */
84 cli_style_option
title_style ("title", ui_file_style::BOLD
);
86 /* See cli-style.h. */
88 cli_style_option::cli_style_option (const char *name
,
89 ui_file_style::basic_color fg
)
91 m_foreground (cli_colors
[fg
- ui_file_style::NONE
]),
92 m_background (cli_colors
[0]),
93 m_intensity (cli_intensities
[ui_file_style::NORMAL
])
97 /* See cli-style.h. */
99 cli_style_option::cli_style_option (const char *name
,
100 ui_file_style::intensity i
)
102 m_foreground (cli_colors
[0]),
103 m_background (cli_colors
[0]),
104 m_intensity (cli_intensities
[i
])
108 /* Return the color number corresponding to COLOR. */
111 color_number (const char *color
)
113 for (int i
= 0; i
< ARRAY_SIZE (cli_colors
); ++i
)
115 if (color
== cli_colors
[i
])
118 gdb_assert_not_reached ("color not found");
121 /* See cli-style.h. */
124 cli_style_option::style () const
126 int fg
= color_number (m_foreground
);
127 int bg
= color_number (m_background
);
128 ui_file_style::intensity intensity
= ui_file_style::NORMAL
;
130 for (int i
= 0; i
< ARRAY_SIZE (cli_intensities
); ++i
)
132 if (m_intensity
== cli_intensities
[i
])
134 intensity
= (ui_file_style::intensity
) i
;
139 return ui_file_style (fg
, bg
, intensity
);
142 /* Implements the cli_style_option::do_show_* functions.
143 WHAT and VALUE are the property and value to show.
144 The style for which WHAT is shown is retrieved from CMD context. */
147 do_show (const char *what
, struct ui_file
*file
,
148 struct cmd_list_element
*cmd
,
151 cli_style_option
*cso
= (cli_style_option
*) get_cmd_context (cmd
);
152 fputs_filtered (_("The "), file
);
153 fprintf_styled (file
, cso
->style (), _("\"%s\" style"), cso
->name ());
154 fprintf_filtered (file
, _(" %s is: %s\n"), what
, value
);
157 /* See cli-style.h. */
160 cli_style_option::do_show_foreground (struct ui_file
*file
, int from_tty
,
161 struct cmd_list_element
*cmd
,
164 do_show (_("foreground color"), file
, cmd
, value
);
167 /* See cli-style.h. */
170 cli_style_option::do_show_background (struct ui_file
*file
, int from_tty
,
171 struct cmd_list_element
*cmd
,
174 do_show (_("background color"), file
, cmd
, value
);
177 /* See cli-style.h. */
180 cli_style_option::do_show_intensity (struct ui_file
*file
, int from_tty
,
181 struct cmd_list_element
*cmd
,
184 do_show (_("display intensity"), file
, cmd
, value
);
187 /* See cli-style.h. */
190 cli_style_option::add_setshow_commands (enum command_class theclass
,
191 const char *prefix_doc
,
192 struct cmd_list_element
**set_list
,
193 void (*do_set
) (const char *args
,
195 struct cmd_list_element
**show_list
,
196 void (*do_show
) (const char *args
,
199 m_set_prefix
= std::string ("set style ") + m_name
+ " ";
200 m_show_prefix
= std::string ("show style ") + m_name
+ " ";
202 add_prefix_cmd (m_name
, no_class
, do_set
, prefix_doc
, &m_set_list
,
203 m_set_prefix
.c_str (), 0, set_list
);
204 add_prefix_cmd (m_name
, no_class
, do_show
, prefix_doc
, &m_show_list
,
205 m_show_prefix
.c_str (), 0, show_list
);
207 add_setshow_enum_cmd ("foreground", theclass
, cli_colors
,
209 _("Set the foreground color for this property."),
210 _("Show the foreground color for this property."),
214 &m_set_list
, &m_show_list
, (void *) this);
215 add_setshow_enum_cmd ("background", theclass
, cli_colors
,
217 _("Set the background color for this property."),
218 _("Show the background color for this property."),
222 &m_set_list
, &m_show_list
, (void *) this);
223 add_setshow_enum_cmd ("intensity", theclass
, cli_intensities
,
225 _("Set the display intensity for this property."),
226 _("Show the display intensity for this property."),
230 &m_set_list
, &m_show_list
, (void *) this);
233 static cmd_list_element
*style_set_list
;
234 static cmd_list_element
*style_show_list
;
237 set_style (const char *arg
, int from_tty
)
239 printf_unfiltered (_("\"set style\" must be followed "
240 "by an appropriate subcommand.\n"));
241 help_list (style_set_list
, "set style ", all_commands
, gdb_stdout
);
245 show_style (const char *arg
, int from_tty
)
247 cmd_show_list (style_show_list
, from_tty
, "");
251 set_style_enabled (const char *args
, int from_tty
, struct cmd_list_element
*c
)
253 g_source_cache
.clear ();
254 gdb::observers::source_styling_changed
.notify ();
258 show_style_enabled (struct ui_file
*file
, int from_tty
,
259 struct cmd_list_element
*c
, const char *value
)
262 fprintf_filtered (file
, _("CLI output styling is enabled.\n"));
264 fprintf_filtered (file
, _("CLI output styling is disabled.\n"));
268 show_style_sources (struct ui_file
*file
, int from_tty
,
269 struct cmd_list_element
*c
, const char *value
)
272 fprintf_filtered (file
, _("Source code styling is enabled.\n"));
274 fprintf_filtered (file
, _("Source code styling is disabled.\n"));
277 /* Builds the "set style NAME " prefix. */
280 set_style_name (const char *name
)
282 std::string
result ("set style ");
290 _initialize_cli_style ()
292 add_prefix_cmd ("style", no_class
, set_style
, _("\
293 Style-specific settings.\n\
294 Configure various style-related variables, such as colors"),
295 &style_set_list
, "set style ", 0, &setlist
);
296 add_prefix_cmd ("style", no_class
, show_style
, _("\
297 Style-specific settings.\n\
298 Configure various style-related variables, such as colors"),
299 &style_show_list
, "show style ", 0, &showlist
);
301 add_setshow_boolean_cmd ("enabled", no_class
, &cli_styling
, _("\
302 Set whether CLI styling is enabled."), _("\
303 Show whether CLI is enabled."), _("\
304 If enabled, output to the terminal is styled."),
305 set_style_enabled
, show_style_enabled
,
306 &style_set_list
, &style_show_list
);
308 add_setshow_boolean_cmd ("sources", no_class
, &source_styling
, _("\
309 Set whether source code styling is enabled."), _("\
310 Show whether source code styling is enabled."), _("\
311 If enabled, source code is styled.\n"
312 #ifdef HAVE_SOURCE_HIGHLIGHT
313 "Note that source styling only works if styling in general is enabled,\n\
314 see \"show style enabled\"."
316 "Source highlighting is disabled in this installation of gdb, because\n\
317 it was not linked against GNU Source Highlight."
319 ), set_style_enabled
, show_style_sources
,
320 &style_set_list
, &style_show_list
);
322 #define STYLE_ADD_SETSHOW_COMMANDS(STYLE, PREFIX_DOC) \
323 STYLE.add_setshow_commands (no_class, PREFIX_DOC, \
325 [] (const char *args, int from_tty) \
328 (STYLE.set_list (), \
329 set_style_name (STYLE.name ()).c_str (), \
334 [] (const char *args, int from_tty) \
337 (STYLE.show_list (), \
342 STYLE_ADD_SETSHOW_COMMANDS (file_name_style
,
344 Filename display styling.\n\
345 Configure filename colors and display intensity."));
347 STYLE_ADD_SETSHOW_COMMANDS (function_name_style
,
349 Function name display styling.\n\
350 Configure function name colors and display intensity"));
352 STYLE_ADD_SETSHOW_COMMANDS (variable_name_style
,
354 Variable name display styling.\n\
355 Configure variable name colors and display intensity"));
357 STYLE_ADD_SETSHOW_COMMANDS (address_style
,
359 Address display styling.\n\
360 Configure address colors and display intensity"));
362 STYLE_ADD_SETSHOW_COMMANDS (title_style
,
364 Title display styling.\n\
365 Configure title colors and display intensity\n\
366 Some commands (such as \"apropos -v REGEXP\") use the title style to improve\n\
369 STYLE_ADD_SETSHOW_COMMANDS (highlight_style
,
371 Highlight display styling.\n\
372 Configure highlight colors and display intensity\n\
373 Some commands use the highlight style to draw the attention to a part\n\