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/unwind.h"
45 #include "pbd/xml++.h"
47 #include "ardour/filesystem_paths.h"
48 #include "ardour/search_paths.h"
49 #include "ardour/revision.h"
50 #include "ardour/utils.h"
51 #include "ardour/types_convert.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 Gtkmm2ext;
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;
75 _instance = &s_instance;
79 UIConfiguration::UIConfiguration ()
81 #undef UI_CONFIG_VARIABLE
82 #define UI_CONFIG_VARIABLE(Type,var,name,val) var (name,val),
83 #define CANVAS_FONT_VARIABLE(var,name) var (name),
84 #include "ui_config_vars.h"
85 #include "canvas_vars.h"
86 #undef UI_CONFIG_VARIABLE
87 #undef CANVAS_FONT_VARIABLE
90 aliases_modified (false),
91 colors_modified (false),
92 modifiers_modified (false),
97 ColorsChanged.connect (boost::bind (&UIConfiguration::colors_changed, this));
99 ParameterChanged.connect (sigc::mem_fun (*this, &UIConfiguration::parameter_changed));
102 UIConfiguration::~UIConfiguration ()
107 UIConfiguration::colors_changed ()
111 /* In theory, one of these ought to work:
113 gtk_rc_reparse_all_for_settings (gtk_settings_get_default(), true);
114 gtk_rc_reset_styles (gtk_settings_get_default());
116 but in practice, neither of them do. So just reload the current
117 GTK RC file, which causes a reset of all styles and a redraw
120 parameter_changed ("ui-rc-file");
124 UIConfiguration::parameter_changed (string param)
128 if (param == "ui-rc-file") {
130 } else if (param == "color-file") {
131 load_color_theme (true);
138 UIConfiguration::reset_gtk_theme ()
140 std::string color_scheme_string("gtk_color_scheme = \"");
142 for (ColorAliases::iterator g = color_aliases.begin(); g != color_aliases.end(); ++g) {
144 if (g->first.find ("gtk_") == 0) {
145 const string gtk_name = g->first.substr (4);
146 Gtkmm2ext::Color a_color = color (g->second);
148 color_scheme_string += gtk_name + ":#" + color_to_hex_string_no_alpha (a_color) + ';';
152 color_scheme_string += '"';
154 /* reset GTK color scheme */
156 Gtk::Settings::get_default()->property_gtk_color_scheme() = color_scheme_string;
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;
246 /* reload color theme */
247 load_color_theme (false);
254 UIConfiguration::color_file_name (bool use_my, bool with_version) const
262 std::string color_name = color_file.get();
263 size_t sep = color_name.find_first_of("-");
264 if (sep != string::npos) {
265 color_name = color_name.substr (0, sep);
268 basename += color_name;
270 basename += downcase(std::string(PROGRAM_NAME));
272 std::string rev (revision);
273 std::size_t pos = rev.find_first_of("-");
275 if (with_version && pos != string::npos && pos > 0) {
277 basename += rev.substr (0, pos); // COLORFILE_VERSION - program major.minor
280 basename += color_file_suffix;
285 UIConfiguration::load_color_file (string const & path)
289 info << string_compose (_("Loading color file %1"), path) << endmsg;
291 if (!tree.read (path.c_str())) {
292 error << string_compose(_("cannot read color file \"%1\""), path) << endmsg;
296 if (set_state (*tree.root(), Stateful::loading_state_version)) {
297 error << string_compose(_("color file \"%1\" not loaded successfully."), path) << endmsg;
305 UIConfiguration::load_color_theme (bool allow_own)
309 /* ColorsChanged() will trigger a parameter_changed () which
310 * in turn calls save_state()
312 PBD::Unwinder<uint32_t> uw (block_save, block_save + 1);
314 if (find_file (theme_search_path(), color_file_name (false, true), cfile)) {
319 if (find_file (theme_search_path(), color_file_name (false, false), cfile)) {
325 warning << string_compose (_("Color file for %1 not found along %2"), color_file.get(), theme_search_path().to_string()) << endmsg;
329 (void) load_color_file (cfile);
335 PBD::Searchpath sp (user_config_directory());
337 /* user's own color files never have the program name in them */
339 if (find_file (sp, color_file_name (true, true), cfile)) {
344 if (find_file (sp, color_file_name (true, false), cfile)) {
350 (void) load_color_file (cfile);
361 UIConfiguration::store_color_theme ()
365 root = new XMLNode("Ardour");
367 XMLNode* parent = new XMLNode (X_("Colors"));
368 for (Colors::const_iterator i = colors.begin(); i != colors.end(); ++i) {
369 XMLNode* node = new XMLNode (X_("Color"));
370 node->set_property (X_("name"), i->first);
371 node->set_property (X_("value"), color_to_hex_string (i->second));
372 parent->add_child_nocopy (*node);
374 root->add_child_nocopy (*parent);
376 parent = new XMLNode (X_("ColorAliases"));
377 for (ColorAliases::const_iterator i = color_aliases.begin(); i != color_aliases.end(); ++i) {
378 XMLNode* node = new XMLNode (X_("ColorAlias"));
379 node->set_property (X_("name"), i->first);
380 node->set_property (X_("alias"), i->second);
381 parent->add_child_nocopy (*node);
383 root->add_child_nocopy (*parent);
385 parent = new XMLNode (X_("Modifiers"));
386 for (Modifiers::const_iterator i = modifiers.begin(); i != modifiers.end(); ++i) {
387 XMLNode* node = new XMLNode (X_("Modifier"));
388 node->set_property (X_("name"), i->first);
389 node->set_property (X_("modifier"), i->second.to_string());
390 parent->add_child_nocopy (*node);
392 root->add_child_nocopy (*parent);
395 std::string colorfile = Glib::build_filename (user_config_directory(), color_file_name (true, true));;
397 tree.set_root (root);
399 if (!tree.write (colorfile.c_str())){
400 error << string_compose (_("Color file %1 not saved"), colorfile) << endmsg;
408 UIConfiguration::load_state ()
414 if (find_file (ardour_config_search_path(), default_ui_config_file_name, rcfile)) {
418 info << string_compose (_("Loading default ui configuration file %1"), rcfile) << endmsg;
420 if (!tree.read (rcfile.c_str())) {
421 error << string_compose(_("cannot read default ui configuration file \"%1\""), rcfile) << endmsg;
425 if (set_state (*tree.root(), Stateful::loading_state_version)) {
426 error << string_compose(_("default ui configuration file \"%1\" not loaded successfully."), rcfile) << endmsg;
431 if (find_file (ardour_config_search_path(), ui_config_file_name, rcfile)) {
435 info << string_compose (_("Loading user ui configuration file %1"), rcfile) << endmsg;
437 if (!tree.read (rcfile)) {
438 error << string_compose(_("cannot read ui configuration file \"%1\""), rcfile) << endmsg;
442 if (set_state (*tree.root(), Stateful::loading_state_version)) {
443 error << string_compose(_("user ui configuration file \"%1\" not loaded successfully."), rcfile) << endmsg;
451 error << _("could not find any ui configuration file, canvas will look broken.") << endmsg;
458 UIConfiguration::save_state()
460 if (block_save != 0) {
465 std::string rcfile = Glib::build_filename (user_config_directory(), ui_config_file_name);
469 tree.set_root (&get_state());
471 if (!tree.write (rcfile.c_str())){
472 error << string_compose (_("Config file %1 not saved"), rcfile) << endmsg;
479 if (aliases_modified || colors_modified || modifiers_modified) {
481 if (store_color_theme ()) {
482 error << string_compose (_("Color file %1 not saved"), color_file.get()) << endmsg;
486 aliases_modified = false;
487 colors_modified = false;
488 modifiers_modified = false;
496 UIConfiguration::get_state ()
500 root = new XMLNode("Ardour");
502 root->add_child_nocopy (get_variables ("UI"));
503 root->add_child_nocopy (get_variables ("Canvas"));
506 root->add_child_copy (*_extra_xml);
513 UIConfiguration::get_variables (std::string which_node)
517 node = new XMLNode (which_node);
519 #undef UI_CONFIG_VARIABLE
520 #undef CANVAS_FONT_VARIABLE
521 #define UI_CONFIG_VARIABLE(Type,var,Name,value) if (node->name() == "UI") { var.add_to_node (*node); }
522 #define CANVAS_FONT_VARIABLE(var,Name) if (node->name() == "Canvas") { var.add_to_node (*node); }
523 #include "ui_config_vars.h"
524 #include "canvas_vars.h"
525 #undef UI_CONFIG_VARIABLE
526 #undef CANVAS_FONT_VARIABLE
532 UIConfiguration::set_state (const XMLNode& root, int /*version*/)
534 /* this can load a generic UI configuration file or a colors file */
536 if (root.name() != "Ardour") {
540 Stateful::save_extra_xml (root);
542 XMLNodeList nlist = root.children();
543 XMLNodeConstIterator niter;
546 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
550 if (node->name() == "Canvas" || node->name() == "UI") {
551 set_variables (*node);
556 XMLNode* colors = find_named_node (root, X_("Colors"));
559 load_colors (*colors);
562 XMLNode* aliases = find_named_node (root, X_("ColorAliases"));
565 load_color_aliases (*aliases);
568 XMLNode* modifiers = find_named_node (root, X_("Modifiers"));
571 load_modifiers (*modifiers);
578 UIConfiguration::load_color_aliases (XMLNode const & node)
580 XMLNodeList const nlist = node.children();
581 XMLNodeConstIterator niter;
582 XMLProperty const *name;
583 XMLProperty const *alias;
585 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
586 XMLNode const * child = *niter;
587 if (child->name() != X_("ColorAlias")) {
590 name = child->property (X_("name"));
591 alias = child->property (X_("alias"));
594 color_aliases[name->value()] = alias->value();
600 UIConfiguration::load_colors (XMLNode const & node)
602 XMLNodeList const nlist = node.children();
603 XMLNodeConstIterator niter;
604 XMLProperty const *name;
605 XMLProperty const *color;
607 /* don't clear colors, so that we can load > 1 color file and have
608 the subsequent ones overwrite the later ones.
611 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
612 XMLNode const * child = *niter;
613 if (child->name() != X_("Color")) {
616 name = child->property (X_("name"));
617 color = child->property (X_("value"));
621 c = strtoul (color->value().c_str(), 0, 16);
622 /* insert or replace color name definition */
623 colors[name->value()] = c;
629 UIConfiguration::load_modifiers (XMLNode const & node)
631 XMLNodeList const nlist = node.children();
632 XMLNodeConstIterator niter;
633 XMLProperty const *name;
634 XMLProperty const *mod;
636 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
637 XMLNode const * child = *niter;
638 if (child->name() != X_("Modifier")) {
642 name = child->property (X_("name"));
643 mod = child->property (X_("modifier"));
646 SVAModifier svam (mod->value());
647 modifiers[name->value()] = svam;
653 UIConfiguration::set_variables (const XMLNode& node)
655 #undef UI_CONFIG_VARIABLE
656 #define UI_CONFIG_VARIABLE(Type,var,name,val) if (var.set_from_node (node)) { ParameterChanged (name); }
657 #define CANVAS_FONT_VARIABLE(var,name) if (var.set_from_node (node)) { ParameterChanged (name); }
658 #include "ui_config_vars.h"
659 #include "canvas_vars.h"
660 #undef UI_CONFIG_VARIABLE
661 #undef CANVAS_FONT_VARIABLE
664 Gtkmm2ext::SVAModifier
665 UIConfiguration::modifier (string const & name) const
667 Modifiers::const_iterator m = modifiers.find (name);
668 if (m != modifiers.end()) {
671 return SVAModifier ();
675 UIConfiguration::color_mod (std::string const & colorname, std::string const & modifiername) const
677 return HSV (color (colorname)).mod (modifier (modifiername)).color ();
681 UIConfiguration::color_mod (const Gtkmm2ext::Color& color, std::string const & modifiername) const
683 return HSV (color).mod (modifier (modifiername)).color ();
687 UIConfiguration::color (const std::string& name, bool* failed) const
689 ColorAliases::const_iterator e = color_aliases.find (name);
695 if (e != color_aliases.end ()) {
696 Colors::const_iterator rc = colors.find (e->second);
697 if (rc != colors.end()) {
701 /* not an alias, try directly */
702 Colors::const_iterator rc = colors.find (name);
703 if (rc != colors.end()) {
709 /* only show this message if the caller wasn't interested in
712 cerr << string_compose (_("Color %1 not found"), name) << endl;
719 return rgba_to_color ((g_random_int()%256)/255.0,
720 (g_random_int()%256)/255.0,
721 (g_random_int()%256)/255.0,
726 UIConfiguration::quantized (Color c) const
729 hsv.h = hue_width * (round (hsv.h/hue_width));
734 UIConfiguration::set_color (string const& name, Gtkmm2ext::Color color)
736 Colors::iterator i = colors.find (name);
737 if (i == colors.end()) {
741 colors_modified = true;
743 ColorsChanged (); /* EMIT SIGNAL */
747 UIConfiguration::set_alias (string const & name, string const & alias)
749 ColorAliases::iterator i = color_aliases.find (name);
750 if (i == color_aliases.end()) {
755 aliases_modified = true;
757 ColorsChanged (); /* EMIT SIGNAL */
761 UIConfiguration::set_modifier (string const & name, SVAModifier svam)
763 Modifiers::iterator m = modifiers.find (name);
765 if (m == modifiers.end()) {
770 modifiers_modified = true;
772 ColorsChanged (); /* EMIT SIGNAL */
776 UIConfiguration::load_rc_file (bool themechange, bool allow_own)
778 string basename = ui_rc_file.get();
779 std::string rc_file_path;
781 if (!find_file (ardour_config_search_path(), basename, rc_file_path)) {
782 warning << string_compose (_("Unable to find UI style file %1 in search path %2. %3 will look strange"),
783 basename, ardour_config_search_path().to_string(), PROGRAM_NAME)
788 info << string_compose (_("Loading ui configuration file %1"), rc_file_path) << endmsg;
790 Gtkmm2ext::UI::instance()->load_rcfile (rc_file_path, themechange);
794 UIConfiguration::color_to_hex_string (Gtkmm2ext::Color c)
797 int retval = g_snprintf (buf, sizeof(buf), "%08x", c);
799 if (retval < 0 || retval >= (int)sizeof(buf)) {
806 UIConfiguration::color_to_hex_string_no_alpha (Gtkmm2ext::Color c)
808 c >>= 8; // shift/remove alpha
810 int retval = g_snprintf (buf, sizeof(buf), "%06x", c);
812 if (retval < 0 || retval >= (int)sizeof(buf)) {