Define Setup device object as base class to HID device

In fact not all Setup devices are HID devices. However all HID devices are Setup devices.

Author: Slion

Project/Hid/CsWin32.cs

@@ -16,11 +16,42 @@ class K
     {
         public static readonly Foundation.BOOLEAN TRUE = new Foundation.BOOLEAN(1);
         public static readonly Foundation.BOOLEAN FALSE = new Foundation.BOOLEAN(0);
+        //public static readonly IntPtr INVALID_HANDLE_VALUE = new IntPtr(-1L);
+        public static readonly uint INVALID_HANDLE_VALUE = uint.MaxValue;
     }
 
 
+
+
     namespace Devices.DeviceAndDriverInstallation
     {
+
+        [Flags]
+        public enum DEVICEINFOGETCLASS_FLAGS : uint
+        {
+            // Flags controlling what is included in the device information set built by SetupDiGetClassDevs
+            DIGCF_DEFAULT = 0x00000001,       // only valid with DIGCF_DEVICEINTERFACE
+            DIGCF_PRESENT = 0x00000002,
+            DIGCF_ALLCLASSES = 0x00000004,
+            DIGCF_PROFILE = 0x00000008,
+            DIGCF_DEVICEINTERFACE = 0x00000010
+        }
+
+        /// <summary>
+        /// 
+        /// </summary>
+        public partial struct SP_DEVINFO_DATA
+        {
+            unsafe public SP_DEVINFO_DATA(bool aValid = true)
+            {
+                cbSize = (uint)sizeof(SP_DEVINFO_DATA);
+                ClassGuid = Guid.Empty;
+                DevInst = K.INVALID_HANDLE_VALUE;
+                //DevInst = 0;
+                Reserved = 0;
+            }
+        }
+
         /// <summary>
         /// We used that as a fixed size buffer to be cast into SP_DEVICE_INTERFACE_DETAIL_DATA_W
         /// See: https://github.com/microsoft/CsWin32/discussions/589

Project/Hid/HidDevice.cs

@@ -31,20 +31,14 @@ namespace SharpLib.Hid
     /// Represent a HID device.
     /// Rename to RawInputDevice?
     /// </summary>
-    public class Device: IDisposable
+    public class Device: Setup.Device
     {
         /// <summary>
         /// Unique name of that HID device.
         /// Notably used as input to CreateFile.
         /// You can derive the device instance path AKA instance id from it.
         /// </summary>
         public string Name { get; private set; }
-
-        /// <summary>
-        /// Instance path uniquely identifies a device.
-        /// Can be used as input to SetupDiGetClassDevs to retrieve device handles and from there other properties.
-        /// </summary>
-        public string InstancePath { get; private set; }
 
         /// <summary>
         /// Friendly name that people should be able to read.
@@ -95,15 +89,6 @@ public Device(IntPtr hRawInputDevice)
             }
         }
 
-
-        /// <summary>
-        /// Make sure dispose is called even if the user forgot about it.
-        /// </summary>
-        ~Device()
-        {
-            Dispose();
-        }
-
         /// <summary>
         /// Private constructor.
         /// </summary>
@@ -352,8 +337,9 @@ private void SetFriendlyName()
         /// Make sure calling disposed multiple times does not crash.
         /// See: http://stackoverflow.com/questions/538060/proper-use-of-the-idisposable-interface/538238#538238
         /// </summary>
-        public void Dispose()
+        public override void Dispose()
         {
+            base.Dispose();
             Marshal.FreeHGlobal(PreParsedData);
             PreParsedData = IntPtr.Zero;
         }

Project/Hid/HidUtils.cs

@@ -127,6 +127,8 @@ namespace SharpLib.Win32
 {
     using SharpLib.ToEnum;
     using Windows.Win32.Foundation;
+    using System.ComponentModel;
+    using System.Diagnostics;
     public static class GetLastError
     {
         public static string String()
@@ -136,9 +138,30 @@ public static string String()
 
         public static WIN32_ERROR Enum()
         {
-            int err = Marshal.GetLastWin32Error();
+            int err = Int();
             return err.ToEnum<WIN32_ERROR>();
         }
 
+        public static int Int()
+        {
+            return Marshal.GetLastWin32Error();
+        }
+
+        public static void Throw()
+        {            
+            throw new Win32Exception(Int(),String());
+        }
+
+        public static void Log(string aPrefix="")
+        {
+            Trace.WriteLine(aPrefix + ".GetLastError: " + String());
+        }
+
+        public static void LogAndThrow(string aPrefix = "")
+        {
+            Log(aPrefix);
+            Throw();
+        }
+
     }
 }

