元に戻す/やり直し機能を実装する

(2016/12/03 0:23:15 created.)

それでは本格的に機能を実装していきましょう。まずは根幹となる History クラスを次のように定義します。元に戻す操作とやり直す操作は表裏一体なので、ひとつのクラスにまとめておくとわかりやすくなります。

Program.cs

```
namespace Tips_Undo
```
```
{
```
```
    using System;
```
```
 
```
```
    /// <summary>
```

    /// 特定のアクションを保持し、任意のタイミングで実行するためのクラスです。

```
    /// </summary>
```
```
    public class History
```
```
    {
```
```
        /// <summary>
```

        /// 新しいインスタンスを生成します。

```
        /// </summary>
```

        /// <param name="undoAction">アンドゥアクションを指定します。</param>

        /// <param name="undoAction">リドゥアクションを指定します。</param>

        /// <param name="name">操作名を指定します。</param>

        public History(Action undoAction, Action redoAction, string name)

```
        {
```
```
            if (undoAction == null)
```

                throw new ArgumentNullException("必ずアンドゥアクションを指定してください。");

```
            if (redoAction == null)
```

                throw new ArgumentNullException("必ずリドゥアクションを指定してください。");

            this._undoAction = undoAction;

            this._redoAction = redoAction;

```
            this.Name = name;
```
```
        }
```
```
 
```
```
        /// <summary>
```

        /// アンドゥアクションを保持します。

```
        /// </summary>
```
```
        private Action _undoAction;
```
```
 
```
```
        /// <summary>
```

        /// リドゥアクションを保持します。

```
        /// </summary>
```
```
        private Action _redoAction;
```
```
 
```
```
        /// <summary>
```

        /// 保持しているアンドゥアクションを実行します。

```
        /// </summary>
```
```
        public void UnDo()
```
```
        {
```
```
            this._undoAction();
```
```
        }
```
```
 
```
```
        /// <summary>
```

        /// 保持しているリドゥアクションを実行します。

```
        /// </summary>
```
```
        public void ReDo()
```
```
        {
```
```
            this._redoAction();
```
```
        }
```
```
 
```
```
        /// <summary>
```

        /// 操作名を取得します。

```
        /// </summary>
```

        public string Name { get; private set; }

```
 
```
```
        /// <summary>
```

        /// 自身を文字列として表現します。

```
        /// </summary>
```

        /// <returns>自身を表現する文字列を返します。</returns>

        public override string ToString()

```
        {
```
```
            return this.Name;
```
```
        }
```
```
    }
```
```
}
```

このクラスを利用して、例えば WPF アプリケーションプロジェクトの ViewModel で機能を実現する場合は次のようなコードになります。

何か操作をするときは、コードの最後にある DoAction() メソッドを使用します。このメソッドの入力引数には、元に戻すときの操作と、やり直すときの操作を Action デリゲートとして与えます。また、操作名を指定することで、操作履歴のリストに表示することができます。

HistoryViewModel.cs

```
namespace Tips_Undo.ViewModels
```
```
{
```
```
    using System;
```
```
    using System.Collections.Generic;
```
```
    using System.Linq;
```
```
    using ObjectEditorSample.Models;
```
```
    using YKToolkit.Bindings;
```
```
 
```

    public class HistoryViewModel : NotificationObject

```
    {
```

        #region シングルトンクラス

```
        /// <summary>
```

        /// インスタンスを保持します。

```
        /// </summary>
```

        private static readonly HistoryViewModel _instance;

```
 
```
```
        /// <summary>
```

        /// インスタンスを取得します。

```
        /// </summary>
```

        public static HistoryViewModel Instance { get { return _instance; } }

```
 
```
```
        /// <summary>
```

        /// 静的なコンストラクタです。

```
        /// </summary>
```
```
        static HistoryViewModel()
```
```
        {
```

            _instance = new HistoryViewModel();

```
        }
```
```
 
```
```
        /// <summary>
```

        /// private なコンストラクタを定義することで外部からインスタンスを生成されることを抑制します。

```
        /// </summary>
```
```
        private HistoryViewModel()
```
```
        {
```
```
        }
```

        #endregion シングルトンクラス

```
 
```
```
        private int _stackCapacity = 2;
```
```
        /// <summary>
```

        /// 操作履歴のバッファサイズを取得または設定します。

```
        /// </summary>
```
```
        public int StackCapacity
```
```
        {
```

            get { return this._stackCapacity; }

```
            set
```
```
            {
```

                if (SetProperty(ref this._stackCapacity, value))

```
                {
```

                    this.UndoStack = new Stack<History>(this._stackCapacity);

                    this.RedoStack = new Stack<History>(this._stackCapacity);

```
                }
```
```
            }
```
```
        }
```
```
 
```
```
        public void ClearHistory()
```
```
        {
```
```
            this.UndoStack.Clear();
```
```
            this.RedoStack.Clear();
```

            RaisePropertyChanged("UndoElements");

            RaisePropertyChanged("RedoElements");

```
        }
```
```
 
```

        private Stack<History> _undoStack;

```
        /// <summary>
```

        /// アンドゥする操作を溜めておくスタックを取得します。

```
        /// </summary>
```

        private Stack<History> UndoStack

```
        {
```

            get { return _undoStack ?? (_undoStack = new Stack<History>(this.StackCapacity)); }

            set { SetProperty(ref this._undoStack, value); }

```
        }
```
```
 
```

        private Stack<History> _redoStack;

