1 /* CLI stylizing 2 3 Copyright (C) 2018-2021 Free Software Foundation, Inc. 4 5 This file is part of GDB. 6 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. 11 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. 16 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/>. */ 19 20 #ifndef CLI_CLI_STYLE_H 21 #define CLI_CLI_STYLE_H 22 23 #include "ui-file.h" 24 #include "command.h" 25 #include "gdbsupport/observable.h" 26 27 /* A single CLI style option. */ 28 class cli_style_option 29 { 30 public: 31 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); 35 36 /* Construct a CLI style option with an intensity. */ 37 cli_style_option (const char *name, ui_file_style::intensity i); 38 39 /* Return a ui_file_style corresponding to the settings in this CLI 40 style. */ 41 ui_file_style style () const; 42 43 /* Return the style name. */ name()44 const char *name () { return m_name; }; 45 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, 51 bool skip_intensity); 52 53 /* Return the 'set style NAME' command list, that can be used 54 to build a lambda DO_SET to call add_setshow_commands. */ set_list()55 struct cmd_list_element *set_list () { return m_set_list; }; 56 57 /* Same as SET_LIST but for the show command list. */ show_list()58 struct cmd_list_element *show_list () { return m_show_list; }; 59 60 /* This style can be observed for any changes. */ 61 gdb::observers::observable<> changed; 62 63 private: 64 65 /* The style name. */ 66 const char *m_name; 67 68 /* The foreground. */ 69 const char *m_foreground; 70 /* The background. */ 71 const char *m_background; 72 /* The intensity. */ 73 const char *m_intensity; 74 75 /* Storage for command lists needed when registering 76 subcommands. */ 77 struct cmd_list_element *m_set_list = nullptr; 78 struct cmd_list_element *m_show_list = nullptr; 79 80 /* Callback to notify the observable. */ 81 static void do_set_value (const char *ignore, int from_tty, 82 struct cmd_list_element *cmd); 83 84 /* Callback to show the foreground. */ 85 static void do_show_foreground (struct ui_file *file, int from_tty, 86 struct cmd_list_element *cmd, 87 const char *value); 88 /* Callback to show the background. */ 89 static void do_show_background (struct ui_file *file, int from_tty, 90 struct cmd_list_element *cmd, 91 const char *value); 92 /* Callback to show the intensity. */ 93 static void do_show_intensity (struct ui_file *file, int from_tty, 94 struct cmd_list_element *cmd, 95 const char *value); 96 }; 97 98 /* The file name style. */ 99 extern cli_style_option file_name_style; 100 101 /* The function name style. */ 102 extern cli_style_option function_name_style; 103 104 /* The variable name style. */ 105 extern cli_style_option variable_name_style; 106 107 /* The address style. */ 108 extern cli_style_option address_style; 109 110 /* The highlight style. */ 111 extern cli_style_option highlight_style; 112 113 /* The title style. */ 114 extern cli_style_option title_style; 115 116 /* The metadata style. */ 117 extern cli_style_option metadata_style; 118 119 /* The border style of a TUI window that does not have the focus. */ 120 extern cli_style_option tui_border_style; 121 122 /* The border style of a TUI window that does have the focus. */ 123 extern cli_style_option tui_active_border_style; 124 125 /* The style to use for the GDB version string. */ 126 extern cli_style_option version_style; 127 128 /* True if source styling is enabled. */ 129 extern bool source_styling; 130 131 /* True if styling is enabled. */ 132 extern bool cli_styling; 133 134 #endif /* CLI_CLI_STYLE_H */ 135