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;
47 Glib::Threads::Private<bool> Stateful::_regenerate_xml_or_string_ids;
52 , _properties (new OwnedPropertyList)
53 , _stateful_frozen (0)
57 Stateful::~Stateful ()
61 // Do not delete _extra_xml. The use of add_child_nocopy()
62 // means it needs to live on indefinately.
68 Stateful::add_extra_xml (XMLNode& node)
70 if (_extra_xml == 0) {
71 _extra_xml = new XMLNode ("Extra");
74 _extra_xml->remove_nodes_and_delete (node.name());
75 _extra_xml->add_child_nocopy (node);
79 Stateful::extra_xml (const string& str, bool add_if_missing)
84 node = _extra_xml->child (str.c_str());
87 if (!node && add_if_missing) {
88 node = new XMLNode (str);
89 add_extra_xml (*node);
96 Stateful::save_extra_xml (const XMLNode& node)
98 /* Looks for the child node called "Extra" and makes _extra_xml
99 point to a copy of it. Will delete any existing node pointed
100 to by _extra_xml if a new Extra node is found, but not
104 const XMLNode* xtra = node.child ("Extra");
108 _extra_xml = new XMLNode (*xtra);
113 Stateful::add_instant_xml (XMLNode& node, const std::string& directory_path)
115 if (!Glib::file_test (directory_path, Glib::FILE_TEST_IS_DIR)) {
116 if (g_mkdir_with_parents (directory_path.c_str(), 0755) != 0) {
117 error << string_compose(_("Error: could not create directory %1"), directory_path) << endmsg;
122 if (_instant_xml == 0) {
123 _instant_xml = new XMLNode ("instant");
126 _instant_xml->remove_nodes_and_delete (node.name());
127 _instant_xml->add_child_copy (node);
129 std::string instant_xml_path = Glib::build_filename (directory_path, "instant.xml");
132 tree.set_filename(instant_xml_path);
134 /* Important: the destructor for an XMLTree deletes
135 all of its nodes, starting at _root. We therefore
136 cannot simply hand it our persistent _instant_xml
137 node as its _root, because we will lose it whenever
138 the Tree goes out of scope.
140 So instead, copy the _instant_xml node (which does
141 a deep copy), and hand that to the tree.
144 XMLNode* copy = new XMLNode (*_instant_xml);
145 tree.set_root (copy);
148 error << string_compose(_("Error: could not write %1"), instant_xml_path) << endmsg;
153 Stateful::instant_xml (const string& str, const std::string& directory_path)
155 if (_instant_xml == 0) {
157 std::string instant_xml_path = Glib::build_filename (directory_path, "instant.xml");
159 if (Glib::file_test (instant_xml_path, Glib::FILE_TEST_EXISTS)) {
161 if (tree.read(instant_xml_path)) {
162 _instant_xml = new XMLNode(*(tree.root()));
164 warning << string_compose(_("Could not understand XML file %1"), instant_xml_path) << endmsg;
172 const XMLNodeList& nlist = _instant_xml->children();
173 XMLNodeConstIterator i;
175 for (i = nlist.begin(); i != nlist.end(); ++i) {
176 if ((*i)->name() == str) {
184 /** Forget about any changes to this object's properties */
186 Stateful::clear_changes ()
188 for (OwnedPropertyList::iterator i = _properties->begin(); i != _properties->end(); ++i) {
189 i->second->clear_changes ();
194 Stateful::get_changes_as_properties (Command* cmd) const
196 PropertyList* pl = new PropertyList;
198 for (OwnedPropertyList::const_iterator i = _properties->begin(); i != _properties->end(); ++i) {
199 i->second->get_changes_as_properties (*pl, cmd);
205 /** Set our property values from an XML node.
206 * Derived types can call this from set_state() (or elsewhere)
207 * to get basic property setting done.
208 * @return IDs of properties that were changed.
211 Stateful::set_values (XMLNode const & node)
215 for (OwnedPropertyList::iterator i = _properties->begin(); i != _properties->end(); ++i) {
216 if (i->second->set_value (node)) {
227 Stateful::apply_changes (const PropertyList& property_list)
230 PropertyList::const_iterator p;
232 DEBUG_TRACE (DEBUG::Stateful, string_compose ("Stateful %1 setting properties from list of %2\n", this, property_list.size()));
234 for (PropertyList::const_iterator pp = property_list.begin(); pp != property_list.end(); ++pp) {
235 DEBUG_TRACE (DEBUG::Stateful, string_compose ("in plist: %1\n", pp->second->property_name()));
238 for (PropertyList::const_iterator i = property_list.begin(); i != property_list.end(); ++i) {
239 if ((p = _properties->find (i->first)) != _properties->end()) {
243 string_compose ("actually setting property %1 using %2\n", p->second->property_name(), i->second->property_name())
246 if (apply_changes (*i->second)) {
250 DEBUG_TRACE (DEBUG::Stateful, string_compose ("passed in property %1 not found in own property list\n",
251 i->second->property_name()));
262 /** Add property states to an XML node.
263 * @param owner_state Node.
266 Stateful::add_properties (XMLNode& owner_state)
268 for (OwnedPropertyList::iterator i = _properties->begin(); i != _properties->end(); ++i) {
269 i->second->get_value (owner_state);
274 Stateful::add_property (PropertyBase& s)
276 _properties->add (s);
280 Stateful::send_change (const PropertyChange& what_changed)
282 if (what_changed.empty()) {
287 Glib::Threads::Mutex::Lock lm (_lock);
288 if (property_changes_suspended ()) {
289 _pending_changed.add (what_changed);
294 PropertyChanged (what_changed);
298 Stateful::suspend_property_changes ()
300 g_atomic_int_add (&_stateful_frozen, 1);
304 Stateful::resume_property_changes ()
306 PropertyChange what_changed;
309 Glib::Threads::Mutex::Lock lm (_lock);
311 if (property_changes_suspended() && g_atomic_int_dec_and_test (&_stateful_frozen) == FALSE) {
315 if (!_pending_changed.empty()) {
316 what_changed = _pending_changed;
317 _pending_changed.clear ();
321 mid_thaw (what_changed);
323 send_change (what_changed);
327 Stateful::changed() const
329 for (OwnedPropertyList::const_iterator i = _properties->begin(); i != _properties->end(); ++i) {
330 if (i->second->changed()) {
339 Stateful::apply_changes (const PropertyBase& prop)
341 OwnedPropertyList::iterator i = _properties->find (prop.property_id());
342 if (i == _properties->end()) {
346 i->second->apply_changes (&prop);
351 Stateful::property_factory (const XMLNode& history_node) const
353 PropertyList* prop_list = new PropertyList;
355 for (OwnedPropertyList::const_iterator i = _properties->begin(); i != _properties->end(); ++i) {
356 PropertyBase* prop = i->second->clone_from_xml (history_node);
359 prop_list->add (prop);
367 Stateful::rdiff (vector<Command*>& cmds) const
369 for (OwnedPropertyList::const_iterator i = _properties->begin(); i != _properties->end(); ++i) {
370 i->second->rdiff (cmds);
375 Stateful::clear_owned_changes ()
377 for (OwnedPropertyList::iterator i = _properties->begin(); i != _properties->end(); ++i) {
378 i->second->clear_owned_changes ();
383 Stateful::set_id (const XMLNode& node)
385 const XMLProperty* prop;
386 bool* regen = _regenerate_xml_or_string_ids.get();
388 if (regen && *regen) {
393 if ((prop = node.property ("id")) != 0) {
394 _id = prop->value ();
402 Stateful::reset_id ()
408 Stateful::set_id (const string& str)
410 bool* regen = _regenerate_xml_or_string_ids.get();
412 if (regen && *regen) {
420 Stateful::regenerate_xml_or_string_ids () const
422 bool* regen = _regenerate_xml_or_string_ids.get();
423 if (regen && *regen) {
431 Stateful::set_regenerate_xml_and_string_ids_in_this_thread (bool yn)
433 bool* val = new bool (yn);
434 _regenerate_xml_or_string_ids.set (val);