feat: restructure base patch & harmony finalizers

- All patches now extend a base OsuPatch
- Custom patch processor automatically handles adding patch finalizers to catch exceptions

Osu.Patcher.Hook/Hook.cs

@@ -3,6 +3,7 @@
 using System.Runtime.InteropServices;
 using HarmonyLib;
 using JetBrains.Annotations;
+using Osu.Patcher.Hook.Patches;
 using Osu.Performance;
 using Osu.Stubs.Wrappers;
 
@@ -66,10 +67,15 @@ private static void InitializePatches(Harmony harmony)
     {
         foreach (var type in AccessTools.GetTypesFromAssembly(typeof(Hook).Assembly))
         {
+            // Check if the type extends OsuPatch
+            if (!type.IsSubclassOf(typeof(OsuPatch)))
+                continue;
+
+            Debug.WriteLine($"Processing Patch {type.Name}", "Hook");
+
             try
             {
-                // This executes for every type and ignores if no [HarmonyPatch] is present
-                harmony.CreateClassProcessor(type).Patch();
+                new OsuPatchProcessor(harmony, type).Patch();
             }
             catch (Exception e)
             {

Osu.Patcher.Hook/Patches/BeatmapMirror/EnableOsuDirect.cs

@@ -1,11 +1,10 @@
-using System;
 using System.Collections.Generic;
-using System.Diagnostics.CodeAnalysis;
 using System.Reflection;
 using System.Reflection.Emit;
 using HarmonyLib;
 using JetBrains.Annotations;
 using Osu.Stubs;
+using Osu.Utils.Extensions;
 using static System.Reflection.Emit.OpCodes;
 
 namespace Osu.Patcher.Hook.Patches.BeatmapMirror;
@@ -28,7 +27,7 @@ namespace Osu.Patcher.Hook.Patches.BeatmapMirror;
 /// </summary>
 [HarmonyPatch]
 [UsedImplicitly]
-public class EnableOsuDirect : BasePatch
+internal class EnableOsuDirect : OsuPatch
 {
     private static readonly OpCode[] Signature =
     {
@@ -49,9 +48,9 @@ public class EnableOsuDirect : BasePatch
 
     [UsedImplicitly]
     [HarmonyTranspiler]
-    private static IEnumerable<CodeInstruction> Transpiler(IEnumerable<CodeInstruction> instructions) =>
-        InsertBeforeSignature(
-            instructions,
+    private static IEnumerable<CodeInstruction> Transpiler(IEnumerable<CodeInstruction> instructions)
+    {
+        instructions = instructions.InsertBeforeSignature(
             Signature,
             new CodeInstruction[]
             {
@@ -61,14 +60,6 @@ private static IEnumerable<CodeInstruction> Transpiler(IEnumerable<CodeInstructi
             }
         );
 
-    [UsedImplicitly]
-    [HarmonyFinalizer]
-    [SuppressMessage("ReSharper", "InconsistentNaming")]
-    private static void Finalizer(Exception? __exception)
-    {
-        if (__exception != null)
-        {
-            Console.WriteLine($"Exception due to {nameof(EnableOsuDirect)}: {__exception}");
-        }
+        return instructions;
     }
 }

Osu.Patcher.Hook/Patches/LivePerformance/AddPerformanceToUi.cs

@@ -1,4 +1,3 @@
-using System;
 using System.Diagnostics;
 using System.Diagnostics.CodeAnalysis;
 using System.Linq;
@@ -17,7 +16,7 @@ namespace Osu.Patcher.Hook.Patches.LivePerformance;
 /// </summary>
 [HarmonyPatch]
 [UsedImplicitly]
-public class AddPerformanceToUi
+internal class AddPerformanceToUi : OsuPatch
 {
     [UsedImplicitly]
     [HarmonyTargetMethod]
@@ -73,17 +72,6 @@ private static void After(
         Debug.WriteLine("Added Performance Counter to ScoreDisplay", nameof(AddPerformanceToUi));
     }
 
-    [UsedImplicitly]
-    [HarmonyFinalizer]
-    [SuppressMessage("ReSharper", "InconsistentNaming")]
-    private static void Finalizer(Exception? __exception)
-    {
-        if (__exception != null)
-        {
-            Console.WriteLine($"Exception due to {nameof(AddPerformanceToUi)}: {__exception}");
-        }
-    }
-
     private static float GetYOffset(float baseYPosition, float scale, object scoreDisplay)
     {
         // Read the heights of both pSpriteTexts: s_Score, s_Accuracy

Osu.Patcher.Hook/Patches/LivePerformance/TrackOnScoreHit.cs

@@ -1,4 +1,3 @@
-using System;
 using System.Diagnostics;
 using System.Diagnostics.CodeAnalysis;
 using System.Reflection;
@@ -16,7 +15,7 @@ namespace Osu.Patcher.Hook.Patches.LivePerformance;
 /// </summary>
 [HarmonyPatch]
 [UsedImplicitly]
-public static class TrackOnScoreHit
+internal class TrackOnScoreHit : OsuPatch
 {
     [UsedImplicitly]
     [HarmonyTargetMethod]
@@ -56,15 +55,4 @@ private static void After(
 
         Task.Run(() => PerformanceCalculator.Calculator?.AddJudgement(judgement, (uint)MaxCombo));
     }
-
-    [UsedImplicitly]
-    [HarmonyFinalizer]
-    [SuppressMessage("ReSharper", "InconsistentNaming")]
-    private static void Finalizer(Exception? __exception)
-    {
-        if (__exception != null)
-        {
-            Console.WriteLine($"Exception due to {nameof(TrackOnScoreHit)}: {__exception}");
-        }
-    }
 }

Osu.Patcher.Hook/Patches/LivePerformance/TrackResetScore.cs

@@ -1,5 +1,3 @@
-using System;
-using System.Diagnostics.CodeAnalysis;
 using System.Reflection;
 using HarmonyLib;
 using JetBrains.Annotations;
@@ -12,7 +10,7 @@ namespace Osu.Patcher.Hook.Patches.LivePerformance;
 /// </summary>
 [HarmonyPatch]
 [UsedImplicitly]
-internal class TrackResetScore
+internal class TrackResetScore : OsuPatch
 {
     [UsedImplicitly]
     [HarmonyTargetMethod]
@@ -21,15 +19,4 @@ internal class TrackResetScore
     [UsedImplicitly]
     [HarmonyPostfix]
     private static void After() => PerformanceCalculator.ResetCalculator();
-
-    [UsedImplicitly]
-    [HarmonyFinalizer]
-    [SuppressMessage("ReSharper", "InconsistentNaming")]
-    private static void Finalizer(Exception? __exception)
-    {
-        if (__exception != null)
-        {
-            Console.WriteLine($"Exception due to {nameof(TrackResetScore)}: {__exception}");
-        }
-    }
 }

Osu.Patcher.Hook/Patches/Misc/AllowPlayModeReload.cs

@@ -4,6 +4,7 @@
 using JetBrains.Annotations;
 using Osu.Patcher.Hook.Patches.UI;
 using Osu.Stubs;
+using Osu.Utils.Extensions;
 using static System.Reflection.Emit.OpCodes;
 
 namespace Osu.Patcher.Hook.Patches.Misc;
@@ -28,17 +29,17 @@ namespace Osu.Patcher.Hook.Patches.Misc;
 /// </summary>
 [HarmonyPatch]
 [UsedImplicitly]
-public class AllowPlayModeReload : BasePatch
+internal class AllowPlayModeReload : OsuPatch
 {
     [UsedImplicitly]
     [HarmonyTargetMethod]
     private static MethodBase Target() => GameBase.GetModeCanReload.Reference;
 
     [UsedImplicitly]
     [HarmonyTranspiler]
-    private static IEnumerable<CodeInstruction> Transpiler(IEnumerable<CodeInstruction> instructions) =>
-        InsertBeforeSignature(
-            instructions,
+    private static IEnumerable<CodeInstruction> Transpiler(IEnumerable<CodeInstruction> instructions)
+    {
+        instructions = instructions.InsertBeforeSignature(
             new[]
             {
                 // Ldsfld, // Loads the ReplayScore to check if it's null
@@ -55,4 +56,7 @@ private static IEnumerable<CodeInstruction> Transpiler(IEnumerable<CodeInstructi
                 new(Ret),
             }
         );
+
+        return instructions;
+    }
 }

Osu.Patcher.Hook/Patches/Misc/DisableErrorReporting.cs

@@ -10,7 +10,7 @@ namespace Osu.Patcher.Hook.Patches.Misc;
 /// </summary>
 [HarmonyPatch]
 [UsedImplicitly]
-internal class DisableErrorReporting : BasePatch
+internal class DisableErrorReporting : OsuPatch
 {
     [UsedImplicitly]
     [HarmonyTargetMethod]

Osu.Patcher.Hook/Patches/Misc/FixDoubleSkipping.cs

@@ -23,7 +23,7 @@ namespace Osu.Patcher.Hook.Patches.Misc;
 /// </summary>
 [HarmonyPatch]
 [UsedImplicitly]
-internal class FixDoubleSkipping : BasePatch
+internal class FixDoubleSkipping : OsuPatch
 {
     [UsedImplicitly]
     [HarmonyTargetMethod]
@@ -48,20 +48,13 @@ private static bool Before(ref bool __result)
     /// </summary>
     [UsedImplicitly]
     [HarmonyTranspiler]
-    private static IEnumerable<CodeInstruction> Transpiler(IEnumerable<CodeInstruction> instructions) =>
-        instructions.Manipulator(
+    private static IEnumerable<CodeInstruction> Transpiler(IEnumerable<CodeInstruction> instructions)
+    {
+        instructions = instructions.Manipulator(
             inst => inst.OperandIs(10000),
             inst => inst.operand = 0
         );
 
-    [UsedImplicitly]
-    [HarmonyFinalizer]
-    [SuppressMessage("ReSharper", "InconsistentNaming")]
-    private static void Finalizer(Exception? __exception)
-    {
-        if (__exception != null)
-        {
-            Console.WriteLine($"Exception due to {nameof(FixDoubleSkipping)}: {__exception}");
-        }
+        return instructions;
     }
 }

Osu.Patcher.Hook/Patches/Misc/LogOsuLogger.cs

@@ -14,7 +14,7 @@ namespace Osu.Patcher.Hook.Patches.Misc;
 /// </summary>
 [HarmonyPatch]
 [UsedImplicitly]
-public static class LogOsuLogger
+internal class LogOsuLogger : OsuPatch
 {
     [UsedImplicitly]
     [HarmonyTargetMethod]

Osu.Patcher.Hook/Patches/Misc/LogSoftErrors.cs

@@ -11,7 +11,7 @@ namespace Osu.Patcher.Hook.Patches.Misc;
 /// </summary>
 [HarmonyPatch]
 [UsedImplicitly]
-public class LogSoftErrors
+internal class LogSoftErrors : OsuPatch
 {
     [UsedImplicitly]
     [HarmonyTargetMethod]

Osu.Patcher.Hook/Patches/Mods/PatchSuddenDeathAutoRetry.cs

@@ -1,6 +1,4 @@
-using System;
 using System.Collections.Generic;
-using System.Diagnostics.CodeAnalysis;
 using System.Reflection;
 using HarmonyLib;
 using JetBrains.Annotations;
@@ -25,7 +23,7 @@ namespace Osu.Patcher.Hook.Patches.Mods;
 /// </summary>
 [HarmonyPatch]
 [UsedImplicitly]
-public class PatchSuddenDeathAutoRetry
+internal class PatchSuddenDeathAutoRetry : OsuPatch
 {
     private const int ModPerfect = 1 << 14;
     private const int ModSuddenDeath = 1 << 5;
@@ -45,15 +43,4 @@ private static IEnumerable<CodeInstruction> Transpiler(IEnumerable<CodeInstructi
             inst => inst.opcode == Ldc_I4 && inst.OperandIs(ModPerfect),
             inst => inst.operand = ModPerfect | ModSuddenDeath
         );
-
-    [UsedImplicitly]
-    [HarmonyFinalizer]
-    [SuppressMessage("ReSharper", "InconsistentNaming")]
-    private static void Finalizer(Exception? __exception)
-    {
-        if (__exception != null)
-        {
-            Console.WriteLine($"Exception due to {nameof(PatchSuddenDeathAutoRetry)}: {__exception}");
-        }
-    }
 }

Osu.Patcher.Hook/Patches/OsuPatch.cs

@@ -0,0 +1,6 @@
+namespace Osu.Patcher.Hook.Patches;
+
+/// <summary>
+///     A base patch that provides utility methods for signature-based patching.
+/// </summary>
+public abstract class OsuPatch;

Osu.Patcher.Hook/Patches/OsuPatchProcessor.cs

@@ -0,0 +1,64 @@
+using System;
+using System.Collections.Generic;
+using System.Diagnostics.CodeAnalysis;
+using System.Reflection;
+using HarmonyLib;
+using JetBrains.Annotations;
+using Osu.Utils.Extensions;
+
+namespace Osu.Patcher.Hook.Patches;
+
+/// <summary>
+///     Custom patch processor to automatically add additional things to the target patches.
+/// </summary>
+public class OsuPatchProcessor : PatchClassProcessor
+{
+    // List<AttributePatch> HarmonyLib.PatchClassProcessor::patchMethods
+    private static readonly FieldInfo FieldPatchMethods = typeof(PatchClassProcessor)
+        .GetField("patchMethods", AccessTools.all)!;
+
+    // AttributePatch HarmonyLib.AttributePatch::Create(MethodInfo)
+    private static readonly MethodInfo MethodCreateAttributePatch =
+        AccessTools.Method("HarmonyLib.AttributePatch:Create");
+
+    // void OsuPatchProcessor::BaseFinalizer(Exception?)
+    private static readonly MethodInfo GenericMethodBaseFinalizer = typeof(OsuPatchProcessor)
+        .GetMethod("BaseFinalizer", AccessTools.all)!;
+
+    // void List<HarmonyLib.AttributePatch>::Add(HarmonyLib.AttributePatch)
+    private static readonly MethodInfo ListAttributePatchAdd = typeof(List<>)
+        .MakeGenericType([AccessTools.TypeByName("HarmonyLib.AttributePatch")])
+        .GetMethod("Add")!;
+
+    /// <summary>
+    ///     Create a new class patch processor that adds extra attribute patches to the patch.
+    /// </summary>
+    public OsuPatchProcessor(Harmony instance, Type type) : base(instance, type)
+    {
+        AddFinalizerPatch(type);
+    }
+
+    /// <summary>
+    ///     Adds a new <see cref="HarmonyFinalizer" /> attribute patch to the
+    ///     current patch processor targeting a specific <paramref name="type" />.
+    /// </summary>
+    private void AddFinalizerPatch(Type type)
+    {
+        var boundMethod = GenericMethodBaseFinalizer.MakeGenericMethod([type]);
+        var attributePatch = MethodCreateAttributePatch.Invoke<object>(null, [boundMethod]);
+
+        var attributePatches = FieldPatchMethods.GetValue(this)!;
+        ListAttributePatchAdd.Invoke(attributePatches, [attributePatch]);
+    }
+
+    [UsedImplicitly]
+    [HarmonyFinalizer]
+    [SuppressMessage("ReSharper", "InconsistentNaming")]
+    private static void BaseFinalizer<P>(Exception? __exception) where P : OsuPatch
+    {
+        if (__exception == null)
+            return;
+
+        Console.WriteLine($"[F] [Patch{typeof(P).Name}]: {__exception}");
+    }
+}