ButterLib now properly reads settings and will not enable a SubSystem…

… if disabled Otherwise we will always create Harmony patches for method, which is not reversible by disabling them
BUTR · Sep 25, 2024 · ede8ac9 · ede8ac9
1 parent 0679f7e
commit ede8ac9
Show file tree

Hide file tree

Showing 15 changed files with 221 additions and 87 deletions.
diff --git a/changelog.txt b/changelog.txt
@@ -3,7 +3,7 @@ Version: 2.9.11
 Game Versions: v1.0.x,v1.1.x,v1.2.x
 * Updated Crash Reporter to v14
 * OS Type/Version and loaded Native Modules are now saved in the crash report
-* Fixed methods not being debuggable when Debugger is attached by Cephas369
+* Fixed methods not being debuggable when Debugger is attached (Thanks Cephas369)
 ---------------------------------------------------------------------------------------------------
 Version: 2.9.10
 Game Versions: v1.0.x,v1.1.x,v1.2.x

diff --git a/src/Bannerlord.ButterLib.Implementation/DistanceMatrix/DistanceMatrixSubSystem.cs b/src/Bannerlord.ButterLib.Implementation/DistanceMatrix/DistanceMatrixSubSystem.cs
@@ -1,4 +1,5 @@
-using Bannerlord.ButterLib.SubSystems;
+using Bannerlord.ButterLib.Options;
+using Bannerlord.ButterLib.SubSystems;
 using Bannerlord.ButterLib.SubSystems.Settings;
 
 using System.Collections.Generic;
@@ -18,13 +19,22 @@ internal class DistanceMatrixSubSystem : ISubSystem, ISubSystemSettings<Distance
     internal bool GameInitialized { get; set; } = false;
     public bool ConsiderVillages { get; set; } = true;
 
