Merge branch 'add-mod-utils' into freemods

osu.Game.Tests.Android/osu.Game.Tests.Android.csproj

@@ -69,5 +69,9 @@
       <Name>osu.Game</Name>
     </ProjectReference>
   </ItemGroup>
+  <ItemGroup Label="Package References">
+    <PackageReference Include="DeepEqual" Version="2.0.0" />
+    <PackageReference Include="Moq" Version="4.16.0" />
+  </ItemGroup>
   <Import Project="$(MSBuildExtensionsPath)\Xamarin\Android\Xamarin.Android.CSharp.targets" />
 </Project>

osu.Game.Tests.iOS/osu.Game.Tests.iOS.csproj

@@ -45,6 +45,7 @@
   </ItemGroup>
   <ItemGroup Label="Package References">
     <PackageReference Include="DeepEqual" Version="2.0.0" />
+    <PackageReference Include="Moq" Version="4.16.0" />
   </ItemGroup>
   <Import Project="$(MSBuildExtensionsPath)\Xamarin\iOS\Xamarin.iOS.CSharp.targets" />
 </Project>

osu.Game.Tests/Mods/ModUtilsTest.cs

@@ -0,0 +1,110 @@
+// 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 Moq;
+using NUnit.Framework;
+using osu.Game.Rulesets.Mods;
+using osu.Game.Utils;
+
+namespace osu.Game.Tests.Mods
+{
+    [TestFixture]
+    public class ModUtilsTest
+    {
+        [Test]
+        public void TestModIsCompatibleByItself()
+        {
+            var mod = new Mock<CustomMod1>();
+            Assert.That(ModUtils.CheckCompatibleSet(new[] { mod.Object }));
+        }
+
+        [Test]
+        public void TestIncompatibleThroughTopLevel()
+        {
+            var mod1 = new Mock<CustomMod1>();
+            var mod2 = new Mock<CustomMod2>();
+
+            mod1.Setup(m => m.IncompatibleMods).Returns(new[] { mod2.Object.GetType() });
+
+            // Test both orderings.
+            Assert.That(ModUtils.CheckCompatibleSet(new Mod[] { mod1.Object, mod2.Object }), Is.False);
+            Assert.That(ModUtils.CheckCompatibleSet(new Mod[] { mod2.Object, mod1.Object }), Is.False);
+        }
+
+        [Test]
+        public void TestMultiModIncompatibleWithTopLevel()
+        {
+            var mod1 = new Mock<CustomMod1>();
+
+            // The nested mod.
+            var mod2 = new Mock<CustomMod2>();
+            mod2.Setup(m => m.IncompatibleMods).Returns(new[] { mod1.Object.GetType() });
+
+            var multiMod = new MultiMod(new MultiMod(mod2.Object));
+
+            // Test both orderings.
+            Assert.That(ModUtils.CheckCompatibleSet(new Mod[] { multiMod, mod1.Object }), Is.False);
+            Assert.That(ModUtils.CheckCompatibleSet(new Mod[] { mod1.Object, multiMod }), Is.False);
+        }
+
+        [Test]
+        public void TestTopLevelIncompatibleWithMultiMod()
+        {
+            // The nested mod.
+            var mod1 = new Mock<CustomMod1>();
+            var multiMod = new MultiMod(new MultiMod(mod1.Object));
+
+            var mod2 = new Mock<CustomMod2>();
+            mod2.Setup(m => m.IncompatibleMods).Returns(new[] { typeof(CustomMod1) });
+
+            // Test both orderings.
+            Assert.That(ModUtils.CheckCompatibleSet(new Mod[] { multiMod, mod2.Object }), Is.False);
+            Assert.That(ModUtils.CheckCompatibleSet(new Mod[] { mod2.Object, multiMod }), Is.False);
+        }
+
+        [Test]
+        public void TestCompatibleMods()
+        {
+            var mod1 = new Mock<CustomMod1>();
+            var mod2 = new Mock<CustomMod2>();
+
+            // Test both orderings.
+            Assert.That(ModUtils.CheckCompatibleSet(new Mod[] { mod1.Object, mod2.Object }), Is.True);
+            Assert.That(ModUtils.CheckCompatibleSet(new Mod[] { mod2.Object, mod1.Object }), Is.True);
+        }
+
+        [Test]
+        public void TestIncompatibleThroughBaseType()
+        {
+            var mod1 = new Mock<CustomMod1>();
+            var mod2 = new Mock<CustomMod2>();
+            mod2.Setup(m => m.IncompatibleMods).Returns(new[] { typeof(Mod) });
+
+            // Test both orderings.
+            Assert.That(ModUtils.CheckCompatibleSet(new Mod[] { mod1.Object, mod2.Object }), Is.False);
+            Assert.That(ModUtils.CheckCompatibleSet(new Mod[] { mod2.Object, mod1.Object }), Is.False);
+        }
+
+        [Test]
+        public void TestAllowedThroughMostDerivedType()
+        {
+            var mod = new Mock<CustomMod1>();
+            Assert.That(ModUtils.CheckAllowed(new[] { mod.Object }, new[] { mod.Object.GetType() }));
+        }
+
+        [Test]
+        public void TestNotAllowedThroughBaseType()
+        {
+            var mod = new Mock<CustomMod1>();
+            Assert.That(ModUtils.CheckAllowed(new[] { mod.Object }, new[] { typeof(Mod) }), Is.False);
+        }
+
+        public abstract class CustomMod1 : Mod
+        {
+        }
+
+        public abstract class CustomMod2 : Mod
+        {
+        }
+    }
+}

