Merge pull request #310 from w-ahmad/feat/enumerable_source

w-ahmad · web-flow · commit ec86ec4fe451 · 2026-02-10T20:58:21.000+05:00
feat: Add support IEnumerable data sources
diff --git a/.github/workflows/ci-build.yml b/.github/workflows/ci-build.yml
@@ -36,7 +36,7 @@ jobs:
                 /p:Version=0.0.${{ github.run_number }}-dev
 
     - name: Setup VSTest
-      uses: darenm/Setup-VSTest@v1
+      uses: darenm/Setup-VSTest@v1.3
 
     - name: Build Tests
       run: |
diff --git a/src/ColumnFilterHandler.cs b/src/ColumnFilterHandler.cs
@@ -1,4 +1,5 @@
 ﻿using System;
+using System.Collections;
 using System.Collections.Generic;
 using System.Diagnostics.CodeAnalysis;
 using System.Linq;
@@ -40,7 +41,7 @@ public virtual IList<TableViewFilterItem> GetFilterItems(TableViewColumn column,
                     }));
             }
 
-            collectionView.Source = column.TableView.ItemsSource;
+            collectionView.Source = (column.TableView.ItemsSource as IEnumerable) ?? Enumerable.Empty<object>();
 
             var items = _tableView.ShowFilterItemsCount ?
                         GetFilterItemsWithCount(column, searchText, collectionView) :
diff --git a/src/Extensions/CollectionExtensions.cs b/src/Extensions/CollectionExtensions.cs
@@ -1,4 +1,6 @@
-﻿using System;
+﻿using Microsoft.UI.Xaml.Data;
+using System;
+using System.Collections;
 using System.Collections.Generic;
 using System.Linq;
 
@@ -38,4 +40,83 @@ public static void RemoveWhere<T>(this ICollection<T> collection, Predicate<T> p
             collection.Remove(item);
         }
     }
+
+    /// <summary>
+    /// Gets the index of the first occurrence of an item in the enumerable.
+    /// </summary>
+    /// <param name="enumerable">The enumerable to search.</param>
+    /// <param name="item">The item to find.</param>
+    /// <returns>The index of the item, or -1 if not found.</returns>
+    public static int IndexOf(this IEnumerable enumerable, object? item)
+    {
+        if (enumerable is IList list)
+            return list.IndexOf(item);
+
+        if (enumerable is ICollectionView collectionView)
+            return collectionView.IndexOf(item);
+
+
+        var index = 0;
+        foreach (var element in enumerable)
+        {
+            if (Equals(element, item))
+                return index;
+
+            index++;
+        }
+
+        return -1;
+    }
+
+    /// <summary>
+    /// Gets a value indicating whether the enumerable is read-only.
+    /// </summary>
+    /// <param name="enumerable">The enumerable to check.</param>
+    /// <returns></returns>
+    public static bool IsReadOnly(this IEnumerable enumerable)
+    {
+        if (enumerable is IList list)
+            return list.IsReadOnly;
+
+        if (enumerable is ICollectionView collectionView)
+            return collectionView.IsReadOnly;
+
+        return true;
+    }
+
+    public static void Add(this IEnumerable enumerable, object? item)
+    {
+        if (enumerable is IList list)
+            list.Add(item);
+
+        if (enumerable is ICollectionView collectionView)
+            collectionView.Add(item);
+    }
+
+    public static void Insert(this IEnumerable enumerable, int index, object? item)
+    {
+        if (enumerable is IList list)
+            list.Insert(index, item);
+
+        if (enumerable is ICollectionView collectionView)
+            collectionView.Insert(index, item);
+    }
+
+    public static void Remove(this IEnumerable enumerable, object? item)
+    {
+        if (enumerable is IList list)
+            list.Remove(item);
+
+        if (enumerable is ICollectionView collectionView)
+            collectionView.Remove(item);
+    }
+
+    public static void Clear(this IEnumerable enumerable)
+    {
+        if (enumerable is IList list)
+            list.Clear();
+
+        if (enumerable is ICollectionView collectionView)
+            collectionView.Clear();
+    }
 }
