a reverb is a reverb is a reverb
[ardour.git] / gtk2_ardour / ui_config.cc
index 8e6c03a9802180b01092a86d70694f5b637f41b8..2db640681d4b219e9317affde2e85e7df59e9228 100644 (file)
 #include <pango/pangocairo.h> // for fontmap resolution control for GnomeCanvas
 
 #include <glibmm/miscutils.h>
-#include <glib/gstdio.h>
 
 #include <gtkmm/settings.h>
 
 #include "pbd/convert.h"
+#include "pbd/error.h"
 #include "pbd/failed_constructor.h"
-#include "pbd/xml++.h"
 #include "pbd/file_utils.h"
+#include "pbd/gstdio_compat.h"
 #include "pbd/locale_guard.h"
-#include "pbd/error.h"
-#include "pbd/stacktrace.h"
-
-#include "gtkmm2ext/rgb_macros.h"
-#include "gtkmm2ext/gtk_ui.h"
+#include "pbd/unwind.h"
+#include "pbd/xml++.h"
 
 #include "ardour/filesystem_paths.h"
+#include "ardour/search_paths.h"
+#include "ardour/revision.h"
 #include "ardour/utils.h"
 
+#include "gtkmm2ext/rgb_macros.h"
+#include "gtkmm2ext/gtk_ui.h"
+
 #include "ui_config.h"
 
-#include "i18n.h"
+#include "pbd/i18n.h"
 
 using namespace std;
 using namespace PBD;
@@ -62,13 +64,16 @@ using namespace ArdourCanvas;
 
 static const char* ui_config_file_name = "ui_config";
 static const char* default_ui_config_file_name = "default_ui_config";
-UIConfiguration* UIConfiguration::_instance = 0;
 
 static const double hue_width = 18.0;
+std::string UIConfiguration::color_file_suffix = X_(".colors");
 
-sigc::signal<void>  UIConfiguration::ColorsChanged;
-
-sigc::signal<void>  UIConfiguration::DPIReset;
+UIConfiguration&
+UIConfiguration::instance ()
+{
+       static UIConfiguration s_instance;
+       return s_instance;
+}
 
 UIConfiguration::UIConfiguration ()
        :
