335 lines
9.8 KiB
C++
335 lines
9.8 KiB
C++
/*
|
|
* mptMemory.h
|
|
* -----------
|
|
* Purpose: Raw memory manipulation
|
|
* Notes : (currently none)
|
|
* Authors: OpenMPT Devs
|
|
* The OpenMPT source code is released under the BSD license. Read LICENSE for more details.
|
|
*/
|
|
|
|
|
|
#pragma once
|
|
|
|
#include "BuildSettings.h"
|
|
|
|
|
|
#include "mptAssert.h"
|
|
#include "mptBaseTypes.h"
|
|
#include "mptSpan.h"
|
|
|
|
#if MPT_CXX_AT_LEAST(20)
|
|
#include <bit>
|
|
#endif
|
|
#include <utility>
|
|
#include <type_traits>
|
|
|
|
#include <cstring>
|
|
|
|
#include <string.h>
|
|
|
|
|
|
|
|
OPENMPT_NAMESPACE_BEGIN
|
|
|
|
|
|
|
|
namespace mpt {
|
|
|
|
|
|
|
|
typedef mpt::span<std::byte> byte_span;
|
|
typedef mpt::span<const std::byte> const_byte_span;
|
|
|
|
|
|
|
|
// Tell which types are safe for mpt::byte_cast.
|
|
// signed char is actually not allowed to alias into an object representation,
|
|
// which means that, if the actual type is not itself signed char but char or
|
|
// unsigned char instead, dereferencing the signed char pointer is undefined
|
|
// behaviour.
|
|
template <typename T> struct is_byte_castable : public std::false_type { };
|
|
template <> struct is_byte_castable<char> : public std::true_type { };
|
|
template <> struct is_byte_castable<unsigned char> : public std::true_type { };
|
|
template <> struct is_byte_castable<std::byte> : public std::true_type { };
|
|
template <> struct is_byte_castable<const char> : public std::true_type { };
|
|
template <> struct is_byte_castable<const unsigned char> : public std::true_type { };
|
|
template <> struct is_byte_castable<const std::byte> : public std::true_type { };
|
|
|
|
|
|
template <typename T> struct is_byte : public std::false_type { };
|
|
template <> struct is_byte<std::byte> : public std::true_type { };
|
|
template <> struct is_byte<const std::byte> : public std::true_type { };
|
|
|
|
|
|
// Tell which types are safe to binary write into files.
|
|
// By default, no types are safe.
|
|
// When a safe type gets defined,
|
|
// also specialize this template so that IO functions will work.
|
|
template <typename T> struct is_binary_safe : public std::false_type { };
|
|
|
|
// Specialization for byte types.
|
|
template <> struct is_binary_safe<char> : public std::true_type { };
|
|
template <> struct is_binary_safe<uint8> : public std::true_type { };
|
|
template <> struct is_binary_safe<int8> : public std::true_type { };
|
|
template <> struct is_binary_safe<std::byte> : public std::true_type { };
|
|
|
|
// Generic Specialization for arrays.
|
|
template <typename T, std::size_t N> struct is_binary_safe<T[N]> : public is_binary_safe<T> { };
|
|
template <typename T, std::size_t N> struct is_binary_safe<const T[N]> : public is_binary_safe<T> { };
|
|
template <typename T, std::size_t N> struct is_binary_safe<std::array<T, N>> : public is_binary_safe<T> { };
|
|
template <typename T, std::size_t N> struct is_binary_safe<const std::array<T, N>> : public is_binary_safe<T> { };
|
|
|
|
|
|
} // namespace mpt
|
|
|
|
#define MPT_BINARY_STRUCT(type, size) \
|
|
static_assert(sizeof( type ) == (size) ); \
|
|
static_assert(alignof( type ) == 1); \
|
|
static_assert(std::is_standard_layout< type >::value); \
|
|
namespace mpt { \
|
|
template <> struct is_binary_safe< type > : public std::true_type { }; \
|
|
} \
|
|
/**/
|
|
|
|
|
|
|
|
template <typename T>
|
|
struct value_initializer
|
|
{
|
|
inline void operator () (T & x)
|
|
{
|
|
x = T();
|
|
}
|
|
};
|
|
|
|
template <typename T, std::size_t N>
|
|
struct value_initializer<T[N]>
|
|
{
|
|
inline void operator () (T (& a)[N])
|
|
{
|
|
for(auto & e : a)
|
|
{
|
|
value_initializer<T>()(e);
|
|
}
|
|
}
|
|
};
|
|
|
|
template <typename T>
|
|
inline void Clear(T & x)
|
|
{
|
|
static_assert(!std::is_pointer<T>::value);
|
|
value_initializer<T>()(x);
|
|
}
|
|
|
|
|
|
// Memset given object to zero.
|
|
template <class T>
|
|
inline void MemsetZero(T &a)
|
|
{
|
|
static_assert(std::is_pointer<T>::value == false, "Won't memset pointers.");
|
|
static_assert(std::is_standard_layout<T>::value);
|
|
static_assert((std::is_trivially_default_constructible<T>::value && std::is_trivially_copyable<T>::value) || mpt::is_binary_safe<T>::value);
|
|
std::memset(&a, 0, sizeof(T));
|
|
}
|
|
|
|
|
|
|
|
namespace mpt {
|
|
|
|
|
|
|
|
#if MPT_CXX_AT_LEAST(20)
|
|
using std::bit_cast;
|
|
#else
|
|
// C++2a compatible bit_cast.
|
|
// Not implementing constexpr because this is not easily possible pre C++20.
|
|
template <typename Tdst, typename Tsrc>
|
|
MPT_FORCEINLINE typename std::enable_if<(sizeof(Tdst) == sizeof(Tsrc)) && std::is_trivially_copyable<Tsrc>::value && std::is_trivially_copyable<Tdst>::value, Tdst>::type bit_cast(const Tsrc & src) noexcept
|
|
{
|
|
Tdst dst{};
|
|
std::memcpy(&dst, &src, sizeof(Tdst));
|
|
return dst;
|
|
}
|
|
#endif
|
|
|
|
|
|
|
|
template <typename Tdst, typename Tsrc>
|
|
struct byte_cast_impl
|
|
{
|
|
inline Tdst operator () (Tsrc src) const
|
|
{
|
|
static_assert(sizeof(Tsrc) == sizeof(std::byte));
|
|
static_assert(sizeof(Tdst) == sizeof(std::byte));
|
|
// not checking is_byte_castable here because we are actually
|
|
// doing a static_cast and converting the value
|
|
static_assert(std::is_integral<Tsrc>::value || mpt::is_byte<Tsrc>::value);
|
|
static_assert(std::is_integral<Tdst>::value || mpt::is_byte<Tdst>::value);
|
|
return static_cast<Tdst>(src);
|
|
}
|
|
};
|
|
template <typename Tdst, typename Tsrc>
|
|
struct byte_cast_impl<mpt::span<Tdst>, mpt::span<Tsrc> >
|
|
{
|
|
inline mpt::span<Tdst> operator () (mpt::span<Tsrc> src) const
|
|
{
|
|
static_assert(sizeof(Tsrc) == sizeof(std::byte));
|
|
static_assert(sizeof(Tdst) == sizeof(std::byte));
|
|
static_assert(mpt::is_byte_castable<Tsrc>::value);
|
|
static_assert(mpt::is_byte_castable<Tdst>::value);
|
|
static_assert(std::is_integral<Tsrc>::value || mpt::is_byte<Tsrc>::value);
|
|
static_assert(std::is_integral<Tdst>::value || mpt::is_byte<Tdst>::value);
|
|
return mpt::as_span(mpt::byte_cast_impl<Tdst*, Tsrc*>()(src.data()), mpt::byte_cast_impl<Tdst*, Tsrc*>()(src.data() + src.size()));
|
|
}
|
|
};
|
|
template <typename Tdst, typename Tsrc>
|
|
struct byte_cast_impl<Tdst*, Tsrc*>
|
|
{
|
|
inline Tdst* operator () (Tsrc* src) const
|
|
{
|
|
static_assert(sizeof(Tsrc) == sizeof(std::byte));
|
|
static_assert(sizeof(Tdst) == sizeof(std::byte));
|
|
static_assert(mpt::is_byte_castable<Tsrc>::value);
|
|
static_assert(mpt::is_byte_castable<Tdst>::value);
|
|
static_assert(std::is_integral<Tsrc>::value || mpt::is_byte<Tsrc>::value);
|
|
static_assert(std::is_integral<Tdst>::value || mpt::is_byte<Tdst>::value);
|
|
return reinterpret_cast<Tdst*>(src);
|
|
}
|
|
};
|
|
|
|
template <typename Tdst, typename Tsrc>
|
|
struct void_cast_impl;
|
|
|
|
template <typename Tdst>
|
|
struct void_cast_impl<Tdst*, void*>
|
|
{
|
|
inline Tdst* operator () (void* src) const
|
|
{
|
|
static_assert(sizeof(Tdst) == sizeof(std::byte));
|
|
static_assert(mpt::is_byte_castable<Tdst>::value);
|
|
static_assert(std::is_integral<Tdst>::value || mpt::is_byte<Tdst>::value);
|
|
return reinterpret_cast<Tdst*>(src);
|
|
}
|
|
};
|
|
template <typename Tdst>
|
|
struct void_cast_impl<Tdst*, const void*>
|
|
{
|
|
inline Tdst* operator () (const void* src) const
|
|
{
|
|
static_assert(sizeof(Tdst) == sizeof(std::byte));
|
|
static_assert(mpt::is_byte_castable<Tdst>::value);
|
|
static_assert(std::is_integral<Tdst>::value || mpt::is_byte<Tdst>::value);
|
|
return reinterpret_cast<Tdst*>(src);
|
|
}
|
|
};
|
|
template <typename Tsrc>
|
|
struct void_cast_impl<void*, Tsrc*>
|
|
{
|
|
inline void* operator () (Tsrc* src) const
|
|
{
|
|
static_assert(sizeof(Tsrc) == sizeof(std::byte));
|
|
static_assert(mpt::is_byte_castable<Tsrc>::value);
|
|
static_assert(std::is_integral<Tsrc>::value || mpt::is_byte<Tsrc>::value);
|
|
return reinterpret_cast<void*>(src);
|
|
}
|
|
};
|
|
template <typename Tsrc>
|
|
struct void_cast_impl<const void*, Tsrc*>
|
|
{
|
|
inline const void* operator () (Tsrc* src) const
|
|
{
|
|
static_assert(sizeof(Tsrc) == sizeof(std::byte));
|
|
static_assert(mpt::is_byte_castable<Tsrc>::value);
|
|
static_assert(std::is_integral<Tsrc>::value || mpt::is_byte<Tsrc>::value);
|
|
return reinterpret_cast<const void*>(src);
|
|
}
|
|
};
|
|
|
|
// casts between different byte (char) types or pointers to these types
|
|
template <typename Tdst, typename Tsrc>
|
|
inline Tdst byte_cast(Tsrc src)
|
|
{
|
|
return byte_cast_impl<Tdst, Tsrc>()(src);
|
|
}
|
|
|
|
// casts between pointers to void and pointers to byte
|
|
template <typename Tdst, typename Tsrc>
|
|
inline Tdst void_cast(Tsrc src)
|
|
{
|
|
return void_cast_impl<Tdst, Tsrc>()(src);
|
|
}
|
|
|
|
|
|
|
|
template <typename T>
|
|
MPT_CONSTEXPR14_FUN std::byte as_byte(T src) noexcept
|
|
{
|
|
static_assert(std::is_integral<T>::value);
|
|
return static_cast<std::byte>(static_cast<uint8>(src));
|
|
}
|
|
|
|
|
|
|
|
template <typename T>
|
|
struct GetRawBytesFunctor
|
|
{
|
|
inline mpt::const_byte_span operator () (const T & v) const
|
|
{
|
|
static_assert(mpt::is_binary_safe<typename std::remove_const<T>::type>::value);
|
|
return mpt::as_span(reinterpret_cast<const std::byte *>(&v), sizeof(T));
|
|
}
|
|
inline mpt::byte_span operator () (T & v) const
|
|
{
|
|
static_assert(mpt::is_binary_safe<typename std::remove_const<T>::type>::value);
|
|
return mpt::as_span(reinterpret_cast<std::byte *>(&v), sizeof(T));
|
|
}
|
|
};
|
|
|
|
template <typename T, std::size_t N>
|
|
struct GetRawBytesFunctor<T[N]>
|
|
{
|
|
inline mpt::const_byte_span operator () (const T (&v)[N]) const
|
|
{
|
|
static_assert(mpt::is_binary_safe<typename std::remove_const<T>::type>::value);
|
|
return mpt::as_span(reinterpret_cast<const std::byte *>(v), N * sizeof(T));
|
|
}
|
|
inline mpt::byte_span operator () (T (&v)[N]) const
|
|
{
|
|
static_assert(mpt::is_binary_safe<typename std::remove_const<T>::type>::value);
|
|
return mpt::as_span(reinterpret_cast<std::byte *>(v), N * sizeof(T));
|
|
}
|
|
};
|
|
|
|
template <typename T, std::size_t N>
|
|
struct GetRawBytesFunctor<const T[N]>
|
|
{
|
|
inline mpt::const_byte_span operator () (const T (&v)[N]) const
|
|
{
|
|
static_assert(mpt::is_binary_safe<typename std::remove_const<T>::type>::value);
|
|
return mpt::as_span(reinterpret_cast<const std::byte *>(v), N * sizeof(T));
|
|
}
|
|
};
|
|
|
|
// In order to be able to partially specialize it,
|
|
// as_raw_memory is implemented via a class template.
|
|
// Do not overload or specialize as_raw_memory directly.
|
|
// Using a wrapper (by default just around a cast to const std::byte *),
|
|
// allows for implementing raw memory access
|
|
// via on-demand generating a cached serialized representation.
|
|
template <typename T> inline mpt::const_byte_span as_raw_memory(const T & v)
|
|
{
|
|
return mpt::GetRawBytesFunctor<T>()(v);
|
|
}
|
|
template <typename T> inline mpt::byte_span as_raw_memory(T & v)
|
|
{
|
|
return mpt::GetRawBytesFunctor<T>()(v);
|
|
}
|
|
|
|
|
|
|
|
} // namespace mpt
|
|
|
|
|
|
|
|
OPENMPT_NAMESPACE_END
|