diff --git a/README.md b/README.md index 54d41b9..8170ac4 100644 --- a/README.md +++ b/README.md @@ -3,11 +3,9 @@ ObservableCollections is a high performance observable collections(`ObservableList`, `ObservableDictionary`, `ObservableHashSet`, `ObservableQueue`, `ObservableStack`, `ObservableRingBuffer`, `ObservableFixedSizeRingBuffer`) with synchronized views and Observe Extension for [R3](https://github.com/Cysharp/R3). -.NET has [`ObservableCollection`](https://docs.microsoft.com/en-us/dotnet/api/system.collections.objectmodel.observablecollection-1), however it has many lacks of features. +.NET has [`ObservableCollection`](https://docs.microsoft.com/en-us/dotnet/api/system.collections.objectmodel.observablecollection-1), however it has many lacks of features. It based `INotifyCollectionChanged`, `NotifyCollectionChangedEventHandler` and `NotifyCollectionChangedEventArgs`. There are no generics so everything boxed, allocate memory every time. Also `NotifyCollectionChangedEventArgs` holds all values to `IList` even if it is single value, this also causes allocations. `ObservableCollection` has no Range feature so a lot of wastage occurs when adding multiple values, because it is a single value notification. Also, it is not thread-safe is hard to do linkage with the notifier. -It based `INotifyCollectionChanged`, `NotifyCollectionChangedEventHandler` and `NotifyCollectionChangedEventArgs`. There are no generics so everything boxed, allocate memory every time. Also `NotifyCollectionChangedEventArgs` holds all values to `IList` even if it is single value, this also causes allocations. `ObservableCollection` has no Range feature so a lot of wastage occurs when adding multiple values, because it is a single value notification. Also, it is not thread-safe is hard to do linkage with the notifier. - -ObservableCollections introduces generics version of `NotifyCollectionChangedEventHandler` and `NotifyCollectionChangedEventArgs`, it using latest C# features(`in`, `readonly ref struct`, `ReadOnlySpan`). +ObservableCollections introduces there generics version, `NotifyCollectionChangedEventHandler` and `NotifyCollectionChangedEventArgs`, it using latest C# features(`in`, `readonly ref struct`, `ReadOnlySpan`). Also, Sort and Reverse will now be notified. ```csharp public delegate void NotifyCollectionChangedEventHandler(in NotifyCollectionChangedEventArgs e); @@ -22,6 +20,7 @@ public readonly ref struct NotifyCollectionChangedEventArgs public readonly ReadOnlySpan OldItems; public readonly int NewStartingIndex; public readonly int OldStartingIndex; + public readonly SortOperation SortOperation; } ``` @@ -30,20 +29,22 @@ Also, use the interface `IObservableCollection` instead of `INotifyCollection ```csharp public interface IObservableCollection : IReadOnlyCollection { - event NotifyCollectionChangedEventHandler CollectionChanged; + event NotifyCollectionChangedEventHandler? CollectionChanged; object SyncRoot { get; } - ISynchronizedView CreateView(Func transform, bool reverse = false); + ISynchronizedView CreateView(Func transform); } - -// also exists SortedView -public static ISynchronizedView CreateSortedView(this IObservableCollection source, Func identitySelector, Func transform, IComparer comparer); -public static ISynchronizedView CreateSortedView(this IObservableCollection source, Func identitySelector, Func transform, IComparer viewComparer); ``` SynchronizedView helps to separate between Model and View (ViewModel). We will use ObservableCollections as the Model and generate SynchronizedView as the View (ViewModel). This architecture can be applied not only to WPF, but also to Blazor, Unity, etc. ![image](https://user-images.githubusercontent.com/46207/131979264-2463403b-0fba-474b-8f49-277c2abe1b05.png) +The View retains the transformed values. The transform function is called only once during Add, so costly objects that are linked can also be instantiated. Additionally, it has a feature to dynamically show or hide values using filters. + +Observable Collections themselves do not implement `INotifyCollectionChanged`, so they cannot be bound on XAML platforms and the like. However, they can be converted to collections that implement `INotifyCollectionChanged` using `ToNotifyCollectionChanged()`, making them suitable for binding. + +![image](https://github.com/user-attachments/assets/b5590bb8-16d6-4f9c-be07-1288a6801e68) + ObservableCollections has not just a simple list, there are many more data structures. `ObservableList`, `ObservableDictionary`, `ObservableHashSet`, `ObservableQueue`, `ObservableStack`, `ObservableRingBuffer`, `ObservableFixedSizeRingBuffer`. `RingBuffer`, especially `FixedSizeRingBuffer`, can be achieved with efficient performance when there is rotation (e.g., displaying up to 1000 logs, where old ones are deleted when new ones are added). Of course, the AddRange allows for efficient batch processing of large numbers of additions. If you want to handle each change event with Rx, you can monitor it with the following method by combining it with [R3](https://github.com/Cysharp/R3): @@ -54,13 +55,18 @@ Observable> IObservableCollection.ObserveRemove() Observable> IObservableCollection.ObserveReplace() Observable> IObservableCollection.ObserveMove() Observable> IObservableCollection.ObserveReset() +Observable> IObservableCollection.ObserveReset() +Observable IObservableCollection.ObserveClear() +Observable<(int Index, int Count)> IObservableCollection.ObserveReverse() +Observable<(int Index, int Count, IComparer Comparer)> IObservableCollection.ObserveSort() +Observable IObservableCollection.ObserveCountChanged() ``` Getting Started --- For .NET, use NuGet. For Unity, please read [Unity](#unity) section. -PM> Install-Package [ObservableCollections](https://www.nuget.org/packages/ObservableCollections) +> dotnet add package [ObservableCollections](https://www.nuget.org/packages/ObservableCollections) create new `ObservableList`, `ObservableDictionary`, `ObservableHashSet`, `ObservableQueue`, `ObservableStack`, `ObservableRingBuffer`, `ObservableFixedSizeRingBuffer`. @@ -98,7 +104,7 @@ static void List_CollectionChanged(in NotifyCollectionChangedEventArgs e) } ``` -Handling all `CollectionChanged` event manually is hard. We recommend to use `SynchronizedView` that transform element and handling all collection changed event for view synchronize. +While it is possible to manually handle the `CollectionChanged` event as shown in the example above, you can also create a `SynchronizedView` as a collection that holds a separate synchronized value. ```csharp var list = new ObservableList(); @@ -110,7 +116,7 @@ list.AddRange(new[] { 30, 40, 50 }); list[1] = 60; list.RemoveAt(3); -foreach (var (_, v) in view) +foreach (var v in view) { // 10$, 60$, 30$, 50$ Console.WriteLine(v); @@ -120,13 +126,120 @@ foreach (var (_, v) in view) view.Dispose(); ``` -The basic idea behind using ObservableCollections is to create a View. In order to automate this pipeline, the view can be sortable, filtered, and have side effects on the values when they are changed. +The view can modify the objects being enumerated by attaching a Filter. + +```csharp +var list = new ObservableList(); +using var view = list.CreateView(x => x.ToString() + "$"); + +list.Add(1); +list.Add(20); +list.AddRange(new[] { 30, 31, 32 }); + +// attach filter +view.AttachFilter(x => x % 2 == 0); + +foreach (var v in view) +{ + // 20$, 30$, 32$ + Console.WriteLine(v); +} + +// attach other filter(removed previous filter) +view.AttachFilter(x => x % 2 == 1); + +foreach (var v in view) +{ + // 1$, 31$ + Console.WriteLine(v); +} + +// Count shows filtered length +Console.WriteLine(view.Count); // 2 +``` + +The View only allows iteration and Count; it cannot be accessed via an indexer. If indexer access is required, you need to convert it using `ToViewList()`. Additionally, `ToNotifyCollectionChanged()` converts it to a synchronized view that implements `INotifyCollectionChanged`, which is necessary for XAML binding, in addition to providing indexer access. + +```csharp +// Queue <-> List Synchronization +var queue = new ObservableQueue(); + +queue.Enqueue(1); +queue.Enqueue(10); +queue.Enqueue(100); +queue.Enqueue(1000); +queue.Enqueue(10000); + +using var view = queue.CreateView(x => x.ToString() + "$"); + +using var viewList = view.ToViewList(); + +Console.WriteLine(viewList[2]); // 100$ +``` + +In the case of ObservableList, calls to `Sort` and `Reverse` can also be synchronized with the view. + +```csharp +var list = new ObservableList { 1, 301, 20, 50001, 4000 }; +using var view = list.CreateView(x => x.ToString() + "$"); + +view.AttachFilter(x => x % 2 == 0); + +foreach (var v in view) +{ + // 20$, 4000$ + Console.WriteLine(v); +} + +// Reverse operations on the list will affect the view +list.Reverse(); + +foreach (var v in view) +{ + // 4000$, 20$ + Console.WriteLine(v); +} + +// remove filter +view.ResetFilter(); + +// The reverse operation is also reflected in the values hidden by the filter +foreach (var v in view) +{ + // 4000$, 50001$, 20$, 301$, 1$ + Console.WriteLine(v); +} + +// also affect Sort Operations +list.Sort(); +foreach (var v in view) +{ + // 1$, 20$, 301$, 4000$, 50001$ + Console.WriteLine(v); +} + +// you can use custom comparer +list.Sort(new DescendantComaprer()); +foreach (var v in view) +{ + // 50001$, 4000$, 301$, 20$, 1$ + Console.WriteLine(v); +} + +class DescendantComaprer : IComparer +{ + public int Compare(int x, int y) + { + return y.CompareTo(x); + } +} +``` Reactive Extensions with R3 --- -Once the R3 extension package is installed, you can subscribe to `ObserveAdd`, `ObserveRemove`, `ObserveReplace`, `ObserveMove`, and `ObserveReset` events as Rx, allowing you to compose events individually. +Once the R3 extension package is installed, you can subscribe to `ObserveAdd`, `ObserveRemove`, `ObserveReplace`, `ObserveMove`, `ObserveReset`, `ObserveClear`, `ObserveReverse`, `ObserveSort` events as Rx, allowing you to compose events individually. -PM> Install-Package [ObservableCollections.R3](https://www.nuget.org/packages/ObservableCollections.R3) +> dotnet add package [ObservableCollections.R3](https://www.nuget.org/packages/ObservableCollections.R3) ```csharp using R3; @@ -144,69 +257,59 @@ list.Add(20); list.AddRange(new[] { 10, 20, 30 }); ``` +Note that `ObserveReset` is used to subscribe to Clear, Reverse, and Sort operations in bulk. + Since it is not supported by dotnet/reactive, please use the Rx library [R3](https://github.com/Cysharp/R3). Blazor --- -Since Blazor re-renders the whole thing by StateHasChanged, you may think that Observable collections are unnecessary. However, when you split it into Components, it is beneficial for Component confidence to detect the change and change its own State. - -The View selector in ObservableCollections is also useful for converting data to a View that represents a Cell, for example, when creating something like a table. +In the case of Blazor, `StateHasChanged` is called and re-enumeration occurs in response to changes in the collection. It's advisable to use the `CollectionStateChanged` event for this purpose. ```csharp -public partial class DataTable : ComponentBase, IDisposable +public partial class Index : IDisposable { - [Parameter, EditorRequired] - public IReadOnlyList Items { get; set; } = default!; - - [Parameter, EditorRequired] - public Func DataTemplate { get; set; } = default!; - - ISynchronizedView view = default!; + ObservableList list; + public ISynchronizedView ItemsView { get; set; } + int count = 0; protected override void OnInitialized() { - if (Items is IObservableCollection observableCollection) - { - // Note: If the table has the ability to sort columns, then it will be automatically sorted using SortedView. - view = observableCollection.CreateView(DataTemplate); - } - else - { - // It is often the case that Items is not Observable. - // In that case, FreezedList is provided to create a View with the same API for normal collections. - var freezedList = new FreezedList(Items); - view = freezedList.CreateView(DataTemplate); - } + list = new ObservableList(); + ItemsView = list.CreateView(x => x); - // View also has a change notification. - view.CollectionStateChanged += async _ => + ItemsView.CollectionStateChanged += action => { - await InvokeAsync(StateHasChanged); + InvokeAsync(StateHasChanged); }; } - + + void OnClick() + { + list.Add(count++); + } + public void Dispose() { - // unsubscribe. - view.Dispose(); + ItemsView.Dispose(); } } // .razor, iterate view -@foreach (var (row, cells) in view) -{ - - @foreach (var item in cells) - { - - - - } - -} +@page "/" + + + + + @foreach (var item in ItemsView) + { + + + + } +
@item
``` -WPF(XAML based UI platforms) +WPF/Avalonia/WinUI (XAML based UI platforms) --- Because of data binding in WPF, it is important that the collection is Observable. ObservableCollections high-performance `IObservableCollection` cannot be bind to WPF. Call `ToNotifyCollectionChanged()` to convert it to `INotifyCollectionChanged`. Also, although ObservableCollections and Views are thread-safe, the WPF UI does not support change notifications from different threads. To`ToNotifyCollectionChanged(IColllectionEventDispatcher)` allows multi thread changed. @@ -214,7 +317,7 @@ Because of data binding in WPF, it is important that the collection is Observabl // WPF simple sample. ObservableList list; -public INotifyCollectionChangedSynchronizedView ItemsView { get; set; } +public INotifyCollectionChangedSynchronizedViewList ItemsView { get; set; } public MainWindow() { @@ -224,10 +327,10 @@ public MainWindow() list = new ObservableList(); // for ui synchronization safety of viewmodel - ItemsView = list.CreateView(x => x).ToNotifyCollectionChanged(SynchronizationContextCollectionEventDispatcher.Current); + ItemsView = list.ToNotifyCollectionChanged(SynchronizationContextCollectionEventDispatcher.Current); // if collection is changed only from ui-thread, can use this overload - // ItemsView = list.CreateView(x => x).ToNotifyCollectionChanged(); + // ItemsView = list.ToNotifyCollectionChanged(); } protected override void OnClosed(EventArgs e) @@ -236,8 +339,6 @@ protected override void OnClosed(EventArgs e) } ``` -> WPF can not use SortedView because SortedView can not provide sort event to INotifyCollectionChanged. - `SynchronizationContextCollectionEventDispatcher.Current` is default implementation of `IColllectionEventDispatcher`, it is used `SynchronizationContext.Current` for dispatche ui thread. You can create custom `ICollectionEventDispatcher` to use custom dispatcher object. For example use WPF Dispatcher: ```csharp @@ -258,12 +359,9 @@ Unity --- In Unity projects, you can installing `ObservableCollections` with [NugetForUnity](https://github.com/GlitchEnzo/NuGetForUnity). If R3 integration is required, similarly install `ObservableCollections.R3` via NuGetForUnity. -In Unity, ObservableCollections and Views are useful as CollectionManagers, since they need to convert T to Prefab for display. - -Since we need to have side effects on GameObjects, we will prepare a filter and apply an action on changes. +In Unity, ObservableCollections and Views are useful as CollectionManagers, since they need to convert T to Prefab for display. Since View objects are generated only once, it's possible to complement GameObjects tied to the collection. ```csharp -// Unity, with filter sample. public class SampleScript : MonoBehaviour { public Button prefab; @@ -280,186 +378,187 @@ public class SampleScript : MonoBehaviour item.GetComponentInChildren().text = x.ToString(); return item.gameObject; }); - view.AttachFilter(new GameObjectFilter(root)); + view.ViewChanged += View_ViewChanged; + } + + void View_ViewChanged(in SynchronizedViewChangedEventArgs eventArgs) + { + if (eventArgs.Action == NotifyCollectionChangedAction.Add) + { + eventArgs.NewItem.View.transform.SetParent(root.transform); + } + else if (NotifyCollectionChangedAction.Remove) + { + GameObject.Destroy(eventArgs.OldItem.View); + } } void OnDestroy() { view.Dispose(); } +} +``` - public class GameObjectFilter : ISynchronizedViewFilter +Reference +--- +ObservableCollections provides these collections. + +```csharp +class ObservableList : IList, IReadOnlyList, IObservableCollection, IReadOnlyObservableList +class ObservableDictionary : IDictionary, IReadOnlyDictionary, IObservableCollection> where TKey : notnull +class ObservableHashSet : IReadOnlySet, IReadOnlyCollection, IObservableCollection where T : notnull +class ObservableQueue : IReadOnlyCollection, IObservableCollection +class ObservableStack : IReadOnlyCollection, IObservableCollection +class ObservableRingBuffer : IList, IReadOnlyList, IObservableCollection +class RingBuffer : IList, IReadOnlyList +class ObservableFixedSizeRingBuffer : IList, IReadOnlyList, IObservableCollection +class AlternateIndexList : IEnumerable +``` + +The `IObservableCollection` is the base interface for all, containing the `CollectionChanged` event and the `CreateView` method. + +```csharp +public delegate void NotifyCollectionChangedEventHandler(in NotifyCollectionChangedEventArgs e); + +public interface IObservableCollection : IReadOnlyCollection +{ + object SyncRoot { get; } + event NotifyCollectionChangedEventHandler? CollectionChanged; + ISynchronizedView CreateView(Func transform); +} +``` + +The notification event `NotifyCollectionChangedEventArgs` has the following definition: + +```csharp +/// +/// Contract: +/// IsSingleItem ? (NewItem, OldItem) : (NewItems, OldItems) +/// Action.Add +/// NewItem, NewItems, NewStartingIndex +/// Action.Remove +/// OldItem, OldItems, OldStartingIndex +/// Action.Replace +/// NewItem, NewItems, OldItem, OldItems, (NewStartingIndex, OldStartingIndex = samevalue) +/// Action.Move +/// NewStartingIndex, OldStartingIndex +/// Action.Reset +/// SortOperation(IsClear, IsReverse, IsSort) +/// +[StructLayout(LayoutKind.Auto)] +public readonly ref struct NotifyCollectionChangedEventArgs +{ + public readonly NotifyCollectionChangedAction Action; + public readonly bool IsSingleItem; + public readonly T NewItem; + public readonly T OldItem; + public readonly ReadOnlySpan NewItems; + public readonly ReadOnlySpan OldItems; + public readonly int NewStartingIndex; + public readonly int OldStartingIndex; + public readonly SortOperation SortOperation; +} +``` + +This is the interface for View: + +```csharp +public delegate void NotifyViewChangedEventHandler(in SynchronizedViewChangedEventArgs e); + +public interface ISynchronizedView : IReadOnlyCollection, IDisposable +{ + object SyncRoot { get; } + ISynchronizedViewFilter Filter { get; } + IEnumerable<(T Value, TView View)> Filtered { get; } + IEnumerable<(T Value, TView View)> Unfiltered { get; } + int UnfilteredCount { get; } + + event NotifyViewChangedEventHandler? ViewChanged; + event Action? CollectionStateChanged; + + void AttachFilter(ISynchronizedViewFilter filter); + void ResetFilter(); + ISynchronizedViewList ToViewList(); + INotifyCollectionChangedSynchronizedViewList ToNotifyCollectionChanged(); + INotifyCollectionChangedSynchronizedViewList ToNotifyCollectionChanged(ICollectionEventDispatcher? collectionEventDispatcher); +} +``` + +The `Count` of the View returns the filtered value, but if you need the unfiltered value, use `UnfilteredCount`. Also, normal enumeration returns only `TView`, but if you need `T` or want to enumerate pre-filtered values, you can get them with `Filtered` and `Unfiltered`. + +The View's notification event `SynchronizedViewChangedEventArgs` has the following definition: + +```csharp +public readonly ref struct SynchronizedViewChangedEventArgs +{ + public readonly NotifyCollectionChangedAction Action; + public readonly bool IsSingleItem; + public readonly (T Value, TView View) NewItem; + public readonly (T Value, TView View) OldItem; + public readonly ReadOnlySpan NewValues; + public readonly ReadOnlySpan NewViews; + public readonly ReadOnlySpan OldValues; + public readonly ReadOnlySpan OldViews; + public readonly int NewStartingIndex; + public readonly int OldStartingIndex; + public readonly SortOperation SortOperation; +} +``` + +When `NotifyCollectionChangedAction` is `Reset`, additional determination can be made with `SortOperation`. + +```csharp +public readonly struct SortOperation +{ + public readonly int Index; + public readonly int Count; + public readonly IComparer? Comparer; + + public bool IsReverse { get; } + public bool IsClear { get; } + public bool IsSort { get; } +} +``` + +When `IsReverse` is true, you need to use `Index` and `Count`. When `IsSort` is true, you need to use `Index`, `Count`, and `Comparer` values. + +For Filter, you can either create one that implements this interface or generate one from a lambda expression using extension methods. + +```csharp +public interface ISynchronizedViewFilter +{ + bool IsMatch(T value); +} + +public static class SynchronizedViewExtensions +{ + public static void AttachFilter(this ISynchronizedView source, Func filter) { - readonly GameObject root; - - public GameObjectFilter(GameObject root) - { - this.root = root; - } - - public void OnCollectionChanged(in SynchronizedViewChangedEventArgs eventArgs) - { - if (eventArgs.Action == NotifyCollectionChangedAction.Add) - { - eventArgs.NewView.transform.SetParent(root.transform); - } - else if (NotifyCollectionChangedAction.Remove) - { - GameObject.Destroy(eventArgs.OldView); - } - } - - public bool IsMatch(int value, GameObject view) - { - return true; - } - - public void WhenTrue(int value, GameObject view) - { - view.SetActive(true); - } - - public void WhenFalse(int value, GameObject view) - { - view.SetActive(false); - } } } ``` -It is also possible to manage Order by managing indexes inserted from eventArgs, but it is very difficult with many caveats. If you don't have major performance issues, you can foreach the View itself on CollectionStateChanged (like Blazor) and reorder the transforms. If you have such a architecture, you can also use SortedView. - -View/SortedView ---- -View can create from `IObservableCollection`, it completely synchronized and thread-safe. +Here are definitions for other collections: ```csharp -public interface IObservableCollection : IReadOnlyCollection +public interface IReadOnlyObservableList : + IReadOnlyList, IObservableCollection { - // snip... - ISynchronizedView CreateView(Func transform, bool reverse = false); -} -``` - -When reverse = true, foreach view as reverse order(Dictionary, etc. are not supported). - -`ISynchronizedView` is `IReadOnlyCollection` and hold both value and view(transformed value when added). - -```csharp -public interface ISynchronizedView : IReadOnlyCollection<(T Value, TView View)>, IDisposable -{ - object SyncRoot { get; } - - event NotifyCollectionChangedEventHandler? RoutingCollectionChanged; - event Action? CollectionStateChanged; - - void AttachFilter(ISynchronizedViewFilter filter); - void ResetFilter(Action? resetAction); - INotifyCollectionChangedSynchronizedView ToNotifyCollectionChanged(); -} -``` - - - -see [filter](#filter) section. - - - -```csharp -var view = transform(value); -if (filter.IsMatch(value, view)) -{ - filter.WhenTrue(value, view); -} -else -{ - filter.WhenFalse(value, view); -} -AddToCollectionInnerStructure(value, view); -filter.OnCollectionChanged(ChangeKind.Add, value, view, eventArgs); -RoutingCollectionChanged(eventArgs); -CollectionStateChanged(); -``` - - -```csharp -public static ISynchronizedView CreateSortedView(this IObservableCollection source, Func identitySelector, Func transform, IComparer comparer) - where TKey : notnull - -public static ISynchronizedView CreateSortedView(this IObservableCollection source, Func identitySelector, Func transform, IComparer viewComparer) - where TKey : notnull - -public static ISynchronizedView CreateSortedView(this IObservableCollection source, Func identitySelector, Func transform, Func compareSelector, bool ascending = true) - where TKey : notnull -``` - -> Notice: foreach ObservableCollections and Views are thread-safe but it uses lock at iterating. In other words, the obtained Enumerator must be Dispose. foreach and LINQ are guaranteed to be Dispose, but be careful when you extract the Enumerator by yourself. - -Filter ---- - -```csharp -public interface ISynchronizedViewFilter -{ - bool IsMatch(T value, TView view); - void WhenTrue(T value, TView view); - void WhenFalse(T value, TView view); - void OnCollectionChanged(in SynchronizedViewChangedEventArgs eventArgs); } -public readonly struct SynchronizedViewChangedEventArgs +public interface IReadOnlyObservableDictionary : + IReadOnlyDictionary, IObservableCollection> { - public readonly NotifyCollectionChangedAction Action = action; - public readonly T NewValue = newValue; - public readonly T OldValue = oldValue; - public readonly TView NewView = newView; - public readonly TView OldView = oldView; - public readonly int NewViewIndex = newViewIndex; - public readonly int OldViewIndex = oldViewIndex; -} -``` - - -Collections ---- - -```csharp -public sealed partial class ObservableDictionary : IDictionary, IReadOnlyDictionary, IObservableCollection> where TKey : notnull -public sealed partial class ObservableFixedSizeRingBuffer : IList, IReadOnlyList, IObservableCollection -public sealed partial class ObservableHashSet : IReadOnlySet, IReadOnlyCollection, IObservableCollection where T : notnull - -public sealed partial class ObservableHashSet : IReadOnlySet, IReadOnlyCollection, IObservableCollection - where T : notnull - -public sealed partial class ObservableList : IList, IReadOnlyList, IObservableCollection - -public sealed partial class ObservableQueue : IReadOnlyCollection, IObservableCollection -public sealed partial class ObservableRingBuffer : IList, IReadOnlyList, IObservableCollection - -public sealed partial class ObservableStack : IReadOnlyCollection, IObservableCollection - -public sealed class RingBuffer : IList, IReadOnlyList -``` - -Freezed ---- - - -```csharp -public sealed class FreezedList : IReadOnlyList, IFreezedCollection -public sealed class FreezedDictionary : IReadOnlyDictionary, IFreezedCollection> where TKey : notnull - - -public interface IFreezedCollection -{ - ISynchronizedView CreateView(Func transform, bool reverse = false); - ISortableSynchronizedView CreateSortableView(Func transform); } -public static ISortableSynchronizedView CreateSortableView(this IFreezedCollection source, Func transform, IComparer initialSort) -public static ISortableSynchronizedView CreateSortableView(this IFreezedCollection source, Func transform, IComparer initialViewSort) -public static ISortableSynchronizedView CreateSortableView(this IFreezedCollection source, Func transform, Func initialCompareSelector, bool ascending = true) -public static void Sort(this ISortableSynchronizedView source, Func compareSelector, bool ascending = true) +public interface ISynchronizedViewList : IReadOnlyList, IDisposable +{ +} + +public interface INotifyCollectionChangedSynchronizedViewList : ISynchronizedViewList, INotifyCollectionChanged, INotifyPropertyChanged +{ +} ``` License diff --git a/docs/assets.pptx b/docs/assets.pptx index bc1016c..1a61a63 100644 Binary files a/docs/assets.pptx and b/docs/assets.pptx differ diff --git a/sandbox/AvaloniaApp/MainWindow.axaml.cs b/sandbox/AvaloniaApp/MainWindow.axaml.cs index 50984cb..b6c6dc6 100644 --- a/sandbox/AvaloniaApp/MainWindow.axaml.cs +++ b/sandbox/AvaloniaApp/MainWindow.axaml.cs @@ -24,7 +24,7 @@ namespace AvaloniaApp public class ViewModel { private ObservableList observableList { get; } = new ObservableList(); - public INotifyCollectionChangedSynchronizedView ItemsView { get; } + public INotifyCollectionChangedSynchronizedViewList ItemsView { get; } public ReactiveCommand AddCommand { get; } = new ReactiveCommand(); public ReactiveCommand ClearCommand { get; } = new ReactiveCommand(); diff --git a/sandbox/BlazorApp/Pages/Index.razor.cs b/sandbox/BlazorApp/Pages/Index.razor.cs index d79fbb5..29188e2 100644 --- a/sandbox/BlazorApp/Pages/Index.razor.cs +++ b/sandbox/BlazorApp/Pages/Index.razor.cs @@ -7,7 +7,7 @@ public partial class Index : IDisposable { ObservableList list; public ISynchronizedView ItemsView { get; set; } - int adder = 99; + int count = 99; protected override void OnInitialized() { @@ -20,19 +20,13 @@ public partial class Index : IDisposable }; } + void OnClick() + { + list.Add(count++); + } + public void Dispose() { ItemsView.Dispose(); } - - - - - void OnClick() - { - ThreadPool.QueueUserWorkItem(_ => - { - list.Add(adder++); - }); - } } diff --git a/sandbox/ConsoleApp/Program.cs b/sandbox/ConsoleApp/Program.cs index 758e3d5..f547f51 100644 --- a/sandbox/ConsoleApp/Program.cs +++ b/sandbox/ConsoleApp/Program.cs @@ -3,43 +3,38 @@ using System.Collections.Specialized; using R3; using System.Linq; using ObservableCollections; +using System.Collections; +using System.Collections.Generic; -var list = new ObservableList(); -list.ObserveAdd() - .Subscribe(x => +// Queue <-> List Synchronization +var queue = new ObservableQueue(); + +queue.Enqueue(1); +queue.Enqueue(10); +queue.Enqueue(100); +queue.Enqueue(1000); +queue.Enqueue(10000); + +using var view = queue.CreateView(x => x.ToString() + "$"); + +using var viewList = view.ToViewList(); + +Console.WriteLine(viewList[2]); // 100$ + + +view.ViewChanged += View_ViewChanged; + +void View_ViewChanged(in SynchronizedViewChangedEventArgs eventArgs) +{ + if (eventArgs.Action == NotifyCollectionChangedAction.Add) { - Console.WriteLine(x); - }); + // eventArgs.OldItem.View. + } -list.Add(10); -list.Add(20); -list.AddRange(new[] { 10, 20, 30 }); - - - - - - - - -var models = new ObservableList(Enumerable.Range(0, 10)); - -var viewModels = models.CreateView(x => new ViewModel -{ - Id = x, - Value = "@" + x -}); - -viewModels.AttachFilter(new HogeFilter(), true); - -models.Add(100); - -foreach (var (x, xs) in viewModels) -{ - System.Console.WriteLine(xs.Value); + throw new NotImplementedException(); } class ViewModel @@ -48,38 +43,28 @@ class ViewModel public string Value { get; set; } = default!; } -class HogeFilter : ISynchronizedViewFilter +class HogeFilter : ISynchronizedViewFilter { - public bool IsMatch(int value, ViewModel view) + public bool IsMatch(int value) { return value % 2 == 0; } - public void WhenTrue(int value, ViewModel view) - { - view.Value = $"@{value} (even)"; - } - - public void WhenFalse(int value, ViewModel view) - { - view.Value = $"@{value} (odd)"; - } - public void OnCollectionChanged(in SynchronizedViewChangedEventArgs eventArgs) { switch (eventArgs.Action) { case NotifyCollectionChangedAction.Add: - eventArgs.NewView.Value += " Add"; + eventArgs.NewItem.View.Value += " Add"; break; case NotifyCollectionChangedAction.Remove: - eventArgs.OldView.Value += " Remove"; + eventArgs.OldItem.View.Value += " Remove"; break; case NotifyCollectionChangedAction.Move: - eventArgs.NewView.Value += $" Move {eventArgs.OldViewIndex} {eventArgs.NewViewIndex}"; + eventArgs.NewItem.View.Value += $" Move {eventArgs.OldStartingIndex} {eventArgs.NewStartingIndex}"; break; case NotifyCollectionChangedAction.Replace: - eventArgs.NewView.Value += $" Replace {eventArgs.NewViewIndex}"; + eventArgs.NewItem.View.Value += $" Replace {eventArgs.NewStartingIndex}"; break; case NotifyCollectionChangedAction.Reset: break; diff --git a/sandbox/WpfApp/MainWindow.xaml b/sandbox/WpfApp/MainWindow.xaml index 67a7270..e5b8ead 100644 --- a/sandbox/WpfApp/MainWindow.xaml +++ b/sandbox/WpfApp/MainWindow.xaml @@ -20,6 +20,12 @@