@@ -86,8 +91,6 @@ UIConfiguration::UIConfiguration ()
        modifiers_modified (false),
        block_save (0)
 {
-       _instance = this;
-
        load_state();
 
        ColorsChanged.connect (boost::bind (&UIConfiguration::colors_changed, this));
@@ -120,11 +123,11 @@ void
 UIConfiguration::parameter_changed (string param)
 {
        _dirty = true;
-       
+
        if (param == "ui-rc-file") {
                load_rc_file (true);
        } else if (param == "color-file") {
-               load_color_theme ();
+               load_color_theme (true);
        }
 
        save_state ();
@@ -133,12 +136,13 @@ UIConfiguration::parameter_changed (string param)
 void
 UIConfiguration::reset_gtk_theme ()
 {
+       LocaleGuard lg;
        stringstream ss;
 
        ss << "gtk_color_scheme = \"" << hex;
-       
+
        for (ColorAliases::iterator g = color_aliases.begin(); g != color_aliases.end(); ++g) {
-               
+
                if (g->first.find ("gtk_") == 0) {
                        const string gtk_name = g->first.substr (4);
                        ss << gtk_name << ":#" << std::setw (6) << setfill ('0') << (color (g->second) >> 8) << ';';
@@ -154,18 +158,6 @@ UIConfiguration::reset_gtk_theme ()
 
 void
 UIConfiguration::reset_dpi ()
-{
-       long val = get_font_scale();
-       set_pango_fontsize ();
-       /* Xft rendering */
-
-       gtk_settings_set_long_property (gtk_settings_get_default(),
-                                       "gtk-xft-dpi", val, "ardour");
-       DPIReset(); //Emit Signal
-}
-
-void
-UIConfiguration::set_pango_fontsize ()
 {
        long val = get_font_scale();
 
@@ -178,6 +170,18 @@ UIConfiguration::set_pango_fontsize ()
        /* Cairo rendering, in case there is any */
 
        pango_cairo_font_map_set_resolution ((PangoCairoFontMap*) pango_cairo_font_map_get_default(), val/1024);
+
+       /* Xft rendering */
+
+       gtk_settings_set_long_property (gtk_settings_get_default(),
+                                       "gtk-xft-dpi", val, "ardour");
+       DPIReset(); //Emit Signal
+}
+
+float
+UIConfiguration::get_ui_scale ()
+{
+       return get_font_scale () / 102400.;
 }
 
 void
@@ -208,7 +212,7 @@ UIConfiguration::pre_gui_init ()
 UIConfiguration*
 UIConfiguration::post_gui_init ()
 {
-       load_color_theme ();
+       load_color_theme (true);
        return this;
 }
 
@@ -217,7 +221,7 @@ UIConfiguration::load_defaults ()
 {
         std::string rcfile;
        int ret = -1;
-       
+
        if (find_file (ardour_config_search_path(), default_ui_config_file_name, rcfile) ) {
                XMLTree tree;
 
@@ -242,59 +246,108 @@ UIConfiguration::load_defaults ()
        if (ret == 0) {
                /* reload color theme */
                load_color_theme (false);
-               ColorsChanged (); /* EMIT SIGNAL */
        }
 
        return ret;
 }
 
+std::string
+UIConfiguration::color_file_name (bool use_my, bool with_version) const
+{
+       string basename;
+
+       if (use_my) {
+               basename += "my-";
+       }
+
+       //this is the overall theme file, e.g. "dark" plus "-downcase(PROGRAM_NAME)"
+       basename += color_file.get();  
+
+       std::string rev (revision);
+       std::size_t pos = rev.find_first_of("-");
+
+       if (with_version && pos != string::npos && pos > 0) {
+               basename += "-";
+               basename += rev.substr (0, pos); // COLORFILE_VERSION - program major.minor
+       }
+
+       basename += color_file_suffix;
+       return basename;
+}
+
+int
+UIConfiguration::load_color_file (string const & path)
+{
+       XMLTree tree;
+
+       info << string_compose (_("Loading color file %1"), path) << endmsg;
+
+       if (!tree.read (path.c_str())) {
+               error << string_compose(_("cannot read color file \"%1\""), path) << endmsg;
+               return -1;
+       }
+
+       if (set_state (*tree.root(), Stateful::loading_state_version)) {
+               error << string_compose(_("color file \"%1\" not loaded successfully."), path) << endmsg;
+               return -1;
+       }
+
+       return 0;
+}
+
 int
 UIConfiguration::load_color_theme (bool allow_own)
 {
        std::string cfile;
-       string basename;
        bool found = false;
+       /* ColorsChanged() will trigger a  parameter_changed () which
+        * in turn calls save_state()
+        */
+       PBD::Unwinder<uint32_t> uw (block_save, block_save + 1);
 
-       if (allow_own) {
-               basename = "my-";
-               basename += color_file.get();
-               basename += ".colors";
+       if (find_file (theme_search_path(), color_file_name (false, true), cfile)) {
+               found = true;
+       }
 
-               if (find_file (ardour_config_search_path(), basename, cfile)) {
+       if (!found) {
+               if (find_file (theme_search_path(), color_file_name (false, false), cfile)) {
                        found = true;
                }
        }
 
        if (!found) {
-               basename = color_file.get();
-               basename += ".colors";
-       
-               if (find_file (ardour_config_search_path(), basename, cfile)) {
-                       found = true;
-               }
+               warning << string_compose (_("Color file for %1 not found along %2"), color_file.get(), theme_search_path().to_string()) << endmsg;
+               return -1;
        }
 
-       if (found) {
+       (void) load_color_file (cfile);
 
-               XMLTree tree;
-               
-               info << string_compose (_("Loading color file %1"), cfile) << endmsg;
+       if (allow_own) {
 
-               if (!tree.read (cfile.c_str())) {
-                       error << string_compose(_("cannot read color file \"%1\""), cfile) << endmsg;
-                       return -1;
+               found = false;
+
+               PBD::Searchpath sp (user_config_directory());
+
+               /* user's own color files never have the program name in them */
+
+               if (find_file (sp, color_file_name (true, true), cfile)) {
+                       found = true;
                }
 
-               if (set_state (*tree.root(), Stateful::loading_state_version)) {
-                       error << string_compose(_("color file \"%1\" not loaded successfully."), cfile) << endmsg;
-                       return -1;
+               if (!found) {
+                       if (find_file (sp, color_file_name (true, false), cfile)) {
+                               found = true;
+                       }
+               }
+
+               if (found) {
+                       (void) load_color_file (cfile);
                }
 
-               ColorsChanged ();
-       } else {
-               warning << string_compose (_("Color file %1 not found"), basename) << endmsg;
        }
 
+       ColorsChanged ();
+
        return 0;
 }
 
@@ -302,7 +355,7 @@ int
 UIConfiguration::store_color_theme ()
 {
        XMLNode* root;
-       LocaleGuard lg (X_("C"));
+       LocaleGuard lg;
 
        root = new XMLNode("Ardour");
 
@@ -316,7 +369,7 @@ UIConfiguration::store_color_theme ()
                parent->add_child_nocopy (*node);
        }
        root->add_child_nocopy (*parent);
-       
+
        parent = new XMLNode (X_("ColorAliases"));
        for (ColorAliases::const_iterator i = color_aliases.begin(); i != color_aliases.end(); ++i) {
                XMLNode* node = new XMLNode (X_("ColorAlias"));
@@ -336,8 +389,8 @@ UIConfiguration::store_color_theme ()
        root->add_child_nocopy (*parent);
 
        XMLTree tree;
-       std::string colorfile = Glib::build_filename (user_config_directory(), (string ("my-") + color_file.get() + ".colors"));
-       
+       std::string colorfile = Glib::build_filename (user_config_directory(), color_file_name (true, true));;
+
        tree.set_root (root);
 
        if (!tree.write (colorfile.c_str())){
@@ -351,6 +404,7 @@ UIConfiguration::store_color_theme ()
 int
 UIConfiguration::load_state ()
 {
+       LocaleGuard lg; // a single guard for all 3 configs
        bool found = false;
 
        std::string rcfile;
@@ -401,10 +455,13 @@ UIConfiguration::load_state ()
 int
 UIConfiguration::save_state()
 {
+       if (block_save != 0) {
+               return -1;
+       }
 
        if (_dirty) {
                std::string rcfile = Glib::build_filename (user_config_directory(), ui_config_file_name);
-               
+
                XMLTree tree;
 
                tree.set_root (&get_state());
@@ -428,7 +485,7 @@ UIConfiguration::save_state()
                colors_modified = false;
                modifiers_modified = false;
        }
-       
+
 
        return 0;
 }
@@ -437,7 +494,7 @@ XMLNode&
 UIConfiguration::get_state ()
 {
        XMLNode* root;
-       LocaleGuard lg (X_("C"));
+       LocaleGuard lg;
 
        root = new XMLNode("Ardour");
 
@@ -455,7 +512,7 @@ XMLNode&
 UIConfiguration::get_variables (std::string which_node)
 {
        XMLNode* node;
-       LocaleGuard lg (X_("C"));
+       LocaleGuard lg;
 
        node = new XMLNode (which_node);
 
@@ -474,6 +531,7 @@ UIConfiguration::get_variables (std::string which_node)
 int
 UIConfiguration::set_state (const XMLNode& root, int /*version*/)
 {
+       LocaleGuard lg;
        /* this can load a generic UI configuration file or a colors file */
 
        if (root.name() != "Ardour") {
@@ -524,18 +582,17 @@ UIConfiguration::load_color_aliases (XMLNode const & node)
        XMLNodeConstIterator niter;
        XMLProperty const *name;
        XMLProperty const *alias;
-       
-       color_aliases.clear ();
 
        for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
-               if ((*niter)->name() != X_("ColorAlias")) {
+               XMLNode const * child = *niter;
+               if (child->name() != X_("ColorAlias")) {
                        continue;
                }
-               name = (*niter)->property (X_("name"));
-               alias = (*niter)->property (X_("alias"));
+               name = child->property (X_("name"));
+               alias = child->property (X_("alias"));
 
                if (name && alias) {
-                       color_aliases.insert (make_pair (name->value(), alias->value()));
+                       color_aliases[name->value()] = alias->value();
                }
        }
 }
@@ -547,20 +604,24 @@ UIConfiguration::load_colors (XMLNode const & node)
        XMLNodeConstIterator niter;
        XMLProperty const *name;
        XMLProperty const *color;
-       
-       colors.clear ();
+
+       /* don't clear colors, so that we can load > 1 color file and have
+          the subsequent ones overwrite the later ones.
+       */
 
        for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
-               if ((*niter)->name() != X_("Color")) {
+               XMLNode const * child = *niter;
+               if (child->name() != X_("Color")) {
                        continue;
                }
-               name = (*niter)->property (X_("name"));
-               color = (*niter)->property (X_("value"));
+               name = child->property (X_("name"));
+               color = child->property (X_("value"));
 
                if (name && color) {
                        ArdourCanvas::Color c;
                        c = strtoul (color->value().c_str(), 0, 16);
-                       colors.insert (make_pair (name->value(), c));
+                       /* insert or replace color name definition */
+                       colors[name->value()] =  c;
                }
        }
 }
@@ -568,25 +629,24 @@ UIConfiguration::load_colors (XMLNode const & node)
 void
 UIConfiguration::load_modifiers (XMLNode const & node)
 {
-       PBD::LocaleGuard lg ("C");
+       PBD::LocaleGuard lg;
        XMLNodeList const nlist = node.children();
        XMLNodeConstIterator niter;
        XMLProperty const *name;
        XMLProperty const *mod;
-       
-       modifiers.clear ();
-       
+
        for (niter = nlist.begin(); niter != nlist.end(); ++niter) {
-               if ((*niter)->name() != X_("Modifier")) {
+               XMLNode const * child = *niter;
+               if (child->name() != X_("Modifier")) {
                        continue;
                }
 
-               name = (*niter)->property (X_("name"));
-               mod = (*niter)->property (X_("modifier"));
+               name = child->property (X_("name"));
+               mod = child->property (X_("modifier"));
 
                if (name && mod) {
                        SVAModifier svam (mod->value());
-                       modifiers.insert (make_pair (name->value(), svam));
+                       modifiers[name->value()] = svam;
                }
        }
 }
@@ -633,7 +693,7 @@ UIConfiguration::color (const std::string& name, bool* failed) const
        if (failed) {
                *failed = false;
        }
-       
+
        if (e != color_aliases.end ()) {
                Colors::const_iterator rc = colors.find (e->second);
                if (rc != colors.end()) {
@@ -646,7 +706,7 @@ UIConfiguration::color (const std::string& name, bool* failed) const
                        return rc->second;
                }
        }
-       
+
        if (!failed) {
                /* only show this message if the caller wasn't interested in
                   the fail status.
@@ -657,7 +717,7 @@ UIConfiguration::color (const std::string& name, bool* failed) const
        if (failed) {
                *failed = true;
        }
-       
+
        return rgba_to_color ((g_random_int()%256)/255.0,
                              (g_random_int()%256)/255.0,
                              (g_random_int()%256)/255.0,
@@ -731,5 +791,3 @@ UIConfiguration::load_rc_file (bool themechange, bool allow_own)
 
        Gtkmm2ext::UI::instance()->load_rcfile (rc_file_path, themechange);
 }
-
-