generalise CIL rewriters for reuse (#231)

6 files changed, 128 insertions, 92 deletions

diff --git a/src/StardewModdingAPI.AssemblyRewriters/IInstructionRewriter.cs b/src/StardewModdingAPI.AssemblyRewriters/IInstructionRewriter.cs
new file mode 100644
index 00000000..5c24acb6
--- /dev/null
+++ b/src/StardewModdingAPI.AssemblyRewriters/IInstructionRewriter.cs
@@ -0,0 +1,21 @@
+using Mono.Cecil;
+using Mono.Cecil.Cil;
+
+namespace StardewModdingAPI.AssemblyRewriters
+{
+    /// <summary>Rewrites a CIL instruction for compatibility.</summary>
+    public interface IInstructionRewriter
+    {
+        /// <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>
+        bool ShouldRewrite(Instruction instruction, bool 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>
+        void Rewrite(ModuleDefinition module, ILProcessor cil, Instruction instruction, PlatformAssemblyMap assemblyMap);
+    }
+}
diff --git a/src/StardewModdingAPI.AssemblyRewriters/IMethodRewriter.cs b/src/StardewModdingAPI.AssemblyRewriters/IMethodRewriter.cs
deleted file mode 100644
index 5cbb7e0d..00000000
--- a/src/StardewModdingAPI.AssemblyRewriters/IMethodRewriter.cs
+++ /dev/null
@@ -1,21 +0,0 @@
-using Mono.Cecil;
-using Mono.Cecil.Cil;
-
-namespace StardewModdingAPI.AssemblyRewriters
-{
-    /// <summary>Rewrites a method for compatibility.</summary>
-    public interface IMethodRewriter
-    {
-        /// <summary>Get whether the given method reference can be rewritten.</summary>
-        /// <param name="methodRef">The method reference.</param>
-        bool ShouldRewrite(MethodReference methodRef);
-
-        /// <summary>Rewrite a method for compatibility.</summary>
-        /// <param name="module">The module being rewritten.</param>
-        /// <param name="cil">The CIL rewriter.</param>
-        /// <param name="callOp">The instruction which calls the method.</param>
-        /// <param name="methodRef">The method reference invoked by the <paramref name="callOp"/>.</param>
-        /// <param name="assemblyMap">Metadata for mapping assemblies to the current platform.</param>
-        void Rewrite(ModuleDefinition module, ILProcessor cil, Instruction callOp, MethodReference methodRef, PlatformAssemblyMap assemblyMap);
-    }
-}
diff --git a/src/StardewModdingAPI.AssemblyRewriters/Rewriters/BaseMethodRewriter.cs b/src/StardewModdingAPI.AssemblyRewriters/Rewriters/BaseMethodRewriter.cs
index 1af6e6c4..e44acaf9 100644
--- a/src/StardewModdingAPI.AssemblyRewriters/Rewriters/BaseMethodRewriter.cs
+++ b/src/StardewModdingAPI.AssemblyRewriters/Rewriters/BaseMethodRewriter.cs
@@ -7,27 +7,52 @@ using Mono.Cecil.Cil;
 namespace StardewModdingAPI.AssemblyRewriters.Rewriters
 {
     /// <summary>Base class for a method rewriter.</summary>
-    public abstract class BaseMethodRewriter : IMethodRewriter
+    public abstract class BaseMethodRewriter : IInstructionRewriter
     {
         /*********
         ** Public methods
         *********/
-        /// <summary>Get whether the given method reference can be rewritten.</summary>
-        /// <param name="methodRef">The method reference.</param>
-        public abstract bool ShouldRewrite(MethodReference methodRef);
+        /// <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;
 
-        /// <summary>Rewrite a method for compatibility.</summary>
+            // 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="callOp">The instruction which calls the method.</param>
-        /// <param name="methodRef">The method reference invoked by the <paramref name="callOp"/>.</param>
+        /// <param name="instruction">The instruction to rewrite.</param>
         /// <param name="assemblyMap">Metadata for mapping assemblies to the current platform.</param>
-        public abstract void Rewrite(ModuleDefinition module, ILProcessor cil, Instruction callOp, MethodReference methodRef, PlatformAssemblyMap assemblyMap);
-
+        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 the given method reference can 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>
diff --git a/src/StardewModdingAPI.AssemblyRewriters/Rewriters/SpriteBatchRewriter.cs b/src/StardewModdingAPI.AssemblyRewriters/Rewriters/SpriteBatchRewriter.cs
index 1c0a5cf3..f64bf768 100644
--- a/src/StardewModdingAPI.AssemblyRewriters/Rewriters/SpriteBatchRewriter.cs
+++ b/src/StardewModdingAPI.AssemblyRewriters/Rewriters/SpriteBatchRewriter.cs
@@ -1,30 +1,94 @@
+using System.Diagnostics.CodeAnalysis;
+using Microsoft.Xna.Framework;
 using Microsoft.Xna.Framework.Graphics;
 using Mono.Cecil;
 using Mono.Cecil.Cil;
-using StardewModdingAPI.AssemblyRewriters.Wrappers;
 
 namespace StardewModdingAPI.AssemblyRewriters.Rewriters
 {
     /// <summary>Rewrites references to <see cref="SpriteBatch"/> to fix inconsistent method signatures between MonoGame and XNA.</summary>
-    /// <remarks>MonoGame has one <c>SpriteBatch.Begin</c> method with optional arguments, but XNA has multiple method overloads. Incompatible method references are rewritten to use <see cref="CompatibleSpriteBatch"/>, which redirects all method signatures to the proper compiled MonoGame/XNA method.</remarks>
+    /// <remarks>MonoGame has one <c>SpriteBatch.Begin</c> method with optional arguments, but XNA has multiple method overloads. Incompatible method references are rewritten to use <see cref="WrapperMethods"/>, which redirects all method signatures to the proper compiled MonoGame/XNA method.</remarks>
     public class SpriteBatchRewriter : BaseMethodRewriter
     {
+        /*********
+        ** Protected methods
+        *********/
         /// <summary>Get whether the given method reference can be rewritten.</summary>
         /// <param name="methodRef">The method reference.</param>
-        public override bool ShouldRewrite(MethodReference methodRef)
+        /// <param name="platformChanged">Whether the mod was compiled on a different platform.</param>
+        protected override bool ShouldRewrite(MethodReference methodRef, bool platformChanged)
         {
-            return methodRef.DeclaringType.FullName == typeof(SpriteBatch).FullName && this.HasMatchingSignature(typeof(CompatibleSpriteBatch), methodRef);
+            return platformChanged
+                && methodRef.DeclaringType.FullName == typeof(SpriteBatch).FullName
+                && this.HasMatchingSignature(typeof(SpriteBatchRewriter.WrapperMethods), methodRef);
         }
 
         /// <summary>Rewrite a method for compatibility.</summary>
         /// <param name="module">The module being rewritten.</param>
         /// <param name="cil">The CIL rewriter.</param>
-        /// <param name="callOp">The instruction which calls the method.</param>
-        /// <param name="methodRef">The method reference invoked by the <paramref name="callOp"/>.</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>
-        public override void Rewrite(ModuleDefinition module, ILProcessor cil, Instruction callOp, MethodReference methodRef, PlatformAssemblyMap assemblyMap)
+        protected override void Rewrite(ModuleDefinition module, ILProcessor cil, Instruction instruction, MethodReference methodRef, PlatformAssemblyMap assemblyMap)
         {
-            methodRef.DeclaringType = module.Import(typeof(CompatibleSpriteBatch));
+            methodRef.DeclaringType = module.Import(typeof(SpriteBatchRewriter.WrapperMethods));
+        }
+
+
+        /*********
+        ** Wrapper methods
+        *********/
+        /// <summary>Wraps <see cref="SpriteBatch"/> methods that are incompatible when converting compiled code between MonoGame and XNA.</summary>
+        public class WrapperMethods : SpriteBatch
+        {
+            /*********
+            ** Public methods
+            *********/
+            /// <summary>Construct an instance.</summary>
+            public WrapperMethods(GraphicsDevice graphicsDevice) : base(graphicsDevice) { }
+
+
+            /****
+            ** MonoGame signatures
+            ****/
+            [SuppressMessage("ReSharper", "CS0109", Justification = "The 'new' modifier applies when compiled on Linux/Mac.")]
+            public new void Begin(SpriteSortMode sortMode, BlendState blendState, SamplerState samplerState, DepthStencilState depthStencilState, RasterizerState rasterizerState, Effect effect, Matrix? matrix)
+            {
+                base.Begin(sortMode, blendState, samplerState, depthStencilState, rasterizerState, effect, matrix ?? Matrix.Identity);
+            }
+
+            /****
+            ** XNA signatures
+            ****/
+            [SuppressMessage("ReSharper", "CS0109", Justification = "The 'new' modifier applies when compiled on Windows.")]
+            public new void Begin()
+            {
+                base.Begin();
+            }
+
+            [SuppressMessage("ReSharper", "CS0109", Justification = "The 'new' modifier applies when compiled on Windows.")]
+            public new void Begin(SpriteSortMode sortMode, BlendState blendState)
+            {
+                base.Begin(sortMode, blendState);
+            }
+
+            [SuppressMessage("ReSharper", "CS0109", Justification = "The 'new' modifier applies when compiled on Windows.")]
+            public new void Begin(SpriteSortMode sortMode, BlendState blendState, SamplerState samplerState, DepthStencilState depthStencilState, RasterizerState rasterizerState)
+            {
+                base.Begin(sortMode, blendState, samplerState, depthStencilState, rasterizerState);
+            }
+
+            [SuppressMessage("ReSharper", "CS0109", Justification = "The 'new' modifier applies when compiled on Windows.")]
+            public new void Begin(SpriteSortMode sortMode, BlendState blendState, SamplerState samplerState, DepthStencilState depthStencilState, RasterizerState rasterizerState, Effect effect)
+            {
+                base.Begin(sortMode, blendState, samplerState, depthStencilState, rasterizerState, effect);
+            }
+
+            [SuppressMessage("ReSharper", "CS0109", Justification = "The 'new' modifier applies when compiled on Windows.")]
+            public new void Begin(SpriteSortMode sortMode, BlendState blendState, SamplerState samplerState, DepthStencilState depthStencilState, RasterizerState rasterizerState, Effect effect, Matrix transformMatrix)
+            {
+                base.Begin(sortMode, blendState, samplerState, depthStencilState, rasterizerState, effect, transformMatrix);
+            }
         }
     }
 }
\ No newline at end of file
diff --git a/src/StardewModdingAPI.AssemblyRewriters/StardewModdingAPI.AssemblyRewriters.csproj b/src/StardewModdingAPI.AssemblyRewriters/StardewModdingAPI.AssemblyRewriters.csproj
index 1e6caacc..01ca1d66 100644
--- a/src/StardewModdingAPI.AssemblyRewriters/StardewModdingAPI.AssemblyRewriters.csproj
+++ b/src/StardewModdingAPI.AssemblyRewriters/StardewModdingAPI.AssemblyRewriters.csproj
@@ -70,13 +70,12 @@
     <Compile Include="..\GlobalAssemblyInfo.cs">
       <Link>Properties\GlobalAssemblyInfo.cs</Link>
     </Compile>
-    <Compile Include="IMethodRewriter.cs" />
+    <Compile Include="IInstructionRewriter.cs" />
     <Compile Include="Platform.cs" />
     <Compile Include="PlatformAssemblyMap.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />
     <Compile Include="Rewriters\BaseMethodRewriter.cs" />
     <Compile Include="Rewriters\SpriteBatchRewriter.cs" />
-    <Compile Include="Wrappers\CompatibleSpriteBatch.cs" />
   </ItemGroup>
   <ItemGroup>
     <None Include="packages.config" />
diff --git a/src/StardewModdingAPI.AssemblyRewriters/Wrappers/CompatibleSpriteBatch.cs b/src/StardewModdingAPI.AssemblyRewriters/Wrappers/CompatibleSpriteBatch.cs
deleted file mode 100644
index e28d1a68..00000000
--- a/src/StardewModdingAPI.AssemblyRewriters/Wrappers/CompatibleSpriteBatch.cs
+++ /dev/null
@@ -1,52 +0,0 @@
-using Microsoft.Xna.Framework;
-using Microsoft.Xna.Framework.Graphics;
-
-#pragma warning disable CS0109 // Member does not hide an inherited member; new keyword is not required
-namespace StardewModdingAPI.AssemblyRewriters.Wrappers
-{
-    /// <summary>Wraps <see cref="SpriteBatch"/> methods that are incompatible when converting compiled code between MonoGame and XNA.</summary>
-    public class CompatibleSpriteBatch : SpriteBatch
-    {
-        /*********
-        ** Public methods
-        *********/
-        /// <summary>Construct an instance.</summary>
-        public CompatibleSpriteBatch(GraphicsDevice graphicsDevice) : base(graphicsDevice) { }
-
-        /****
-        ** MonoGame signatures
-        ****/
-        public new void Begin(SpriteSortMode sortMode, BlendState blendState, SamplerState samplerState, DepthStencilState depthStencilState, RasterizerState rasterizerState, Effect effect, Matrix? matrix)
-        {
-            base.Begin(sortMode, blendState, samplerState, depthStencilState, rasterizerState, effect, matrix ?? Matrix.Identity);
-        }
-
-        /****
-        ** XNA signatures
-        ****/
-        public new void Begin()
-        {
-            base.Begin();
-        }
-
-        public new void Begin(SpriteSortMode sortMode, BlendState blendState)
-        {
-            base.Begin(sortMode, blendState);
-        }
-
-        public new void Begin(SpriteSortMode sortMode, BlendState blendState, SamplerState samplerState, DepthStencilState depthStencilState, RasterizerState rasterizerState)
-        {
-            base.Begin(sortMode, blendState, samplerState, depthStencilState, rasterizerState);
-        }
-
-        public new void Begin(SpriteSortMode sortMode, BlendState blendState, SamplerState samplerState, DepthStencilState depthStencilState, RasterizerState rasterizerState, Effect effect)
-        {
-            base.Begin(sortMode, blendState, samplerState, depthStencilState, rasterizerState, effect);
-        }
-
-        public new void Begin(SpriteSortMode sortMode, BlendState blendState, SamplerState samplerState, DepthStencilState depthStencilState, RasterizerState rasterizerState, Effect effect, Matrix transformMatrix)
-        {
-            base.Begin(sortMode, blendState, samplerState, depthStencilState, rasterizerState, effect, transformMatrix);
-        }
-    }
-}
\ No newline at end of file