pluginFactory.h

/* Copyright (c) 2013-2015, 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/types.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 <servus/uri.h> // Default template type

#include <boost/foreach.hpp> // used inline
#include <boost/lexical_cast.hpp> // used inline
#include <boost/noncopyable.hpp> // base class
#include <boost/unordered_map.hpp>

namespace lunchbox
{

template< class PluginT, class InitDataT = servus::URI >
class PluginFactory : public boost::noncopyable
{
public:
    typedef Plugin< PluginT, InitDataT > PluginHolder;
    typedef std::vector< PluginHolder > Plugins;

    static PluginFactory& getInstance();

    PluginT* create( const InitDataT& initData );

    void register_( const Plugin< PluginT, InitDataT >& plugin );

    bool deregister( const Plugin< PluginT, InitDataT >& plugin );

    void deregisterAll();

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

    bool unload( DSO* dso );

private:
    Plugins _plugins;

    typedef boost::unordered_map< DSO*, PluginHolder > PluginMap;
    PluginMap _libraries;

    void _load( DSOs& result, const int version, const std::string& path,
                const std::string& pattern );
};

}

#include "pluginFactory.ipp" // template implementation

#endif // LUNCHBOX_PLUGINFACTORY_H