From bd20c2e1375ed5e32315ef5e292802bccc42f530 Mon Sep 17 00:00:00 2001
From: Jesse Plamondon-Willard <Pathoschild@users.noreply.github.com>
Date: Sun, 11 Jul 2021 01:44:02 -0400
Subject: alias Mono.Cecil references (#711)

This is needed to migrate to Harmony 2.0 because it uses MonoMod, which has a copy of Mono.Cecil merged into its assembly, which leads to "type X exists in both 0Harmony.dll and Mono.Cecil.dll" errors. We can't use the version bundled with MonoMod since only some of the types are publicly accessible.
---
 src/SMAPI/Framework/ModLoading/Rewriters/FieldReplaceRewriter.cs    | 6 ++++--
 .../Framework/ModLoading/Rewriters/Harmony1AssemblyRewriter.cs      | 6 ++++--
 src/SMAPI/Framework/ModLoading/Rewriters/HeuristicFieldRewriter.cs  | 6 ++++--
 src/SMAPI/Framework/ModLoading/Rewriters/HeuristicMethodRewriter.cs | 6 ++++--
 src/SMAPI/Framework/ModLoading/Rewriters/MethodParentRewriter.cs    | 6 ++++--
 src/SMAPI/Framework/ModLoading/Rewriters/TypeReferenceRewriter.cs   | 4 +++-
 6 files changed, 23 insertions(+), 11 deletions(-)

(limited to 'src/SMAPI/Framework/ModLoading/Rewriters')

diff --git a/src/SMAPI/Framework/ModLoading/Rewriters/FieldReplaceRewriter.cs b/src/SMAPI/Framework/ModLoading/Rewriters/FieldReplaceRewriter.cs
index 0b679e9d..d40d4111 100644
--- a/src/SMAPI/Framework/ModLoading/Rewriters/FieldReplaceRewriter.cs
+++ b/src/SMAPI/Framework/ModLoading/Rewriters/FieldReplaceRewriter.cs
@@ -1,7 +1,9 @@
+extern alias MonoCecilPackage;
+
 using System;
 using System.Reflection;
-using Mono.Cecil;
-using Mono.Cecil.Cil;
+using MonoCecilPackage.Mono.Cecil;
+using MonoCecilPackage.Mono.Cecil.Cil;
 using StardewModdingAPI.Framework.ModLoading.Framework;
 
 namespace StardewModdingAPI.Framework.ModLoading.Rewriters
diff --git a/src/SMAPI/Framework/ModLoading/Rewriters/Harmony1AssemblyRewriter.cs b/src/SMAPI/Framework/ModLoading/Rewriters/Harmony1AssemblyRewriter.cs
index 4b3675bc..147a12f9 100644
--- a/src/SMAPI/Framework/ModLoading/Rewriters/Harmony1AssemblyRewriter.cs
+++ b/src/SMAPI/Framework/ModLoading/Rewriters/Harmony1AssemblyRewriter.cs
@@ -1,8 +1,10 @@
 #if HARMONY_2
+extern alias MonoCecilPackage;
+
 using System;
 using HarmonyLib;
-using Mono.Cecil;
-using Mono.Cecil.Cil;
+using MonoCecilPackage.Mono.Cecil;
+using MonoCecilPackage.Mono.Cecil.Cil;
 using StardewModdingAPI.Framework.ModLoading.Framework;
 using StardewModdingAPI.Framework.ModLoading.RewriteFacades;
 
diff --git a/src/SMAPI/Framework/ModLoading/Rewriters/HeuristicFieldRewriter.cs b/src/SMAPI/Framework/ModLoading/Rewriters/HeuristicFieldRewriter.cs
index f59a6ab1..c381e4e5 100644
--- a/src/SMAPI/Framework/ModLoading/Rewriters/HeuristicFieldRewriter.cs
+++ b/src/SMAPI/Framework/ModLoading/Rewriters/HeuristicFieldRewriter.cs
@@ -1,7 +1,9 @@
+extern alias MonoCecilPackage;
+
 using System.Collections.Generic;
 using System.Linq;
-using Mono.Cecil;
-using Mono.Cecil.Cil;
+using MonoCecilPackage.Mono.Cecil;
+using MonoCecilPackage.Mono.Cecil.Cil;
 using StardewModdingAPI.Framework.ModLoading.Framework;
 
 namespace StardewModdingAPI.Framework.ModLoading.Rewriters
diff --git a/src/SMAPI/Framework/ModLoading/Rewriters/HeuristicMethodRewriter.cs b/src/SMAPI/Framework/ModLoading/Rewriters/HeuristicMethodRewriter.cs
index e133b6fa..748c1e6f 100644
--- a/src/SMAPI/Framework/ModLoading/Rewriters/HeuristicMethodRewriter.cs
+++ b/src/SMAPI/Framework/ModLoading/Rewriters/HeuristicMethodRewriter.cs
@@ -1,7 +1,9 @@
+extern alias MonoCecilPackage;
+
 using System.Collections.Generic;
 using System.Linq;
-using Mono.Cecil;
-using Mono.Cecil.Cil;
+using MonoCecilPackage.Mono.Cecil;
+using MonoCecilPackage.Mono.Cecil.Cil;
 using StardewModdingAPI.Framework.ModLoading.Framework;
 
 namespace StardewModdingAPI.Framework.ModLoading.Rewriters
diff --git a/src/SMAPI/Framework/ModLoading/Rewriters/MethodParentRewriter.cs b/src/SMAPI/Framework/ModLoading/Rewriters/MethodParentRewriter.cs
index 9933e2ca..5e0d9c70 100644
--- a/src/SMAPI/Framework/ModLoading/Rewriters/MethodParentRewriter.cs
+++ b/src/SMAPI/Framework/ModLoading/Rewriters/MethodParentRewriter.cs
@@ -1,7 +1,9 @@
+extern alias MonoCecilPackage;
+
 using System;
 using System.Linq;
-using Mono.Cecil;
-using Mono.Cecil.Cil;
+using MonoCecilPackage.Mono.Cecil;
+using MonoCecilPackage.Mono.Cecil.Cil;
 using StardewModdingAPI.Framework.ModLoading.Framework;
 
 namespace StardewModdingAPI.Framework.ModLoading.Rewriters
diff --git a/src/SMAPI/Framework/ModLoading/Rewriters/TypeReferenceRewriter.cs b/src/SMAPI/Framework/ModLoading/Rewriters/TypeReferenceRewriter.cs
index ad5cb96f..a4d09ae9 100644
--- a/src/SMAPI/Framework/ModLoading/Rewriters/TypeReferenceRewriter.cs
+++ b/src/SMAPI/Framework/ModLoading/Rewriters/TypeReferenceRewriter.cs
@@ -1,5 +1,7 @@
+extern alias MonoCecilPackage;
+
 using System;
-using Mono.Cecil;
+using MonoCecilPackage.Mono.Cecil;
 using StardewModdingAPI.Framework.ModLoading.Framework;
 
 namespace StardewModdingAPI.Framework.ModLoading.Rewriters
-- 
cgit 


From 8df578edb6d135796a48b219ecc7a7291c7ef460 Mon Sep 17 00:00:00 2001
From: Jesse Plamondon-Willard <Pathoschild@users.noreply.github.com>
Date: Tue, 13 Jul 2021 09:14:07 -0400
Subject: migrate to Harmony 2.1 (#711)

---
 src/SMAPI/Framework/ModLoading/Rewriters/Harmony1AssemblyRewriter.cs | 4 +---
 1 file changed, 1 insertion(+), 3 deletions(-)

(limited to 'src/SMAPI/Framework/ModLoading/Rewriters')

diff --git a/src/SMAPI/Framework/ModLoading/Rewriters/Harmony1AssemblyRewriter.cs b/src/SMAPI/Framework/ModLoading/Rewriters/Harmony1AssemblyRewriter.cs
index 147a12f9..5a84a16a 100644
--- a/src/SMAPI/Framework/ModLoading/Rewriters/Harmony1AssemblyRewriter.cs
+++ b/src/SMAPI/Framework/ModLoading/Rewriters/Harmony1AssemblyRewriter.cs
@@ -1,4 +1,3 @@
-#if HARMONY_2
 extern alias MonoCecilPackage;
 
 using System;
@@ -44,7 +43,7 @@ namespace StardewModdingAPI.Framework.ModLoading.Rewriters
         }
 
         /// <inheritdoc />
-        public override bool Handle(ModuleDefinition module, ILProcessor cil, Instruction instruction, Action<Instruction> replaceWith)
+        public override bool Handle(ModuleDefinition module, ILProcessor cil, Instruction instruction)
         {
             // rewrite Harmony 1.x methods to Harmony 2.0
             MethodReference methodRef = RewriteHelper.AsMethodReference(instruction);
@@ -119,4 +118,3 @@ namespace StardewModdingAPI.Framework.ModLoading.Rewriters
         }
     }
 }
