13
0
livetrax/libs/pbd/stateful.cc
Carl Hetherington 3c00a7ca2a Move ARDOUR::Change into PBD so that Stateful can be aware of
what Change a State reflects.  Hence allow Stateful to do some
of the work of set/get_state in Region.


git-svn-id: svn://localhost/ardour2/branches/3.0@6671 d708f5d6-7413-0410-9779-e7cbd77b26cf
2010-02-10 01:38:20 +00:00

228 lines
5.1 KiB
C++

/*
Copyright (C) 2000-2001 Paul Davis
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
$Id: stateful.cc 629 2006-06-21 23:01:03Z paul $
*/
#include <unistd.h>
#include "pbd/stateful.h"
#include "pbd/destructible.h"
#include "pbd/filesystem.h"
#include "pbd/xml++.h"
#include "pbd/error.h"
#include "i18n.h"
using namespace std;
namespace PBD {
int Stateful::current_state_version = 0;
int Stateful::loading_state_version = 0;
PBD::Change
new_change ()
{
Change c;
static uint32_t change_bit = 1;
/* catch out-of-range */
if (!change_bit)
{
fatal << _("programming error: ")
<< "change_bit out of range in ARDOUR::new_change()"
<< endmsg;
/*NOTREACHED*/
}
c = Change (change_bit);
change_bit <<= 1; // if it shifts too far, change_bit == 0
return c;
}
Stateful::Stateful ()
{
_extra_xml = 0;
_instant_xml = 0;
}
Stateful::~Stateful ()
{
// Do not delete _extra_xml. The use of add_child_nocopy()
// means it needs to live on indefinately.
delete _instant_xml;
}
void
Stateful::add_extra_xml (XMLNode& node)
{
if (_extra_xml == 0) {
_extra_xml = new XMLNode ("Extra");
}
_extra_xml->remove_nodes (node.name());
_extra_xml->add_child_nocopy (node);
}
XMLNode *
Stateful::extra_xml (const string& str)
{
if (_extra_xml == 0) {
return 0;
}
const XMLNodeList& nlist = _extra_xml->children();
XMLNodeConstIterator i;
for (i = nlist.begin(); i != nlist.end(); ++i) {
if ((*i)->name() == str) {
return (*i);
}
}
return 0;
}
void
Stateful::add_instant_xml (XMLNode& node, const sys::path& directory_path)
{
sys::create_directories (directory_path); // may throw
if (_instant_xml == 0) {
_instant_xml = new XMLNode ("instant");
}
_instant_xml->remove_nodes_and_delete (node.name());
_instant_xml->add_child_copy (node);
sys::path instant_xml_path(directory_path);
instant_xml_path /= "instant.xml";
XMLTree tree;
tree.set_filename(instant_xml_path.to_string());
/* Important: the destructor for an XMLTree deletes
all of its nodes, starting at _root. We therefore
cannot simply hand it our persistent _instant_xml
node as its _root, because we will lose it whenever
the Tree goes out of scope.
So instead, copy the _instant_xml node (which does
a deep copy), and hand that to the tree.
*/
XMLNode* copy = new XMLNode (*_instant_xml);
tree.set_root (copy);
if (!tree.write()) {
error << string_compose(_("Error: could not write %1"), instant_xml_path.to_string()) << endmsg;
}
}
XMLNode *
Stateful::instant_xml (const string& str, const sys::path& directory_path)
{
if (_instant_xml == 0) {
sys::path instant_xml_path(directory_path);
instant_xml_path /= "instant.xml";
if (exists(instant_xml_path)) {
XMLTree tree;
if (tree.read(instant_xml_path.to_string())) {
_instant_xml = new XMLNode(*(tree.root()));
} else {
warning << string_compose(_("Could not understand XML file %1"), instant_xml_path.to_string()) << endmsg;
return 0;
}
} else {
return 0;
}
}
const XMLNodeList& nlist = _instant_xml->children();
XMLNodeConstIterator i;
for (i = nlist.begin(); i != nlist.end(); ++i) {
if ((*i)->name() == str) {
return (*i);
}
}
return 0;
}
/** Forget about any old state for this object */
void
Stateful::clear_history ()
{
for (list<StateBase*>::iterator i = _states.begin(); i != _states.end(); ++i) {
(*i)->clear_history ();
}
}
/** @return A pair of XMLNodes representing state that has changed since the last time clear_history
* was called on this object; the first is the state before, the second the state after.
*
* It is the caller's responsibility to delete the returned XMLNodes.
*/
pair<XMLNode *, XMLNode *>
Stateful::diff ()
{
XMLNode* old = new XMLNode (_xml_node_name);
XMLNode* current = new XMLNode (_xml_node_name);
for (list<StateBase*>::iterator i = _states.begin(); i != _states.end(); ++i) {
(*i)->diff (old, current);
}
return make_pair (old, current);
}
/** Set state of _states from an XML node.
* @param node Node.
* @return Changes made.
*/
Change
Stateful::set_state_using_states (XMLNode const & node)
{
Change c = Change (0);
for (list<StateBase*>::iterator i = _states.begin(); i != _states.end(); ++i) {
c = Change (c | (*i)->set_state (node));
}
return c;
}
/** Add state of _states to an XML node.
* @param node Node.
*/
void
Stateful::add_states (XMLNode & node)
{
for (list<StateBase*>::iterator i = _states.begin(); i != _states.end(); ++i) {
(*i)->add_state (node);
}
}
} // namespace PBD