*** NEW CODING POLICY ***
[ardour.git] / libs / pbd / undo.cc
index 6f421de84edcfa450f1c7605ba796af9591b8a22..a0e98f9a132029a2b62b06967cf22bf4546420dd 100644 (file)
     $Id$
 */
 
-#include <iostream>
-
-#include <pbd/undo.h>
-#include <pbd/xml++.h>
 #include <string>
 #include <sstream>
+#include <time.h>
+
+#include "pbd/undo.h"
+#include "pbd/xml++.h"
+
+#include <sigc++/bind.h>
 
 using namespace std;
 using namespace sigc;
 
 UndoTransaction::UndoTransaction ()
+       : _clearing(false)
 {
+       gettimeofday (&_timestamp, 0);
 }
 
 UndoTransaction::UndoTransaction (const UndoTransaction& rhs)
+       : Command(rhs._name)
+       , _clearing(false)
 {
-       _name = rhs._name;
        clear ();
        actions.insert(actions.end(),rhs.actions.begin(),rhs.actions.end());
 }
 
+UndoTransaction::~UndoTransaction ()
+{
+       GoingAway ();
+       clear ();
+}
+
+void 
+command_death (UndoTransaction* ut, Command* c)
+{
+       if (ut->clearing()) {
+               return;
+       }
+
+       ut->remove_command (c);
+
+       if (ut->empty()) {
+               delete ut;
+       }
+}
+
 UndoTransaction& 
 UndoTransaction::operator= (const UndoTransaction& rhs)
 {
@@ -52,13 +77,49 @@ UndoTransaction::operator= (const UndoTransaction& rhs)
 void
 UndoTransaction::add_command (Command *const action)
 {
+       /* catch death of command (e.g. caused by death of object to
+          which it refers.
+        */
+       shivas.push_back (new PBD::ProxyShiva<Command,UndoTransaction> (*action, *this, &command_death));
        actions.push_back (action);
 }
 
+void
+UndoTransaction::remove_command (Command* const action)
+{
+       actions.remove (action);
+}
+
+void
+UndoTransaction::about_to_explicitly_delete ()
+{
+       /* someone is going to call our destructor and its not Shiva,
+          the god of destruction and chaos. This happens when an UndoHistory
+          is pruning itself. we must remove Shivas to avoid the god
+          striking us down a second time, unnecessarily and illegally.
+       */
+
+       for (list<PBD::ProxyShiva<Command,UndoTransaction>*>::iterator i = shivas.begin(); i != shivas.end(); ++i) {
+               delete *i;
+       }
+       shivas.clear ();
+}
+
+bool
+UndoTransaction::empty () const
+{
+       return actions.empty();
+}
+
 void
 UndoTransaction::clear ()
 {
+       _clearing = true;
+       for (list<Command*>::iterator i = actions.begin(); i != actions.end(); ++i) {
+               delete *i;
+       }
        actions.clear ();
+       _clearing = false;
 }
 
 void
@@ -72,7 +133,6 @@ UndoTransaction::operator() ()
 void
 UndoTransaction::undo ()
 {
-       cerr << "Undo " << _name << endl;
        for (list<Command*>::reverse_iterator i = actions.rbegin(); i != actions.rend(); ++i) {
                (*i)->undo();
        }
@@ -81,7 +141,6 @@ UndoTransaction::undo ()
 void
 UndoTransaction::redo ()
 {
-       cerr << "Redo " << _name << endl;
         (*this)();
 }
 
@@ -103,12 +162,86 @@ XMLNode &UndoTransaction::get_state()
     return *node;
 }
 
+UndoHistory::UndoHistory ()
+{
+       _clearing = false;
+       _depth = 0;
+}
+
 void
-UndoHistory::add (UndoTransaction ut)
+UndoHistory::set_depth (uint32_t d)
 {
+       UndoTransaction* ut;
+       uint32_t current_depth = UndoList.size();
+
+       _depth = d;
+
+       if (d > current_depth) {
+               /* not even transactions to meet request */
+               return;
+       }
+
+       if (_depth > 0) {
+
+               uint32_t cnt = current_depth - d;
+
+               while (cnt--) {
+                       ut = UndoList.front();
+                       UndoList.pop_front ();
+                       ut->about_to_explicitly_delete ();
+                       delete ut;
+               }
+       }
+}
+
+void
+UndoHistory::add (UndoTransaction* const ut)
+{
+       uint32_t current_depth = UndoList.size();
+
+       ut->GoingAway.connect (bind (mem_fun (*this, &UndoHistory::remove), ut));
+
+       /* if the current undo history is larger than or equal to the currently
+          requested depth, then pop off at least 1 element to make space
+          at the back for new one.
+       */
+
+       if ((_depth > 0) && current_depth && (current_depth >= _depth)) {
+
+               uint32_t cnt = 1 + (current_depth - _depth);
+
+               while (cnt--) {
+                       UndoTransaction* ut;
+                       ut = UndoList.front ();
+                       UndoList.pop_front ();
+                       ut->about_to_explicitly_delete ();
+                       delete ut;
+               }
+       }
+
        UndoList.push_back (ut);
+
+       /* we are now owners of the transaction and must delete it when finished with it */
+
+       Changed (); /* EMIT SIGNAL */
+}
+
+void
+UndoHistory::remove (UndoTransaction* const ut)
+{
+       if (_clearing) {
+               return;
+       }
+
+       UndoList.remove (ut);
+       RedoList.remove (ut);
+
+       Changed (); /* EMIT SIGNAL */
 }
 
+/** Undo some transactions.
+ * @param n Number of transactions to undo.
+ */
 void
 UndoHistory::undo (unsigned int n)
 {
@@ -116,11 +249,13 @@ UndoHistory::undo (unsigned int n)
                if (UndoList.size() == 0) {
                        return;
                }
-               UndoTransaction ut = UndoList.back ();
+               UndoTransaction* ut = UndoList.back ();
                UndoList.pop_back ();
-               ut.undo ();
+               ut->undo ();
                RedoList.push_back (ut);
        }
+
+       Changed (); /* EMIT SIGNAL */
 }
 
 void
