/**
 ******************************************************************************
 *
 * @file       ophid_plugin.h
 * @author     The OpenPilot Team, http://www.openpilot.org Copyright (C) 2013.
 * @addtogroup GCSPlugins GCS Plugins
 * @{
 * @addtogroup opHIDPlugin Raw HID Plugin
 * @{
 * @brief Impliments a HID USB connection to the flight hardware as a QIODevice
 *****************************************************************************/
/*
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program 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 GNU General Public License
 * for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 */

#ifndef OPHID_PLUGIN_H
#define OPHID_PLUGIN_H

#include <QtCore/QMutex>
#include <QtCore/QThread>
#include <extensionsystem/iplugin.h>
#include "coreplugin/iconnection.h"

#include "ophid.h"
#include "ophid_global.h"
#include "ophid_usbmon.h"

class IConnection;
class RawHIDConnection;


/**
 *   Define a connection via the IConnection interface
 *   Plugin will add a instance of this class to the pool,
 *   so the connection manager can use it.
 */
class OPHID_EXPORT RawHIDConnection : public Core::IConnection {
    Q_OBJECT

public:
    RawHIDConnection();
    virtual ~RawHIDConnection();

    virtual QList < Core::IConnection::device> availableDevices();
    virtual QIODevice *openDevice(const QString &deviceName);
    virtual void closeDevice(const QString &deviceName);

    virtual QString connectionName();
    virtual QString shortName();
    virtual void suspendPolling();
    virtual void resumePolling();

    bool deviceOpened()
    {
        return RawHidHandle != NULL;
    } // Pip

protected slots:
    void onDeviceConnected();
    void onDeviceDisconnected();

private:
    RawHID *RawHidHandle;
    bool enablePolling;

protected:
    QMutex m_enumMutex;
    USBMonitor *m_usbMonitor;
    bool m_deviceOpened;
};

class OPHID_EXPORT RawHIDPlugin : public ExtensionSystem::IPlugin {
    Q_OBJECT
                   Q_PLUGIN_METADATA(IID "OpenPilot.RawHID")

public:
    RawHIDPlugin();
    ~RawHIDPlugin();

    virtual bool initialize(const QStringList &arguments, QString *error_message);
    virtual void extensionsInitialized();

private:
    RawHIDConnection *hidConnection;
    USBMonitor *m_usbMonitor;
};

#endif // OPHID_PLUGIN_H