Implement equality comparers for HitSampleInfo

osu.Game.Rulesets.Catch/Objects/Banana.cs

@@ -1,6 +1,7 @@
 // Copyright (c) ppy Pty Ltd <contact@ppy.sh>. Licensed under the MIT Licence.
 // See the LICENCE file in the repository root for full licence text.
 
+using System;
 using System.Collections.Generic;
 using osu.Framework.Utils;
 using osu.Game.Audio;
@@ -50,16 +51,24 @@ namespace osu.Game.Rulesets.Catch.Objects
             }
         }
 
-        private class BananaHitSampleInfo : HitSampleInfo
+        private class BananaHitSampleInfo : HitSampleInfo, IEquatable<BananaHitSampleInfo>
         {
-            private static string[] lookupNames { get; } = { "metronomelow", "catch-banana" };
+            private static readonly string[] lookup_names = { "metronomelow", "catch-banana" };
 
-            public override IEnumerable<string> LookupNames => lookupNames;
+            public override IEnumerable<string> LookupNames => lookup_names;
 
             public BananaHitSampleInfo()
                 : base(string.Empty)
             {
             }
+
+            public bool Equals(BananaHitSampleInfo other)
+                => other != null;
+
+            public override bool Equals(object obj)
+                => Equals((BananaHitSampleInfo)obj);
+
+            public override int GetHashCode() => lookup_names.GetHashCode();
         }
     }
 }

osu.Game/Audio/HitSampleInfo.cs

@@ -13,7 +13,7 @@ namespace osu.Game.Audio
     /// Describes a gameplay hit sample.
     /// </summary>
     [Serializable]
-    public class HitSampleInfo : ISampleInfo
+    public class HitSampleInfo : ISampleInfo, IEquatable<HitSampleInfo>
     {
         public const string HIT_WHISTLE = @"hitwhistle";
         public const string HIT_FINISH = @"hitfinish";
@@ -77,5 +77,13 @@ namespace osu.Game.Audio
         /// <returns>The new <see cref="HitSampleInfo"/>.</returns>
         public virtual HitSampleInfo With(Optional<string> name = default, Optional<string?> bank = default, Optional<string?> suffix = default, Optional<int> volume = default)
             => new HitSampleInfo(name.GetOr(Name), bank.GetOr(Bank), suffix.GetOr(Suffix), volume.GetOr(Volume));
+
+        public bool Equals(HitSampleInfo? other)
+            => other != null && Name == other.Name && Bank == other.Bank && Suffix == other.Suffix;
+
+        public override bool Equals(object? obj)
+            => Equals((HitSampleInfo?)obj);
+
+        public override int GetHashCode() => HashCode.Combine(Name, Bank, Suffix);
     }
 }

osu.Game/Rulesets/Objects/Legacy/ConvertHitObjectParser.cs

@@ -466,7 +466,7 @@ namespace osu.Game.Rulesets.Objects.Legacy
 
 #nullable enable
 
-        public class LegacyHitSampleInfo : HitSampleInfo
+        public class LegacyHitSampleInfo : HitSampleInfo, IEquatable<LegacyHitSampleInfo>
         {
             public readonly int CustomSampleBank;
 
@@ -492,9 +492,16 @@ namespace osu.Game.Rulesets.Objects.Legacy
             public LegacyHitSampleInfo With(Optional<string> name = default, Optional<string?> bank = default, Optional<int> volume = default, Optional<int> customSampleBank = default,
                                             Optional<bool> isLayered = default)
                 => new LegacyHitSampleInfo(name.GetOr(Name), bank.GetOr(Bank), volume.GetOr(Volume), customSampleBank.GetOr(CustomSampleBank), isLayered.GetOr(IsLayered));
+
+            public bool Equals(LegacyHitSampleInfo? other)
+                => base.Equals(other) && CustomSampleBank == other.CustomSampleBank && IsLayered == other.IsLayered;
+
+            public override bool Equals(object? obj) => Equals((LegacyHitSampleInfo?)obj);
+
+            public override int GetHashCode() => HashCode.Combine(base.GetHashCode(), CustomSampleBank, IsLayered);
         }
 
-        private class FileHitSampleInfo : LegacyHitSampleInfo
+        private class FileHitSampleInfo : LegacyHitSampleInfo, IEquatable<FileHitSampleInfo>
         {
             public readonly string Filename;
 
@@ -517,6 +524,14 @@ namespace osu.Game.Rulesets.Objects.Legacy
 
             public FileHitSampleInfo With(Optional<string> filename = default, Optional<int> volume = default)
                 => new FileHitSampleInfo(filename.GetOr(Filename), volume.GetOr(Volume));
+
+            public bool Equals(FileHitSampleInfo? other)
+                => base.Equals(other) && Filename == other.Filename;
+
+            public override bool Equals(object? obj)
+                => Equals((FileHitSampleInfo?)obj);
+
+            public override int GetHashCode() => HashCode.Combine(base.GetHashCode(), Filename);
         }
 
 #nullable disable