gdb/cli/cli-style.h

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