From 74a56a7b3b3bde30fbcb711eaef977ad69601e03 Mon Sep 17 00:00:00 2001
From: Jesse Plamondon-Willard <github@jplamondonw.com>
Date: Thu, 9 Feb 2017 14:02:43 -0500
Subject: further generalise CIL rewriters for reuse (#231)

---
 .../Framework/BaseMethodRewriter.cs                | 89 ++++++++++++++++++++++
 .../Framework/RewriteHelper.cs                     | 41 ++++++++++
 2 files changed, 130 insertions(+)
 create mode 100644 src/StardewModdingAPI.AssemblyRewriters/Framework/BaseMethodRewriter.cs
 create mode 100644 src/StardewModdingAPI.AssemblyRewriters/Framework/RewriteHelper.cs

(limited to 'src/StardewModdingAPI.AssemblyRewriters/Framework')

diff --git a/src/StardewModdingAPI.AssemblyRewriters/Framework/BaseMethodRewriter.cs b/src/StardewModdingAPI.AssemblyRewriters/Framework/BaseMethodRewriter.cs
new file mode 100644
index 00000000..c9729ee8
--- /dev/null
+++ b/src/StardewModdingAPI.AssemblyRewriters/Framework/BaseMethodRewriter.cs
@@ -0,0 +1,89 @@
+using System;
+using System.Linq;
+using System.Reflection;
+using Mono.Cecil;
+using Mono.Cecil.Cil;
+
+namespace StardewModdingAPI.AssemblyRewriters.Framework
+{
+    /// <summary>Base class for a method rewriter.</summary>
+    public abstract class BaseMethodRewriter : IInstructionRewriter
+    {
+        /*********
+        ** Public methods
+        *********/
+        /// <summary>Get whether a CIL instruction should be rewritten.</summary>
+        /// <param name="instruction">The IL instruction.</param>
+        /// <param name="platformChanged">Whether the mod was compiled on a different platform.</param>
+        public bool ShouldRewrite(Instruction instruction, bool platformChanged)
+        {
+            // ignore non-method-call instructions
+            if (instruction.OpCode != OpCodes.Call && instruction.OpCode != OpCodes.Callvirt)
+                return false;
+
+            // check reference
+            MethodReference methodRef = (MethodReference)instruction.Operand;
+            return this.ShouldRewrite(methodRef, platformChanged);
+        }
+
+        /// <summary>Rewrite a CIL instruction for compatibility.</summary>
+        /// <param name="module">The module being rewritten.</param>
+        /// <param name="cil">The CIL rewriter.</param>
+        /// <param name="instruction">The instruction to rewrite.</param>
+        /// <param name="assemblyMap">Metadata for mapping assemblies to the current platform.</param>
+        public void Rewrite(ModuleDefinition module, ILProcessor cil, Instruction instruction, PlatformAssemblyMap assemblyMap)
+        {
+            MethodReference methodRef = (MethodReference)instruction.Operand;
+            this.Rewrite(module, cil, instruction, methodRef, assemblyMap);
+        }
+
+
+        /*********
+        ** Protected methods
+        *********/
+        /// <summary>Get whether a method reference should be rewritten.</summary>
+        /// <param name="methodRef">The method reference.</param>
+        /// <param name="platformChanged">Whether the mod was compiled on a different platform.</param>
+        protected abstract bool ShouldRewrite(MethodReference methodRef, bool platformChanged);
+
+        /// <summary>Rewrite a method for compatibility.</summary>
+        /// <param name="module">The module being rewritten.</param>
+        /// <param name="cil">The CIL rewriter.</param>
+        /// <param name="instruction">The instruction which calls the method.</param>
+        /// <param name="methodRef">The method reference invoked by the <paramref name="instruction"/>.</param>
+        /// <param name="assemblyMap">Metadata for mapping assemblies to the current platform.</param>
+        protected abstract void Rewrite(ModuleDefinition module, ILProcessor cil, Instruction instruction, MethodReference methodRef, PlatformAssemblyMap assemblyMap);
+
+        /// <summary>Get whether a method definition matches the signature expected by a method reference.</summary>
+        /// <param name="definition">The method definition.</param>
+        /// <param name="reference">The method reference.</param>
+        protected bool HasMatchingSignature(MethodInfo definition, MethodReference reference)
+        {
+            // same name
+            if (definition.Name != reference.Name)
+                return false;
+
+            // same arguments
+            ParameterInfo[] definitionParameters = definition.GetParameters();
+            ParameterDefinition[] referenceParameters = reference.Parameters.ToArray();
+            if (referenceParameters.Length != definitionParameters.Length)
+                return false;
+            for (int i = 0; i < referenceParameters.Length; i++)
+            {
+                if (!RewriteHelper.IsMatchingType(definitionParameters[i].ParameterType, referenceParameters[i].ParameterType))
+                    return false;
+            }
+            return true;
+        }
+
+        /// <summary>Get whether a type has a method whose signature matches the one expected by a method reference.</summary>
+        /// <param name="type">The type to check.</param>
+        /// <param name="reference">The method reference.</param>
+        protected bool HasMatchingSignature(Type type, MethodReference reference)
+        {
+            return type
+                .GetMethods(BindingFlags.Instance | BindingFlags.DeclaredOnly | BindingFlags.Public)
+                .Any(method => this.HasMatchingSignature(method, reference));
+        }
+    }
+}
diff --git a/src/StardewModdingAPI.AssemblyRewriters/Framework/RewriteHelper.cs b/src/StardewModdingAPI.AssemblyRewriters/Framework/RewriteHelper.cs
new file mode 100644
index 00000000..0307053f
--- /dev/null
+++ b/src/StardewModdingAPI.AssemblyRewriters/Framework/RewriteHelper.cs
@@ -0,0 +1,41 @@
+using System;
+using Mono.Cecil;
+
+namespace StardewModdingAPI.AssemblyRewriters.Framework
+{
+    /// <summary>Provides helper methods for field rewriters.</summary>
+    internal static class RewriteHelper
+    {
+        /*********
+        ** Public methods
+        *********/
+        /// <summary>Get whether a type matches a type reference.</summary>
+        /// <param name="type">The defined type.</param>
+        /// <param name="reference">The type reference.</param>
+        public static bool IsMatchingType(Type type, TypeReference reference)
+        {
+            // same namespace & name
+            if (type.Namespace != reference.Namespace || type.Name != reference.Name)
+                return false;
+
+            // same generic parameters
+            if (type.IsGenericType)
+            {
+                if (!reference.IsGenericInstance)
+                    return false;
+
+                Type[] defGenerics = type.GetGenericArguments();
+                TypeReference[] refGenerics = ((GenericInstanceType)reference).GenericArguments.ToArray();
+                if (defGenerics.Length != refGenerics.Length)
+                    return false;
+                for (int i = 0; i < defGenerics.Length; i++)
+                {
+                    if (!RewriteHelper.IsMatchingType(defGenerics[i], refGenerics[i]))
+                        return false;
+                }
+            }
+
+            return true;
+        }
+    }
+}
-- 
cgit