-#endif
-- 
cgit 


From 175eaad68373185b010410c5e2de1af9afbba1f5 Mon Sep 17 00:00:00 2001
From: Jesse Plamondon-Willard <Pathoschild@users.noreply.github.com>
Date: Fri, 23 Jul 2021 20:37:26 -0400
Subject: remove now-unneeded Mono.Cecil aliases (#711)

---
 src/SMAPI/Framework/ModLoading/Rewriters/FieldReplaceRewriter.cs    | 6 ++----
 .../Framework/ModLoading/Rewriters/Harmony1AssemblyRewriter.cs      | 6 ++----
 src/SMAPI/Framework/ModLoading/Rewriters/HeuristicFieldRewriter.cs  | 6 ++----
 src/SMAPI/Framework/ModLoading/Rewriters/HeuristicMethodRewriter.cs | 6 ++----
 src/SMAPI/Framework/ModLoading/Rewriters/MethodParentRewriter.cs    | 6 ++----
 src/SMAPI/Framework/ModLoading/Rewriters/TypeReferenceRewriter.cs   | 4 +---
 6 files changed, 11 insertions(+), 23 deletions(-)

(limited to 'src/SMAPI/Framework/ModLoading/Rewriters')

diff --git a/src/SMAPI/Framework/ModLoading/Rewriters/FieldReplaceRewriter.cs b/src/SMAPI/Framework/ModLoading/Rewriters/FieldReplaceRewriter.cs
index d40d4111..0b679e9d 100644
--- a/src/SMAPI/Framework/ModLoading/Rewriters/FieldReplaceRewriter.cs
+++ b/src/SMAPI/Framework/ModLoading/Rewriters/FieldReplaceRewriter.cs
@@ -1,9 +1,7 @@
-extern alias MonoCecilPackage;
-
 using System;
 using System.Reflection;
-using MonoCecilPackage.Mono.Cecil;
-using MonoCecilPackage.Mono.Cecil.Cil;
+using Mono.Cecil;
+using Mono.Cecil.Cil;
 using StardewModdingAPI.Framework.ModLoading.Framework;
 
 namespace StardewModdingAPI.Framework.ModLoading.Rewriters
diff --git a/src/SMAPI/Framework/ModLoading/Rewriters/Harmony1AssemblyRewriter.cs b/src/SMAPI/Framework/ModLoading/Rewriters/Harmony1AssemblyRewriter.cs
index 5a84a16a..723983be 100644
--- a/src/SMAPI/Framework/ModLoading/Rewriters/Harmony1AssemblyRewriter.cs
+++ b/src/SMAPI/Framework/ModLoading/Rewriters/Harmony1AssemblyRewriter.cs
@@ -1,9 +1,7 @@
-extern alias MonoCecilPackage;
-
 using System;
 using HarmonyLib;
-using MonoCecilPackage.Mono.Cecil;
-using MonoCecilPackage.Mono.Cecil.Cil;
+using Mono.Cecil;
+using Mono.Cecil.Cil;
 using StardewModdingAPI.Framework.ModLoading.Framework;
 using StardewModdingAPI.Framework.ModLoading.RewriteFacades;
 
diff --git a/src/SMAPI/Framework/ModLoading/Rewriters/HeuristicFieldRewriter.cs b/src/SMAPI/Framework/ModLoading/Rewriters/HeuristicFieldRewriter.cs
index c381e4e5..f59a6ab1 100644
--- a/src/SMAPI/Framework/ModLoading/Rewriters/HeuristicFieldRewriter.cs
+++ b/src/SMAPI/Framework/ModLoading/Rewriters/HeuristicFieldRewriter.cs
@@ -1,9 +1,7 @@
-extern alias MonoCecilPackage;
-
 using System.Collections.Generic;
 using System.Linq;
-using MonoCecilPackage.Mono.Cecil;
-using MonoCecilPackage.Mono.Cecil.Cil;
+using Mono.Cecil;
+using Mono.Cecil.Cil;
 using StardewModdingAPI.Framework.ModLoading.Framework;
 
 namespace StardewModdingAPI.Framework.ModLoading.Rewriters
diff --git a/src/SMAPI/Framework/ModLoading/Rewriters/HeuristicMethodRewriter.cs b/src/SMAPI/Framework/ModLoading/Rewriters/HeuristicMethodRewriter.cs
index 748c1e6f..e133b6fa 100644
--- a/src/SMAPI/Framework/ModLoading/Rewriters/HeuristicMethodRewriter.cs
+++ b/src/SMAPI/Framework/ModLoading/Rewriters/HeuristicMethodRewriter.cs
@@ -1,9 +1,7 @@
-extern alias MonoCecilPackage;
-
 using System.Collections.Generic;
 using System.Linq;
-using MonoCecilPackage.Mono.Cecil;
-using MonoCecilPackage.Mono.Cecil.Cil;
+using Mono.Cecil;
+using Mono.Cecil.Cil;
 using StardewModdingAPI.Framework.ModLoading.Framework;
 
 namespace StardewModdingAPI.Framework.ModLoading.Rewriters
diff --git a/src/SMAPI/Framework/ModLoading/Rewriters/MethodParentRewriter.cs b/src/SMAPI/Framework/ModLoading/Rewriters/MethodParentRewriter.cs
index 5e0d9c70..9933e2ca 100644
--- a/src/SMAPI/Framework/ModLoading/Rewriters/MethodParentRewriter.cs
+++ b/src/SMAPI/Framework/ModLoading/Rewriters/MethodParentRewriter.cs
@@ -1,9 +1,7 @@
-extern alias MonoCecilPackage;
-
 using System;
 using System.Linq;
-using MonoCecilPackage.Mono.Cecil;
-using MonoCecilPackage.Mono.Cecil.Cil;
+using Mono.Cecil;
+using Mono.Cecil.Cil;
 using StardewModdingAPI.Framework.ModLoading.Framework;
 
 namespace StardewModdingAPI.Framework.ModLoading.Rewriters
diff --git a/src/SMAPI/Framework/ModLoading/Rewriters/TypeReferenceRewriter.cs b/src/SMAPI/Framework/ModLoading/Rewriters/TypeReferenceRewriter.cs
index a4d09ae9..ad5cb96f 100644
--- a/src/SMAPI/Framework/ModLoading/Rewriters/TypeReferenceRewriter.cs
+++ b/src/SMAPI/Framework/ModLoading/Rewriters/TypeReferenceRewriter.cs
@@ -1,7 +1,5 @@
-extern alias MonoCecilPackage;
-
 using System;
-using MonoCecilPackage.Mono.Cecil;
+using Mono.Cecil;
 using StardewModdingAPI.Framework.ModLoading.Framework;
 
 namespace StardewModdingAPI.Framework.ModLoading.Rewriters
-- 
cgit 


From bdae52c9ae76303fd8082b10763b9ab7660fbd35 Mon Sep 17 00:00:00 2001
From: Jesse Plamondon-Willard <Pathoschild@users.noreply.github.com>
Date: Mon, 26 Jul 2021 22:28:32 -0400
Subject: fix rewriting for Harmony ExceptionBlock type (#711)

---
 .../Rewriters/Harmony1AssemblyRewriter.cs          | 46 +++++++++++-----------
 1 file changed, 22 insertions(+), 24 deletions(-)

(limited to 'src/SMAPI/Framework/ModLoading/Rewriters')

diff --git a/src/SMAPI/Framework/ModLoading/Rewriters/Harmony1AssemblyRewriter.cs b/src/SMAPI/Framework/ModLoading/Rewriters/Harmony1AssemblyRewriter.cs
index 723983be..3197c151 100644
--- a/src/SMAPI/Framework/ModLoading/Rewriters/Harmony1AssemblyRewriter.cs
+++ b/src/SMAPI/Framework/ModLoading/Rewriters/Harmony1AssemblyRewriter.cs
@@ -28,7 +28,7 @@ namespace StardewModdingAPI.Framework.ModLoading.Rewriters
         public override bool Handle(ModuleDefinition module, TypeReference type, Action<TypeReference> replaceWith)
         {
             // rewrite Harmony 1.x type to Harmony 2.0 type
-            if (type.Scope is AssemblyNameReference scope && scope.Name == "0Harmony" && scope.Version.Major == 1)
+            if (type.Scope is AssemblyNameReference { Name: "0Harmony" } scope && scope.Version.Major == 1)
             {
                 Type targetType = this.GetMappedType(type);
                 replaceWith(module.ImportReference(targetType));
@@ -72,24 +72,15 @@ namespace StardewModdingAPI.Framework.ModLoading.Rewriters
                 return false; // not Harmony (or already using Harmony 2.0)
 
             // get facade type
-            Type toType;
-            switch (methodRef?.DeclaringType.FullName)
+            Type toType = methodRef?.DeclaringType.FullName switch
             {
-                case "HarmonyLib.Harmony":
-                    toType = typeof(HarmonyInstanceFacade);
-                    break;
-
-                case "HarmonyLib.AccessTools":
-                    toType = typeof(AccessToolsFacade);
-                    break;
-
-                case "HarmonyLib.HarmonyMethod":
-                    toType = typeof(HarmonyMethodFacade);
-                    break;
-
-                default:
-                    return false;
-            }
+                "HarmonyLib.Harmony" => typeof(HarmonyInstanceFacade),
+                "HarmonyLib.AccessTools" => typeof(AccessToolsFacade),
+                "HarmonyLib.HarmonyMethod" => typeof(HarmonyMethodFacade),
+                _ => null
+            };
+            if (toType == null)
+                return false;
 
             // map if there's a matching method
             if (RewriteHelper.HasMatchingSignature(toType, methodRef))
@@ -102,16 +93,23 @@ namespace StardewModdingAPI.Framework.ModLoading.Rewriters
         }
 
         /// <summary>Get an equivalent Harmony 2.x type.</summary>
-        /// <param name="type">The Harmony 1.x method.</param>
+        /// <param name="type">The Harmony 1.x type.</param>
         private Type GetMappedType(TypeReference type)
         {
-            // main Harmony object
-            if (type.FullName == "Harmony.HarmonyInstance")
-                return typeof(Harmony);
+            return type.FullName switch
+            {
+                "Harmony.HarmonyInstance" => typeof(Harmony),
+                "Harmony.ILCopying.ExceptionBlock" => typeof(ExceptionBlock),
+                _ => this.GetMappedTypeByConvention(type)
+            };
+        }
 
-            // other objects
+        /// <summary>Get an equivalent Harmony 2.x type using the convention expected for most types.</summary>
+        /// <param name="type">The Harmony 1.x type.</param>
+        private Type GetMappedTypeByConvention(TypeReference type)
+        {
             string fullName = type.FullName.Replace("Harmony.", "HarmonyLib.");
-            string targetName = typeof(Harmony).AssemblyQualifiedName.Replace(typeof(Harmony).FullName, fullName);
+            string targetName = typeof(Harmony).AssemblyQualifiedName!.Replace(typeof(Harmony).FullName!, fullName);
             return Type.GetType(targetName, throwOnError: true);
         }
     }
-- 
cgit 


From b4f307e1ba88df072efed3b94975fa45789ae1ef Mon Sep 17 00:00:00 2001
From: Jesse Plamondon-Willard <Pathoschild@users.noreply.github.com>
Date: Wed, 28 Jul 2021 00:51:45 -0400
Subject: fix rewritten Harmony 1.x code not raising 'detected game patch' flag
 (#711)

---
 .../ModLoading/Rewriters/Harmony1AssemblyRewriter.cs      | 15 ++++++++++++++-
 1 file changed, 14 insertions(+), 1 deletion(-)

(limited to 'src/SMAPI/Framework/ModLoading/Rewriters')

diff --git a/src/SMAPI/Framework/ModLoading/Rewriters/Harmony1AssemblyRewriter.cs b/src/SMAPI/Framework/ModLoading/Rewriters/Harmony1AssemblyRewriter.cs
index 3197c151..7a3b428d 100644
--- a/src/SMAPI/Framework/ModLoading/Rewriters/Harmony1AssemblyRewriter.cs
+++ b/src/SMAPI/Framework/ModLoading/Rewriters/Harmony1AssemblyRewriter.cs
@@ -32,7 +32,7 @@ namespace StardewModdingAPI.Framework.ModLoading.Rewriters
             {
                 Type targetType = this.GetMappedType(type);
                 replaceWith(module.ImportReference(targetType));
-                this.MarkRewritten();
+                this.OnChanged();
                 this.ReplacedTypes = true;
                 return true;
             }
@@ -46,14 +46,20 @@ namespace StardewModdingAPI.Framework.ModLoading.Rewriters
             // rewrite Harmony 1.x methods to Harmony 2.0
             MethodReference methodRef = RewriteHelper.AsMethodReference(instruction);
             if (this.TryRewriteMethodsToFacade(module, methodRef))
+            {
+                this.OnChanged();
                 return true;
+            }
 
             // rewrite renamed fields
             FieldReference fieldRef = RewriteHelper.AsFieldReference(instruction);
             if (fieldRef != null)
             {
                 if (fieldRef.DeclaringType.FullName == "HarmonyLib.HarmonyMethod" && fieldRef.Name == "prioritiy")
+                {
                     fieldRef.Name = nameof(HarmonyMethod.priority);
+                    this.OnChanged();
+                }
             }
 
             return false;
@@ -63,6 +69,13 @@ namespace StardewModdingAPI.Framework.ModLoading.Rewriters
         /*********
         ** Private methods
         *********/
+        /// <summary>Update the mod metadata when any Harmony 1.x code is migrated.</summary>
+        private void OnChanged()
+        {
+            this.MarkRewritten();
+            this.MarkFlag(InstructionHandleResult.DetectedGamePatch);
+        }
+
         /// <summary>Rewrite methods to use Harmony facades if needed.</summary>
         /// <param name="module">The assembly module containing the method reference.</param>
         /// <param name="methodRef">The method reference to map.</param>
-- 
cgit