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"
52 #include "ardour/types_convert.h"
54 #include "gtkmm2ext/rgb_macros.h"
55 #include "gtkmm2ext/gtk_ui.h"
57 #include "ui_config.h"
63 using namespace ARDOUR;
64 using namespace ArdourCanvas;
66 static const char* ui_config_file_name = "ui_config";
67 static const char* default_ui_config_file_name = "default_ui_config";
69 static const double hue_width = 18.0;
70 std::string UIConfiguration::color_file_suffix = X_(".colors");
73 UIConfiguration::instance ()
75 static UIConfiguration 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 ()
143 ss << "gtk_color_scheme = \"" << hex;
145 for (ColorAliases::iterator g = color_aliases.begin(); g != color_aliases.end(); ++g) {
147 if (g->first.find ("gtk_") == 0) {
148 const string gtk_name = g->first.substr (4);
149 ss << gtk_name << ":#" << std::setw (6) << setfill ('0') << (color (g->second) >> 8) << ';';
153 ss << '"' << dec << endl;
155 /* reset GTK color scheme */
157 Gtk::Settings::get_default()->property_gtk_color_scheme() = ss.str();
161 UIConfiguration::reset_dpi ()
163 long val = get_font_scale();
165 /* FT2 rendering - used by GnomeCanvas, sigh */
167 #ifndef PLATFORM_WINDOWS
168 pango_ft2_font_map_set_resolution ((PangoFT2FontMap*) pango_ft2_font_map_new(), val/1024, val/1024); // XXX pango_ft2_font_map_new leaks
171 /* Cairo rendering, in case there is any */
173 pango_cairo_font_map_set_resolution ((PangoCairoFontMap*) pango_cairo_font_map_get_default(), val/1024);
177 gtk_settings_set_long_property (gtk_settings_get_default(),
178 "gtk-xft-dpi", val, "ardour");
179 DPIReset(); //Emit Signal
183 UIConfiguration::get_ui_scale ()
185 return get_font_scale () / 102400.;
189 UIConfiguration::map_parameters (boost::function<void (std::string)>& functor)
191 #undef UI_CONFIG_VARIABLE
192 #define UI_CONFIG_VARIABLE(Type,var,Name,value) functor (Name);
193 #include "ui_config_vars.h"
194 #undef UI_CONFIG_VARIABLE
198 UIConfiguration::pre_gui_init ()
200 #ifdef CAIRO_SUPPORTS_FORCE_BUGGY_GRADIENTS_ENVIRONMENT_VARIABLE
201 if (get_buggy_gradients()) {
202 g_setenv ("FORCE_BUGGY_GRADIENTS", "1", 1);
205 #ifdef OPTIONAL_CAIRO_IMAGE_SURFACE
206 if (get_cairo_image_surface()) {
207 g_setenv ("ARDOUR_IMAGE_SURFACE", "1", 1);
214 UIConfiguration::post_gui_init ()
216 load_color_theme (true);
221 UIConfiguration::load_defaults ()
226 if (find_file (ardour_config_search_path(), default_ui_config_file_name, rcfile) ) {
229 info << string_compose (_("Loading default ui configuration file %1"), rcfile) << endmsg;
231 if (!tree.read (rcfile.c_str())) {
232 error << string_compose(_("cannot read default ui configuration file \"%1\""), rcfile) << endmsg;
234 if (set_state (*tree.root(), Stateful::loading_state_version)) {
235 error << string_compose(_("default ui configuration file \"%1\" not loaded successfully."), rcfile) << endmsg;
243 warning << string_compose (_("Could not find default UI configuration file %1"), default_ui_config_file_name) << endmsg;
248 /* reload color theme */
249 load_color_theme (false);
256 UIConfiguration::color_file_name (bool use_my, bool with_version) const
264 std::string color_name = color_file.get();
265 size_t sep = color_name.find_first_of("-");
266 if (sep != string::npos) {
267 color_name = color_name.substr (0, sep);
270 basename += color_name;
272 basename += downcase(std::string(PROGRAM_NAME));
274 std::string rev (revision);
275 std::size_t pos = rev.find_first_of("-");
277 if (with_version && pos != string::npos && pos > 0) {
279 basename += rev.substr (0, pos); // COLORFILE_VERSION - program major.minor
282 basename += color_file_suffix;
287 UIConfiguration::load_color_file (string const & path)
291 info << string_compose (_("Loading color file %1"), path) << endmsg;
293 if (!tree.read (path.c_str())) {
294 error << string_compose(_("cannot read color file \"%1\""), path) << endmsg;
298 if (set_state (*tree.root(), Stateful::loading_state_version)) {
299 error << string_compose(_("color file \"%1\" not loaded successfully."), path) << endmsg;
307 UIConfiguration::load_color_theme (bool allow_own)
311 /* ColorsChanged() will trigger a parameter_changed () which
312 * in turn calls save_state()
314 PBD::Unwinder<uint32_t> uw (block_save, block_save + 1);
316 if (find_file (theme_search_path(), color_file_name (false, true), cfile)) {
321 if (find_file (theme_search_path(), color_file_name (false, false), cfile)) {
327 warning << string_compose (_("Color file for %1 not found along %2"), color_file.get(), theme_search_path().to_string()) << endmsg;
331 (void) load_color_file (cfile);
337 PBD::Searchpath sp (user_config_directory());
339 /* user's own color files never have the program name in them */
341 if (find_file (sp, color_file_name (true, true), cfile)) {
346 if (find_file (sp, color_file_name (true, false), cfile)) {
352 (void) load_color_file (cfile);
363 UIConfiguration::store_color_theme ()
368 root = new XMLNode("Ardour");
370 XMLNode* parent = new XMLNode (X_("Colors"));
371 for (Colors::const_iterator i = colors.begin(); i != colors.end(); ++i) {
372 XMLNode* node = new XMLNode (X_("Color"));
373 node->set_property (X_("name"), i->first);
375 ss << "0x" << setw (8) << setfill ('0') << hex << i->second;
376 node->set_property (X_("value"), ss.str());
377 parent->add_child_nocopy (*node);
379 root->add_child_nocopy (*parent);
381 parent = new XMLNode (X_("ColorAliases"));
382 for (ColorAliases::const_iterator i = color_aliases.begin(); i != color_aliases.end(); ++i) {
383 XMLNode* node = new XMLNode (X_("ColorAlias"));
384 node->set_property (X_("name"), i->first);
385 node->set_property (X_("alias"), i->second);
386 parent->add_child_nocopy (*node);
388 root->add_child_nocopy (*parent);
390 parent = new XMLNode (X_("Modifiers"));
391 for (Modifiers::const_iterator i = modifiers.begin(); i != modifiers.end(); ++i) {
392 XMLNode* node = new XMLNode (X_("Modifier"));
393 node->set_property (X_("name"), i->first);
394 node->set_property (X_("modifier"), i->second.to_string());
395 parent->add_child_nocopy (*node);
397 root->add_child_nocopy (*parent);
400 std::string colorfile = Glib::build_filename (user_config_directory(), color_file_name (true, true));;
402 tree.set_root (root);
404 if (!tree.write (colorfile.c_str())){
405 error << string_compose (_("Color file %1 not saved"), colorfile) << endmsg;
413 UIConfiguration::load_state ()
415 LocaleGuard lg; // a single guard for all 3 configs
420 if (find_file (ardour_config_search_path(), default_ui_config_file_name, rcfile)) {
424 info << string_compose (_("Loading default ui configuration file %1"), rcfile) << endmsg;
426 if (!tree.read (rcfile.c_str())) {
427 error << string_compose(_("cannot read default ui configuration file \"%1\""), rcfile) << endmsg;
431 if (set_state (*tree.root(), Stateful::loading_state_version)) {
432 error << string_compose(_("default ui configuration file \"%1\" not loaded successfully."), rcfile) << endmsg;
437 if (find_file (ardour_config_search_path(), ui_config_file_name, rcfile)) {
441 info << string_compose (_("Loading user ui configuration file %1"), rcfile) << endmsg;
443 if (!tree.read (rcfile)) {
444 error << string_compose(_("cannot read ui configuration file \"%1\""), rcfile) << endmsg;
448 if (set_state (*tree.root(), Stateful::loading_state_version)) {
449 error << string_compose(_("user ui configuration file \"%1\" not loaded successfully."), rcfile) << endmsg;
457 error << _("could not find any ui configuration file, canvas will look broken.") << endmsg;
464 UIConfiguration::save_state()
466 if (block_save != 0) {
471 std::string rcfile = Glib::build_filename (user_config_directory(), ui_config_file_name);
475 tree.set_root (&get_state());
477 if (!tree.write (rcfile.c_str())){
478 error << string_compose (_("Config file %1 not saved"), rcfile) << endmsg;
485 if (aliases_modified || colors_modified || modifiers_modified) {
487 if (store_color_theme ()) {
488 error << string_compose (_("Color file %1 not saved"), color_file.get()) << endmsg;
492 aliases_modified = false;
493 colors_modified = false;
494 modifiers_modified = false;
502 UIConfiguration::get_state ()
507 root = new XMLNode("Ardour");
509 root->add_child_nocopy (get_variables ("UI"));
510 root->add_child_nocopy (get_variables ("Canvas"));
513 root->add_child_copy (*_extra_xml);
520 UIConfiguration::get_variables (std::string which_node)
525 node = new XMLNode (which_node);
527 #undef UI_CONFIG_VARIABLE
528 #undef CANVAS_FONT_VARIABLE
529 #define UI_CONFIG_VARIABLE(Type,var,Name,value) if (node->name() == "UI") { var.add_to_node (*node); }
530 #define CANVAS_FONT_VARIABLE(var,Name) if (node->name() == "Canvas") { var.add_to_node (*node); }
531 #include "ui_config_vars.h"
532 #include "canvas_vars.h"
533 #undef UI_CONFIG_VARIABLE
534 #undef CANVAS_FONT_VARIABLE
540 UIConfiguration::set_state (const XMLNode& root, int /*version*/)
543 /* this can load a generic UI configuration file or a colors file */
545 if (root.name() != "Ardour") {
549 Stateful::save_extra_xml (root);
551 XMLNodeList nlist = root.children();
552 XMLNodeConstIterator niter;
555 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
559 if (node->name() == "Canvas" || node->name() == "UI") {
560 set_variables (*node);
565 XMLNode* colors = find_named_node (root, X_("Colors"));
568 load_colors (*colors);
571 XMLNode* aliases = find_named_node (root, X_("ColorAliases"));
574 load_color_aliases (*aliases);
577 XMLNode* modifiers = find_named_node (root, X_("Modifiers"));
580 load_modifiers (*modifiers);
587 UIConfiguration::load_color_aliases (XMLNode const & node)
589 XMLNodeList const nlist = node.children();
590 XMLNodeConstIterator niter;
591 XMLProperty const *name;
592 XMLProperty const *alias;
594 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
595 XMLNode const * child = *niter;
596 if (child->name() != X_("ColorAlias")) {
599 name = child->property (X_("name"));
600 alias = child->property (X_("alias"));
603 color_aliases[name->value()] = alias->value();
609 UIConfiguration::load_colors (XMLNode const & node)
611 XMLNodeList const nlist = node.children();
612 XMLNodeConstIterator niter;
613 XMLProperty const *name;
614 XMLProperty const *color;
616 /* don't clear colors, so that we can load > 1 color file and have
617 the subsequent ones overwrite the later ones.
620 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
621 XMLNode const * child = *niter;
622 if (child->name() != X_("Color")) {
625 name = child->property (X_("name"));
626 color = child->property (X_("value"));
629 ArdourCanvas::Color c;
630 c = strtoul (color->value().c_str(), 0, 16);
631 /* insert or replace color name definition */
632 colors[name->value()] = c;
638 UIConfiguration::load_modifiers (XMLNode const & node)
641 XMLNodeList const nlist = node.children();
642 XMLNodeConstIterator niter;
643 XMLProperty const *name;
644 XMLProperty const *mod;
646 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
647 XMLNode const * child = *niter;
648 if (child->name() != X_("Modifier")) {
652 name = child->property (X_("name"));
653 mod = child->property (X_("modifier"));
656 SVAModifier svam (mod->value());
657 modifiers[name->value()] = svam;
663 UIConfiguration::set_variables (const XMLNode& node)
665 #undef UI_CONFIG_VARIABLE
666 #define UI_CONFIG_VARIABLE(Type,var,name,val) if (var.set_from_node (node)) { ParameterChanged (name); }
667 #define CANVAS_FONT_VARIABLE(var,name) if (var.set_from_node (node)) { ParameterChanged (name); }
668 #include "ui_config_vars.h"
669 #include "canvas_vars.h"
670 #undef UI_CONFIG_VARIABLE
671 #undef CANVAS_FONT_VARIABLE
674 ArdourCanvas::SVAModifier
675 UIConfiguration::modifier (string const & name) const
677 Modifiers::const_iterator m = modifiers.find (name);
678 if (m != modifiers.end()) {
681 return SVAModifier ();
685 UIConfiguration::color_mod (std::string const & colorname, std::string const & modifiername) const
687 return HSV (color (colorname)).mod (modifier (modifiername)).color ();
691 UIConfiguration::color_mod (const ArdourCanvas::Color& color, std::string const & modifiername) const
693 return HSV (color).mod (modifier (modifiername)).color ();
697 UIConfiguration::color (const std::string& name, bool* failed) const
699 ColorAliases::const_iterator e = color_aliases.find (name);
705 if (e != color_aliases.end ()) {
706 Colors::const_iterator rc = colors.find (e->second);
707 if (rc != colors.end()) {
711 /* not an alias, try directly */
712 Colors::const_iterator rc = colors.find (name);
713 if (rc != colors.end()) {
719 /* only show this message if the caller wasn't interested in
722 cerr << string_compose (_("Color %1 not found"), name) << endl;
729 return rgba_to_color ((g_random_int()%256)/255.0,
730 (g_random_int()%256)/255.0,
731 (g_random_int()%256)/255.0,
736 UIConfiguration::quantized (Color c) const
739 hsv.h = hue_width * (round (hsv.h/hue_width));
744 UIConfiguration::set_color (string const& name, ArdourCanvas::Color color)
746 Colors::iterator i = colors.find (name);
747 if (i == colors.end()) {
751 colors_modified = true;
753 ColorsChanged (); /* EMIT SIGNAL */
757 UIConfiguration::set_alias (string const & name, string const & alias)
759 ColorAliases::iterator i = color_aliases.find (name);
760 if (i == color_aliases.end()) {
765 aliases_modified = true;
767 ColorsChanged (); /* EMIT SIGNAL */
771 UIConfiguration::set_modifier (string const & name, SVAModifier svam)
773 Modifiers::iterator m = modifiers.find (name);
775 if (m == modifiers.end()) {
780 modifiers_modified = true;
782 ColorsChanged (); /* EMIT SIGNAL */
786 UIConfiguration::load_rc_file (bool themechange, bool allow_own)
788 string basename = ui_rc_file.get();
789 std::string rc_file_path;
791 if (!find_file (ardour_config_search_path(), basename, rc_file_path)) {
792 warning << string_compose (_("Unable to find UI style file %1 in search path %2. %3 will look strange"),
793 basename, ardour_config_search_path().to_string(), PROGRAM_NAME)
798 info << "Loading ui configuration file " << rc_file_path << endmsg;
800 Gtkmm2ext::UI::instance()->load_rcfile (rc_file_path, themechange);