improve destructor logging

Author: al2me6

Source/DynamicProperties/Disposable.cs

@@ -0,0 +1,39 @@
+using System;
+using KSPBuildTools;
+
+namespace Shabby.DynamicProperties;
+
+public abstract class Disposable : IDisposable
+{
+	protected virtual bool IsUnused() => false;
+
+	protected abstract void OnDispose();
+
+	private bool _disposed = false;
+
+	private void HandleDispose(bool disposing)
+	{
+		if (_disposed) return;
+
+		if (disposing) {
+			Log.Debug($"disposing {GetType().Name} instance {GetHashCode()}");
+			OnDispose();
+		} else if (!IsUnused()) {
+			Log.Warning(
+				$"active {GetType().Name} instance {GetHashCode()} was not disposed");
+		}
+
+		_disposed = true;
+	}
+
+	public void Dispose()
+	{
+		HandleDispose(true);
+		GC.SuppressFinalize(this);
+	}
+
+	~Disposable()
+	{
+		HandleDispose(false);
+	}
+}

Source/DynamicProperties/MaterialPropertyManager.cs

@@ -43,8 +43,9 @@ private void OnDestroy()
 		MpbCompilerCache.CheckCleared();
 
 		// Poor man's GC :'(
-		MaterialColorUpdaterPatch.temperatureColorProps.Clear();
-		ModuleColorChangerPatch.mccProps.Clear();
+		PartPatch.ClearOnSceneSwitch();
+		MaterialColorUpdaterPatch.ClearOnSceneSwitch();
+		ModuleColorChangerPatch.ClearOnSceneSwitch();
 
 		this.LogMessage("destroyed");
 	}

Source/DynamicProperties/MpbCompiler.cs

@@ -1,14 +1,13 @@
 #nullable enable
 
-using System;
 using System.Collections.Generic;
 using System.Runtime.CompilerServices;
 using KSPBuildTools;
 using UnityEngine;
 
 namespace Shabby.DynamicProperties;
 
-internal class MpbCompiler : IDisposable
+internal class MpbCompiler : Disposable
 {
 	#region Fields
 
@@ -126,43 +125,22 @@ private void ApplyAll()
 		}
 
 		foreach (var dead in _deadRenderers) {
-			MaterialPropertyManager.Instance.LogDebug($"dead renderer {dead.GetHashCode()}");
-			MaterialPropertyManager.Instance.Remove(dead);
+			MaterialPropertyManager.Instance?.LogDebug($"dead renderer {dead.GetHashCode()}");
+			MaterialPropertyManager.Instance?.Remove(dead);
 		}
 
 		_deadRenderers.Clear();
 	}
 
 	#endregion
 
-	#region dtor
+	protected override bool IsUnused() => linkedRenderers.Count == 0;
 
-	private bool _disposed = false;
-
-	private void HandleDispose()
+	protected override void OnDispose()
 	{
-		if (_disposed) return;
-
-		Log.Debug($"disposing MPB compiler instance {RuntimeHelpers.GetHashCode(this)}");
-
 		foreach (var props in Cascade) {
 			props.OnEntriesChanged -= OnPropsEntriesChanged;
 			props.OnValueChanged -= OnPropsValueChanged;
 		}
-
-		_disposed = true;
-	}
-
-	public void Dispose()
-	{
-		HandleDispose();
-		GC.SuppressFinalize(this);
-	}
-
-	~MpbCompiler()
-	{
-		HandleDispose();
 	}
-
-	#endregion
 }

Source/DynamicProperties/MpbCompilerCache.cs

@@ -1,3 +1,4 @@
+using System;
 using System.Collections.Generic;
 using System.Runtime.CompilerServices;
 using KSPBuildTools;

Source/DynamicProperties/Patches/MaterialColorUpdaterPatch.cs

@@ -6,24 +6,22 @@
 namespace Shabby.DynamicProperties;
 
 [HarmonyPatch(typeof(MaterialColorUpdater))]
