Merge branch 'master' into cairocanvas
[ardour.git] / libs / pbd / pbd / undo.h
index f067635ed3a2adf3ba9c58f393e779c0e05c4288..11ff2bf321b806106001ce8a9f27d768b890c86a 100644 (file)
@@ -1,5 +1,5 @@
 /* 
-   Copyright (C) 2002 Brett Viren & Paul Davis
+    Copyright (C) 2002 Brett Viren & 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
@@ -15,7 +15,6 @@
     along with this program; if not, write to the Free Software
     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 
-    $Id$
 */
 
 #ifndef __lib_pbd_undo_h__
 
 #include <string>
 #include <list>
+#include <map>
 #include <sigc++/slot.h>
+#include <sigc++/bind.h>
 #include <sys/time.h>
 
-using std::string;
-using std::list;
+#include "pbd/command.h"
 
 typedef sigc::slot<void> UndoAction;
 
-class UndoCommand 
+class UndoTransaction : public Command
 {
   public:
-       UndoCommand ();
-       UndoCommand (const UndoCommand&);
-       UndoCommand& operator= (const UndoCommand&);
+       UndoTransaction ();
+       UndoTransaction (const UndoTransaction&);
+       UndoTransaction& operator= (const UndoTransaction&);
+       ~UndoTransaction ();
 
        void clear ();
+       bool empty() const;
+       bool clearing () const { return _clearing; }
 
-       void add_undo (const UndoAction&);
-       void add_redo (const UndoAction&);
-       void add_redo_no_execute (const UndoAction&);
+       void add_command (Command* const);
+       void remove_command (Command* const);
 
+       void operator() ();
        void undo();
        void redo();
-       
-       void set_name (const string& str) {
-               _name = str;
-       }
-       const string& name() const { return _name; }
+
+       XMLNode &get_state();
 
        void set_timestamp (struct timeval &t) {
                _timestamp = t;
@@ -61,35 +61,59 @@ class UndoCommand
        }
 
   private:
-       list<UndoAction> redo_actions;
-       list<UndoAction> undo_actions;
-       struct timeval   _timestamp;
-       string           _name;
+       std::list<Command*>    actions;
+       struct timeval        _timestamp;
+       bool                  _clearing;
+
+       friend void command_death (UndoTransaction*, Command *);
+       
+       void about_to_explicitly_delete ();
 };
 
-class UndoHistory
+class UndoHistory : public PBD::ScopedConnectionList
 {
   public:
-       UndoHistory() {}
+       UndoHistory();
        ~UndoHistory() {}
        
-       void add (UndoCommand uc);
+       void add (UndoTransaction* ut);
        void undo (unsigned int n);
        void redo (unsigned int n);
        
        unsigned long undo_depth() const { return UndoList.size(); }
        unsigned long redo_depth() const { return RedoList.size(); }
        
-       string next_undo() const { return (UndoList.empty() ? string("") : UndoList.back().name()); }
-       string next_redo() const { return (RedoList.empty() ? string("") : RedoList.back().name()); }
+       std::string next_undo() const { return (UndoList.empty() ? std::string() : UndoList.back()->name()); }
+       std::string next_redo() const { return (RedoList.empty() ? std::string() : RedoList.back()->name()); }
 
        void clear ();
        void clear_undo ();
        void clear_redo ();
 
+       /* returns all or part of the history.
+          If depth==0 it returns just the top
+          node. If depth<0, it returns everything.
+          If depth>0, it returns state for that
+          many elements of the history, or 
+          the full history, whichever is smaller.
+       */
+
+        XMLNode &get_state(int32_t depth = 0);
+        void save_state();
+
+       void set_depth (uint32_t);
+
+       PBD::Signal0<void> Changed;
+       PBD::Signal0<void> BeginUndoRedo;
+       PBD::Signal0<void> EndUndoRedo;
+       
   private:
-       list<UndoCommand> UndoList;
-       list<UndoCommand> RedoList;
+       bool _clearing;
+       uint32_t _depth;
+       std::list<UndoTransaction*> UndoList;
+       std::list<UndoTransaction*> RedoList;
+
+       void remove (UndoTransaction*);
 };