From fae362723f1390cb7758bd151d50889cf6c999a9 Mon Sep 17 00:00:00 2001
From: Jesse Plamondon-Willard <github@jplamondonw.com>
Date: Sun, 12 Mar 2017 03:23:20 -0400
Subject: reject mods which reference obsolete Game1.borderFont and
 Game1.smoothFont fields (#247)

---
 .../Finders/Game1_borderFont_FieldFinder.cs        | 35 ++++++++++++++++++++++
 .../Finders/Game1_smoothFont_FieldFinder.cs        | 35 ++++++++++++++++++++++
 .../Finders/SMAPI_Extensions_MethodFinder.cs       |  2 +-
 3 files changed, 71 insertions(+), 1 deletion(-)
 create mode 100644 src/StardewModdingAPI.AssemblyRewriters/Finders/Game1_borderFont_FieldFinder.cs
 create mode 100644 src/StardewModdingAPI.AssemblyRewriters/Finders/Game1_smoothFont_FieldFinder.cs

(limited to 'src/StardewModdingAPI.AssemblyRewriters/Finders')

diff --git a/src/StardewModdingAPI.AssemblyRewriters/Finders/Game1_borderFont_FieldFinder.cs b/src/StardewModdingAPI.AssemblyRewriters/Finders/Game1_borderFont_FieldFinder.cs
new file mode 100644
index 00000000..e25cc544
--- /dev/null
+++ b/src/StardewModdingAPI.AssemblyRewriters/Finders/Game1_borderFont_FieldFinder.cs
@@ -0,0 +1,35 @@
+using System.Diagnostics.CodeAnalysis;
+using Mono.Cecil;
+using Mono.Cecil.Cil;
+using StardewModdingAPI.AssemblyRewriters.Framework;
+using StardewValley;
+
+namespace StardewModdingAPI.AssemblyRewriters.Finders
+{
+    /// <summary>Finds CIL instructions that reference the former <c>Game1.borderFont</c> field, which was removed in Stardew Valley 1.2.3–1.2.6.</summary>
+    [SuppressMessage("ReSharper", "InconsistentNaming", Justification = "This class is not meant to be used directly, and is deliberately named to make it easier to know what it changes at a glance.")]
+    public class Game1_borderFont_FieldFinder : BaseFieldFinder
+    {
+        /*********
+        ** Accessors
+        *********/
+        /// <summary>A brief noun phrase indicating what the instruction finder matches.</summary>
+        public override string NounPhrase { get; } = $"obsolete {nameof(Game1)}.borderFont field";
+
+
+        /*********
+        ** Protected methods
+        *********/
+        /// <summary>Get whether a field reference should be rewritten.</summary>
+        /// <param name="instruction">The IL instruction.</param>
+        /// <param name="fieldRef">The field reference.</param>
+        /// <param name="platformChanged">Whether the mod was compiled on a different platform.</param>
+        protected override bool IsMatch(Instruction instruction, FieldReference fieldRef, bool platformChanged)
+        {
+            return
+                this.IsStaticField(instruction)
+                && fieldRef.DeclaringType.FullName == typeof(Game1).FullName
+                && fieldRef.Name == "borderFont";
+        }
+    }
+}
diff --git a/src/StardewModdingAPI.AssemblyRewriters/Finders/Game1_smoothFont_FieldFinder.cs b/src/StardewModdingAPI.AssemblyRewriters/Finders/Game1_smoothFont_FieldFinder.cs
new file mode 100644
index 00000000..b852f10d
--- /dev/null
+++ b/src/StardewModdingAPI.AssemblyRewriters/Finders/Game1_smoothFont_FieldFinder.cs
@@ -0,0 +1,35 @@
+using System.Diagnostics.CodeAnalysis;
+using Mono.Cecil;
+using Mono.Cecil.Cil;
+using StardewModdingAPI.AssemblyRewriters.Framework;
+using StardewValley;
+
+namespace StardewModdingAPI.AssemblyRewriters.Finders
+{
+    /// <summary>Finds CIL instructions that reference the former <c>Game1.smoothFont</c> field, which was removed in Stardew Valley 1.2.3–1.2.6.</summary>
+    [SuppressMessage("ReSharper", "InconsistentNaming", Justification = "This class is not meant to be used directly, and is deliberately named to make it easier to know what it changes at a glance.")]
+    public class Game1_smoothFont_FieldFinder : BaseFieldFinder
+    {
+        /*********
+        ** Accessors
+        *********/
+        /// <summary>A brief noun phrase indicating what the instruction finder matches.</summary>
+        public override string NounPhrase { get; } = $"obsolete {nameof(Game1)}.smoothFont field";
+
+
+        /*********
+        ** Protected methods
+        *********/
+        /// <summary>Get whether a field reference should be rewritten.</summary>
+        /// <param name="instruction">The IL instruction.</param>
+        /// <param name="fieldRef">The field reference.</param>
+        /// <param name="platformChanged">Whether the mod was compiled on a different platform.</param>
+        protected override bool IsMatch(Instruction instruction, FieldReference fieldRef, bool platformChanged)
+        {
+            return
+                this.IsStaticField(instruction)
+                && fieldRef.DeclaringType.FullName == typeof(Game1).FullName
+                && fieldRef.Name == "smoothFont";
+        }
+    }
+}
diff --git a/src/StardewModdingAPI.AssemblyRewriters/Finders/SMAPI_Extensions_MethodFinder.cs b/src/StardewModdingAPI.AssemblyRewriters/Finders/SMAPI_Extensions_MethodFinder.cs
index f359b595..4abcbc13 100644
--- a/src/StardewModdingAPI.AssemblyRewriters/Finders/SMAPI_Extensions_MethodFinder.cs
+++ b/src/StardewModdingAPI.AssemblyRewriters/Finders/SMAPI_Extensions_MethodFinder.cs
@@ -5,7 +5,7 @@ using StardewModdingAPI.AssemblyRewriters.Framework;
 
 namespace StardewModdingAPI.AssemblyRewriters.Finders
 {
-    /// <summary>Matches CIL instructions that reference the former <c>StardewModdingAPI.Extensions</c> class, which was removed in SMAPI 1.9.</summary>
+    /// <summary>Finds CIL instructions that reference the former <c>StardewModdingAPI.Extensions</c> class, which was removed in SMAPI 1.9.</summary>
     [SuppressMessage("ReSharper", "InconsistentNaming", Justification = "This class is not meant to be used directly, and is deliberately named to make it easier to know what it changes at a glance.")]
     public class SMAPI_Extensions_MethodFinder : BaseMethodFinder
     {
-- 
cgit