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/stacktrace.h"
46 #include "pbd/unwind.h"
47 #include "pbd/xml++.h"
49 #include "ardour/filesystem_paths.h"
50 #include "ardour/search_paths.h"
51 #include "ardour/revision.h"
52 #include "ardour/utils.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") {
138 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 ()
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_program, bool with_version) const
269 basename = color_file.get(); //this is the overall theme file, e.g. "dark"
273 basename += downcase (PROGRAM_NAME);
276 std::string rev (revision);
277 std::size_t pos = rev.find_first_of("-");
279 if (with_version && pos != string::npos && pos > 0) {
281 basename += rev.substr (0, pos); // COLORFILE_VERSION - program major.minor
284 basename += color_file_suffix;
290 UIConfiguration::load_color_theme (bool allow_own)
294 /* ColorsChanged() will trigger a parameter_changed () which
295 * in turn calls save_state()
297 PBD::Unwinder<uint32_t> uw (block_save, block_save + 1);
301 PBD::Searchpath sp (user_config_directory());
303 if (find_file (sp, color_file_name (true, true, true), cfile)) {
309 if (find_file (sp, color_file_name (true, true, false), cfile)) {
315 if (find_file (sp, color_file_name (true, false, false), cfile)) {
324 if (find_file (theme_search_path(), color_file_name (false, true, true), cfile)) {
329 if (find_file (theme_search_path(), color_file_name (false, true, false), cfile)) {
335 if (find_file (theme_search_path(), color_file_name (false, false, false), cfile)) {
345 info << string_compose (_("Loading color file %1"), cfile) << endmsg;
347 if (!tree.read (cfile.c_str())) {
348 error << string_compose(_("cannot read color file \"%1\""), cfile) << endmsg;
352 if (set_state (*tree.root(), Stateful::loading_state_version)) {
353 error << string_compose(_("color file \"%1\" not loaded successfully."), cfile) << endmsg;
359 warning << string_compose (_("Color file for %1 not found along %2"), color_file.get(), theme_search_path().to_string()) << endmsg;
366 UIConfiguration::store_color_theme ()
371 root = new XMLNode("Ardour");
373 XMLNode* parent = new XMLNode (X_("Colors"));
374 for (Colors::const_iterator i = colors.begin(); i != colors.end(); ++i) {
375 XMLNode* node = new XMLNode (X_("Color"));
376 node->add_property (X_("name"), i->first);
378 ss << "0x" << setw (8) << setfill ('0') << hex << i->second;
379 node->add_property (X_("value"), ss.str());
380 parent->add_child_nocopy (*node);
382 root->add_child_nocopy (*parent);
384 parent = new XMLNode (X_("ColorAliases"));
385 for (ColorAliases::const_iterator i = color_aliases.begin(); i != color_aliases.end(); ++i) {
386 XMLNode* node = new XMLNode (X_("ColorAlias"));
387 node->add_property (X_("name"), i->first);
388 node->add_property (X_("alias"), i->second);
389 parent->add_child_nocopy (*node);
391 root->add_child_nocopy (*parent);
393 parent = new XMLNode (X_("Modifiers"));
394 for (Modifiers::const_iterator i = modifiers.begin(); i != modifiers.end(); ++i) {
395 XMLNode* node = new XMLNode (X_("Modifier"));
396 node->add_property (X_("name"), i->first);
397 node->add_property (X_("modifier"), i->second.to_string());
398 parent->add_child_nocopy (*node);
400 root->add_child_nocopy (*parent);
403 std::string colorfile = Glib::build_filename (user_config_directory(), color_file_name (true, true, true));;
405 tree.set_root (root);
407 if (!tree.write (colorfile.c_str())){
408 error << string_compose (_("Color file %1 not saved"), colorfile) << endmsg;
416 UIConfiguration::load_state ()
418 LocaleGuard lg; // a single guard for all 3 configs
423 if (find_file (ardour_config_search_path(), default_ui_config_file_name, rcfile)) {
427 info << string_compose (_("Loading default ui configuration file %1"), rcfile) << endmsg;
429 if (!tree.read (rcfile.c_str())) {
430 error << string_compose(_("cannot read default ui configuration file \"%1\""), rcfile) << endmsg;
434 if (set_state (*tree.root(), Stateful::loading_state_version)) {
435 error << string_compose(_("default ui configuration file \"%1\" not loaded successfully."), rcfile) << endmsg;
440 if (find_file (ardour_config_search_path(), ui_config_file_name, rcfile)) {
444 info << string_compose (_("Loading user ui configuration file %1"), rcfile) << endmsg;
446 if (!tree.read (rcfile)) {
447 error << string_compose(_("cannot read ui configuration file \"%1\""), rcfile) << endmsg;
451 if (set_state (*tree.root(), Stateful::loading_state_version)) {
452 error << string_compose(_("user ui configuration file \"%1\" not loaded successfully."), rcfile) << endmsg;
460 error << _("could not find any ui configuration file, canvas will look broken.") << endmsg;
467 UIConfiguration::save_state()
469 if (block_save != 0) {
474 std::string rcfile = Glib::build_filename (user_config_directory(), ui_config_file_name);
478 tree.set_root (&get_state());
480 if (!tree.write (rcfile.c_str())){
481 error << string_compose (_("Config file %1 not saved"), rcfile) << endmsg;
488 if (aliases_modified || colors_modified || modifiers_modified) {
490 if (store_color_theme ()) {
491 error << string_compose (_("Color file %1 not saved"), color_file.get()) << endmsg;
495 aliases_modified = false;
496 colors_modified = false;
497 modifiers_modified = false;
505 UIConfiguration::get_state ()
510 root = new XMLNode("Ardour");
512 root->add_child_nocopy (get_variables ("UI"));
513 root->add_child_nocopy (get_variables ("Canvas"));
516 root->add_child_copy (*_extra_xml);
523 UIConfiguration::get_variables (std::string which_node)
528 node = new XMLNode (which_node);
530 #undef UI_CONFIG_VARIABLE
531 #undef CANVAS_FONT_VARIABLE
532 #define UI_CONFIG_VARIABLE(Type,var,Name,value) if (node->name() == "UI") { var.add_to_node (*node); }
533 #define CANVAS_FONT_VARIABLE(var,Name) if (node->name() == "Canvas") { var.add_to_node (*node); }
534 #include "ui_config_vars.h"
535 #include "canvas_vars.h"
536 #undef UI_CONFIG_VARIABLE
537 #undef CANVAS_FONT_VARIABLE
543 UIConfiguration::set_state (const XMLNode& root, int /*version*/)
546 /* this can load a generic UI configuration file or a colors file */
548 if (root.name() != "Ardour") {
552 Stateful::save_extra_xml (root);
554 XMLNodeList nlist = root.children();
555 XMLNodeConstIterator niter;
558 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
562 if (node->name() == "Canvas" || node->name() == "UI") {
563 set_variables (*node);
568 XMLNode* colors = find_named_node (root, X_("Colors"));
571 load_colors (*colors);
574 XMLNode* aliases = find_named_node (root, X_("ColorAliases"));
577 load_color_aliases (*aliases);
580 XMLNode* modifiers = find_named_node (root, X_("Modifiers"));
583 load_modifiers (*modifiers);
590 UIConfiguration::load_color_aliases (XMLNode const & node)
592 XMLNodeList const nlist = node.children();
593 XMLNodeConstIterator niter;
594 XMLProperty const *name;
595 XMLProperty const *alias;
597 color_aliases.clear ();
599 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
600 XMLNode const * child = *niter;
601 if (child->name() != X_("ColorAlias")) {
604 name = child->property (X_("name"));
605 alias = child->property (X_("alias"));
608 color_aliases.insert (make_pair (name->value(), alias->value()));
614 UIConfiguration::load_colors (XMLNode const & node)
616 XMLNodeList const nlist = node.children();
617 XMLNodeConstIterator niter;
618 XMLProperty const *name;
619 XMLProperty const *color;
623 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
624 XMLNode const * child = *niter;
625 if (child->name() != X_("Color")) {
628 name = child->property (X_("name"));
629 color = child->property (X_("value"));
632 ArdourCanvas::Color c;
633 c = strtoul (color->value().c_str(), 0, 16);
634 colors.insert (make_pair (name->value(), c));
640 UIConfiguration::load_modifiers (XMLNode const & node)
643 XMLNodeList const nlist = node.children();
644 XMLNodeConstIterator niter;
645 XMLProperty const *name;
646 XMLProperty const *mod;
650 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
651 XMLNode const * child = *niter;
652 if (child->name() != X_("Modifier")) {
656 name = child->property (X_("name"));
657 mod = child->property (X_("modifier"));
660 SVAModifier svam (mod->value());
661 modifiers.insert (make_pair (name->value(), svam));
667 UIConfiguration::set_variables (const XMLNode& node)
669 #undef UI_CONFIG_VARIABLE
670 #define UI_CONFIG_VARIABLE(Type,var,name,val) if (var.set_from_node (node)) { ParameterChanged (name); }
671 #define CANVAS_FONT_VARIABLE(var,name) if (var.set_from_node (node)) { ParameterChanged (name); }
672 #include "ui_config_vars.h"
673 #include "canvas_vars.h"
674 #undef UI_CONFIG_VARIABLE
675 #undef CANVAS_FONT_VARIABLE
678 ArdourCanvas::SVAModifier
679 UIConfiguration::modifier (string const & name) const
681 Modifiers::const_iterator m = modifiers.find (name);
682 if (m != modifiers.end()) {
685 return SVAModifier ();
689 UIConfiguration::color_mod (std::string const & colorname, std::string const & modifiername) const
691 return HSV (color (colorname)).mod (modifier (modifiername)).color ();
695 UIConfiguration::color_mod (const ArdourCanvas::Color& color, std::string const & modifiername) const
697 return HSV (color).mod (modifier (modifiername)).color ();
701 UIConfiguration::color (const std::string& name, bool* failed) const
703 ColorAliases::const_iterator e = color_aliases.find (name);
709 if (e != color_aliases.end ()) {
710 Colors::const_iterator rc = colors.find (e->second);
711 if (rc != colors.end()) {
715 /* not an alias, try directly */
716 Colors::const_iterator rc = colors.find (name);
717 if (rc != colors.end()) {
723 /* only show this message if the caller wasn't interested in
726 cerr << string_compose (_("Color %1 not found"), name) << endl;
733 return rgba_to_color ((g_random_int()%256)/255.0,
734 (g_random_int()%256)/255.0,
735 (g_random_int()%256)/255.0,
740 UIConfiguration::quantized (Color c) const
743 hsv.h = hue_width * (round (hsv.h/hue_width));
748 UIConfiguration::set_color (string const& name, ArdourCanvas::Color color)
750 Colors::iterator i = colors.find (name);
751 if (i == colors.end()) {
755 colors_modified = true;
757 ColorsChanged (); /* EMIT SIGNAL */
761 UIConfiguration::set_alias (string const & name, string const & alias)
763 ColorAliases::iterator i = color_aliases.find (name);
764 if (i == color_aliases.end()) {
769 aliases_modified = true;
771 ColorsChanged (); /* EMIT SIGNAL */
775 UIConfiguration::set_modifier (string const & name, SVAModifier svam)
777 Modifiers::iterator m = modifiers.find (name);
779 if (m == modifiers.end()) {
784 modifiers_modified = true;
786 ColorsChanged (); /* EMIT SIGNAL */
790 UIConfiguration::load_rc_file (bool themechange, bool allow_own)
792 string basename = ui_rc_file.get();
793 std::string rc_file_path;
795 if (!find_file (ardour_config_search_path(), basename, rc_file_path)) {
796 warning << string_compose (_("Unable to find UI style file %1 in search path %2. %3 will look strange"),
797 basename, ardour_config_search_path().to_string(), PROGRAM_NAME)
802 info << "Loading ui configuration file " << rc_file_path << endmsg;
804 Gtkmm2ext::UI::instance()->load_rcfile (rc_file_path, themechange);