StardewValley
/
SMAPI
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

rewrite Harmony.Patch method to allow non-implemented virtual methods (#711)

This commit is contained in:
Jesse Plamondon-Willard 2020-05-21 23:50:34 -04:00
parent db0a46cb68
commit 33da29b3e5
No known key found for this signature in database
GPG Key ID: CF8B1456B3E29F49
1 changed files with 41 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

56
src/SMAPI/Framework/ModLoading/RewriteFacades/HarmonyInstanceFacade.cs
View File

@ -28,6 +28,13 @@ namespace StardewModdingAPI.Framework.ModLoading.RewriteFacades
public DynamicMethod Patch(MethodBase original, HarmonyMethod prefix = null, HarmonyMethod postfix = null, HarmonyMethod transpiler = null) public DynamicMethod Patch(MethodBase original, HarmonyMethod prefix = null, HarmonyMethod postfix = null, HarmonyMethod transpiler = null)
{ {
// In Harmony 1.x you could target a virtual method that's not implemented by the
// target type, but in Harmony 2.0 you need to target the concrete implementation.
// This just resolves the method to the concrete implementation if needed.
if (original != null)
original = original.GetDeclaredMember();
// call Harmony 2.0 and show a detailed exception if it fails
try try
{ {
MethodInfo method = base.Patch(original: original, prefix: prefix, postfix: postfix, transpiler: transpiler); MethodInfo method = base.Patch(original: original, prefix: prefix, postfix: postfix, transpiler: transpiler);
@ -35,22 +42,41 @@ namespace StardewModdingAPI.Framework.ModLoading.RewriteFacades
} }
catch (Exception ex) catch (Exception ex)
{ {
// get patch types string patchTypes = this.GetPatchTypesLabel(prefix, postfix, transpiler);
var patchTypes = new List<string>(); string methodLabel = this.GetMethodLabel(original);
if (prefix != null) throw new Exception($"Harmony instance {this.Id} failed applying {patchTypes} to {methodLabel}.", ex);
patchTypes.Add("prefix");
if (postfix != null)
patchTypes.Add("postfix");
if (transpiler != null)
patchTypes.Add("transpiler");
// get original method label
string methodLabel = original != null
? $"method {original.DeclaringType?.FullName}.{original.Name}"
: "null method";
throw new Exception($"Harmony instance {this.Id} failed applying {string.Join("/", patchTypes)} to {methodLabel}.", ex);
} }
} }
/*********
** Private methods
*********/
/// <summary>Get a human-readable label for the patch types being applies.</summary>
/// <param name="prefix">The prefix method, if any.</param>
/// <param name="postfix">The postfix method, if any.</param>
/// <param name="transpiler">The transpiler method, if any.</param>
private string GetPatchTypesLabel(HarmonyMethod prefix = null, HarmonyMethod postfix = null, HarmonyMethod transpiler = null)
{
var patchTypes = new List<string>();
if (prefix != null)
patchTypes.Add("prefix");
if (postfix != null)
patchTypes.Add("postfix");
if (transpiler != null)
patchTypes.Add("transpiler");
return string.Join("/", patchTypes);
}
/// <summary>Get a human-readable label for the method being patched.</summary>
/// <param name="method">The method being patched.</param>
private string GetMethodLabel(MethodBase method)
{
return method != null
? $"method {method.DeclaringType?.FullName}.{method.Name}"
: "null method";
}
} }
} }