[Add] Flags support

Author: mrouffet

Include/SA/Support/Flags.hpp

@@ -0,0 +1,95 @@
+// Copyright (c) 2024 Sapphire's Suite. All Rights Reserved.
+
+#pragma once
+
+#ifndef SAPPHIRE_SUPPORT_FLAGS_GUARD
+#define SAPPHIRE_SUPPORT_FLAGS_GUARD
+
+#include <cstdint>
+
+/**
+*	\file Flags.hpp
+*
+*	\brief \b Flags support file.
+*
+*	Define preprocessor for enum class to flag support.
+*
+*	\ingroup Support
+*	\{
+*/
+
+
+namespace SA
+{
+	/// \cond Internal
+
+	namespace Intl
+	{
+		template <uint32_t size>
+		struct IntSizeT;
+
+		template <>
+		struct IntSizeT<sizeof(int8_t)>
+		{
+			using intT = int8_t;
+			using uintT = uint8_t;
+		};
+
+		template <>
+		struct IntSizeT<sizeof(int16_t)>
+		{
+			using intT = int16_t;
+			using uintT = uint16_t;
+		};
+
+		template <>
+		struct IntSizeT<sizeof(int32_t)>
+		{
+			using intT = int32_t;
+			using uintT = uint32_t;
+		};
+
+		template <>
+		struct IntSizeT<sizeof(int64_t)>
+		{
+			using intT = int64_t;
+			using uintT = uint64_t;
+		};
+
+		#define __SA_EINT(EnumType) SA::Intl::IntSizeT<sizeof(EnumType)>::intT
+		#define __SA_EUINT(EnumType) SA::Intl::IntSizeT<sizeof(EnumType)>::uintT
+	}
+
+	#define __SA_DEFINE_ENUM_CLASS_FLAGS_OP(EnumType, op)\
+		inline constexpr __SA_EUINT(EnumType) operator op(EnumType _e1, EnumType _e2) {\
+			return static_cast<__SA_EUINT(EnumType)>(_e1) op static_cast<__SA_EUINT(EnumType)>(_e2);\
+		}\
+		inline constexpr __SA_EUINT(EnumType) operator op(__SA_EUINT(EnumType) _flags, EnumType _e) {\
+			return _flags op static_cast<__SA_EUINT(EnumType)>(_e);\
+		}\
+		inline constexpr __SA_EUINT(EnumType) operator op(EnumType _e, __SA_EUINT(EnumType) _flags) {\
+			return static_cast<__SA_EUINT(EnumType)>(_e) op _flags;\
+		}\
+		inline __SA_EUINT(EnumType)& operator op##=(__SA_EUINT(EnumType)& _flags, EnumType _e) {\
+			return _flags op##= static_cast<__SA_EUINT(EnumType)>(_e);\
+		}
+	
+
+	/// \endcond
+
+	#define SA_DEFINE_ENUM_CLASS_FLAGS(EnumType)\
+		__SA_DEFINE_ENUM_CLASS_FLAGS_OP(EnumType, &)\
+		__SA_DEFINE_ENUM_CLASS_FLAGS_OP(EnumType, |)\
+		__SA_DEFINE_ENUM_CLASS_FLAGS_OP(EnumType, ^)\
+		inline constexpr __SA_EUINT(EnumType) operator ~(EnumType _e){\
+			return ~static_cast<__SA_EUINT(EnumType)>(_e);\
+		}\
+		inline constexpr __SA_EUINT(EnumType) operator +(EnumType _e){\
+			return static_cast<__SA_EUINT(EnumType)>(_e);\
+		}
+}
+
+
+/** \} */
+
+#endif // SAPPHIRE_SUPPORT_FLAGS_GUARD

Tests/UnitTests/Flags.cpp

@@ -0,0 +1,80 @@
+// Copyright (c) 2024 Sapphire development team. All Rights Reserved.
+
+#include <gtest/gtest.h>
+
+#include <SA/Support/Flags.hpp>
+
+namespace SA::UT::Flags
+{
+	enum class MyEnumFlag : uint8_t
+	{
+		MyFlag1 = (1 << 0),
+		MyFlag2 = (1 << 1),
+		MyFlag3 = (1 << 2),
+		MyFlag4 = (1 << 3),
+		MyFlag5 = (1 << 4),
+	};
+
+	SA_DEFINE_ENUM_CLASS_FLAGS(MyEnumFlag);
+
+
+	TEST(Flags, FlagsAND)
+	{
+		constexpr uint8_t flags1 = MyEnumFlag::MyFlag1 & MyEnumFlag::MyFlag2;
+		EXPECT_EQ((flags1), 0u);
+
+		constexpr uint8_t flags2 = MyEnumFlag::MyFlag3 & 4u;
+		EXPECT_EQ(flags2, 4u);
+
+		constexpr uint8_t flags3 = 4u & MyEnumFlag::MyFlag3;
+		EXPECT_EQ(flags3, 4u);
+
+		uint8_t flags4 = 7u;
+		flags4 &= MyEnumFlag::MyFlag1;
+		EXPECT_EQ(flags4, 1u);
+	}
+
+	TEST(Flags, FlagsOR)
+	{
+		constexpr uint8_t flags1 = MyEnumFlag::MyFlag1 | MyEnumFlag::MyFlag2;
+		EXPECT_EQ((flags1), 3u);
+
+		constexpr uint8_t flags2 = MyEnumFlag::MyFlag3 | 3u;
+		EXPECT_EQ(flags2, 7u);
+
+		constexpr uint8_t flags3 = 3u | MyEnumFlag::MyFlag3;
+		EXPECT_EQ(flags3, 7u);
+
+		uint8_t flags4 = 6u;
+		flags4 |= MyEnumFlag::MyFlag1;
+		EXPECT_EQ(flags4, 7u);
+	}
+
+	TEST(Flags, FlagsXOR)
+	{
+		constexpr uint8_t flags1 = MyEnumFlag::MyFlag1 ^ MyEnumFlag::MyFlag2;
+		EXPECT_EQ((flags1), 3u);
+
+		constexpr uint8_t flags2 = MyEnumFlag::MyFlag3 ^ 4u;
+		EXPECT_EQ(flags2, 0u);
+
+		constexpr uint8_t flags3 = 4u ^ MyEnumFlag::MyFlag3;
+		EXPECT_EQ(flags3, 0u);
+
+		uint8_t flags4 = 6u;
+		flags4 ^= MyEnumFlag::MyFlag2;
+		EXPECT_EQ(flags4, 4u);
+	}
+
+	TEST(Flags, FlagsInv)
+	{
+		constexpr uint8_t flags1 = ~MyEnumFlag::MyFlag2;
+		EXPECT_EQ((flags1), 0xFD);
+	}
+
+	TEST(Flags, FlagsCast)
+	{
+		constexpr uint8_t flags1 = +MyEnumFlag::MyFlag2;
+		EXPECT_EQ((flags1), 2);
+	}
+}