From b6de3a3b7296ffc88fb16fcf5d5ac3b0d8c46791 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Standa=20Luke=C5=A1?= <exyi@outlook.cz>
Date: Fri, 20 Dec 2024 21:22:39 +0100
Subject: [PATCH] v5 cleanup: Replace custom ReferenceEqualityComparer with the
 standard one

---
 .../Compilation/ErrorCheckingVisitor.cs       |  2 +-
 src/Framework/Framework/Controls/Repeater.cs  |  2 +-
 .../Utils/ReferenceEqualityComparer.cs        | 66 +++++++++++++++----
 3 files changed, 57 insertions(+), 13 deletions(-)

diff --git a/src/Framework/Framework/Compilation/ErrorCheckingVisitor.cs b/src/Framework/Framework/Compilation/ErrorCheckingVisitor.cs
index 86413cde7..c7b7be47d 100644
--- a/src/Framework/Framework/Compilation/ErrorCheckingVisitor.cs
+++ b/src/Framework/Framework/Compilation/ErrorCheckingVisitor.cs
@@ -71,7 +71,7 @@ private void AddNodeErrors(DothtmlNode node, int priority)
         /// * the locations are processed using MapBindingLocation to make them useful in the context of a dothtml file </summary>
         Dictionary<Exception, DotvvmCompilationSourceLocation?> AnnotateBindingExceptionWithLocation(ResolvedBinding binding, DotvvmProperty? relatedProperty, IEnumerable<Exception> errors)
         {
-            var result = new Dictionary<Exception, DotvvmCompilationSourceLocation?>(ReferenceEqualityComparer<Exception>.Instance);
+            var result = new Dictionary<Exception, DotvvmCompilationSourceLocation?>(ReferenceEqualityComparer.Instance);
             void recurse(Exception exception, DotvvmCompilationSourceLocation? location)
             {
                 if (result.ContainsKey(exception))
diff --git a/src/Framework/Framework/Controls/Repeater.cs b/src/Framework/Framework/Controls/Repeater.cs
index 988f8bbf2..5d72e369d 100644
--- a/src/Framework/Framework/Controls/Repeater.cs
+++ b/src/Framework/Framework/Controls/Repeater.cs
@@ -250,7 +250,7 @@ private DotvvmControl CreateEmptyItem(IDotvvmRequestContext context)
             return emptyDataContainer;
         }
 
-        private readonly Dictionary<object, DataItemContainer> childrenCache = new(ReferenceEqualityComparer<object>.Instance);
+        private readonly Dictionary<object, DataItemContainer> childrenCache = new(ReferenceEqualityComparer.Instance);
         private DotvvmControl AddItem(IList<DotvvmControl> c, IDotvvmRequestContext context, object? item = null, int? index = null, bool allowMemoizationRetrieve = false, bool allowMemoizationStore = false)
         {
             if (allowMemoizationRetrieve && item != null && childrenCache.TryGetValue(item, out var container2) && container2.Parent == null)
diff --git a/src/Framework/Framework/Utils/ReferenceEqualityComparer.cs b/src/Framework/Framework/Utils/ReferenceEqualityComparer.cs
index 4c34d4126..630ae7188 100644
--- a/src/Framework/Framework/Utils/ReferenceEqualityComparer.cs
+++ b/src/Framework/Framework/Utils/ReferenceEqualityComparer.cs
@@ -1,16 +1,60 @@
-using System.Collections.Generic;
-using System.Runtime.CompilerServices;
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+#if !NET_5_0_OR_GREATER
 
-namespace DotVVM.Framework.Utils
+using System.Runtime.CompilerServices;
+ 
+namespace System.Collections.Generic
 {
-    // TODO next version: Replace with System.Collections.Generic.ReferenceEqualityComparer
-    internal class ReferenceEqualityComparer<T> : IEqualityComparer<T>
-        where T : class
+    /// <summary>
+    /// An <see cref="IEqualityComparer{Object}"/> that uses reference equality (<see cref="object.ReferenceEquals(object?, object?)"/>)
+    /// instead of value equality (<see cref="object.Equals(object?)"/>) when comparing two object instances.
+    /// </summary>
+    /// <remarks>
+    /// The <see cref="ReferenceEqualityComparer"/> type cannot be instantiated. Instead, use the <see cref="Instance"/> property
+    /// to access the singleton instance of this type.
+    /// </remarks>
+    internal sealed class ReferenceEqualityComparer : IEqualityComparer<object?>, IEqualityComparer
     {
-        public static ReferenceEqualityComparer<T> Instance { get; } = new ReferenceEqualityComparer<T>();
-
-
-        public bool Equals(T? x, T? y) => ReferenceEquals(x, y);
-        public int GetHashCode(T obj) => obj == null ? 0 : RuntimeHelpers.GetHashCode(obj);
+        private ReferenceEqualityComparer() { }
+ 
+        /// <summary>
+        /// Gets the singleton <see cref="ReferenceEqualityComparer"/> instance.
+        /// </summary>
+        public static ReferenceEqualityComparer Instance { get; } = new ReferenceEqualityComparer();
+ 
+        /// <summary>
+        /// Determines whether two object references refer to the same object instance.
+        /// </summary>
+        /// <param name="x">The first object to compare.</param>
+        /// <param name="y">The second object to compare.</param>
+        /// <returns>
+        /// <see langword="true"/> if both <paramref name="x"/> and <paramref name="y"/> refer to the same object instance
+        /// or if both are <see langword="null"/>; otherwise, <see langword="false"/>.
+        /// </returns>
+        /// <remarks>
+        /// This API is a wrapper around <see cref="object.ReferenceEquals(object?, object?)"/>.
+        /// It is not necessarily equivalent to calling <see cref="object.Equals(object?, object?)"/>.
+        /// </remarks>
+        public new bool Equals(object? x, object? y) => ReferenceEquals(x, y);
+ 
+        /// <summary>
+        /// Returns a hash code for the specified object. The returned hash code is based on the object
+        /// identity, not on the contents of the object.
+        /// </summary>
+        /// <param name="obj">The object for which to retrieve the hash code.</param>
+        /// <returns>A hash code for the identity of <paramref name="obj"/>.</returns>
+        /// <remarks>
+        /// This API is a wrapper around <see cref="RuntimeHelpers.GetHashCode(object)"/>.
+        /// It is not necessarily equivalent to calling <see cref="object.GetHashCode()"/>.
+        /// </remarks>
+        public int GetHashCode(object? obj)
+        {
+            // Depending on target framework, RuntimeHelpers.GetHashCode might not be annotated
+            // with the proper nullability attribute. We'll suppress any warning that might
+            // result.
+            return RuntimeHelpers.GetHashCode(obj!);
+        }
     }
 }
+#endif