new files from sakari, missed last time
[ardour.git] / libs / ardour / configuration.cc
index e73208b872ec8b6ca36cbc59737014eae1190e3f..56dfd99f024729cf26201bb02f7e72da5e8ee374 100644 (file)
     along with this program; if not, write to the Free Software
     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 
-    $Id$
 */
 
 #include <unistd.h>
 #include <cstdio> /* for snprintf, grrr */
 
+#include <glib.h>  
+#include <glib/gstdio.h> /* for g_stat() */
+#include <glibmm/miscutils.h>
+
 #include <pbd/failed_constructor.h>
 #include <pbd/xml++.h>
+#include <pbd/filesystem.h>
+#include <pbd/file_utils.h>
+
+#include <midi++/manager.h>
 
 #include <ardour/ardour.h>
 #include <ardour/configuration.h>
 #include <ardour/audio_diskstream.h>
-#include <ardour/destructive_filesource.h>
 #include <ardour/control_protocol_manager.h>
+#include <ardour/filesystem_paths.h>
 
 #include "i18n.h"
 
 using namespace ARDOUR;
 using namespace std;
+using namespace PBD;
 
 /* this is global so that we do not have to indirect through an object pointer
    to reference it.
@@ -52,9 +60,10 @@ Configuration::Configuration ()
 #define CONFIG_VARIABLE_SPECIAL(Type,var,name,value,mutator) var (name,value,mutator),
 #include "ardour/configuration_vars.h"
 #undef  CONFIG_VARIABLE
-#undef  CONFIG_VARIABLE_SPECIAL        
+#undef  CONFIG_VARIABLE_SPECIAL
+
 
-       user_configuration (false)
+       current_owner (ConfigVariableBase::Default)
 {
        _control_protocol_state = 0;
 }
@@ -63,57 +72,94 @@ Configuration::~Configuration ()
 {
 }
 
+void
+Configuration::set_current_owner (ConfigVariableBase::Owner owner)
+{
+       current_owner = owner;
+}
+
 int
 Configuration::load_state ()
 {
-       string rcfile;
-       
-       /* load system configuration first */
+       bool found = false;
 
