pluginFactory.h

/* Copyright (c) 2013-2017, EPFL/Blue Brain Project
 *                          Raphael Dumusc <raphael.dumusc@epfl.ch>
 *                          Stefan.Eilemann@epfl.ch
 *
 * This file is part of Lunchbox <https://github.com/Eyescale/Lunchbox>
 *
 * This library is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License version 2.1 as published
 * by the Free Software Foundation.
 *
 * 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.
 */

#ifndef LUNCHBOX_PLUGINFACTORY_H
#define LUNCHBOX_PLUGINFACTORY_H

#include <lunchbox/algorithm.h> // used inline
#include <lunchbox/debug.h>     // LBTHROW
#include <lunchbox/dso.h>       // used inline
#include <lunchbox/file.h>      // searchDirectory() used inline
#include <lunchbox/plugin.h>    // member
#include <lunchbox/types.h>
#include <servus/uri.h> // Default template type

#include <unordered_map>

namespace lunchbox
{
template <class T>
class PluginFactory
{
public:
    typedef Plugin<T> PluginT;
    typedef std::vector<PluginT> Plugins;

    static PluginFactory& getInstance();

    bool handles(const typename T::InitDataT& initData);

    T* create(const typename T::InitDataT& initData);

    void register_(const PluginT& plugin);

    bool deregister(const PluginT& plugin);

    void deregisterAll();

    std::string getDescriptions() const;

    void load(const int version, const std::string& path,
              const std::string& pattern);
    void load(const int version, const Strings& paths,
              const std::string& pattern);

private:
    PluginFactory() {}
    PluginFactory(const PluginFactory&) = delete;
    PluginFactory(PluginFactory&&) = delete;
    PluginFactory& operator=(const PluginFactory&) = delete;
    PluginFactory& operator=(PluginFactory&&) = delete;

#pragma warning(disable : 4251)
    Plugins _plugins;
    typedef std::unordered_map<DSO*, PluginT> PluginMap;
    PluginMap _libraries;
#pragma warning(default : 4251)

    ~PluginFactory();
};
}

#include "pluginFactory.ipp" // template implementation

#endif // LUNCHBOX_PLUGINFACTORY_H