///\file /****************************************************************************** The MIT License(MIT) Embedded Template Library. https://github.com/ETLCPP/etl https://www.etlcpp.com Copyright(c) 2014 jwellbelove, Robin S�derholm 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. ******************************************************************************/ #include "../platform.h" #include "../utility.h" #include "../array.h" #include "../largest.h" #include "../exception.h" #include "../type_traits.h" #include "../integral_limits.h" #include "../static_assert.h" #include "../alignment.h" #include "../error_handler.h" #include "../null_type.h" #include "../placement_new.h" #include #if defined(ETL_COMPILER_KEIL) #pragma diag_suppress 940 #pragma diag_suppress 111 #endif //***************************************************************************** ///\defgroup variant variant /// A class that can contain one a several specified types in a type safe manner. ///\ingroup containers //***************************************************************************** namespace etl { #if ETL_NOT_USING_LEGACY_VARIANT namespace legacy { #endif namespace private_variant { //************************************************************************* /// Placeholder for unused template parameters. /// This class is never instantiated. //************************************************************************* template struct no_type { }; } //*************************************************************************** /// Monostate for variants. ///\ingroup variant //*************************************************************************** struct monostate { }; //*************************************************************************** /// Base exception for the variant class. ///\ingroup variant //*************************************************************************** class variant_exception : public etl::exception { public: variant_exception(string_type reason_, string_type file_name_, numeric_type line_number_) : exception(reason_, file_name_, line_number_) { } }; //*************************************************************************** /// 'Unsupported type' exception for the variant class. ///\ingroup variant //*************************************************************************** class variant_incorrect_type_exception : public variant_exception { public: variant_incorrect_type_exception(string_type file_name_, numeric_type line_number_) : variant_exception(ETL_ERROR_TEXT("variant:unsupported type", ETL_VARIANT_FILE_ID"A"), file_name_, line_number_) { } }; //*************************************************************************** /// 'Bad variant access' exception for the variant class. ///\ingroup variant //*************************************************************************** class bad_variant_access : public variant_exception { public: bad_variant_access(string_type file_name_, numeric_type line_number_) : variant_exception(ETL_ERROR_TEXT("variant:bad variant access", ETL_VARIANT_FILE_ID"B"), file_name_, line_number_) {} }; //*************************************************************************** /// 'Not a base type' exception for the variant class. ///\ingroup variant //*************************************************************************** class variant_not_a_base_exception : public variant_exception { public: variant_not_a_base_exception(string_type file_name_, numeric_type line_number_) : variant_exception(ETL_ERROR_TEXT("variant:not_a base", ETL_VARIANT_FILE_ID"C"), file_name_, line_number_) { } }; //*************************************************************************** /// A template class that can store any of the types defined in the template parameter list. /// Supports up to 8 types. ///\ingroup variant //*************************************************************************** template , typename T3 = etl::null_type<3>, typename T4 = etl::null_type<4>, typename T5 = etl::null_type<5>, typename T6 = etl::null_type<6>, typename T7 = etl::null_type<7>, typename T8 = etl::null_type<8> > class variant { public: //*************************************************************************** /// The type used for ids. //*************************************************************************** typedef uint_least8_t type_id_t; //*************************************************************************** /// The id a unsupported types. //*************************************************************************** static const type_id_t UNSUPPORTED_TYPE_ID = etl::integral_limits::max; private: // All types of variant are friends. template friend class variant; //*************************************************************************** /// The largest type. //*************************************************************************** typedef typename etl::largest_type::type largest_t; //*************************************************************************** /// The largest size. //*************************************************************************** static const size_t SIZE = sizeof(largest_t); //*************************************************************************** /// The largest alignment. //*************************************************************************** static const size_t ALIGNMENT = etl::largest_alignment::value; //*************************************************************************** /// Short form of no_type placeholders. //*************************************************************************** typedef etl::null_type<2> no_type2; typedef etl::null_type<3> no_type3; typedef etl::null_type<4> no_type4; typedef etl::null_type<5> no_type5; typedef etl::null_type<6> no_type6; typedef etl::null_type<7> no_type7; typedef etl::null_type<8> no_type8; //*************************************************************************** /// Lookup the id of type. //*************************************************************************** template struct Type_Id_Lookup { static const uint_least8_t type_id = etl::is_same::value ? 0 : etl::is_same::value ? 1 : etl::is_same::value ? 2 : etl::is_same::value ? 3 : etl::is_same::value ? 4 : etl::is_same::value ? 5 : etl::is_same::value ? 6 : etl::is_same::value ? 7 : UNSUPPORTED_TYPE_ID; }; //*************************************************************************** /// Lookup for the id of type. //*************************************************************************** template struct Type_Is_Supported : public etl::integral_constant::value || etl::is_same::value || etl::is_same::value || etl::is_same::value || etl::is_same::value || etl::is_same::value || etl::is_same::value || etl::is_same::value> { }; public: //*************************************************************************** /// Destructor. //*************************************************************************** ~variant() { destruct_current(); } //************************************************************************* //**** Reader types ******************************************************* //************************************************************************* //************************************************************************* /// Base reader type functor class. /// Allows for typesafe access to the stored value types. /// Define the reader type for 8 types. //************************************************************************* template class reader_type { public: friend class variant; virtual ~reader_type() { } virtual void read(typename etl::parameter_type::type value) = 0; virtual void read(typename etl::parameter_type::type value) = 0; virtual void read(typename etl::parameter_type::type value) = 0; virtual void read(typename etl::parameter_type::type value) = 0; virtual void read(typename etl::parameter_type::type value) = 0; virtual void read(typename etl::parameter_type::type value) = 0; virtual void read(typename etl::parameter_type::type value) = 0; virtual void read(typename etl::parameter_type::type value) = 0; }; //************************************************************************* /// Define the reader type for 7 types. //************************************************************************* template class reader_type { public: friend class variant; virtual ~reader_type() { } virtual void read(typename etl::parameter_type::type value) = 0; virtual void read(typename etl::parameter_type::type value) = 0; virtual void read(typename etl::parameter_type::type value) = 0; virtual void read(typename etl::parameter_type::type value) = 0; virtual void read(typename etl::parameter_type::type value) = 0; virtual void read(typename etl::parameter_type::type value) = 0; virtual void read(typename etl::parameter_type::type value) = 0; private: void read(no_type8&) {}; }; //************************************************************************* /// Define the reader type for 6 types. //************************************************************************* template class reader_type { public: friend class variant; virtual ~reader_type() { } virtual void read(typename etl::parameter_type::type value) = 0; virtual void read(typename etl::parameter_type::type value) = 0; virtual void read(typename etl::parameter_type::type value) = 0; virtual void read(typename etl::parameter_type::type value) = 0; virtual void read(typename etl::parameter_type::type value) = 0; virtual void read(typename etl::parameter_type::type value) = 0; private: void read(no_type7&) {}; void read(no_type8&) {}; }; //************************************************************************* /// Define the reader type for 5 types. //************************************************************************* template class reader_type { public: friend class variant; virtual ~reader_type() { } virtual void read(typename etl::parameter_type::type value) = 0; virtual void read(typename etl::parameter_type::type value) = 0; virtual void read(typename etl::parameter_type::type value) = 0; virtual void read(typename etl::parameter_type::type value) = 0; virtual void read(typename etl::parameter_type::type value) = 0; private: void read(no_type6&) {}; void read(no_type7&) {}; void read(no_type8&) {}; }; //************************************************************************* /// Define the reader type for 4 types. //************************************************************************* template class reader_type { public: friend class variant; virtual ~reader_type() { } virtual void read(typename etl::parameter_type::type value) = 0; virtual void read(typename etl::parameter_type::type value) = 0; virtual void read(typename etl::parameter_type::type value) = 0; virtual void read(typename etl::parameter_type::type value) = 0; private: void read(no_type5&) {}; void read(no_type6&) {}; void read(no_type7&) {}; void read(no_type8&) {}; }; //************************************************************************* /// Define the reader type for 3 types. //************************************************************************* template class reader_type { public: friend class variant; virtual ~reader_type() { } virtual void read(typename etl::parameter_type::type value) = 0; virtual void read(typename etl::parameter_type::type value) = 0; virtual void read(typename etl::parameter_type::type value) = 0; private: void read(no_type4&) {}; void read(no_type5&) {}; void read(no_type6&) {}; void read(no_type7&) {}; void read(no_type8&) {}; }; //************************************************************************* /// Define the reader type for 2 types. //************************************************************************* template class reader_type { public: friend class variant; virtual ~reader_type() { } virtual void read(typename etl::parameter_type::type value) = 0; virtual void read(typename etl::parameter_type::type value) = 0; private: void read(no_type3&) {}; void read(no_type4&) {}; void read(no_type5&) {}; void read(no_type6&) {}; void read(no_type7&) {}; void read(no_type8&) {}; }; //************************************************************************* /// Define the reader type for 1 type. //************************************************************************* template class reader_type { public: friend class variant; virtual ~reader_type() { } virtual void read(typename etl::parameter_type::type value) = 0; private: void read(no_type2&) {}; void read(no_type3&) {}; void read(no_type4&) {}; void read(no_type5&) {}; void read(no_type6&) {}; void read(no_type7&) {}; void read(no_type8&) {}; }; //*************************************************************************** /// The base type for derived readers. //*************************************************************************** typedef reader_type reader; //*************************************************************************** /// Default constructor. /// Sets the state of the instance to containing no valid data. //*************************************************************************** #include "diagnostic_uninitialized_push.h" variant() : type_id(UNSUPPORTED_TYPE_ID) { } #include "diagnostic_pop.h" //*************************************************************************** /// Constructor that catches any types that are not supported. /// Forces a ETL_STATIC_ASSERT. //*************************************************************************** template variant(const T& value) { ETL_STATIC_ASSERT(Type_Is_Supported::value, "Unsupported type"); ::new (static_cast(data)) T(value); type_id = Type_Id_Lookup::type_id; } //*************************************************************************** /// Copy constructor. ///\param other The other variant object to copy. //*************************************************************************** #include "diagnostic_uninitialized_push.h" variant(const variant& other) { switch (other.type_id) { case 0: ::new (static_cast(data)) T1(other.get()); break; case 1: ::new (static_cast(data)) T2(other.get()); break; case 2: ::new (static_cast(data)) T3(other.get()); break; case 3: ::new (static_cast(data)) T4(other.get()); break; case 4: ::new (static_cast(data)) T5(other.get()); break; case 5: ::new (static_cast(data)) T6(other.get()); break; case 6: ::new (static_cast(data)) T7(other.get()); break; case 7: ::new (static_cast(data)) T8(other.get()); break; default: break; } type_id = other.type_id; } #include "diagnostic_pop.h" #if ETL_USING_CPP11 && ETL_NOT_USING_STLPORT && !defined(ETL_VARIANT_FORCE_CPP03_IMPLEMENTATION) //************************************************************************* /// Emplace with variadic constructor parameters. //************************************************************************* template T& emplace(Args&&... args) { ETL_STATIC_ASSERT(Type_Is_Supported::value, "Unsupported type"); destruct_current(); ::new (static_cast(data)) T(etl::forward(args)...); type_id = Type_Id_Lookup::type_id; return *static_cast(data); } #else //*************************************************************************** /// Emplace with one constructor parameter. //*************************************************************************** template T& emplace() { ETL_STATIC_ASSERT(Type_Is_Supported::value, "Unsupported type"); destruct_current(); ::new (static_cast(data)) T(); type_id = Type_Id_Lookup::type_id; return *static_cast(data); } //*************************************************************************** /// Emplace with one constructor parameter. //*************************************************************************** template T& emplace(const TP1& value1) { ETL_STATIC_ASSERT(Type_Is_Supported::value, "Unsupported type"); destruct_current(); ::new (static_cast(data)) T(value1); type_id = Type_Id_Lookup::type_id; return *static_cast(data); } //*************************************************************************** /// Emplace with two constructor parameters. //*************************************************************************** template T& emplace(const TP1& value1, const TP2& value2) { ETL_STATIC_ASSERT(Type_Is_Supported::value, "Unsupported type"); destruct_current(); ::new (static_cast(data)) T(value1, value2); type_id = Type_Id_Lookup::type_id; return *static_cast(data); } //*************************************************************************** /// Emplace with three constructor parameters. //*************************************************************************** template T& emplace(const TP1& value1, const TP2& value2, const TP3& value3) { ETL_STATIC_ASSERT(Type_Is_Supported::value, "Unsupported type"); destruct_current(); ::new (static_cast(data)) T(value1, value2, value3); type_id = Type_Id_Lookup::type_id; return *static_cast(data); } //*************************************************************************** /// Emplace with four constructor parameters. //*************************************************************************** template T& emplace(const TP1& value1, const TP2& value2, const TP3& value3, const TP4& value4) { ETL_STATIC_ASSERT(Type_Is_Supported::value, "Unsupported type"); destruct_current(); ::new (static_cast(data)) T(value1, value2, value3, value4); type_id = Type_Id_Lookup::type_id; return *static_cast(data); } #endif //*************************************************************************** /// Assignment operator for T1 type. ///\param value The value to assign. //*************************************************************************** template variant& operator =(const T& value) { ETL_STATIC_ASSERT(Type_Is_Supported::value, "Unsupported type"); destruct_current(); ::new (static_cast(data)) T(value); type_id = Type_Id_Lookup::type_id; return *this; } //*************************************************************************** /// Assignment operator for variant type. ///\param other The variant to assign. //*************************************************************************** variant& operator =(const variant& other) { if (this != &other) { destruct_current(); switch (other.type_id) { case 0: ::new (static_cast(data)) T1(other.get()); break; case 1: ::new (static_cast(data)) T2(other.get()); break; case 2: ::new (static_cast(data)) T3(other.get()); break; case 3: ::new (static_cast(data)) T4(other.get()); break; case 4: ::new (static_cast(data)) T5(other.get()); break; case 5: ::new (static_cast(data)) T6(other.get()); break; case 6: ::new (static_cast(data)) T7(other.get()); break; case 7: ::new (static_cast(data)) T8(other.get()); break; default: break; } type_id = other.type_id; } return *this; } //*************************************************************************** /// Checks if the type is the same as the current stored type. /// For variants with the same type declarations. ///\return true if the types are the same, otherwise false. //*************************************************************************** bool is_same_type(const variant& other) const { return type_id == other.type_id; } //*************************************************************************** /// Checks if the type is the same as the current stored type. /// For variants with differing declarations. ///\return true if the types are the same, otherwise false. //*************************************************************************** template bool is_same_type(const variant& other) const { bool is_same = false; switch (other.type_id) { case 0: is_same = (type_id == Type_Id_Lookup::type_id); break; case 1: is_same = (type_id == Type_Id_Lookup::type_id); break; case 2: is_same = (type_id == Type_Id_Lookup::type_id); break; case 3: is_same = (type_id == Type_Id_Lookup::type_id); break; case 4: is_same = (type_id == Type_Id_Lookup::type_id); break; case 5: is_same = (type_id == Type_Id_Lookup::type_id); break; case 6: is_same = (type_id == Type_Id_Lookup::type_id); break; case 7: is_same = (type_id == Type_Id_Lookup::type_id); break; default: break; } return is_same; } //*************************************************************************** /// Calls the supplied reader instance. /// The 'read' function appropriate to the current type is called with the stored value. //*************************************************************************** void call(reader& r) { switch (type_id) { case 0: r.read(static_cast(data)); break; case 1: r.read(static_cast(data)); break; case 2: r.read(static_cast(data)); break; case 3: r.read(static_cast(data)); break; case 4: r.read(static_cast(data)); break; case 5: r.read(static_cast(data)); break; case 6: r.read(static_cast(data)); break; case 7: r.read(static_cast(data)); break; default: break; } } //*************************************************************************** /// Checks whether a valid value is currently stored. ///\return true if the value is valid, otherwise false. //*************************************************************************** bool is_valid() const { return type_id != UNSUPPORTED_TYPE_ID; } //*************************************************************************** /// Checks to see if the type currently stored is the same as that specified in the template parameter. ///\return true if it is the specified type, otherwise false. //*************************************************************************** template bool is_type() const { return type_id == Type_Id_Lookup::type_id; } //*************************************************************************** /// Gets the index of the type currently stored or UNSUPPORTED_TYPE_ID //*************************************************************************** size_t index() const { return type_id; } //*************************************************************************** /// Clears the value to 'no valid stored value'. //*************************************************************************** void clear() { destruct_current(); } //*************************************************************************** /// Gets the value stored as the specified template type. /// Throws a variant_incorrect_type_exception if the actual type is not that specified. ///\return A reference to the value. //*************************************************************************** template T& get() { ETL_STATIC_ASSERT(Type_Is_Supported::value, "Unsupported type"); ETL_ASSERT(is_type(), ETL_ERROR(variant_incorrect_type_exception)); return static_cast(data); } //*************************************************************************** /// Gets the value stored as the specified template type. /// Throws a variant_incorrect_type_exception if the actual type is not that specified. ///\return A const reference to the value. //*************************************************************************** template const T& get() const { ETL_STATIC_ASSERT(Type_Is_Supported::value, "Unsupported type"); ETL_ASSERT(is_type(), ETL_ERROR(variant_incorrect_type_exception)); return static_cast(data); } //*************************************************************************** /// Gets the value stored as the specified template type. ///\return A pointer to the value. //*************************************************************************** template TBase* upcast_ptr() { if (is_base_of()) { return reinterpret_cast(static_cast(data)); } else { return ETL_NULLPTR; } } //*************************************************************************** /// Gets the value stored as the specified template type. ///\return A reference to the value. //*************************************************************************** template TBase& upcast() { TBase* ptr = upcast_ptr(); ETL_ASSERT(ptr != ETL_NULLPTR, ETL_ERROR(variant_not_a_base_exception)); return *ptr; } //*************************************************************************** /// Gets the value stored as the specified template type. ///\return A const pointer to the value. //*************************************************************************** template const TBase* upcast_ptr() const { if (is_base_of()) { return reinterpret_cast(static_cast(data)); } else { return ETL_NULLPTR; } } //*************************************************************************** /// Gets the value stored as the specified template type. ///\return A const reference to the value. //*************************************************************************** template const TBase& upcast() const { const TBase* ptr = upcast_ptr(); ETL_ASSERT(ptr != ETL_NULLPTR, ETL_ERROR(variant_not_a_base_exception)); return *ptr; } //*************************************************************************** /// Check that TBase is a base class of the current variant value. //*************************************************************************** template bool is_base_of() const { bool is_base; switch (type_id) { case 0: is_base = etl::is_base_of::value; break; case 1: is_base = etl::is_base_of::value; break; case 2: is_base = etl::is_base_of::value; break; case 3: is_base = etl::is_base_of::value; break; case 4: is_base = etl::is_base_of::value; break; case 5: is_base = etl::is_base_of::value; break; case 6: is_base = etl::is_base_of::value; break; case 7: is_base = etl::is_base_of::value; break; default: is_base = false; break; } return is_base; } //*************************************************************************** /// Conversion operators for each type. //*************************************************************************** operator T1& () { return get(); } operator T2& () { return get(); } operator T3& () { return get(); } operator T4& () { return get(); } operator T5& () { return get(); } operator T6& () { return get(); } operator T7& () { return get(); } operator T8& () { return get(); } //*************************************************************************** /// Checks if the template type is supported by the implementation of variant.. ///\return true if the type is supported, otherwise false. //*************************************************************************** template static bool is_supported_type() { return Type_Is_Supported::value; } private: #include "diagnostic_uninitialized_push.h" //*************************************************************************** /// Destruct the current occupant of the variant. //*************************************************************************** void destruct_current() { switch (type_id) { case 0: { static_cast(data)->~T1(); break; } case 1: { static_cast(data)->~T2(); break; } case 2: { static_cast(data)->~T3(); break; } case 3: { static_cast(data)->~T4(); break; } case 4: { static_cast(data)->~T5(); break; } case 5: { static_cast(data)->~T6(); break; } case 6: { static_cast(data)->~T7(); break; } case 7: { static_cast(data)->~T8(); break; } default: { break; } } type_id = UNSUPPORTED_TYPE_ID; } #include "diagnostic_pop.h" //*************************************************************************** /// The internal storage. /// Aligned on a suitable boundary, which should be good for all types. //*************************************************************************** typename etl::aligned_storage::type data; //*************************************************************************** /// The id of the current stored type. //*************************************************************************** type_id_t type_id; }; namespace private_variant { template struct variant_alternative_helper; #define ETL_VARIANT_HELPER(INDEX, TYPE) \ template \ struct variant_alternative_helper > \ { \ typedef TYPE type; \ }; ETL_VARIANT_HELPER(0, T1) ETL_VARIANT_HELPER(1, T2) ETL_VARIANT_HELPER(2, T3) ETL_VARIANT_HELPER(3, T4) ETL_VARIANT_HELPER(4, T5) ETL_VARIANT_HELPER(5, T6) ETL_VARIANT_HELPER(6, T7) ETL_VARIANT_HELPER(7, T8) #undef ETL_VARIANT_HELPER } // namespace private_variant template struct variant_alternative { typedef typename private_variant::variant_alternative_helper::type type; }; template struct variant_alternative { typedef typename private_variant::variant_alternative_helper::type const type; }; template struct variant_alternative { typedef typename private_variant::variant_alternative_helper::type volatile type; }; template struct variant_alternative { typedef typename private_variant::variant_alternative_helper::type const volatile type; }; template inline T& get(TVariant& variant) { return variant.template get(); } template inline T const& get(TVariant const& variant) { return variant.template get(); } template inline typename variant_alternative::type& get(TVariant& variant) { return get::type>(variant); } template inline typename variant_alternative::type& get(TVariant const& variant) { return get::type>(variant); } #define ETL_GEN_LEGACY_VISIT(VISITQUAL, VARIANTQUAL) \ template \ static TReturn visit(TVisitor VISITQUAL visitor, TVariant VARIANTQUAL variant) \ { \ switch (variant.index()) \ { \ case 0: return static_cast(visitor(get<0>(variant))); \ case 1: return static_cast(visitor(get<1>(variant))); \ case 2: return static_cast(visitor(get<2>(variant))); \ case 3: return static_cast(visitor(get<3>(variant))); \ case 4: return static_cast(visitor(get<4>(variant))); \ case 5: return static_cast(visitor(get<5>(variant))); \ case 6: return static_cast(visitor(get<6>(variant))); \ case 7: return static_cast(visitor(get<7>(variant))); \ default: ETL_ASSERT_FAIL_AND_RETURN_VALUE(ETL_ERROR(bad_variant_access), TReturn()); \ } \ } ETL_GEN_LEGACY_VISIT(&, &) ETL_GEN_LEGACY_VISIT(const&, &) ETL_GEN_LEGACY_VISIT(&, const&) ETL_GEN_LEGACY_VISIT(const&, const&) #undef ETL_GEN_LEGACY_VISIT #if ETL_NOT_USING_LEGACY_VARIANT } #endif }