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();
163 set_pango_fontsize ();
166 gtk_settings_set_long_property (gtk_settings_get_default(),
167 "gtk-xft-dpi", val, "ardour");
168 DPIReset(); //Emit Signal
172 UIConfiguration::set_pango_fontsize ()
174 long val = get_font_scale();
176 /* FT2 rendering - used by GnomeCanvas, sigh */
178 #ifndef PLATFORM_WINDOWS
179 pango_ft2_font_map_set_resolution ((PangoFT2FontMap*) pango_ft2_font_map_new(), val/1024, val/1024);
182 /* Cairo rendering, in case there is any */
184 pango_cairo_font_map_set_resolution ((PangoCairoFontMap*) pango_cairo_font_map_get_default(), val/1024);
188 UIConfiguration::get_ui_scale ()
190 return get_font_scale () / 102400.;
194 UIConfiguration::map_parameters (boost::function<void (std::string)>& functor)
196 #undef UI_CONFIG_VARIABLE
197 #define UI_CONFIG_VARIABLE(Type,var,Name,value) functor (Name);
198 #include "ui_config_vars.h"
199 #undef UI_CONFIG_VARIABLE
203 UIConfiguration::pre_gui_init ()
205 #ifdef CAIRO_SUPPORTS_FORCE_BUGGY_GRADIENTS_ENVIRONMENT_VARIABLE
206 if (get_buggy_gradients()) {
207 g_setenv ("FORCE_BUGGY_GRADIENTS", "1", 1);
210 #ifdef OPTIONAL_CAIRO_IMAGE_SURFACE
211 if (get_cairo_image_surface()) {
212 g_setenv ("ARDOUR_IMAGE_SURFACE", "1", 1);
219 UIConfiguration::post_gui_init ()
221 load_color_theme (true);
226 UIConfiguration::load_defaults ()
231 if (find_file (ardour_config_search_path(), default_ui_config_file_name, rcfile) ) {
234 info << string_compose (_("Loading default ui configuration file %1"), rcfile) << endmsg;
236 if (!tree.read (rcfile.c_str())) {
237 error << string_compose(_("cannot read default ui configuration file \"%1\""), rcfile) << endmsg;
239 if (set_state (*tree.root(), Stateful::loading_state_version)) {
240 error << string_compose(_("default ui configuration file \"%1\" not loaded successfully."), rcfile) << endmsg;
248 warning << string_compose (_("Could not find default UI configuration file %1"), default_ui_config_file_name) << endmsg;
253 /* reload color theme */
254 load_color_theme (false);
261 UIConfiguration::color_file_name (bool use_my, bool with_version) const
269 //this is the overall theme file, e.g. "dark" plus "-downcase(PROGRAM_NAME)"
270 basename += color_file.get();
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 ()
366 root = new XMLNode("Ardour");
368 XMLNode* parent = new XMLNode (X_("Colors"));
369 for (Colors::const_iterator i = colors.begin(); i != colors.end(); ++i) {
370 XMLNode* node = new XMLNode (X_("Color"));
371 node->add_property (X_("name"), i->first);
373 ss << "0x" << setw (8) << setfill ('0') << hex << i->second;
374 node->add_property (X_("value"), ss.str());
375 parent->add_child_nocopy (*node);
377 root->add_child_nocopy (*parent);
379 parent = new XMLNode (X_("ColorAliases"));
380 for (ColorAliases::const_iterator i = color_aliases.begin(); i != color_aliases.end(); ++i) {
381 XMLNode* node = new XMLNode (X_("ColorAlias"));
382 node->add_property (X_("name"), i->first);
383 node->add_property (X_("alias"), i->second);
384 parent->add_child_nocopy (*node);
386 root->add_child_nocopy (*parent);
388 parent = new XMLNode (X_("Modifiers"));
389 for (Modifiers::const_iterator i = modifiers.begin(); i != modifiers.end(); ++i) {
390 XMLNode* node = new XMLNode (X_("Modifier"));
391 node->add_property (X_("name"), i->first);
392 node->add_property (X_("modifier"), i->second.to_string());
393 parent->add_child_nocopy (*node);
395 root->add_child_nocopy (*parent);
398 std::string colorfile = Glib::build_filename (user_config_directory(), color_file_name (true, true));;
400 tree.set_root (root);
402 if (!tree.write (colorfile.c_str())){
403 error << string_compose (_("Color file %1 not saved"), colorfile) << endmsg;
411 UIConfiguration::load_state ()
413 LocaleGuard lg; // a single guard for all 3 configs
418 if (find_file (ardour_config_search_path(), default_ui_config_file_name, rcfile)) {
422 info << string_compose (_("Loading default ui configuration file %1"), rcfile) << endmsg;
424 if (!tree.read (rcfile.c_str())) {
425 error << string_compose(_("cannot read default ui configuration file \"%1\""), rcfile) << endmsg;
429 if (set_state (*tree.root(), Stateful::loading_state_version)) {
430 error << string_compose(_("default ui configuration file \"%1\" not loaded successfully."), rcfile) << endmsg;
435 if (find_file (ardour_config_search_path(), ui_config_file_name, rcfile)) {
439 info << string_compose (_("Loading user ui configuration file %1"), rcfile) << endmsg;
441 if (!tree.read (rcfile)) {
442 error << string_compose(_("cannot read ui configuration file \"%1\""), rcfile) << endmsg;
446 if (set_state (*tree.root(), Stateful::loading_state_version)) {
447 error << string_compose(_("user ui configuration file \"%1\" not loaded successfully."), rcfile) << endmsg;
455 error << _("could not find any ui configuration file, canvas will look broken.") << endmsg;
462 UIConfiguration::save_state()
464 if (block_save != 0) {
469 std::string rcfile = Glib::build_filename (user_config_directory(), ui_config_file_name);
473 tree.set_root (&get_state());
475 if (!tree.write (rcfile.c_str())){
476 error << string_compose (_("Config file %1 not saved"), rcfile) << endmsg;
483 if (aliases_modified || colors_modified || modifiers_modified) {
485 if (store_color_theme ()) {
486 error << string_compose (_("Color file %1 not saved"), color_file.get()) << endmsg;
490 aliases_modified = false;
491 colors_modified = false;
492 modifiers_modified = false;
500 UIConfiguration::get_state ()
505 root = new XMLNode("Ardour");
507 root->add_child_nocopy (get_variables ("UI"));
508 root->add_child_nocopy (get_variables ("Canvas"));
511 root->add_child_copy (*_extra_xml);
518 UIConfiguration::get_variables (std::string which_node)
523 node = new XMLNode (which_node);
525 #undef UI_CONFIG_VARIABLE
526 #undef CANVAS_FONT_VARIABLE
527 #define UI_CONFIG_VARIABLE(Type,var,Name,value) if (node->name() == "UI") { var.add_to_node (*node); }
528 #define CANVAS_FONT_VARIABLE(var,Name) if (node->name() == "Canvas") { var.add_to_node (*node); }
529 #include "ui_config_vars.h"
530 #include "canvas_vars.h"
531 #undef UI_CONFIG_VARIABLE
532 #undef CANVAS_FONT_VARIABLE
538 UIConfiguration::set_state (const XMLNode& root, int /*version*/)
541 /* this can load a generic UI configuration file or a colors file */
543 if (root.name() != "Ardour") {
547 Stateful::save_extra_xml (root);
549 XMLNodeList nlist = root.children();
550 XMLNodeConstIterator niter;
553 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
557 if (node->name() == "Canvas" || node->name() == "UI") {
558 set_variables (*node);
563 XMLNode* colors = find_named_node (root, X_("Colors"));
566 load_colors (*colors);
569 XMLNode* aliases = find_named_node (root, X_("ColorAliases"));
572 load_color_aliases (*aliases);
575 XMLNode* modifiers = find_named_node (root, X_("Modifiers"));
578 load_modifiers (*modifiers);
585 UIConfiguration::load_color_aliases (XMLNode const & node)
587 XMLNodeList const nlist = node.children();
588 XMLNodeConstIterator niter;
589 XMLProperty const *name;
590 XMLProperty const *alias;
592 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
593 XMLNode const * child = *niter;
594 if (child->name() != X_("ColorAlias")) {
597 name = child->property (X_("name"));
598 alias = child->property (X_("alias"));
601 color_aliases[name->value()] = alias->value();
607 UIConfiguration::load_colors (XMLNode const & node)
609 XMLNodeList const nlist = node.children();
610 XMLNodeConstIterator niter;
611 XMLProperty const *name;
612 XMLProperty const *color;
614 /* don't clear colors, so that we can load > 1 color file and have
615 the subsequent ones overwrite the later ones.
618 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
619 XMLNode const * child = *niter;
620 if (child->name() != X_("Color")) {
623 name = child->property (X_("name"));
624 color = child->property (X_("value"));
627 ArdourCanvas::Color c;
628 c = strtoul (color->value().c_str(), 0, 16);
629 /* insert or replace color name definition */
630 colors[name->value()] = c;
636 UIConfiguration::load_modifiers (XMLNode const & node)
639 XMLNodeList const nlist = node.children();
640 XMLNodeConstIterator niter;
641 XMLProperty const *name;
642 XMLProperty const *mod;
644 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
645 XMLNode const * child = *niter;
646 if (child->name() != X_("Modifier")) {
650 name = child->property (X_("name"));
651 mod = child->property (X_("modifier"));
654 SVAModifier svam (mod->value());
655 modifiers[name->value()] = svam;
661 UIConfiguration::set_variables (const XMLNode& node)
663 #undef UI_CONFIG_VARIABLE
664 #define UI_CONFIG_VARIABLE(Type,var,name,val) if (var.set_from_node (node)) { ParameterChanged (name); }
665 #define CANVAS_FONT_VARIABLE(var,name) if (var.set_from_node (node)) { ParameterChanged (name); }
666 #include "ui_config_vars.h"
667 #include "canvas_vars.h"
668 #undef UI_CONFIG_VARIABLE
669 #undef CANVAS_FONT_VARIABLE
672 ArdourCanvas::SVAModifier
673 UIConfiguration::modifier (string const & name) const
675 Modifiers::const_iterator m = modifiers.find (name);
676 if (m != modifiers.end()) {
679 return SVAModifier ();
683 UIConfiguration::color_mod (std::string const & colorname, std::string const & modifiername) const
685 return HSV (color (colorname)).mod (modifier (modifiername)).color ();
689 UIConfiguration::color_mod (const ArdourCanvas::Color& color, std::string const & modifiername) const
691 return HSV (color).mod (modifier (modifiername)).color ();
695 UIConfiguration::color (const std::string& name, bool* failed) const
697 ColorAliases::const_iterator e = color_aliases.find (name);
703 if (e != color_aliases.end ()) {
704 Colors::const_iterator rc = colors.find (e->second);
705 if (rc != colors.end()) {
709 /* not an alias, try directly */
710 Colors::const_iterator rc = colors.find (name);
711 if (rc != colors.end()) {
717 /* only show this message if the caller wasn't interested in
720 cerr << string_compose (_("Color %1 not found"), name) << endl;
727 return rgba_to_color ((g_random_int()%256)/255.0,
728 (g_random_int()%256)/255.0,
729 (g_random_int()%256)/255.0,
734 UIConfiguration::quantized (Color c) const
737 hsv.h = hue_width * (round (hsv.h/hue_width));
742 UIConfiguration::set_color (string const& name, ArdourCanvas::Color color)
744 Colors::iterator i = colors.find (name);
745 if (i == colors.end()) {
749 colors_modified = true;
751 ColorsChanged (); /* EMIT SIGNAL */
755 UIConfiguration::set_alias (string const & name, string const & alias)
757 ColorAliases::iterator i = color_aliases.find (name);
758 if (i == color_aliases.end()) {
763 aliases_modified = true;
765 ColorsChanged (); /* EMIT SIGNAL */
769 UIConfiguration::set_modifier (string const & name, SVAModifier svam)
771 Modifiers::iterator m = modifiers.find (name);
773 if (m == modifiers.end()) {
778 modifiers_modified = true;
780 ColorsChanged (); /* EMIT SIGNAL */
784 UIConfiguration::load_rc_file (bool themechange, bool allow_own)
786 string basename = ui_rc_file.get();
787 std::string rc_file_path;
789 if (!find_file (ardour_config_search_path(), basename, rc_file_path)) {
790 warning << string_compose (_("Unable to find UI style file %1 in search path %2. %3 will look strange"),
791 basename, ardour_config_search_path().to_string(), PROGRAM_NAME)
796 info << "Loading ui configuration file " << rc_file_path << endmsg;
798 Gtkmm2ext::UI::instance()->load_rcfile (rc_file_path, themechange);