// -*- C++ -*-
/* GG is a GUI for SDL and OpenGL.
   Copyright (C) 2003-2008 T. Zachary Laine

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Lesser General Public License
   as published by the Free Software Foundation; either version 2.1
   of the License, or (at your option) any later version.
   
   This library 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
   Lesser General Public License for more details.
    
   You should have received a copy of the GNU Lesser General Public
   License along with this library; if not, write to the Free
   Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
   02111-1307 USA

   If you do not wish to comply with the terms of the LGPL please
   contact the author as other terms are available for a fee.
    
   Zach Laine
   whatwasthataddress@gmail.com */

/** \file StrongTypedef.h \brief Contains macros used to create "strong
    typedefs", that is value types that are not mutually interoperable with
    each other or with builtin types for extra type safety. */

#ifndef _GG_StrongTypedef_h_
#define _GG_StrongTypedef_h_

#include <boost/static_assert.hpp>
#include <boost/type_traits/is_integral.hpp>
#include <boost/serialization/nvp.hpp>

#include <iostream>


namespace GG {

/** Overload of Value() for int. */
inline int Value(int i)
{ return i; }

/** Overload of Value() for double. */
inline double Value(double d)
{ return d; }

/** Overload of Value() for std::size_t. */
inline std::size_t Value(std::size_t s)
{ return s; }

}

#define GG_MEMBER_BOOL_OP_SELF_TYPE(op, rhs_type) \
    inline bool operator op (rhs_type rhs) const  \
    { return m_value op rhs.m_value; }

#define GG_MEMBER_BOOL_OP_OTHER_TYPE(op, rhs_type) \
    inline bool operator op (rhs_type rhs) const   \
    { return m_value op Value(rhs); }

#define GG_MEMBER_NEG_INCR_DECR(this_type)      \
    inline this_type operator-() const          \
    { return this_type(-m_value); }             \
    inline this_type& operator++()              \
    {                                           \
        ++m_value;                              \
        return *this;                           \
    }                                           \
    inline this_type& operator--()              \
    {                                           \
        --m_value;                              \
        return *this;                           \
    }                                           \
    inline this_type operator++(int)            \
    {                                           \
        this_type retval(m_value);              \
        ++m_value;                              \
        return retval;                          \
    }                                           \
    inline this_type operator--(int)            \
    {                                           \
        this_type retval(m_value);              \
        --m_value;                              \
        return retval;                          \
    }

#define GG_MEMBER_ASSIGN_OP_SELF_TYPE(op, rhs_type)     \
    inline rhs_type& operator op (rhs_type rhs)         \
    {                                                   \
        m_value op rhs.m_value;                         \
        return *this;                                   \
    }

#define GG_MEMBER_ASSIGN_OP_OTHER_TYPE_DECL(op, self_type, rhs_type) \
    inline self_type& operator op ## = (rhs_type rhs)

#define GG_MEMBER_ASSIGN_OP_OTHER_TYPE(op, self_type, rhs_type)  \
    GG_MEMBER_ASSIGN_OP_OTHER_TYPE_DECL(op, self_type, rhs_type) \
    {                                                            \
        m_value = static_cast<self_type::value_type>(            \
            m_value op Value(rhs)                                \
        );                                                       \
        return *this;                                            \
    }

#define GG_MEMBER_OP_OTHER_TYPE_DECL(op, self_type, rhs_type) \
    inline self_type& operator op (rhs_type rhs) const

#define GG_MEMBER_OP_OTHER_TYPE(op, self_type, rhs_type)  \
    GG_MEMBER_OP_OTHER_TYPE_DECL(op, self_type, rhs_type) \
    { return self_type(m_value op Value(rhs)); }

