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/stateful.h"
24 #include "pbd/destructible.h"
25 #include "pbd/filesystem.h"
26 #include "pbd/xml++.h"
27 #include "pbd/error.h"
35 int Stateful::current_state_version = 0;
36 int Stateful::loading_state_version = 0;
44 Stateful::~Stateful ()
46 // Do not delete _extra_xml. The use of add_child_nocopy()
47 // means it needs to live on indefinately.
53 Stateful::add_extra_xml (XMLNode& node)
55 if (_extra_xml == 0) {
56 _extra_xml = new XMLNode ("Extra");
59 _extra_xml->remove_nodes (node.name());
60 _extra_xml->add_child_nocopy (node);
64 Stateful::extra_xml (const string& str)
66 if (_extra_xml == 0) {
70 const XMLNodeList& nlist = _extra_xml->children();
71 XMLNodeConstIterator i;
73 for (i = nlist.begin(); i != nlist.end(); ++i) {
74 if ((*i)->name() == str) {
83 Stateful::add_instant_xml (XMLNode& node, const sys::path& directory_path)
85 sys::create_directories (directory_path); // may throw
87 if (_instant_xml == 0) {
88 _instant_xml = new XMLNode ("instant");
91 _instant_xml->remove_nodes_and_delete (node.name());
92 _instant_xml->add_child_copy (node);
94 sys::path instant_xml_path(directory_path);
96 instant_xml_path /= "instant.xml";
99 tree.set_filename(instant_xml_path.to_string());
101 /* Important: the destructor for an XMLTree deletes
102 all of its nodes, starting at _root. We therefore
103 cannot simply hand it our persistent _instant_xml
104 node as its _root, because we will lose it whenever
105 the Tree goes out of scope.
107 So instead, copy the _instant_xml node (which does
108 a deep copy), and hand that to the tree.
111 XMLNode* copy = new XMLNode (*_instant_xml);
112 tree.set_root (copy);
115 error << string_compose(_("Error: could not write %1"), instant_xml_path.to_string()) << endmsg;
120 Stateful::instant_xml (const string& str, const sys::path& directory_path)
122 if (_instant_xml == 0) {
124 sys::path instant_xml_path(directory_path);
125 instant_xml_path /= "instant.xml";
127 if (exists(instant_xml_path)) {
129 if (tree.read(instant_xml_path.to_string())) {
130 _instant_xml = new XMLNode(*(tree.root()));
132 warning << string_compose(_("Could not understand XML file %1"), instant_xml_path.to_string()) << endmsg;
140 const XMLNodeList& nlist = _instant_xml->children();
141 XMLNodeConstIterator i;
143 for (i = nlist.begin(); i != nlist.end(); ++i) {
144 if ((*i)->name() == str) {
152 /** Forget about any old state for this object */
154 Stateful::clear_history ()
156 for (list<StateBase*>::iterator i = _states.begin(); i != _states.end(); ++i) {
157 (*i)->clear_history ();
161 /** @return A pair of XMLNodes representing state that has changed since the last time clear_history
162 * was called on this object; the first is the state before, the second the state after.
164 * It is the caller's responsibility to delete the returned XMLNodes.
166 pair<XMLNode *, XMLNode *>
169 XMLNode* old = new XMLNode (_xml_node_name);
170 XMLNode* current = new XMLNode (_xml_node_name);
172 for (list<StateBase*>::iterator i = _states.begin(); i != _states.end(); ++i) {
173 (*i)->diff (old, current);
176 return make_pair (old, current);