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 $
22 #include <io.h> // Microsoft's nearest equivalent to <unistd.h>
27 #include <glibmm/fileutils.h>
28 #include <glibmm/miscutils.h>
30 #include "pbd/debug.h"
31 #include "pbd/stateful.h"
32 #include "pbd/property_list.h"
33 #include "pbd/properties.h"
34 #include "pbd/destructible.h"
35 #include "pbd/xml++.h"
36 #include "pbd/error.h"
44 int Stateful::current_state_version = 0;
45 int Stateful::loading_state_version = 0;
48 : _properties (new OwnedPropertyList)
49 , _stateful_frozen (0)
55 Stateful::~Stateful ()
59 // Do not delete _extra_xml. The use of add_child_nocopy()
60 // means it needs to live on indefinately.
66 Stateful::add_extra_xml (XMLNode& node)
68 if (_extra_xml == 0) {
69 _extra_xml = new XMLNode ("Extra");
72 _extra_xml->remove_nodes (node.name());
73 _extra_xml->add_child_nocopy (node);
77 Stateful::extra_xml (const string& str, bool add_if_missing)
82 node = _extra_xml->child (str.c_str());
85 if (!node && add_if_missing) {
86 node = new XMLNode (str);
87 add_extra_xml (*node);
94 Stateful::save_extra_xml (const XMLNode& node)
96 /* Looks for the child node called "Extra" and makes _extra_xml
97 point to a copy of it. Will delete any existing node pointed
98 to by _extra_xml if a new Extra node is found, but not
102 const XMLNode* xtra = node.child ("Extra");
106 _extra_xml = new XMLNode (*xtra);
111 Stateful::add_instant_xml (XMLNode& node, const std::string& directory_path)
113 if (!Glib::file_test (directory_path, Glib::FILE_TEST_IS_DIR)) {
114 if (g_mkdir_with_parents (directory_path.c_str(), 0755) != 0) {
115 error << string_compose(_("Error: could not create directory %1"), directory_path) << endmsg;
120 if (_instant_xml == 0) {
121 _instant_xml = new XMLNode ("instant");
124 _instant_xml->remove_nodes_and_delete (node.name());
125 _instant_xml->add_child_copy (node);
127 std::string instant_xml_path = Glib::build_filename (directory_path, "instant.xml");
130 tree.set_filename(instant_xml_path);
132 /* Important: the destructor for an XMLTree deletes
133 all of its nodes, starting at _root. We therefore
134 cannot simply hand it our persistent _instant_xml
135 node as its _root, because we will lose it whenever
136 the Tree goes out of scope.
138 So instead, copy the _instant_xml node (which does
139 a deep copy), and hand that to the tree.
142 XMLNode* copy = new XMLNode (*_instant_xml);
143 tree.set_root (copy);
146 error << string_compose(_("Error: could not write %1"), instant_xml_path) << endmsg;
151 Stateful::instant_xml (const string& str, const std::string& directory_path)
153 if (_instant_xml == 0) {
155 std::string instant_xml_path = Glib::build_filename (directory_path, "instant.xml");
157 if (Glib::file_test (instant_xml_path, Glib::FILE_TEST_EXISTS)) {
159 if (tree.read(instant_xml_path)) {
160 _instant_xml = new XMLNode(*(tree.root()));
162 warning << string_compose(_("Could not understand XML file %1"), instant_xml_path) << endmsg;
170 const XMLNodeList& nlist = _instant_xml->children();
171 XMLNodeConstIterator i;
173 for (i = nlist.begin(); i != nlist.end(); ++i) {
174 if ((*i)->name() == str) {
182 /** Forget about any changes to this object's properties */
184 Stateful::clear_changes ()
186 for (OwnedPropertyList::iterator i = _properties->begin(); i != _properties->end(); ++i) {
187 i->second->clear_changes ();
192 Stateful::get_changes_as_properties (Command* cmd) const
194 PropertyList* pl = new PropertyList;
196 for (OwnedPropertyList::const_iterator i = _properties->begin(); i != _properties->end(); ++i) {
197 i->second->get_changes_as_properties (*pl, cmd);
203 /** Set our property values from an XML node.
204 * Derived types can call this from set_state() (or elsewhere)
205 * to get basic property setting done.
206 * @return IDs of properties that were changed.
209 Stateful::set_values (XMLNode const & node)
213 for (OwnedPropertyList::iterator i = _properties->begin(); i != _properties->end(); ++i) {
214 if (i->second->set_value (node)) {
225 Stateful::apply_changes (const PropertyList& property_list)
228 PropertyList::const_iterator p;
230 DEBUG_TRACE (DEBUG::Stateful, string_compose ("Stateful %1 setting properties from list of %2\n", this, property_list.size()));
232 for (PropertyList::const_iterator pp = property_list.begin(); pp != property_list.end(); ++pp) {
233 DEBUG_TRACE (DEBUG::Stateful, string_compose ("in plist: %1\n", pp->second->property_name()));
236 for (PropertyList::const_iterator i = property_list.begin(); i != property_list.end(); ++i) {
237 if ((p = _properties->find (i->first)) != _properties->end()) {
241 string_compose ("actually setting property %1 using %2\n", p->second->property_name(), i->second->property_name())
244 if (apply_changes (*i->second)) {
248 DEBUG_TRACE (DEBUG::Stateful, string_compose ("passed in property %1 not found in own property list\n",
249 i->second->property_name()));
260 /** Add property states to an XML node.
261 * @param owner_state Node.
264 Stateful::add_properties (XMLNode& owner_state)
266 for (OwnedPropertyList::iterator i = _properties->begin(); i != _properties->end(); ++i) {
267 i->second->get_value (owner_state);
272 Stateful::add_property (PropertyBase& s)
274 _properties->add (s);
278 Stateful::send_change (const PropertyChange& what_changed)
280 if (what_changed.empty()) {
285 Glib::Threads::Mutex::Lock lm (_lock);
286 if (property_changes_suspended ()) {
287 _pending_changed.add (what_changed);
292 PropertyChanged (what_changed);
296 Stateful::suspend_property_changes ()
298 g_atomic_int_add (&_stateful_frozen, 1);
302 Stateful::resume_property_changes ()
304 PropertyChange what_changed;
307 Glib::Threads::Mutex::Lock lm (_lock);
309 if (property_changes_suspended() && g_atomic_int_dec_and_test (&_stateful_frozen) == FALSE) {
313 if (!_pending_changed.empty()) {
314 what_changed = _pending_changed;
315 _pending_changed.clear ();
319 mid_thaw (what_changed);
321 send_change (what_changed);
325 Stateful::changed() const
327 for (OwnedPropertyList::const_iterator i = _properties->begin(); i != _properties->end(); ++i) {
328 if (i->second->changed()) {
337 Stateful::apply_changes (const PropertyBase& prop)
339 OwnedPropertyList::iterator i = _properties->find (prop.property_id());
340 if (i == _properties->end()) {
344 i->second->apply_changes (&prop);
349 Stateful::property_factory (const XMLNode& history_node) const
351 PropertyList* prop_list = new PropertyList;
353 for (OwnedPropertyList::const_iterator i = _properties->begin(); i != _properties->end(); ++i) {
354 PropertyBase* prop = i->second->clone_from_xml (history_node);
357 prop_list->add (prop);
365 Stateful::rdiff (vector<Command*>& cmds) const
367 for (OwnedPropertyList::const_iterator i = _properties->begin(); i != _properties->end(); ++i) {
368 i->second->rdiff (cmds);
373 Stateful::clear_owned_changes ()
375 for (OwnedPropertyList::iterator i = _properties->begin(); i != _properties->end(); ++i) {
376 i->second->clear_owned_changes ();
381 Stateful::set_id (const XMLNode& node)
383 const XMLProperty* prop;
385 if ((prop = node.property ("id")) != 0) {
386 _id = prop->value ();
394 Stateful::reset_id ()
400 Stateful::set_id (const string& str)