diff --git a/src/Extensions/ObjectExtensions.cs b/src/Extensions/ObjectExtensions.cs
@@ -400,6 +400,7 @@ private static bool TryCreateGenericIndexerExpression(Type type, ParameterExpres
         var listType = list.GetType();
         Type? itemType = null;
         var isICustomTypeProvider = false;
+        var isWinRTObject = false;
 
         // If it's a generic enumerable, get the generic type.
 
@@ -410,11 +411,14 @@ private static bool TryCreateGenericIndexerExpression(Type type, ParameterExpres
         if (itemType != null)
         {
             isICustomTypeProvider = typeof(ICustomTypeProvider).IsAssignableFrom(itemType);
+#if WINDOWS
+            isWinRTObject = typeof(WinRT.IInspectable).IsAssignableFrom(itemType);
+#endif
         }
 
         // Bare IEnumerables mean that result type will be object.  In that case, try to get something more interesting.
         // Or, if the itemType implements ICustomTypeProvider, try to retrieve the custom type from one of the object instances.
-        if (itemType == null || itemType == typeof(object) || isICustomTypeProvider)
+        if (itemType == null || itemType == typeof(object) || isICustomTypeProvider || isWinRTObject)
         {
             // No type was located yet. Does the list have anything in it?
             Type? firstItemType = null;
diff --git a/src/ItemsSource/CollectionView.Properties.cs b/src/ItemsSource/CollectionView.Properties.cs
@@ -1,8 +1,8 @@
 ﻿using Microsoft.UI.Xaml.Data;
 using System.Collections;
 using System.Collections.Generic;
-using System.Collections.Specialized;
 using Windows.Foundation.Collections;
+using WinUI.TableView.Extensions;
 
 namespace WinUI.TableView;
 
@@ -11,24 +11,22 @@ partial class CollectionView
     /// <summary>
     /// Gets or sets the source collection.
     /// </summary>
-    public IList Source
+    public IEnumerable Source
     {
         get => _source;
         set
         {
             if (_source == value) return;
 
-            if (_source is not null) DetachPropertyChangedHandlers(_source);
+            DetachCollectionChangedHandlers(_source);
+            DetachPropertyChangedHandlers(_source);
 
             _source = value;
-            AttachPropertyChangedHandlers(_source);
 
-            _collectionChangedListener?.Detach();
+            AttachCollectionChangedHandlers(_source);
+            AttachPropertyChangedHandlers(_source);
 
-            if (_source is INotifyCollectionChanged sourceNcc)
-            {
-                _collectionChangedListener = new(this, sourceNcc, OnSourceCollectionChanged);
-            }
+            CreateItemsCopy(_source);
 
             HandleSourceChanged();
             OnPropertyChanged();
@@ -103,7 +101,7 @@ public object? CurrentItem
     /// <summary>
     /// Gets a value indicating whether the collection is read-only.
     /// </summary>
-    public bool IsReadOnly => _source == null || _source.IsReadOnly;
+    public bool IsReadOnly => _source == null || _source.IsReadOnly();
 
     /// <summary>
     /// Gets or sets a value indicating whether live shaping is enabled.
diff --git a/src/ItemsSource/CollectionView.cs b/src/ItemsSource/CollectionView.cs
@@ -8,7 +8,7 @@
 using System.Linq;
 using Windows.Foundation;
 using Windows.Foundation.Collections;
-using WinUI.TableView.Helpers;
+using WinUI.TableView.Extensions;
 
 namespace WinUI.TableView;
 
@@ -17,19 +17,19 @@ namespace WinUI.TableView;
 /// </summary>
 internal partial class CollectionView : ICollectionView, ISupportIncrementalLoading, INotifyPropertyChanged, IComparer<object?>
 {
-    private IList _source = default!;
+    private IEnumerable _source = new List<object>();
+    private object[] _itemsCopy = []; // In case the source is ICollection, keep a copy of the items to keep track of removed items.
     private bool _allowLiveShaping;
     private readonly List<object?> _view = [];
     private readonly ObservableCollection<FilterDescription> _filterDescriptions = [];
     private readonly ObservableCollection<SortDescription> _sortDescriptions = [];
-    private CollectionChangedListener<CollectionView>? _collectionChangedListener;
 
     /// <summary>
     /// Initializes a new instance of the <see cref="CollectionView"/> class.
     /// </summary>
     /// <param name="source">The source collection.</param>
     /// <param name="liveShapingEnabled">Indicates whether live shaping is enabled.</param>
-    public CollectionView(IList? source = null, bool liveShapingEnabled = true)
+    public CollectionView(IEnumerable? source = null, bool liveShapingEnabled = true)
     {
         _filterDescriptions.CollectionChanged += OnFilterDescriptionsCollectionChanged;
         _sortDescriptions.CollectionChanged += OnSortDescriptionsCollectionChanged;
@@ -64,6 +64,36 @@ private void OnSortDescriptionsCollectionChanged(object? sender, NotifyCollectio
             HandleSortChanged();
     }
 
+    /// <summary>
+    /// Attaches collection changed handlers to the source collection.
+    /// </summary>
+    private void AttachCollectionChangedHandlers(IEnumerable source)
+    {
+        if (source is INotifyCollectionChanged sourceNcc)
+        {
+            sourceNcc.CollectionChanged += OnSourceCollectionChanged;
+        }
+        else if (source is ICollectionView sourceCV)
+        {
+            sourceCV.VectorChanged += OnSourceVectorChanged;
+        }
+    }
+
+    /// <summary>
+    /// Detaches collection changed handlers from the source collection.
+    /// </summary>
+    private void DetachCollectionChangedHandlers(IEnumerable source)
+    {
+        if (source is INotifyCollectionChanged sourceNcc)
+        {
+            sourceNcc.CollectionChanged -= OnSourceCollectionChanged;
+        }
+        else if (source is ICollectionView sourceCV)
+        {
+            sourceCV.VectorChanged -= OnSourceVectorChanged;
+        }
+    }
+
     /// <summary>
     /// Attaches property changed handlers to the items in the collection.
     /// </summary>
@@ -92,6 +122,75 @@ private void DetachPropertyChangedHandlers(IEnumerable? items)
         }
     }
 
+    /// <summary>
+    /// Handles changes to the source vector.
+    /// </summary>
+    private void OnSourceVectorChanged(IObservableVector<object> sender, IVectorChangedEventArgs args)
+    {
+        var index = (int)args.Index;
+
+        switch (args.CollectionChange)
+        {
+            case CollectionChange.ItemInserted:
+                if (_deferCounter <= 0)
+                {
+                    if (index < Count)
+                    {
+                        var item = sender[index];
+                        AttachPropertyChangedHandlers(new object[] { item });
+                        HandleItemAdded(index, item);
+                    }
+                    else
+                    {
+                        HandleSourceChanged();
+                    }
+                }
+
+                break;
+            case CollectionChange.ItemRemoved:
+                if (_deferCounter <= 0)
+                {
+                    if (index < _itemsCopy.Length)
+                    {
+                        var item = _itemsCopy[index];
+                        DetachPropertyChangedHandlers(new object[] { item });
+                        HandleItemRemoved(index, item);
+                    }
+                    else
+                    {
+                        HandleSourceChanged();
+                    }
+                }
+
+                break;
+            case CollectionChange.ItemChanged:
+            case CollectionChange.Reset:
+                if (_deferCounter <= 0)
+                {
+                    HandleSourceChanged();
+                }
+
+                DetachPropertyChangedHandlers(_itemsCopy);
+                AttachPropertyChangedHandlers(_source);
+
+                break;
+        }
+
+        CreateItemsCopy(_source);
+    }
+
+    /// <summary>
+    /// Creates a copy of the items from the collection if it implements ICollectionView.
+    /// </summary>
+    private void CreateItemsCopy(IEnumerable source)
+    {
+        if (source is ICollectionView collectionView)
+        {
+            _itemsCopy = new object[collectionView.Count];
+            collectionView.CopyTo(_itemsCopy, 0);
+        }
+    }
+
     /// <summary>
     /// Handles changes to the source collection.
     /// </summary>
@@ -137,6 +236,9 @@ private void OnSourceCollectionChanged(object? arg1, NotifyCollectionChangedEven
                     HandleSourceChanged();
                 }
 
+                DetachPropertyChangedHandlers(e.OldItems);
+                AttachPropertyChangedHandlers(_source);
+
                 break;
         }
     }
@@ -242,7 +344,7 @@ private void HandleSourceChanged()
     /// </summary>
     private void HandleFilterChanged()
     {
-        if (FilterDescriptions.Any())
+        if (FilterDescriptions.Count > 0)
         {
             for (var index = 0; index < _view.Count; index++)
             {
@@ -259,19 +361,21 @@ private void HandleFilterChanged()
 
         var viewHash = new HashSet<object?>(_view);
         var viewIndex = 0;
-        for (var index = 0; index < _source.Count; index++)
+        var i = 0;
+        foreach (var item in _source)
         {
-            var item = _source[index]!;
             if (viewHash.Contains(item))
             {
                 viewIndex++;
                 continue;
             }
 
-            if (HandleItemAdded(index, item, viewIndex))
+            if (HandleItemAdded(i, item, viewIndex))
             {
                 viewIndex++;
             }
+
+            i++;
         }
     }
 
diff --git a/src/TableView.Properties.cs b/src/TableView.Properties.cs
diff --git a/src/TableView.cs b/src/TableView.cs
diff --git a/tests/CollectionExtensionsTests.cs b/tests/CollectionExtensionsTests.cs
