summaryrefslogtreecommitdiff
path: root/src/SMAPI/Framework/ModLoading/Rewriters/MethodParentRewriter.cs
diff options
context:
space:
mode:
authorJesse Plamondon-Willard <Pathoschild@users.noreply.github.com>2020-05-20 19:38:08 -0400
committerJesse Plamondon-Willard <Pathoschild@users.noreply.github.com>2020-05-20 19:38:08 -0400
commit310eb1fe9afdb820d5584a46200bf073fc00ccb7 (patch)
tree72c16c6d4f8447f45e8e6612cb25cd255d2b308c /src/SMAPI/Framework/ModLoading/Rewriters/MethodParentRewriter.cs
parentaa5cc2c9be8bdc79c6fa7b1b9c2581a05b88117d (diff)
parentc5c30189e43f93c3f3c66207945187a974656c9e (diff)
downloadSMAPI-310eb1fe9afdb820d5584a46200bf073fc00ccb7.tar.gz
SMAPI-310eb1fe9afdb820d5584a46200bf073fc00ccb7.tar.bz2
SMAPI-310eb1fe9afdb820d5584a46200bf073fc00ccb7.zip
Merge branch 'mod/harmony-2.0' into develop
# Conflicts: # docs/release-notes.md # src/SMAPI/Framework/ModLoading/AssemblyLoader.cs
Diffstat (limited to 'src/SMAPI/Framework/ModLoading/Rewriters/MethodParentRewriter.cs')
-rw-r--r--src/SMAPI/Framework/ModLoading/Rewriters/MethodParentRewriter.cs71
1 files changed, 29 insertions, 42 deletions
diff --git a/src/SMAPI/Framework/ModLoading/Rewriters/MethodParentRewriter.cs b/src/SMAPI/Framework/ModLoading/Rewriters/MethodParentRewriter.cs
index 6b8c2de1..b8e53f40 100644
--- a/src/SMAPI/Framework/ModLoading/Rewriters/MethodParentRewriter.cs
+++ b/src/SMAPI/Framework/ModLoading/Rewriters/MethodParentRewriter.cs
@@ -1,31 +1,23 @@
using System;
+using System.Linq;
using Mono.Cecil;
using Mono.Cecil.Cil;
+using StardewModdingAPI.Framework.ModLoading.Framework;
namespace StardewModdingAPI.Framework.ModLoading.Rewriters
{
/// <summary>Rewrites method references from one parent type to another if the signatures match.</summary>
- internal class MethodParentRewriter : IInstructionHandler
+ internal class MethodParentRewriter : BaseInstructionHandler
{
/*********
** Fields
*********/
- /// <summary>The type whose methods to remap.</summary>
- private readonly Type FromType;
+ /// <summary>The full name of the type whose methods to remap.</summary>
+ private readonly string 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
@@ -33,55 +25,50 @@ namespace StardewModdingAPI.Framework.ModLoading.Rewriters
/// <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>
- public MethodParentRewriter(Type fromType, Type toType, bool onlyIfPlatformChanged = false)
+ /// <param name="nounPhrase">A brief noun phrase indicating what the instruction finder matches (or <c>null</c> to generate one).</param>
+ public MethodParentRewriter(string fromType, Type toType, string nounPhrase = null)
+ : base(nounPhrase ?? $"{fromType.Split('.').Last()} methods")
{
this.FromType = fromType;
this.ToType = toType;
- this.NounPhrase = $"{fromType.Name} methods";
- this.OnlyIfPlatformChanged = onlyIfPlatformChanged;
}
- /// <summary>Perform the predefined logic for a method if applicable.</summary>
- /// <param name="module">The assembly module containing the instruction.</param>
- /// <param name="method">The method definition containing the instruction.</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>
- public InstructionHandleResult Handle(ModuleDefinition module, MethodDefinition method, PlatformAssemblyMap assemblyMap, bool platformChanged)
- {
- return InstructionHandleResult.None;
- }
+ /// <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="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, string nounPhrase = null)
+ : this(fromType.FullName, toType, nounPhrase) { }
- /// <summary>Perform the predefined logic for an instruction if applicable.</summary>
+ /// <summary>Rewrite a CIL instruction reference if needed.</summary>
/// <param name="module">The assembly module containing the instruction.</param>
/// <param name="cil">The CIL processor.</param>
- /// <param name="instruction">The instruction to handle.</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>
- public InstructionHandleResult Handle(ModuleDefinition module, ILProcessor cil, Instruction instruction, PlatformAssemblyMap assemblyMap, bool platformChanged)
+ /// <param name="instruction">The CIL instruction to handle.</param>
+ /// <param name="replaceWith">Replaces the CIL instruction with a new one.</param>
+ /// <returns>Returns whether the instruction was changed.</returns>
+ public override bool Handle(ModuleDefinition module, ILProcessor cil, Instruction instruction, Action<Instruction> replaceWith)
{
- if (!this.IsMatch(instruction, platformChanged))
- return InstructionHandleResult.None;
+ // get method ref
+ MethodReference methodRef = RewriteHelper.AsMethodReference(instruction);
+ if (!this.IsMatch(methodRef))
+ return false;
- MethodReference methodRef = (MethodReference)instruction.Operand;
+ // rewrite
methodRef.DeclaringType = module.ImportReference(this.ToType);
- return InstructionHandleResult.Rewritten;
+ return this.MarkRewritten();
}
/*********
- ** Protected methods
+ ** Private 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)
+ /// <param name="methodRef">The method reference.</param>
+ private bool IsMatch(MethodReference methodRef)
{
- MethodReference methodRef = RewriteHelper.AsMethodReference(instruction);
return
methodRef != null
- && (platformChanged || !this.OnlyIfPlatformChanged)
- && methodRef.DeclaringType.FullName == this.FromType.FullName
+ && methodRef.DeclaringType.FullName == this.FromType
&& RewriteHelper.HasMatchingSignature(this.ToType, methodRef);
}
}