Fix deadlock.
[ardour.git] / libs / pbd / stateful.cc
index 9f510b85d4972eb6a6d4e9755b44b358cc977928..c33418ce39fdcf82b3551aa3669e9a349e8e61d4 100644 (file)
 
 #include <unistd.h>
 
+#include "pbd/debug.h"
 #include "pbd/stateful.h"
+#include "pbd/property_list.h"
+#include "pbd/properties.h"
 #include "pbd/destructible.h"
 #include "pbd/filesystem.h"
 #include "pbd/xml++.h"
@@ -36,6 +39,8 @@ int Stateful::current_state_version = 0;
 int Stateful::loading_state_version = 0;
 
 Stateful::Stateful ()
+        : _frozen (0)
+        , _properties (new OwnedPropertyList)
 {
        _extra_xml = 0;
        _instant_xml = 0;
@@ -43,14 +48,12 @@ Stateful::Stateful ()
 
 Stateful::~Stateful ()
 {
+        delete _properties;
+
        // Do not delete _extra_xml.  The use of add_child_nocopy() 
        // means it needs to live on indefinately.
 
        delete _instant_xml;
-
-       for (list<StateBase*>::iterator i = _states.begin(); i != _states.end(); ++i) {
-               delete *i;
-       }
 }
 
 void
@@ -153,31 +156,203 @@ Stateful::instant_xml (const string& str, const sys::path& directory_path)
        return 0;
 }
 
-/** Forget about any old state for this object */      
+/** Forget about any changes to this object's properties */
 void
-Stateful::clear_history ()
+Stateful::clear_changes ()
+{
+       for (OwnedPropertyList::iterator i = _properties->begin(); i != _properties->end(); ++i) {
+               i->second->clear_changes ();
+       }
+}
+
+PropertyList *
+Stateful::get_changes_as_properties (Command* cmd) const
+{
+       PropertyList* pl = new PropertyList;
+       
+       for (OwnedPropertyList::const_iterator i = _properties->begin(); i != _properties->end(); ++i) {
+               i->second->get_changes_as_properties (*pl, cmd);
+       }
+
+       return pl;
+}
+
+/** Set our property values from an XML node.
+ *  Derived types can call this from ::set_state() (or elsewhere)
+ *  to get basic property setting done.
+ *  @return IDs of properties that were changed.
+ */
+PropertyChange
+Stateful::set_values (XMLNode const & node)
+{
+       PropertyChange c;
+        
+       for (OwnedPropertyList::iterator i = _properties->begin(); i != _properties->end(); ++i) {
+               if (i->second->set_value (node)) {
+                       c.add (i->first);
+               }
+       }
+
+       post_set ();
+
+       return c;
+}
+
+PropertyChange
+Stateful::apply_changes (const PropertyList& property_list)
 {
-       for (list<StateBase*>::iterator i = _states.begin(); i != _states.end(); ++i) {
-               (*i)->clear_history ();
+       PropertyChange c;
+       PropertyList::const_iterator p;
+
+        DEBUG_TRACE (DEBUG::Stateful, string_compose ("Stateful %1 setting properties from list of %2\n", this, property_list.size()));
+
+        for (PropertyList::const_iterator pp = property_list.begin(); pp != property_list.end(); ++pp) {
+                DEBUG_TRACE (DEBUG::Stateful, string_compose ("in plist: %1\n", pp->second->property_name()));
+        }
+        
+        for (PropertyList::const_iterator i = property_list.begin(); i != property_list.end(); ++i) {
+                if ((p = _properties->find (i->first)) != _properties->end()) {
+
+                        DEBUG_TRACE (
+                               DEBUG::Stateful,
+                               string_compose ("actually setting property %1 using %2\n", p->second->property_name(), i->second->property_name())
+                               );
+                       
+                       if (apply_changes (*i->second)) {
+                               c.add (i->first);
+                       }
+               } else {
+                        DEBUG_TRACE (DEBUG::Stateful, string_compose ("passed in property %1 not found in own property list\n",
+                                                                      i->second->property_name()));
+                }
        }
+       
+       post_set ();
+
+       send_change (c);
+
+       return c;
 }
 
-/** @return A pair of XMLNodes representing state that has changed since the last time clear_history
- *  was called on this object; the first is the state before, the second the state after.
- *
- *  It is the caller's responsibility to delete the returned XMLNodes.
+/** Add property states to an XML node.
+ *  @param owner_state Node.
  */
-pair<XMLNode *, XMLNode *>
-Stateful::diff ()
+void
+Stateful::add_properties (XMLNode& owner_state)
+{
+       for (OwnedPropertyList::iterator i = _properties->begin(); i != _properties->end(); ++i) {
+               i->second->get_value (owner_state);
+       }
+}
+
+void
+Stateful::add_property (PropertyBase& s)
+{
+        _properties->add (s);
+}
+
+void
+Stateful::send_change (const PropertyChange& what_changed)
 {
-       XMLNode* old = new XMLNode (_xml_node_name);
-       XMLNode* current = new XMLNode (_xml_node_name);
+       if (what_changed.empty()) {
+               return;
+       }
 
-       for (list<StateBase*>::iterator i = _states.begin(); i != _states.end(); ++i) {
-               (*i)->diff (old, current);
+       {
+               Glib::Mutex::Lock lm (_lock);
+               if (_frozen) {
+                       _pending_changed.add (what_changed);
+                       return;
+               }
        }
 
-       return make_pair (old, current);
+       PropertyChanged (what_changed);
+}
+
+void
+Stateful::suspend_property_changes ()
+{
+        _frozen++;
+}
+
+void
+Stateful::resume_property_changes ()
+{
+       PropertyChange what_changed;
+
+       {
+               Glib::Mutex::Lock lm (_lock);
+
+               if (_frozen && --_frozen > 0) {
+                       return;
+               }
+
+               if (!_pending_changed.empty()) {
+                       what_changed = _pending_changed;
+                       _pending_changed.clear ();
+               }
+       }
+
+        mid_thaw (what_changed);
+
+        send_change (what_changed);
+}
+
+bool
+Stateful::changed() const  
+{
+       for (OwnedPropertyList::const_iterator i = _properties->begin(); i != _properties->end(); ++i) {
+                if (i->second->changed()) {
+                        return true;
+                }
+        }
+
+        return false;
+}
+
+bool
+Stateful::apply_changes (const PropertyBase& prop)
+{
+       OwnedPropertyList::iterator i = _properties->find (prop.property_id());
+       if (i == _properties->end()) {
+               return false;
+       }
+
+       i->second->apply_changes (&prop);
+       return true;
+}
+
+PropertyList*
+Stateful::property_factory (const XMLNode& history_node) const
+{
+        PropertyList* prop_list = new PropertyList;
+
+        for (OwnedPropertyList::const_iterator i = _properties->begin(); i != _properties->end(); ++i) {
+                PropertyBase* prop = i->second->clone_from_xml (history_node);
+
+                if (prop) {
+                        prop_list->add (prop);
+                }
+        }
+
+        return prop_list;
+}
+
+void
+Stateful::rdiff (vector<Command*>& cmds) const
+{
+       for (OwnedPropertyList::const_iterator i = _properties->begin(); i != _properties->end(); ++i) {
+               i->second->rdiff (cmds);
+       }
+}
+
+void
+Stateful::clear_owned_changes ()
+{
+       for (OwnedPropertyList::iterator i = _properties->begin(); i != _properties->end(); ++i) {
+               i->second->clear_owned_changes ();
+       }
 }
+  
 
 } // namespace PBD