Shos.UndoRedoList 1.0.0

There is a newer version of this package available.
See the version list below for details.
dotnet add package Shos.UndoRedoList --version 1.0.0
NuGet\Install-Package Shos.UndoRedoList -Version 1.0.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Shos.UndoRedoList" Version="1.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Shos.UndoRedoList --version 1.0.0
#r "nuget: Shos.UndoRedoList, 1.0.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Shos.UndoRedoList as a Cake Addin
#addin nuget:?package=Shos.UndoRedoList&version=1.0.0

// Install Shos.UndoRedoList as a Cake Tool
#tool nuget:?package=Shos.UndoRedoList&version=1.0.0

Shos.UndoRedoList

List and ObservableCollection which support undo/redo.

Projects

  • Shos.UndoRedoList

Types for undo/redo support.

  • Shos.UndoRedoList.Tests

Tests for Shos.UndoRedoList.

  • Shos.UndoRedoList.SampleApp

Sample WPF app for UndoRedoObservableCollection.

NuGet

You can install Shos.UndoRedoList to your project with NuGet on Visual Studio.

Types

class UndoRedoList<TElement, TList> : IList<TElement> where TList : IList<TElement>, new()

List which supports undo/redo.

class UndoRedoObservableCollection<TElement> : UndoRedoList<TElement, ObservableCollection<TElement>>, INotifyCollectionChanged

ObservableCollection which supports undo/redo.

class RingBuffer<TElement> : IEnumerable<TElement>

Circular buffer - Wikipedia

In computer science, a circular buffer, circular queue, cyclic buffer or ring buffer is a data structure that uses a single, fixed-size buffer as if it were connected end-to-end. This structure lends itself easily to buffering data streams.

class UndoRedoRingBuffer<TElement> : RingBuffer<TElement>

Specialized RingBuffer for undo/redo.

struct ModuloArithmetic : IEquatable<ModuloArithmetic>

Modular arithmetic - Wikipedia

In mathematics, modular arithmetic is a system of arithmetic for integers, where numbers "wrap around" when reaching a certain value, called the modulus.

Samples

Space

using Microsoft.VisualStudio.TestTools.UnitTesting;
using Shos.Collections;
using System.Collections.Generic;
using System.Collections.Specialized;

namespace Shos.UndoRedoList.Tests
{
    [TestClass]
    public class SampleTest
    {
        [TestMethod]
        public void UndoRedoTest()
        {
            // list which support undo/redo.
            var list = new UndoRedoList<int, List<int>>();

            Assert.IsFalse(list.CanUndo);
            Assert.IsFalse(list.CanRedo);

            // Modify list
            list.Add(100);
            Assert.AreEqual(1, list.Count);
            Assert.AreEqual(100, list[0]);
            Assert.IsTrue (list.CanUndo);
            Assert.IsFalse(list.CanRedo);

            // Undo
            Assert.IsTrue(list.Undo());

            Assert.AreEqual(0, list.Count);
            Assert.IsFalse(list.CanUndo);
            Assert.IsTrue (list.CanRedo);

            // Redo
            Assert.IsTrue(list.Redo());

            Assert.AreEqual(1, list.Count);
            Assert.AreEqual(100, list[0]);
            Assert.IsTrue (list.CanUndo);
            Assert.IsFalse(list.CanRedo);
        }

        [TestMethod]
        public void ActionScopeTest()
        {
            // list which support undo/redo.
            var list = new UndoRedoList<int, List<int>>();
            Assert.IsFalse(list.CanUndo);
            Assert.IsFalse(list.CanRedo);

            // ActionScope
            using (var scope = new UndoRedoList<int, List<int>>.ActionScope(list)) {
                // Modify list in ActionScope
                list.Add(100);
                list.Add(200);
                list.Add(300);
            }

            Assert.AreEqual(3, list.Count);
            Assert.AreEqual(100, list[0]);
            Assert.AreEqual(200, list[1]);
            Assert.AreEqual(300, list[2]);
            Assert.IsTrue(list.CanUndo);

            // Undo
            Assert.IsTrue(list.Undo());
            // 3 adding actions can undo in one time.
            Assert.AreEqual(0, list.Count);
            Assert.IsFalse(list.CanUndo);
        }

        [TestMethod]
        public void DisabledUndoScopeTest()
        {
            // list which support undo/redo.
            var list = new UndoRedoList<int, List<int>>();
            Assert.IsFalse(list.CanUndo);
            Assert.IsFalse(list.CanRedo);

            // DisabledUndoScope
            using (var scope = new UndoRedoList<int, List<int>>.DisabledUndoScope(list)) {
                // Modify list in DisabledUndoScope
                list.Add(100);
            }

            // You can't undo actions in DisabledUndoScope.
            Assert.IsFalse(list.CanUndo);
            Assert.IsFalse(list.CanRedo);
        }

        [TestMethod]
        public void UndoRedoObservableCollectionTest()
        {
            // ObservableCollection which support undo/redo.
            var observableCollection = new UndoRedoObservableCollection<int>();
            observableCollection.CollectionChanged += ObservableCollection_CollectionChanged;

            observableCollection.Add(100);

            // You can undo/redo also.
            Assert.IsTrue (observableCollection.CanUndo);
            Assert.IsFalse(observableCollection.CanRedo);

            Assert.IsTrue(observableCollection.Undo());
            Assert.IsTrue(observableCollection.Redo());

            // event handler
            static void ObservableCollection_CollectionChanged(object sender, NotifyCollectionChangedEventArgs e)
            { /* do domething */ }
        }
    }
}

See also: Shos.UndoRedoList.SampleApp

Author Info

Fujio Kojima: a software developer in Japan

License

This library is under the MIT License.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
  • .NETStandard 2.0

    • No dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.0.5 31 3/28/2024
1.0.4 40 3/26/2024
1.0.3 469 12/10/2020
1.0.2 435 12/9/2020
1.0.1 356 12/8/2020
1.0.0 395 12/8/2020