osu.Game/Utils/ModUtils.cs

@@ -4,7 +4,6 @@
 using System;
 using System.Collections.Generic;
 using System.Linq;
-using osu.Framework.Extensions.TypeExtensions;
 using osu.Game.Rulesets.Mods;
 
 #nullable enable
@@ -29,7 +28,7 @@ namespace osu.Game.Utils
         {
             // Prevent multiple-enumeration.
             var combinationList = combination as ICollection<Mod> ?? combination.ToArray();
-            return CheckCompatibleSet(combinationList) && CheckAllowed(combinationList, allowedTypes);
+            return CheckCompatibleSet(combinationList, out _) && CheckAllowed(combinationList, allowedTypes);
         }
 
         /// <summary>
@@ -38,32 +37,32 @@ namespace osu.Game.Utils
         /// <param name="combination">The <see cref="Mod"/> combination to check.</param>
         /// <returns>Whether all <see cref="Mod"/>s in the combination are compatible with each-other.</returns>
         public static bool CheckCompatibleSet(IEnumerable<Mod> combination)
+            => CheckCompatibleSet(combination, out _);
+
+        /// <summary>
+        /// Checks that all <see cref="Mod"/>s in a combination are compatible with each-other.
+        /// </summary>
+        /// <param name="combination">The <see cref="Mod"/> combination to check.</param>
+        /// <param name="invalidMods">Any invalid mods in the set.</param>
+        /// <returns>Whether all <see cref="Mod"/>s in the combination are compatible with each-other.</returns>
+        public static bool CheckCompatibleSet(IEnumerable<Mod> combination, out List<Mod>? invalidMods)
         {
-            var incompatibleTypes = new HashSet<Type>();
+            combination = FlattenMods(combination).ToArray();
-            var incomingTypes = new HashSet<Type>();
+            invalidMods = null;
 
-            foreach (var mod in combination.SelectMany(FlattenMod))
+            foreach (var mod in combination)
             {
-                // Add the new mod incompatibilities, checking whether any match the existing mod types.
+                foreach (var type in mod.IncompatibleMods)
-                foreach (var t in mod.IncompatibleMods)
                 {
-                    if (incomingTypes.Contains(t))
+                    foreach (var invalid in combination.Where(m => type.IsInstanceOfType(m)))
-                        return false;
+                    {
-
+                        invalidMods ??= new List<Mod>();
-                    incompatibleTypes.Add(t);
+                        invalidMods.Add(invalid);
-                }
+                    }
-
-                // Add the new mod types, checking whether any match the incompatible types.
-                foreach (var t in mod.GetType().EnumerateBaseTypes())
-                {
-                    if (incomingTypes.Contains(t))
-                        return false;
-
-                    incomingTypes.Add(t);
                 }
             }
 
-            return true;
+            return invalidMods == null;
         }
 
         /// <summary>