2 Copyright (C) 1999-2014 Paul Davis
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.
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.
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.
20 #if !defined USE_CAIRO_IMAGE_SURFACE && !defined NDEBUG
21 #define OPTIONAL_CAIRO_IMAGE_SURFACE
28 #include <cstdio> /* for snprintf, grrr */
30 #include <cairo/cairo.h>
32 #include <pango/pangoft2.h> // for fontmap resolution control for GnomeCanvas
33 #include <pango/pangocairo.h> // for fontmap resolution control for GnomeCanvas
35 #include <glibmm/miscutils.h>
37 #include <gtkmm/settings.h>
39 #include "pbd/convert.h"
40 #include "pbd/error.h"
41 #include "pbd/failed_constructor.h"
42 #include "pbd/file_utils.h"
43 #include "pbd/gstdio_compat.h"
44 #include "pbd/locale_guard.h"
45 #include "pbd/unwind.h"
46 #include "pbd/xml++.h"
48 #include "ardour/filesystem_paths.h"
49 #include "ardour/search_paths.h"
50 #include "ardour/revision.h"
51 #include "ardour/utils.h"
53 #include "gtkmm2ext/rgb_macros.h"
54 #include "gtkmm2ext/gtk_ui.h"
56 #include "ui_config.h"
62 using namespace ARDOUR;
63 using namespace ArdourCanvas;
65 static const char* ui_config_file_name = "ui_config";
66 static const char* default_ui_config_file_name = "default_ui_config";
68 static const double hue_width = 18.0;
69 std::string UIConfiguration::color_file_suffix = X_(".colors");
72 UIConfiguration::instance ()
74 static UIConfiguration s_instance;
78 UIConfiguration::UIConfiguration ()
80 #undef UI_CONFIG_VARIABLE
81 #define UI_CONFIG_VARIABLE(Type,var,name,val) var (name,val),
82 #define CANVAS_FONT_VARIABLE(var,name) var (name),
83 #include "ui_config_vars.h"
84 #include "canvas_vars.h"
85 #undef UI_CONFIG_VARIABLE
86 #undef CANVAS_FONT_VARIABLE
89 aliases_modified (false),
90 colors_modified (false),
91 modifiers_modified (false),
96 ColorsChanged.connect (boost::bind (&UIConfiguration::colors_changed, this));
98 ParameterChanged.connect (sigc::mem_fun (*this, &UIConfiguration::parameter_changed));
101 UIConfiguration::~UIConfiguration ()
106 UIConfiguration::colors_changed ()
110 /* In theory, one of these ought to work:
112 gtk_rc_reparse_all_for_settings (gtk_settings_get_default(), true);
113 gtk_rc_reset_styles (gtk_settings_get_default());
115 but in practice, neither of them do. So just reload the current
116 GTK RC file, which causes a reset of all styles and a redraw
119 parameter_changed ("ui-rc-file");
123 UIConfiguration::parameter_changed (string param)
127 if (param == "ui-rc-file") {
129 } else if (param == "color-file") {
130 load_color_theme (true);
137 UIConfiguration::reset_gtk_theme ()
142 ss << "gtk_color_scheme = \"" << hex;
144 for (ColorAliases::iterator g = color_aliases.begin(); g != color_aliases.end(); ++g) {
146 if (g->first.find ("gtk_") == 0) {
147 const string gtk_name = g->first.substr (4);
148 ss << gtk_name << ":#" << std::setw (6) << setfill ('0') << (color (g->second) >> 8) << ';';
152 ss << '"' << dec << endl;
154 /* reset GTK color scheme */
156 Gtk::Settings::get_default()->property_gtk_color_scheme() = ss.str();
160 UIConfiguration::reset_dpi ()
162 long val = get_font_scale();
164 /* FT2 rendering - used by GnomeCanvas, sigh */
166 #ifndef PLATFORM_WINDOWS
167 pango_ft2_font_map_set_resolution ((PangoFT2FontMap*) pango_ft2_font_map_new(), val/1024, val/1024); // XXX pango_ft2_font_map_new leaks
170 /* Cairo rendering, in case there is any */
172 pango_cairo_font_map_set_resolution ((PangoCairoFontMap*) pango_cairo_font_map_get_default(), val/1024);
176 gtk_settings_set_long_property (gtk_settings_get_default(),
177 "gtk-xft-dpi", val, "ardour");
178 DPIReset(); //Emit Signal
182 UIConfiguration::get_ui_scale ()
184 return get_font_scale () / 102400.;
188 UIConfiguration::map_parameters (boost::function<void (std::string)>& functor)
190 #undef UI_CONFIG_VARIABLE
191 #define UI_CONFIG_VARIABLE(Type,var,Name,value) functor (Name);
192 #include "ui_config_vars.h"
193 #undef UI_CONFIG_VARIABLE
197 UIConfiguration::pre_gui_init ()
199 #ifdef CAIRO_SUPPORTS_FORCE_BUGGY_GRADIENTS_ENVIRONMENT_VARIABLE
200 if (get_buggy_gradients()) {
201 g_setenv ("FORCE_BUGGY_GRADIENTS", "1", 1);
204 #ifdef OPTIONAL_CAIRO_IMAGE_SURFACE
205 if (get_cairo_image_surface()) {
206 g_setenv ("ARDOUR_IMAGE_SURFACE", "1", 1);
213 UIConfiguration::post_gui_init ()
215 load_color_theme (true);
220 UIConfiguration::load_defaults ()
225 if (find_file (ardour_config_search_path(), default_ui_config_file_name, rcfile) ) {
228 info << string_compose (_("Loading default ui configuration file %1"), rcfile) << endmsg;
230 if (!tree.read (rcfile.c_str())) {
231 error << string_compose(_("cannot read default ui configuration file \"%1\""), rcfile) << endmsg;
233 if (set_state (*tree.root(), Stateful::loading_state_version)) {
234 error << string_compose(_("default ui configuration file \"%1\" not loaded successfully."), rcfile) << endmsg;
242 warning << string_compose (_("Could not find default UI configuration file %1"), default_ui_config_file_name) << endmsg;
247 /* reload color theme */
248 load_color_theme (false);
255 UIConfiguration::color_file_name (bool use_my, bool with_version) const
263 std::string color_name = color_file.get();
264 size_t sep = color_name.find_first_of("-");
265 if (sep != string::npos) {
266 color_name = color_name.substr (0, sep);
269 basename += color_name;
271 basename += downcase(std::string(PROGRAM_NAME));
273 std::string rev (revision);
274 std::size_t pos = rev.find_first_of("-");
276 if (with_version && pos != string::npos && pos > 0) {
278 basename += rev.substr (0, pos); // COLORFILE_VERSION - program major.minor
281 basename += color_file_suffix;
286 UIConfiguration::load_color_file (string const & path)
290 info << string_compose (_("Loading color file %1"), path) << endmsg;
292 if (!tree.read (path.c_str())) {
293 error << string_compose(_("cannot read color file \"%1\""), path) << endmsg;
297 if (set_state (*tree.root(), Stateful::loading_state_version)) {
298 error << string_compose(_("color file \"%1\" not loaded successfully."), path) << endmsg;
306 UIConfiguration::load_color_theme (bool allow_own)
310 /* ColorsChanged() will trigger a parameter_changed () which
311 * in turn calls save_state()
313 PBD::Unwinder<uint32_t> uw (block_save, block_save + 1);
315 if (find_file (theme_search_path(), color_file_name (false, true), cfile)) {
320 if (find_file (theme_search_path(), color_file_name (false, false), cfile)) {
326 warning << string_compose (_("Color file for %1 not found along %2"), color_file.get(), theme_search_path().to_string()) << endmsg;
330 (void) load_color_file (cfile);
336 PBD::Searchpath sp (user_config_directory());
338 /* user's own color files never have the program name in them */
340 if (find_file (sp, color_file_name (true, true), cfile)) {
345 if (find_file (sp, color_file_name (true, false), cfile)) {
351 (void) load_color_file (cfile);
362 UIConfiguration::store_color_theme ()
367 root = new XMLNode("Ardour");
369 XMLNode* parent = new XMLNode (X_("Colors"));
370 for (Colors::const_iterator i = colors.begin(); i != colors.end(); ++i) {
371 XMLNode* node = new XMLNode (X_("Color"));
372 node->add_property (X_("name"), i->first);
374 ss << "0x" << setw (8) << setfill ('0') << hex << i->second;
375 node->add_property (X_("value"), ss.str());
376 parent->add_child_nocopy (*node);
378 root->add_child_nocopy (*parent);
380 parent = new XMLNode (X_("ColorAliases"));
381 for (ColorAliases::const_iterator i = color_aliases.begin(); i != color_aliases.end(); ++i) {
382 XMLNode* node = new XMLNode (X_("ColorAlias"));
383 node->add_property (X_("name"), i->first);
384 node->add_property (X_("alias"), i->second);
385 parent->add_child_nocopy (*node);
387 root->add_child_nocopy (*parent);
389 parent = new XMLNode (X_("Modifiers"));
390 for (Modifiers::const_iterator i = modifiers.begin(); i != modifiers.end(); ++i) {
391 XMLNode* node = new XMLNode (X_("Modifier"));
392 node->add_property (X_("name"), i->first);
393 node->add_property (X_("modifier"), i->second.to_string());
394 parent->add_child_nocopy (*node);
396 root->add_child_nocopy (*parent);
399 std::string colorfile = Glib::build_filename (user_config_directory(), color_file_name (true, true));;
401 tree.set_root (root);
403 if (!tree.write (colorfile.c_str())){
404 error << string_compose (_("Color file %1 not saved"), colorfile) << endmsg;
412 UIConfiguration::load_state ()
414 LocaleGuard lg; // a single guard for all 3 configs
419 if (find_file (ardour_config_search_path(), default_ui_config_file_name, rcfile)) {
423 info << string_compose (_("Loading default ui configuration file %1"), rcfile) << endmsg;
425 if (!tree.read (rcfile.c_str())) {
426 error << string_compose(_("cannot read default ui configuration file \"%1\""), rcfile) << endmsg;
430 if (set_state (*tree.root(), Stateful::loading_state_version)) {
431 error << string_compose(_("default ui configuration file \"%1\" not loaded successfully."), rcfile) << endmsg;
436 if (find_file (ardour_config_search_path(), ui_config_file_name, rcfile)) {
440 info << string_compose (_("Loading user ui configuration file %1"), rcfile) << endmsg;
442 if (!tree.read (rcfile)) {
443 error << string_compose(_("cannot read ui configuration file \"%1\""), rcfile) << endmsg;
447 if (set_state (*tree.root(), Stateful::loading_state_version)) {
448 error << string_compose(_("user ui configuration file \"%1\" not loaded successfully."), rcfile) << endmsg;
456 error << _("could not find any ui configuration file, canvas will look broken.") << endmsg;
463 UIConfiguration::save_state()
465 if (block_save != 0) {
470 std::string rcfile = Glib::build_filename (user_config_directory(), ui_config_file_name);
474 tree.set_root (&get_state());
476 if (!tree.write (rcfile.c_str())){
477 error << string_compose (_("Config file %1 not saved"), rcfile) << endmsg;
484 if (aliases_modified || colors_modified || modifiers_modified) {
486 if (store_color_theme ()) {
487 error << string_compose (_("Color file %1 not saved"), color_file.get()) << endmsg;
491 aliases_modified = false;
492 colors_modified = false;
493 modifiers_modified = false;
501 UIConfiguration::get_state ()
506 root = new XMLNode("Ardour");
508 root->add_child_nocopy (get_variables ("UI"));
509 root->add_child_nocopy (get_variables ("Canvas"));
512 root->add_child_copy (*_extra_xml);
519 UIConfiguration::get_variables (std::string which_node)
524 node = new XMLNode (which_node);
526 #undef UI_CONFIG_VARIABLE
527 #undef CANVAS_FONT_VARIABLE
528 #define UI_CONFIG_VARIABLE(Type,var,Name,value) if (node->name() == "UI") { var.add_to_node (*node); }
529 #define CANVAS_FONT_VARIABLE(var,Name) if (node->name() == "Canvas") { var.add_to_node (*node); }
530 #include "ui_config_vars.h"
531 #include "canvas_vars.h"
532 #undef UI_CONFIG_VARIABLE
533 #undef CANVAS_FONT_VARIABLE
539 UIConfiguration::set_state (const XMLNode& root, int /*version*/)
542 /* this can load a generic UI configuration file or a colors file */
544 if (root.name() != "Ardour") {
548 Stateful::save_extra_xml (root);
550 XMLNodeList nlist = root.children();
551 XMLNodeConstIterator niter;
554 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
558 if (node->name() == "Canvas" || node->name() == "UI") {
559 set_variables (*node);
564 XMLNode* colors = find_named_node (root, X_("Colors"));
567 load_colors (*colors);
570 XMLNode* aliases = find_named_node (root, X_("ColorAliases"));
573 load_color_aliases (*aliases);
576 XMLNode* modifiers = find_named_node (root, X_("Modifiers"));
579 load_modifiers (*modifiers);
586 UIConfiguration::load_color_aliases (XMLNode const & node)
588 XMLNodeList const nlist = node.children();
589 XMLNodeConstIterator niter;
590 XMLProperty const *name;
591 XMLProperty const *alias;
593 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
594 XMLNode const * child = *niter;
595 if (child->name() != X_("ColorAlias")) {
598 name = child->property (X_("name"));
599 alias = child->property (X_("alias"));
602 color_aliases[name->value()] = alias->value();
608 UIConfiguration::load_colors (XMLNode const & node)
610 XMLNodeList const nlist = node.children();
611 XMLNodeConstIterator niter;
612 XMLProperty const *name;
613 XMLProperty const *color;
615 /* don't clear colors, so that we can load > 1 color file and have
616 the subsequent ones overwrite the later ones.
619 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
620 XMLNode const * child = *niter;
621 if (child->name() != X_("Color")) {
624 name = child->property (X_("name"));
625 color = child->property (X_("value"));
628 ArdourCanvas::Color c;
629 c = strtoul (color->value().c_str(), 0, 16);
630 /* insert or replace color name definition */
631 colors[name->value()] = c;
637 UIConfiguration::load_modifiers (XMLNode const & node)
640 XMLNodeList const nlist = node.children();
641 XMLNodeConstIterator niter;
642 XMLProperty const *name;
643 XMLProperty const *mod;
645 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
646 XMLNode const * child = *niter;
647 if (child->name() != X_("Modifier")) {
651 name = child->property (X_("name"));
652 mod = child->property (X_("modifier"));
655 SVAModifier svam (mod->value());
656 modifiers[name->value()] = svam;
662 UIConfiguration::set_variables (const XMLNode& node)
664 #undef UI_CONFIG_VARIABLE
665 #define UI_CONFIG_VARIABLE(Type,var,name,val) if (var.set_from_node (node)) { ParameterChanged (name); }
666 #define CANVAS_FONT_VARIABLE(var,name) if (var.set_from_node (node)) { ParameterChanged (name); }
667 #include "ui_config_vars.h"
668 #include "canvas_vars.h"
669 #undef UI_CONFIG_VARIABLE
670 #undef CANVAS_FONT_VARIABLE
673 ArdourCanvas::SVAModifier
674 UIConfiguration::modifier (string const & name) const
676 Modifiers::const_iterator m = modifiers.find (name);
677 if (m != modifiers.end()) {
680 return SVAModifier ();
684 UIConfiguration::color_mod (std::string const & colorname, std::string const & modifiername) const
686 return HSV (color (colorname)).mod (modifier (modifiername)).color ();
690 UIConfiguration::color_mod (const ArdourCanvas::Color& color, std::string const & modifiername) const
692 return HSV (color).mod (modifier (modifiername)).color ();
696 UIConfiguration::color (const std::string& name, bool* failed) const
698 ColorAliases::const_iterator e = color_aliases.find (name);
704 if (e != color_aliases.end ()) {
705 Colors::const_iterator rc = colors.find (e->second);
706 if (rc != colors.end()) {
710 /* not an alias, try directly */
711 Colors::const_iterator rc = colors.find (name);
712 if (rc != colors.end()) {
718 /* only show this message if the caller wasn't interested in
721 cerr << string_compose (_("Color %1 not found"), name) << endl;
728 return rgba_to_color ((g_random_int()%256)/255.0,
729 (g_random_int()%256)/255.0,
730 (g_random_int()%256)/255.0,
735 UIConfiguration::quantized (Color c) const
738 hsv.h = hue_width * (round (hsv.h/hue_width));
743 UIConfiguration::set_color (string const& name, ArdourCanvas::Color color)
745 Colors::iterator i = colors.find (name);
746 if (i == colors.end()) {
750 colors_modified = true;
752 ColorsChanged (); /* EMIT SIGNAL */
756 UIConfiguration::set_alias (string const & name, string const & alias)
758 ColorAliases::iterator i = color_aliases.find (name);
759 if (i == color_aliases.end()) {
764 aliases_modified = true;
766 ColorsChanged (); /* EMIT SIGNAL */
770 UIConfiguration::set_modifier (string const & name, SVAModifier svam)
772 Modifiers::iterator m = modifiers.find (name);
774 if (m == modifiers.end()) {
779 modifiers_modified = true;
781 ColorsChanged (); /* EMIT SIGNAL */
785 UIConfiguration::load_rc_file (bool themechange, bool allow_own)
787 string basename = ui_rc_file.get();
788 std::string rc_file_path;
790 if (!find_file (ardour_config_search_path(), basename, rc_file_path)) {
791 warning << string_compose (_("Unable to find UI style file %1 in search path %2. %3 will look strange"),
792 basename, ardour_config_search_path().to_string(), PROGRAM_NAME)
797 info << "Loading ui configuration file " << rc_file_path << endmsg;
799 Gtkmm2ext::UI::instance()->load_rcfile (rc_file_path, themechange);