Plugin.h

//
//  Created by Bradley Austin Davis on 2015/08/08
//  Copyright 2015 High Fidelity, Inc.
//
//  Distributed under the Apache License, Version 2.0.
//  See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
//
#pragma once
 
#include <assert.h>
 
#include <QString>
#include <QObject>
 
#include "Forward.h"
 
class Plugin : public QObject {
    Q_OBJECT
public:
    virtual const QString getName() const = 0;
 
    typedef enum { STANDARD, ADVANCED, DEVELOPER } grouping;
 
    virtual grouping getGrouping() const { return STANDARD; }
 
    virtual const QString getID() const { assert(false); return UNKNOWN_PLUGIN_ID; }
 
    virtual bool isSupported() const;
 
    void setContainer(PluginContainer* container);
 
    virtual void init();
 
    virtual void deinit();
 
    virtual bool activate() {
        _active = true;
        return _active;
    }
 
    virtual void deactivate() {
        _active = false;
    }
 
    virtual bool isActive() {
        return _active;
    }
    virtual bool startStandBySession() {
        _sessionStatus = true;
        return _sessionStatus;
    }
 
    virtual void endSession() {
        _sessionStatus = false;
    }
 
    virtual bool isSessionActive() {
        return _sessionStatus;
    }
 
    virtual void idle();
 
    virtual void saveSettings() const {}
    virtual void loadSettings() {}
    virtual bool isRunning() const { return _active; }
 
signals:
    void deviceStatusChanged(const QString& deviceName, bool isRunning) const;
 
    // These signals should be emitted when a device is first known to be available. In some cases this will
    // be in `init()`, in other cases, like Neuron, this isn't known until activation.
    // SDL2 isn't a device itself, but can have 0+ subdevices. subdeviceConnected is used in this case.
    void deviceConnected(QString pluginName) const;
    void subdeviceConnected(QString pluginName, QString subdeviceName) const;
 
protected:
    bool _active { false };
    bool _enabled { false };
    bool _sessionStatus { false };
    PluginContainer* _container { nullptr };
    static const char* UNKNOWN_PLUGIN_ID;
 
};