AbstractPluginLoader.h

Go to the documentation of this file.

/*  This file is part of Charon.

 Charon 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 of the License, or
 (at your option) any later version.

 Charon 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 Charon.  If not, see <http://www.gnu.org/licenses/>.
 */
#ifndef ABSTRACTPLUGINLOADER_H_
#define ABSTRACTPLUGINLOADER_H_

#include "ParameteredObject.hxx"
#include <iostream>
#include <stdexcept>

class charon_plugins_DLL_PUBLIC AbstractPluginLoader {
protected:
    std::string pluginName;

    ParameteredObject* (*create) (
        const std::string&, ParameteredObject::template_type);

    void (*destroy) (ParameteredObject*);

    ParameteredObject::build_type (*getBuildType)();

    std::vector<std::string>& pluginPaths;

    std::string &libSuffix;

    PluginManagerInterface::PluginVersionCheckLevel _versionCheck;

public:

    class charon_plugins_DLL_PUBLIC PluginException: public std::runtime_error {
    public:
        enum ErrorCode {
            FILE_NOT_FOUND = 1,
            FILE_DAMAGED = 2,
            INVALID_PLUGIN_FORMAT = 3,
            ALREADY_LOADED = 4,
            PLUGIN_NOT_LOADED = 5,
            NO_SUCH_INSTANCE = 6,
            DUPLICATE_INSTANCE_NAME = 7,
            INCOMPATIBLE_BUILD_TYPE = 8,
            VERSION_INFORMATION_MISSING = 9,
            VERSION_MISSMATCH = 10,
            OTHER = 0
        };


        PluginException(const std::string & message,
                const std::string & pluginName = "", ErrorCode err = OTHER);


        const std::string & getPluginName() const;


        ErrorCode getErrorCode() const;

        virtual ~PluginException() throw ();

    private:
        std::string _nameOfPlugin;

        ErrorCode _err;
    };


    AbstractPluginLoader(const std::string& name,
            std::vector<std::string> &plpaths, std::string& lSuffix,
            PluginManagerInterface::PluginVersionCheckLevel versionCheck =
                    PluginManagerInterface::PluginVersionIgnore);


    virtual void load() throw (PluginException) = 0;


    virtual void unload() throw (PluginException) = 0;


    virtual const std::string& getName() const;


    virtual ParameteredObject * createInstance(const std::string & name,
        ParameteredObject::template_type t = ParameteredObject::TYPE_DOUBLE)
        throw (PluginException);


    virtual void destroyInstance(ParameteredObject * p)
        throw (PluginException);


    virtual ~AbstractPluginLoader();
};

#endif /* ABSTRACTPLUGINLOADER_H_ */