iinfo.h

Go to the documentation of this file.

/**********************************************************************
 * LeechCraft - modular cross-platform feature rich internet client.
 * Copyright (C) 2006-2014  Georg Rudoy
 *
 * Distributed under the Boost Software License, Version 1.0.
 * (See accompanying file LICENSE or copy at https://www.boost.org/LICENSE_1_0.txt)
 **********************************************************************/
 
#pragma once
 
#include <memory>
#include <QString>
#include <QStringList>
#include <QtPlugin>
#include "structures.h"
 
class ICoreProxy;
typedef std::shared_ptr<ICoreProxy> ICoreProxy_ptr;

class Q_DECL_EXPORT IInfo
{
public:
    virtual void Init (ICoreProxy_ptr proxy) = 0;

    virtual void SecondInit () = 0;

    virtual QByteArray GetUniqueID () const = 0;

    virtual QString GetName () const = 0;

    virtual QString GetInfo () const = 0;

    virtual QStringList Provides () const
    {
        return QStringList ();
    }

    virtual QStringList Needs () const
    {
        return QStringList ();
    }

    virtual QStringList Uses () const
    {
        return QStringList ();
    }

    virtual void SetProvider (QObject* object,
            const QString& feature)
    {
        Q_UNUSED (object);
        Q_UNUSED (feature);
    }

    virtual void Release () = 0;

    virtual QIcon GetIcon () const = 0;

    virtual ~IInfo () {}
 
    // implementation details
    virtual void SetProxy (ICoreProxy_ptr) = 0;
    virtual const ICoreProxy_ptr& GetProxy () = 0;
    virtual void SetPluginInstance (QObject*) = 0;
};
 
Q_DECLARE_INTERFACE (IInfo, "org.Deviant.LeechCraft.IInfo/1.0")
 
#define CURRENT_API_LEVEL 21
 
#define LC_EXPORT_PLUGIN(file,klass) \
    ICoreProxy_ptr klass::S_Proxy_;     \
    QObject* klass::S_Plugin_; \
    const ICoreProxy_ptr& GetProxyHolder () { return klass::S_Proxy_; } \
    QObject* GetPluginInstance () { return klass::S_Plugin_; } \
    \
    extern "C"\
    {\
        Q_DECL_EXPORT quint64 GetAPILevels () { return CURRENT_API_LEVEL; } \
    }
 
const ICoreProxy_ptr& GetProxyHolder ();
 
QObject* GetPluginInstance ();
 
#ifdef __clang__
#define LC_PUSH_OVERRIDE_WARNING \
    _Pragma("clang diagnostic push") \
    _Pragma("clang diagnostic ignored \"-Winconsistent-missing-override\"")
#define LC_POP_OVERRIDE_WARNING \
    _Pragma("clang diagnostic pop")
#else
#define LC_PUSH_OVERRIDE_WARNING
#define LC_POP_OVERRIDE_WARNING
#endif
 
#define DEFINE_PROXY \
    static ICoreProxy_ptr S_Proxy_; \
    static QObject *S_Plugin_; \
    LC_PUSH_OVERRIDE_WARNING \
    void SetProxy (ICoreProxy_ptr proxy) { S_Proxy_ = std::move (proxy); } \
    const ICoreProxy_ptr& GetProxy () { return S_Proxy_; } \
    void SetPluginInstance (QObject *instance) { S_Plugin_ = instance; } \
    LC_POP_OVERRIDE_WARNING \
    friend const ICoreProxy_ptr& ::GetProxyHolder (); \
    friend QObject* ::GetPluginInstance ();
 
#define LC_PLUGIN_METADATA(id) \
    Q_PLUGIN_METADATA (IID id) \
    DEFINE_PROXY