summaryrefslogtreecommitdiff
path: root/src/SMAPI/Framework/ModLoading/RewriteFacades
diff options
context:
space:
mode:
authorJesse Plamondon-Willard <Pathoschild@users.noreply.github.com>2020-05-18 22:44:06 -0400
committerJesse Plamondon-Willard <Pathoschild@users.noreply.github.com>2020-05-18 22:44:06 -0400
commitd1bf3d52352df4bb720cf0fa87dcd6a64f35446a (patch)
treefe48d4e07815a6e183e4773492ed8cda1b7e239c /src/SMAPI/Framework/ModLoading/RewriteFacades
parent21303a4e987e4169f3bf0c55c7099d0d07536ca5 (diff)
downloadSMAPI-d1bf3d52352df4bb720cf0fa87dcd6a64f35446a.tar.gz
SMAPI-d1bf3d52352df4bb720cf0fa87dcd6a64f35446a.tar.bz2
SMAPI-d1bf3d52352df4bb720cf0fa87dcd6a64f35446a.zip
move facade namespace (#711)
Diffstat (limited to 'src/SMAPI/Framework/ModLoading/RewriteFacades')
-rw-r--r--src/SMAPI/Framework/ModLoading/RewriteFacades/AccessToolsMethods.cs32
-rw-r--r--src/SMAPI/Framework/ModLoading/RewriteFacades/HarmonyInstanceMethods.cs49
-rw-r--r--src/SMAPI/Framework/ModLoading/RewriteFacades/SpriteBatchMethods.cs61
3 files changed, 142 insertions, 0 deletions
diff --git a/src/SMAPI/Framework/ModLoading/RewriteFacades/AccessToolsMethods.cs b/src/SMAPI/Framework/ModLoading/RewriteFacades/AccessToolsMethods.cs
new file mode 100644
index 00000000..ea35fec9
--- /dev/null
+++ b/src/SMAPI/Framework/ModLoading/RewriteFacades/AccessToolsMethods.cs
@@ -0,0 +1,32 @@
+using System;
+using System.Collections.Generic;
+using System.Diagnostics.CodeAnalysis;
+using System.Reflection;
+using HarmonyLib;
+
+namespace StardewModdingAPI.Framework.ModLoading.RewriteFacades
+{
+ /// <summary>Maps Harmony 1.x <see cref="AccessTools"/> methods to Harmony 2.x to avoid breaking older mods.</summary>
+ /// <remarks>This is public to support SMAPI rewriting and should not be referenced directly by mods.</remarks>
+ [SuppressMessage("ReSharper", "CS1591", Justification = "Documentation not needed for facade classes.")]
+ public class AccessToolsMethods
+ {
+ /*********
+ ** Public methods
+ *********/
+ public static ConstructorInfo DeclaredConstructor(Type type, Type[] parameters = null)
+ {
+ return AccessTools.DeclaredConstructor(type, parameters, searchForStatic: true);
+ }
+
+ public static ConstructorInfo Constructor(Type type, Type[] parameters = null)
+ {
+ return AccessTools.Constructor(type, parameters, searchForStatic: true);
+ }
+
+ public static List<ConstructorInfo> GetDeclaredConstructors(Type type)
+ {
+ return AccessTools.GetDeclaredConstructors(type, searchForStatic: true);
+ }
+ }
+}
diff --git a/src/SMAPI/Framework/ModLoading/RewriteFacades/HarmonyInstanceMethods.cs b/src/SMAPI/Framework/ModLoading/RewriteFacades/HarmonyInstanceMethods.cs
new file mode 100644
index 00000000..78cf25f8
--- /dev/null
+++ b/src/SMAPI/Framework/ModLoading/RewriteFacades/HarmonyInstanceMethods.cs
@@ -0,0 +1,49 @@
+using System;
+using System.Collections.Generic;
+using System.Diagnostics.CodeAnalysis;
+using System.Reflection;
+using System.Reflection.Emit;
+using HarmonyLib;
+
+namespace StardewModdingAPI.Framework.ModLoading.RewriteFacades
+{
+ /// <summary>Maps Harmony 1.x <code>HarmonyInstance</code> methods to Harmony 2.x's <see cref="Harmony"/> to avoid breaking older mods.</summary>
+ /// <remarks>This is public to support SMAPI rewriting and should not be referenced directly by mods.</remarks>
+ [SuppressMessage("ReSharper", "CS1591", Justification = "Documentation not needed for facade classes.")]
+ public class HarmonyInstanceMethods : Harmony
+ {
+ /*********
+ ** Public methods
+ *********/
+ /// <summary>Construct an instance.</summary>
+ /// <param name="id">The unique patch identifier.</param>
+ public HarmonyInstanceMethods(string id)
+ : base(id) { }
+
+ public static Harmony Create(string id)
+ {
+ return new Harmony(id);
+ }
+
+ public DynamicMethod Patch(MethodBase original, HarmonyMethod prefix = null, HarmonyMethod postfix = null, HarmonyMethod transpiler = null)
+ {
+ try
+ {
+ MethodInfo method = base.Patch(original: original, prefix: prefix, postfix: postfix, transpiler: transpiler);
+ return (DynamicMethod)method;
+ }
+ catch (Exception ex)
+ {
+ var patchTypes = new List<string>();
+ if (prefix != null)
+ patchTypes.Add("prefix");
+ if (postfix != null)
+ patchTypes.Add("postfix");
+ if (transpiler != null)
+ patchTypes.Add("transpiler");
+
+ throw new Exception($"Harmony instance {this.Id} failed applying {string.Join("/", patchTypes)} to method {original.DeclaringType?.FullName}.{original.Name}.", ex);
+ }
+ }
+ }
+}
diff --git a/src/SMAPI/Framework/ModLoading/RewriteFacades/SpriteBatchMethods.cs b/src/SMAPI/Framework/ModLoading/RewriteFacades/SpriteBatchMethods.cs
new file mode 100644
index 00000000..75bb61ef
--- /dev/null
+++ b/src/SMAPI/Framework/ModLoading/RewriteFacades/SpriteBatchMethods.cs
@@ -0,0 +1,61 @@
+using System.Diagnostics.CodeAnalysis;
+using Microsoft.Xna.Framework;
+using Microsoft.Xna.Framework.Graphics;
+
+#pragma warning disable 1591 // missing documentation
+namespace StardewModdingAPI.Framework.ModLoading.RewriteFacades
+{
+ /// <summary>Provides <see cref="SpriteBatch"/> method signatures that can be injected into mod code for compatibility between Linux/Mac or Windows.</summary>
+ /// <remarks>This is public to support SMAPI rewriting and should not be referenced directly by mods.</remarks>
+ public class SpriteBatchMethods : SpriteBatch
+ {
+ /*********
+ ** Public methods
+ *********/
+ /// <summary>Construct an instance.</summary>
+ public SpriteBatchMethods(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);
+ }
+ }
+}