recursive_configurable_module.h

Go to the documentation of this file.

/*
**  recursive_configurable_module.h
**
**  This is part of Shiokaze, a research-oriented fluid solver for computer graphics.
**  Created by Ryoichi Ando <rand@nii.ac.jp> on Jan 12, 2018.
**
**  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_RECURSIVE_CONFIGURABLE_MODULE_H
#define SHKZ_RECURSIVE_CONFIGURABLE_MODULE_H
//
#include <shiokaze/core/module.h>
#include <shiokaze/core/configurable.h>
#include <vector>
#include <cassert>
//
SHKZ_BEGIN_NAMESPACE
#define DEFINE_MODULE(CLASS_T,LNG_NAME,ARG_NAME,DESCRIPTION) \
    DEFINE_QUICK_ALLOC_MODULE(CLASS_T,ARG_NAME,DESCRIPTION) \
    LONG_NAME(LNG_NAME) \
    static std::unique_ptr<CLASS_T> quick_load_module( configuration &config, std::string name ) { \
        auto result = unique_alloc_module<CLASS_T>(config,ARG_NAME,name,DESCRIPTION); \
        result->recursive_load(config); \
        return result; \
    }
class recursive_configurable_module : public recursive_configurable, public module {
public:
    virtual void recursive_load ( configuration &config ) override {
        configuration::auto_group group(config,*this);
        recursive_configurable::recursive_load(config);
    }
    virtual void recursive_configure ( configuration &config ) override {
        configuration::auto_group group(config,*this);
        recursive_configurable::recursive_configure(config);
    }
};
template <class T> class recursive_configurable_driver : public configurable, public messageable {
public:
    recursive_configurable_driver ( std::string name, std::string argname="" ) : m_name(name), m_argname(argname) {}
    recursive_configurable_driver ( recursive_configurable *parent, std::string name ) : m_name(name) {
        assert(parent);
        parent->add_child(this);
    }
    void set_name( std::string long_name, std::string argname="" ) {
        m_long_name = long_name;
        if( argname.size()) m_argname = argname;
    }
    void set_argument_name( std::string argname ) {
        m_argname = argname;
    }
    void set_environment( std::string name, const void *value ) {
        m_environment[name] = value;
    }
    virtual void load ( configuration &config ) override {
        m_object = T::quick_alloc_module(config,m_name);
        if( m_long_name.size()) m_object->set_name(m_long_name);
        if( m_argname.size()) m_object->set_argument_name(m_argname);
        m_object->recursive_load(config);
    }
    virtual void configure ( configuration &config ) override {
        m_object->recursive_configure(config);
    }
    virtual void initialize( const configurable::environment_map &environment ) override {
        configurable::environment_map merged_environment(m_environment);
        merged_environment.insert(environment.begin(),environment.end());
        m_object->recursive_initialize(merged_environment);
    }
    T* operator->() { return get(); }
    const T* operator->() const { return get(); }
    T* get() { return m_object.get(); }
    const T* get() const { return m_object.get(); }
    //
private:
    //
    std::string m_name, m_long_name, m_argname;
    std::unique_ptr<T> m_object;
    configurable::environment_map m_environment;
    //
    recursive_configurable_driver( const recursive_configurable_driver & ) = delete;
    recursive_configurable_driver& operator=( const recursive_configurable_driver & ) = delete;
};
//
SHKZ_END_NAMESPACE
//
#endif