pluginRegistry.h

/* Copyright (c) 2010, Cedric Stalder <cedric.stalder@gmail.com>
 *               2010-2013, Stefan Eilemann <eile@eyescale.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_PLUGINREGISTRY_H
#define LUNCHBOX_PLUGINREGISTRY_H

#include <lunchbox/api.h>
#include <lunchbox/nonCopyable.h> // base class
#include <lunchbox/types.h>
#include <lunchbox/visitorResult.h> // enum
#include <string>

namespace lunchbox
{
namespace detail { class PluginRegistry; }

class PluginRegistry : public NonCopyable
{
public:
    LUNCHBOX_API PluginRegistry();

    LUNCHBOX_API ~PluginRegistry();

    LUNCHBOX_API void addDirectory( const std::string& path );

    LUNCHBOX_API void removeDirectory( const std::string& path );

    LUNCHBOX_API const Strings& getDirectories() const;

    LUNCHBOX_API bool addLunchboxPlugins();

    LUNCHBOX_API void init();

    LUNCHBOX_API void exit();

    LUNCHBOX_API VisitorResult accept( PluginVisitor& visitor );

    LUNCHBOX_API VisitorResult accept( ConstPluginVisitor& visitor ) const;

    LUNCHBOX_API const Plugins& getPlugins() const;

    LUNCHBOX_API Plugin* findPlugin( const uint32_t name );

    LUNCHBOX_API const Plugin* findPlugin( const uint32_t name ) const;

    LUNCHBOX_API bool addPlugin( const std::string& filename );

private:
    detail::PluginRegistry* const impl_;
};
}
#endif // LUNCHBOX_PLUGINREGISTRY_H