Project/Hid/NativeMethods.txt

@@ -19,6 +19,9 @@ RID_DEVICE_INFO
 
 
 DEVPKEY*
-DIGCF*
+//DIGCF*
 ERROR*
 //ERROR_NO_MORE_ITEMS
+
+//INVALID_HANDLE_VALUE
+

Project/Hid/Setup/Device.cs

@@ -0,0 +1,98 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+
+/// <summary>
+/// TODO: Move it to another project SharpLibSetup
+/// </summary>
+namespace SharpLib.Setup
+{
+
+    using Windows.Win32;
+    using Windows.Win32.Foundation;
+    using Windows.Win32.Devices.DeviceAndDriverInstallation;
+    using SharpLib.Win32;
+    using System.Diagnostics;
+    using System.ComponentModel;
+
+    /// <summary>
+    /// A setup device is identified by the set it belongs to (HDEVINFO) and its informations data (SP_DEVINFO_DATA).
+    /// <see href="https://docs.microsoft.com/en-us/windows-hardware/drivers/install/device-information-sets"/>
+    /// <see cref="Windows.Win32.Devices.DeviceAndDriverInstallation.HDEVINFO"/>
+    /// <see cref="Windows.Win32.SetupDiDestroyDeviceInfoListSafeHandle"/> 
+    /// <see cref="Windows.Win32.Devices.DeviceAndDriverInstallation.SP_DEVINFO_DATA"/>
+    /// </summary>
+    public class Device : IDisposable
+    {
+
+        SetupDiDestroyDeviceInfoListSafeHandle iDevInfo;
+        SP_DEVINFO_DATA iDevInfoData = new SP_DEVINFO_DATA(true);
+        string iInstancePath;
+
+        /// <summary>
+        /// Instance path uniquely identifies a device.
+        /// Can be used as input to SetupDiGetClassDevs to retrieve device handles and from there other properties.
+        /// </summary>
+        public string InstancePath 
+        {
+            get { return iInstancePath; }
+            protected set
+            {
+                unsafe
+                {
+                    iInstancePath = value;
+                    // Get our device information set handle, that set though should contain only this device instance really
+                    iDevInfo = PInvoke.SetupDiGetClassDevs(null, iInstancePath, new HWND(0), (uint)(DEVICEINFOGETCLASS_FLAGS.DIGCF_ALLCLASSES | DEVICEINFOGETCLASS_FLAGS.DIGCF_DEVICEINTERFACE));
+                    if (iDevInfo.IsInvalid)
+                    {
+                        //GetLastError.Log();
+                        //return;
+                        GetLastError.LogAndThrow("SetupDiGetClassDevs");
+                    }
+
+                    uint index = 0;
+                    // Get our device information data
+                    fixed (SP_DEVINFO_DATA* ptrDevInfoData = &iDevInfoData) // Needed for data members apparently 
+                    {                        
+                        if (!PInvoke.SetupDiEnumDeviceInfo(iDevInfo, index++, ptrDevInfoData))
+                        {
+                            GetLastError.LogAndThrow("SetupDiEnumDeviceInfo");
+                        }
+                    }
+
+                    // Make sure we only have one item in our list
+                    SP_DEVINFO_DATA discard = new SP_DEVINFO_DATA(true);
+                    if (PInvoke.SetupDiEnumDeviceInfo(iDevInfo, index++, &discard))
+                    {
+                        throw new ArgumentException("More than one device in our information set");
+                        //GetLastError.LogAndThrow("SetupDiEnumDeviceInfo");
+                    }
+                }
+            } 
+        }
+
+
+        /// <summary>
+        /// Make sure dispose is called even if the user forgot about it.
+        /// </summary>
+        ~Device()
+        {
+            Dispose();
+        }
+
+
+        /// <summary>
+        /// Dispose is just for unmanaged clean-up.
+        /// Make sure calling disposed multiple times does not crash.
+        /// See: http://stackoverflow.com/questions/538060/proper-use-of-the-idisposable-interface/538238#538238
+        /// </summary>
+        public virtual void Dispose()
+        {
+        }
+
+
+
+
+    }
+}