Merge branch 'master' into windows

[ardour.git] / libs / pbd / pbd / stateful.h

diff --git a/libs/pbd/pbd/stateful.h b/libs/pbd/pbd/stateful.h
index bc32d7fd9b0df37437f0d4c0eb3b4514d32a72cf..4808bc2911f816b3e6e5634342dab488a5bd0433 100644 (file)
--- a/libs/pbd/pbd/stateful.h
+++ b/libs/pbd/pbd/stateful.h
@@ -26,7 +26,7 @@
 
 #include "pbd/id.h"
 #include "pbd/xml++.h"
-#include "pbd/properties.h"
+#include "pbd/property_basics.h"
 #include "pbd/signals.h"
 
 class XMLNode;
@@ -37,6 +37,9 @@ namespace sys {
        class path;
 }
 
+class PropertyList;
+class OwnedPropertyList;
+
 /** Base class for objects with saveable and undoable state */
 class Stateful {
   public:
@@ -45,29 +48,38 @@ class Stateful {
 
        virtual XMLNode& get_state (void) = 0;
        virtual int set_state (const XMLNode&, int version) = 0;
-       /* derived types do not have to implement this, but probably should
-          give it serious attention.
-       */
-       virtual bool set_property (const PropertyBase&) { return false; }
 
-       PropertyChange set_properties (const PropertyList&);
+       virtual bool apply_changes (PropertyBase const &);
+       PropertyChange apply_changes (PropertyList const &);
+       
+        const OwnedPropertyList& properties() const { return *_properties; }
 
-       void add_property (PropertyBase& s) {
-               _properties.add (s);
-       }
+       void add_property (PropertyBase& s);
 
        /* Extra XML node: so that 3rd parties can attach state to the XMLNode
           representing the state of this object.
         */
 
        void add_extra_xml (XMLNode&);
-       XMLNode *extra_xml (const std::string& str);
+       XMLNode *extra_xml (const std::string& str, bool add_if_missing = false);
+       void save_extra_xml (const XMLNode&);
 
        const PBD::ID& id() const { return _id; }
+       bool set_id (const XMLNode&);
+       void set_id (const std::string&);
+       void reset_id ();
+
+        /* history management */
+
+       void clear_changes ();
+       virtual void clear_owned_changes ();
+        PropertyList* get_changes_as_properties (Command *) const;
+       virtual void rdiff (std::vector<Command*> &) const;
+        bool changed() const;
 
-       void clear_history ();
-       std::pair<XMLNode *, XMLNode*> diff () const;
-       void changed (PropertyChange&) const;
+        /* create a property list from an XMLNode
+         */
+        virtual PropertyList* property_factory (const XMLNode&) const;
 
        /* How stateful's notify of changes to their properties
         */
@@ -76,29 +88,42 @@ class Stateful {
        static int current_state_version;
        static int loading_state_version;
 
+       virtual void suspend_property_changes ();
+       virtual void resume_property_changes ();
+
+        bool property_changes_suspended() const { return g_atomic_int_get (const_cast<gint*>(&_stateful_frozen)) > 0; }
+        
   protected:
 
-       void add_instant_xml (XMLNode&, const sys::path& directory_path);
-       XMLNode *instant_xml (const std::string& str, const sys::path& directory_path);
+       void add_instant_xml (XMLNode&, const std::string& directory_path);
+       XMLNode *instant_xml (const std::string& str, const std::string& directory_path);
        void add_properties (XMLNode &);
-       /* derived types can call this from ::set_state() (or elsewhere)
-          to get basic property setting done.
-       */
-       PropertyChange set_properties (XMLNode const &);
 
+       PropertyChange set_values (XMLNode const &);
        
        /* derived classes can implement this to do cross-checking
           of property values after either a PropertyList or XML 
           driven property change.
        */
-       virtual void post_set () { };
+       virtual void post_set (const PropertyChange&) { };
 
        XMLNode *_extra_xml;
        XMLNode *_instant_xml;
-       PBD::ID _id;
+       PBD::PropertyChange     _pending_changed;
+        Glib::Threads::Mutex _lock;
 
        std::string _xml_node_name; ///< name of node to use for this object in XML
-       OwnedPropertyList _properties;
+       OwnedPropertyList* _properties;
+
+        virtual void send_change (const PropertyChange&);
+        /** derived classes can implement this in order to process a property change
+            within thaw() just before send_change() is called.
+        */
+        virtual void mid_thaw (const PropertyChange&) { }
+
+  private:
+       PBD::ID  _id;
+        gint     _stateful_frozen;
 };
 
 } // namespace PBD