1.39.1 hotfix release

The caching mechansims for enum descriptions now uses the string name of the enum member instead of the underlying integer value. This is necessary to propely support enums where different members share the same value. It does make the cache a bit less performant as it now involve a ToString() call on the enum value and a string hashing, but this is still much better than the stock implementation.

Author: gotmachine

CHANGELOG.md

@@ -1,5 +1,9 @@
 ### Changelog
 
+##### 1.39.1
+**Bug fixes**
+- **FastAndFixedEnumExtensions** : fixed the caching mechanism erroring out on enums containing multiple members using the same underlying value. Was causing various issues in RO/RP1 due to such an enum being defind here.
+
 ##### 1.39.0
 **New/improved patches**
 - New performance patch : [**FasterEditorPartList**](https://github.com/KSPModdingLibs/KSPCommunityFixes/pull/326) Improve the responsiveness of the part list when switching between categories, sorting and searching by tag. Adress [issue #242](https://github.com/KSPModdingLibs/KSPCommunityFixes/issues/242) reported by @Rodg88.

GameData/KSPCommunityFixes/KSPCommunityFixes.version

@@ -2,7 +2,7 @@
   "NAME": "KSPCommunityFixes",
   "URL": "https://raw.githubusercontent.com/KSPModdingLibs/KSPCommunityFixes/master/GameData/KSPCommunityFixes/KSPCommunityFixes.version",
   "DOWNLOAD": "https://github.com/KSPModdingLibs/KSPCommunityFixes/releases",
-  "VERSION": {"MAJOR": 1, "MINOR": 39, "PATCH": 0, "BUILD": 0},
+  "VERSION": {"MAJOR": 1, "MINOR": 39, "PATCH": 1, "BUILD": 0},
   "KSP_VERSION": {"MAJOR": 1, "MINOR": 12, "PATCH": 5},
   "KSP_VERSION_MIN": {"MAJOR": 1, "MINOR": 8, "PATCH": 0},
   "KSP_VERSION_MAX": {"MAJOR": 1, "MINOR": 12, "PATCH": 5}

KSPCommunityFixes/BugFixes/FastAndFixedEnumExtensions.cs

@@ -8,7 +8,7 @@ namespace KSPCommunityFixes
 {
     internal class FastAndFixedEnumExtensions : BasePatch
     {
-        internal static Dictionary<Type, Dictionary<long, EnumMemberDescription>> enumMemberDescriptionCache = new Dictionary<Type, Dictionary<long, EnumMemberDescription>>();
+        internal static Dictionary<Type, Dictionary<string, EnumMemberDescription>> enumMemberDescriptionCache = new Dictionary<Type, Dictionary<string, EnumMemberDescription>>();
 
         internal class EnumMemberDescription
         {
@@ -31,9 +31,9 @@ protected override void ApplyPatches()
         internal static bool TryGetEnumMemberDescription(Enum enumValue, out EnumMemberDescription enumMemberDescription)
         {
             Type enumType = enumValue.GetType();
-            if (!enumMemberDescriptionCache.TryGetValue(enumType, out Dictionary<long, EnumMemberDescription> enumDescriptions))
+            if (!enumMemberDescriptionCache.TryGetValue(enumType, out Dictionary<string, EnumMemberDescription> enumDescriptions))
             {
-                enumDescriptions = new Dictionary<long, EnumMemberDescription>();
+                enumDescriptions = new Dictionary<string, EnumMemberDescription>();
                 string[] names = enumType.GetEnumNames();
 
                 foreach (string enumMemberName in names)
@@ -44,13 +44,13 @@ internal static bool TryGetEnumMemberDescription(Enum enumValue, out EnumMemberD
 
                     DescriptionAttribute descriptionAttribute = enumMembers[0].GetCustomAttribute<DescriptionAttribute>();
                     Enum enumMember = (Enum)Enum.Parse(enumType, enumMemberName);
-                    enumDescriptions.Add(enumMember.GetSignedBoxedEnumValue(), new EnumMemberDescription(enumMemberName, descriptionAttribute));
+                    enumDescriptions.Add(enumMemberName, new EnumMemberDescription(enumMemberName, descriptionAttribute));
                 }
 
                 enumMemberDescriptionCache.Add(enumType, enumDescriptions);
             }
 
-            if (enumDescriptions.TryGetValue(enumValue.GetSignedBoxedEnumValue(), out enumMemberDescription))
+            if (enumDescriptions.TryGetValue(enumValue.ToString(), out enumMemberDescription))
                 return true;
 
             return false;

KSPCommunityFixes/Library/Extensions.cs

@@ -29,35 +29,6 @@ public static bool IsPAWOpen(this Part part)
         {
             return part.PartActionWindow.IsNotNullOrDestroyed() && part.PartActionWindow.isActiveAndEnabled;
         }
-
-        /// <summary>
-        /// Get the value of a boxed enum, as a 64 bit signed integer. 
-        /// If the enum underlying type is an unsigned 64 bit integer and the value is greater than long.MaxValue, 
-        /// the result will overflow and be negative.
-        /// </summary>
-        public static long GetSignedBoxedEnumValue(this Enum enumInstance)
-        {
-            Type underlyingType = enumInstance.GetType().GetEnumUnderlyingType();
-
-            if (underlyingType == typeof(int))
-                return (int)(object)enumInstance;
-            else if (underlyingType == typeof(sbyte))
-                return (sbyte)(object)enumInstance;
-            else if (underlyingType == typeof(short))
-                return (short)(object)enumInstance;
-            else if (underlyingType == typeof(long))
-                return (long)(object)enumInstance;
-            else if (underlyingType == typeof(uint))
-                return (uint)(object)enumInstance;
-            else if (underlyingType == typeof(byte))
-                return (byte)(object)enumInstance;
-            else if (underlyingType == typeof(ushort))
-                return (ushort)(object)enumInstance;
-            else if (underlyingType == typeof(ulong))
-                return (long)(ulong)(object)enumInstance;
-
-            throw new Exception($"Enum {enumInstance.GetType()} is of unknown size");
-        }
     }
 
     static class ParticleBuffer

KSPCommunityFixes/Properties/AssemblyInfo.cs

@@ -30,9 +30,9 @@
 //      Revision
 //
 [assembly: AssemblyVersion("1.37.3.0")]
-[assembly: AssemblyFileVersion("1.39.0.0")]
+[assembly: AssemblyFileVersion("1.39.1.0")]
 
-[assembly: KSPAssembly("KSPCommunityFixes", 1, 39, 0)]
+[assembly: KSPAssembly("KSPCommunityFixes", 1, 39, 1)]
 [assembly: KSPAssemblyDependency("MultipleModulePartAPI", 1, 0, 0)]
 [assembly: KSPAssemblyDependency("ModuleManager", 1, 0)]
 [assembly: KSPAssemblyDependency("HarmonyKSP", 1, 0)]