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
metadata_style ("metadata", ui_file_style::DIM
);
90 /* See cli-style.h. */
92 cli_style_option::cli_style_option (const char *name
,
93 ui_file_style::basic_color fg
)
95 m_foreground (cli_colors
[fg
- ui_file_style::NONE
]),
96 m_background (cli_colors
[0]),
97 m_intensity (cli_intensities
[ui_file_style::NORMAL
])
101 /* See cli-style.h. */
103 cli_style_option::cli_style_option (const char *name
,
104 ui_file_style::intensity i
)
106 m_foreground (cli_colors
[0]),
107 m_background (cli_colors
[0]),
108 m_intensity (cli_intensities
[i
])
112 /* Return the color number corresponding to COLOR. */
115 color_number (const char *color
)
117 for (int i
= 0; i
< ARRAY_SIZE (cli_colors
); ++i
)
119 if (color
== cli_colors
[i
])
122 gdb_assert_not_reached ("color not found");
125 /* See cli-style.h. */
128 cli_style_option::style () const
130 int fg
= color_number (m_foreground
);
131 int bg
= color_number (m_background
);
132 ui_file_style::intensity intensity
= ui_file_style::NORMAL
;
134 for (int i
= 0; i
< ARRAY_SIZE (cli_intensities
); ++i
)
136 if (m_intensity
== cli_intensities
[i
])
138 intensity
= (ui_file_style::intensity
) i
;
143 return ui_file_style (fg
, bg
, intensity
);
146 /* Implements the cli_style_option::do_show_* functions.
147 WHAT and VALUE are the property and value to show.
148 The style for which WHAT is shown is retrieved from CMD context. */
151 do_show (const char *what
, struct ui_file
*file
,
152 struct cmd_list_element
*cmd
,
155 cli_style_option
*cso
= (cli_style_option
*) get_cmd_context (cmd
);
156 fputs_filtered (_("The "), file
);
157 fprintf_styled (file
, cso
->style (), _("\"%s\" style"), cso
->name ());
158 fprintf_filtered (file
, _(" %s is: %s\n"), what
, value
);
161 /* See cli-style.h. */
164 cli_style_option::do_show_foreground (struct ui_file
*file
, int from_tty
,
165 struct cmd_list_element
*cmd
,
168 do_show (_("foreground color"), file
, cmd
, value
);
171 /* See cli-style.h. */
174 cli_style_option::do_show_background (struct ui_file
*file
, int from_tty
,
175 struct cmd_list_element
*cmd
,
178 do_show (_("background color"), file
, cmd
, value
);
181 /* See cli-style.h. */
184 cli_style_option::do_show_intensity (struct ui_file
*file
, int from_tty
,
185 struct cmd_list_element
*cmd
,
188 do_show (_("display intensity"), file
, cmd
, value
);
191 /* See cli-style.h. */
194 cli_style_option::add_setshow_commands (enum command_class theclass
,
195 const char *prefix_doc
,
196 struct cmd_list_element
**set_list
,
197 void (*do_set
) (const char *args
,
199 struct cmd_list_element
**show_list
,
200 void (*do_show
) (const char *args
,
203 m_set_prefix
= std::string ("set style ") + m_name
+ " ";
204 m_show_prefix
= std::string ("show style ") + m_name
+ " ";
206 add_prefix_cmd (m_name
, no_class
, do_set
, prefix_doc
, &m_set_list
,
207 m_set_prefix
.c_str (), 0, set_list
);
208 add_prefix_cmd (m_name
, no_class
, do_show
, prefix_doc
, &m_show_list
,
209 m_show_prefix
.c_str (), 0, show_list
);
211 add_setshow_enum_cmd ("foreground", theclass
, cli_colors
,
213 _("Set the foreground color for this property."),
214 _("Show the foreground color for this property."),
218 &m_set_list
, &m_show_list
, (void *) this);
219 add_setshow_enum_cmd ("background", theclass
, cli_colors
,
221 _("Set the background color for this property."),
222 _("Show the background color for this property."),
226 &m_set_list
, &m_show_list
, (void *) this);
227 add_setshow_enum_cmd ("intensity", theclass
, cli_intensities
,
229 _("Set the display intensity for this property."),
230 _("Show the display intensity for this property."),
234 &m_set_list
, &m_show_list
, (void *) this);
237 static cmd_list_element
*style_set_list
;
238 static cmd_list_element
*style_show_list
;
241 set_style (const char *arg
, int from_tty
)
243 printf_unfiltered (_("\"set style\" must be followed "
244 "by an appropriate subcommand.\n"));
245 help_list (style_set_list
, "set style ", all_commands
, gdb_stdout
);
249 show_style (const char *arg
, int from_tty
)
251 cmd_show_list (style_show_list
, from_tty
, "");
255 set_style_enabled (const char *args
, int from_tty
, struct cmd_list_element
*c
)
257 g_source_cache
.clear ();
258 gdb::observers::source_styling_changed
.notify ();
262 show_style_enabled (struct ui_file
*file
, int from_tty
,
263 struct cmd_list_element
*c
, const char *value
)
266 fprintf_filtered (file
, _("CLI output styling is enabled.\n"));
268 fprintf_filtered (file
, _("CLI output styling is disabled.\n"));
272 show_style_sources (struct ui_file
*file
, int from_tty
,
273 struct cmd_list_element
*c
, const char *value
)
276 fprintf_filtered (file
, _("Source code styling is enabled.\n"));
278 fprintf_filtered (file
, _("Source code styling is disabled.\n"));
281 /* Builds the "set style NAME " prefix. */
284 set_style_name (const char *name
)
286 std::string
result ("set style ");
294 _initialize_cli_style ()
296 add_prefix_cmd ("style", no_class
, set_style
, _("\
297 Style-specific settings.\n\
298 Configure various style-related variables, such as colors"),
299 &style_set_list
, "set style ", 0, &setlist
);
300 add_prefix_cmd ("style", no_class
, show_style
, _("\
301 Style-specific settings.\n\
302 Configure various style-related variables, such as colors"),
303 &style_show_list
, "show style ", 0, &showlist
);
305 add_setshow_boolean_cmd ("enabled", no_class
, &cli_styling
, _("\
306 Set whether CLI styling is enabled."), _("\
307 Show whether CLI is enabled."), _("\
308 If enabled, output to the terminal is styled."),
309 set_style_enabled
, show_style_enabled
,
310 &style_set_list
, &style_show_list
);
312 add_setshow_boolean_cmd ("sources", no_class
, &source_styling
, _("\
313 Set whether source code styling is enabled."), _("\
314 Show whether source code styling is enabled."), _("\
315 If enabled, source code is styled.\n"
316 #ifdef HAVE_SOURCE_HIGHLIGHT
317 "Note that source styling only works if styling in general is enabled,\n\
318 see \"show style enabled\"."
320 "Source highlighting is disabled in this installation of gdb, because\n\
321 it was not linked against GNU Source Highlight."
323 ), set_style_enabled
, show_style_sources
,
324 &style_set_list
, &style_show_list
);
326 #define STYLE_ADD_SETSHOW_COMMANDS(STYLE, PREFIX_DOC) \
327 STYLE.add_setshow_commands (no_class, PREFIX_DOC, \
329 [] (const char *args, int from_tty) \
332 (STYLE.set_list (), \
333 set_style_name (STYLE.name ()).c_str (), \
338 [] (const char *args, int from_tty) \
341 (STYLE.show_list (), \
346 STYLE_ADD_SETSHOW_COMMANDS (file_name_style
,
348 Filename display styling.\n\
349 Configure filename colors and display intensity."));
351 STYLE_ADD_SETSHOW_COMMANDS (function_name_style
,
353 Function name display styling.\n\
354 Configure function name colors and display intensity"));
356 STYLE_ADD_SETSHOW_COMMANDS (variable_name_style
,
358 Variable name display styling.\n\
359 Configure variable name colors and display intensity"));
361 STYLE_ADD_SETSHOW_COMMANDS (address_style
,
363 Address display styling.\n\
364 Configure address colors and display intensity"));
366 STYLE_ADD_SETSHOW_COMMANDS (title_style
,
368 Title display styling.\n\
369 Configure title colors and display intensity\n\
370 Some commands (such as \"apropos -v REGEXP\") use the title style to improve\n\
373 STYLE_ADD_SETSHOW_COMMANDS (highlight_style
,
375 Highlight display styling.\n\
376 Configure highlight colors and display intensity\n\
377 Some commands use the highlight style to draw the attention to a part\n\
380 STYLE_ADD_SETSHOW_COMMANDS (metadata_style
,
382 Metadata display styling\n\
383 Configure metadata colors and display intensity\n\
384 The \"metadata\" style is used when GDB displays information about\n\
385 your data, for example \"<unavailable>\""));
This page took 0.059536 seconds and 5 git commands to generate.