Skip to content

Commit 2dafcf1

Browse files
dwcullopdwcullop
authored
Add AOT Friendly Attributes for BindingList<T> Compatibility (#987)
* Enhance dynamic member access support and code clarity Created a Polyfill for the `DynamicallyAccessedMembers` attribute / enum which isn't available until Net5. Updated any class using `BindingList` to include the `DynamicallyAccessedMembers` attribute so that the type have the same attributes as `BindingList`. Recursively walked up the code hierarchy to apply the attribute all the way up. * Update API text
1 parent 2fb3eff commit 2dafcf1

11 files changed

+303
-263
lines changed

‎src/DynamicData.Tests/API/ApiApprovalTests.DynamicDataTests.DotNet8_0.verified.txt‎

Lines changed: 26 additions & 26 deletions
Large diffs are not rendered by default.

‎src/DynamicData/Binding/BindPaged.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
// Roland Pheasant licenses this file to you under the MIT license.
33
// See the LICENSE file in the project root for full license information.
44

5-
using System.Reactive.Concurrency;
5+
using System.Diagnostics.CodeAnalysis;
66
using System.Reactive.Disposables;
77
using System.Reactive.Linq;
88
using System.Reactive.Subjects;
@@ -14,7 +14,7 @@ namespace DynamicData.Binding;
1414
*
1515
* (Direct lift from BindVirtualized).
1616
*/
17-
internal sealed class BindPaged<TObject, TKey>(
17+
internal sealed class BindPaged<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] TObject, TKey>(
1818
IObservable<IChangeSet<TObject, TKey, PageContext<TObject>>> source,
1919
IList<TObject> targetList,
2020
SortAndBindOptions? options)

‎src/DynamicData/Binding/BindVirtualized.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
// Roland Pheasant licenses this file to you under the MIT license.
33
// See the LICENSE file in the project root for full license information.
44

5-
using System.Reactive.Concurrency;
5+
using System.Diagnostics.CodeAnalysis;
66
using System.Reactive.Disposables;
77
using System.Reactive.Linq;
88
using System.Reactive.Subjects;
@@ -12,7 +12,7 @@ namespace DynamicData.Binding;
1212
/*
1313
* Binding for the result of the SortAndVirtualize operator
1414
*/
15-
internal sealed class BindVirtualized<TObject, TKey>(
15+
internal sealed class BindVirtualized<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] TObject, TKey>(
1616
IObservable<IChangeSet<TObject, TKey, VirtualContext<TObject>>> source,
1717
IList<TObject> targetList,
1818
SortAndBindOptions? options)

‎src/DynamicData/Binding/BindingListAdaptor.cs‎

Lines changed: 93 additions & 94 deletions
Original file line numberDiff line numberDiff line change
@@ -8,120 +8,119 @@
88
using DynamicData.Cache;
99
using DynamicData.Cache.Internal;
1010

11-
namespace DynamicData.Binding
11+
namespace DynamicData.Binding;
12+
13+
/// <summary>
14+
/// Adaptor to reflect a change set into a binding list.
15+
/// </summary>
16+
/// <typeparam name="T">The type of items.</typeparam>
17+
/// <remarks>
18+
/// Initializes a new instance of the <see cref="BindingListAdaptor{T}"/> class.
19+
/// </remarks>
20+
/// <param name="list">The list of items to add to the adapter.</param>
21+
/// <param name="refreshThreshold">The threshold before a reset is issued.</param>
22+
public class BindingListAdaptor<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] T>(BindingList<T> list, int refreshThreshold = BindingOptions.DefaultResetThreshold) : IChangeSetAdaptor<T>
23+
where T : notnull
1224
{
13-
/// <summary>
14-
/// Adaptor to reflect a change set into a binding list.
15-
/// </summary>
16-
/// <typeparam name="T">The type of items.</typeparam>
17-
/// <remarks>
18-
/// Initializes a new instance of the <see cref="BindingListAdaptor{T}"/> class.
19-
/// </remarks>
20-
/// <param name="list">The list of items to add to the adapter.</param>
21-
/// <param name="refreshThreshold">The threshold before a reset is issued.</param>
22-
public class BindingListAdaptor<T>(BindingList<T> list, int refreshThreshold = BindingOptions.DefaultResetThreshold) : IChangeSetAdaptor<T>
23-
where T : notnull
25+
private readonly BindingList<T> _list = list ?? throw new ArgumentNullException(nameof(list));
26+
private bool _loaded;
27+
28+
/// <inheritdoc />
29+
public void Adapt(IChangeSet<T> changes)
2430
{
25-
private readonly BindingList<T> _list = list ?? throw new ArgumentNullException(nameof(list));
26-
private bool _loaded;
31+
changes.ThrowArgumentNullExceptionIfNull(nameof(changes));
2732

28-
/// <inheritdoc />
29-
public void Adapt(IChangeSet<T> changes)
33+
if (changes.TotalChanges - changes.Refreshes > refreshThreshold || !_loaded)
3034
{
31-
changes.ThrowArgumentNullExceptionIfNull(nameof(changes));
32-
33-
if (changes.TotalChanges - changes.Refreshes > refreshThreshold || !_loaded)
34-
{
35-
using (new BindingListEventsSuspender<T>(_list))
36-
{
37-
_list.Clone(changes);
38-
_loaded = true;
39-
}
40-
}
41-
else
35+
using (new BindingListEventsSuspender<T>(_list))
4236
{
4337
_list.Clone(changes);
38+
_loaded = true;
4439
}
4540
}
41+
else
42+
{
43+
_list.Clone(changes);
44+
}
4645
}
46+
}
4747

