Merge pull request #121 from CoraleStudios/feature/temp-init-endpoints

Add endpoints for init and uninit

Corale.Colore/Core/Chroma.cs

@@ -57,11 +57,6 @@ public sealed class Chroma : IChroma
         /// </summary>
         private static readonly object InitLock = new object();
 
-        /// <summary>
-        /// Keeps track of whether the SDK has been initialized.
-        /// </summary>
-        private static bool _initialized;
-
         /// <summary>
         /// Holds the application-wide instance of the <see cref="IChroma" /> interface.
         /// </summary>
@@ -82,12 +77,7 @@ public sealed class Chroma : IChroma
         /// </summary>
         private Chroma()
         {
-            Log.Info("Chroma is initializing.");
-            Log.Debug("Calling SDK Init function");
-            NativeWrapper.Init();
-            _initialized = true;
-            Log.Debug("Resetting _registeredHandle");
-            _registeredHandle = IntPtr.Zero;
+            Initialize();
         }
 
         /// <summary>
@@ -98,11 +88,7 @@ private Chroma()
         /// </remarks>
         ~Chroma()
         {
-            if (!_initialized)
-                return;
-
-            Unregister();
-            NativeWrapper.UnInit();
+            Uninitialize();
         }
 
         /// <summary>
@@ -211,15 +197,10 @@ public IKeypad Keypad
         }
 
         /// <summary>
-        /// Gets a value indicating whether the Chroma main class has been initialized or not.
+        /// Gets a value indicating whether the Chroma
+        /// SDK has been initialized or not.
         /// </summary>
-        internal static bool Initialized
-        {
-            get
-            {
-                return _instance != null;
-            }
-        }
+        public bool Initialized { get; private set; }
 
         /// <summary>
         /// Checks if the Chroma SDK is available on this system.
@@ -288,6 +269,57 @@ public static bool IsSdkAvailable()
             return dllValid && regEnabled;
         }
 
+        /// <summary>
+        /// Initializes the SDK if it hasn't already.
+        /// </summary>
+        /// <remarks>
+        /// <span style="color: red;">Manual manipulation of the SDK state is
+        /// <strong>not supported by the CoraleStudios team</strong> and may
+        /// result in <emph>undefined behaviour</emph>. Usage of this method is
+        /// <strong>at your own risk</strong>.</span>
+        /// </remarks>
+        public void Initialize()
+        {
+            if (Initialized)
+                return;
+
+            Log.Info("Chroma is initializing.");
+            Log.Debug("Calling SDK Init function");
+            NativeWrapper.Init();
+            Initialized = true;
+            Log.Debug("Resetting _registeredHandle");
+            _registeredHandle = IntPtr.Zero;
+        }
+
+        /// <summary>
+        /// Uninitializes the SDK if it has been initialized.
+        /// </summary>
+        /// <remarks>
+        /// <span style="color: red;">Manual manipulation of the SDK state is
+        /// <strong>not supported by the CoraleStudios team</strong> and may
+        /// result in <emph>undefined behaviour</emph>. Usage of this method is
+        /// <strong>at your own risk</strong>. Usage of SDK functions while
+        /// the SDK is in an <emph>uninitialized</emph> state is <strong>highly
+        /// advised against</strong> and <emph>WILL</emph> result in catastrophic
+        /// failure. <strong>YOU HAVE BEEN WARNED</strong>.</span>
+        /// </remarks>
+        public void Uninitialize()
+        {
+            if (!Initialized)
+                return;
+
+            ((Device)Keyboard).DeleteCurrentEffect();
+            ((Device)Mouse).DeleteCurrentEffect();
+            ((Device)Keypad).DeleteCurrentEffect();
+            ((Device)Mousepad).DeleteCurrentEffect();
+            ((Device)Headset).DeleteCurrentEffect();
+
+            Unregister();
+            NativeWrapper.UnInit();
+
+            Initialized = false;
+        }
+
         /// <summary>
         /// Queries the SDK for information regarding a specific device.
         /// </summary>
@@ -428,10 +460,9 @@ public void SetAll(Color color)
         /// <remarks>
         /// For internal use by singleton accessors in device interface implementations.
         /// </remarks>