```
        /// <summary>
```

        /// リドゥする操作を溜めておくスタックを取得します。

```
        /// </summary>
```

        private Stack<History> RedoStack

```
        {
```

            get { return _redoStack ?? (_redoStack = new Stack<History>(this.StackCapacity)); }

            set { SetProperty(ref this._redoStack, value); }

```
        }
```
```
 
```
```
        /// <summary>
```

        /// アンドゥ操作リストを取得します。

```
        /// </summary>
```

        public string[] UndoElements { get { return this.UndoStack.Select(x => x.Name).ToArray(); } }

```
 
```

        private bool _isChagnedFromUI = true;

```
 
```

        private int _selectedUndoElementIndex = -1;

        public int SelectedUndoElementIndex

```
        {
```

            get { return this._selectedUndoElementIndex; }

```
            set
```
```
            {
```

                if (SetProperty(ref this._selectedUndoElementIndex, value))

```
                {
```

                    if (this._isChagnedFromUI)

```
                    {
```

                        var undoCount = 1 + this._selectedUndoElementIndex;

```
 
```

                        for (var i = 0; i < undoCount; i++)

```
                        {
```
```
                            Undo();
```
```
                        }
```
```
 
```

                        this._isChagnedFromUI = false;

                        RaisePropertyChanged("UndoElements");

                        RaisePropertyChanged("RedoElements");

                        this._isChagnedFromUI = true;

```
 
```

                        System.Windows.Threading.Dispatcher.CurrentDispatcher.BeginInvoke(new Action(() =>

```
                        {
```

                            this.SelectedUndoElementIndex = -1;

                        }), System.Windows.Threading.DispatcherPriority.ApplicationIdle);

```
                    }
```
```
                }
```
```
            }
```
```
        }
```
```
 
```
```
        /// <summary>
```

        /// リドゥ操作リストを取得します。

```
        /// </summary>
```

        public string[] RedoElements { get { return this.RedoStack.Select(x => x.Name).ToArray(); } }

```
 
```

        private int _selectedRedoElementIndex = -1;

        public int SelectedRedoElementIndex

```
        {
```

            get { return this._selectedRedoElementIndex; }

```
            set
```
```
            {
```

                if (SetProperty(ref this._selectedRedoElementIndex, value))

```
                {
```

                    if (this._isChagnedFromUI)

```
                    {
```

                        var redoCount = 1 + this._selectedRedoElementIndex;

```
 
```

                        for (var i = 0; i < redoCount; i++)

```
                        {
```
```
                            Redo();
```
```
                        }
```
```
 
```

                        this._isChagnedFromUI = false;

                        RaisePropertyChanged("UndoElements");

                        RaisePropertyChanged("RedoElements");

                        this._isChagnedFromUI = true;

```
 
```

                        this.SelectedRedoElementIndex = -1;

```
                    }
```
```
                }
```
```
            }
```
```
        }
```
```
 
```
```
        private void Undo()
```
```
        {
```

            var action = this.UndoStack.Pop();

```
            action.UnDo();
```

            this.RedoStack.Push(action);

```
        }
```
```
 
```
```
        private void Redo()
```
```
        {
```

            var action = this.RedoStack.Pop();

```
            action.ReDo();
```

            this.UndoStack.Push(action);

```
        }
```
```
 
```

        private DelegateCommand _undoCommand;

```
        /// <summary>
```

        /// 元に戻すコマンドを取得します。

```
        /// </summary>
```

        public DelegateCommand UndoCommand

```
        {
```
```
            get
```
```
            {
```

                return _undoCommand ?? (_undoCommand = new DelegateCommand(

```
                _ =>
```
```
                {
```
```
                    Undo();
```
```
 
```

                    this._isChagnedFromUI = false;

                    RaisePropertyChanged("UndoElements");

                    RaisePropertyChanged("RedoElements");

                    this._isChagnedFromUI = true;

```
                },
```

                _ => this.UndoStack.Count > 0));

```
            }
```
```
        }
```
```
 
```

        private DelegateCommand _redoCommand;

```
        /// <summary>
```

        /// やり直しコマンドを取得します。

```
        /// </summary>
```

        public DelegateCommand RedoCommand

```
        {
```
```
            get
```
```
            {
```

                return _redoCommand ?? (_redoCommand = new DelegateCommand(

```
                _ =>
```
```
                {
```
```
                    Redo();
```
```
 
```

                    this._isChagnedFromUI = false;

                    RaisePropertyChanged("UndoElements");

                    RaisePropertyChanged("RedoElements");

                    this._isChagnedFromUI = true;

```
                },
```

                _ => this.RedoStack.Count > 0));

```
            }
```
```
        }
```
```
 
```
```
        /// <summary>
```

        /// 指定された操作をおこない、操作履歴に手順を登録します。

```
        /// </summary>
```

        /// <param name="undoAction">元に戻す操作を指定します。</param>

        /// <param name="redoAction">やり直す操作を指定します。</param>

        /// <param name="name">操作名を指定します。</param>

        public void DoAction(Action undoAction, Action redoAction, string name)

```
        {
```
```
            redoAction();
```
```
 
```

            var history = new History(undoAction, redoAction, name);

            this.UndoStack.Push(history);

```
            this.RedoStack.Clear();
```
```
 
```

            this._isChagnedFromUI = false;

            RaisePropertyChanged("UndoElements");

            RaisePropertyChanged("RedoElements");

            this._isChagnedFromUI = true;

```
        }
```
```
    }
```
```
}
```