summaryrefslogtreecommitdiff
path: root/src/StardewModdingAPI.AssemblyRewriters/Rewriters
diff options
context:
space:
mode:
Diffstat (limited to 'src/StardewModdingAPI.AssemblyRewriters/Rewriters')
-rw-r--r--src/StardewModdingAPI.AssemblyRewriters/Rewriters/FieldReplaceRewriter.cs53
-rw-r--r--src/StardewModdingAPI.AssemblyRewriters/Rewriters/FieldToPropertyRewriter.cs54
-rw-r--r--src/StardewModdingAPI.AssemblyRewriters/Rewriters/MethodParentRewriter.cs93
-rw-r--r--src/StardewModdingAPI.AssemblyRewriters/Rewriters/TypeReferenceRewriter.cs157
-rw-r--r--src/StardewModdingAPI.AssemblyRewriters/Rewriters/Wrappers/SpriteBatchWrapper.cs59
5 files changed, 0 insertions, 416 deletions
diff --git a/src/StardewModdingAPI.AssemblyRewriters/Rewriters/FieldReplaceRewriter.cs b/src/StardewModdingAPI.AssemblyRewriters/Rewriters/FieldReplaceRewriter.cs
deleted file mode 100644
index 73844073..00000000
--- a/src/StardewModdingAPI.AssemblyRewriters/Rewriters/FieldReplaceRewriter.cs
+++ /dev/null
@@ -1,53 +0,0 @@
-using System;
-using System.Reflection;
-using Mono.Cecil;
-using Mono.Cecil.Cil;
-using StardewModdingAPI.AssemblyRewriters.Finders;
-
-namespace StardewModdingAPI.AssemblyRewriters.Rewriters
-{
- /// <summary>Rewrites references to one field with another.</summary>
- public class FieldReplaceRewriter : FieldFinder
- {
- /*********
- ** Properties
- *********/
- /// <summary>The new field to reference.</summary>
- private readonly FieldInfo ToField;
-
-
- /*********
- ** Public methods
- *********/
- /// <summary>Construct an instance.</summary>
- /// <param name="type">The type whose field to which references should be rewritten.</param>
- /// <param name="fromFieldName">The field name to rewrite.</param>
- /// <param name="toFieldName">The new field name to reference.</param>
- /// <param name="nounPhrase">A brief noun phrase indicating what the instruction finder matches (or <c>null</c> to generate one).</param>
- public FieldReplaceRewriter(Type type, string fromFieldName, string toFieldName, string nounPhrase = null)
- : base(type.FullName, fromFieldName, nounPhrase)
- {
- this.ToField = type.GetField(toFieldName);
- if (this.ToField == null)
- throw new InvalidOperationException($"The {type.FullName} class doesn't have a {toFieldName} field.");
- }
-
- /// <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>
- /// <param name="platformChanged">Whether the mod was compiled on a different platform.</param>
- /// <returns>Returns whether the instruction was rewritten.</returns>
- /// <exception cref="IncompatibleInstructionException">The CIL instruction is not compatible, and can't be rewritten.</exception>
- public override bool Rewrite(ModuleDefinition module, ILProcessor cil, Instruction instruction, PlatformAssemblyMap assemblyMap, bool platformChanged)
- {
- if (!this.IsMatch(instruction))
- return false;
-
- FieldReference newRef = module.Import(this.ToField);
- cil.Replace(instruction, cil.Create(instruction.OpCode, newRef));
- return true;
- }
- }
-}
diff --git a/src/StardewModdingAPI.AssemblyRewriters/Rewriters/FieldToPropertyRewriter.cs b/src/StardewModdingAPI.AssemblyRewriters/Rewriters/FieldToPropertyRewriter.cs
deleted file mode 100644
index 3f57042d..00000000
--- a/src/StardewModdingAPI.AssemblyRewriters/Rewriters/FieldToPropertyRewriter.cs
+++ /dev/null
@@ -1,54 +0,0 @@
-using System;
-using Mono.Cecil;
-using Mono.Cecil.Cil;
-using StardewModdingAPI.AssemblyRewriters.Finders;
-
-namespace StardewModdingAPI.AssemblyRewriters.Rewriters
-{
- /// <summary>Rewrites field references into property references.</summary>
- public class FieldToPropertyRewriter : FieldFinder
- {
- /*********
- ** Properties
- *********/
- /// <summary>The type whose field to which references should be rewritten.</summary>
- private readonly Type Type;
-
- /// <summary>The field name to rewrite.</summary>
- private readonly string FieldName;
-
-
- /*********
- ** Public methods
- *********/
- /// <summary>Construct an instance.</summary>
- /// <param name="type">The type whose field to which references should be rewritten.</param>
- /// <param name="fieldName">The field name to rewrite.</param>
- /// <param name="nounPhrase">A brief noun phrase indicating what the instruction finder matches (or <c>null</c> to generate one).</param>
- public FieldToPropertyRewriter(Type type, string fieldName, string nounPhrase = null)
- : base(type.FullName, fieldName, nounPhrase)
- {
- this.Type = type;
- this.FieldName = fieldName;
- }
-
- /// <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>
- /// <param name="platformChanged">Whether the mod was compiled on a different platform.</param>
- /// <returns>Returns whether the instruction was rewritten.</returns>
- /// <exception cref="IncompatibleInstructionException">The CIL instruction is not compatible, and can't be rewritten.</exception>
- public override bool Rewrite(ModuleDefinition module, ILProcessor cil, Instruction instruction, PlatformAssemblyMap assemblyMap, bool platformChanged)
- {
- if (!this.IsMatch(instruction))
- return false;
-
- string methodPrefix = instruction.OpCode == OpCodes.Ldsfld || instruction.OpCode == OpCodes.Ldfld ? "get" : "set";
- MethodReference propertyRef = module.Import(this.Type.GetMethod($"{methodPrefix}_{this.FieldName}"));
- cil.Replace(instruction, cil.Create(OpCodes.Call, propertyRef));
- return true;
- }
- }
-}
diff --git a/src/StardewModdingAPI.AssemblyRewriters/Rewriters/MethodParentRewriter.cs b/src/StardewModdingAPI.AssemblyRewriters/Rewriters/MethodParentRewriter.cs
deleted file mode 100644
index 035ef211..00000000
--- a/src/StardewModdingAPI.AssemblyRewriters/Rewriters/MethodParentRewriter.cs
+++ /dev/null
@@ -1,93 +0,0 @@
-using System;
-using Mono.Cecil;
-using Mono.Cecil.Cil;
-
-namespace StardewModdingAPI.AssemblyRewriters.Rewriters
-{
- /// <summary>Rewrites method references from one parent type to another if the signatures match.</summary>
- public class MethodParentRewriter : IInstructionRewriter
- {
- /*********
- ** Properties
- *********/
- /// <summary>The type whose methods to remap.</summary>
- private readonly Type FromType;
-
- /// <summary>The type with methods to map to.</summary>
- private readonly Type ToType;
-
- /// <summary>Whether to only rewrite references if loading the assembly on a different platform than it was compiled on.</summary>
- private readonly bool OnlyIfPlatformChanged;
-
-
- /*********
- ** Accessors
- *********/
- /// <summary>A brief noun phrase indicating what the instruction finder matches.</summary>
- public string NounPhrase { get; }
-
-
- /*********
- ** Public methods
- *********/
- /// <summary>Construct an instance.</summary>
- /// <param name="fromType">The type whose methods to remap.</param>
- /// <param name="toType">The type with methods to map to.</param>
- /// <param name="onlyIfPlatformChanged">Whether to only rewrite references if loading the assembly on a different platform than it was compiled on.</param>
- /// <param name="nounPhrase">A brief noun phrase indicating what the instruction finder matches (or <c>null</c> to generate one).</param>
- public MethodParentRewriter(Type fromType, Type toType, bool onlyIfPlatformChanged = false, string nounPhrase = null)
- {
- this.FromType = fromType;
- this.ToType = toType;
- this.NounPhrase = nounPhrase ?? $"{fromType.Name} methods";
- this.OnlyIfPlatformChanged = onlyIfPlatformChanged;
- }
-
- /// <summary>Rewrite a method definition for compatibility.</summary>
- /// <param name="module">The module being rewritten.</param>
- /// <param name="method">The method definition to rewrite.</param>
- /// <param name="assemblyMap">Metadata for mapping assemblies to the current platform.</param>
- /// <param name="platformChanged">Whether the mod was compiled on a different platform.</param>
- /// <returns>Returns whether the instruction was rewritten.</returns>
- /// <exception cref="IncompatibleInstructionException">The CIL instruction is not compatible, and can't be rewritten.</exception>
- public bool Rewrite(ModuleDefinition module, MethodDefinition method, PlatformAssemblyMap assemblyMap, bool platformChanged)
- {
- return false;
- }
-
- /// <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>
- /// <param name="platformChanged">Whether the mod was compiled on a different platform.</param>
- /// <returns>Returns whether the instruction was rewritten.</returns>
- /// <exception cref="IncompatibleInstructionException">The CIL instruction is not compatible, and can't be rewritten.</exception>
- public bool Rewrite(ModuleDefinition module, ILProcessor cil, Instruction instruction, PlatformAssemblyMap assemblyMap, bool platformChanged)
- {
- if (!this.IsMatch(instruction, platformChanged))
- return false;
-
- MethodReference methodRef = (MethodReference)instruction.Operand;
- methodRef.DeclaringType = module.Import(this.ToType);
- return true;
- }
-
-
- /*********
- ** Protected methods
- *********/
- /// <summary>Get whether a CIL instruction matches.</summary>
- /// <param name="instruction">The IL instruction.</param>
- /// <param name="platformChanged">Whether the mod was compiled on a different platform.</param>
- protected bool IsMatch(Instruction instruction, bool platformChanged)
- {
- MethodReference methodRef = RewriteHelper.AsMethodReference(instruction);
- return
- methodRef != null
- && (platformChanged || !this.OnlyIfPlatformChanged)
- && methodRef.DeclaringType.FullName == this.FromType.FullName
- && RewriteHelper.HasMatchingSignature(this.ToType, methodRef);
- }
- }
-}
diff --git a/src/StardewModdingAPI.AssemblyRewriters/Rewriters/TypeReferenceRewriter.cs b/src/StardewModdingAPI.AssemblyRewriters/Rewriters/TypeReferenceRewriter.cs
deleted file mode 100644
index da6d9bc9..00000000
--- a/src/StardewModdingAPI.AssemblyRewriters/Rewriters/TypeReferenceRewriter.cs
+++ /dev/null
@@ -1,157 +0,0 @@
-using System;
-using Mono.Cecil;
-using Mono.Cecil.Cil;
-using StardewModdingAPI.AssemblyRewriters.Finders;
-
-namespace StardewModdingAPI.AssemblyRewriters.Rewriters
-{
- /// <summary>Rewrites all references to a type.</summary>
- public class TypeReferenceRewriter : TypeFinder
- {
- /*********
- ** Properties
- *********/
- /// <summary>The full type name to which to find references.</summary>
- private readonly string FromTypeName;
-
- /// <summary>The new type to reference.</summary>
- private readonly Type ToType;
-
-
- /*********
- ** Public methods
- *********/
- /// <summary>Construct an instance.</summary>
- /// <param name="fromTypeFullName">The full type name to which to find references.</param>
- /// <param name="toType">The new type to reference.</param>
- /// <param name="nounPhrase">A brief noun phrase indicating what the instruction finder matches (or <c>null</c> to generate one).</param>
- public TypeReferenceRewriter(string fromTypeFullName, Type toType, string nounPhrase = null)
- : base(fromTypeFullName, nounPhrase)
- {
- this.FromTypeName = fromTypeFullName;
- this.ToType = toType;
- }
-
- /// <summary>Rewrite a method definition for compatibility.</summary>
- /// <param name="module">The module being rewritten.</param>
- /// <param name="method">The method definition to rewrite.</param>
- /// <param name="assemblyMap">Metadata for mapping assemblies to the current platform.</param>
- /// <param name="platformChanged">Whether the mod was compiled on a different platform.</param>
- /// <returns>Returns whether the instruction was rewritten.</returns>
- /// <exception cref="IncompatibleInstructionException">The CIL instruction is not compatible, and can't be rewritten.</exception>
- public override bool Rewrite(ModuleDefinition module, MethodDefinition method, PlatformAssemblyMap assemblyMap, bool platformChanged)
- {
- bool rewritten = false;
-
- // return type
- if (this.IsMatch(method.ReturnType))
- {
- method.ReturnType = this.RewriteIfNeeded(module, method.ReturnType);
- rewritten = true;
- }
-
- // parameters
- foreach (ParameterDefinition parameter in method.Parameters)
- {
- if (this.IsMatch(parameter.ParameterType))
- {
- parameter.ParameterType = this.RewriteIfNeeded(module, parameter.ParameterType);
- rewritten = true;
- }
- }
-
- // generic parameters
- for (int i = 0; i < method.GenericParameters.Count; i++)
- {
- var parameter = method.GenericParameters[i];
- if (this.IsMatch(parameter))
- {
- TypeReference newType = this.RewriteIfNeeded(module, parameter);
- if (newType != parameter)
- method.GenericParameters[i] = new GenericParameter(parameter.Name, newType);
- rewritten = true;
- }
- }
-
- // local variables
- foreach (VariableDefinition variable in method.Body.Variables)
- {
- if (this.IsMatch(variable.VariableType))
- {
- variable.VariableType = this.RewriteIfNeeded(module, variable.VariableType);
- rewritten = true;
- }
- }
-
- return rewritten;
- }
-
- /// <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>
- /// <param name="platformChanged">Whether the mod was compiled on a different platform.</param>
- /// <returns>Returns whether the instruction was rewritten.</returns>
- /// <exception cref="IncompatibleInstructionException">The CIL instruction is not compatible, and can't be rewritten.</exception>
- public override bool Rewrite(ModuleDefinition module, ILProcessor cil, Instruction instruction, PlatformAssemblyMap assemblyMap, bool platformChanged)
- {
- if (!this.IsMatch(instruction) && !instruction.ToString().Contains(this.FromTypeName))
- return false;
-
- // field reference
- FieldReference fieldRef = RewriteHelper.AsFieldReference(instruction);
- if (fieldRef != null)
- {
- fieldRef.DeclaringType = this.RewriteIfNeeded(module, fieldRef.DeclaringType);
- fieldRef.FieldType = this.RewriteIfNeeded(module, fieldRef.FieldType);
- }
-
- // method reference
- MethodReference methodRef = RewriteHelper.AsMethodReference(instruction);
- if (methodRef != null)
- {
- methodRef.DeclaringType = this.RewriteIfNeeded(module, methodRef.DeclaringType);
- methodRef.ReturnType = this.RewriteIfNeeded(module, methodRef.ReturnType);
- foreach (var parameter in methodRef.Parameters)
- parameter.ParameterType = this.RewriteIfNeeded(module, parameter.ParameterType);
- }
-
- // type reference
- if (instruction.Operand is TypeReference typeRef)
- {
- TypeReference newRef = this.RewriteIfNeeded(module, typeRef);
- if (typeRef != newRef)
- cil.Replace(instruction, cil.Create(instruction.OpCode, newRef));
- }
-
- return true;
- }
-
- /*********
- ** Private methods
- *********/
- /// <summary>Get the adjusted type reference if it matches, else the same value.</summary>
- /// <param name="module">The module being rewritten.</param>
- /// <param name="type">The type to replace if it matches.</param>
- private TypeReference RewriteIfNeeded(ModuleDefinition module, TypeReference type)
- {
- // root type
- if (type.FullName == this.FromTypeName)
- return module.Import(this.ToType);
-
- // generic arguments
- if (type is GenericInstanceType genericType)
- {
- for (int i = 0; i < genericType.GenericArguments.Count; i++)
- genericType.GenericArguments[i] = this.RewriteIfNeeded(module, genericType.GenericArguments[i]);
- }
-
- // generic parameters (e.g. constraints)
- for (int i = 0; i < type.GenericParameters.Count; i++)
- type.GenericParameters[i] = new GenericParameter(this.RewriteIfNeeded(module, type.GenericParameters[i]));
-
- return type;
- }
- }
-}
diff --git a/src/StardewModdingAPI.AssemblyRewriters/Rewriters/Wrappers/SpriteBatchWrapper.cs b/src/StardewModdingAPI.AssemblyRewriters/Rewriters/Wrappers/SpriteBatchWrapper.cs
deleted file mode 100644
index ee68f1d5..00000000
--- a/src/StardewModdingAPI.AssemblyRewriters/Rewriters/Wrappers/SpriteBatchWrapper.cs
+++ /dev/null
@@ -1,59 +0,0 @@
-using System.Diagnostics.CodeAnalysis;
-using Microsoft.Xna.Framework;
-using Microsoft.Xna.Framework.Graphics;
-
-namespace StardewModdingAPI.AssemblyRewriters.Rewriters.Wrappers
-{
- /// <summary>Wraps <see cref="SpriteBatch"/> methods that are incompatible when converting compiled code between MonoGame and XNA.</summary>
- public class SpriteBatchWrapper : SpriteBatch
- {
- /*********
- ** Public methods
- *********/
- /// <summary>Construct an instance.</summary>
- public SpriteBatchWrapper(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