credit.h

Go to the documentation of this file.

/*
**  credit.h
**
**  This is part of Shiokaze, a research-oriented fluid solver for computer graphics.
**  Created by Ryoichi Ando <rand@nii.ac.jp> on Aug 29, 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_CREDIT_H
#define SHKZ_CREDIT_H
//
#include <shiokaze/core/common.h>
#include <string>
#include <tuple>
//
SHKZ_BEGIN_NAMESPACE
//
#define LONG_NAME(long_name)            virtual std::string get_name() const override { return credit::m_name.empty() ? long_name : credit::m_name; }
#define ARGUMENT_NAME(argument_name)    virtual std::string get_argument_name() const override { return credit::m_argument_name.empty() ? argument_name : credit::m_argument_name; }
#define AUTHOR_NAME(author_name)    virtual std::string get_author() const override { return author_name; }
//
class credit {
public:
    credit() = default;
    credit( std::string name, std::string argument_name ) : m_name(name), m_argument_name(argument_name) {}
    virtual void set_name( std::string name, std::string argument_name="" ) { 
        m_name = name;
        if( ! argument_name.empty()) m_argument_name = argument_name;
    }
    virtual std::string get_name() const { return m_name.empty() ? "Unknown" : m_name; }
    virtual void set_argument_name( std::string argument_name ) { m_argument_name = argument_name; }
    virtual std::string get_argument_name() const { return m_argument_name; }
    virtual double get_version() const { return 0.0; }
    virtual std::string get_author() const { return ""; }
    virtual std::tuple<int,int,int> get_date() const { return std::make_tuple(0,0,0); }
    virtual std::string get_email_address() const { return ""; }
    //
protected:
    std::string m_name;
    std::string m_argument_name;
};
//
SHKZ_END_NAMESPACE
//
#endif