From 889004f1eba31aa3a5069e1dcbe79896d05720b0 Mon Sep 17 00:00:00 2001
From: Jesse Plamondon-Willard <Pathoschild@users.noreply.github.com>
Date: Tue, 19 Apr 2022 19:03:47 -0400
Subject: move deprecation code into namespace

---
 .../Framework/Deprecations/DeprecationWarning.cs   | 48 ++++++++++++++++++++++
 1 file changed, 48 insertions(+)
 create mode 100644 src/SMAPI/Framework/Deprecations/DeprecationWarning.cs

(limited to 'src/SMAPI/Framework/Deprecations/DeprecationWarning.cs')

diff --git a/src/SMAPI/Framework/Deprecations/DeprecationWarning.cs b/src/SMAPI/Framework/Deprecations/DeprecationWarning.cs
new file mode 100644
index 00000000..38062daf
--- /dev/null
+++ b/src/SMAPI/Framework/Deprecations/DeprecationWarning.cs
@@ -0,0 +1,48 @@
+using System.Diagnostics;
+
+namespace StardewModdingAPI.Framework.Deprecations
+{
+    /// <summary>A deprecation warning for a mod.</summary>
+    internal class DeprecationWarning
+    {
+        /*********
+        ** Accessors
+        *********/
+        /// <summary>The affected mod.</summary>
+        public IModMetadata? Mod { get; }
+
+        /// <summary>Get the display name for the affected mod.</summary>
+        public string ModName => this.Mod?.DisplayName ?? "<unknown mod>";
+
+        /// <summary>A noun phrase describing what is deprecated.</summary>
+        public string NounPhrase { get; }
+
+        /// <summary>The SMAPI version which deprecated it.</summary>
+        public string Version { get; }
+
+        /// <summary>The deprecation level for the affected code.</summary>
+        public DeprecationLevel Level { get; }
+
+        /// <summary>The stack trace when the deprecation warning was raised.</summary>
+        public StackTrace StackTrace { get; }
+
+
+        /*********
+        ** Public methods
+        *********/
+        /// <summary>Construct an instance.</summary>
+        /// <param name="mod">The affected mod.</param>
+        /// <param name="nounPhrase">A noun phrase describing what is deprecated.</param>
+        /// <param name="version">The SMAPI version which deprecated it.</param>
+        /// <param name="level">The deprecation level for the affected code.</param>
+        /// <param name="stackTrace">The stack trace when the deprecation warning was raised.</param>
+        public DeprecationWarning(IModMetadata? mod, string nounPhrase, string version, DeprecationLevel level, StackTrace stackTrace)
+        {
+            this.Mod = mod;
+            this.NounPhrase = nounPhrase;
+            this.Version = version;
+            this.Level = level;
+            this.StackTrace = stackTrace;
+        }
+    }
+}
-- 
cgit 


From e6c696fa6b0bfe5ef013e1179765ce1dcb071c38 Mon Sep 17 00:00:00 2001
From: Jesse Plamondon-Willard <Pathoschild@users.noreply.github.com>
Date: Tue, 19 Apr 2022 19:11:58 -0400
Subject: add immutable stack trace to cache stack info

---
 src/SMAPI/Framework/Deprecations/DeprecationWarning.cs | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

(limited to 'src/SMAPI/Framework/Deprecations/DeprecationWarning.cs')

diff --git a/src/SMAPI/Framework/Deprecations/DeprecationWarning.cs b/src/SMAPI/Framework/Deprecations/DeprecationWarning.cs
index 38062daf..e00881b1 100644
--- a/src/SMAPI/Framework/Deprecations/DeprecationWarning.cs
+++ b/src/SMAPI/Framework/Deprecations/DeprecationWarning.cs
@@ -24,7 +24,7 @@ namespace StardewModdingAPI.Framework.Deprecations
         public DeprecationLevel Level { get; }
 
         /// <summary>The stack trace when the deprecation warning was raised.</summary>
-        public StackTrace StackTrace { get; }
+        public ImmutableStackTrace StackTrace { get; }
 
 
         /*********
@@ -36,7 +36,7 @@ namespace StardewModdingAPI.Framework.Deprecations
         /// <param name="version">The SMAPI version which deprecated it.</param>
         /// <param name="level">The deprecation level for the affected code.</param>
         /// <param name="stackTrace">The stack trace when the deprecation warning was raised.</param>
-        public DeprecationWarning(IModMetadata? mod, string nounPhrase, string version, DeprecationLevel level, StackTrace stackTrace)
+        public DeprecationWarning(IModMetadata? mod, string nounPhrase, string version, DeprecationLevel level, ImmutableStackTrace stackTrace)
         {
             this.Mod = mod;
             this.NounPhrase = nounPhrase;
-- 
cgit 


From 7bb7a7522fcdfef27f8f22ba77f24c7609f49912 Mon Sep 17 00:00:00 2001
From: Jesse Plamondon-Willard <Pathoschild@users.noreply.github.com>
Date: Sat, 30 Apr 2022 12:57:28 -0400
Subject: omit stack trace for deprecated code not called directly by the mod

---
 src/SMAPI/Framework/Deprecations/DeprecationWarning.cs | 9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)

(limited to 'src/SMAPI/Framework/Deprecations/DeprecationWarning.cs')

diff --git a/src/SMAPI/Framework/Deprecations/DeprecationWarning.cs b/src/SMAPI/Framework/Deprecations/DeprecationWarning.cs
index e00881b1..5936517b 100644
--- a/src/SMAPI/Framework/Deprecations/DeprecationWarning.cs
+++ b/src/SMAPI/Framework/Deprecations/DeprecationWarning.cs
@@ -1,5 +1,3 @@
-using System.Diagnostics;
-
 namespace StardewModdingAPI.Framework.Deprecations
 {
     /// <summary>A deprecation warning for a mod.</summary>
@@ -26,6 +24,9 @@ namespace StardewModdingAPI.Framework.Deprecations
         /// <summary>The stack trace when the deprecation warning was raised.</summary>
         public ImmutableStackTrace StackTrace { get; }
 
+        /// <summary>Whether to log a stack trace showing where the deprecated code is in the mod.</summary>
+        public bool LogStackTrace { get; }
+
 
         /*********
         ** Public methods
@@ -36,13 +37,15 @@ namespace StardewModdingAPI.Framework.Deprecations
         /// <param name="version">The SMAPI version which deprecated it.</param>
         /// <param name="level">The deprecation level for the affected code.</param>
         /// <param name="stackTrace">The stack trace when the deprecation warning was raised.</param>
-        public DeprecationWarning(IModMetadata? mod, string nounPhrase, string version, DeprecationLevel level, ImmutableStackTrace stackTrace)
+        /// <param name="logStackTrace">Whether to log a stack trace showing where the deprecated code is in the mod.</param>
+        public DeprecationWarning(IModMetadata? mod, string nounPhrase, string version, DeprecationLevel level, ImmutableStackTrace stackTrace, bool logStackTrace)
         {
             this.Mod = mod;
             this.NounPhrase = nounPhrase;
             this.Version = version;
             this.Level = level;
             this.StackTrace = stackTrace;
+            this.LogStackTrace = logStackTrace;
         }
     }
 }
-- 
cgit