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