-public class MaterialColorUpdaterPatch
+internal class MaterialColorUpdaterPatch : StockPatchBase<MaterialColorUpdater>
 {
-	internal static readonly Dictionary<MaterialColorUpdater, Props> temperatureColorProps = [];
-
 	[HarmonyPostfix]
 	[HarmonyPatch("CreateRendererList")]
 	private static void MaterialColorUpdater_CreateRendererList_Postfix(
 		MaterialColorUpdater __instance)
 	{
-		var props = temperatureColorProps[__instance] = new Props(int.MinValue + 1);
+		var props = Props[__instance] = new Props(int.MinValue + 1);
 		foreach (var renderer in __instance.renderers) {
 			MaterialPropertyManager.Instance?.Set(renderer, props);
 		}
 	}
 
 	private static void Update_SetProperty(MaterialColorUpdater mcu)
 	{
-		temperatureColorProps[mcu].SetColor(mcu.propertyID, mcu.setColor);
+		Props[mcu].SetColor(mcu.propertyID, mcu.setColor);
 	}
 
 	[HarmonyTranspiler]
@@ -64,7 +62,7 @@ private static IEnumerable<CodeInstruction> Update_Transpiler(
 	private static void DisposeIfExists(MaterialColorUpdater mcu)
 	{
 		if (mcu == null) return;
-		if (temperatureColorProps.TryGetValue(mcu, out var props)) props.Dispose();
+		if (Props.TryGetValue(mcu, out var props)) props.Dispose();
 	}
 
 	[HarmonyPrefix]

Source/DynamicProperties/Patches/ModuleColorChangerPatch.cs

@@ -1,25 +1,22 @@
-using System.Collections.Generic;
 using HarmonyLib;
 
 namespace Shabby.DynamicProperties;
 
 [HarmonyPatch(typeof(ModuleColorChanger))]
-internal class ModuleColorChangerPatch
+internal class ModuleColorChangerPatch : StockPatchBase<ModuleColorChanger>
 {
-	internal static readonly Dictionary<ModuleColorChanger, Props> mccProps = [];
-
 	[HarmonyPostfix]
 	[HarmonyPatch(nameof(ModuleColorChanger.OnStart))]
 	private static void OnStart_Postfix(ModuleColorChanger __instance)
 	{
-		mccProps[__instance] = new Props(0);
+		Props[__instance] = new Props(0);
 	}
 
 	[HarmonyPostfix]
 	[HarmonyPatch("EditRenderers")]
 	private static void EditRenderers_Postfix(ModuleColorChanger __instance)
 	{
-		var props = mccProps[__instance];
+		var props = Props[__instance];
 		foreach (var renderer in __instance.renderers) {
 			MaterialPropertyManager.Instance?.Set(renderer, props);
 		}
@@ -29,7 +26,7 @@ private static void EditRenderers_Postfix(ModuleColorChanger __instance)
 	[HarmonyPatch("UpdateColor")]
 	public static bool UpdateColor_Prefix(ModuleColorChanger __instance)
 	{
-		mccProps[__instance].SetColor(__instance.shaderPropertyInt, __instance.color);
+		Props[__instance].SetColor(__instance.shaderPropertyInt, __instance.color);
 		return false;
 	}
 
@@ -38,7 +35,7 @@ public static bool UpdateColor_Prefix(ModuleColorChanger __instance)
 	private static void Part_OnDestroy_Postfix(Part __instance)
 	{
 		foreach (var mcc in __instance.FindModulesImplementing<ModuleColorChanger>()) {
-			if (mccProps.Remove(mcc, out var props)) props.Dispose();
+			if (Props.Remove(mcc, out var props)) props.Dispose();
 		}
 	}
 

Source/DynamicProperties/Patches/PartPatch.cs

@@ -6,22 +6,20 @@
 namespace Shabby.DynamicProperties;
 
 [HarmonyPatch(typeof(Part))]
-internal static class PartPatch
+internal class PartPatch : StockPatchBase<Part>
 {
-	private static readonly Dictionary<Part, Props> rimHighlightProps = [];
-
 	[HarmonyPostfix]
 	[HarmonyPatch("Awake")]
 	private static void Awake_Postfix(Part __instance)
 	{
-		rimHighlightProps[__instance] = new Props(int.MinValue + 1);
+		Props[__instance] = new Props(int.MinValue + 1);
 	}
 
 	[HarmonyPostfix]
 	[HarmonyPatch("CreateRendererLists")]
 	private static void CreateRendererLists_Postfix(Part __instance)
 	{
-		var props = rimHighlightProps[__instance];
+		var props = Props[__instance];
 		props.SetFloat(PropertyIDs._RimFalloff, 2f);
 		props.SetColor(PropertyIDs._RimColor, Part.defaultHighlightNone);
 		foreach (var renderer in __instance.HighlightRenderer) {
@@ -35,13 +33,13 @@ private static bool SetOpacity_Prefix(Part __instance, float opacity)
 	{
 		__instance.CreateRendererLists();
 		__instance.mpb.SetFloat(PropertyIDs._Opacity, opacity);
-		rimHighlightProps[__instance].SetFloat(PropertyIDs._Opacity, opacity);
+		Props[__instance].SetFloat(PropertyIDs._Opacity, opacity);
 		return false;
 	}
 
 	private static void Highlight_SetRimColor(Part part, Color color)
 	{
-		rimHighlightProps[part].SetColor(PropertyIDs._RimColor, color);
+		Props[part].SetColor(PropertyIDs._RimColor, color);
 	}
 
 	[HarmonyTranspiler]
@@ -122,7 +120,7 @@ private static IEnumerable<CodeInstruction> Highlight_Transpiler(
 	[HarmonyPatch("OnDestroy")]
 	private static void OnDestroy_Postfix(Part __instance)
 	{
-		if (rimHighlightProps.Remove(__instance, out var props)) {
+		if (Props.Remove(__instance, out var props)) {
 			props.Dispose();
 		}
 	}

Source/DynamicProperties/Patches/StockPatch.cs

@@ -0,0 +1,17 @@
+using System.Collections.Generic;
+using KSPBuildTools;
+
+namespace Shabby.DynamicProperties;
+
+internal abstract class StockPatchBase<T>
+{
+	internal static readonly Dictionary<T, Props> Props = [];
+
+	internal static void ClearOnSceneSwitch()
+	{
+		if (Props.Count == 0) return;
+
+		Log.Message($"cleared {Props.Count} Props instances", $"[{typeof(T).Name} MPM Patch]");
+		Props.Clear();
+	}
+}