dxx-rebirth/common/include/valptridx.h

/*
 * This file is part of the DXX-Rebirth project <http://www.dxx-rebirth.com/>.
 * It is copyright by its individual contributors, as recorded in the
 * project's Git history.  See COPYING.txt at the top level for license
 * terms and a link to the Git history.
 */
#pragma once

#include <cstddef>
#include <stdexcept>
#include "dxxsconf.h"
#include "compiler-type_traits.h"

#ifdef DXX_HAVE_BUILTIN_CONSTANT_P
#define DXX_VALPTRIDX_STATIC_CHECK(E,F,S)	\
	((void)(dxx_builtin_constant_p((E)) && !(E) &&	\
		(DXX_ALWAYS_ERROR_FUNCTION(F,S), 0)))
#define DXX_VALPTRIDX_INLINE_STATIC_CHECK	inline
#else
#define DXX_VALPTRIDX_STATIC_CHECK(E,F,S)	\
	((void)0)
#define DXX_VALPTRIDX_INLINE_STATIC_CHECK
#endif

#ifdef DXX_HAVE_CXX11_REF_QUALIFIER
#define DXX_VALPTRIDX_REF_QUALIFIER_LVALUE &
#else
#define DXX_VALPTRIDX_REF_QUALIFIER_LVALUE
#endif

