// Copyright (C) 2016 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0

#pragma once

#include "extensionsystem_global.h"

#include <utils/id.h>

#include <QObject>

#include <functional>

namespace ExtensionSystem {

namespace Internal { class IPluginPrivate; }

using TestCreator = std::function<QObject *()>;

using ObjectCreator = std::function<void *()>;
using ObjectDestructor = std::function<void(void *)>;

struct EXTENSIONSYSTEM_EXPORT ObjectCreationPolicy
{
    // Can be empty if nothing depends on it.
    Utils::Id id;
    // Objects with empty dependencies are created as soon as possible.
    QList<Utils::Id> dependsOn;
};

class EXTENSIONSYSTEM_EXPORT IPlugin : public QObject
{
    Q_OBJECT

public:
    enum ShutdownFlag {
        SynchronousShutdown,
        AsynchronousShutdown
    };

    IPlugin();
    ~IPlugin() override;

    virtual bool initialize(const QStringList &arguments, QString *errorString);
    virtual void extensionsInitialized() {}
    virtual bool delayedInitialize() { return false; }
    virtual ShutdownFlag aboutToShutdown() { return SynchronousShutdown; }
    virtual QObject *remoteCommand(const QStringList & /* options */,
                                   const QString & /* workingDirectory */,
                                   const QStringList & /* arguments */) { return nullptr; }


    // Deprecated in 10.0, use addTest()
    virtual QVector<QObject *> createTestObjects() const;
    virtual void tryCreateObjects();

protected:
    virtual void initialize() {}

    template <typename Test, typename ...Args>
    void addTest(Args && ...args) { addTestCreator([args...] { return new Test(args...); }); }
    void addTestCreator(const TestCreator &creator);

    template <typename Type>
    void addManaged(const ObjectCreationPolicy &policy = {}) {
        addManagedHelper([]() -> void * { return new Type(); },
                             [](void *p) { delete static_cast<Type *>(p); },
                             policy);
    }

    void addManagedHelper(const ObjectCreator &creator,
                          const ObjectDestructor &destructor,
                          const ObjectCreationPolicy &policy);

signals:
    void asynchronousShutdownFinished();

private:
    Internal::IPluginPrivate *d;
};

} // namespace ExtensionSystem