#define __pbd_stateful_h__
#include <string>
+#include <list>
#include <cassert>
+
#include "pbd/id.h"
#include "pbd/xml++.h"
+#include "pbd/property_basics.h"
+#include "pbd/signals.h"
class XMLNode;
class path;
}
-/** Base (non template) part of State */
-class StateBase
-{
-public:
- StateBase (std::string const & p)
- : _have_old (false)
- , _xml_property_name (p)
- {
-
- }
-
- StateBase (StateBase const & s)
- : _have_old (s._have_old)
- , _xml_property_name (s._xml_property_name)
- {
-
- }
-
- /** Forget about any old value for this state */
- void clear_history () {
- _have_old = false;
- }
-
- virtual void diff (XMLNode *, XMLNode *) const = 0;
-
-protected:
- bool _have_old;
- std::string _xml_property_name;
-};
-
-/** Class to represent a single piece of state in a Stateful object */
-template <class T>
-class State : public StateBase
-{
-public:
- State (std::string const & p, T const & v)
- : StateBase (p)
- , _current (v)
- {
-
- }
-
- State (State<T> const & s)
- : StateBase (s)
- {
- _current = s._current;
- _old = s._old;
- }
-
- State<T> & operator= (State<T> const & s) {
- /* XXX: isn't there a nicer place to do this? */
- _have_old = s._have_old;
- _xml_property_name = s._xml_property_name;
-
- _current = s._current;
- _old = s._old;
- return *this;
- }
-
- T & operator= (T const & v) {
- set (v);
- return _current;
- }
-
- T & operator+= (T const & v) {
- set (_current + v);
- return _current;
- }
-
- operator T () const {
- return _current;
- }
-
- T const & get () const {
- return _current;
- }
-
- void diff (XMLNode* old, XMLNode* current) const {
- if (_have_old) {
- std::stringstream o;
- o << _old;
- old->add_property (_xml_property_name.c_str(), o.str().c_str());
- std::stringstream c;
- c << _current;
- current->add_property (_xml_property_name.c_str(), c.str().c_str());
- }
- }
-
-private:
- void set (T const & v) {
- _old = _current;
- _have_old = true;
- _current = v;
- }
-
- T _current;
- T _old;
-};
+class PropertyList;
+class OwnedPropertyList;
/** Base class for objects with saveable and undoable state */
class Stateful {
virtual ~Stateful();
virtual XMLNode& get_state (void) = 0;
-
virtual int set_state (const XMLNode&, int version) = 0;
- void add_state (StateBase & s) {
- _states.push_back (&s);
- }
+ virtual bool apply_changes (PropertyBase const &);
+ PropertyChange apply_changes (PropertyList const &);
+
+ const OwnedPropertyList& properties() const { return *_properties; }
+
+ void add_property (PropertyBase& s);
- /* Extra XML nodes */
+ /* 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);
const PBD::ID& id() const { return _id; }
- void clear_history ();
- std::pair<XMLNode *, XMLNode*> diff ();
+ /* history management */
+
+ void clear_changes ();
+ virtual void clear_owned_changes ();
+ PropertyList* get_changes_as_properties (Command *) const;
+ virtual void rdiff (std::vector<StatefulDiffCommand*> &) const;
+ bool changed() const;
+
+ /* create a property list from an XMLNode
+ */
+ virtual PropertyList* property_factory (const XMLNode&) const;
+
+ /* How stateful's notify of changes to their properties
+ */
+ PBD::Signal1<void,const PropertyChange&> PropertyChanged;
static int current_state_version;
static int loading_state_version;
+ virtual void suspend_property_changes ();
+ virtual void resume_property_changes ();
+
+ void unlock_property_changes () { _no_property_changes = false; }
+ void block_property_changes () { _no_property_changes = true; }
+
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_properties (XMLNode &);
+
+ 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 () { };
XMLNode *_extra_xml;
XMLNode *_instant_xml;
- PBD::ID _id;
+ PBD::ID _id;
+ int32_t _frozen;
+ bool _no_property_changes;
+ PBD::PropertyChange _pending_changed;
+ Glib::Mutex _lock;
std::string _xml_node_name; ///< name of node to use for this object in XML
- std::list<StateBase*> _states; ///< state variables that this object has
+ 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&) { }
+ bool property_changes_suspended() const { return g_atomic_int_get (&_frozen) > 0; }
};
} // namespace PBD
projects / ardour.git / blobdiff