WdkHidDeviceHandle.h

// This file is a part of the OpenSurgSim project.
// Copyright 2013, SimQuest Solutions Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#ifndef SURGSIM_DEVICES_MULTIAXIS_WIN32_WDKHIDDEVICEHANDLE_H
#define SURGSIM_DEVICES_MULTIAXIS_WIN32_WDKHIDDEVICEHANDLE_H

#include <string>
#include <memory>
#include <array>
#include <vector>

#include "SurgSim/Devices/MultiAxis/SystemInputDeviceHandle.h"


// The following structure is defined by the Windows HID API, but we don't want to include the whole thing here.
struct _HIDP_CAPS;


namespace SurgSim
{
namespace Framework
{
class Logger;
};  // namespace Framework

namespace Devices
{

class WdkHidDeviceHandle : public SystemInputDeviceHandle
{
public:
    ~WdkHidDeviceHandle();

    static std::vector<std::string> enumeratePaths(SurgSim::Framework::Logger* logger);

    static std::unique_ptr<WdkHidDeviceHandle> open(const std::string& path,
        std::shared_ptr<SurgSim::Framework::Logger> logger);

    std::string getDeviceName() const override;

    bool getDeviceIds(int* vendorId, int* productId) const override;

    bool hasTranslationAndRotationAxes() const override;

    bool updateStates(AxisStates* axisStates, ButtonStates* buttonStates, bool* updated) override;

    void prepareForShutdown() override;

private:
    explicit WdkHidDeviceHandle(std::shared_ptr<SurgSim::Framework::Logger>&& logger);

    // Prevent copy construction and copy assignment.  (VS2012 does not support "= delete" yet.)
    WdkHidDeviceHandle(const WdkHidDeviceHandle& other) /*= delete*/;
    WdkHidDeviceHandle& operator=(const WdkHidDeviceHandle& other) /*= delete*/;

    bool getCapabilities(struct _HIDP_CAPS* capabilities) const;

    bool startAsynchronousRead();

    bool finishAsynchronousRead(size_t* numBytesRead);

    void cancelAsynchronousRead();

    void decodeStateUpdates(const unsigned char* rawData, size_t rawDataSize,
        AxisStates* axisStates, ButtonStates* buttonStates, bool* updated);


    struct State;
    std::unique_ptr<State> m_state;
};

};  // namespace Devices
};  // namespace SurgSim

#endif  // SURGSIM_DEVICES_MULTIAXIS_WIN32_WDKHIDDEVICEHANDLE_H