-       rcfile = find_config_file ("ardour_system.rc");
-
-       if (rcfile.length()) {
+       sys::path system_rc_file;
+       struct stat statbuf;
 
+       /* load system configuration first */
+       
+       if ( find_file_in_search_path (ardour_search_path() + system_config_search_path(),
+                       "ardour_system.rc", system_rc_file) )
+       {
                XMLTree tree;
+               found = true;
+
+               string rcfile = system_rc_file.to_string();
 
-               cerr << string_compose (_("loading system configuration file %1"), rcfile) << endl;
+               /* stupid XML Parser hates empty files */
                
-               if (!tree.read (rcfile.c_str())) {
-                       error << string_compose(_("Ardour: cannot read system configuration file \"%1\""), rcfile) << endmsg;
+               if (g_stat (rcfile.c_str(), &statbuf)) {
                        return -1;
                }
 
-               if (set_state (*tree.root())) {
-                       error << string_compose(_("Ardour: system configuration file \"%1\" not loaded successfully."), rcfile) << endmsg;
-                       return -1;
+               if (statbuf.st_size != 0) {
+                       cerr << string_compose (_("loading system configuration file %1"), rcfile) << endl;
+                       
+                       if (!tree.read (rcfile.c_str())) {
+                               error << string_compose(_("Ardour: cannot read system configuration file \"%1\""), rcfile) << endmsg;
+                               return -1;
+                       }
+                       
+                       current_owner = ConfigVariableBase::System;
+                       
+                       if (set_state (*tree.root())) {
+                               error << string_compose(_("Ardour: system configuration file \"%1\" not loaded successfully."), rcfile) << endmsg;
+                               return -1;
+                       }
+               } else {
+                       error << _("your system Ardour configuration file is empty. This probably means that there as an error installing Ardour") << endmsg;
                }
        }
 
-       /* from this point on, all configuration changes are user driven */
-
-       user_configuration = true;
-
        /* now load configuration file for user */
-       
-       rcfile = find_config_file ("ardour.rc");
 
-       if (rcfile.length()) {
+       sys::path user_rc_file;
 
+       if (find_file_in_search_path (ardour_search_path() + user_config_directory(),
+                       "ardour.rc", user_rc_file))
+       {
                XMLTree tree;
                
-               cerr << string_compose (_("loading user configuration file %1"), rcfile) << endl;
+               string rcfile = user_rc_file.to_string();
 
-               if (!tree.read (rcfile)) {
-                       error << string_compose(_("Ardour: cannot read configuration file \"%1\""), rcfile) << endmsg;
-                       return -1;
-               }
+               /* stupid XML parser hates empty files */
 
-               if (set_state (*tree.root())) {
-                       error << string_compose(_("Ardour: user configuration file \"%1\" not loaded successfully."), rcfile) << endmsg;
+               if (g_stat (rcfile.c_str(), &statbuf)) {
                        return -1;
                }
+
+               if (statbuf.st_size != 0) {
+                       cerr << string_compose (_("loading user configuration file %1"), rcfile) << endl;
+                       
+                       if (!tree.read (rcfile)) {
+                               error << string_compose(_("Ardour: cannot read configuration file \"%1\""), rcfile) << endmsg;
+                               return -1;
+                       }
+                       
+                       current_owner = ConfigVariableBase::Config;
+                       
+                       if (set_state (*tree.root())) {
+                               error << string_compose(_("Ardour: user configuration file \"%1\" not loaded successfully."), rcfile) << endmsg;
+                               return -1;
+                       }
+               } else {
+                       warning << _("your Ardour configuration file is empty. This is not normal.") << endmsg;
+               }       
        }
 
+       if (!found)
+               error << "Ardour: could not find configuration file (ardour.rc), canvas will look broken." << endmsg;
+
        return 0;
 }
 
@@ -121,17 +167,25 @@ int
 Configuration::save_state()
 {
        XMLTree tree;
-       string rcfile;
 
-       /* Note: this only writes the per-user file, and therefore
-          only saves variables marked as user-set or modified
-       */
+       try
+       {
+               sys::create_directories (user_config_directory ());
+       }
+       catch (const sys::filesystem_error& ex)
+       {
+               error << "Could not create user configuration directory" << endmsg;
+               return -1;
+       }
+       
+       sys::path rcfile_path(user_config_directory());
 
-       rcfile = get_user_ardour_path ();
-       rcfile += "ardour.rc";
+       rcfile_path /= "ardour.rc";
+       const string rcfile = rcfile_path.to_string();
 
+       // this test seems bogus?
        if (rcfile.length()) {
-               tree.set_root (&state (true));
+               tree.set_root (&get_state());
                if (!tree.write (rcfile.c_str())){
                        error << string_compose (_("Config file %1 not saved"), rcfile) << endmsg;
                        return -1;
@@ -141,44 +195,71 @@ Configuration::save_state()
        return 0;
 }
 
+void
+Configuration::add_instant_xml(XMLNode& node)
+{
+       Stateful::add_instant_xml (node, user_config_directory ());
+}
+
+XMLNode*
+Configuration::instant_xml(const string& node_name)
+{
+       return Stateful::instant_xml (node_name, user_config_directory ());
+}
+
+
+bool
+Configuration::save_config_options_predicate (ConfigVariableBase::Owner owner)
+{
+       /* only save things that were in the config file to start with */
+       return owner & ConfigVariableBase::Config;
+}
+
 XMLNode&
 Configuration::get_state ()
 {
-       return state (false);
+       XMLNode* root;
+       LocaleGuard lg (X_("POSIX"));
+
+       root = new XMLNode("Ardour");
+
+       MIDI::Manager::PortMap::const_iterator i;
+       const MIDI::Manager::PortMap& ports = MIDI::Manager::instance()->get_midi_ports();
+       
+       for (i = ports.begin(); i != ports.end(); ++i) {
+               root->add_child_nocopy(i->second->get_state());
+       }
+       
+       root->add_child_nocopy (get_variables (sigc::mem_fun (*this, &Configuration::save_config_options_predicate), "Config"));
+       
+       if (_extra_xml) {
+               root->add_child_copy (*_extra_xml);
+       }
+       
+       root->add_child_nocopy (ControlProtocolManager::instance().get_state());
+       
+       return *root;
 }
 
 XMLNode&
-Configuration::state (bool user_only)
+Configuration::get_variables (sigc::slot<bool,ConfigVariableBase::Owner> predicate, std::string which_node)
 {
-       XMLNode* root = new XMLNode("Ardour");
+       XMLNode* node;
        LocaleGuard lg (X_("POSIX"));
 
-       typedef map<string, MidiPortDescriptor*>::const_iterator CI;
-       for(CI m = midi_ports.begin(); m != midi_ports.end(); ++m){
-               root->add_child_nocopy(m->second->get_state());
-       }
+       node = new XMLNode(which_node);
 
-       XMLNode* node = new XMLNode("Config");
-       
 #undef  CONFIG_VARIABLE
 #undef  CONFIG_VARIABLE_SPECIAL        
-#define CONFIG_VARIABLE(type,var,name,value) \
-         if (!user_only || var.is_user()) var.add_to_node (*node);
-#define CONFIG_VARIABLE_SPECIAL(type,var,name,value,mutator) \
-         if (!user_only || var.is_user()) var.add_to_node (*node);
+#define CONFIG_VARIABLE(type,var,Name,value) \
+         if (node->name() == "Config") { if (predicate (var.owner())) { var.add_to_node (*node); }}
+#define CONFIG_VARIABLE_SPECIAL(type,var,Name,value,mutator) \
+         if (node->name() == "Config") { if (predicate (var.owner())) { var.add_to_node (*node); }}
 #include "ardour/configuration_vars.h"
 #undef  CONFIG_VARIABLE
 #undef  CONFIG_VARIABLE_SPECIAL        
 
-       root->add_child_nocopy (*node);
-
-       if (_extra_xml) {
-               root->add_child_copy (*_extra_xml);
-       }
-
-       root->add_child_nocopy (ControlProtocolManager::instance().get_state());
-
-       return *root;
+       return *node;
 }
 
 int
@@ -199,10 +280,13 @@ Configuration::set_state (const XMLNode& root)
                if (node->name() == "MIDI-port") {
 
                        try {
-                               pair<string,MidiPortDescriptor*> newpair;
-                               newpair.second = new MidiPortDescriptor (*node);
-                               newpair.first = newpair.second->tag;
-                               midi_ports.insert (newpair);
+
+                               MIDI::Port::Descriptor desc (*node);
+                               map<string,XMLNode>::iterator x;
+                               if ((x = midi_ports.find (desc.tag)) != midi_ports.end()) {
+                                       midi_ports.erase (x);
+                               }
+                               midi_ports.insert (pair<string,XMLNode>(desc.tag,*node));
                        }
 
                        catch (failed_constructor& err) {
@@ -210,18 +294,8 @@ Configuration::set_state (const XMLNode& root)
                        }
 
                } else if (node->name() == "Config") {
-
-#undef  CONFIG_VARIABLE
-#undef  CONFIG_VARIABLE_SPECIAL        
-#define CONFIG_VARIABLE(type,var,name,value) \
-         var.set_from_node (*node); \
-        var.set_is_user (user_configuration);
-#define CONFIG_VARIABLE_SPECIAL(type,var,name,value,mutator) \
-         var.set_from_node (*node); \
-        var.set_is_user (user_configuration);
-#include "ardour/configuration_vars.h"
-#undef  CONFIG_VARIABLE
-#undef  CONFIG_VARIABLE_SPECIAL        
+                       
+                       set_variables (*node, ConfigVariableBase::Config);
                        
                } else if (node->name() == "extra") {
                        _extra_xml = new XMLNode (*node);
@@ -231,54 +305,68 @@ Configuration::set_state (const XMLNode& root)
                }
        }
 
-       AudioDiskstream::set_disk_io_chunk_frames (minimum_disk_io_bytes.get() / sizeof (Sample));
+       Diskstream::set_disk_io_chunk_frames (minimum_disk_io_bytes.get() / sizeof (Sample));
 
        return 0;
 }
 
-Configuration::MidiPortDescriptor::MidiPortDescriptor (const XMLNode& node)
+void
+Configuration::set_variables (const XMLNode& node, ConfigVariableBase::Owner owner)
 {
-       const XMLProperty *prop;
-       bool have_tag = false;
-       bool have_device = false;
-       bool have_type = false;
-       bool have_mode = false;
-
-       if ((prop = node.property ("tag")) != 0) {
-               tag = prop->value();
-               have_tag = true;
-       }
+#undef  CONFIG_VARIABLE
+#undef  CONFIG_VARIABLE_SPECIAL        
+#define CONFIG_VARIABLE(type,var,name,value) \
+         if (var.set_from_node (node, owner)) { \
+                ParameterChanged (name); \
+        }
+#define CONFIG_VARIABLE_SPECIAL(type,var,name,value,mutator) \
+         if (var.set_from_node (node, owner)) { \
+                ParameterChanged (name); \
+        }
 
-       if ((prop = node.property ("device")) != 0) {
-               device = prop->value();
-               have_device = true;
-       }
+#include "ardour/configuration_vars.h"
+#undef  CONFIG_VARIABLE
+#undef  CONFIG_VARIABLE_SPECIAL
+       
+}
+void
+Configuration::map_parameters (sigc::slot<void,const char*> theSlot)
+{
+#undef  CONFIG_VARIABLE
+#undef  CONFIG_VARIABLE_SPECIAL        
+#define CONFIG_VARIABLE(type,var,name,value)                 theSlot (name);
+#define CONFIG_VARIABLE_SPECIAL(type,var,name,value,mutator) theSlot (name);
+#include "ardour/configuration_vars.h"
+#undef  CONFIG_VARIABLE
+#undef  CONFIG_VARIABLE_SPECIAL        
+}
 
-       if ((prop = node.property ("type")) != 0) {
-               type = prop->value();
-               have_type = true;
-       }
+bool ConfigVariableBase::show_stores = false;
 
-       if ((prop = node.property ("mode")) != 0) {
-               mode = prop->value();
-               have_mode = true;
-       }
+void
+ConfigVariableBase::set_show_stored_values (bool yn)
+{
+       show_stores = yn;
+}
 
-       if (!have_tag || !have_device || !have_type || !have_mode) {
-               throw failed_constructor();
+void
+ConfigVariableBase::show_stored_value (const string& str)
+{
+       if (show_stores) {
+               cerr << "Config variable " << _name << " stored as " << str << endl;
        }
 }
 
-XMLNode&
-Configuration::MidiPortDescriptor::get_state()
+void
+ConfigVariableBase::notify ()
 {
-       XMLNode* root = new XMLNode("MIDI-port");
-
-       root->add_property("tag", tag);
-       root->add_property("device", device);
-       root->add_property("type", type);
-       root->add_property("mode", mode);
+       // placeholder for any debugging desired when a config variable is modified
+}
 
-       return *root;
+void
+ConfigVariableBase::miss ()
+{
+       // placeholder for any debugging desired when a config variable 
+       // is set but to the same value as it already has
 }