48-
/// <summary>
49-
/// Adaptor to reflect a change set into a binding list.
50-
/// </summary>
51-
/// <typeparam name="TObject">The type of the object.</typeparam>
52-
/// <typeparam name="TKey">The type of the key.</typeparam>
53-
/// <remarks>
54-
/// Initializes a new instance of the <see cref="BindingListAdaptor{TObject, TKey}"/> class.
55-
/// </remarks>
56-
/// <param name="list">The list of items to adapt.</param>
57-
/// <param name="refreshThreshold">The threshold before the refresh is triggered.</param>
58-
[SuppressMessage("StyleCop.CSharp.MaintainabilityRules", "SA1402:File may only contain a single type", Justification = "Same class name, different generics")]
59-
public class BindingListAdaptor<TObject, TKey>(BindingList<TObject> list, int refreshThreshold = BindingOptions.DefaultResetThreshold) : IChangeSetAdaptor<TObject, TKey>
60-
where TObject : notnull
61-
where TKey : notnull
62-
{
63-
private readonly Cache<TObject, TKey> _cache = new();
48+
/// <summary>
49+
/// Adaptor to reflect a change set into a binding list.
50+
/// </summary>
51+
/// <typeparam name="TObject">The type of the object.</typeparam>
52+
/// <typeparam name="TKey">The type of the key.</typeparam>
53+
/// <remarks>
54+
/// Initializes a new instance of the <see cref="BindingListAdaptor{TObject, TKey}"/> class.
55+
/// </remarks>
56+
/// <param name="list">The list of items to adapt.</param>
57+
/// <param name="refreshThreshold">The threshold before the refresh is triggered.</param>
58+
[SuppressMessage("StyleCop.CSharp.MaintainabilityRules", "SA1402:File may only contain a single type", Justification = "Same class name, different generics")]
59+
public class BindingListAdaptor<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] TObject, TKey>(BindingList<TObject> list, int refreshThreshold = BindingOptions.DefaultResetThreshold) : IChangeSetAdaptor<TObject, TKey>
60+
where TObject : notnull
61+
where TKey : notnull
62+
{
63+
private readonly Cache<TObject, TKey> _cache = new();
6464

65-
private readonly BindingList<TObject> _list = list ?? throw new ArgumentNullException(nameof(list));
66-
private bool _loaded;
65+
private readonly BindingList<TObject> _list = list ?? throw new ArgumentNullException(nameof(list));
66+
private bool _loaded;
6767

68-
/// <inheritdoc />
69-
public void Adapt(IChangeSet<TObject, TKey> changes)
70-
{
71-
changes.ThrowArgumentNullExceptionIfNull(nameof(changes));
72-
_cache.Clone(changes);
68+
/// <inheritdoc />
69+
public void Adapt(IChangeSet<TObject, TKey> changes)
70+
{
71+
changes.ThrowArgumentNullExceptionIfNull(nameof(changes));
72+
_cache.Clone(changes);
7373

74-
if (changes.Count - changes.Refreshes > refreshThreshold || !_loaded)
75-
{
76-
using (new BindingListEventsSuspender<TObject>(_list))
77-
{
78-
_list.Clear();
79-
_list.AddRange(_cache.Items);
80-
_loaded = true;
81-
}
82-
}
83-
else
74+
if (changes.Count - changes.Refreshes > refreshThreshold || !_loaded)
75+
{
76+
using (new BindingListEventsSuspender<TObject>(_list))
8477
{
85-
DoUpdate(changes, _list);
78+
_list.Clear();
79+
_list.AddRange(_cache.Items);
80+
_loaded = true;
8681
}
8782
}
83+
else
84+
{
85+
DoUpdate(changes, _list);
86+
}
87+
}
8888

89-
private static void DoUpdate(IChangeSet<TObject, TKey> changes, BindingList<TObject> list)
89+
private static void DoUpdate(IChangeSet<TObject, TKey> changes, BindingList<TObject> list)
90+
{
91+
foreach (var update in changes.ToConcreteType())
9092
{
91-
foreach (var update in changes.ToConcreteType())
93+
switch (update.Reason)
9294
{
93-
switch (update.Reason)
94-
{
95-
case ChangeReason.Add:
95+
case ChangeReason.Add:
96+
list.Add(update.Current);
97+
break;
98+
99+
case ChangeReason.Remove:
100+
list.Remove(update.Current);
101+
break;
102+
103+
case ChangeReason.Update:
104+
var previousIndex = list.IndexOf(update.Previous.Value);
105+
if (previousIndex >= 0)
106+
{
107+
list[previousIndex] = update.Current;
108+
}
109+
else
110+
{
96111
list.Add(update.Current);
97-
break;
98-
99-
case ChangeReason.Remove:
100-
list.Remove(update.Current);
101-
break;
102-
103-
case ChangeReason.Update:
104-
var previousIndex = list.IndexOf(update.Previous.Value);
105-
if (previousIndex >= 0)
106-
{
107-
list[previousIndex] = update.Current;
108-
}
109-
else
110-
{
111-
list.Add(update.Current);
112-
}
113-
114-
break;
115-
116-
case ChangeReason.Refresh:
117-
var index = list.IndexOf(update.Current);
118-
if (index != -1)
119-
{
120-
list.ResetItem(index);
121-
}
122-
123-
break;
124-
}
112+
}
113+
114+
break;
115+
116+
case ChangeReason.Refresh:
117+
var index = list.IndexOf(update.Current);
118+
if (index != -1)
119+
{
120+
list.ResetItem(index);
121+
}
122+
123+
break;
125124
}
126125
}
127126
}

‎src/DynamicData/Binding/BindingListEventsSuspender.cs‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,12 @@
33
// See the LICENSE file in the project root for full license information.
44

55
using System.ComponentModel;
6+
using System.Diagnostics.CodeAnalysis;
67
using System.Reactive.Disposables;
78

89
namespace DynamicData.Binding;
910

10-
internal sealed class BindingListEventsSuspender<T> : IDisposable
11+
internal sealed class BindingListEventsSuspender<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] T> : IDisposable
1112
{
1213
private readonly IDisposable _cleanUp;
1314

‎src/DynamicData/Binding/SortAndBind.cs‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
// See the LICENSE file in the project root for full license information.
44

55
using System.ComponentModel;
6+
using System.Diagnostics.CodeAnalysis;
67
using System.Reactive.Disposables;
78
using System.Reactive.Linq;
89
using DynamicData.Cache;
@@ -17,7 +18,7 @@ namespace DynamicData.Binding;
1718
* collection upon every change in order that the sorted list could be transmitted to the bind operator.
1819
*
1920
*/
20-
internal sealed class SortAndBind<TObject, TKey>
21+
internal sealed class SortAndBind<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.All)] TObject, TKey>
2122
where TObject : notnull
2223
where TKey : notnull
2324
{

0 commit comments

Comments
 (0)