Initial revision
[blender.git] / intern / action / ACT_ActionStack.h
1 /**
2  * $Id$
3  * ***** BEGIN GPL/BL DUAL LICENSE BLOCK *****
4  *
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU General Public License
7  * as published by the Free Software Foundation; either version 2
8  * of the License, or (at your option) any later version. The Blender
9  * Foundation also sells licenses for use in proprietary software under
10  * the Blender License.  See http://www.blender.org/BL/ for information
11  * about this.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software Foundation,
20  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
21  *
22  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
23  * All rights reserved.
24  *
25  * The Original Code is: all of this file.
26  *
27  * Contributor(s): none yet.
28  *
29  * ***** END GPL/BL DUAL LICENSE BLOCK *****
30  */
31
32 /**
33
34  * $Id$
35  * Copyright (C) 2001 NaN Technologies B.V.
36  * @author      Maarten Gribnau
37  * @date        March 31, 2001
38  */
39
40 #ifndef _H_ACT_ACTIONSTACK
41 #define _H_ACT_ACTIONSTACK
42
43 #include "ACT_Action.h"
44 #include <deque>
45
46
47 /**
48  * A stack with actions that implements undo/redo capabilities.
49  * A stack can grow to a maximum number of actions by pushing actions on the stack.
50  * By calling undo and redo the apply and undo members of the actions on the stack are called.
51  * In addition, this will move the stackIndex up and down the stack.
52  * When a new action is pushed onto the stack, the actions above the current action are removed from the stack.
53  * Actions pushed onto the stack are applied if they are not applied already.
54  * @todo        implement error handling (e.g. memory errors)
55  * @author      Maarten Gribnau
56  * @date        March 31, 2001
57  */
58
59 class ACT_ActionStack {
60 public:
61         /**
62          * Constructs an action stack.
63          */
64         ACT_ActionStack(unsigned int maxStackDepth = 1);
65
66         /**
67          * Destructs an action stack.
68          */
69         virtual ~ACT_ActionStack();
70
71         /**
72          * Returns the current depth of the stack.
73          * @return the current stack depth.
74          */
75         virtual unsigned int getStackDepth() const;
76
77         /**
78          * Returns the current maximum depth of the stack.
79          * @return the maximum stack depth.
80          */
81         virtual unsigned int getMaxStackDepth() const;
82
83         /**
84          * Sets new maximum depth of the stack.
85          * @param maxStackDepth The new stack depth.
86          */
87         virtual void setMaxStackDepth(unsigned int maxStackDepth);
88
89         /**
90          * Pushes an action on the stack.
91          * If the action has not been applied yet, it will be applied here.
92          * This will increase the reference count of the action.
93          * If there is not enough capacity, the action at the bottom of the stack is removed (and its reference count decreased).
94          * @param action        the action that is pushed onto the stack.
95          */
96         virtual void push(ACT_Action& action);
97
98         /**
99          * Returns pointer to the current undo item.
100          * @return The action scheduled for undo (0 if there is none).
101          */
102         virtual ACT_Action* peekUndo();
103
104         /**
105          * Returns pointer to the current redo item.
106          * @return The action scheduled for redo (0 if there is none).
107          */
108         virtual ACT_Action* peekRedo();
109
110         /**
111          * Flushes the action stack.
112          * All actions are removed from the stack and their reference counts decreased.
113          */
114         virtual void flush();
115
116         /**
117          * Returns whether we can undo the current action.
118          * @return Indication of the possibility to undo.
119          */
120         virtual bool canUndo() const;
121
122         /**
123          * Undos the current action.
124          * This will move the current undo index down (if the stack depth allows it).
125          */
126         virtual void undo();
127
128         /**
129          * Returns whether we can redo the current action.
130          * @return Indication of the possibility to redo.
131          */
132         virtual bool canRedo() const;
133
134         /**
135          * Redos the current action.
136          * This will move the action index up (if the stack depth allows it).
137          */
138         virtual void redo();
139
140 protected:
141         /**
142          * Removes <i>numActions</i> actions from the back of the stack.
143          * @param numActions    number of items to remove.
144          * @return the number of actions removed.
145          */
146         virtual unsigned int popBack(unsigned int numActions = 1);
147
148         /**
149          * Removes <i>numActions</i> actions from the front of the stack.
150          * @param numActions    number of items to remove.
151          * @return the number of actions removed.
152          */
153         virtual unsigned int popFront(unsigned int numActions = 1);
154
155         /**
156          * Returns the index of the current undo action.
157          * @param index The index of the action.
158          * @return Indication as to whether the index is valid (==true).
159          */
160         virtual bool getUndoIndex(unsigned int& index) const;
161
162         /**
163          * Returns the index of the current redo action.
164          * @param index The index of the action.
165          * @return Indication as to whether the index is valid (==true).
166          */
167         virtual bool getRedoIndex(unsigned int& index) const;
168
169         /** The maximum depth of this stack. */
170         unsigned int m_maxStackDepth;
171         /** The index of the current undo action in the stack. */
172         unsigned int m_undoIndex;
173         /** Is the index of the current undo action in the stack valid? */
174         bool m_undoIndexValid;
175         /** The index of the current redo action in the stack. */
176         unsigned int m_redoIndex;
177         /** Is the index of the current redo action in the stack valid? */
178         bool m_redoIndexValid;
179         /** The stack with actions. */
180         deque<ACT_Action*> m_stack;
181 };
182
183
184 #endif // _H_ACT_ACTIONSTACK