// _ _ __ _____ // | \ | | / _| / ____|_ _ // | \| | __ _ _ __ ___ ___ ___ | |_ | | _| |_ _| |_ // | . ` |/ _` | '_ ` _ \ / _ \/ _ \| _| | | |_ _|_ _| // | |\ | (_| | | | | | | __/ (_) | | | |____|_| |_| // |_| \_|\__,_|_| |_| |_|\___|\___/|_| \_____| // https://github.com/Neargye/nameof // vesion 0.9.1 // // Licensed under the MIT License . // SPDX-License-Identifier: MIT // Copyright (c) 2016, 2018 - 2019 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_NAMEOF_HPP #define NEARGYE_NAMEOF_HPP #include #include #include #include #include #include #include #include // Checks nameof_type compiler compatibility. #if defined(__clang__) || defined(__GNUC__) || defined(_MSC_VER) # define NAMEOF_TYPE_SUPPORTED 1 #endif // Checks nameof_enum compiler compatibility. #if defined(__clang__) || defined(__GNUC__) && __GNUC__>= 9 || defined(_MSC_VER) # define NAMEOF_ENUM_SUPPORTED 1 #endif // Enum value must be greater or equals than NAMEOF_ENUM_RANGE_MIN. By default NAMEOF_ENUM_RANGE_MIN = -128. // If need another min range for all enum types by default, redefine the macro NAMEOF_ENUM_RANGE_MIN. #if !defined(NAMEOF_ENUM_RANGE_MIN) # define NAMEOF_ENUM_RANGE_MIN -128 #endif // Enum value must be less or equals than NAMEOF_ENUM_RANGE_MAX. By default NAMEOF_ENUM_RANGE_MAX = 128. // If need another max range for all enum types by default, redefine the macro NAMEOF_ENUM_RANGE_MAX. #if !defined(NAMEOF_ENUM_RANGE_MAX) # define NAMEOF_ENUM_RANGE_MAX 128 #endif namespace nameof { // Enum value must be in range [NAMEOF_ENUM_RANGE_MIN, NAMEOF_ENUM_RANGE_MAX]. By default NAMEOF_ENUM_RANGE_MIN = -128, NAMEOF_ENUM_RANGE_MAX = 128. // If need another range for all enum types by default, redefine the macro NAMEOF_ENUM_RANGE_MIN and NAMEOF_ENUM_RANGE_MAX. // If need another range for specific enum type, add specialization enum_range for necessary enum type. template struct enum_range final { static_assert(std::is_enum_v, "nameof::enum_range requires enum type."); inline static constexpr int min = NAMEOF_ENUM_RANGE_MIN; inline static constexpr int max = NAMEOF_ENUM_RANGE_MAX; static_assert(max > min, "nameof::enum_range requires max > min."); }; static_assert(NAMEOF_ENUM_RANGE_MIN <= 0, "NAMEOF_ENUM_RANGE_MIN must be less or equals than 0."); static_assert(NAMEOF_ENUM_RANGE_MIN > (std::numeric_limits::min)(), "NAMEOF_ENUM_RANGE_MIN must be greater than INT16_MIN."); static_assert(NAMEOF_ENUM_RANGE_MAX > 0, "NAMEOF_ENUM_RANGE_MAX must be greater than 0."); static_assert(NAMEOF_ENUM_RANGE_MAX < (std::numeric_limits::max)(), "NAMEOF_ENUM_RANGE_MAX must be less than INT16_MAX."); static_assert(NAMEOF_ENUM_RANGE_MAX > NAMEOF_ENUM_RANGE_MIN, "NAMEOF_ENUM_RANGE_MAX must be greater than NAMEOF_ENUM_RANGE_MIN."); template struct [[nodiscard]] cstring final { static_assert(N > 0, "Expression does not have a name."); constexpr cstring(std::string_view str) noexcept : cstring{str, std::make_index_sequence{}} {} [[nodiscard]] constexpr auto data() const noexcept { return chars.data(); } [[nodiscard]] constexpr auto size() const noexcept { return N; } [[nodiscard]] constexpr auto begin() const noexcept { return data(); } [[nodiscard]] constexpr auto end() const noexcept { return data() + size(); } [[nodiscard]] constexpr auto cbegin() const noexcept { return begin(); } [[nodiscard]] constexpr auto cend() const noexcept { return end(); } [[nodiscard]] constexpr auto rbegin() const noexcept { return std::reverse_iterator{end()}; } [[nodiscard]] constexpr auto rend() const noexcept { return std::reverse_iterator{begin()}; } [[nodiscard]] constexpr auto crbegin() const noexcept { return rbegin(); } [[nodiscard]] constexpr auto crend() const noexcept { return rend(); } [[nodiscard]] constexpr auto operator[](std::size_t i) const noexcept { return chars[i]; } [[nodiscard]] constexpr auto at(std::size_t i) const { return chars.at(i); } [[nodiscard]] constexpr auto front() const noexcept { return chars[0]; } [[nodiscard]] constexpr auto back() const noexcept { return chars[N]; } [[nodiscard]] constexpr auto length() const noexcept { return size(); } [[nodiscard]] constexpr auto empty() const noexcept { return false; } [[nodiscard]] constexpr auto compare(std::string_view str) const noexcept { return std::string_view{data(), size()}.compare(str); } [[nodiscard]] constexpr operator std::string_view() const noexcept { return {data(), size()}; } private: template constexpr cstring(std::string_view str, std::index_sequence) noexcept : chars{{str[I]..., '\0'}} {} const std::array chars; }; template [[nodiscard]] constexpr bool operator==(const cstring& lhs, std::string_view rhs) noexcept { return lhs.compare(rhs) == 0; } template [[nodiscard]] constexpr bool operator==(std::string_view lhs, const cstring& rhs) noexcept { return lhs.compare(rhs) == 0; } template [[nodiscard]] constexpr bool operator!=(const cstring& lhs, std::string_view rhs) noexcept { return lhs.compare(rhs) != 0; } template [[nodiscard]] constexpr bool operator!=(std::string_view lhs, const cstring& rhs) noexcept { return lhs.compare(rhs) != 0; } template [[nodiscard]] constexpr bool operator>(const cstring& lhs, std::string_view rhs) noexcept { return lhs.compare(rhs) > 0; } template [[nodiscard]] constexpr bool operator>(std::string_view lhs, const cstring& rhs) noexcept { return lhs.compare(rhs) > 0; } template [[nodiscard]] constexpr bool operator>=(const cstring& lhs, std::string_view rhs) noexcept { return lhs.compare(rhs) >= 0; } template [[nodiscard]] constexpr bool operator>=(std::string_view lhs, const cstring& rhs) noexcept { return lhs.compare(rhs) >= 0; } template [[nodiscard]] constexpr bool operator<(const cstring& lhs, std::string_view rhs) noexcept { return lhs.compare(rhs) < 0; } template [[nodiscard]] constexpr bool operator<(std::string_view lhs, const cstring& rhs) noexcept { return lhs.compare(rhs) < 0; } template [[nodiscard]] constexpr bool operator<=(const cstring& lhs, std::string_view rhs) noexcept { return lhs.compare(rhs) <= 0; } template [[nodiscard]] constexpr bool operator<=(std::string_view lhs, const cstring& rhs) noexcept { return lhs.compare(rhs) <= 0; } template std::basic_ostream& operator<<(std::basic_ostream& os, const cstring& srt) { for (auto c : std::string_view{srt}) { os.put(c); } return os; } namespace detail { template struct identity final { using type = T; }; template struct nameof_type_supported final #if defined(NAMEOF_TYPE_SUPPORTED) && NAMEOF_TYPE_SUPPORTED || defined(NAMEOF_TYPE_NO_CHECK_SUPPORT) : std::true_type {}; #else : std::false_type {}; #endif template struct nameof_enum_supported final #if defined(NAMEOF_ENUM_SUPPORTED) && NAMEOF_ENUM_SUPPORTED || defined(NAMEOF_ENUM_NO_CHECK_SUPPORT) : std::true_type {}; #else : std::false_type {}; #endif template struct static_string final { constexpr static_string(std::string_view str) noexcept : static_string{str, std::make_index_sequence{}} {} constexpr const char* data() const noexcept { return chars.data(); } constexpr std::size_t size() const noexcept { return N; } constexpr operator std::string_view() const noexcept { return {data(), size()}; } private: template constexpr static_string(std::string_view str, std::index_sequence) noexcept : chars{{str[I]..., '\0'}} {} const std::array chars; }; template <> struct static_string<0> final { constexpr static_string(std::string_view) noexcept {} constexpr const char* data() const noexcept { return nullptr; } constexpr std::size_t size() const noexcept { return 0; } constexpr operator std::string_view() const noexcept { return {}; } }; template using remove_cvref_t = std::remove_cv_t>; template using enable_if_enum_t = std::enable_if_t, R>; template inline constexpr bool is_enum_v = std::is_enum_v && std::is_same_v>; constexpr std::string_view pretty_name(std::string_view name, bool remove_template_suffix = true) noexcept { if (name.size() >= 1 && (name[0] == '"' || name[0] == '\'')) { return {}; // Narrow multibyte string literal. } else if (name.size() >= 2 && name[0] == 'R' && (name[1] == '"' || name[1] == '\'')) { return {}; // Raw string literal. } else if (name.size() >= 2 && name[0] == 'L' && (name[1] == '"' || name[1] == '\'')) { return {}; // Wide string literal. } else if (name.size() >= 2 && name[0] == 'U' && (name[1] == '"' || name[1] == '\'')) { return {}; // UTF-32 encoded string literal. } else if (name.size() >= 2 && name[0] == 'u' && (name[1] == '"' || name[1] == '\'')) { return {}; // UTF-16 encoded string literal. } else if (name.size() >= 3 && name[0] == 'u' && name[1] == '8' && (name[2] == '"' || name[2] == '\'')) { return {}; // UTF-8 encoded string literal. } else if (name.size() >= 1 && (name[0] >= '0' && name[0] <= '9')) { return {}; // Invalid name. } for (std::size_t i = name.size(), h = 0, s = 0; i > 0; --i) { if (name[i - 1] == ')') { ++h; ++s; continue; } else if (name[i - 1] == '(') { --h; ++s; continue; } if (h == 0) { name.remove_suffix(s); break; } else { ++s; continue; } } std::size_t s = 0; for (std::size_t i = name.size(), h = 0; i > 0; --i) { if (name[i - 1] == '>') { ++h; ++s; continue; } else if (name[i - 1] == '<') { --h; ++s; continue; } if (h == 0) { break; } else { ++s; continue; } } for (std::size_t i = name.size() - s; i > 0; --i) { if (!((name[i - 1] >= '0' && name[i - 1] <= '9') || (name[i - 1] >= 'a' && name[i - 1] <= 'z') || (name[i - 1] >= 'A' && name[i - 1] <= 'Z') || (name[i - 1] == '_'))) { name.remove_prefix(i); break; } } if (remove_template_suffix) { name.remove_suffix(s); } if (name.size() > 0 && ((name.front() >= 'a' && name.front() <= 'z') || (name.front() >= 'A' && name.front() <= 'Z') || (name.front() == '_'))) { return name; } return {}; // Invalid name. } template constexpr auto n() noexcept { static_assert(is_enum_v, "nameof::detail::n requires enum type."); #if defined(NAMEOF_ENUM_SUPPORTED) && NAMEOF_ENUM_SUPPORTED # if defined(__clang__) || defined(__GNUC__) && __GNUC__>= 9 constexpr auto name = pretty_name({__PRETTY_FUNCTION__, sizeof(__PRETTY_FUNCTION__) - 2}); # elif defined(_MSC_VER) constexpr auto name = pretty_name({__FUNCSIG__, sizeof(__FUNCSIG__) - 17}); # endif return static_string{name}; #else static_assert(nameof_enum_supported::value, "nameof::nameof_enum: Unsupported compiler (https://github.com/Neargye/nameof#compiler-compatibility)."); return std::string_view{}; // Unsupported compiler. #endif } template inline constexpr auto enum_name_v = n(); namespace enums { template inline constexpr int reflected_min_v = static_cast(enum_range::min > (std::numeric_limits>::min)() ? enum_range::min : (std::numeric_limits>::min)()); template inline constexpr int reflected_max_v = static_cast(enum_range::max < (std::numeric_limits>::max)() ? enum_range::max : (std::numeric_limits>::max)()); template constexpr std::size_t reflected_size() { static_assert(is_enum_v, "nameof::detail::reflected_size requires enum type."); static_assert(reflected_min_v > (std::numeric_limits::min)(), "nameof::enum_range requires min must be greater than INT16_MIN."); static_assert(reflected_max_v < (std::numeric_limits::max)(), "nameof::enum_range requires max must be less than INT16_MAX."); static_assert(reflected_max_v > reflected_min_v, "nameof::enum_range requires max > min."); constexpr auto size = reflected_max_v - reflected_min_v + 1; static_assert(size > 0, "nameof::enum_range requires valid size."); static_assert(size < (std::numeric_limits::max)(), "nameof::enum_range requires valid size."); return static_cast(size); } template constexpr int range_min(std::integer_sequence) noexcept { static_assert(is_enum_v, "nameof::detail::range_min requires enum type."); int r = 0; (void)(((n(I + reflected_min_v)>().size() != 0) ? (r = I + reflected_min_v, false) : true) && ...); return r; } template constexpr int range_max(std::integer_sequence) noexcept { static_assert(is_enum_v, "nameof::detail::range_max requires enum type."); int r = 0; (void)(((n(reflected_max_v - I)>().size() != 0) ? (r = reflected_max_v - I, false) : true) && ...); return r; } template inline constexpr int min_v = range_min(std::make_integer_sequence()>{}); template inline constexpr int max_v = range_max(std::make_integer_sequence()>{}); template constexpr std::size_t range_size() noexcept { static_assert(is_enum_v, "nameof::detail::range_size requires enum type."); constexpr auto size = max_v - min_v + 1; static_assert(size > 0, "nameof::enum_range requires valid size."); static_assert(size < (std::numeric_limits::max)(), "nameof::enum_range requires valid size."); return static_cast(size); } template inline constexpr std::size_t size_v = range_size(); template inline constexpr auto range_v = std::make_integer_sequence>{}; template constexpr std::size_t count(std::integer_sequence) noexcept { static_assert(is_enum_v, "nameof::detail::count requires enum type."); return (((n(I + min_v)>().size() != 0) ? 1 : 0) + ...); } template inline constexpr std::size_t count_v = count(range_v); template inline constexpr auto sequence_v = std::make_index_sequence>{}; template constexpr auto values(std::integer_sequence) noexcept { static_assert(is_enum_v, "nameof::detail::values requires enum type."); constexpr std::array> valid{{(n(I + min_v)>().size() != 0)...}}; std::array> values{}; for (std::size_t i = 0, v = 0; v < count_v; ++i) { if (valid[i]) { values[v++] = static_cast(static_cast(i) + min_v); } } return values; } template using index_t = std::conditional_t < (std::numeric_limits::max)(), std::uint8_t, std::uint16_t>; template inline constexpr auto invalid_index_v = (std::numeric_limits>::max)(); template constexpr auto indexes(std::integer_sequence) noexcept { static_assert(is_enum_v, "nameof::detail::indexes requires enum type."); index_t i = 0; return std::array, size_v>{{((n(I + min_v)>().size() != 0) ? i++ : invalid_index_v)...}}; } template inline constexpr bool sparsity_v = (sizeof(const char*) * size_v) > (sizeof(index_t) * size_v + sizeof(const char*) * count_v); template constexpr auto strings(std::integer_sequence) noexcept { static_assert(is_enum_v, "nameof::detail::strings requires enum type."); return std::array>{{enum_name_v(I + min_v)>.data()...}}; } template constexpr auto strings(std::index_sequence) noexcept { static_assert(is_enum_v, "nameof::detail::strings requires enum type."); constexpr auto vals = values(range_v); return std::array>{{enum_name_v.data()...}}; } template constexpr auto strings() noexcept { static_assert(is_enum_v, "nameof::detail::strings requires enum type."); if constexpr (sparsity_v) { return strings(sequence_v); } else { return strings(range_v); } } template class enum_traits final { static_assert(is_enum_v, "nameof::enum_traits requires enum type."); static_assert(enum_range::min > (std::numeric_limits::min)(), "nameof::enum_range requires min must be greater than INT16_MIN."); static_assert(enum_range::max < (std::numeric_limits::max)(), "nameof::enum_range requires max must be less than INT16_MAX."); static_assert(enum_range::max > enum_range::min, "nameof::enum_range requires max > min."); static_assert(count_v > 0, "nameof::enum_range requires enum implementation or valid max and min."); using U = std::underlying_type_t; inline static constexpr auto strings_ = strings(); inline static constexpr auto indexes_ = indexes(range_v); public: static constexpr std::string_view name(E value) noexcept { if (static_cast(value) >= static_cast(min_v) && static_cast(value) <= static_cast(max_v)) { if constexpr (sparsity_v) { if (auto i = indexes_[static_cast(value) - min_v]; i != invalid_index_v) { return strings_[i]; } } else { return strings_[static_cast(value) - min_v]; } } return {}; // Value out of range. } }; } // namespace nameof::detail::enums template constexpr auto n() noexcept { #if defined(NAMEOF_TYPE_SUPPORTED) && NAMEOF_TYPE_SUPPORTED # if defined(__clang__) constexpr std::string_view name{__PRETTY_FUNCTION__ + 31, sizeof(__PRETTY_FUNCTION__) - 34}; # elif defined(__GNUC__) constexpr std::string_view name{__PRETTY_FUNCTION__ + 46, sizeof(__PRETTY_FUNCTION__) - 49}; # elif defined(_MSC_VER) constexpr std::string_view name{__FUNCSIG__ + 63, sizeof(__FUNCSIG__) - 81 - (__FUNCSIG__[sizeof(__FUNCSIG__) - 19] == ' ' ? 1 : 0)}; # endif return cstring{name}; #else static_assert(nameof_type_supported::value, "nameof::nameof_type: Unsupported compiler (https://github.com/Neargye/nameof#compiler-compatibility)."); return std::string_view{}; // Unsupported compiler. #endif } } // namespace nameof::detail // Checks is nameof_type supported compiler. inline constexpr bool is_nameof_type_supported = detail::nameof_type_supported::value; // Checks is nameof_enum supported compiler. inline constexpr bool is_nameof_enum_supported = detail::nameof_enum_supported::value; // Obtains simple (unqualified) string enum name of enum variable. template [[nodiscard]] constexpr auto nameof_enum(E value) noexcept -> detail::enable_if_enum_t { return detail::enums::enum_traits>::name(value); } // Obtains simple (unqualified) string enum name of static storage enum variable. // This version is much lighter on the compile times and is not restricted to the enum_range limitation. template [[nodiscard]] constexpr auto nameof_enum() noexcept -> detail::enable_if_enum_t { return detail::enum_name_v, V>; } // Obtains string name of type, reference and cv-qualifiers are ignored. template [[nodiscard]] constexpr auto nameof_type() noexcept { #if defined(_MSC_VER) return detail::n>>(); #else return detail::n>(); #endif } // Obtains string name of full type, with reference and cv-qualifiers. template [[nodiscard]] constexpr auto nameof_full_type() noexcept { #if defined(_MSC_VER) return detail::n>(); #else return detail::n(); #endif } } // namespace nameof // Obtains simple (unqualified) string name of variable, function, macro. #define NAMEOF(...) []() constexpr noexcept { \ ::std::void_t(); \ constexpr auto name = ::nameof::detail::pretty_name(#__VA_ARGS__, true); \ static_assert(!name.empty(), "Expression does not have a name."); \ constexpr auto size = name.size(); \ return ::nameof::cstring{name}; }() // Obtains simple (unqualified) full (with template suffix) string name of variable, function, macro. #define NAMEOF_FULL(...) []() constexpr noexcept { \ ::std::void_t(); \ constexpr auto name = ::nameof::detail::pretty_name(#__VA_ARGS__, false); \ static_assert(!name.empty(), "Expression does not have a name."); \ constexpr auto size = name.size(); \ return ::nameof::cstring{name}; }() // Obtains raw string name of variable, function, macro. #define NAMEOF_RAW(...) []() constexpr noexcept { \ ::std::void_t(); \ constexpr auto name = ::std::string_view{#__VA_ARGS__}; \ static_assert(!name.empty(), "Expression does not have a name."); \ constexpr auto size = name.size(); \ return ::nameof::cstring{name}; }() // Obtains simple (unqualified) string enum name of enum variable. #define NAMEOF_ENUM(...) ::nameof::nameof_enum(__VA_ARGS__) // Obtains simple (unqualified) string enum name of static storage enum variable. // This version is much lighter on the compile times and is not restricted to the enum_range limitation. #define NAMEOF_CONST_ENUM(...) ::nameof::nameof_enum<__VA_ARGS__>() // Obtains string name of type, reference and cv-qualifiers are ignored. #define NAMEOF_TYPE(...) ::nameof::nameof_type<__VA_ARGS__>() // Obtains string name of full type, with reference and cv-qualifiers. #define NAMEOF_FULL_TYPE(...) ::nameof::nameof_full_type<__VA_ARGS__>() // Obtains string name type of expression, reference and cv-qualifiers are ignored. #define NAMEOF_TYPE_EXPR(...) ::nameof::nameof_type() // Obtains string name full type of expression, with reference and cv-qualifiers. #define NAMEOF_FULL_TYPE_EXPR(...) ::nameof::nameof_full_type() #endif // NEARGYE_NAMEOF_HPP