From 7a881a68baee4c7742ceb54b573a42d4b47f6abc Mon Sep 17 00:00:00 2001 From: neargye Date: Mon, 12 Jun 2023 17:45:42 +0400 Subject: [PATCH] add enum_next_value and enum_prev_value --- include/magic_enum_utility.hpp | 97 ++++++++++++++++++++++++++++++++++ test/test.cpp | 63 ++++++++++++++++++++++ test/test_flags.cpp | 63 ++++++++++++++++++++++ 3 files changed, 223 insertions(+) create mode 100644 include/magic_enum_utility.hpp diff --git a/include/magic_enum_utility.hpp b/include/magic_enum_utility.hpp new file mode 100644 index 0000000..6426494 --- /dev/null +++ b/include/magic_enum_utility.hpp @@ -0,0 +1,97 @@ +// __ __ _ ______ _____ +// | \/ | (_) | ____| / ____|_ _ +// | \ / | __ _ __ _ _ ___ | |__ _ __ _ _ _ __ ___ | | _| |_ _| |_ +// | |\/| |/ _` |/ _` | |/ __| | __| | '_ \| | | | '_ ` _ \ | | |_ _|_ _| +// | | | | (_| | (_| | | (__ | |____| | | | |_| | | | | | | | |____|_| |_| +// |_| |_|\__,_|\__, |_|\___| |______|_| |_|\__,_|_| |_| |_| \_____| +// __/ | https://github.com/Neargye/magic_enum +// |___/ version 0.9.1 +// +// Licensed under the MIT License . +// SPDX-License-Identifier: MIT +// Copyright (c) 2019 - 2023 Daniil Goncharov . +// +// 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 NEARGYE_MAGIC_ENUM_UTILITY_HPP +#define NEARGYE_MAGIC_ENUM_UTILITY_HPP + +#include "magic_enum.hpp" + +namespace magic_enum { + +template > +[[nodiscard]] constexpr auto enum_next_value(E value, std::ptrdiff_t n = 1) noexcept -> detail::enable_if_t>> { + using D = std::decay_t; + constexpr auto count = detail::count_v; + + if (const auto i = enum_index(value)) { + const std::ptrdiff_t index = (static_cast(*i) + n); + if (index >= 0 && index < count) { + return enum_value(index); + } + } + return {}; +} + +template > +[[nodiscard]] constexpr auto enum_next_value_circular(E value, std::ptrdiff_t n = 1) noexcept -> detail::enable_if_t> { + using D = std::decay_t; + constexpr std::ptrdiff_t count = detail::count_v; + + if (const auto i = enum_index(value)) { + const std::ptrdiff_t index = ((((static_cast(*i) + n) % count) + count) % count); + if (index >= 0 && index < count) { + return enum_value(index); + } + } + return MAGIC_ENUM_ASSERT(false), value; +} + +template > +[[nodiscard]] constexpr auto enum_prev_value(E value, std::ptrdiff_t n = 1) noexcept -> detail::enable_if_t>> { + using D = std::decay_t; + constexpr auto count = detail::count_v; + + if (const auto i = enum_index(value)) { + const std::ptrdiff_t index = (static_cast(*i) - n); + if (index >= 0 && index < count) { + return enum_value(index); + } + } + return {}; +} + +template > +[[nodiscard]] constexpr auto enum_prev_value_circular(E value, std::ptrdiff_t n = 1) noexcept -> detail::enable_if_t> { + using D = std::decay_t; + constexpr std::ptrdiff_t count = detail::count_v; + + if (const auto i = enum_index(value)) { + const std::ptrdiff_t index = ((((static_cast(*i) - n) % count) + count) % count); + if (index >= 0 && index < count) { + return enum_value(index); + } + } + return MAGIC_ENUM_ASSERT(false), value; +} + +} // namespace magic_enum + +#endif // NEARGYE_MAGIC_ENUM_UTILITY_HPP diff --git a/test/test.cpp b/test/test.cpp index bb826b9..3e58e13 100644 --- a/test/test.cpp +++ b/test/test.cpp @@ -30,6 +30,7 @@ #include #include #include +#include #include #include @@ -1140,3 +1141,65 @@ TEST_CASE("format-base") { } #endif + +TEST_CASE("enum_next_value") { + REQUIRE(enum_next_value(Color::RED) == Color::GREEN); + REQUIRE(enum_next_value(Color::RED, 2) == Color::BLUE); + REQUIRE(enum_next_value(Color::RED, 1) == Color::GREEN); + REQUIRE(enum_next_value(Color::RED, 0) == Color::RED); + REQUIRE(enum_next_value(Color::BLUE, -2) == Color::RED); + REQUIRE(enum_next_value(Color::BLUE, -1) == Color::GREEN); + REQUIRE_FALSE(enum_next_value(Color::BLUE).has_value()); + REQUIRE_FALSE(enum_next_value(Color::RED, -1).has_value()); + REQUIRE_FALSE(enum_next_value(Color::RED, 10).has_value()); +} + +TEST_CASE("enum_next_value_circular") { + REQUIRE(enum_next_value_circular(Color::RED) == Color::GREEN); + REQUIRE(enum_next_value_circular(Color::RED, 2) == Color::BLUE); + REQUIRE(enum_next_value_circular(Color::RED, 1) == Color::GREEN); + REQUIRE(enum_next_value_circular(Color::RED, 0) == Color::RED); + REQUIRE(enum_next_value_circular(Color::BLUE, -2) == Color::RED); + REQUIRE(enum_next_value_circular(Color::BLUE, -1) == Color::GREEN); + REQUIRE(enum_next_value_circular(Color::BLUE) == Color::RED); + REQUIRE(enum_next_value_circular(Color::BLUE, 4) == Color::RED); + REQUIRE(enum_next_value_circular(Color::BLUE, 3) == Color::BLUE); + REQUIRE(enum_next_value_circular(Color::BLUE, 2) == Color::GREEN); + REQUIRE(enum_next_value_circular(Color::BLUE, 1) == Color::RED); + REQUIRE(enum_next_value_circular(Color::BLUE, 0) == Color::BLUE); + REQUIRE(enum_next_value_circular(Color::RED, -1) == Color::BLUE); + REQUIRE(enum_next_value_circular(Color::RED, -2) == Color::GREEN); + REQUIRE(enum_next_value_circular(Color::RED, -3) == Color::RED); + REQUIRE(enum_next_value_circular(Color::RED, -4) == Color::BLUE); +} + +TEST_CASE("enum_prev_value") { + REQUIRE(enum_prev_value(Color::BLUE) == Color::GREEN); + REQUIRE(enum_prev_value(Color::BLUE, 2) == Color::RED); + REQUIRE(enum_prev_value(Color::BLUE, 1) == Color::GREEN); + REQUIRE(enum_prev_value(Color::RED, -2) == Color::BLUE); + REQUIRE(enum_prev_value(Color::RED, -1) == Color::GREEN); + REQUIRE(enum_prev_value(Color::BLUE, 0) == Color::BLUE); + REQUIRE_FALSE(enum_prev_value(Color::RED).has_value()); + REQUIRE_FALSE(enum_prev_value(Color::BLUE, -1).has_value()); + REQUIRE_FALSE(enum_prev_value(Color::BLUE, 10).has_value()); +} + +TEST_CASE("enum_prev_value_circular") { + REQUIRE(enum_prev_value_circular(Color::RED) == Color::BLUE); + REQUIRE(enum_prev_value_circular(Color::RED, 2) == Color::GREEN); + REQUIRE(enum_prev_value_circular(Color::RED, 1) == Color::BLUE); + REQUIRE(enum_prev_value_circular(Color::RED, 0) == Color::RED); + REQUIRE(enum_prev_value_circular(Color::BLUE, -2) == Color::GREEN); + REQUIRE(enum_prev_value_circular(Color::BLUE, -1) == Color::RED); + REQUIRE(enum_prev_value_circular(Color::BLUE) == Color::GREEN); + REQUIRE(enum_prev_value_circular(Color::BLUE, 4) == Color::GREEN); + REQUIRE(enum_prev_value_circular(Color::BLUE, 3) == Color::BLUE); + REQUIRE(enum_prev_value_circular(Color::BLUE, 2) == Color::RED); + REQUIRE(enum_prev_value_circular(Color::BLUE, 1) == Color::GREEN); + REQUIRE(enum_prev_value_circular(Color::BLUE, 0) == Color::BLUE); + REQUIRE(enum_prev_value_circular(Color::RED, -1) == Color::GREEN); + REQUIRE(enum_prev_value_circular(Color::RED, -2) == Color::BLUE); + REQUIRE(enum_prev_value_circular(Color::RED, -3) == Color::RED); + REQUIRE(enum_prev_value_circular(Color::RED, -4) == Color::GREEN); +} diff --git a/test/test_flags.cpp b/test/test_flags.cpp index 199f67d..9e3a36c 100644 --- a/test/test_flags.cpp +++ b/test/test_flags.cpp @@ -36,6 +36,7 @@ #include #include #include +#include #include #include @@ -769,3 +770,65 @@ TEST_CASE("enum_flags_test_any") { REQUIRE(enum_flags_test(Numbers::one, Numbers::none) == enum_flags_test_any(Numbers::one, Numbers::none)); REQUIRE(enum_flags_test(Numbers::none, Numbers::one) == enum_flags_test_any(Numbers::none, Numbers::one)); } + +TEST_CASE("enum_next_value") { + REQUIRE(enum_next_value(Color::RED) == Color::GREEN); + REQUIRE(enum_next_value(Color::RED, 2) == Color::BLUE); + REQUIRE(enum_next_value(Color::RED, 1) == Color::GREEN); + REQUIRE(enum_next_value(Color::RED, 0) == Color::RED); + REQUIRE(enum_next_value(Color::BLUE, -2) == Color::RED); + REQUIRE(enum_next_value(Color::BLUE, -1) == Color::GREEN); + REQUIRE_FALSE(enum_next_value(Color::BLUE).has_value()); + REQUIRE_FALSE(enum_next_value(Color::RED, -1).has_value()); + REQUIRE_FALSE(enum_next_value(Color::RED, 10).has_value()); +} + +TEST_CASE("enum_next_value_circular") { + REQUIRE(enum_next_value_circular(Color::RED) == Color::GREEN); + REQUIRE(enum_next_value_circular(Color::RED, 2) == Color::BLUE); + REQUIRE(enum_next_value_circular(Color::RED, 1) == Color::GREEN); + REQUIRE(enum_next_value_circular(Color::RED, 0) == Color::RED); + REQUIRE(enum_next_value_circular(Color::BLUE, -2) == Color::RED); + REQUIRE(enum_next_value_circular(Color::BLUE, -1) == Color::GREEN); + REQUIRE(enum_next_value_circular(Color::BLUE) == Color::RED); + REQUIRE(enum_next_value_circular(Color::BLUE, 4) == Color::RED); + REQUIRE(enum_next_value_circular(Color::BLUE, 3) == Color::BLUE); + REQUIRE(enum_next_value_circular(Color::BLUE, 2) == Color::GREEN); + REQUIRE(enum_next_value_circular(Color::BLUE, 1) == Color::RED); + REQUIRE(enum_next_value_circular(Color::BLUE, 0) == Color::BLUE); + REQUIRE(enum_next_value_circular(Color::RED, -1) == Color::BLUE); + REQUIRE(enum_next_value_circular(Color::RED, -2) == Color::GREEN); + REQUIRE(enum_next_value_circular(Color::RED, -3) == Color::RED); + REQUIRE(enum_next_value_circular(Color::RED, -4) == Color::BLUE); +} + +TEST_CASE("enum_prev_value") { + REQUIRE(enum_prev_value(Color::BLUE) == Color::GREEN); + REQUIRE(enum_prev_value(Color::BLUE, 2) == Color::RED); + REQUIRE(enum_prev_value(Color::BLUE, 1) == Color::GREEN); + REQUIRE(enum_prev_value(Color::RED, -2) == Color::BLUE); + REQUIRE(enum_prev_value(Color::RED, -1) == Color::GREEN); + REQUIRE(enum_prev_value(Color::BLUE, 0) == Color::BLUE); + REQUIRE_FALSE(enum_prev_value(Color::RED).has_value()); + REQUIRE_FALSE(enum_prev_value(Color::BLUE, -1).has_value()); + REQUIRE_FALSE(enum_prev_value(Color::BLUE, 10).has_value()); +} + +TEST_CASE("enum_prev_value_circular") { + REQUIRE(enum_prev_value_circular(Color::RED) == Color::BLUE); + REQUIRE(enum_prev_value_circular(Color::RED, 2) == Color::GREEN); + REQUIRE(enum_prev_value_circular(Color::RED, 1) == Color::BLUE); + REQUIRE(enum_prev_value_circular(Color::RED, 0) == Color::RED); + REQUIRE(enum_prev_value_circular(Color::BLUE, -2) == Color::GREEN); + REQUIRE(enum_prev_value_circular(Color::BLUE, -1) == Color::RED); + REQUIRE(enum_prev_value_circular(Color::BLUE) == Color::GREEN); + REQUIRE(enum_prev_value_circular(Color::BLUE, 4) == Color::GREEN); + REQUIRE(enum_prev_value_circular(Color::BLUE, 3) == Color::BLUE); + REQUIRE(enum_prev_value_circular(Color::BLUE, 2) == Color::RED); + REQUIRE(enum_prev_value_circular(Color::BLUE, 1) == Color::GREEN); + REQUIRE(enum_prev_value_circular(Color::BLUE, 0) == Color::BLUE); + REQUIRE(enum_prev_value_circular(Color::RED, -1) == Color::GREEN); + REQUIRE(enum_prev_value_circular(Color::RED, -2) == Color::BLUE); + REQUIRE(enum_prev_value_circular(Color::RED, -3) == Color::RED); + REQUIRE(enum_prev_value_circular(Color::RED, -4) == Color::GREEN); +}