gtk2_ardour/ui_config.h

   1 /*
   2     Copyright (C) 2000-2007 Paul Davis
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #ifndef __ardour_ui_configuration_h__
  21 #define __ardour_ui_configuration_h__
  22
  23 #include <sstream>
  24 #include <ostream>
  25 #include <iostream>
  26
  27 #include <boost/function.hpp>
  28 #include <boost/bind.hpp>
  29
  30 #include "pbd/stateful.h"
  31 #include "pbd/xml++.h"
  32 #include "ardour/configuration_variable.h"
  33
  34 #include "canvas/colors.h"
  35
  36 #include "utils.h"
  37
  38 /* This is very similar to ARDOUR::ConfigVariable but expects numeric values to
  39  * be in hexadecimal. This is because it is intended for use with color
  40  * specifications which are easier to scan for issues in "rrggbbaa" format than
  41  * as decimals.
  42  */
  43 template<class T>
  44 class ColorVariable : public ARDOUR::ConfigVariableBase
  45 {
  46     public:
  47         ColorVariable (std::string str) : ARDOUR::ConfigVariableBase (str) {}
  48         ColorVariable (std::string str, T val) : ARDOUR::ConfigVariableBase (str), value (val) {}
  49
  50         bool set (T val) {
  51                 if (val == value) {
  52                         return false;
  53                 }
  54                 value = val;
  55                 return true;
  56         }
  57
  58         T get() const {
  59                 return value;
  60         }
  61
  62         std::string get_as_string () const {
  63                 std::stringstream ss;
  64                 ss << std::hex;
  65                 ss.fill('0');
  66                 ss.width(8);
  67                 ss << value;
  68                 return ss.str ();
  69         }
  70
  71         void set_from_string (std::string const & s) {
  72                 std::stringstream ss;
  73                 ss << std::hex;
  74                 ss << s;
  75                 ss >> value;
  76         }
  77
  78   protected:
  79         T get_for_save() { return value; }
  80         T value;
  81 };
  82
  83 class UIConfiguration : public PBD::Stateful
  84 {
  85     public:
  86         struct RelativeHSV {
  87                 RelativeHSV (const std::string& b, const ArdourCanvas::HSV& mod)
  88                         : base_color (b)
  89                         , modifier (mod)
  90                         , quantized_hue (-1.0) {}
  91                 std::string base_color;
  92                 ArdourCanvas::HSV modifier;
  93                 double quantized_hue;
  94
  95                 ArdourCanvas::HSV get() const;
  96         };
  97
  98         UIConfiguration();
  99         ~UIConfiguration();
 100
 101         static UIConfiguration* instance() { return _instance; }
 102
 103         std::map<std::string,ColorVariable<ArdourCanvas::Color> *> configurable_colors;
 104
 105         bool dirty () const;
 106         void set_dirty ();
 107
 108         int load_state ();
 109         int save_state ();
 110         int load_defaults ();
 111
 112         int set_state (const XMLNode&, int version);
 113         XMLNode& get_state (void);
 114         XMLNode& get_variables (std::string);
 115         void set_variables (const XMLNode&);
 116
 117         typedef std::map<std::string,RelativeHSV> RelativeColors;
 118         typedef std::map<std::string,std::string> ColorAliases;
 119
 120         RelativeColors relative_colors;
 121         ColorAliases color_aliases;
 122
 123         void set_alias (std::string const & name, std::string const & alias);
 124
 125         void reset_relative (const std::string& name, const RelativeHSV& new_value);
 126
 127         RelativeHSV color_as_relative_hsv (ArdourCanvas::Color c);
 128         ArdourCanvas::Color quantized (ArdourCanvas::Color) const;
 129
 130         ArdourCanvas::Color base_color_by_name (const std::string&) const;
 131         ArdourCanvas::Color color (const std::string&) const;
 132         ArdourCanvas::HSV  color_hsv (const std::string&) const;
 133
 134         sigc::signal<void,std::string> ParameterChanged;
 135         void map_parameters (boost::function<void (std::string)>&);
 136
 137 #undef UI_CONFIG_VARIABLE
 138 #define UI_CONFIG_VARIABLE(Type,var,name,value) \
 139         Type get_##var () const { return var.get(); } \
 140         bool set_##var (Type val) { bool ret = var.set (val); if (ret) { ParameterChanged (name); } return ret;  }
 141 #include "ui_config_vars.h"
 142 #undef  UI_CONFIG_VARIABLE
 143 #undef CANVAS_STRING_VARIABLE
 144 #define CANVAS_STRING_VARIABLE(var,name) \
 145         std::string get_##var () const { return var.get(); }                    \
 146         bool set_##var (const std::string& val) { bool ret = var.set (val); if (ret) { ParameterChanged (name); } return ret;  }
 147 #define CANVAS_FONT_VARIABLE(var,name) \
 148         Pango::FontDescription get_##var () const { return ARDOUR_UI_UTILS::sanitized_font (var.get()); } \
 149         bool set_##var (const std::string& val) { bool ret = var.set (val); if (ret) { ParameterChanged (name); } return ret;  }
 150 #include "canvas_vars.h"
 151 #undef CANVAS_STRING_VARIABLE
 152 #undef CANVAS_FONT_VARIABLE
 153
 154 #undef CANVAS_BASE_COLOR
 155 #define CANVAS_BASE_COLOR(var,name,val) \
 156         ArdourCanvas::Color get_##var() const { return var.get(); } \
 157         bool set_##var (ArdourCanvas::Color v) { bool ret = var.set (v); if (ret) { ParameterChanged (#var); } return ret;  } \
 158         bool set_##var(const ArdourCanvas::HSV& v) const { return set_##var (v.color()); }
 159 #include "base_colors.h"
 160 #undef CANVAS_BASE_COLOR
 161
 162 #undef COLOR_ALIAS
 163 #define COLOR_ALIAS(var,name,alias) ArdourCanvas::Color get_##var() const { return color (name); }
 164 #include "color_aliases.h"
 165 #undef COLOR_ALIAS
 166
 167   private:
 168         /* declare variables */
 169
 170 #undef  UI_CONFIG_VARIABLE
 171 #define UI_CONFIG_VARIABLE(Type,var,name,value) ARDOUR::ConfigVariable<Type> var;
 172 #include "ui_config_vars.h"
 173 #undef UI_CONFIG_VARIABLE
 174
 175 #define CANVAS_STRING_VARIABLE(var,name) ARDOUR::ConfigVariable<std::string> var;
 176 #define CANVAS_FONT_VARIABLE(var,name) ARDOUR::ConfigVariable<std::string> var;
 177 #include "canvas_vars.h"
 178 #undef CANVAS_STRING_VARIABLE
 179 #undef CANVAS_FONT_VARIABLE
 180
 181         /* declare base color variables (these are modifiable by the user) */
 182
 183 #undef CANVAS_BASE_COLOR
 184 #define CANVAS_BASE_COLOR(var,name,val) ColorVariable<ArdourCanvas::Color> var;
 185 #include "base_colors.h"
 186 #undef CANVAS_BASE_COLOR
 187
 188         XMLNode& state ();
 189         bool _dirty;
 190         static UIConfiguration* _instance;
 191
 192         void color_theme_changed ();
 193 };
 194
 195 #endif /* __ardour_ui_configuration_h__ */
 196