diff --git a/.travis.yml b/.travis.yml index 2c000ad..72127a2 100644 --- a/.travis.yml +++ b/.travis.yml @@ -9,6 +9,14 @@ matrix: dist: trusty addons: { apt: { sources: ubuntu-toolchain-r-test, packages: ["xorg-dev", "g++-8"] } } env: MATRIX_EVAL="CC=gcc-8 && CXX=g++-8" + - os: linux + dist: trusty + addons: { apt: { sources: ["ubuntu-toolchain-r-test", "llvm-toolchain-trusty-5.0"], packages: ["xorg-dev", "clang-5.0", "g++-7"] } } + env: MATRIX_EVAL="CC=clang-5.0 && CXX=clang++-5.0" + - os: linux + dist: trusty + addons: { apt: { sources: ["ubuntu-toolchain-r-test", "llvm-toolchain-trusty-6.0"], packages: ["xorg-dev", "clang-6.0", "g++-7"] } } + env: MATRIX_EVAL="CC=clang-6.0 && CXX=clang++-6.0" - os: linux dist: trusty addons: { apt: { sources: ["ubuntu-toolchain-r-test", "llvm-toolchain-trusty-7"], packages: ["xorg-dev", "clang-7", "g++-7"] } } diff --git a/README.md b/README.md index 2d6d68e..b4bd9c5 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ ## Requirements - [gcc](https://www.gnu.org/software/gcc/) **>= 7** -- [clang](https://clang.llvm.org/) **>= 7.0** +- [clang](https://clang.llvm.org/) **>= 5.0** - [msvc](https://visualstudio.microsoft.com/) **>= 2017** ## Installation @@ -63,38 +63,7 @@ enum debug_level : int { }; struct debug_level_traits { - using underlying_type = int; - static constexpr std::size_t size = 3; - - static constexpr const debug_level values[] = { - level_info, - level_warning, - level_warning - }; - - static constexpr const std::string_view names[] = { - "level_info", - "level_warning", - "level_warning" - }; - - static constexpr underlying_type to_underlying(debug_level e) noexcept; - - static constexpr std::optional to_string(debug_level e) noexcept; - static constexpr std::string_view to_string_or_empty(Enum e) noexcept; - static std::string_view to_string_or_throw(Enum e); - - static constexpr std::optional from_string(std::string_view name) noexcept; - static constexpr debug_level from_string_or_default(std::string_view name, debug_level def) noexcept; - static debug_level from_string_or_throw(std::string_view name); - - static constexpr std::optional to_index(debug_level e) noexcept; - static constexpr std::size_t to_index_or_invalid(debug_level e) noexcept; - static std::size_t to_index_or_throw(debug_level e); - - static constexpr std::optional from_index(std::size_t index) noexcept; - static constexpr debug_level from_index_or_default(std::size_t index, debug_level def) noexcept; - static debug_level from_index_or_throw(std::size_t index); + /*...*/ }; ``` @@ -115,40 +84,7 @@ enum class color : unsigned { }; struct color_traits { - using underlying_type = unsigned; - static constexpr std::size_t size = 4; - - static constexpr const color values[] = { - color::red, - color::green, - color::blue, - color::white - }; - - static constexpr const std::string_view names[] = { - "red", - "green", - "blue", - "white" - }; - - static constexpr underlying_type to_underlying(color e) noexcept; - - static constexpr std::optional to_string(color e) noexcept; - static constexpr std::string_view to_string_or_empty(Enum e) noexcept; - static std::string_view to_string_or_throw(Enum e); - - static constexpr std::optional from_string(std::string_view name) noexcept; - static constexpr color from_string_or_default(std::string_view name, color def) noexcept; - static color from_string_or_throw(std::string_view name); - - static constexpr std::optional to_index(color e) noexcept; - static constexpr std::size_t to_index_or_invalid(color e) noexcept; - static std::size_t to_index_or_throw(color e); - - static constexpr std::optional from_index(std::size_t index) noexcept; - static constexpr color from_index_or_default(std::size_t index, color def) noexcept; - static color from_index_or_throw(std::size_t index); + /*...*/ }; ``` @@ -196,6 +132,145 @@ int main() { } ``` +### Generic context + +```cpp +namespace some_namespace +{ + ENUM_HPP_CLASS_DECL(color, unsigned, + (red = 0xFF0000) + (green = 0x00FF00) + (blue = 0x0000FF) + (white = red | green | blue)) +} + +// register traits in global namespace to generic access +ENUM_HPP_REGISTER_TRAITS(color) + +int main() { + // to string + static_assert(enum_hpp::to_string(color::red) == "red"); + + // from string + static_assert(enum_hpp::from_string("red") == color::red); + + return 0; +} +``` + +## API + +### Enum traits + +```cpp +// declare enum +ENUM_HPP_DECL( + /*enum_name*/, + /*underlying_type*/, + /*fields*/) + +// declare enum class +ENUM_HPP_DECL( + /*enum_name*/, + /*underlying_type*/, + /*fields*/) + +struct /*enum_name*/_traits { + using underlying_type = /*underlying_type*/; + static constexpr std::size_t size = /*field_count*/; + + static constexpr const std::array values = { + /*enum values*/ + }; + + static constexpr const std::array names = { + /*enum names*/ + }; + + static constexpr /*underlying_type*/ to_underlying(/*enum_name*/ e) noexcept; + + static constexpr std::optional to_string(/*enum_name*/ e) noexcept; + static constexpr std::string_view to_string_or_empty(/*enum_name*/ e) noexcept; + static std::string_view to_string_or_throw(/*enum_name*/ e); + + static constexpr std::optional from_string(std::string_view name) noexcept; + static constexpr /*enum_name*/ from_string_or_default(std::string_view name, /*enum_name*/ def) noexcept; + static /*enum_name*/ from_string_or_throw(std::string_view name); + + static constexpr std::optional to_index(/*enum_name*/ e) noexcept; + static constexpr std::size_t to_index_or_invalid(/*enum_name*/ e) noexcept; + static std::size_t to_index_or_throw(/*enum_name*/ e); + + static constexpr std::optional from_index(std::size_t index) noexcept; + static constexpr /*enum_name*/ from_index_or_default(std::size_t index, /*enum_name*/ def) noexcept; + static /*enum_name*/ from_index_or_throw(std::size_t index); +}; +``` + +### Generic functions + +```cpp +// should be in global namespace +ENUM_HPP_REGISTER_TRAITS(/*declared_enum_name*/) + +namespace enum_hpp +{ + template < typename Enum > + using traits_t = typename traits::type; + + template < typename Enum > + using underlying_type = typename traits_t::underlying_type; + + template < typename Enum > + constexpr std::size_t size() noexcept; + + template < typename Enum > + constexpr const std::array()>& values() noexcept; + + template < typename Enum > + constexpr const std::array()>& names() noexcept; + + template < typename Enum > + constexpr typename traits_t::underlying_type to_underlying(Enum e) noexcept; + + template < typename Enum > + constexpr std::optional to_string(Enum e) noexcept; + + template < typename Enum > + constexpr std::string_view to_string_or_empty(Enum e) noexcept; + + template < typename Enum > + std::string_view to_string_or_throw(Enum e); + + template < typename Enum > + constexpr std::optional from_string(std::string_view name) noexcept; + + template < typename Enum > + constexpr Enum from_string_or_default(std::string_view name, Enum def) noexcept; + + template < typename Enum > + Enum from_string_or_throw(std::string_view name); + + template < typename Enum > + constexpr std::optional to_index(Enum e) noexcept; + + template < typename Enum > + constexpr std::size_t to_index_or_invalid(Enum e) noexcept; + + template < typename Enum > + std::size_t to_index_or_throw(Enum e); + + template < typename Enum > + constexpr std::optional from_index(std::size_t index) noexcept; + + template < typename Enum > + constexpr Enum from_index_or_default(std::size_t index, Enum def) noexcept; + + template < typename Enum > + Enum from_index_or_throw(std::size_t index); +} +``` + ## Alternatives [Better Enums](https://github.com/aantron/better-enums) diff --git a/headers/enum.hpp/enum.hpp b/headers/enum.hpp/enum.hpp index 61bc353..a2d460e 100644 --- a/headers/enum.hpp/enum.hpp +++ b/headers/enum.hpp/enum.hpp @@ -211,7 +211,9 @@ namespace enum_hpp::detail #define ENUM_HPP_TRAITS_DECL(Enum, Fields)\ struct Enum##_traits {\ private:\ - enum enum_names_for_this_score_ { ENUM_HPP_GENERATE_ENUM_FIELDS(Fields) };\ + enum enum_names_for_this_score_ {\ + ENUM_HPP_GENERATE_ENUM_FIELDS(Fields)\ + };\ public:\ using underlying_type = std::underlying_type_t;\ static constexpr std::size_t size = ENUM_HPP_PP_SEQ_SIZE(Fields);\ diff --git a/untests/enum_examples.cpp b/untests/enum_examples.cpp index e260e3f..e49598d 100644 --- a/untests/enum_examples.cpp +++ b/untests/enum_examples.cpp @@ -21,6 +21,8 @@ namespace (white = red | green | blue)) } +ENUM_HPP_REGISTER_TRAITS(color) + TEST_CASE("examples") { SECTION("traits_using") { // size @@ -50,4 +52,12 @@ TEST_CASE("examples") { std::cout << n << ","; } // stdout: red,green,blue, } + + SECTION("generic_context") { + // to string + static_assert(enum_hpp::to_string(color::red) == "red"); + + // from string + static_assert(enum_hpp::from_string("red") == color::red); + } }