libs/pbd/pbd/stateful.h

   1 /*
   2     Copyright (C) 2000-2010 Paul Davis
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #ifndef __pbd_stateful_h__
  21 #define __pbd_stateful_h__
  22
  23 #include <string>
  24 #include <list>
  25 #include <cassert>
  26
  27 #include "pbd/id.h"
  28 #include "pbd/xml++.h"
  29 #include "pbd/property_basics.h"
  30 #include "pbd/signals.h"
  31
  32 class XMLNode;
  33
  34 namespace PBD {
  35
  36 namespace sys {
  37         class path;
  38 }
  39
  40 class PropertyList;
  41 class OwnedPropertyList;
  42
  43 /** Base class for objects with saveable and undoable state */
  44 class Stateful {
  45   public:
  46         Stateful ();
  47         virtual ~Stateful();
  48
  49         virtual XMLNode& get_state (void) = 0;
  50         virtual int set_state (const XMLNode&, int version) = 0;
  51
  52         virtual bool apply_changes (PropertyBase const &);
  53         PropertyChange apply_changes (PropertyList const &);
  54
  55         const OwnedPropertyList& properties() const { return *_properties; }
  56
  57         void add_property (PropertyBase& s);
  58
  59         /* Extra XML node: so that 3rd parties can attach state to the XMLNode
  60            representing the state of this object.
  61          */
  62
  63         void add_extra_xml (XMLNode&);
  64         XMLNode *extra_xml (const std::string& str);
  65
  66         const PBD::ID& id() const { return _id; }
  67
  68         /* history management */
  69
  70         void clear_changes ();
  71         virtual void clear_owned_changes ();
  72         PropertyList* get_changes_as_properties (Command *) const;
  73         virtual void rdiff (std::vector<Command*> &) const;
  74         bool changed() const;
  75
  76         /* create a property list from an XMLNode
  77          */
  78         virtual PropertyList* property_factory (const XMLNode&) const;
  79
  80         /* How stateful's notify of changes to their properties
  81          */
  82         PBD::Signal1<void,const PropertyChange&> PropertyChanged;
  83
  84         static int current_state_version;
  85         static int loading_state_version;
  86
  87         virtual void suspend_property_changes ();
  88         virtual void resume_property_changes ();
  89
  90         virtual bool frozen() const { return _frozen; }
  91
  92   protected:
  93
  94         void add_instant_xml (XMLNode&, const sys::path& directory_path);
  95         XMLNode *instant_xml (const std::string& str, const sys::path& directory_path);
  96         void add_properties (XMLNode &);
  97
  98         PropertyChange set_values (XMLNode const &);
  99
 100         /* derived classes can implement this to do cross-checking
 101            of property values after either a PropertyList or XML
 102            driven property change.
 103         */
 104         virtual void post_set () { };
 105
 106         XMLNode *_extra_xml;
 107         XMLNode *_instant_xml;
 108         PBD::ID  _id;
 109         int32_t  _frozen;
 110         PBD::PropertyChange     _pending_changed;
 111         Glib::Mutex _lock;
 112
 113         std::string _xml_node_name; ///< name of node to use for this object in XML
 114         OwnedPropertyList* _properties;
 115
 116         virtual void send_change (const PropertyChange&);
 117         /** derived classes can implement this in order to process a property change
 118             within thaw() just before send_change() is called.
 119         */
 120         virtual void mid_thaw (const PropertyChange&) { }
 121         bool property_changes_suspended() const { return g_atomic_int_get (&_frozen) > 0; }
 122 };
 123
 124 } // namespace PBD
 125
 126 #endif /* __pbd_stateful_h__ */
 127