setupapi: Introduce DevInfo methods for cleaner code

Signed-off-by: Simon Rozman <simon@rozman.si>

diff --git a/setupapi/setupapi_windows.go b/setupapi/setupapi_windows.go
index 43d0d28af114b964c03762ecdd3ca4698abd37a7..d87520b9914b7c3dbef6bd7f5bbb577c07a149da 100644 (file)
--- a/setupapi/setupapi_windows.go
+++ b/setupapi/setupapi_windows.go
@@ -16,7 +16,7 @@ import (
 //sys  setupDiCreateDeviceInfoListEx(ClassGUID *windows.GUID, hwndParent uintptr, MachineName *uint16, Reserved uintptr) (handle DevInfo, err error) [failretval==DevInfo(windows.InvalidHandle)] = setupapi.SetupDiCreateDeviceInfoListExW
 
 // SetupDiCreateDeviceInfoListEx function creates an empty device information set on a remote or a local computer and optionally associates the set with a device setup class.
-func SetupDiCreateDeviceInfoListEx(ClassGUID *windows.GUID, hwndParent uintptr, MachineName string) (handle DevInfo, err error) {
+func SetupDiCreateDeviceInfoListEx(ClassGUID *windows.GUID, hwndParent uintptr, MachineName string) (DeviceInfoSet DevInfo, err error) {
        var machineNameUTF16 *uint16
        if MachineName != "" {
                machineNameUTF16, err = syscall.UTF16PtrFromString(MachineName)
@@ -46,6 +46,11 @@ func SetupDiGetDeviceInfoListDetail(DeviceInfoSet DevInfo) (DeviceInfoSetDetailD
        }, nil
 }
 
+// GetDeviceInfoListDetail method retrieves information associated with a device information set including the class GUID, remote computer handle, and remote computer name.
+func (DeviceInfoSet DevInfo) GetDeviceInfoListDetail() (DeviceInfoSetDetailData *DevInfoListDetailData, err error) {
+       return SetupDiGetDeviceInfoListDetail(DeviceInfoSet)
+}
+
 //sys  setupDiCreateDeviceInfo(DeviceInfoSet DevInfo, DeviceName *uint16, ClassGUID *windows.GUID, DeviceDescription *uint16, hwndParent uintptr, CreationFlags DICD, DeviceInfoData *SP_DEVINFO_DATA) (err error) = setupapi.SetupDiCreateDeviceInfoW
 
 // SetupDiCreateDeviceInfo function creates a new device information element and adds it as a new member to the specified device information set.
@@ -69,6 +74,11 @@ func SetupDiCreateDeviceInfo(DeviceInfoSet DevInfo, DeviceName string, ClassGUID
        return &data, setupDiCreateDeviceInfo(DeviceInfoSet, deviceNameUTF16, ClassGUID, deviceDescriptionUTF16, hwndParent, CreationFlags, &data)
 }
 
+// CreateDeviceInfo method creates a new device information element and adds it as a new member to the specified device information set.
+func (DeviceInfoSet DevInfo) CreateDeviceInfo(DeviceName string, ClassGUID *windows.GUID, DeviceDescription string, hwndParent uintptr, CreationFlags DICD) (DeviceInfoData *SP_DEVINFO_DATA, err error) {
+       return SetupDiCreateDeviceInfo(DeviceInfoSet, DeviceName, ClassGUID, DeviceDescription, hwndParent, CreationFlags)
+}
+
 //sys  setupDiEnumDeviceInfo(DeviceInfoSet DevInfo, MemberIndex uint32, DeviceInfoData *SP_DEVINFO_DATA) (err error) = setupapi.SetupDiEnumDeviceInfo
 
 // SetupDiEnumDeviceInfo function returns a SP_DEVINFO_DATA structure that specifies a device information element in a device information set.
@@ -79,9 +89,19 @@ func SetupDiEnumDeviceInfo(DeviceInfoSet DevInfo, MemberIndex int) (DeviceInfoDa
        return &data, setupDiEnumDeviceInfo(DeviceInfoSet, uint32(MemberIndex), &data)
 }
 
+// EnumDeviceInfo method returns a SP_DEVINFO_DATA structure that specifies a device information element in a device information set.
+func (DeviceInfoSet DevInfo) EnumDeviceInfo(MemberIndex int) (DeviceInfoData *SP_DEVINFO_DATA, err error) {
+       return SetupDiEnumDeviceInfo(DeviceInfoSet, MemberIndex)
+}
+
 // SetupDiDestroyDeviceInfoList function deletes a device information set and frees all associated memory.
 //sys  SetupDiDestroyDeviceInfoList(DeviceInfoSet DevInfo) (err error) = setupapi.SetupDiDestroyDeviceInfoList
 
+// Close method deletes a device information set and frees all associated memory.
+func (DeviceInfoSet DevInfo) Close() error {
+       return SetupDiDestroyDeviceInfoList(DeviceInfoSet)
+}
+
 //sys  setupDiGetClassDevsEx(ClassGUID *windows.GUID, Enumerator *uint16, hwndParent uintptr, Flags DIGCF, DeviceInfoSet DevInfo, MachineName *uint16, reserved uintptr) (handle DevInfo, err error) [failretval==DevInfo(windows.InvalidHandle)] = setupapi.SetupDiGetClassDevsExW
 
 // SetupDiGetClassDevsEx function returns a handle to a device information set that contains requested device information elements for a local or a remote computer.
@@ -106,6 +126,11 @@ func SetupDiGetClassDevsEx(ClassGUID *windows.GUID, Enumerator string, hwndParen
 // SetupDiCallClassInstaller function calls the appropriate class installer, and any registered co-installers, with the specified installation request (DIF code).
 //sys  SetupDiCallClassInstaller(InstallFunction DI_FUNCTION, DeviceInfoSet DevInfo, DeviceInfoData *SP_DEVINFO_DATA) (err error) = setupapi.SetupDiCallClassInstaller
 
+// CallClassInstaller member calls the appropriate class installer, and any registered co-installers, with the specified installation request (DIF code).
+func (DeviceInfoSet DevInfo) CallClassInstaller(InstallFunction DI_FUNCTION, DeviceInfoData *SP_DEVINFO_DATA) (err error) {
+       return SetupDiCallClassInstaller(InstallFunction, DeviceInfoSet, DeviceInfoData)
+}
+
 //sys  setupDiOpenDevRegKey(DeviceInfoSet DevInfo, DeviceInfoData *SP_DEVINFO_DATA, Scope DICS_FLAG, HwProfile uint32, KeyType DIREG, samDesired uint32) (key windows.Handle, err error) [failretval==windows.InvalidHandle] = setupapi.SetupDiOpenDevRegKey
 
 // SetupDiOpenDevRegKey function opens a registry key for device-specific configuration information.
@@ -114,6 +139,11 @@ func SetupDiOpenDevRegKey(DeviceInfoSet DevInfo, DeviceInfoData *SP_DEVINFO_DATA
        return registry.Key(handle), err
 }
 
+// OpenDevRegKey method opens a registry key for device-specific configuration information.
+func (DeviceInfoSet DevInfo) OpenDevRegKey(DeviceInfoData *SP_DEVINFO_DATA, Scope DICS_FLAG, HwProfile uint32, KeyType DIREG, samDesired uint32) (key registry.Key, err error) {
+       return SetupDiOpenDevRegKey(DeviceInfoSet, DeviceInfoData, Scope, HwProfile, KeyType, samDesired)
+}
+
 //sys  setupDiGetDeviceInstallParams(DeviceInfoSet DevInfo, DeviceInfoData *SP_DEVINFO_DATA, DeviceInstallParams *_SP_DEVINSTALL_PARAMS) (err error) = setupapi.SetupDiGetDeviceInstallParamsW
 
 // SetupDiGetDeviceInstallParams function retrieves device installation parameters for a device information set or a particular device information element.
@@ -137,9 +167,19 @@ func SetupDiGetDeviceInstallParams(DeviceInfoSet DevInfo, DeviceInfoData *SP_DEV
        }, nil
 }
 
+// GetDeviceInstallParams method retrieves device installation parameters for a device information set or a particular device information element.
+func (DeviceInfoSet DevInfo) GetDeviceInstallParams(DeviceInfoData *SP_DEVINFO_DATA) (DeviceInstallParams *DevInstallParams, err error) {
+       return SetupDiGetDeviceInstallParams(DeviceInfoSet, DeviceInfoData)
+}
+
 // SetupDiGetClassInstallParams function retrieves class installation parameters for a device information set or a particular device information element.
 //sys  SetupDiGetClassInstallParams(DeviceInfoSet DevInfo, DeviceInfoData *SP_DEVINFO_DATA, ClassInstallParams *SP_CLASSINSTALL_HEADER, ClassInstallParamsSize uint32, RequiredSize *uint32) (err error) = setupapi.SetupDiGetClassInstallParamsW
 
+// GetClassInstallParams method retrieves class installation parameters for a device information set or a particular device information element.
+func (DeviceInfoSet DevInfo) GetClassInstallParams(DeviceInfoData *SP_DEVINFO_DATA, ClassInstallParams *SP_CLASSINSTALL_HEADER, ClassInstallParamsSize uint32, RequiredSize *uint32) (err error) {
+       return SetupDiGetClassInstallParams(DeviceInfoSet, DeviceInfoData, ClassInstallParams, ClassInstallParamsSize, RequiredSize)
+}
+
 //sys  setupDiSetDeviceInstallParams(DeviceInfoSet DevInfo, DeviceInfoData *SP_DEVINFO_DATA, DeviceInstallParams *_SP_DEVINSTALL_PARAMS) (err error) = setupapi.SetupDiSetDeviceInstallParamsW
 
 // SetupDiSetDeviceInstallParams function sets device installation parameters for a device information set or a particular device information element.
@@ -163,9 +203,19 @@ func SetupDiSetDeviceInstallParams(DeviceInfoSet DevInfo, DeviceInfoData *SP_DEV
        return setupDiSetDeviceInstallParams(DeviceInfoSet, DeviceInfoData, &_data)
 }
 
+// SetDeviceInstallParams member sets device installation parameters for a device information set or a particular device information element.
+func (DeviceInfoSet DevInfo) SetDeviceInstallParams(DeviceInfoData *SP_DEVINFO_DATA, DeviceInstallParams *DevInstallParams) (err error) {
+       return SetupDiSetDeviceInstallParams(DeviceInfoSet, DeviceInfoData, DeviceInstallParams)
+}
+
 // SetupDiSetClassInstallParams function sets or clears class install parameters for a device information set or a particular device information element.
 //sys  SetupDiSetClassInstallParams(DeviceInfoSet DevInfo, DeviceInfoData *SP_DEVINFO_DATA, ClassInstallParams *SP_CLASSINSTALL_HEADER, ClassInstallParamsSize uint32) (err error) = setupapi.SetupDiSetClassInstallParamsW
 
+// SetClassInstallParams method sets or clears class install parameters for a device information set or a particular device information element.
+func (DeviceInfoSet DevInfo) SetClassInstallParams(DeviceInfoData *SP_DEVINFO_DATA, ClassInstallParams *SP_CLASSINSTALL_HEADER, ClassInstallParamsSize uint32) (err error) {
+       return SetupDiSetClassInstallParams(DeviceInfoSet, DeviceInfoData, ClassInstallParams, ClassInstallParamsSize)
+}
+
 //sys  setupDiClassNameFromGuidEx(ClassGUID *windows.GUID, ClassName *uint16, ClassNameSize uint32, RequiredSize *uint32, MachineName *uint16, Reserved uintptr) (err error) = setupapi.SetupDiClassNameFromGuidExW
 
 // SetupDiClassNameFromGuidEx function retrieves the class name associated with a class GUID. The class can be installed on a local or remote computer.
@@ -238,5 +288,15 @@ func SetupDiGetSelectedDevice(DeviceInfoSet DevInfo) (DeviceInfoData *SP_DEVINFO
        return &data, setupDiGetSelectedDevice(DeviceInfoSet, &data)
 }
 
+// GetSelectedDevice method retrieves the selected device information element in a device information set.
+func (DeviceInfoSet DevInfo) GetSelectedDevice() (DeviceInfoData *SP_DEVINFO_DATA, err error) {
+       return SetupDiGetSelectedDevice(DeviceInfoSet)
+}
+
 // SetupDiSetSelectedDevice function sets a device information element as the selected member of a device information set. This function is typically used by an installation wizard.
 //sys  SetupDiSetSelectedDevice(DeviceInfoSet DevInfo, DeviceInfoData *SP_DEVINFO_DATA) (err error) = setupapi.SetupDiSetSelectedDevice
+
+// SetSelectedDevice method sets a device information element as the selected member of a device information set. This function is typically used by an installation wizard.
+func (DeviceInfoSet DevInfo) SetSelectedDevice(DeviceInfoData *SP_DEVINFO_DATA) (err error) {
+       return SetupDiSetSelectedDevice(DeviceInfoSet, DeviceInfoData)
+}

diff --git a/setupapi/setupapi_windows_test.go b/setupapi/setupapi_windows_test.go
index 8d5453f0dd1597945d4fc2503b96fc3396cd2e11..81a0a098b3ebf04860c15a0a21eb7580cce346d4 100644 (file)
--- a/setupapi/setupapi_windows_test.go
+++ b/setupapi/setupapi_windows_test.go
@@ -50,7 +50,7 @@ func TestSetupDiGetDeviceInfoListDetail(t *testing.T) {
        }
        defer devInfoList.Close()
 
-       data, err := SetupDiGetDeviceInfoListDetail(devInfoList)
+       data, err := devInfoList.GetDeviceInfoListDetail()
        if err != nil {
                t.Errorf("Error calling SetupDiGetDeviceInfoListDetail: %s", err.Error())
        } else {
@@ -73,7 +73,7 @@ func TestSetupDiGetDeviceInfoListDetail(t *testing.T) {
        }
        defer devInfoList.Close()
 
-       data, err = SetupDiGetDeviceInfoListDetail(devInfoList)
+       data, err = devInfoList.GetDeviceInfoListDetail()
        if err != nil {
                t.Errorf("Error calling SetupDiGetDeviceInfoListDetail: %s", err.Error())
        } else {
@@ -103,7 +103,7 @@ func TestSetupDiCreateDeviceInfo(t *testing.T) {
                t.Errorf("Error calling SetupDiClassNameFromGuidEx: %s", err.Error())
        }
 
-       devInfoData, err := SetupDiCreateDeviceInfo(devInfoList, deviceClassNetName, &deviceClassNetGUID, "This is a test device", 0, DICD_GENERATE_ID)
+       devInfoData, err := devInfoList.CreateDeviceInfo(deviceClassNetName, &deviceClassNetGUID, "This is a test device", 0, DICD_GENERATE_ID)
        if err != nil {
                // Access denied is expected, as the SetupDiCreateDeviceInfo() require elevation to succeed.
                if errWin, ok := err.(syscall.Errno); !ok || errWin != windows.ERROR_ACCESS_DENIED {
@@ -122,7 +122,7 @@ func TestSetupDiEnumDeviceInfo(t *testing.T) {
        defer devInfoList.Close()
 
        for i := 0; true; i++ {
-               data, err := SetupDiEnumDeviceInfo(devInfoList, i)
+               data, err := devInfoList.EnumDeviceInfo(i)
                if err != nil {
                        if errWin, ok := err.(syscall.Errno); ok && errWin == 259 /*ERROR_NO_MORE_ITEMS*/ {
                                break
@@ -163,7 +163,7 @@ func TestSetupDiOpenDevRegKey(t *testing.T) {
        defer devInfoList.Close()
 
        for i := 0; true; i++ {
-               data, err := SetupDiEnumDeviceInfo(devInfoList, i)
+               data, err := devInfoList.EnumDeviceInfo(i)
                if err != nil {
                        if errWin, ok := err.(syscall.Errno); ok && errWin == 259 /*ERROR_NO_MORE_ITEMS*/ {
                                break
@@ -171,7 +171,7 @@ func TestSetupDiOpenDevRegKey(t *testing.T) {
                        continue
                }
 
-               key, err := SetupDiOpenDevRegKey(devInfoList, data, DICS_FLAG_GLOBAL, 0, DIREG_DRV, windows.KEY_READ)
+               key, err := devInfoList.OpenDevRegKey(data, DICS_FLAG_GLOBAL, 0, DIREG_DRV, windows.KEY_READ)
                if err != nil {
                        t.Errorf("Error calling SetupDiOpenDevRegKey: %s", err.Error())
                }
@@ -187,7 +187,7 @@ func TestSetupDiGetDeviceInstallParams(t *testing.T) {
        defer devInfoList.Close()
 
        for i := 0; true; i++ {
-               data, err := SetupDiEnumDeviceInfo(devInfoList, i)
+               data, err := devInfoList.EnumDeviceInfo(i)
                if err != nil {
                        if errWin, ok := err.(syscall.Errno); ok && errWin == 259 /*ERROR_NO_MORE_ITEMS*/ {
                                break
@@ -195,9 +195,9 @@ func TestSetupDiGetDeviceInstallParams(t *testing.T) {
                        continue
                }
 
-               _, err = SetupDiGetDeviceInstallParams(devInfoList, data)
+               _, err = devInfoList.GetDeviceInstallParams(data)
                if err != nil {
-                       t.Errorf("Error calling SetupDiOpenDevRegKey: %s", err.Error())
+                       t.Errorf("Error calling SetupDiGetDeviceInstallParams: %s", err.Error())
                }
        }
 }
@@ -260,7 +260,7 @@ func TestSetupDiGetSelectedDevice(t *testing.T) {
        defer devInfoList.Close()
 
        for i := 0; true; i++ {
-               data, err := SetupDiEnumDeviceInfo(devInfoList, i)
+               data, err := devInfoList.EnumDeviceInfo(i)
                if err != nil {
                        if errWin, ok := err.(syscall.Errno); ok && errWin == 259 /*ERROR_NO_MORE_ITEMS*/ {
                                break
@@ -268,12 +268,12 @@ func TestSetupDiGetSelectedDevice(t *testing.T) {
                        continue
                }
 
-               err = SetupDiSetSelectedDevice(devInfoList, data)
+               err = devInfoList.SetSelectedDevice(data)
                if err != nil {
                        t.Errorf("Error calling SetupDiSetSelectedDevice: %s", err.Error())
                }
 
-               data2, err := SetupDiGetSelectedDevice(devInfoList)
+               data2, err := devInfoList.GetSelectedDevice()
                if err != nil {
                        t.Errorf("Error calling SetupDiGetSelectedDevice: %s", err.Error())
                } else if *data != *data2 {
@@ -281,7 +281,7 @@ func TestSetupDiGetSelectedDevice(t *testing.T) {
                }
        }
 
-       err = SetupDiSetSelectedDevice(devInfoList, nil)
+       err = devInfoList.SetSelectedDevice(nil)
        if err == nil {
                t.Errorf("SetupDiSetSelectedDevice(nil) should fail")
        } else {

diff --git a/setupapi/types_windows.go b/setupapi/types_windows.go
index ef23614d3f515df18d28e13eeb52fbad24c384f8..83a4753f1e3cd726c874134b77dcf828b1624500 100644 (file)
--- a/setupapi/types_windows.go
+++ b/setupapi/types_windows.go
@@ -31,11 +31,6 @@ type HSPFILEQ uintptr
 // DevInfo holds reference to device information set
 type DevInfo windows.Handle
 
-// Close function deletes a device information set and frees all associated memory.
-func (h DevInfo) Close() error {
-       return SetupDiDestroyDeviceInfoList(h)
-}
-
 // SP_DEVINFO_DATA is a device information structure (references a device instance that is a member of a device information set)
 type SP_DEVINFO_DATA struct {
        Size      uint32