gdb/cli/cli-style.h

   1 /* CLI stylizing
   2
   3    Copyright (C) 2018-2019 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
  25 /* A single CLI style option.  */
  26 class cli_style_option
  27 {
  28 public:
  29
  30   /* Construct a CLI style option with a foreground color.  */
  31   cli_style_option (const char *name, ui_file_style::basic_color fg);
  32
  33   /* Construct a CLI style option with an intensity.  */
  34   cli_style_option (const char *name, ui_file_style::intensity i);
  35
  36   /* Return a ui_file_style corresponding to the settings in this CLI
  37      style.  */
  38   ui_file_style style () const;
  39
  40   /* Return the style name.  */
  41   const char *name () { return m_name; };
  42
  43   /* Call once to register this CLI style with the CLI engine.  */
  44   void add_setshow_commands (enum command_class theclass,
  45                              const char *prefix_doc,
  46                              struct cmd_list_element **set_list,
  47                              void (*do_set) (const char *args, int from_tty),
  48                              struct cmd_list_element **show_list,
  49                              void (*do_show) (const char *args, int from_tty));
  50
  51   /* Return the 'set style NAME' command list, that can be used
  52      to build a lambda DO_SET to call add_setshow_commands.  */
  53   struct cmd_list_element *set_list () { return m_set_list; };
  54
  55   /* Same as SET_LIST but for the show command list.  */
  56   struct cmd_list_element *show_list () { return m_show_list; };
  57
  58 private:
  59
  60   /* The style name.  */
  61   const char *m_name;
  62
  63   /* The foreground.  */
  64   const char *m_foreground;
  65   /* The background.  */
  66   const char *m_background;
  67   /* The intensity.  */
  68   const char *m_intensity;
  69
  70   /* Storage for prefixes needed when registering the commands.  */
  71   std::string m_show_prefix;
  72   std::string m_set_prefix;
  73   /* Storage for command lists needed when registering
  74      subcommands.  */
  75   struct cmd_list_element *m_set_list = nullptr;
  76   struct cmd_list_element *m_show_list = nullptr;
  77
  78   /* Callback to show the foreground.  */
  79   static void do_show_foreground (struct ui_file *file, int from_tty,
  80                                   struct cmd_list_element *cmd,
  81                                   const char *value);
  82   /* Callback to show the background.  */
  83   static void do_show_background (struct ui_file *file, int from_tty,
  84                                   struct cmd_list_element *cmd,
  85                                   const char *value);
  86   /* Callback to show the intensity.  */
  87   static void do_show_intensity (struct ui_file *file, int from_tty,
  88                                  struct cmd_list_element *cmd,
  89                                  const char *value);
  90 };
  91
  92 /* The file name style.  */
  93 extern cli_style_option file_name_style;
  94
  95 /* The function name style.  */
  96 extern cli_style_option function_name_style;
  97
  98 /* The variable name style.  */
  99 extern cli_style_option variable_name_style;
 100
 101 /* The address style.  */
 102 extern cli_style_option address_style;
 103
 104 /* The highlight style.  */
 105 extern cli_style_option highlight_style;
 106
 107 /* The title style.  */
 108 extern cli_style_option title_style;
 109
 110
 111 /* True if source styling is enabled.  */
 112 extern int source_styling;
 113
 114 /* True if styling is enabled.  */
 115 extern int cli_styling;
 116
 117 #endif /* CLI_CLI_STYLE_H */