IPlugin.h

Go to the documentation of this file.

// SPDX-License-Identifier: GPLv3-or-later
//
// SPDX-FileCopyrightText: Patrick L.S. Connor <patrick.connor@cern.ch>
// SPDX-FileCopyrightText: Louis Moureaux <louis.moureaux@cern.ch>
 
#pragma once
 
#include <filesystem>
#include <iostream>
#include <memory>
#include <string>
#include <vector>
#include <type_traits>
 
#include <Options.h>
#include <Variation.h>
 
namespace Darwin::Tools {
 
class Flow;
class MetaInfo;
 
class IPlugin {
 
    std::filesystem::path file; 
 
protected:
 
    int steering = none; 
 
    bool isMC = false;
 
    virtual int GetParamsVeto () noexcept { return none; }
 
public:
    IPlugin () = default;
 
    virtual ~IPlugin ()
    {
        using namespace std;
        if (steering & verbose)
            cout << "IPlugin: destroying plugin from " << file << endl;
    }
 
    void SetPath (const std::filesystem::path& file) noexcept { this->file = file; }
 
    virtual void Load (Darwin::Tools::Flow&,
                       Darwin::Tools::MetaInfo&,
                       int = 0,
                       const boost::property_tree::ptree& = {}
                      );
};
 
template<typename P> concept Plugin = std::is_base_of_v<IPlugin, P>;
 
} // end of Darwin::Tools namespace
 
using PluginsVec = std::vector<std::unique_ptr<Darwin::Tools::IPlugin>>;
 
template<class... Plugins> PluginsVec * plugins()
{
    using namespace std;
    auto vec = new PluginsVec;
    auto _ [[maybe_unused]] = (vec->emplace_back(make_unique<Plugins>()), ..., 0);
    return vec;
}
#define DARWIN_EXPORT_PLUGIN(...) \
    extern "C" PluginsVec * CreatePlugin () { return plugins<__VA_ARGS__>(); }