+    private bool _wasInitialized;
+
     public DistanceMatrixSubSystem()
     {
         Instance = this;
     }
 
     public void Enable()
     {
+        if (!_wasInitialized)
+        {
+            _wasInitialized = true;
+            var isEnabledViaSettings = SettingsProvider.PopulateSubSystemSettings(this) ?? true;
+            if (!isEnabledViaSettings) return;
+        }
+
         if (IsEnabled) return;
 
         if (GameInitialized) return;

diff --git a/src/Bannerlord.ButterLib.Implementation/HotKeys/HotKeySubSystem.cs b/src/Bannerlord.ButterLib.Implementation/HotKeys/HotKeySubSystem.cs
@@ -5,6 +5,7 @@
  */
 
 using Bannerlord.ButterLib.Implementation.HotKeys.Patches;
+using Bannerlord.ButterLib.Options;
 using Bannerlord.ButterLib.SubSystems;
 
 using HarmonyLib;
@@ -26,13 +27,22 @@ internal sealed class HotKeySubSystem : ISubSystem
 
     private readonly Harmony _harmony = new("Bannerlord.ButterLib.HotKeySystem");
 
+    private bool _wasInitialized;
+
     public HotKeySubSystem()
     {
         Instance = this;
     }
 
     public void Enable()
     {
+        if (!_wasInitialized)
+        {
+            _wasInitialized = true;
+            var isEnabledViaSettings = SettingsProvider.PopulateSubSystemSettings(this) ?? true;
+            if (!isEnabledViaSettings) return;
+        }
+
         if (IsEnabled) return;
         IsEnabled = true;
 

diff --git a/...Bannerlord.ButterLib.Implementation/MBSubModuleBaseExtended/MBSubModuleBaseExSubSystem.cs b/...Bannerlord.ButterLib.Implementation/MBSubModuleBaseExtended/MBSubModuleBaseExSubSystem.cs
@@ -1,4 +1,5 @@
 using Bannerlord.ButterLib.Implementation.MBSubModuleBaseExtended.Patches;
+using Bannerlord.ButterLib.Options;
 using Bannerlord.ButterLib.SubSystems;
 
 using HarmonyLib;
@@ -23,12 +24,21 @@ internal class MBSubModuleBaseExSubSystem : ISubSystem
 
     private readonly Harmony _harmony = new("Bannerlord.ButterLib.MBSubModuleBaseEx");
 
+    private bool _wasInitialized;
+
     public MBSubModuleBaseExSubSystem()
     {
         Instance = this;
     }
     public void Enable()
     {
+        if (!_wasInitialized)
+        {
+            _wasInitialized = true;
+            var isEnabledViaSettings = SettingsProvider.PopulateSubSystemSettings(this) ?? true;
+            if (!isEnabledViaSettings) return;
+        }
+
         if (IsEnabled) return;
         IsEnabled = true;
 

diff --git a/src/Bannerlord.ButterLib.Implementation/SaveSystem/SaveSystemSubSystem.cs b/src/Bannerlord.ButterLib.Implementation/SaveSystem/SaveSystemSubSystem.cs
@@ -1,4 +1,5 @@
 using Bannerlord.ButterLib.Implementation.SaveSystem.Patches;
+using Bannerlord.ButterLib.Options;
 using Bannerlord.ButterLib.SubSystems;
 
 using HarmonyLib;
@@ -22,13 +23,22 @@ internal class SaveSystemSubSystem : ISubSystem
 
     private readonly Harmony _harmony = new("Bannerlord.ButterLib.SaveSystem");
 
+    private bool _wasInitialized;
+
     public SaveSystemSubSystem()
     {
         Instance = this;
     }
 
     public void Enable()
     {
+        if (!_wasInitialized)
+        {
+            _wasInitialized = true;
+            var isEnabledViaSettings = SettingsProvider.PopulateSubSystemSettings(this) ?? true;
+            if (!isEnabledViaSettings) return;
+        }
+
         if (IsEnabled) return;
         IsEnabled = true;
 

diff --git a/src/Bannerlord.ButterLib.Implementation/SubModule.cs b/src/Bannerlord.ButterLib.Implementation/SubModule.cs
@@ -70,6 +70,7 @@ protected override void OnSubModuleLoad()
         Logger.LogInformation("Wrapping DebugManager of type {Type} with DebugManagerWrapper", Debug.DebugManager.GetType());
         Debug.DebugManager = new DebugManagerWrapper(Debug.DebugManager, serviceProvider.GetRequiredService<ILoggerFactory>());
 
+        DistanceMatrixSubSystem.Instance?.Enable();
         HotKeySubSystem.Instance?.Enable();
         MBSubModuleBaseExSubSystem.Instance?.Enable();
         SaveSystemSubSystem.Instance?.Enable();

diff --git a/src/Bannerlord.ButterLib/ButterLibSubModule.cs b/src/Bannerlord.ButterLib/ButterLibSubModule.cs
@@ -4,7 +4,6 @@
 using Bannerlord.ButterLib.DelayedSubModule;
 using Bannerlord.ButterLib.DynamicAPI;
 using Bannerlord.ButterLib.ExceptionHandler;
-using Bannerlord.ButterLib.Extensions;
 using Bannerlord.ButterLib.ObjectSystem.Extensions;
 using Bannerlord.ButterLib.Options;
 using Bannerlord.ButterLib.SubModuleWrappers2;
@@ -21,12 +20,9 @@
 
 using TaleWorlds.CampaignSystem;
 using TaleWorlds.Core;
-using TaleWorlds.Engine;
 using TaleWorlds.Localization;
 using TaleWorlds.MountAndBlade;
 
-using Path = System.IO.Path;
-
 namespace Bannerlord.ButterLib;
 
 /// <summary>
@@ -66,16 +62,16 @@ public void OnServiceRegistration()
         Services.AddOptions();
         Services.Configure<ButterLibOptions>(o =>
         {
-            var defaultJsonOptions = new JsonButterLibOptionsModel();
+            var defaultJsonOptions = SettingsProvider.GetSettings();
             o.MinLogLevel = defaultJsonOptions.MinLogLevel;
         });
 
         foreach (var action in BeforeInitialization)
             action?.Invoke(Services);
 
         this.AddDefaultSerilogLogger();
-        this.AddSerilogLoggerProvider("butterlib.txt", new[] { "Bannerlord.ButterLib.*" });
-        this.AddSerilogLoggerProvider("trace.txt", new[] { "System.Diagnostics.Logger.*" });
+        this.AddSerilogLoggerProvider("butterlib.txt", ["Bannerlord.ButterLib.*"]);
+        this.AddSerilogLoggerProvider("trace.txt", ["System.Diagnostics.Logger.*"]);
         //this.AddSteamWriterLogger("harmony.txt", out var harmonyStreamWriter);
         //HarmonyLib.FileLog.LogWriter = harmonyStreamWriter;
 
@@ -110,6 +106,8 @@ protected override void OnSubModuleLoad()
         if (!DelayedServiceCreation)
             InitializeServices();
 
+        DelayedSubModuleSubSystem.Instance?.Enable();
+        SubModuleWrappers2SubSystem.Instance?.Enable();
         ExceptionHandlerSubSystem.Instance?.Enable();
         CrashUploaderSubSystem.Instance?.Enable();
 

diff --git a/src/Bannerlord.ButterLib/CrashUploader/CrashUploaderSubSystem.cs b/src/Bannerlord.ButterLib/CrashUploader/CrashUploaderSubSystem.cs
@@ -1,4 +1,5 @@
-using Bannerlord.ButterLib.SubSystems;
+using Bannerlord.ButterLib.Options;
+using Bannerlord.ButterLib.SubSystems;
 
 namespace Bannerlord.ButterLib.CrashUploader;
 
@@ -13,6 +14,7 @@ internal sealed class CrashUploaderSubSystem : ISubSystem
     public bool CanBeDisabled => true;
     public bool CanBeSwitchedAtRuntime => true;
 
+    private bool _wasInitialized;
 
     public CrashUploaderSubSystem()
     {
@@ -21,6 +23,13 @@ public CrashUploaderSubSystem()
 
     public void Enable()
     {
+        if (!_wasInitialized)
+        {
+            _wasInitialized = true;
+            var isEnabledViaSettings = SettingsProvider.PopulateSubSystemSettings(this) ?? true;
+            if (!isEnabledViaSettings) return;
+        }
+
         if (IsEnabled) return;
         IsEnabled = true;
     }

diff --git a/src/Bannerlord.ButterLib/DelayedSubModule/DelayedSubModuleSubSystem.cs b/src/Bannerlord.ButterLib/DelayedSubModule/DelayedSubModuleSubSystem.cs
@@ -4,12 +4,20 @@ namespace Bannerlord.ButterLib.DelayedSubModule;
 
 internal class DelayedSubModuleSubSystem : ISubSystem
 {
+    public static DelayedSubModuleSubSystem? Instance { get; private set; }
+
     public string Id => "Delayed SubModule";
     public string Name => "{=joCJ9xpDvM}Delayed SubModule";
     public string Description => "{=Gznum6kuzv}Mod Developer feature! Provides helpers to run methods after SubModule events.";
     public bool IsEnabled => true;
     public bool CanBeDisabled => false;
     public bool CanBeSwitchedAtRuntime => false;
+
+    public DelayedSubModuleSubSystem()
+    {
+        Instance = this;
+    }
+
     public void Enable() { }
     public void Disable() { }
 }
diff --git a/src/Bannerlord.ButterLib/ExceptionHandler/BEWPatch.cs b/src/Bannerlord.ButterLib/ExceptionHandler/BEWPatch.cs
@@ -65,6 +65,9 @@ private static void Finalizer(Exception? __exception)
     {
         if (__exception is not null)
         {
+            if (ExceptionHandlerSubSystem.Instance?.DisableWhenDebuggerIsAttached == true && IsDebuggerAttached())
+                return;
+
             ExceptionReporter.Show(__exception);
         }
     }

diff --git a/src/Bannerlord.ButterLib/ExceptionHandler/ExceptionHandlerSubSystem.cs b/src/Bannerlord.ButterLib/ExceptionHandler/ExceptionHandlerSubSystem.cs
@@ -1,4 +1,5 @@
 using Bannerlord.BLSE;
+using Bannerlord.ButterLib.Options;
 using Bannerlord.ButterLib.SubSystems;
 using Bannerlord.ButterLib.SubSystems.Settings;
 
@@ -37,33 +38,38 @@ public bool DisableWhenDebuggerIsAttached
         get => _disableWhenDebuggerIsAttached;
         private set
         {
-            if (_disableWhenDebuggerIsAttached != value)
-            {
-                _disableWhenDebuggerIsAttached = value;
+            if (_disableWhenDebuggerIsAttached == value) return;
+
+            _disableWhenDebuggerIsAttached = value;
 
-                if (BEWPatch.IsDebuggerAttached())
+            if (BEWPatch.IsDebuggerAttached())
+            {
+                if (_disableWhenDebuggerIsAttached)
                 {
-                    if (_disableWhenDebuggerIsAttached)
-                        UnsubscribeToUnhandledException();
-                    else
-                        SubscribeToUnhandledException();
+                    Disable();
                 }
                 else
                 {
                     SubscribeToUnhandledException();
                 }
             }
+            else
+            {
+                SubscribeToUnhandledException();
+            }
         }
     }
 
+    private bool _wasInitialized;
+
     /// <inheritdoc />
-    public IReadOnlyCollection<SubSystemSettingsDeclaration<ExceptionHandlerSubSystem>> Declarations { get; } = new SubSystemSettingsDeclaration<ExceptionHandlerSubSystem>[]
-    {
+    public IReadOnlyCollection<SubSystemSettingsDeclaration<ExceptionHandlerSubSystem>> Declarations { get; } =
+    [
         new SubSystemSettingsPropertyBool<ExceptionHandlerSubSystem>(
             "{=B7bfrDNzIk} Disable when Debugger is Attached",
             "{=r3ktQzFMRz} Stops the Exception Handler when a debugger is attached.",
             x => x.DisableWhenDebuggerIsAttached),
-    };
+    ];
 
 
     public ExceptionHandlerSubSystem()
@@ -73,12 +79,19 @@ public ExceptionHandlerSubSystem()
 
     public void Enable()
     {
+        if (!_wasInitialized)
+        {
+            _wasInitialized = true;
+            var isEnabledViaSettings = SettingsProvider.PopulateSubSystemSettings(this) ?? true;
+            if (!isEnabledViaSettings) return;
+        }
+
         if (IsEnabled) return;
         IsEnabled = true;
 
         if (!BEWPatch.IsDebuggerAttached())
             SubscribeToUnhandledException();
-        else if (Instance?.DisableWhenDebuggerIsAttached == true)
+        else if (_disableWhenDebuggerIsAttached)
             return;
 
         if (!_wasButrLoaderInterceptorCalled)

diff --git a/src/Bannerlord.ButterLib/Options/ButterLibOptions.cs b/src/Bannerlord.ButterLib/Options/ButterLibOptions.cs
@@ -1,6 +1,8 @@
-namespace Bannerlord.ButterLib.Options;
+using Microsoft.Extensions.Logging;
+
+namespace Bannerlord.ButterLib.Options;
 
 public sealed class ButterLibOptions
 {
-    public int MinLogLevel { get; set; }
+    public int MinLogLevel { get; set; } = (int) LogLevel.Information;
 }
diff --git a/src/Bannerlord.ButterLib/Options/JsonButterLibOptionsModel.cs b/src/Bannerlord.ButterLib/Options/JsonButterLibOptionsModel.cs