migrate to the new Harmony patch pattern used in my mods

That improves validation and error-handling.

1 files changed, 54 insertions, 0 deletions

diff --git a/src/SMAPI.Internal.Patching/BasePatcher.cs b/src/SMAPI.Internal.Patching/BasePatcher.cs
new file mode 100644
index 00000000..87155d7f
--- /dev/null
+++ b/src/SMAPI.Internal.Patching/BasePatcher.cs
@@ -0,0 +1,54 @@
+using System;
+using System.Reflection;
+using HarmonyLib;
+
+namespace StardewModdingAPI.Internal.Patching
+{
+    /// <summary>Provides base implementation logic for <see cref="IPatcher"/> instances.</summary>
+    internal abstract class BasePatcher : IPatcher
+    {
+        /*********
+        ** Public methods
+        *********/
+        /// <inheritdoc />
+        public abstract void Apply(Harmony harmony, IMonitor monitor);
+
+
+        /*********
+        ** Protected methods
+        *********/
+        /// <summary>Get a method and assert that it was found.</summary>
+        /// <typeparam name="TTarget">The type containing the method.</typeparam>
+        /// <param name="parameters">The method parameter types, or <c>null</c> if it's not overloaded.</param>
+        protected ConstructorInfo RequireConstructor<TTarget>(params Type[] parameters)
+        {
+            return PatchHelper.RequireConstructor<TTarget>(parameters);
+        }
+
+        /// <summary>Get a method and assert that it was found.</summary>
+        /// <typeparam name="TTarget">The type containing the method.</typeparam>
+        /// <param name="name">The method name.</param>
+        /// <param name="parameters">The method parameter types, or <c>null</c> if it's not overloaded.</param>
+        /// <param name="generics">The method generic types, or <c>null</c> if it's not generic.</param>
+        protected MethodInfo RequireMethod<TTarget>(string name, Type[] parameters = null, Type[] generics = null)
+        {
+            return PatchHelper.RequireMethod<TTarget>(name, parameters, generics);
+        }
+
+        /// <summary>Get a Harmony patch method on the current patcher instance.</summary>
+        /// <param name="name">The method name.</param>
+        /// <param name="priority">The patch priority to apply, usually specified using Harmony's <see cref="Priority"/> enum, or <c>null</c> to keep the default value.</param>
+        protected HarmonyMethod GetHarmonyMethod(string name, int? priority = null)
+        {
+            var method = new HarmonyMethod(
+                AccessTools.Method(this.GetType(), name)
+                ?? throw new InvalidOperationException($"Can't find patcher method {PatchHelper.GetMethodString(this.GetType(), name)}.")
+            );
+
+            if (priority.HasValue)
+                method.priority = priority.Value;
+
+            return method;
+        }
+    }
+}