configuration.h

Go to the documentation of this file.

/*
**  configuration.h
**
**  This is part of Shiokaze, a research-oriented fluid solver for computer graphics.
**  Created by Ryoichi Ando <rand@nii.ac.jp> on July 19, 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_CONFIGURATION_H
#define SHKZ_CONFIGURATION_H
//
#include <string>
#include <map>
#include <stack>
#include <shiokaze/core/common.h>
#include <shiokaze/core/credit.h>
//
SHKZ_BEGIN_NAMESPACE
//
class configuration {
public:
    configuration();
    configuration( std::map<std::string,std::string> dictionary );
    void print_variables () const;
    void print_help() const;
    void print_splash() const;
    void check_touched () const;
    bool is_parameter_set ( std::string name ) const;
    bool check_set ( std::string name ) const;
    static void print_bar( std::string str="" );
    static void print_center( std::string str );
    struct auto_group {
        auto_group( configuration &config,
                    std::string name,
                    std::string argument_name="",
                    std::string author="",
                    std::string address="",
                    std::tuple<int,int,int> date=std::tuple<int,int,int>(0,0,0),
                    double version=0.0
         ) : config(config) {
            config.push_group(name,argument_name,author,address,date,version);
        }
        auto_group( configuration &config, const credit &info ) : config(config) {
            config.push_group(info);
        }
        ~auto_group() { config.pop_group(); }
    private:
        configuration &config;
    };
    std::string get_current_group_name( bool argument_name=false ) const;
    bool stack_empty() const { return m_group_stack.empty(); }
    void push_group( const credit &info );
    void push_group( std::string name,
                     std::string argument_name="",
                     std::string author="",
                     std::string address="",
                     std::tuple<int,int,int> date=std::tuple<int,int,int>(0,0,0),
                     double version=0.0 );
    void pop_group();
    bool get_integer( std::string name, int &value, std::string description=std::string() );
    void set_integer( std::string name, int value );
    void set_default_integer( std::string name, int value );
    bool get_unsigned( std::string name, unsigned &value, std::string description=std::string() );
    void set_unsigned( std::string name, unsigned value );
    void set_default_unsigned( std::string name, unsigned value );
    bool get_bool( std::string name, bool &value, std::string description=std::string() );
    void set_bool( std::string name, bool value );
    void set_default_bool( std::string name, bool value );
    double get_double( std::string name, double &value, std::string description=std::string() );
    void set_double( std::string name, double value );
    void set_default_double( std::string name, double value );
    bool get_real( std::string name, Real &value, std::string description=std::string() );
    void set_real( std::string name, Real value );
    void set_default_real( std::string name, Real value );
    bool get_vec2i( std::string name, int value[2], std::string description=std::string() );
    void set_vec2i( std::string name, const int value[2] );
    void set_default_vec2i( std::string name, const int value[2] );
    bool get_vec2d( std::string name, double value[2], std::string description=std::string() );
    void set_vec2d( std::string name, const double value[2] );
    void set_default_vec2d( std::string name, const double value[2] );
    bool get_vec3i( std::string name, int value[3], std::string description=std::string() );
    void set_vec3i( std::string name, const int value[3] );
    void set_default_vec3i( std::string name, const int value[3] );
    bool get_vec3d( std::string name, double value[3], std::string description=std::string());
    void set_vec3d( std::string name, const double value[3] );
    void set_default_vec3d( std::string name, const double value[3] );
    bool get_vec4d( std::string name, double value[4], std::string description=std::string());
    void set_vec4d( std::string name, const double value[4] );
    void set_default_vec4d( std::string name, const double value[4] );
    bool get_string( std::string name, std::string &value, std::string description=std::string() );
    void set_string( std::string name, std::string value );
    void set_default_string( std::string name, std::string value );
    bool exist( std::string name ) const;
    const std::map<std::string,std::string> & get_dictionary() const { return m_dictionary; }
    //
private:
    //
    struct double2 { double v[2]; };
    struct double3 { double v[3]; };
    struct double4 { double v[4]; };
    struct int2 { int v[2]; };
    struct int3 { int v[3]; };
    //
    std::map<std::string,int> default_integer;
    std::map<std::string,unsigned> default_unsigned;
    std::map<std::string,bool> default_bool;
    std::map<std::string,double> default_double;
    std::map<std::string,Real> default_real;
    std::map<std::string,double2> default_vec2d;
    std::map<std::string,double3> default_vec3d;
    std::map<std::string,double4> default_vec4d;
    std::map<std::string,int2> default_vec2i;
    std::map<std::string,int3> default_vec3i;
    std::map<std::string,std::string> default_string;
    //
    struct Entry {
        bool is_default;
        std::string type;
        std::string value;
        std::string description;
    };
    //
    struct Group {
        std::string author;
        std::string address;
        std::tuple<int,int,int> date;
        double version;
        std::map<std::string,Entry> entries;
    };
    //
    struct Title {
        std::string name;
        std::string argument_name;
        unsigned id;
        bool operator<( const Title &a ) const { return id < a.id; }
    };
    //
    void register_variables ( std::string name, bool is_default, std::string type, std::string value, std::string description );
    //
    void print_credit( const Group &group ) const;
    void print_groupbar( const Title &group_title, const Group &group ) const;
    std::string concated_name( std::string name ) const;
    //
    std::map<std::string,std::string> m_dictionary;
    std::map<Title,Group> m_groups;
    std::stack<Title> m_group_stack;
    unsigned m_label_index;
};
//
SHKZ_END_NAMESPACE
//
#endif
//