-        internal static void Initialize()
+        internal static void InitInstance()
         {
-            if (!Initialized)
-                _instance = new Chroma();
+            Instance.Initialize();
         }
 
         /// <summary>

Corale.Colore/Core/Device.cs

@@ -62,14 +62,21 @@ public void Clear()
         /// <param name="guid">GUID to set.</param>
         public void SetGuid(Guid guid)
         {
-            if (CurrentEffectId != Guid.Empty)
-            {
-                NativeWrapper.DeleteEffect(CurrentEffectId);
-                CurrentEffectId = Guid.Empty;
-            }
-
+            DeleteCurrentEffect();
             NativeWrapper.SetEffect(guid);
             CurrentEffectId = guid;
         }
+
+        /// <summary>
+        /// Deletes the currently set effect.
+        /// </summary>
+        internal void DeleteCurrentEffect()
+        {
+            if (CurrentEffectId == Guid.Empty)
+                return;
+
+            NativeWrapper.DeleteEffect(CurrentEffectId);
+            CurrentEffectId = Guid.Empty;
+        }
     }
 }

Corale.Colore/Core/GenericDevice.cs

@@ -93,7 +93,7 @@ public Guid DeviceId
         [PublicAPI]
         public static IGenericDevice Get(Guid deviceId)
         {
-            Chroma.Initialize();
+            Chroma.InitInstance();
 
             if (!Instances.ContainsKey(deviceId))
                 Instances[deviceId] = new GenericDevice(deviceId);

Corale.Colore/Core/Headset.cs

@@ -55,7 +55,7 @@ public sealed class Headset : Device, IHeadset
         private Headset()
         {
             Log.Info("Headset is initializing");
-            Chroma.Initialize();
+            Chroma.InitInstance();
         }
 
         /// <summary>

Corale.Colore/Core/IChroma.cs

@@ -110,6 +110,35 @@ public interface IChroma
         [PublicAPI]
         IKeypad Keypad { get; }
 
+        /// <summary>
+        /// Gets a value indicating whether the Chroma
+        /// SDK has been initialized or not.
+        /// </summary>
+        [PublicAPI]
+        bool Initialized { get; }
+
+        /// <summary>
+        /// Initializes the SDK if it hasn't already.
+        /// </summary>
+        /// <remarks>
+        /// Manually modifying the SDK init state is <b>untested</b>
+        /// and may result in <emph>undefined behaviour</emph>, usage
+        /// is at <b>your own risk</b>.
+        /// </remarks>
+        [PublicAPI]
+        void Initialize();
+
+        /// <summary>
+        /// Uninitializes the SDK if it has been initialized.
+        /// </summary>
+        /// <remarks>
+        /// Manually modifying the SDK init state is <b>untested</b>
+        /// and may result in <emph>undefined behaviour</emph>, usage
+        /// is at <b>your own risk</b>.
+        /// </remarks>
+        [PublicAPI]
+        void Uninitialize();
+
         /// <summary>
         /// Queries the SDK for information regarding a specific device.
         /// </summary>

Corale.Colore/Core/Keyboard.cs

@@ -73,7 +73,7 @@ private Keyboard()
         {
             Log.Info("Keyboard initializing...");
 
-            Chroma.Initialize();
+            Chroma.InitInstance();
 
             CurrentEffectId = Guid.Empty;
 

Corale.Colore/Core/Keypad.cs

@@ -67,7 +67,7 @@ public sealed class Keypad : Device, IKeypad
         private Keypad()
         {
             Log.Debug("Keypad is initializing");
-            Chroma.Initialize();
+            Chroma.InitInstance();
 
             _custom = Custom.Create();
         }

Corale.Colore/Core/Mouse.cs

@@ -73,7 +73,7 @@ public sealed class Mouse : Device, IMouse
         private Mouse()
         {
             Log.Info("Mouse is initializing");
-            Chroma.Initialize();
+            Chroma.InitInstance();
             _custom = Custom.Create();
             _customGrid = CustomGrid.Create();
         }

Corale.Colore/Core/Mousepad.cs

@@ -65,7 +65,7 @@ public sealed class Mousepad : Device, IMousepad
         private Mousepad()
         {
             Log.Debug("Mousepad is initializing.");
-            Chroma.Initialize();
+            Chroma.InitInstance();
             _custom = Custom.Create();
         }