#define DXX_VALPTRIDX_CHECK(E,S,success,failure)	\
	(	\
		DXX_VALPTRIDX_STATIC_CHECK(E,dxx_trap_##failure,S),	\
		(E) ? success : throw failure(S)	\
	)

/* Never used with an actual void, but needed for proper two-stage
 * lookup.
 */
template <typename T>
typename tt::enable_if<tt::is_void<T>::value, void>::type get_global_array(T *);

template <typename P, typename I>
class valbaseptridxutil_t
{
protected:
	struct null_pointer_exception : std::logic_error {
		null_pointer_exception(const char *s) : std::logic_error(s) {}
	};
	struct index_mismatch_exception : std::logic_error {
		index_mismatch_exception(const char *s) : std::logic_error(s) {}
	};
	struct index_range_exception : std::out_of_range {
		index_range_exception(const char *s) : std::out_of_range(s) {}
	};
	typedef P *pointer_type;
	typedef I index_type;
	typedef typename tt::remove_const<P>::type Prc;
	static constexpr decltype(get_global_array(pointer_type())) get_array()
	{
		return get_global_array(pointer_type());
	}
	static const P *check_null_pointer(const P *p) __attribute_warn_unused_result
	{
		return DXX_VALPTRIDX_CHECK(p, "NULL pointer used", p, null_pointer_exception);
	}
	static Prc *check_null_pointer(Prc *p) __attribute_warn_unused_result
	{
		return DXX_VALPTRIDX_CHECK(p, "NULL pointer used", p, null_pointer_exception);
	}
	template <typename A>
		static DXX_VALPTRIDX_INLINE_STATIC_CHECK index_type check_index_match(const A &a, pointer_type p, index_type s) __attribute_warn_unused_result;
	template <typename A>
		static DXX_VALPTRIDX_INLINE_STATIC_CHECK index_type check_index_range(const A &a, index_type s) __attribute_warn_unused_result;
};

template <typename P, typename I>
class vvalptr_t;

template <typename P, typename I, template <I> class magic_constant>
class vvalidx_t;

template <typename P, typename I, template <I> class magic_constant>
class validx_t;

template <
	bool require_valid,
	typename P, typename I, template <I> class magic_constant,
	typename Prc = typename tt::remove_const<P>::type>
struct valptridx_template_t;

template <typename P, typename I>
class valptr_t : protected valbaseptridxutil_t<P, I>
{
	typedef valbaseptridxutil_t<P, I> valutil;
protected:
	typedef typename valutil::Prc Prc;
	typedef valptr_t valptr_type;
	using valutil::check_null_pointer;
	using valutil::check_index_range;
	const P *unchecked_const_pointer() const { return p; }
	/* Indirect through the extra version to get a good compiler
	 * backtrace when misuse happens.
	 */
	Prc *unchecked_mutable_pointer(const P *) const = delete;
	Prc *unchecked_mutable_pointer(Prc *) const { return p; }
	Prc *unchecked_mutable_pointer() const { return unchecked_mutable_pointer(static_cast<P *>(nullptr)); }
public:
	typedef typename valutil::pointer_type pointer_type;
	typedef P &reference;
	valptr_t() = delete;
	valptr_t(I) = delete;
	valptr_t(vvalptr_t<const P, I> &&) = delete;
	valptr_t(vvalptr_t<Prc, I> &&) = delete;
	valptr_t(std::nullptr_t) : p(nullptr) {}
	template <template <I> class magic_constant>
	valptr_t(valptridx_template_t<true, const P, I, magic_constant> v) :
		p(v)
	{
	}
	template <template <I> class magic_constant>
	valptr_t(valptridx_template_t<true, Prc, I, magic_constant> v) :
		p(v)
	{
	}
	template <template <I> class magic_constant>
	valptr_t(valptridx_template_t<false, const P, I, magic_constant> v) :
		p(v)
	{
	}
	template <template <I> class magic_constant>
	valptr_t(valptridx_template_t<false, Prc, I, magic_constant> v) :
		p(v)
	{
	}
	valptr_t(const valptr_t<const P, I> &t) :
		p(static_cast<typename valptr_t<const P, I>::pointer_type>(t))
	{
	}
	valptr_t(const valptr_t<Prc, I> &t) :
		p(t)
	{
	}
	valptr_t(const vvalptr_t<const P, I> &t);
	valptr_t(const vvalptr_t<Prc, I> &t);
	template <typename A>
		valptr_t(A &, pointer_type p) :
			p(p)
		{
		}
	valptr_t(pointer_type p) :
		p(p)
	{
	}
	pointer_type operator->() const DXX_VALPTRIDX_REF_QUALIFIER_LVALUE { return *this; }
	operator const P *() const DXX_VALPTRIDX_REF_QUALIFIER_LVALUE { return check_null_pointer(unchecked_const_pointer()); }
	operator Prc *() const DXX_VALPTRIDX_REF_QUALIFIER_LVALUE { return check_null_pointer(unchecked_mutable_pointer()); }
#ifdef DXX_HAVE_CXX11_REF_QUALIFIER
	pointer_type operator->() const && = delete;
	operator const P *() const && = delete;
	operator Prc *() const && = delete;
#endif
	reference operator*() const { return *check_null_pointer(p); }
	/* Only vvalptr_t can implicitly convert to reference */
	operator reference() const = delete;
	explicit operator bool() const { return *this != nullptr; }
	template <typename R>
		bool operator!=(const R &rhs) const
		{
			return !(*this == rhs);
		}
	bool operator==(const valptr_t<Prc, I> &rhs) const { return p == rhs.p; }
	bool operator==(const valptr_t<P const, I> &rhs) const { return p == rhs.p; }
	bool operator==(Prc *rhs) const { return p == rhs; }
	bool operator==(P const *rhs) const { return p == rhs; }
	bool operator==(std::nullptr_t) const { return p == nullptr; }
	template <typename U>
		typename tt::enable_if<!tt::is_base_of<valptr_t, U>::value, bool>::type operator==(U) const = delete;
	template <typename U>
		long operator-(U) const = delete;
protected:
	template <typename A>
		valptr_t(A &a, I i) :
			p(&a[check_index_range(a, i)])
		{
		}
	pointer_type p;
};

template <typename P, typename I, template <I> class magic_constant>
class validx_t : protected valbaseptridxutil_t<P, I>
{
	typedef valbaseptridxutil_t<P, I> valutil;
protected:
	using valutil::check_index_match;
	using valutil::check_index_range;
	typedef validx_t validx_type;
public:
	typedef typename valutil::pointer_type pointer_type;
	typedef typename valutil::index_type index_type;
	typedef I integral_type;
	validx_t() = delete;
	validx_t(P) = delete;
	template <integral_type v>
		validx_t(const magic_constant<v> &) :
			i(v)
	{
	}
	validx_t(vvalidx_t<P, I, magic_constant> &&) = delete;
	template <typename A>
		validx_t(A &a, pointer_type p, index_type s) :
			i(s != ~static_cast<integral_type>(0) ? check_index_match(a, p, check_index_range(a, s)) : s)
	{
	}
	template <typename A>
		validx_t(A &a, index_type s) :
			i(s != ~static_cast<integral_type>(0) ? check_index_range(a, s) : s)
	{
	}
	operator const index_type&() const { return i; }
	template <integral_type v>
		bool operator==(const magic_constant<v> &) const
		{
			return i == v;
		}
	bool operator==(const index_type &rhs) const { return i == rhs; }
	// Compatibility hack since some object numbers are in int, not
	// short
	bool operator==(const int &rhs) const { return i == rhs; }
	template <typename R>
		bool operator!=(const R &rhs) const
		{
			return !(*this == rhs);
		}
	bool operator==(const validx_t &rhs) const
	{
		return i == rhs.i;
	}
	template <typename U>
		typename tt::enable_if<!tt::is_base_of<validx_t, U>::value && !tt::is_base_of<U, validx_t>::value, bool>::type operator==(U) const = delete;
protected:
	validx_t(index_type s) :
		i(s)
	{
	}
	index_type i;
};

template <bool, typename P, typename I, template <I> class magic_constant>
struct valptridx_dispatch_require_valid
{
	typedef valptr_t<P, I> vptr_type;
	typedef validx_t<P, I, magic_constant> vidx_type;
};

template <typename P, typename I, template <I> class magic_constant>
struct valptridx_dispatch_require_valid<true, P, I, magic_constant>
{
	typedef vvalptr_t<P, I> vptr_type;
	typedef vvalidx_t<P, I, magic_constant> vidx_type;
};

/*
 * A data type for passing both a pointer and its offset in an
 * agreed-upon array.  Useful for Segments, Objects.
 */
template <
	bool require_valid,
	typename P, typename I, template <I> class magic_constant,
	typename Prc>
struct valptridx_template_t :
	valptridx_dispatch_require_valid<require_valid, P, I, magic_constant>::vptr_type,
	valptridx_dispatch_require_valid<require_valid, P, I, magic_constant>::vidx_type
{
	typedef typename valptridx_dispatch_require_valid<require_valid, P, I, magic_constant>::vptr_type vptr_type;
	typedef typename valptridx_dispatch_require_valid<require_valid, P, I, magic_constant>::vidx_type vidx_type;
	typedef valptridx_template_t valptridx_type;
protected:
	using vidx_type::get_array;
public:
	typedef typename vptr_type::pointer_type pointer_type;
	typedef typename vptr_type::reference reference;
	typedef typename vidx_type::index_type index_type;
	typedef typename vidx_type::integral_type integral_type;
	operator const vptr_type &() const { return *this; }
	operator const vidx_type &() const { return *this; }
	using vptr_type::operator==;
	using vidx_type::operator==;
	using vidx_type::operator const index_type&;
	valptridx_template_t() = delete;
	valptridx_template_t(std::nullptr_t) = delete;
	/* Swapped V0/V1 matches rvalue construction to/from always-valid type */
	valptridx_template_t(valptridx_template_t<!require_valid, const P, I, magic_constant> &&) = delete;
	valptridx_template_t(valptridx_template_t<!require_valid, Prc, I, magic_constant> &&) = delete;
	/* Convenience conversion to/from always-valid.  Throws on attempt
	 * to make an always-valid from an invalid maybe-valid.
	 */
	valptridx_template_t(const valptridx_template_t<!require_valid, const P, I, magic_constant> &t) :
		vptr_type(t.operator const typename valptridx_dispatch_require_valid<!require_valid, const P, I, magic_constant>::vptr_type &()),
		vidx_type(t.operator const typename valptridx_dispatch_require_valid<!require_valid, const P, I, magic_constant>::vidx_type &())
	{
	}
	valptridx_template_t(const valptridx_template_t<!require_valid, Prc, I, magic_constant> &t) :
		vptr_type(t.operator const typename valptridx_dispatch_require_valid<!require_valid, Prc, I, magic_constant>::vptr_type &()),
		vidx_type(t.operator const typename valptridx_dispatch_require_valid<!require_valid, Prc, I, magic_constant>::vidx_type &())
	{
	}
	/* Copy construction from like type, possibly const-qualified */
	valptridx_template_t(const valptridx_template_t<require_valid, const P, I, magic_constant> &t) :
		vptr_type(t.operator const typename valptridx_dispatch_require_valid<require_valid, const P, I, magic_constant>::vptr_type &()),
		vidx_type(t.operator const typename valptridx_dispatch_require_valid<require_valid, const P, I, magic_constant>::vidx_type &())
	{
	}
	valptridx_template_t(const valptridx_template_t<require_valid, Prc, I, magic_constant> &t) :
		vptr_type(t.operator const typename valptridx_dispatch_require_valid<require_valid, Prc, I, magic_constant>::vptr_type &()),
		vidx_type(t.operator const typename valptridx_dispatch_require_valid<require_valid, Prc, I, magic_constant>::vidx_type &())
	{
	}
	template <integral_type v>
		valptridx_template_t(const magic_constant<v> &m) :
			vptr_type(static_cast<std::size_t>(v) < get_array().size() ? &get_array()[v] : NULL),
			vidx_type(m)
	{
	}
	template <typename A>
	valptridx_template_t(A &a, pointer_type p, index_type s) :
		vptr_type(a, p),
		vidx_type(a, p, s)
	{
	}
	template <typename A>
	valptridx_template_t(A &a, pointer_type p) :
		vptr_type(a, p),
		vidx_type(a, p, p-a)
	{
	}
	valptridx_template_t(pointer_type p) :
		vptr_type(p),
		vidx_type(get_array(), p, p-get_array())
	{
	}
	template <typename A>
	valptridx_template_t(A &a, index_type s) :
		vptr_type(a, static_cast<std::size_t>(s) < a.size() ? &a[s] : NULL),
		vidx_type(a, s)
	{
	}
	valptridx_template_t(index_type s) :
		vptr_type(get_array(), static_cast<std::size_t>(s) < get_array().size() ? &get_array()[s] : NULL),
		vidx_type(get_array(), s)
	{
	}
	template <
		bool erv,
		typename EP>
	/* Reuse Prc to enforce is_same<remove_const<EP>::type,
	 * remove_const<P>::type>.
	 */
	bool operator==(const valptridx_template_t<erv, EP, I, magic_constant, Prc> &rhs) const
	{
		typedef valptridx_template_t<erv, EP, I, magic_constant, Prc> rhs_t;
		return vptr_type::operator==(rhs.operator const typename rhs_t::vptr_type &()) &&
			vidx_type::operator==(rhs.operator const typename rhs_t::vidx_type &());
	}
	template <typename R>
		bool operator!=(const R &rhs) const
		{
			return !(*this == rhs);
		}
};

/* Out of line since gcc chokes on template + inline + attribute */
template <typename P, typename I>
template <typename A>
typename valbaseptridxutil_t<P, I>::index_type valbaseptridxutil_t<P, I>::check_index_match(const A &a, pointer_type p, index_type s)
{
	return DXX_VALPTRIDX_CHECK(&a[s] == p, "pointer/index mismatch", s, index_mismatch_exception);
}

template <typename P, typename I>
template <typename A>
typename valbaseptridxutil_t<P, I>::index_type valbaseptridxutil_t<P, I>::check_index_range(const A &a, index_type s)
{
	return DXX_VALPTRIDX_CHECK(static_cast<std::size_t>(s) < a.size(), "invalid index used in array subscript", s, index_range_exception);
}

template <typename P, typename I>
class vvalptr_t : public valptr_t<P, I>
{
	typedef valptr_t<P, I> base_t;
	using base_t::check_null_pointer;
	typedef typename base_t::Prc Prc;
protected:
	typedef vvalptr_t valptr_type;
public:
	typedef typename base_t::pointer_type pointer_type;
	typedef typename base_t::reference reference;
	using base_t::operator==;
	pointer_type operator->() const DXX_VALPTRIDX_REF_QUALIFIER_LVALUE { return *this; }
	operator const P *() const DXX_VALPTRIDX_REF_QUALIFIER_LVALUE { return base_t::unchecked_const_pointer(); }
	operator Prc *() const DXX_VALPTRIDX_REF_QUALIFIER_LVALUE { return base_t::unchecked_mutable_pointer(); }
	reference operator*() const { return *this; }
	operator reference() const { return *static_cast<pointer_type>(*this); }
	vvalptr_t() = delete;
	vvalptr_t(I) = delete;
	vvalptr_t(std::nullptr_t) = delete;
	vvalptr_t(base_t &&) = delete;
	vvalptr_t(const valptr_t<const P, I> &t) :
		base_t(check_null_pointer(static_cast<const P *>(t)))
	{
	}
	vvalptr_t(const valptr_t<Prc, I> &t) :
		base_t(check_null_pointer(static_cast<Prc *>(t)))
	{
	}
	vvalptr_t(const vvalptr_t<const P, I> &t) :
		base_t(t)
	{
	}
	vvalptr_t(const vvalptr_t<Prc, I> &t) :
		base_t(t)
	{
	}
	template <typename A>
		vvalptr_t(A &a, pointer_type p) :
			base_t(a, check_null_pointer(p))
	{
	}
	template <typename A>
		vvalptr_t(A &a, I i) :
			base_t(a, i)
	{
	}
	vvalptr_t(pointer_type p) :
		base_t(check_null_pointer(p))
	{
	}
	template <template <I> class magic_constant>
	vvalptr_t(valptridx_template_t<true, const P, I, magic_constant> v) :
		base_t(v)
	{
	}
	template <template <I> class magic_constant>
	vvalptr_t(valptridx_template_t<true, Prc, I, magic_constant> v) :
		base_t(v)
	{
	}
	template <template <I> class magic_constant>
	vvalptr_t(valptridx_template_t<false, const P, I, magic_constant> v) :
		base_t(check_null_pointer(static_cast<const P *>(v)))
	{
	}
	template <template <I> class magic_constant>
	vvalptr_t(valptridx_template_t<false, Prc, I, magic_constant> v) :
		base_t(check_null_pointer(static_cast<Prc *>(v)))
	{
	}
	bool operator==(std::nullptr_t) const = delete;
	template <typename R>
		bool operator!=(const R &rhs) const
		{
			return !(*this == rhs);
		}
};

template <typename P, typename I>
valptr_t<P, I>::valptr_t(const vvalptr_t<const P, I> &t) :
	p(t)
{
}

template <typename P, typename I>
valptr_t<P, I>::valptr_t(const vvalptr_t<Prc, I> &t) :
	p(t)
{
}

template <typename P, typename I, template <I> class magic_constant>
class vvalidx_t : public validx_t<P, I, magic_constant>
{
	typedef validx_t<P, I, magic_constant> base_t;
protected:
	using base_t::get_array;
	using base_t::check_index_match;
	using base_t::check_index_range;
	typedef vvalidx_t validx_type;
public:
	typedef typename base_t::index_type index_type;
	typedef typename base_t::integral_type integral_type;
	typedef typename base_t::pointer_type pointer_type;
	template <integral_type v>
		vvalidx_t(const magic_constant<v> &m) :
			base_t(check_constant_index(m))
	{
	}
	vvalidx_t() = delete;
	vvalidx_t(P) = delete;
	vvalidx_t(base_t &&) = delete;
	vvalidx_t(const base_t &t) :
		base_t(check_index_range(get_array(), t))
	{
	}
	template <typename A>
		vvalidx_t(A &a, index_type s) :
			base_t(check_index_range(a, s))
	{
	}
	template <typename A>
	vvalidx_t(A &a, pointer_type p, index_type s) :
		base_t(check_index_match(a, p, check_index_range(a, s)))
	{
	}
	vvalidx_t(index_type s) :
		base_t(check_index_range(get_array(), s))
	{
	}
	template <integral_type v>
		static constexpr const magic_constant<v> &check_constant_index(const magic_constant<v> &m)
		{
#ifndef constexpr
			static_assert(static_cast<std::size_t>(v) < get_array().size(), "invalid index used");
#endif
			return m;
		}
	using base_t::operator==;
	template <integral_type v>
		bool operator==(const magic_constant<v> &m) const
		{
			return base_t::operator==(check_constant_index(m));
		}
	template <typename R>
		bool operator!=(const R &rhs) const
		{
			return !(*this == rhs);
		}
};

template <typename A, A &a, typename vptr, typename vptridx>
struct vvalptr_functions
{
	vptr operator()(typename vptr::pointer_type p) const
	{
		return {a, p};
	}
	vptr operator()(typename vptridx::integral_type i) const
	{
		return {a, i};
	}
	template <typename T>
		vptr operator()(T) const = delete;
};

template <typename A, A &a, typename ptridx>
struct valptridx_functions
{
	ptridx operator()(typename ptridx::index_type i) const
	{
		return {a, i};
	}
	template <typename T>
		typename tt::enable_if<!tt::is_convertible<T, typename ptridx::index_type>::value, ptridx>::type operator()(T) const = delete;
};

template <typename A, A &a, typename vptridx>
struct vvalptridx_functions : valptridx_functions<A, a, vptridx>
{
	typedef valptridx_functions<A, a, vptridx> base_t;
	using base_t::operator();
	vptridx operator()(typename vptridx::pointer_type p) const
	{
		return {a, p};
	}
};

#define _DEFINE_VALPTRIDX_SUBTYPE_USERTYPE(N,P,I,A,prefix,Pconst)	\
	struct prefix##ptr_t : valptr_t<P Pconst, I>	\
	{	\
		DXX_INHERIT_CONSTRUCTORS(prefix##ptr_t, valptr_type);	\
	};	\
	struct v##prefix##ptr_t : vvalptr_t<P Pconst, I>	\
	{	\
		DXX_INHERIT_CONSTRUCTORS(v##prefix##ptr_t, valptr_type);	\
	};	\
	\
	struct prefix##ptridx_t : valptridx_template_t<false, P Pconst, I, P##_magic_constant_t> {	\
		DXX_INHERIT_CONSTRUCTORS(prefix##ptridx_t, valptridx_type);	\
	};	\
	\
	struct v##prefix##ptridx_t : valptridx_template_t<true, P Pconst, I, P##_magic_constant_t> {	\
		DXX_INHERIT_CONSTRUCTORS(v##prefix##ptridx_t, valptridx_type);	\
	};	\
	\
	const vvalptr_functions<Pconst decltype(A), A, v##prefix##ptr_t, v##prefix##ptridx_t> v##prefix##ptr{};	\
	const valptridx_functions<Pconst decltype(A), A, prefix##ptridx_t> prefix##ptridx{};	\
	const vvalptridx_functions<Pconst decltype(A), A, v##prefix##ptridx_t> v##prefix##ptridx{};	\
	static inline v##prefix##ptridx_t operator-(P Pconst *o, decltype(A) Pconst &O)	\
	{	\
		return {A, o, static_cast<v##prefix##ptridx_t::integral_type>(const_cast<const P *>(o) - &(const_cast<const decltype(A) &>(O).front()))};	\
	}	\

#define DEFINE_VALPTRIDX_SUBTYPE(N,P,I,A)	\
	static inline constexpr decltype(A) &get_global_array(P *) { return A; }	\
	/* "decltype(A) const &" parses correctly, but fails to match */	\
	static inline constexpr typename tt::add_const<decltype(A)>::type &get_global_array(P const *) { return A; }	\
	\
	_DEFINE_VALPTRIDX_SUBTYPE_USERTYPE(N,P,I,A,N,);	\
	_DEFINE_VALPTRIDX_SUBTYPE_USERTYPE(N,P,I,A,c##N,const)	\