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     $Id$
  19 */
  20
  21 #ifndef __lib_pbd_undo_h__
  22 #define __lib_pbd_undo_h__
  23
  24 #include <string>
  25 #include <list>
  26 #include <map>
  27 #include <sigc++/slot.h>
  28 #include <sigc++/bind.h>
  29 #include <sys/time.h>
  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         ~UndoTransaction ();
  41
  42         void clear ();
  43
  44         void add_command (Command* const);
  45
  46         void operator() ();
  47         void undo();
  48         void redo();
  49
  50         XMLNode &get_state();
  51
  52         void set_name (const std::string& str) {
  53                 _name = str;
  54         }
  55         const std::string& name() const { return _name; }
  56
  57         void set_timestamp (struct timeval &t) {
  58                 _timestamp = t;
  59         }
  60
  61         const struct timeval& timestamp() const {
  62                 return _timestamp;
  63         }
  64
  65   private:
  66         std::list<Command*>    actions;
  67         struct timeval        _timestamp;
  68         std::string           _name;
  69         bool                   clearing;
  70         void remove_command (Command* const);
  71 };
  72
  73 class UndoHistory
  74 {
  75   public:
  76         UndoHistory();
  77         ~UndoHistory() {}
  78
  79         void add (UndoTransaction* ut);
  80         void undo (unsigned int n);
  81         void redo (unsigned int n);
  82
  83         unsigned long undo_depth() const { return UndoList.size(); }
  84         unsigned long redo_depth() const { return RedoList.size(); }
  85
  86         std::string next_undo() const { return (UndoList.empty() ? std::string("") : UndoList.back()->name()); }
  87         std::string next_redo() const { return (RedoList.empty() ? std::string("") : RedoList.back()->name()); }
  88
  89         void clear ();
  90         void clear_undo ();
  91         void clear_redo ();
  92
  93         XMLNode &get_state();
  94         void save_state();
  95
  96   private:
  97         bool clearing;
  98         std::list<UndoTransaction*> UndoList;
  99         std::list<UndoTransaction*> RedoList;
 100
 101         void remove (UndoTransaction*);
 102 };
 103
 104
 105 #endif /* __lib_pbd_undo_h__ */