plugin.hpp

Go to the documentation of this file.

/*************************************************************************
 * Copyright (C) 2011 by Saleh Dindar and the Swarm-NG Development Team  *
 *                                                                       *
 * This program is free software; you can redistribute it and/or modify  *
 * it under the terms of the GNU General Public License as published by  *
 * the Free Software Foundation; either version 3 of the License.        *
 *                                                                       *
 * This program 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 General Public License for more details.                          *
 *                                                                       *
 * You should have received a copy of the GNU General Public License     *
 * along with this program; if not, write to the                         *
 * Free Software Foundation, Inc.,                                       *
 * 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ************************************************************************/

#pragma once
#include "types/config.hpp"

namespace swarm {

struct plugin {
        virtual void* create(const config& cfg) = 0;
        virtual std::string description() { return ""; }
        virtual std::string id() = 0;

        static void    add(plugin* p);
        static plugin* find(const std::string& id);
        static void*   instance(const std::string& name, const config& cfg);
        static std::vector<plugin*> all();

        struct help_t{};
        static help_t help;

};

template<class T> 
struct basic_plugin : public plugin {

        std::string _id, _description;
        basic_plugin(const std::string& i, const std::string& d = std::string() ) 
                : _id(i),_description(d) {}

        virtual void* create(const config& cfg) { return new T(cfg); }
        virtual std::string id() { return _id; }
        virtual std::string description() { return _description; }
};

template<class T> 
struct plugin_initializer {
        T t;
        plugin_initializer() {
                plugin::add(&t);
        }
};


template<class T>
struct basic_plugin_initializer {
        basic_plugin<T> t;

        basic_plugin_initializer(const std::string& id
                        , const std::string& description = std::string() ) 
                : t(id,description) {
                        plugin::add(&t);
        }
};


template<class T>
struct integrator_plugin_initializer : public basic_plugin_initializer<T> {
        integrator_plugin_initializer(const std::string& id
                        , const std::string& description = std::string() ) 
                : basic_plugin_initializer<T>("integrator_" + id,description) {}
};

template<class T>
struct writer_plugin_initializer : public basic_plugin_initializer<T> {
        writer_plugin_initializer(const std::string& id
                        , const std::string& description = std::string() ) 
                : basic_plugin_initializer<T>("writer_" + id,description) {}
};

struct plugin_not_found : std::exception {
        std::string _name;
        plugin_not_found(std::string name) : _name(name) {}
        virtual ~plugin_not_found() throw(){}

        virtual const char * what() const throw() { 
                return ("Plugin \"" + _name + "\" was not found ").c_str(); 
        }
};

std::ostream& operator << (std::ostream&, const plugin::help_t&);

}