Merge pull request #214 from DarthAffe/Core/IdGeneration

Improved DeviceName-generation to be more consistent after provider disposes

RGB.NET.Core/Devices/AbstractRGBDevice.cs

@@ -135,6 +135,8 @@ namespace RGB.NET.Core
         {
             try { UpdateQueue.Dispose(); } catch { /* :( */ }
             try { LedMapping.Clear(); } catch { /* this really shouldn't happen */ }
+
+            IdGenerator.ResetCounter(GetType().Assembly);
         }
 
         /// <summary>

RGB.NET.Core/Helper/DeviceHelper.cs

@@ -1,32 +1,14 @@
-using System.Collections.Generic;
+using System.Reflection;
+using System.Runtime.CompilerServices;
 
 namespace RGB.NET.Core
 {
     public static class DeviceHelper
     {
-        #region Properties & Fields
-
-        private static readonly Dictionary<string, int> MODEL_COUNTER = new();
-
-        #endregion
-
         #region Methods
 
-        public static string CreateDeviceName(string manufacturer, string model) => $"{manufacturer} {MakeUnique(model)}";
-
-        public static string MakeUnique(string model)
-        {
-            if (MODEL_COUNTER.TryGetValue(model, out int _))
-            {
-                int counter = ++MODEL_COUNTER[model];
-                return $"{model} {counter}";
-            }
-            else
-            {
-                MODEL_COUNTER.Add(model, 1);
-                return model;
-            }
-        }
+        [MethodImpl(MethodImplOptions.NoInlining)]
+        public static string CreateDeviceName(string manufacturer, string model) => IdGenerator.MakeUnique(Assembly.GetCallingAssembly(), $"{manufacturer} {model}");
 
         #endregion
     }

RGB.NET.Core/Ids/IdGenerator.cs

@@ -0,0 +1,63 @@
+using System.Collections.Generic;
+using System.Reflection;
+using System.Runtime.CompilerServices;
+
+namespace RGB.NET.Core
+{
+    public static class IdGenerator
+    {
+        #region Properties & Fields
+
+        // ReSharper disable InconsistentNaming
+        private static readonly HashSet<string> _registeredIds = new();
+        private static readonly Dictionary<Assembly, Dictionary<string, string>> _idMappings = new();
+        private static readonly Dictionary<Assembly, Dictionary<string, int>> _counter = new();
+        // ReSharper restore InconsistentNaming
+
+        #endregion
+
+        #region Methods
+
+        [MethodImpl(MethodImplOptions.NoInlining)]
+        public static string MakeUnique(string id) => MakeUnique(Assembly.GetCallingAssembly(), id);
+
+        internal static string MakeUnique(Assembly callingAssembly, string id)
+        {
+            if (!_idMappings.TryGetValue(callingAssembly, out Dictionary<string, string>? idMapping))
+            {
+                _idMappings.Add(callingAssembly, idMapping = new Dictionary<string, string>());
+                _counter.Add(callingAssembly, new Dictionary<string, int>());
+            }
+
+            Dictionary<string, int> counterMapping = _counter[callingAssembly];
+
+            if (!idMapping.TryGetValue(id, out string? mappedId))
+            {
+                mappedId = id;
+                int mappingCounter = 1;
+                while (_registeredIds.Contains(id))
+                    mappedId = $"{id} ({++mappingCounter})";
+
+                _registeredIds.Add(mappedId);
+                idMapping.Add(id, mappedId);
+            }
+
+            if (!counterMapping.ContainsKey(mappedId))
+                counterMapping.Add(mappedId, 0);
+
+            int counter = ++counterMapping[mappedId];
+            return counter <= 1 ? mappedId : $"{mappedId} ({counter})";
+        }
+
+        [MethodImpl(MethodImplOptions.NoInlining)]
+        public static void ResetCounter() => ResetCounter(Assembly.GetCallingAssembly());
+
+        internal static void ResetCounter(Assembly callingAssembly)
+        {
+            if (_counter.TryGetValue(callingAssembly, out Dictionary<string, int>? counter))
+                counter.Clear();
+        }
+
+        #endregion
+    }
+}

RGB.NET.Core/RGB.NET.Core.csproj.DotSettings

@@ -14,6 +14,7 @@
 	<s:Boolean x:Key="/Default/CodeInspection/NamespaceProvider/NamespaceFoldersToSkip/=extensions/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/CodeInspection/NamespaceProvider/NamespaceFoldersToSkip/=groups/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/CodeInspection/NamespaceProvider/NamespaceFoldersToSkip/=helper/@EntryIndexedValue">True</s:Boolean>
+	<s:Boolean x:Key="/Default/CodeInspection/NamespaceProvider/NamespaceFoldersToSkip/=ids/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/CodeInspection/NamespaceProvider/NamespaceFoldersToSkip/=leds/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/CodeInspection/NamespaceProvider/NamespaceFoldersToSkip/=mvvm/@EntryIndexedValue">True</s:Boolean>
 	<s:Boolean x:Key="/Default/CodeInspection/NamespaceProvider/NamespaceFoldersToSkip/=positioning/@EntryIndexedValue">True</s:Boolean>

RGB.NET.Core/RGBSurface.cs

@@ -265,7 +265,8 @@ namespace RGB.NET.Core
         {
             lock (_devices)
             {
-                if (device.Surface != null) throw new RGBSurfaceException($"The device '{device.DeviceInfo.Manufacturer} {device.DeviceInfo.Model}' is already attached to a surface.");
+                if (string.IsNullOrWhiteSpace(device.DeviceInfo.DeviceName)) throw new RGBDeviceException($"The device '{device.DeviceInfo.Manufacturer} {device.DeviceInfo.Model}' has no valid name.");
+                if (device.Surface != null) throw new RGBSurfaceException($"The device '{device.DeviceInfo.DeviceName}' is already attached to a surface.");
 
                 device.Surface = this;
                 device.BoundaryChanged += DeviceOnBoundaryChanged;
@@ -279,7 +280,7 @@ namespace RGB.NET.Core
         {
             lock (_devices)
             {
-                if (!_devices.Contains(device)) throw new RGBSurfaceException($"The device '{device.DeviceInfo.Manufacturer} {device.DeviceInfo.Model}' is not attached to this surface.");
+                if (!_devices.Contains(device)) throw new RGBSurfaceException($"The device '{device.DeviceInfo.DeviceName}' is not attached to this surface.");
 
                 device.BoundaryChanged -= DeviceOnBoundaryChanged;
                 device.Surface = null;

RGB.NET.Devices.Corsair/CorsairDeviceProvider.cs

@@ -99,12 +99,11 @@ namespace RGB.NET.Devices.Corsair
             for (int i = 0; i < deviceCount; i++)
             {
                 _CorsairDeviceInfo nativeDeviceInfo = (_CorsairDeviceInfo)Marshal.PtrToStructure(_CUESDK.CorsairGetDeviceInfo(i), typeof(_CorsairDeviceInfo))!;
-                CorsairRGBDeviceInfo info = new(i, RGBDeviceType.Unknown, nativeDeviceInfo);
-                if (!info.CapsMask.HasFlag(CorsairDeviceCaps.Lighting))
+                if (!((CorsairDeviceCaps)nativeDeviceInfo.capsMask).HasFlag(CorsairDeviceCaps.Lighting))
                     continue; // Everything that doesn't support lighting control is useless
 
-                CorsairDeviceUpdateQueue updateQueue = new(GetUpdateTrigger(), info.CorsairDeviceIndex);
-                switch (info.CorsairDeviceType)
+                CorsairDeviceUpdateQueue updateQueue = new(GetUpdateTrigger(), i);
+                switch (nativeDeviceInfo.type)
                 {
                     case CorsairDeviceType.Keyboard:
                         yield return new CorsairKeyboardRGBDevice(new CorsairKeyboardRGBDeviceInfo(i, nativeDeviceInfo), updateQueue);
@@ -149,7 +148,7 @@ namespace RGB.NET.Devices.Corsair
 
                             for (int channel = 0; channel < channelsInfo.channelsCount; channel++)
                             {
-                                CorsairLedId referenceLed = GetChannelReferenceId(info.CorsairDeviceType, channel);
+                                CorsairLedId referenceLed = GetChannelReferenceId(nativeDeviceInfo.type, channel);
                                 if (referenceLed == CorsairLedId.Invalid) continue;
 
                                 _CorsairChannelInfo channelInfo = (_CorsairChannelInfo)Marshal.PtrToStructure(channelInfoPtr, typeof(_CorsairChannelInfo))!;
@@ -161,7 +160,7 @@ namespace RGB.NET.Devices.Corsair
                                 {
                                     _CorsairChannelDeviceInfo channelDeviceInfo = (_CorsairChannelDeviceInfo)Marshal.PtrToStructure(channelDeviceInfoPtr, typeof(_CorsairChannelDeviceInfo))!;
 
-                                    yield return new CorsairCustomRGBDevice(new CorsairCustomRGBDeviceInfo(info, nativeDeviceInfo, channelDeviceInfo, referenceLed, ledOffset), updateQueue);
+                                    yield return new CorsairCustomRGBDevice(new CorsairCustomRGBDeviceInfo(i, nativeDeviceInfo, channelDeviceInfo, referenceLed, ledOffset), updateQueue);
                                     referenceLed += channelDeviceInfo.deviceLedCount;
 
                                     ledOffset += channelDeviceInfo.deviceLedCount;

RGB.NET.Devices.Corsair/Custom/CorsairCustomRGBDeviceInfo.cs

@@ -2,6 +2,8 @@
 // ReSharper disable UnusedMember.Global
 
 using System;
+using System.Runtime.InteropServices;
+using System.Text.RegularExpressions;
 using RGB.NET.Core;
 using RGB.NET.Devices.Corsair.Native;
 
@@ -28,12 +30,13 @@ namespace RGB.NET.Devices.Corsair
         /// <summary>
         /// Internal constructor of managed <see cref="T:RGB.NET.Devices.Corsair.CorsairCustomRGBDeviceInfo" />.
         /// </summary>
-        /// <param name="info">The info describing the the <see cref="T:RGB.NET.Devices.Corsair.CorsairCustomRGBDevice" />.</param>
+        /// <param name="deviceIndex">The index of the <see cref="T:RGB.NET.Devices.Corsair._CorsairChannelDeviceInfo" />.</param>
         /// <param name="nativeInfo">The native <see cref="T:RGB.NET.Devices.Corsair.Native._CorsairDeviceInfo" />-struct</param>
         /// <param name="channelDeviceInfo">The native <see cref="T:RGB.NET.Devices.Corsair.Native._CorsairChannelDeviceInfo"/> representing this device.</param>
         /// <param name="referenceCorsairLed">The id of the first led of this device.</param>
-        internal CorsairCustomRGBDeviceInfo(CorsairRGBDeviceInfo info, _CorsairDeviceInfo nativeInfo, _CorsairChannelDeviceInfo channelDeviceInfo, CorsairLedId referenceCorsairLed, int ledOffset)
-            : base(info.CorsairDeviceIndex, GetDeviceType(channelDeviceInfo.type), nativeInfo, GetModelName(info, channelDeviceInfo))
+        internal CorsairCustomRGBDeviceInfo(int deviceIndex, _CorsairDeviceInfo nativeInfo, _CorsairChannelDeviceInfo channelDeviceInfo, CorsairLedId referenceCorsairLed, int ledOffset)
+            : base(deviceIndex, GetDeviceType(channelDeviceInfo.type), nativeInfo,
+                   GetModelName(nativeInfo.model == IntPtr.Zero ? string.Empty : Regex.Replace(Marshal.PtrToStringAnsi(nativeInfo.model) ?? string.Empty, " ?DEMO", string.Empty, RegexOptions.IgnoreCase), channelDeviceInfo))
         {
             this.ReferenceCorsairLed = referenceCorsairLed;
             this.LedOffset = ledOffset;
@@ -73,7 +76,7 @@ namespace RGB.NET.Devices.Corsair
             }
         }
 
-        private static string GetModelName(IRGBDeviceInfo info, _CorsairChannelDeviceInfo channelDeviceInfo)
+        private static string GetModelName(string model, _CorsairChannelDeviceInfo channelDeviceInfo)
         {
             switch (channelDeviceInfo.type)
             {
@@ -100,14 +103,14 @@ namespace RGB.NET.Devices.Corsair
 
                 case CorsairChannelDeviceType.Strip:
                     // LS100 Led Strips are reported as one big strip if configured in monitor mode in iCUE, 138 LEDs for dual monitor, 84 for single
-                    if ((info.Model == "LS100 Starter Kit") && (channelDeviceInfo.deviceLedCount == 138))
+                    if ((model == "LS100 Starter Kit") && (channelDeviceInfo.deviceLedCount == 138))
                         return "LS100 LED Strip (dual monitor)";
-                    else if ((info.Model == "LS100 Starter Kit") && (channelDeviceInfo.deviceLedCount == 84))
+                    else if ((model == "LS100 Starter Kit") && (channelDeviceInfo.deviceLedCount == 84))
                         return "LS100 LED Strip (single monitor)";
                     // Any other value means an "External LED Strip" in iCUE, these are reported per-strip, 15 for short strips, 27 for long
-                    else if ((info.Model == "LS100 Starter Kit") && (channelDeviceInfo.deviceLedCount == 15))
+                    else if ((model == "LS100 Starter Kit") && (channelDeviceInfo.deviceLedCount == 15))
                         return "LS100 LED Strip (short)";
-                    else if ((info.Model == "LS100 Starter Kit") && (channelDeviceInfo.deviceLedCount == 27))
+                    else if ((model == "LS100 Starter Kit") && (channelDeviceInfo.deviceLedCount == 27))
                         return "LS100 LED Strip (long)";
                     // Device model is "Commander Pro" for regular LED strips
                     else