UniginePluginInfo.h

// Copyright (C), UNIGINE. All rights reserved.
#pragma once


#include <editor/UnigineEditorGlobal.h>

#include <UnigineString.h>

#include <QPluginLoader>

// Forward decl.
namespace UnigineEditor
{
class Plugin;
class PluginManager;
class PluginInfoPrivate;
class PluginManagerPrivate;
}


namespace UnigineEditor
{

struct UNIGINE_EDITOR_API PluginDependency
{
    enum class Type
    {
        REQUIRED,
        OPTION
    };

    Type type = Type::REQUIRED;
    Unigine::String name;
    Unigine::String version;
};

class UNIGINE_EDITOR_API PluginInfo
{
public:
    enum class State
    {
        INVALID,
        READ,
        RESOLVED,
        LOADED,
        RUNNING,
        STOPPED,
        UNLOADED
    };

    PluginInfo();
    ~PluginInfo();

    const char *name() const;
    const char *version() const;
    const char *vendor() const;
    const char *description() const;
    const char *compatibleVersion() const;
    Unigine::Vector<PluginDependency> dependencies() const;

    const char *absoluteFilePath() const;

    bool hasError() const;
    const char *errorString() const;

    State state() const;

    bool isInstanceOf(const char *name, const char *version) const;

    Plugin *plugin() const;

private:
    ::UnigineEditor::PluginInfoPrivate *const d;

    friend class ::UnigineEditor::PluginManagerPrivate;
};

} // namespace UnigineEditor

Q_DECLARE_METATYPE(::UnigineEditor::PluginInfo *);

namespace Unigine
{

template<typename Type>
struct Hasher;

template<>
struct Hasher<::UnigineEditor::PluginDependency>
{
    using HashType = unsigned int;
    UNIGINE_INLINE static HashType create(const ::UnigineEditor::PluginDependency &v)
    {
        return ::Unigine::Hasher<::Unigine::String>::create(v.name);
    }
};

} // namespace Unigine