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") {
137 UIConfiguration::reset_gtk_theme ()
141 ss << "gtk_color_scheme = \"" << hex;
143 for (ColorAliases::iterator g = color_aliases.begin(); g != color_aliases.end(); ++g) {
145 if (g->first.find ("gtk_") == 0) {
146 const string gtk_name = g->first.substr (4);
147 ss << gtk_name << ":#" << std::setw (6) << setfill ('0') << (color (g->second) >> 8) << ';';
151 ss << '"' << dec << endl;
153 /* reset GTK color scheme */
155 Gtk::Settings::get_default()->property_gtk_color_scheme() = ss.str();
159 UIConfiguration::reset_dpi ()
161 long val = get_font_scale();
162 set_pango_fontsize ();
165 gtk_settings_set_long_property (gtk_settings_get_default(),
166 "gtk-xft-dpi", val, "ardour");
167 DPIReset(); //Emit Signal
171 UIConfiguration::set_pango_fontsize ()
173 long val = get_font_scale();
175 /* FT2 rendering - used by GnomeCanvas, sigh */
177 #ifndef PLATFORM_WINDOWS
178 pango_ft2_font_map_set_resolution ((PangoFT2FontMap*) pango_ft2_font_map_new(), val/1024, val/1024);
181 /* Cairo rendering, in case there is any */
183 pango_cairo_font_map_set_resolution ((PangoCairoFontMap*) pango_cairo_font_map_get_default(), val/1024);
187 UIConfiguration::get_ui_scale ()
189 return get_font_scale () / 102400.;
193 UIConfiguration::map_parameters (boost::function<void (std::string)>& functor)
195 #undef UI_CONFIG_VARIABLE
196 #define UI_CONFIG_VARIABLE(Type,var,Name,value) functor (Name);
197 #include "ui_config_vars.h"
198 #undef UI_CONFIG_VARIABLE
202 UIConfiguration::pre_gui_init ()
204 #ifdef CAIRO_SUPPORTS_FORCE_BUGGY_GRADIENTS_ENVIRONMENT_VARIABLE
205 if (get_buggy_gradients()) {
206 g_setenv ("FORCE_BUGGY_GRADIENTS", "1", 1);
209 #ifdef OPTIONAL_CAIRO_IMAGE_SURFACE
210 if (get_cairo_image_surface()) {
211 g_setenv ("ARDOUR_IMAGE_SURFACE", "1", 1);
218 UIConfiguration::post_gui_init ()
225 UIConfiguration::load_defaults ()
230 if (find_file (ardour_config_search_path(), default_ui_config_file_name, rcfile) ) {
233 info << string_compose (_("Loading default ui configuration file %1"), rcfile) << endmsg;
235 if (!tree.read (rcfile.c_str())) {
236 error << string_compose(_("cannot read default ui configuration file \"%1\""), rcfile) << endmsg;
238 if (set_state (*tree.root(), Stateful::loading_state_version)) {
239 error << string_compose(_("default ui configuration file \"%1\" not loaded successfully."), rcfile) << endmsg;
247 warning << string_compose (_("Could not find default UI configuration file %1"), default_ui_config_file_name) << endmsg;
252 /* reload color theme */
253 load_color_theme (false);
260 UIConfiguration::color_file_name (bool use_my, bool with_program_name, bool with_version) const
268 basename += color_file.get(); //this is the overall theme file, e.g. "dark"
270 if (with_program_name) {
272 basename += downcase (PROGRAM_NAME);
275 std::string rev (revision);
276 std::size_t pos = rev.find_first_of("-");
278 if (with_version && pos != string::npos && pos > 0) {
280 basename += rev.substr (0, pos); // COLORFILE_VERSION - program major.minor
283 basename += color_file_suffix;
289 UIConfiguration::load_color_theme (bool allow_own)
293 /* ColorsChanged() will trigger a parameter_changed () which
294 * in turn calls save_state()
296 PBD::Unwinder<uint32_t> uw (block_save, block_save + 1);
297 const bool running_from_source = ARDOUR_UI_UTILS::running_from_source_tree ();
301 PBD::Searchpath sp (user_config_directory());
303 /* user's own color files never have the program name in them */
305 if (find_file (sp, color_file_name (true, false, true), cfile)) {
310 if (find_file (sp, color_file_name (true, false, false), cfile)) {
318 if (find_file (theme_search_path(), color_file_name (false, running_from_source, true), cfile)) {
323 if (find_file (theme_search_path(), color_file_name (false, running_from_source, false), cfile)) {
330 warning << string_compose (_("Color file for %1 not found along %2"), color_file.get(), theme_search_path().to_string()) << endmsg;
337 info << string_compose (_("Loading color file %1"), cfile) << endmsg;
339 if (!tree.read (cfile.c_str())) {
340 error << string_compose(_("cannot read color file \"%1\""), cfile) << endmsg;
344 if (set_state (*tree.root(), Stateful::loading_state_version)) {
345 error << string_compose(_("color file \"%1\" not loaded successfully."), cfile) << endmsg;
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, false, 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 color_aliases.clear ();
588 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
589 XMLNode const * child = *niter;
590 if (child->name() != X_("ColorAlias")) {
593 name = child->property (X_("name"));
594 alias = child->property (X_("alias"));
597 color_aliases.insert (make_pair (name->value(), alias->value()));
603 UIConfiguration::load_colors (XMLNode const & node)
605 XMLNodeList const nlist = node.children();
606 XMLNodeConstIterator niter;
607 XMLProperty const *name;
608 XMLProperty const *color;
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 colors.insert (make_pair (name->value(), c));
629 UIConfiguration::load_modifiers (XMLNode const & node)
632 XMLNodeList const nlist = node.children();
633 XMLNodeConstIterator niter;
634 XMLProperty const *name;
635 XMLProperty const *mod;
639 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
640 XMLNode const * child = *niter;
641 if (child->name() != X_("Modifier")) {
645 name = child->property (X_("name"));
646 mod = child->property (X_("modifier"));
649 SVAModifier svam (mod->value());
650 modifiers.insert (make_pair (name->value(), svam));
656 UIConfiguration::set_variables (const XMLNode& node)
658 #undef UI_CONFIG_VARIABLE
659 #define UI_CONFIG_VARIABLE(Type,var,name,val) if (var.set_from_node (node)) { ParameterChanged (name); }
660 #define CANVAS_FONT_VARIABLE(var,name) if (var.set_from_node (node)) { ParameterChanged (name); }
661 #include "ui_config_vars.h"
662 #include "canvas_vars.h"
663 #undef UI_CONFIG_VARIABLE
664 #undef CANVAS_FONT_VARIABLE
667 ArdourCanvas::SVAModifier
668 UIConfiguration::modifier (string const & name) const
670 Modifiers::const_iterator m = modifiers.find (name);
671 if (m != modifiers.end()) {
674 return SVAModifier ();
678 UIConfiguration::color_mod (std::string const & colorname, std::string const & modifiername) const
680 return HSV (color (colorname)).mod (modifier (modifiername)).color ();
684 UIConfiguration::color_mod (const ArdourCanvas::Color& color, std::string const & modifiername) const
686 return HSV (color).mod (modifier (modifiername)).color ();
690 UIConfiguration::color (const std::string& name, bool* failed) const
692 ColorAliases::const_iterator e = color_aliases.find (name);
698 if (e != color_aliases.end ()) {
699 Colors::const_iterator rc = colors.find (e->second);
700 if (rc != colors.end()) {
704 /* not an alias, try directly */
705 Colors::const_iterator rc = colors.find (name);
706 if (rc != colors.end()) {
712 /* only show this message if the caller wasn't interested in
715 cerr << string_compose (_("Color %1 not found"), name) << endl;
722 return rgba_to_color ((g_random_int()%256)/255.0,
723 (g_random_int()%256)/255.0,
724 (g_random_int()%256)/255.0,
729 UIConfiguration::quantized (Color c) const
732 hsv.h = hue_width * (round (hsv.h/hue_width));
737 UIConfiguration::set_color (string const& name, ArdourCanvas::Color color)
739 Colors::iterator i = colors.find (name);
740 if (i == colors.end()) {
744 colors_modified = true;
746 ColorsChanged (); /* EMIT SIGNAL */
750 UIConfiguration::set_alias (string const & name, string const & alias)
752 ColorAliases::iterator i = color_aliases.find (name);
753 if (i == color_aliases.end()) {
758 aliases_modified = true;
760 ColorsChanged (); /* EMIT SIGNAL */
764 UIConfiguration::set_modifier (string const & name, SVAModifier svam)
766 Modifiers::iterator m = modifiers.find (name);
768 if (m == modifiers.end()) {
773 modifiers_modified = true;
775 ColorsChanged (); /* EMIT SIGNAL */
779 UIConfiguration::load_rc_file (bool themechange, bool allow_own)
781 string basename = ui_rc_file.get();
782 std::string rc_file_path;
784 if (!find_file (ardour_config_search_path(), basename, rc_file_path)) {
785 warning << string_compose (_("Unable to find UI style file %1 in search path %2. %3 will look strange"),
786 basename, ardour_config_search_path().to_string(), PROGRAM_NAME)
791 info << "Loading ui configuration file " << rc_file_path << endmsg;
793 Gtkmm2ext::UI::instance()->load_rcfile (rc_file_path, themechange);