using System;
using System.Collections.Generic;
using System.Diagnostics.CodeAnalysis;
using System.Reflection;
using System.Reflection.Emit;
using HarmonyLib;
#pragma warning disable CS1591 // Missing XML comment for publicly visible type or member: This is internal code to support rewriters that shouldn't be called directly.
namespace StardewModdingAPI.Framework.ModLoading.RewriteFacades
{
/// Maps Harmony 1.x HarmonyInstance
methods to Harmony 2.x's to avoid breaking older mods.
/// This is public to support SMAPI rewriting and should not be referenced directly by mods.
[SuppressMessage("ReSharper", "UnusedMember.Global", Justification = "Used via assembly rewriting")]
[SuppressMessage("ReSharper", "CS1591", Justification = "Documentation not needed for facade classes.")]
public class HarmonyInstanceFacade : Harmony
{
/*********
** Public methods
*********/
/// Construct an instance.
/// The unique patch identifier.
public HarmonyInstanceFacade(string id)
: base(id) { }
public static Harmony Create(string id)
{
return new Harmony(id);
}
[SuppressMessage("ReSharper", "ConditionIsAlwaysTrueOrFalse", Justification = "If the user passes a null original method, we let it fail in the underlying Harmony instance instead of handling it here.")]
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
{
MethodInfo method = base.Patch(original: original, prefix: prefix, postfix: postfix, transpiler: transpiler);
return (DynamicMethod)method;
}
catch (Exception ex)
{
string patchTypes = this.GetPatchTypesLabel(prefix, postfix, transpiler);
string methodLabel = this.GetMethodLabel(original);
throw new Exception($"Harmony instance {this.Id} failed applying {patchTypes} to {methodLabel}.", ex);
}
}
/*********
** Private methods
*********/
/// Get a human-readable label for the patch types being applies.
/// The prefix method, if any.
/// The postfix method, if any.
/// The transpiler method, if any.
private string GetPatchTypesLabel(HarmonyMethod? prefix = null, HarmonyMethod? postfix = null, HarmonyMethod? transpiler = null)
{
var patchTypes = new List();
if (prefix != null)
patchTypes.Add("prefix");
if (postfix != null)
patchTypes.Add("postfix");
if (transpiler != null)
patchTypes.Add("transpiler");
return string.Join("/", patchTypes);
}
/// Get a human-readable label for the method being patched.
/// The method being patched.
private string GetMethodLabel(MethodBase? method)
{
return method != null
? $"method {method.DeclaringType?.FullName}.{method.Name}"
: "null method";
}
}
}