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);
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 //this is the overall theme file, e.g. "dark" plus "-downcase(PROGRAM_NAME)"
264 basename += color_file.get();
266 std::string rev (revision);
267 std::size_t pos = rev.find_first_of("-");
269 if (with_version && pos != string::npos && pos > 0) {
271 basename += rev.substr (0, pos); // COLORFILE_VERSION - program major.minor
274 basename += color_file_suffix;
279 UIConfiguration::load_color_file (string const & path)
283 info << string_compose (_("Loading color file %1"), path) << endmsg;
285 if (!tree.read (path.c_str())) {
286 error << string_compose(_("cannot read color file \"%1\""), path) << endmsg;
290 if (set_state (*tree.root(), Stateful::loading_state_version)) {
291 error << string_compose(_("color file \"%1\" not loaded successfully."), path) << endmsg;
299 UIConfiguration::load_color_theme (bool allow_own)
303 /* ColorsChanged() will trigger a parameter_changed () which
304 * in turn calls save_state()
306 PBD::Unwinder<uint32_t> uw (block_save, block_save + 1);
308 if (find_file (theme_search_path(), color_file_name (false, true), cfile)) {
313 if (find_file (theme_search_path(), color_file_name (false, false), cfile)) {
319 warning << string_compose (_("Color file for %1 not found along %2"), color_file.get(), theme_search_path().to_string()) << endmsg;
323 (void) load_color_file (cfile);
329 PBD::Searchpath sp (user_config_directory());
331 /* user's own color files never have the program name in them */
333 if (find_file (sp, color_file_name (true, true), cfile)) {
338 if (find_file (sp, color_file_name (true, false), cfile)) {
344 (void) load_color_file (cfile);
355 UIConfiguration::store_color_theme ()
360 root = new XMLNode("Ardour");
362 XMLNode* parent = new XMLNode (X_("Colors"));
363 for (Colors::const_iterator i = colors.begin(); i != colors.end(); ++i) {
364 XMLNode* node = new XMLNode (X_("Color"));
365 node->add_property (X_("name"), i->first);
367 ss << "0x" << setw (8) << setfill ('0') << hex << i->second;
368 node->add_property (X_("value"), ss.str());
369 parent->add_child_nocopy (*node);
371 root->add_child_nocopy (*parent);
373 parent = new XMLNode (X_("ColorAliases"));
374 for (ColorAliases::const_iterator i = color_aliases.begin(); i != color_aliases.end(); ++i) {
375 XMLNode* node = new XMLNode (X_("ColorAlias"));
376 node->add_property (X_("name"), i->first);
377 node->add_property (X_("alias"), i->second);
378 parent->add_child_nocopy (*node);
380 root->add_child_nocopy (*parent);
382 parent = new XMLNode (X_("Modifiers"));
383 for (Modifiers::const_iterator i = modifiers.begin(); i != modifiers.end(); ++i) {
384 XMLNode* node = new XMLNode (X_("Modifier"));
385 node->add_property (X_("name"), i->first);
386 node->add_property (X_("modifier"), i->second.to_string());
387 parent->add_child_nocopy (*node);
389 root->add_child_nocopy (*parent);
392 std::string colorfile = Glib::build_filename (user_config_directory(), color_file_name (true, true));;
394 tree.set_root (root);
396 if (!tree.write (colorfile.c_str())){
397 error << string_compose (_("Color file %1 not saved"), colorfile) << endmsg;
405 UIConfiguration::load_state ()
407 LocaleGuard lg; // a single guard for all 3 configs
412 if (find_file (ardour_config_search_path(), default_ui_config_file_name, rcfile)) {
416 info << string_compose (_("Loading default ui configuration file %1"), rcfile) << endmsg;
418 if (!tree.read (rcfile.c_str())) {
419 error << string_compose(_("cannot read default ui configuration file \"%1\""), rcfile) << endmsg;
423 if (set_state (*tree.root(), Stateful::loading_state_version)) {
424 error << string_compose(_("default ui configuration file \"%1\" not loaded successfully."), rcfile) << endmsg;
429 if (find_file (ardour_config_search_path(), ui_config_file_name, rcfile)) {
433 info << string_compose (_("Loading user ui configuration file %1"), rcfile) << endmsg;
435 if (!tree.read (rcfile)) {
436 error << string_compose(_("cannot read ui configuration file \"%1\""), rcfile) << endmsg;
440 if (set_state (*tree.root(), Stateful::loading_state_version)) {
441 error << string_compose(_("user ui configuration file \"%1\" not loaded successfully."), rcfile) << endmsg;
449 error << _("could not find any ui configuration file, canvas will look broken.") << endmsg;
456 UIConfiguration::save_state()
458 if (block_save != 0) {
463 std::string rcfile = Glib::build_filename (user_config_directory(), ui_config_file_name);
467 tree.set_root (&get_state());
469 if (!tree.write (rcfile.c_str())){
470 error << string_compose (_("Config file %1 not saved"), rcfile) << endmsg;
477 if (aliases_modified || colors_modified || modifiers_modified) {
479 if (store_color_theme ()) {
480 error << string_compose (_("Color file %1 not saved"), color_file.get()) << endmsg;
484 aliases_modified = false;
485 colors_modified = false;
486 modifiers_modified = false;
494 UIConfiguration::get_state ()
499 root = new XMLNode("Ardour");
501 root->add_child_nocopy (get_variables ("UI"));
502 root->add_child_nocopy (get_variables ("Canvas"));
505 root->add_child_copy (*_extra_xml);
512 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*/)
535 /* this can load a generic UI configuration file or a colors file */
537 if (root.name() != "Ardour") {
541 Stateful::save_extra_xml (root);
543 XMLNodeList nlist = root.children();
544 XMLNodeConstIterator niter;
547 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
551 if (node->name() == "Canvas" || node->name() == "UI") {
552 set_variables (*node);
557 XMLNode* colors = find_named_node (root, X_("Colors"));
560 load_colors (*colors);
563 XMLNode* aliases = find_named_node (root, X_("ColorAliases"));
566 load_color_aliases (*aliases);
569 XMLNode* modifiers = find_named_node (root, X_("Modifiers"));
572 load_modifiers (*modifiers);
579 UIConfiguration::load_color_aliases (XMLNode const & node)
581 XMLNodeList const nlist = node.children();
582 XMLNodeConstIterator niter;
583 XMLProperty const *name;
584 XMLProperty const *alias;
586 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
587 XMLNode const * child = *niter;
588 if (child->name() != X_("ColorAlias")) {
591 name = child->property (X_("name"));
592 alias = child->property (X_("alias"));
595 color_aliases[name->value()] = alias->value();
601 UIConfiguration::load_colors (XMLNode const & node)
603 XMLNodeList const nlist = node.children();
604 XMLNodeConstIterator niter;
605 XMLProperty const *name;
606 XMLProperty const *color;
608 /* don't clear colors, so that we can load > 1 color file and have
609 the subsequent ones overwrite the later ones.
612 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
613 XMLNode const * child = *niter;
614 if (child->name() != X_("Color")) {
617 name = child->property (X_("name"));
618 color = child->property (X_("value"));
621 ArdourCanvas::Color c;
622 c = strtoul (color->value().c_str(), 0, 16);
623 /* insert or replace color name definition */
624 colors[name->value()] = c;
630 UIConfiguration::load_modifiers (XMLNode const & node)
633 XMLNodeList const nlist = node.children();
634 XMLNodeConstIterator niter;
635 XMLProperty const *name;
636 XMLProperty const *mod;
638 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
639 XMLNode const * child = *niter;
640 if (child->name() != X_("Modifier")) {
644 name = child->property (X_("name"));
645 mod = child->property (X_("modifier"));
648 SVAModifier svam (mod->value());
649 modifiers[name->value()] = svam;
655 UIConfiguration::set_variables (const XMLNode& node)
657 #undef UI_CONFIG_VARIABLE
658 #define UI_CONFIG_VARIABLE(Type,var,name,val) if (var.set_from_node (node)) { ParameterChanged (name); }
659 #define CANVAS_FONT_VARIABLE(var,name) if (var.set_from_node (node)) { ParameterChanged (name); }
660 #include "ui_config_vars.h"
661 #include "canvas_vars.h"
662 #undef UI_CONFIG_VARIABLE
663 #undef CANVAS_FONT_VARIABLE
666 ArdourCanvas::SVAModifier
667 UIConfiguration::modifier (string const & name) const
669 Modifiers::const_iterator m = modifiers.find (name);
670 if (m != modifiers.end()) {
673 return SVAModifier ();
677 UIConfiguration::color_mod (std::string const & colorname, std::string const & modifiername) const
679 return HSV (color (colorname)).mod (modifier (modifiername)).color ();
683 UIConfiguration::color_mod (const ArdourCanvas::Color& color, std::string const & modifiername) const
685 return HSV (color).mod (modifier (modifiername)).color ();
689 UIConfiguration::color (const std::string& name, bool* failed) const
691 ColorAliases::const_iterator e = color_aliases.find (name);
697 if (e != color_aliases.end ()) {
698 Colors::const_iterator rc = colors.find (e->second);
699 if (rc != colors.end()) {
703 /* not an alias, try directly */
704 Colors::const_iterator rc = colors.find (name);
705 if (rc != colors.end()) {
711 /* only show this message if the caller wasn't interested in
714 cerr << string_compose (_("Color %1 not found"), name) << endl;
721 return rgba_to_color ((g_random_int()%256)/255.0,
722 (g_random_int()%256)/255.0,
723 (g_random_int()%256)/255.0,
728 UIConfiguration::quantized (Color c) const
731 hsv.h = hue_width * (round (hsv.h/hue_width));
736 UIConfiguration::set_color (string const& name, ArdourCanvas::Color color)
738 Colors::iterator i = colors.find (name);
739 if (i == colors.end()) {
743 colors_modified = true;
745 ColorsChanged (); /* EMIT SIGNAL */
749 UIConfiguration::set_alias (string const & name, string const & alias)
751 ColorAliases::iterator i = color_aliases.find (name);
752 if (i == color_aliases.end()) {
757 aliases_modified = true;
759 ColorsChanged (); /* EMIT SIGNAL */
763 UIConfiguration::set_modifier (string const & name, SVAModifier svam)
765 Modifiers::iterator m = modifiers.find (name);
767 if (m == modifiers.end()) {
772 modifiers_modified = true;
774 ColorsChanged (); /* EMIT SIGNAL */
778 UIConfiguration::load_rc_file (bool themechange, bool allow_own)
780 string basename = ui_rc_file.get();
781 std::string rc_file_path;
783 if (!find_file (ardour_config_search_path(), basename, rc_file_path)) {
784 warning << string_compose (_("Unable to find UI style file %1 in search path %2. %3 will look strange"),
785 basename, ardour_config_search_path().to_string(), PROGRAM_NAME)
790 info << "Loading ui configuration file " << rc_file_path << endmsg;
792 Gtkmm2ext::UI::instance()->load_rcfile (rc_file_path, themechange);