libs/pbd/stateful.cc

   1 /*
   2     Copyright (C) 2000-2001 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     $Id: stateful.cc 629 2006-06-21 23:01:03Z paul $
  19 */
  20
  21 #include <unistd.h>
  22
  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"
  28
  29 #include "i18n.h"
  30
  31 using namespace std;
  32
  33 namespace PBD {
  34
  35 int Stateful::current_state_version = 0;
  36 int Stateful::loading_state_version = 0;
  37
  38 Stateful::Stateful ()
  39 {
  40         _extra_xml = 0;
  41         _instant_xml = 0;
  42 }
  43
  44 Stateful::~Stateful ()
  45 {
  46         // Do not delete _extra_xml.  The use of add_child_nocopy()
  47         // means it needs to live on indefinately.
  48
  49         delete _instant_xml;
  50
  51         for (list<StateBase*>::iterator i = _states.begin(); i != _states.end(); ++i) {
  52                 delete *i;
  53         }
  54 }
  55
  56 void
  57 Stateful::add_extra_xml (XMLNode& node)
  58 {
  59         if (_extra_xml == 0) {
  60                 _extra_xml = new XMLNode ("Extra");
  61         }
  62
  63         _extra_xml->remove_nodes (node.name());
  64         _extra_xml->add_child_nocopy (node);
  65 }
  66
  67 XMLNode *
  68 Stateful::extra_xml (const string& str)
  69 {
  70         if (_extra_xml == 0) {
  71                 return 0;
  72         }
  73
  74         const XMLNodeList& nlist = _extra_xml->children();
  75         XMLNodeConstIterator i;
  76
  77         for (i = nlist.begin(); i != nlist.end(); ++i) {
  78                 if ((*i)->name() == str) {
  79                         return (*i);
  80                 }
  81         }
  82
  83         return 0;
  84 }
  85
  86 void
  87 Stateful::add_instant_xml (XMLNode& node, const sys::path& directory_path)
  88 {
  89         sys::create_directories (directory_path); // may throw
  90
  91         if (_instant_xml == 0) {
  92                 _instant_xml = new XMLNode ("instant");
  93         }
  94
  95         _instant_xml->remove_nodes_and_delete (node.name());
  96         _instant_xml->add_child_copy (node);
  97
  98         sys::path instant_xml_path(directory_path);
  99
 100         instant_xml_path /= "instant.xml";
 101
 102         XMLTree tree;
 103         tree.set_filename(instant_xml_path.to_string());
 104
 105         /* Important: the destructor for an XMLTree deletes
 106            all of its nodes, starting at _root. We therefore
 107            cannot simply hand it our persistent _instant_xml
 108            node as its _root, because we will lose it whenever
 109            the Tree goes out of scope.
 110
 111            So instead, copy the _instant_xml node (which does
 112            a deep copy), and hand that to the tree.
 113         */
 114
 115         XMLNode* copy = new XMLNode (*_instant_xml);
 116         tree.set_root (copy);
 117
 118         if (!tree.write()) {
 119                 error << string_compose(_("Error: could not write %1"), instant_xml_path.to_string()) << endmsg;
 120         }
 121 }
 122
 123 XMLNode *
 124 Stateful::instant_xml (const string& str, const sys::path& directory_path)
 125 {
 126         if (_instant_xml == 0) {
 127
 128                 sys::path instant_xml_path(directory_path);
 129                 instant_xml_path /= "instant.xml";
 130
 131                 if (exists(instant_xml_path)) {
 132                         XMLTree tree;
 133                         if (tree.read(instant_xml_path.to_string())) {
 134                                 _instant_xml = new XMLNode(*(tree.root()));
 135                         } else {
 136                                 warning << string_compose(_("Could not understand XML file %1"), instant_xml_path.to_string()) << endmsg;
 137                                 return 0;
 138                         }
 139                 } else {
 140                         return 0;
 141                 }
 142         }
 143
 144         const XMLNodeList& nlist = _instant_xml->children();
 145         XMLNodeConstIterator i;
 146
 147         for (i = nlist.begin(); i != nlist.end(); ++i) {
 148                 if ((*i)->name() == str) {
 149                         return (*i);
 150                 }
 151         }
 152
 153         return 0;
 154 }
 155
 156 /** Forget about any old state for this object */
 157 void
 158 Stateful::clear_history ()
 159 {
 160         for (list<StateBase*>::iterator i = _states.begin(); i != _states.end(); ++i) {
 161                 (*i)->clear_history ();
 162         }
 163 }
 164
 165 /** @return A pair of XMLNodes representing state that has changed since the last time clear_history
 166  *  was called on this object; the first is the state before, the second the state after.
 167  *
 168  *  It is the caller's responsibility to delete the returned XMLNodes.
 169  */
 170 pair<XMLNode *, XMLNode *>
 171 Stateful::diff ()
 172 {
 173         XMLNode* old = new XMLNode (_xml_node_name);
 174         XMLNode* current = new XMLNode (_xml_node_name);
 175
 176         for (list<StateBase*>::iterator i = _states.begin(); i != _states.end(); ++i) {
 177                 (*i)->diff (old, current);
 178         }
 179
 180         return make_pair (old, current);
 181 }
 182
 183 } // namespace PBD