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
)
45 actions
.insert(actions
.end(),rhs
.actions
.begin(),rhs
.actions
.end());
48 UndoTransaction::~UndoTransaction ()
55 command_death (UndoTransaction
* ut
, Command
* c
)
61 ut
->remove_command (c
);
69 UndoTransaction::operator= (const UndoTransaction
& rhs
)
71 if (this == &rhs
) return *this;
74 actions
.insert(actions
.end(),rhs
.actions
.begin(),rhs
.actions
.end());
79 UndoTransaction::add_command (Command
*const cmd
)
81 /* catch death of command (e.g. caused by death of object to
82 which it refers. command_death() is a normal static function
83 so there is no need to manage this connection.
86 cmd
->DropReferences
.connect_same_thread (*this, boost::bind (&command_death
, this, cmd
));
87 actions
.push_back (cmd
);
91 UndoTransaction::remove_command (Command
* const action
)
93 actions
.remove (action
);
97 UndoTransaction::empty () const
99 return actions
.empty();
103 UndoTransaction::clear ()
106 for (list
<Command
*>::iterator i
= actions
.begin(); i
!= actions
.end(); ++i
) {
114 UndoTransaction::operator() ()
116 for (list
<Command
*>::iterator i
= actions
.begin(); i
!= actions
.end(); ++i
) {
122 UndoTransaction::undo ()
124 for (list
<Command
*>::reverse_iterator i
= actions
.rbegin(); i
!= actions
.rend(); ++i
) {
130 UndoTransaction::redo ()
135 XMLNode
&UndoTransaction::get_state()
137 XMLNode
*node
= new XMLNode ("UndoTransaction");
139 ss
<< _timestamp
.tv_sec
;
140 node
->add_property("tv_sec", ss
.str());
142 ss
<< _timestamp
.tv_usec
;
143 node
->add_property("tv_usec", ss
.str());
144 node
->add_property("name", _name
);
146 list
<Command
*>::iterator it
;
147 for (it
=actions
.begin(); it
!=actions
.end(); it
++)
148 node
->add_child_nocopy((*it
)->get_state());
153 class UndoRedoSignaller
{
155 UndoRedoSignaller (UndoHistory
& uh
)
157 _history
.BeginUndoRedo();
159 ~UndoRedoSignaller() {
160 _history
.EndUndoRedo();
164 UndoHistory
& _history
;
167 UndoHistory::UndoHistory ()
174 UndoHistory::set_depth (uint32_t d
)
177 uint32_t current_depth
= UndoList
.size();
181 if (d
> current_depth
) {
182 /* not even transactions to meet request */
188 uint32_t cnt
= current_depth
- d
;
191 ut
= UndoList
.front();
192 UndoList
.pop_front ();
199 UndoHistory::add (UndoTransaction
* const ut
)
201 uint32_t current_depth
= UndoList
.size();
203 ut
->DropReferences
.connect_same_thread (*this, boost::bind (&UndoHistory::remove
, this, ut
));
205 /* if the current undo history is larger than or equal to the currently
206 requested depth, then pop off at least 1 element to make space
207 at the back for new one.
210 if ((_depth
> 0) && current_depth
&& (current_depth
>= _depth
)) {
212 uint32_t cnt
= 1 + (current_depth
- _depth
);
216 ut
= UndoList
.front ();
217 UndoList
.pop_front ();
222 UndoList
.push_back (ut
);
224 /* we are now owners of the transaction and must delete it when finished with it */
226 Changed (); /* EMIT SIGNAL */
230 UndoHistory::remove (UndoTransaction
* const ut
)
236 UndoList
.remove (ut
);
237 RedoList
.remove (ut
);
239 Changed (); /* EMIT SIGNAL */
242 /** Undo some transactions.
243 * @param n Number of transactions to undo.
246 UndoHistory::undo (unsigned int n
)
253 UndoRedoSignaller
exception_safe_signaller (*this);
256 if (UndoList
.size() == 0) {
259 UndoTransaction
* ut
= UndoList
.back ();
260 UndoList
.pop_back ();
262 RedoList
.push_back (ut
);
266 Changed (); /* EMIT SIGNAL */
270 UndoHistory::redo (unsigned int n
)
277 UndoRedoSignaller
exception_safe_signaller (*this);
280 if (RedoList
.size() == 0) {
283 UndoTransaction
* ut
= RedoList
.back ();
284 RedoList
.pop_back ();
286 UndoList
.push_back (ut
);
290 Changed (); /* EMIT SIGNAL */
294 UndoHistory::clear_redo ()
300 Changed (); /* EMIT SIGNAL */
305 UndoHistory::clear_undo ()
311 Changed (); /* EMIT SIGNAL */
315 UndoHistory::clear ()
320 Changed (); /* EMIT SIGNAL */
324 UndoHistory::get_state (int32_t depth
)
326 XMLNode
*node
= new XMLNode ("UndoHistory");
332 } else if (depth
< 0) {
336 for (list
<UndoTransaction
*>::iterator it
= UndoList
.begin(); it
!= UndoList
.end(); ++it
) {
337 node
->add_child_nocopy((*it
)->get_state());
342 /* just the last "depth" transactions */
344 list
<UndoTransaction
*> in_order
;
346 for (list
<UndoTransaction
*>::reverse_iterator it
= UndoList
.rbegin(); it
!= UndoList
.rend() && depth
; ++it
, depth
--) {
347 in_order
.push_front (*it
);
350 for (list
<UndoTransaction
*>::iterator it
= in_order
.begin(); it
!= in_order
.end(); it
++) {
351 node
->add_child_nocopy((*it
)->get_state());