module.h

Go to the documentation of this file.

/*
**  module.h
**
**  This is part of Shiokaze, a research-oriented fluid solver for computer graphics.
**  Created by Ryoichi Ando <rand@nii.ac.jp> on Feb 3, 2017.
**
**  Permission is hereby granted, free of charge, to any person obtaining a copy of
**  this software and associated documentation files (the "Software"), to deal in
**  the Software without restriction, including without limitation the rights to use,
**  copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
**  Software, and to permit persons to whom the Software is furnished to do so,
**  subject to the following conditions:
**
**  The above copyright notice and this permission notice shall be included in all copies
**  or substantial portions of the Software.
**
**  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
**  INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
**  PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
**  HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
**  CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE
**  OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
//
#ifndef SHKZ_MODULE_H
#define SHKZ_MODULE_H
//
#include <shiokaze/core/credit.h>
#include <shiokaze/core/configuration.h>
#include <iostream>
#include <memory>
#include <cassert>
#include "messageable.h"
//
SHKZ_BEGIN_NAMESPACE
//
#define DEFINE_QUICK_ALLOC_MODULE(CLASS_T,ARG_NAME,DESCRIPTION) \
    ARGUMENT_NAME(ARG_NAME) \
    static std::unique_ptr<CLASS_T> quick_alloc_module( configuration &config, std::string name ) { \
        return unique_alloc_module<CLASS_T>(config,ARG_NAME,name,DESCRIPTION); \
    }
//
class module : public credit, public messageable {
public:
    module ();
    virtual ~module();
    virtual std::string get_module_name() const { return std::string(); }
    static std::string module_libpath( std::string module_name );
    static module * alloc_module( configuration &config, std::string arg_name, std::string default_module_name, std::string description );
    static module * alloc_module( std::string path );
    static unsigned close_all_handles ();
    template <class T> static std::unique_ptr<T> unique_alloc_module( configuration &config, std::string arg_name, std::string default_module_name, std::string description ) {
        auto ptr = dynamic_cast<T*>(alloc_module(config,arg_name,default_module_name,description));
        assert(ptr);
        return std::unique_ptr<T>(ptr);
    }
    static unsigned count_open_modules();
    //
private:
    std::string m_path;
    module( const module & ) = delete;
    module& operator=( const module & ) = delete;
};
//
/******** Your binary should include the following function **********
//
extern "C" module * create_instance();
//
**********************************************************************/
//
SHKZ_END_NAMESPACE
//
#endif