Plugin.hpp

// SPDX-FileCopyrightText: 2026 Vincent Leroy
// SPDX-License-Identifier: MIT
//
// This file is part of dfx.
//
// Licensed under the MIT License. See the LICENSE file in the project root
// for full license information.
 
#pragma once
 
// Standard includes
#include <memory>
 
// Third-party includes
#include <nlohmann/json.hpp>
 
// Project includes
#include "SharedLibrary.hpp"
#include <dfx-plugins-interface/PluginInterface.h>
#include <dfx-utilities/CopyMoveControl.hpp>
 
namespace dfx::Plugins
{
class Plugin
{
    friend class Registry;
 
public:
    static nlohmann::json const pluginMetadataSchema;
 
public:
    explicit Plugin() = default;

    explicit Plugin(fs::path path);

    ~Plugin();
 
    // Plugins are not copiable nor movable because they pass the this pointer to C code as context
    DFX_DISABLE_COPY_AND_MOVE(Plugin);
 
public:
    void loadAndInitPlugin(dfx_registration_api_t const & reg,
                           std::string const & pluginConfig,
                           fs::path const & basePath,
                           SharedLibrary::LoadFlags loadFlags = SharedLibrary::defaultLoadFlags);

    dfx_env_api_t & pluginEnv() noexcept             { return _env; }
    dfx_env_api_t const & pluginEnv() const noexcept { return _env; }

    fs::path const & pluginPath() const noexcept      { return _path; }
    SharedLibraryPtr const & lib() const noexcept     { return _lib; }
    nlohmann::json const & metadata() const noexcept  { return _metadata; }
 
public:
    std::string name() const    { return _metadata.value("name", std::string()); }
    std::string version() const { return _metadata.value("version", std::string()); }

    std::vector<std::string> const & registeredTransportScheme() const noexcept { return _registeredTransportScheme; }
    std::vector<std::string> const & registeredNodeType() const noexcept        { return _registeredNodeType; }
 
public:
    static nlohmann::json readMetadataOfPluginAt(fs::path const & path);
 
private:
    dfx_env_api_t _env{};
 
    fs::path _path;
    fs::path _pluginDir;
    SharedLibraryPtr _lib;
    nlohmann::json _metadata;
 
    decltype(&dfx_deinit_plugin) _deinitFunc = nullptr;
 
    // These vectors are filled by the Registry
    std::vector<std::string> _registeredTransportScheme;
    std::vector<std::string> _registeredNodeType;
};
 
using PluginPtr = std::unique_ptr<Plugin>;
} // !namespace dfx::Plugins