extensionmanager.h

Go to the documentation of this file.

 
#pragma once
 
#include "sdk/ExtensionHost.hpp"
#include "sdk/IGuiExtension.hpp"
#include <QSettings>
#include <functional>
#include <memory>
#include <vector>
 
namespace openswmmvis
{
struct GuiExtensionRecord {
    OpenSWMM::Sdk::ExtensionInfo info; 
    OpenSWMM::Sdk::CompatibilityManifest builtAgainst; 
    QString path;                                      
    QString state;                  
    QString error;                  
    QString warning;                
    bool enabled = true;            
    bool loaded = false;            
    bool requiresEngineAbi = false; 
    QList<OpenSWMM::Sdk::ExtensionInfo> children; 
};
 
class ExtensionManager : public QObject
{
    Q_OBJECT
public:
    using HostFactory =
        std::function<std::unique_ptr<OpenSWMM::Sdk::ExtensionHost>(const QString &)>;
    explicit ExtensionManager(OpenSWMM::Sdk::CompatibilityManifest manifest, QSettings *settings,
                              QObject *parent = nullptr);
    ~ExtensionManager() override;
    static ExtensionManager *instance();
    static OpenSWMM::Sdk::CompatibilityManifest buildManifest();
    OpenSWMM::Sdk::CompatibilityManifest manifest() const { return mManifest; }
    void setEngineRuntimeAbiTag(const QString &tag);
    static QString compatibilityError(const OpenSWMM::Sdk::CompatibilityManifest &host,
                                      const OpenSWMM::Sdk::CompatibilityManifest &plugin,
                                      bool requiresEngineAbi, QString *warning = nullptr);
    QList<GuiExtensionRecord> records() const { return mRecords; }
    QStringList directories() const;
    void addDirectory(const QString &path);
    void setEnabled(const QString &id, bool enabled);
    void rescan();
    void start(HostFactory factory, bool safeMode = false);
    void shutdown();
    void refreshModels();
    bool safeMode() const { return mSafeMode; }
signals:
    void changed();
 
private:
    struct Loaded;
    OpenSWMM::Sdk::CompatibilityManifest mManifest;
    QSettings *mSettings;
    QList<GuiExtensionRecord> mRecords;
    std::vector<std::unique_ptr<Loaded>> mLoaded;
    QHash<QString, QString> mFailures, mWarnings;
    bool mStarted = false, mSafeMode = false;
};
}