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 ()
141 std::string color_scheme_string("gtk_color_scheme = \"");
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 ArdourCanvas::Color a_color = color (g->second);
149 color_scheme_string += gtk_name + ":#" + color_to_hex_string_no_alpha (a_color) + ';';
153 color_scheme_string += '"';
155 /* reset GTK color scheme */
157 Gtk::Settings::get_default()->property_gtk_color_scheme() = color_scheme_string;
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;
247 /* reload color theme */
248 load_color_theme (false);
255 UIConfiguration::color_file_name (bool use_my, bool with_version) const
263 std::string color_name = color_file.get();
264 size_t sep = color_name.find_first_of("-");
265 if (sep != string::npos) {
266 color_name = color_name.substr (0, sep);
269 basename += color_name;
271 basename += downcase(std::string(PROGRAM_NAME));
273 std::string rev (revision);
274 std::size_t pos = rev.find_first_of("-");
276 if (with_version && pos != string::npos && pos > 0) {
278 basename += rev.substr (0, pos); // COLORFILE_VERSION - program major.minor
281 basename += color_file_suffix;
286 UIConfiguration::load_color_file (string const & path)
290 info << string_compose (_("Loading color file %1"), path) << endmsg;
292 if (!tree.read (path.c_str())) {
293 error << string_compose(_("cannot read color file \"%1\""), path) << endmsg;
297 if (set_state (*tree.root(), Stateful::loading_state_version)) {
298 error << string_compose(_("color file \"%1\" not loaded successfully."), path) << endmsg;
306 UIConfiguration::load_color_theme (bool allow_own)
310 /* ColorsChanged() will trigger a parameter_changed () which
311 * in turn calls save_state()
313 PBD::Unwinder<uint32_t> uw (block_save, block_save + 1);
315 if (find_file (theme_search_path(), color_file_name (false, true), cfile)) {
320 if (find_file (theme_search_path(), color_file_name (false, false), cfile)) {
326 warning << string_compose (_("Color file for %1 not found along %2"), color_file.get(), theme_search_path().to_string()) << endmsg;
330 (void) load_color_file (cfile);
336 PBD::Searchpath sp (user_config_directory());
338 /* user's own color files never have the program name in them */
340 if (find_file (sp, color_file_name (true, true), cfile)) {
345 if (find_file (sp, color_file_name (true, false), cfile)) {
351 (void) load_color_file (cfile);
362 UIConfiguration::store_color_theme ()
367 root = new XMLNode("Ardour");
369 XMLNode* parent = new XMLNode (X_("Colors"));
370 for (Colors::const_iterator i = colors.begin(); i != colors.end(); ++i) {
371 XMLNode* node = new XMLNode (X_("Color"));
372 node->set_property (X_("name"), i->first);
373 node->set_property (X_("value"), color_to_hex_string (i->second));
374 parent->add_child_nocopy (*node);
376 root->add_child_nocopy (*parent);
378 parent = new XMLNode (X_("ColorAliases"));
379 for (ColorAliases::const_iterator i = color_aliases.begin(); i != color_aliases.end(); ++i) {
380 XMLNode* node = new XMLNode (X_("ColorAlias"));
381 node->set_property (X_("name"), i->first);
382 node->set_property (X_("alias"), i->second);
383 parent->add_child_nocopy (*node);
385 root->add_child_nocopy (*parent);
387 parent = new XMLNode (X_("Modifiers"));
388 for (Modifiers::const_iterator i = modifiers.begin(); i != modifiers.end(); ++i) {
389 XMLNode* node = new XMLNode (X_("Modifier"));
390 node->set_property (X_("name"), i->first);
391 node->set_property (X_("modifier"), i->second.to_string());
392 parent->add_child_nocopy (*node);
394 root->add_child_nocopy (*parent);
397 std::string colorfile = Glib::build_filename (user_config_directory(), color_file_name (true, true));;
399 tree.set_root (root);
401 if (!tree.write (colorfile.c_str())){
402 error << string_compose (_("Color file %1 not saved"), colorfile) << endmsg;
410 UIConfiguration::load_state ()
412 LocaleGuard lg; // a single guard for all 3 configs
417 if (find_file (ardour_config_search_path(), default_ui_config_file_name, rcfile)) {
421 info << string_compose (_("Loading default ui configuration file %1"), rcfile) << endmsg;
423 if (!tree.read (rcfile.c_str())) {
424 error << string_compose(_("cannot read default ui configuration file \"%1\""), rcfile) << endmsg;
428 if (set_state (*tree.root(), Stateful::loading_state_version)) {
429 error << string_compose(_("default ui configuration file \"%1\" not loaded successfully."), rcfile) << endmsg;
434 if (find_file (ardour_config_search_path(), ui_config_file_name, rcfile)) {
438 info << string_compose (_("Loading user ui configuration file %1"), rcfile) << endmsg;
440 if (!tree.read (rcfile)) {
441 error << string_compose(_("cannot read ui configuration file \"%1\""), rcfile) << endmsg;
445 if (set_state (*tree.root(), Stateful::loading_state_version)) {
446 error << string_compose(_("user ui configuration file \"%1\" not loaded successfully."), rcfile) << endmsg;
454 error << _("could not find any ui configuration file, canvas will look broken.") << endmsg;
461 UIConfiguration::save_state()
463 if (block_save != 0) {
468 std::string rcfile = Glib::build_filename (user_config_directory(), ui_config_file_name);
472 tree.set_root (&get_state());
474 if (!tree.write (rcfile.c_str())){
475 error << string_compose (_("Config file %1 not saved"), rcfile) << endmsg;
482 if (aliases_modified || colors_modified || modifiers_modified) {
484 if (store_color_theme ()) {
485 error << string_compose (_("Color file %1 not saved"), color_file.get()) << endmsg;
489 aliases_modified = false;
490 colors_modified = false;
491 modifiers_modified = false;
499 UIConfiguration::get_state ()
504 root = new XMLNode("Ardour");
506 root->add_child_nocopy (get_variables ("UI"));
507 root->add_child_nocopy (get_variables ("Canvas"));
510 root->add_child_copy (*_extra_xml);
517 UIConfiguration::get_variables (std::string which_node)
522 node = new XMLNode (which_node);
524 #undef UI_CONFIG_VARIABLE
525 #undef CANVAS_FONT_VARIABLE
526 #define UI_CONFIG_VARIABLE(Type,var,Name,value) if (node->name() == "UI") { var.add_to_node (*node); }
527 #define CANVAS_FONT_VARIABLE(var,Name) if (node->name() == "Canvas") { var.add_to_node (*node); }
528 #include "ui_config_vars.h"
529 #include "canvas_vars.h"
530 #undef UI_CONFIG_VARIABLE
531 #undef CANVAS_FONT_VARIABLE
537 UIConfiguration::set_state (const XMLNode& root, int /*version*/)
540 /* this can load a generic UI configuration file or a colors file */
542 if (root.name() != "Ardour") {
546 Stateful::save_extra_xml (root);
548 XMLNodeList nlist = root.children();
549 XMLNodeConstIterator niter;
552 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
556 if (node->name() == "Canvas" || node->name() == "UI") {
557 set_variables (*node);
562 XMLNode* colors = find_named_node (root, X_("Colors"));
565 load_colors (*colors);
568 XMLNode* aliases = find_named_node (root, X_("ColorAliases"));
571 load_color_aliases (*aliases);
574 XMLNode* modifiers = find_named_node (root, X_("Modifiers"));
577 load_modifiers (*modifiers);
584 UIConfiguration::load_color_aliases (XMLNode const & node)
586 XMLNodeList const nlist = node.children();
587 XMLNodeConstIterator niter;
588 XMLProperty const *name;
589 XMLProperty const *alias;
591 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
592 XMLNode const * child = *niter;
593 if (child->name() != X_("ColorAlias")) {
596 name = child->property (X_("name"));
597 alias = child->property (X_("alias"));
600 color_aliases[name->value()] = alias->value();
606 UIConfiguration::load_colors (XMLNode const & node)
608 XMLNodeList const nlist = node.children();
609 XMLNodeConstIterator niter;
610 XMLProperty const *name;
611 XMLProperty const *color;
613 /* don't clear colors, so that we can load > 1 color file and have
614 the subsequent ones overwrite the later ones.
617 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
618 XMLNode const * child = *niter;
619 if (child->name() != X_("Color")) {
622 name = child->property (X_("name"));
623 color = child->property (X_("value"));
626 ArdourCanvas::Color c;
627 c = strtoul (color->value().c_str(), 0, 16);
628 /* insert or replace color name definition */
629 colors[name->value()] = c;
635 UIConfiguration::load_modifiers (XMLNode const & node)
638 XMLNodeList const nlist = node.children();
639 XMLNodeConstIterator niter;
640 XMLProperty const *name;
641 XMLProperty const *mod;
643 for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
644 XMLNode const * child = *niter;
645 if (child->name() != X_("Modifier")) {
649 name = child->property (X_("name"));
650 mod = child->property (X_("modifier"));
653 SVAModifier svam (mod->value());
654 modifiers[name->value()] = svam;
660 UIConfiguration::set_variables (const XMLNode& node)
662 #undef UI_CONFIG_VARIABLE
663 #define UI_CONFIG_VARIABLE(Type,var,name,val) if (var.set_from_node (node)) { ParameterChanged (name); }
664 #define CANVAS_FONT_VARIABLE(var,name) if (var.set_from_node (node)) { ParameterChanged (name); }
665 #include "ui_config_vars.h"
666 #include "canvas_vars.h"
667 #undef UI_CONFIG_VARIABLE
668 #undef CANVAS_FONT_VARIABLE
671 ArdourCanvas::SVAModifier
672 UIConfiguration::modifier (string const & name) const
674 Modifiers::const_iterator m = modifiers.find (name);
675 if (m != modifiers.end()) {
678 return SVAModifier ();
682 UIConfiguration::color_mod (std::string const & colorname, std::string const & modifiername) const
684 return HSV (color (colorname)).mod (modifier (modifiername)).color ();
688 UIConfiguration::color_mod (const ArdourCanvas::Color& color, std::string const & modifiername) const
690 return HSV (color).mod (modifier (modifiername)).color ();
694 UIConfiguration::color (const std::string& name, bool* failed) const
696 ColorAliases::const_iterator e = color_aliases.find (name);
702 if (e != color_aliases.end ()) {
703 Colors::const_iterator rc = colors.find (e->second);
704 if (rc != colors.end()) {
708 /* not an alias, try directly */
709 Colors::const_iterator rc = colors.find (name);
710 if (rc != colors.end()) {
716 /* only show this message if the caller wasn't interested in
719 cerr << string_compose (_("Color %1 not found"), name) << endl;
726 return rgba_to_color ((g_random_int()%256)/255.0,
727 (g_random_int()%256)/255.0,
728 (g_random_int()%256)/255.0,
733 UIConfiguration::quantized (Color c) const
736 hsv.h = hue_width * (round (hsv.h/hue_width));
741 UIConfiguration::set_color (string const& name, ArdourCanvas::Color color)
743 Colors::iterator i = colors.find (name);
744 if (i == colors.end()) {
748 colors_modified = true;
750 ColorsChanged (); /* EMIT SIGNAL */
754 UIConfiguration::set_alias (string const & name, string const & alias)
756 ColorAliases::iterator i = color_aliases.find (name);
757 if (i == color_aliases.end()) {
762 aliases_modified = true;
764 ColorsChanged (); /* EMIT SIGNAL */
768 UIConfiguration::set_modifier (string const & name, SVAModifier svam)
770 Modifiers::iterator m = modifiers.find (name);
772 if (m == modifiers.end()) {
777 modifiers_modified = true;
779 ColorsChanged (); /* EMIT SIGNAL */
783 UIConfiguration::load_rc_file (bool themechange, bool allow_own)
785 string basename = ui_rc_file.get();
786 std::string rc_file_path;
788 if (!find_file (ardour_config_search_path(), basename, rc_file_path)) {
789 warning << string_compose (_("Unable to find UI style file %1 in search path %2. %3 will look strange"),
790 basename, ardour_config_search_path().to_string(), PROGRAM_NAME)
795 info << "Loading ui configuration file " << rc_file_path << endmsg;
797 Gtkmm2ext::UI::instance()->load_rcfile (rc_file_path, themechange);
801 UIConfiguration::color_to_hex_string (ArdourCanvas::Color c)
804 int retval = g_snprintf (buf, sizeof(buf), "%08x", c);
806 if (retval < 0 || retval >= (int)sizeof(buf)) {
813 UIConfiguration::color_to_hex_string_no_alpha (ArdourCanvas::Color c)
815 c >>= 8; // shift/remove alpha
817 int retval = g_snprintf (buf, sizeof(buf), "%06x", c);
819 if (retval < 0 || retval >= (int)sizeof(buf)) {