2 Copyright (C) 2001 Brett Viren & 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.
27 #include "pbd/xml++.h"
29 #include <sigc++/bind.h>
34 UndoTransaction::UndoTransaction ()
37 gettimeofday (&_timestamp, 0);
40 UndoTransaction::UndoTransaction (const UndoTransaction& rhs)
44 _timestamp = rhs._timestamp;
46 actions.insert(actions.end(),rhs.actions.begin(),rhs.actions.end());
49 UndoTransaction::~UndoTransaction ()
56 command_death (UndoTransaction* ut, Command* c)
62 ut->remove_command (c);
70 UndoTransaction::operator= (const UndoTransaction& rhs)
72 if (this == &rhs) return *this;
75 actions.insert(actions.end(),rhs.actions.begin(),rhs.actions.end());
80 UndoTransaction::add_command (Command *const cmd)
82 /* catch death of command (e.g. caused by death of object to
83 which it refers. command_death() is a normal static function
84 so there is no need to manage this connection.
87 cmd->DropReferences.connect_same_thread (*this, boost::bind (&command_death, this, cmd));
88 actions.push_back (cmd);
92 UndoTransaction::remove_command (Command* const action)
94 actions.remove (action);
98 UndoTransaction::empty () const
100 return actions.empty();
104 UndoTransaction::clear ()
107 for (list<Command*>::iterator i = actions.begin(); i != actions.end(); ++i) {
115 UndoTransaction::operator() ()
117 for (list<Command*>::iterator i = actions.begin(); i != actions.end(); ++i) {
123 UndoTransaction::undo ()
125 for (list<Command*>::reverse_iterator i = actions.rbegin(); i != actions.rend(); ++i) {
131 UndoTransaction::redo ()
136 XMLNode &UndoTransaction::get_state()
138 XMLNode *node = new XMLNode ("UndoTransaction");
140 ss << _timestamp.tv_sec;
141 node->add_property("tv_sec", ss.str());
143 ss << _timestamp.tv_usec;
144 node->add_property("tv_usec", ss.str());
145 node->add_property("name", _name);
147 list<Command*>::iterator it;
148 for (it=actions.begin(); it!=actions.end(); it++)
149 node->add_child_nocopy((*it)->get_state());
154 class UndoRedoSignaller {
156 UndoRedoSignaller (UndoHistory& uh)
158 _history.BeginUndoRedo();
160 ~UndoRedoSignaller() {
161 _history.EndUndoRedo();
165 UndoHistory& _history;
168 UndoHistory::UndoHistory ()
175 UndoHistory::set_depth (uint32_t d)
178 uint32_t current_depth = UndoList.size();
182 if (d > current_depth) {
183 /* not even transactions to meet request */
189 uint32_t cnt = current_depth - d;
192 ut = UndoList.front();
193 UndoList.pop_front ();
200 UndoHistory::add (UndoTransaction* const ut)
202 uint32_t current_depth = UndoList.size();
204 ut->DropReferences.connect_same_thread (*this, boost::bind (&UndoHistory::remove, this, ut));
206 /* if the current undo history is larger than or equal to the currently
207 requested depth, then pop off at least 1 element to make space
208 at the back for new one.
211 if ((_depth > 0) && current_depth && (current_depth >= _depth)) {
213 uint32_t cnt = 1 + (current_depth - _depth);
217 ut = UndoList.front ();
218 UndoList.pop_front ();
223 UndoList.push_back (ut);
225 /* we are now owners of the transaction and must delete it when finished with it */
227 Changed (); /* EMIT SIGNAL */
231 UndoHistory::remove (UndoTransaction* const ut)
237 UndoList.remove (ut);
238 RedoList.remove (ut);
240 Changed (); /* EMIT SIGNAL */
243 /** Undo some transactions.
244 * @param n Number of transactions to undo.
247 UndoHistory::undo (unsigned int n)
254 UndoRedoSignaller exception_safe_signaller (*this);
257 if (UndoList.size() == 0) {
260 UndoTransaction* ut = UndoList.back ();
261 UndoList.pop_back ();
263 RedoList.push_back (ut);
267 Changed (); /* EMIT SIGNAL */
271 UndoHistory::redo (unsigned int n)
278 UndoRedoSignaller exception_safe_signaller (*this);
281 if (RedoList.size() == 0) {
284 UndoTransaction* ut = RedoList.back ();
285 RedoList.pop_back ();
287 UndoList.push_back (ut);
291 Changed (); /* EMIT SIGNAL */
295 UndoHistory::clear_redo ()
298 for (std::list<UndoTransaction*>::iterator i = RedoList.begin(); i != RedoList.end(); ++i) {
304 Changed (); /* EMIT SIGNAL */
309 UndoHistory::clear_undo ()
312 for (std::list<UndoTransaction*>::iterator i = UndoList.begin(); i != UndoList.end(); ++i) {
318 Changed (); /* EMIT SIGNAL */
322 UndoHistory::clear ()
327 Changed (); /* EMIT SIGNAL */
331 UndoHistory::get_state (int32_t depth)
333 XMLNode *node = new XMLNode ("UndoHistory");
339 } else if (depth < 0) {
343 for (list<UndoTransaction*>::iterator it = UndoList.begin(); it != UndoList.end(); ++it) {
344 node->add_child_nocopy((*it)->get_state());
349 /* just the last "depth" transactions */
351 list<UndoTransaction*> in_order;
353 for (list<UndoTransaction*>::reverse_iterator it = UndoList.rbegin(); it != UndoList.rend() && depth; ++it, depth--) {
354 in_order.push_front (*it);
357 for (list<UndoTransaction*>::iterator it = in_order.begin(); it != in_order.end(); it++) {
358 node->add_child_nocopy((*it)->get_state());