3 Copyright (C) 2018-2021 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/>. */
20 #ifndef CLI_CLI_STYLE_H
21 #define CLI_CLI_STYLE_H
25 #include "gdbsupport/observable.h"
27 /* A single CLI style option. */
28 class cli_style_option
32 /* Construct a CLI style option with a foreground color. */
33 cli_style_option (const char *name
, ui_file_style::basic_color fg
,
34 ui_file_style::intensity
= ui_file_style::NORMAL
);
36 /* Construct a CLI style option with an intensity. */
37 cli_style_option (const char *name
, ui_file_style::intensity i
);
39 /* Return a ui_file_style corresponding to the settings in this CLI
41 ui_file_style
style () const;
43 /* Return the style name. */
44 const char *name () { return m_name
; };
46 /* Call once to register this CLI style with the CLI engine. */
47 void add_setshow_commands (enum command_class theclass
,
48 const char *prefix_doc
,
49 struct cmd_list_element
**set_list
,
50 struct cmd_list_element
**show_list
,
53 /* Return the 'set style NAME' command list, that can be used
54 to build a lambda DO_SET to call add_setshow_commands. */
55 struct cmd_list_element
*set_list () { return m_set_list
; };
57 /* Same as SET_LIST but for the show command list. */
58 struct cmd_list_element
*show_list () { return m_show_list
; };
60 /* This style can be observed for any changes. */
61 gdb::observers::observable
<> changed
;
69 const char *m_foreground
;
71 const char *m_background
;
73 const char *m_intensity
;
75 /* Storage for prefixes needed when registering the commands. */
76 std::string m_show_prefix
;
77 std::string m_set_prefix
;
78 /* Storage for command lists needed when registering
80 struct cmd_list_element
*m_set_list
= nullptr;
81 struct cmd_list_element
*m_show_list
= nullptr;
83 /* Callback to notify the observable. */
84 static void do_set_value (const char *ignore
, int from_tty
,
85 struct cmd_list_element
*cmd
);
87 /* Callback to show the foreground. */
88 static void do_show_foreground (struct ui_file
*file
, int from_tty
,
89 struct cmd_list_element
*cmd
,
91 /* Callback to show the background. */
92 static void do_show_background (struct ui_file
*file
, int from_tty
,
93 struct cmd_list_element
*cmd
,
95 /* Callback to show the intensity. */
96 static void do_show_intensity (struct ui_file
*file
, int from_tty
,
97 struct cmd_list_element
*cmd
,
101 /* The file name style. */
102 extern cli_style_option file_name_style
;
104 /* The function name style. */
105 extern cli_style_option function_name_style
;
107 /* The variable name style. */
108 extern cli_style_option variable_name_style
;
110 /* The address style. */
111 extern cli_style_option address_style
;
113 /* The highlight style. */
114 extern cli_style_option highlight_style
;
116 /* The title style. */
117 extern cli_style_option title_style
;
119 /* The metadata style. */
120 extern cli_style_option metadata_style
;
122 /* The border style of a TUI window that does not have the focus. */
123 extern cli_style_option tui_border_style
;
125 /* The border style of a TUI window that does have the focus. */
126 extern cli_style_option tui_active_border_style
;
128 /* The style to use for the GDB version string. */
129 extern cli_style_option version_style
;
131 /* True if source styling is enabled. */
132 extern bool source_styling
;
134 /* True if styling is enabled. */
135 extern bool cli_styling
;
137 #endif /* CLI_CLI_STYLE_H */