libs/pbd/pbd/undo.h

   1 /*
   2     Copyright (C) 2002 Brett Viren & Paul Davis
   3
   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.
   8
   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.
  13
  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.
  17
  18 */
  19
  20 #ifndef __lib_pbd_undo_h__
  21 #define __lib_pbd_undo_h__
  22
  23 #include <string>
  24 #include <list>
  25 #include <map>
  26 #include <sigc++/slot.h>
  27 #include <sigc++/bind.h>
  28 #include <sys/time.h>
  29
  30 #include "pbd/command.h"
  31
  32 typedef sigc::slot<void> UndoAction;
  33
  34 class UndoTransaction : public Command
  35 {
  36   public:
  37         UndoTransaction ();
  38         UndoTransaction (const UndoTransaction&);
  39         UndoTransaction& operator= (const UndoTransaction&);
  40
  41         void clear ();
  42         bool empty() const;
  43         bool clearing () const { return _clearing; }
  44
  45         void add_command (Command* const);
  46         void remove_command (Command* const);
  47
  48         void operator() ();
  49         void undo();
  50         void redo();
  51
  52         XMLNode &get_state();
  53
  54         void set_timestamp (struct timeval &t) {
  55                 _timestamp = t;
  56         }
  57
  58         const struct timeval& timestamp() const {
  59                 return _timestamp;
  60         }
  61
  62   private:
  63         std::list<Command*>    actions;
  64         struct timeval        _timestamp;
  65         bool                  _clearing;
  66
  67         friend void command_death (UndoTransaction*, Command *);
  68
  69         friend class UndoHistory;
  70
  71         ~UndoTransaction ();
  72         void about_to_explicitly_delete ();
  73 };
  74
  75 class UndoHistory : public PBD::ScopedConnectionList
  76 {
  77   public:
  78         UndoHistory();
  79         ~UndoHistory() {}
  80
  81         void add (UndoTransaction* ut);
  82         void undo (unsigned int n);
  83         void redo (unsigned int n);
  84
  85         unsigned long undo_depth() const { return UndoList.size(); }
  86         unsigned long redo_depth() const { return RedoList.size(); }
  87
  88         std::string next_undo() const { return (UndoList.empty() ? std::string() : UndoList.back()->name()); }
  89         std::string next_redo() const { return (RedoList.empty() ? std::string() : RedoList.back()->name()); }
  90
  91         void clear ();
  92         void clear_undo ();
  93         void clear_redo ();
  94
  95         /* returns all or part of the history.
  96            If depth==0 it returns just the top
  97            node. If depth<0, it returns everything.
  98            If depth>0, it returns state for that
  99            many elements of the history, or
 100            the full history, whichever is smaller.
 101         */
 102
 103         XMLNode &get_state(int32_t depth = 0);
 104         void save_state();
 105
 106         void set_depth (uint32_t);
 107
 108         PBD::Signal0<void> Changed;
 109         PBD::Signal0<void> BeginUndoRedo;
 110         PBD::Signal0<void> EndUndoRedo;
 111
 112   private:
 113         bool _clearing;
 114         uint32_t _depth;
 115         std::list<UndoTransaction*> UndoList;
 116         std::list<UndoTransaction*> RedoList;
 117
 118         void remove (UndoTransaction*);
 119 };
 120
 121
 122 #endif /* __lib_pbd_undo_h__ */