#define GG_NONMEMBER_OP_SELF_TYPE(op, self_type)                \
    inline self_type operator op (self_type lhs, self_type rhs) \
    { return lhs op ## = rhs; }

#define GG_NONMEMBER_OP_OTHER_TYPE(op, self_type, rhs_type)     \
    inline self_type operator op (self_type lhs, rhs_type rhs)  \
    { return lhs op ## = Value(rhs); }

#define GG_MEMBER_SELF_COMPARATORS(self_type)    \
    GG_MEMBER_BOOL_OP_SELF_TYPE(==, self_type); \
    GG_MEMBER_BOOL_OP_SELF_TYPE(!=, self_type); \
    GG_MEMBER_BOOL_OP_SELF_TYPE(<, self_type);  \
    GG_MEMBER_BOOL_OP_SELF_TYPE(>, self_type);  \
    GG_MEMBER_BOOL_OP_SELF_TYPE(<=, self_type); \
    GG_MEMBER_BOOL_OP_SELF_TYPE(>=, self_type);

#define GG_MEMBER_OTHER_COMPARATORS(rhs_type)   \
    GG_MEMBER_BOOL_OP_OTHER_TYPE(==, rhs_type); \
    GG_MEMBER_BOOL_OP_OTHER_TYPE(!=, rhs_type); \
    GG_MEMBER_BOOL_OP_OTHER_TYPE(<, rhs_type);  \
    GG_MEMBER_BOOL_OP_OTHER_TYPE(>, rhs_type);  \
    GG_MEMBER_BOOL_OP_OTHER_TYPE(<=, rhs_type); \
    GG_MEMBER_BOOL_OP_OTHER_TYPE(>=, rhs_type);

#define GG_MEMBER_ARITH_ASSIGN_OPS_SELF_TYPE(rhs_type) \
    GG_MEMBER_ASSIGN_OP_SELF_TYPE(+=, rhs_type);       \
    GG_MEMBER_ASSIGN_OP_SELF_TYPE(-=, rhs_type);       \
    GG_MEMBER_ASSIGN_OP_SELF_TYPE(*=, rhs_type);       \
    GG_MEMBER_ASSIGN_OP_SELF_TYPE(/=, rhs_type);

#define GG_MEMBER_ARITH_ASSIGN_OPS_OTHER_TYPE(self_type, rhs_type) \
    GG_MEMBER_ASSIGN_OP_OTHER_TYPE(+, self_type, rhs_type);        \
    GG_MEMBER_ASSIGN_OP_OTHER_TYPE(-, self_type, rhs_type);        \
    GG_MEMBER_ASSIGN_OP_OTHER_TYPE(*, self_type, rhs_type);        \
    GG_MEMBER_ASSIGN_OP_OTHER_TYPE(/, self_type, rhs_type);

#define GG_NONMEMBER_ARITH_OPS_SELF_TYPE(self_type) \
    GG_NONMEMBER_OP_SELF_TYPE(+, self_type);        \
    GG_NONMEMBER_OP_SELF_TYPE(-, self_type);        \
    GG_NONMEMBER_OP_SELF_TYPE(*, self_type);        \
    GG_NONMEMBER_OP_SELF_TYPE(/, self_type);

#define GG_NONMEMBER_ARITH_OPS_OTHER_TYPE(self_type, rhs_type) \
    GG_NONMEMBER_OP_OTHER_TYPE(+, self_type, rhs_type);        \
    GG_NONMEMBER_OP_OTHER_TYPE(-, self_type, rhs_type);        \
    GG_NONMEMBER_OP_OTHER_TYPE(*, self_type, rhs_type);        \
    GG_NONMEMBER_OP_OTHER_TYPE(/, self_type, rhs_type);

#define GG_NONMEMBER_REVERSED_BOOL_OP_SET(lhs_type, self_type)  \
    inline bool operator==(lhs_type x, self_type y)             \
    { return y == x; }                                          \
    inline bool operator!=(lhs_type x, self_type y)             \
    { return y != x; }                                          \
    inline bool operator<(lhs_type x, self_type y)              \
    { return !(y < x || y == x); }                              \
    inline bool operator>(lhs_type x, self_type y)              \
    { return !(y > x || y == x); }                              \
    inline bool operator<=(lhs_type x, self_type y)             \
    { return !(y < x); }                                        \
    inline bool operator>=(lhs_type x, self_type y)             \
    { return !(y > x); }

#define GG_NONMEMBER_REVERSED_ARITH_OP_SET(lhs_type, self_type) \
    inline self_type operator+(lhs_type x, self_type y)         \
    { return y += x; }                                          \
    inline self_type operator-(lhs_type x, self_type y)         \
    { return -(y -= x); }                                       \
    inline self_type operator*(lhs_type x, self_type y)         \
    { return y *= x; }


#define GG_STRONG_DOUBLE_TYPEDEF(name, type)                            \
    class name;                                                         \
    class name ## _d;                                                   \
    type Value(name x);                                                 \
    double Value(name ## _d x);                                         \
                                                                        \
    class name ## _d                                                    \
    {                                                                   \
    private:                                                            \
        struct ConvertibleToBoolDummy {int _;};                         \
                                                                        \
    public:                                                             \
        typedef double value_type;                                      \
                                                                        \
        name ## _d() : m_value(0.0) {}                                  \
        explicit name ## _d(double t) : m_value(t) {}                   \
                                                                        \
        GG_MEMBER_SELF_COMPARATORS(name ## _d);                         \
                                                                        \
        GG_MEMBER_OTHER_COMPARATORS(double);                            \
                                                                        \
        operator int ConvertibleToBoolDummy::* () const                 \
        { return m_value ? &ConvertibleToBoolDummy::_ : 0; }            \
                                                                        \
        GG_MEMBER_NEG_INCR_DECR(name ## _d);                            \
                                                                        \
        GG_MEMBER_ARITH_ASSIGN_OPS_SELF_TYPE(name ## _d);               \
                                                                        \
        GG_MEMBER_ARITH_ASSIGN_OPS_OTHER_TYPE(name ## _d, double);      \
                                                                        \
        GG_MEMBER_ASSIGN_OP_OTHER_TYPE_DECL(+, name ## _d, name);       \
        GG_MEMBER_ASSIGN_OP_OTHER_TYPE_DECL(-, name ## _d, name);       \
        GG_MEMBER_ASSIGN_OP_OTHER_TYPE_DECL(*, name ## _d, name);       \
        GG_MEMBER_ASSIGN_OP_OTHER_TYPE_DECL(/, name ## _d, name);       \
                                                                        \
    private:                                                            \
        double m_value;                                                 \
                                                                        \
        friend class boost::serialization::access;                      \
        template <class Archive>                                        \
        void serialize(Archive& ar, const unsigned int version)         \
        { ar & BOOST_SERIALIZATION_NVP(m_value); }                      \
                                                                        \
        friend double Value(name ## _d x);                              \
    };                                                                  \
                                                                        \
    GG_NONMEMBER_ARITH_OPS_SELF_TYPE(name ## _d);                       \
                                                                        \
    GG_NONMEMBER_ARITH_OPS_OTHER_TYPE(name ## _d, double);              \
                                                                        \
    GG_NONMEMBER_REVERSED_BOOL_OP_SET(double, name ## _d);              \
                                                                        \
    GG_NONMEMBER_REVERSED_ARITH_OP_SET(double, name ## _d);             \
                                                                        \
    inline double Value(name ## _d x)                                   \
    { return x.m_value; }                                               \
                                                                        \
    inline std::ostream& operator<<(std::ostream& os, name ## _d x)     \
    { os << Value(x); return os; }                                      \
                                                                        \
    inline std::istream& operator>>(std::istream& os, name ## _d& x)    \
    {                                                                   \
        double t;                                                       \
        os >> t;                                                        \
        x = name ## _d(t);                                              \
        return os;                                                      \
    }                                                                   \
                                                                        \
    void dummy_function_to_force_semicolon()

/** Creates a new type \a name, based on underlying type \a type, which is not
    interconvertible with any other numeric type.  \a type must be an integral
    type.  The resulting type has most of the operations of the underlying
    integral type.  Specifically, the type is totally ordered, incrementable,
    decrementable, and arithmetic.  The type is also interarithemtic with and
    comparable to objects of types \a type and double.  Note that the free
    functions accepting doubles return GG_STRONG_DOUBLE_TYPEDEF's called \a
    name_d.  This allows \a name objects to be used in floating point math. */
#define GG_STRONG_INTEGRAL_TYPEDEF(name, type)                          \
    GG_STRONG_DOUBLE_TYPEDEF(name, type);                               \
                                                                        \
    type Value(name x);                                                 \
                                                                        \
    class name                                                          \
    {                                                                   \
    private:                                                            \
        struct ConvertibleToBoolDummy {int _;};                         \
                                                                        \
    public:                                                             \
        BOOST_STATIC_ASSERT((boost::is_integral<type>::value));         \
                                                                        \
        typedef type value_type;                                        \
                                                                        \
        name() : m_value(0) {}                                          \
        explicit name(type t) : m_value(t) {}                           \
        explicit name(name ## _d t) :                                   \
            m_value(static_cast<type>(Value(t)))                        \
        {}                                                              \
                                                                        \
        name& operator=(name ## _d t)                                   \
        { m_value = static_cast<type>(Value(t)); return *this; }        \
                                                                        \
        GG_MEMBER_SELF_COMPARATORS(name);                               \
                                                                        \
        GG_MEMBER_OTHER_COMPARATORS(type);                              \
        GG_MEMBER_OTHER_COMPARATORS(name ## _d);                        \
        GG_MEMBER_OTHER_COMPARATORS(double);                            \
                                                                        \
        operator int ConvertibleToBoolDummy::* () const                 \
        { return m_value ? &ConvertibleToBoolDummy::_ : 0; }            \
                                                                        \
        GG_MEMBER_NEG_INCR_DECR(name);                                  \
                                                                        \
        GG_MEMBER_ARITH_ASSIGN_OPS_SELF_TYPE(name);                     \
        GG_MEMBER_ASSIGN_OP_SELF_TYPE(%=, name);                        \
                                                                        \
        GG_MEMBER_ARITH_ASSIGN_OPS_OTHER_TYPE(name, type);              \
        GG_MEMBER_ASSIGN_OP_OTHER_TYPE(%, name, type);                  \
                                                                        \
        GG_MEMBER_ARITH_ASSIGN_OPS_OTHER_TYPE(name, name ## _d);        \
        GG_MEMBER_ARITH_ASSIGN_OPS_OTHER_TYPE(name, double);            \
                                                                        \
    private:                                                            \
        type m_value;                                                   \
                                                                        \
        friend class boost::serialization::access;                      \
        template <class Archive>                                        \
        void serialize(Archive& ar, const unsigned int version)         \
        { ar & BOOST_SERIALIZATION_NVP(m_value); }                      \
                                                                        \
        friend class name ## _d;                                        \
        friend type Value(name x);                                      \
    };                                                                  \
                                                                        \
    GG_NONMEMBER_ARITH_OPS_SELF_TYPE(name);                             \
    GG_NONMEMBER_OP_SELF_TYPE(%, name);                                 \
                                                                        \
    GG_NONMEMBER_ARITH_OPS_OTHER_TYPE(name, type);                      \
    GG_NONMEMBER_OP_OTHER_TYPE(%, name, type);                          \
                                                                        \
    GG_NONMEMBER_REVERSED_BOOL_OP_SET(type, name);                      \
    GG_NONMEMBER_REVERSED_BOOL_OP_SET(name ## _d, name);                \
    GG_NONMEMBER_REVERSED_BOOL_OP_SET(double, name);                    \
                                                                        \
    GG_NONMEMBER_REVERSED_ARITH_OP_SET(type, name);                     \
                                                                        \
    inline name ## _d operator+(name x, double y)                       \
    { return name ## _d(Value(x)) + y; }                                \
    inline name ## _d operator-(name x, double y)                       \
    { return name ## _d(Value(x)) - y; }                                \
    inline name ## _d operator*(name x, double y)                       \
    { return name ## _d(Value(x)) * y; }                                \
    inline name ## _d operator/(name x, double y)                       \
    { return name ## _d(Value(x)) / y; }                                \
                                                                        \
    inline name ## _d operator+(double x, name y)                       \
    { return x + name ## _d(Value(y)); }                                \
    inline name ## _d operator-(double x, name y)                       \
    { return x - name ## _d(Value(y)); }                                \
    inline name ## _d operator*(double x, name y)                       \
    { return x * name ## _d(Value(y)); }                                \
                                                                        \
    inline type Value(name x)                                           \
    { return x.m_value; }                                               \
                                                                        \
    inline std::ostream& operator<<(std::ostream& os, name x)           \
    { os << Value(x); return os; }                                      \
                                                                        \
    inline std::istream& operator>>(std::istream& os, name& x)          \
    {                                                                   \
        type t;                                                         \
        os >> t;                                                        \
        x = name(t);                                                    \
        return os;                                                      \
    }                                                                   \
                                                                        \
    inline name ## _d& name ## _d::operator+=(name rhs)                 \
    { m_value += Value(rhs); return *this; }                            \
    inline name ## _d& name ## _d::operator-=(name rhs)                 \
    { m_value -= Value(rhs); return *this; }                            \
    inline name ## _d& name ## _d::operator*=(name rhs)                 \
    { m_value *= Value(rhs); return *this; }                            \
    inline name ## _d& name ## _d::operator/=(name rhs)                 \
    { m_value /= Value(rhs); return *this; }                            \
                                                                        \
    GG_NONMEMBER_ARITH_OPS_OTHER_TYPE(name ## _d, name);                \
                                                                        \
    GG_NONMEMBER_REVERSED_ARITH_OP_SET(name, name ## _d);               \
    inline name ## _d operator/(name x, name ## _d y)                   \
    { return name ## _d(Value(x) / Value(y)); }                         \
                                                                        \
    void dummy_function_to_force_semicolon()

/** Creates a new type \a name, based on underlying type std::size_t, which is
    not interconvertible with any other numeric type.  The resulting type has
    most of the operations of std::size_t.  Specifically, the type is totally
    ordered, incrementable, decrementable, and arithmetic.  The type is also
    interarithemtic with and comparable to objects of type std::size_t. */
#define GG_STRONG_SIZE_TYPEDEF(name)                                    \
    class name;                                                         \
    std::size_t Value(name x);                                          \
                                                                        \
    class name                                                          \
    {                                                                   \
    private:                                                            \
        struct ConvertibleToBoolDummy {int _;};                         \
                                                                        \
    public:                                                             \
        typedef std::size_t value_type;                                 \
                                                                        \
        name() : m_value(0) {}                                          \
        explicit name(std::size_t t) : m_value(t) {}                    \
                                                                        \
        GG_MEMBER_SELF_COMPARATORS(name);                               \
                                                                        \
        GG_MEMBER_OTHER_COMPARATORS(std::size_t);                       \
                                                                        \
        operator int ConvertibleToBoolDummy::* () const                 \
        { return m_value ? &ConvertibleToBoolDummy::_ : 0; }            \
                                                                        \
        GG_MEMBER_NEG_INCR_DECR(name);                                  \
                                                                        \
        GG_MEMBER_ARITH_ASSIGN_OPS_SELF_TYPE(name);                     \
        GG_MEMBER_ASSIGN_OP_SELF_TYPE(%=, name);                        \
                                                                        \
        GG_MEMBER_ARITH_ASSIGN_OPS_OTHER_TYPE(name, std::size_t);       \
        GG_MEMBER_ASSIGN_OP_OTHER_TYPE(%, name, std::size_t);           \
                                                                        \
    private:                                                            \
        std::size_t m_value;                                            \
                                                                        \
        friend class boost::serialization::access;                      \
        template <class Archive>                                        \
        void serialize(Archive& ar, const unsigned int version)         \
        { ar & BOOST_SERIALIZATION_NVP(m_value); }                      \
                                                                        \
        friend class name ## _d;                                        \
        friend std::size_t Value(name x);                               \
    };                                                                  \
                                                                        \
    GG_NONMEMBER_ARITH_OPS_SELF_TYPE(name);                             \
    GG_NONMEMBER_OP_SELF_TYPE(%, name);                                 \
                                                                        \
    GG_NONMEMBER_ARITH_OPS_OTHER_TYPE(name, std::size_t);               \
    GG_NONMEMBER_OP_OTHER_TYPE(%, name, std::size_t);                   \
                                                                        \
    GG_NONMEMBER_REVERSED_BOOL_OP_SET(std::size_t, name);               \
                                                                        \
    GG_NONMEMBER_REVERSED_ARITH_OP_SET(std::size_t, name);              \
                                                                        \
    inline std::size_t Value(name x)                                    \
    { return x.m_value; }                                               \
                                                                        \
    inline std::ostream& operator<<(std::ostream& os, name x)           \
    { os << Value(x); return os; }                                      \
                                                                        \
    inline std::istream& operator>>(std::istream& os, name& x)          \
    {                                                                   \
        std::size_t t;                                                  \
        os >> t;                                                        \
        x = name(t);                                                    \
        return os;                                                      \
    }                                                                   \
                                                                        \
    void dummy_function_to_force_semicolon()

#endif // _GG_StrongTypedef_h_