@@ -130,39 +265,78 @@ UndoHistory::redo (unsigned int n)
                if (RedoList.size() == 0) {
                        return;
                }
-               UndoTransaction ut = RedoList.back ();
+               UndoTransaction* ut = RedoList.back ();
                RedoList.pop_back ();
-               ut.redo ();
+               ut->redo ();
                UndoList.push_back (ut);
        }
+
+       Changed (); /* EMIT SIGNAL */
 }
 
 void
 UndoHistory::clear_redo ()
 {
+       _clearing = true;
        RedoList.clear ();
+       _clearing = false;
+
+       Changed (); /* EMIT SIGNAL */
+
 }
 
 void
 UndoHistory::clear_undo ()
 {
+       _clearing = true;
        UndoList.clear ();
+       _clearing = false;
+
+       Changed (); /* EMIT SIGNAL */
 }
 
 void
 UndoHistory::clear ()
 {
-       RedoList.clear ();
-       UndoList.clear ();
+       clear_undo ();
+       clear_redo ();
+
+       Changed (); /* EMIT SIGNAL */
 }
 
-XMLNode & UndoHistory::get_state()
+XMLNode& 
+UndoHistory::get_state (int32_t depth)
 {
     XMLNode *node = new XMLNode ("UndoHistory");
 
-    list<UndoTransaction>::iterator it;
-    for (it=UndoList.begin(); it != UndoList.end(); it++)
-        node->add_child_nocopy(it->get_state());
+    if (depth == 0) {
+
+           return (*node);
+
+    } else if (depth < 0) {
+
+           /* everything */
+
+           for (list<UndoTransaction*>::iterator it = UndoList.begin(); it != UndoList.end(); ++it) {
+                   node->add_child_nocopy((*it)->get_state());
+           }
+
+    } else {
+
+           /* just the last "depth" transactions */
+
+           list<UndoTransaction*> in_order;
+
+           for (list<UndoTransaction*>::reverse_iterator it = UndoList.rbegin(); it != UndoList.rend() && depth; ++it, depth--) {
+                   in_order.push_front (*it);
+           }
+
+           for (list<UndoTransaction*>::iterator it = in_order.begin(); it != in_order.end(); it++) {
+                   node->add_child_nocopy((*it)->get_state());
+           }
+    }
 
     return *node;
 }
+
+