PluginManager.h

Go to the documentation of this file.

/*
 * Copyright © 2019-2022 Université de Genève, LMU Munich - Faculty of Physics, IAP-CNRS/Sorbonne Université
 *
 * This library is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by the Free
 * Software Foundation; either version 3.0 of the License, or (at your option)
 * any later version.
 *
 * This library is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */
/*
 * PluginManager.h
 *
 *  Created on: Jul 27, 2016
 *      Author: mschefer
 */

#ifndef _SEFRAMEWORK_PLUGIN_PLUGINMANAGER_H_
#define _SEFRAMEWORK_PLUGIN_PLUGINMANAGER_H_

#include <boost/version.hpp>
#define USE_BOOST_DLL BOOST_VERSION >= 105500

#if USE_BOOST_DLL
#include <boost/dll/shared_library.hpp>
#endif
#include <boost/filesystem/path.hpp>

#include <memory>
#include <vector>

#include "SEFramework/Configuration/Configurable.h"
#include "SEFramework/Task/TaskFactoryRegistry.h"
#include "SEFramework/Plugin/PluginAPI.h"

namespace SourceXtractor {

class Plugin;

class PluginManager : public PluginAPI {
public:

  ~PluginManager() override = default;

  PluginManager(std::shared_ptr<TaskFactoryRegistry> task_factory_registry,
                std::shared_ptr<OutputRegistry> output_registry,
                std::string plugin_path,
                std::vector<std::string> plugin_list) :
        m_plugin_path(plugin_path),
        m_plugin_list(std::move(plugin_list)),
        m_task_factory_registry(std::move(task_factory_registry)),
        m_output_registry(std::move(output_registry)) {}

  void loadPlugins();

  // PluginAPI implementation
  TaskFactoryRegistry& getTaskFactoryRegistry() const override {
    return *m_task_factory_registry;
  }

  OutputRegistry& getOutputRegistry() const override {
    return *m_output_registry;
  }

  template<typename T>
  static void registerStaticPlugin() {
    s_static_plugins.emplace_back(new T);
  }

private:
  boost::filesystem::path m_plugin_path;
  std::vector<std::string> m_plugin_list;

  std::shared_ptr<TaskFactoryRegistry> m_task_factory_registry;
  std::shared_ptr<OutputRegistry> m_output_registry;

#if USE_BOOST_DLL
  static std::vector<boost::dll::shared_library> s_loaded_plugins;
#endif
  static std::vector<std::unique_ptr<Plugin>> s_static_plugins;
};

}

#endif /* _SEFRAMEWORK_PLUGIN_PLUGINMANAGER_H_ */