2 Copyright (C) 2000-2001 Paul Davis
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.
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.
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.
18 $Id: stateful.cc 629 2006-06-21 23:01:03Z paul $
23 #include "pbd/debug.h"
24 #include "pbd/stateful.h"
25 #include "pbd/property_list.h"
26 #include "pbd/properties.h"
27 #include "pbd/destructible.h"
28 #include "pbd/filesystem.h"
29 #include "pbd/xml++.h"
30 #include "pbd/error.h"
38 int Stateful::current_state_version
= 0;
39 int Stateful::loading_state_version
= 0;
43 , _properties (new OwnedPropertyList
)
49 Stateful::~Stateful ()
53 // Do not delete _extra_xml. The use of add_child_nocopy()
54 // means it needs to live on indefinately.
60 Stateful::add_extra_xml (XMLNode
& node
)
62 if (_extra_xml
== 0) {
63 _extra_xml
= new XMLNode ("Extra");
66 _extra_xml
->remove_nodes (node
.name());
67 _extra_xml
->add_child_nocopy (node
);
71 Stateful::extra_xml (const string
& str
, bool add_if_missing
)
76 node
= _extra_xml
->child (str
.c_str());
79 if (!node
&& add_if_missing
) {
80 node
= new XMLNode (str
);
81 add_extra_xml (*node
);
88 Stateful::save_extra_xml (const XMLNode
& node
)
90 /* Looks for the child node called "Extra" and makes _extra_xml
91 point to a copy of it. Will delete any existing node pointed
92 to by _extra_xml if a new Extra node is found, but not
96 const XMLNode
* xtra
= node
.child ("Extra");
100 _extra_xml
= new XMLNode (*xtra
);
105 Stateful::add_instant_xml (XMLNode
& node
, const sys::path
& directory_path
)
107 sys::create_directories (directory_path
); // may throw
109 if (_instant_xml
== 0) {
110 _instant_xml
= new XMLNode ("instant");
113 _instant_xml
->remove_nodes_and_delete (node
.name());
114 _instant_xml
->add_child_copy (node
);
116 sys::path
instant_xml_path(directory_path
);
118 instant_xml_path
/= "instant.xml";
121 tree
.set_filename(instant_xml_path
.to_string());
123 /* Important: the destructor for an XMLTree deletes
124 all of its nodes, starting at _root. We therefore
125 cannot simply hand it our persistent _instant_xml
126 node as its _root, because we will lose it whenever
127 the Tree goes out of scope.
129 So instead, copy the _instant_xml node (which does
130 a deep copy), and hand that to the tree.
133 XMLNode
* copy
= new XMLNode (*_instant_xml
);
134 tree
.set_root (copy
);
137 error
<< string_compose(_("Error: could not write %1"), instant_xml_path
.to_string()) << endmsg
;
142 Stateful::instant_xml (const string
& str
, const sys::path
& directory_path
)
144 if (_instant_xml
== 0) {
146 sys::path
instant_xml_path(directory_path
);
147 instant_xml_path
/= "instant.xml";
149 if (exists(instant_xml_path
)) {
151 if (tree
.read(instant_xml_path
.to_string())) {
152 _instant_xml
= new XMLNode(*(tree
.root()));
154 warning
<< string_compose(_("Could not understand XML file %1"), instant_xml_path
.to_string()) << endmsg
;
162 const XMLNodeList
& nlist
= _instant_xml
->children();
163 XMLNodeConstIterator i
;
165 for (i
= nlist
.begin(); i
!= nlist
.end(); ++i
) {
166 if ((*i
)->name() == str
) {
174 /** Forget about any changes to this object's properties */
176 Stateful::clear_changes ()
178 for (OwnedPropertyList::iterator i
= _properties
->begin(); i
!= _properties
->end(); ++i
) {
179 i
->second
->clear_changes ();
184 Stateful::get_changes_as_properties (Command
* cmd
) const
186 PropertyList
* pl
= new PropertyList
;
188 for (OwnedPropertyList::const_iterator i
= _properties
->begin(); i
!= _properties
->end(); ++i
) {
189 i
->second
->get_changes_as_properties (*pl
, cmd
);
195 /** Set our property values from an XML node.
196 * Derived types can call this from set_state() (or elsewhere)
197 * to get basic property setting done.
198 * @return IDs of properties that were changed.
201 Stateful::set_values (XMLNode
const & node
)
205 for (OwnedPropertyList::iterator i
= _properties
->begin(); i
!= _properties
->end(); ++i
) {
206 if (i
->second
->set_value (node
)) {
217 Stateful::apply_changes (const PropertyList
& property_list
)
220 PropertyList::const_iterator p
;
222 DEBUG_TRACE (DEBUG::Stateful
, string_compose ("Stateful %1 setting properties from list of %2\n", this, property_list
.size()));
224 for (PropertyList::const_iterator pp
= property_list
.begin(); pp
!= property_list
.end(); ++pp
) {
225 DEBUG_TRACE (DEBUG::Stateful
, string_compose ("in plist: %1\n", pp
->second
->property_name()));
228 for (PropertyList::const_iterator i
= property_list
.begin(); i
!= property_list
.end(); ++i
) {
229 if ((p
= _properties
->find (i
->first
)) != _properties
->end()) {
233 string_compose ("actually setting property %1 using %2\n", p
->second
->property_name(), i
->second
->property_name())
236 if (apply_changes (*i
->second
)) {
240 DEBUG_TRACE (DEBUG::Stateful
, string_compose ("passed in property %1 not found in own property list\n",
241 i
->second
->property_name()));
252 /** Add property states to an XML node.
253 * @param owner_state Node.
256 Stateful::add_properties (XMLNode
& owner_state
)
258 for (OwnedPropertyList::iterator i
= _properties
->begin(); i
!= _properties
->end(); ++i
) {
259 i
->second
->get_value (owner_state
);
264 Stateful::add_property (PropertyBase
& s
)
266 _properties
->add (s
);
270 Stateful::send_change (const PropertyChange
& what_changed
)
272 if (what_changed
.empty()) {
277 Glib::Mutex::Lock
lm (_lock
);
279 _pending_changed
.add (what_changed
);
284 PropertyChanged (what_changed
);
288 Stateful::suspend_property_changes ()
294 Stateful::resume_property_changes ()
296 PropertyChange what_changed
;
299 Glib::Mutex::Lock
lm (_lock
);
301 if (_frozen
&& --_frozen
> 0) {
305 if (!_pending_changed
.empty()) {
306 what_changed
= _pending_changed
;
307 _pending_changed
.clear ();
311 mid_thaw (what_changed
);
313 send_change (what_changed
);
317 Stateful::changed() const
319 for (OwnedPropertyList::const_iterator i
= _properties
->begin(); i
!= _properties
->end(); ++i
) {
320 if (i
->second
->changed()) {
329 Stateful::apply_changes (const PropertyBase
& prop
)
331 OwnedPropertyList::iterator i
= _properties
->find (prop
.property_id());
332 if (i
== _properties
->end()) {
336 i
->second
->apply_changes (&prop
);
341 Stateful::property_factory (const XMLNode
& history_node
) const
343 PropertyList
* prop_list
= new PropertyList
;
345 for (OwnedPropertyList::const_iterator i
= _properties
->begin(); i
!= _properties
->end(); ++i
) {
346 PropertyBase
* prop
= i
->second
->clone_from_xml (history_node
);
349 prop_list
->add (prop
);
357 Stateful::rdiff (vector
<Command
*>& cmds
) const
359 for (OwnedPropertyList::const_iterator i
= _properties
->begin(); i
!= _properties
->end(); ++i
) {
360 i
->second
->rdiff (cmds
);
365 Stateful::clear_owned_changes ()
367 for (OwnedPropertyList::iterator i
= _properties
->begin(); i
!= _properties
->end(); ++i
) {
368 i
->second
->clear_owned_changes ();