#pragma region CPL License
/*
Nuclex Native Framework
Copyright (C) 2002-2013 Nuclex Development Labs

This library is free software; you can redistribute it and/or
modify it under the terms of the IBM Common Public License as
published by the IBM Corporation; either version 1.0 of the
License, or (at your option) any later version.

This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
IBM Common Public License for more details.

You should have received a copy of the IBM Common Public
License along with this library
*/
#pragma endregion // CPL License

#ifndef NUCLEX_INPUT_WINDOWS_XINPUTDEVICEENUMERATOR_H
#define NUCLEX_INPUT_WINDOWS_XINPUTDEVICEENUMERATOR_H

#define WIN32_LEAN_AND_MEAN
#define VC_EXTRALEAN
#include <Windows.h>
#include <comdef.h>
#include <Wbemidl.h>

#include <set>

// --------------------------------------------------------------------------------------------- //

/// <summary>Smart pointer to a WBEM locator</summary>
_COM_SMARTPTR_TYPEDEF(IWbemLocator, IID_IWbemLocator);
/// <summary>Smart pointer to a WBEM services proxy</summary>
_COM_SMARTPTR_TYPEDEF(IWbemServices, IID_IWbemServices);
/// <summary>Smart pointer to a WBEM device instance</summary>
_COM_SMARTPTR_TYPEDEF(IEnumWbemClassObject, IID_IEnumWbemClassObject);

// --------------------------------------------------------------------------------------------- //

namespace Nuclex { namespace Input {

  // ------------------------------------------------------------------------------------------- //

  /// <summary>Enumerates the PnP devices via WMI, looking for XINPUT controllers</summary>
  class XInputDeviceEnumerator {

    /// <summary>Retrieves the VID+PID pairs of all connected XINPUT devices</summary>
    /// <returns>A set containing the VID+PID pairs of all connected XINPUT devices</returns>
    public: static std::set<DWORD> GetXInputVidPidPairs();

    /// <summary>Accesses the WBEM services interface for the local system</summary>
    /// <returns>The local system's WBEM services interface</returns>
    private: static IWbemServicesPtr getWbemServices();

    /// <summary>Creates an enumerator for the device instances in the specified class</summary>
    /// <param name="services">WBEM services an enumerator will be requested from</param>
    /// <param name="deviceClass">Type of devices whose instance will be enumerated</param>
    /// <returns>A new enumerator for the device instances of the specified class</returns>
    private: static IEnumWbemClassObjectPtr createDeviceInstanceEnumerator(
      const IWbemServicesPtr &services, const _bstr_t &deviceClass
    );

    /// <summary>Retrieves the device id of the specified PnP device instance</summary>
    /// <param name="deviceInstance">Device instance whose name will be retrieved</param>
    /// <returns>The name of the specified device instance</returns>
    private: static std::wstring getDeviceId(IWbemClassObject *deviceInstance);

    /// <summary>Checks if the specified device id is an XINPUT device id</summary>
    /// <param name="deviceId">Device id that will be checked</param>
    /// <returns>True if the specified device id was an XINPUT device id</returns>
    private: static bool isXInputDeviceId(const std::wstring &deviceId);

    /// <summary>Extracts an id from the specified device id</summary>
    /// <param name="deviceId">Device id from which the VID+PID pair will be extracted</param>
    /// <param name="idName">Name of the id that will be extracted from the device id</param>
    /// <returns>The id extracted from the specified device id</returns>
    private: static DWORD extractId(const std::wstring &deviceId, const std::wstring &idName);

  };

  // ------------------------------------------------------------------------------------------- //

}} // namespace Nuclex::Input

#endif // NUCLEX_INPUT_WINDOWS_XINPUTDEVICEENUMERATOR_H