aboutsummaryrefslogtreecommitdiffstats
path: root/Software/Visual_Studio/Tango.Editors/UndoRedoStatesProviderBase.cs
blob: 94c6efb5a2606628cc787fc7cb65299b4eeb5208 (plain)
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
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace Tango.Editors
{
    /// <summary>
    /// Represents an undo/redo states provider base class.
    /// </summary>
    /// <seealso cref="Tango.Editors.IUndoRedoStatesProvider" />
    public abstract class UndoRedoStatesProviderBase : IUndoRedoStatesProvider
    {
        private IUndoRedoState _uncommittedState; //Holds the current undo state about to be committed.

        /// <summary>
        /// Occurs when an Undo/Redo state was executed.
        /// </summary>
        public event EventHandler<UndoRedoStateExecutedEventArgs> StateExecuted;

        /// <summary>
        /// Gets the undo states.
        /// </summary>
        public Stack<IUndoRedoState> UndoStates { get; protected set; }

        /// <summary>
        /// Gets the redo states.
        /// </summary>
        public Stack<IUndoRedoState> RedoStates { get; protected set; }

        /// <summary>
        /// Gets a value indicating whether this instance can undo.
        /// </summary>
        public bool CanUndo
        {
            get
            {
                return UndoStates.Count > 0;
            }
        }

        /// <summary>
        /// Gets a value indicating whether this instance can redo.
        /// </summary>
        public bool CanRedo
        {
            get
            {
                return RedoStates.Count > 0;
            }
        }


        /// <summary>
        /// Initializes a new instance of the <see cref="UndoRedoStatesProviderBase"/> class.
        /// </summary>
        public UndoRedoStatesProviderBase()
        {
            UndoStates = new Stack<IUndoRedoState>();
            RedoStates = new Stack<IUndoRedoState>();
        }


        /// <summary>
        /// Prepares the state of the undo.
        /// </summary>
        public virtual void PrepareUndoState()
        {
            RedoStates.Clear();
            _uncommittedState = CreateUndoRedoState();
        }

        /// <summary>
        /// Commits the state created by <see cref="PrepareUndoState" />.
        /// </summary>
        public void CommitUndoState()
        {
            if (_uncommittedState != null)
            {
                UndoStates.Push(_uncommittedState);
                _uncommittedState = null;
            }
        }

        /// <summary>
        /// Creates the a new undo/redo state.
        /// </summary>
        /// <returns></returns>
        public abstract IUndoRedoState CreateUndoRedoState();

        /// <summary>
        /// Executes the an undo/redo state.
        /// </summary>
        /// <param name="state">The state.</param>
        public abstract void ExecuteState(IUndoRedoState state);

        /// <summary>
        /// Performs an undo operation.
        /// </summary>
        public virtual void Undo()
        {
            if (UndoStates.Count > 0)
            {
                var state = UndoStates.Pop();

                var redoState = CreateUndoRedoState();

                ExecuteState(state);

                OnStateExecuted(new UndoRedoStateExecutedEventArgs() { Mode = UndoRedoStateMode.Undo, State = state });

                RedoStates.Push(redoState);
            }
        }

        /// <summary>
        /// Performs a redo operation.
        /// </summary>
        public virtual void Redo()
        {
            if (RedoStates.Count > 0)
            {
                var state = RedoStates.Pop();

                var undoState = CreateUndoRedoState();

                ExecuteState(state);

                OnStateExecuted(new UndoRedoStateExecutedEventArgs() { Mode = UndoRedoStateMode.Redo, State = state });

                UndoStates.Push(undoState);
            }
        }

        /// <summary>
        /// Raises the <see cref="E:StateExecuted" /> event.
        /// </summary>
        /// <param name="e">The <see cref="UndoRedoStateExecutedEventArgs"/> instance containing the event data.</param>
        public virtual void OnStateExecuted(UndoRedoStateExecutedEventArgs e)
        {
            if (StateExecuted != null) StateExecuted(this, e);
        }

        /// <summary>
        /// Resets undo and redo states.
        /// </summary>
        public void Reset()
        {
            UndoStates.Clear();
            RedoStates.Clear();
        }
    }
}