// // Any.h // // Library: Foundation // Package: Core // Module: Any // // Copyright Kevlin Henney, 2000, 2001, 2002. All rights reserved. // Extracted from Boost 1.33.1 lib and adapted for poco: Peter Schojer/AppliedInformatics 2006-02-02 // // SPDX-License-Identifier: BSL-1.0 // #ifndef Foundation_Any_INCLUDED #define Foundation_Any_INCLUDED #include "Poco/Exception.h" #include "Poco/MetaProgramming.h" #include #include #include #include namespace Poco { class Any; using namespace std::string_literals; namespace Dynamic { class Var; class VarHolder; template class VarHolderImpl; } #ifndef POCO_DOC template struct TypeSizeLE: std::integral_constant{}; template struct TypeSizeGT: std::integral_constant S)>{}; #endif template union Placeholder /// ValueHolder union (used by Poco::Any and Poco::Dynamic::Var for small /// object optimization, when enabled). /// /// If Holder fits into POCO_SMALL_OBJECT_SIZE bytes of storage, /// it will be placement-new-allocated into the local buffer /// (i.e. there will be no heap-allocation). The local buffer size is one byte /// larger - [POCO_SMALL_OBJECT_SIZE + 1], additional byte value indicating /// where the object was allocated (0 => heap, 1 => local). /// /// Important: for SOO builds, only same-type (or trivial both-empty no-op) /// swap operation is allowed. { public: struct Size { enum { value = SizeV }; }; Placeholder(const Placeholder&) = delete; Placeholder(Placeholder&&) = delete; Placeholder& operator=(const Placeholder&) = delete; Placeholder& operator=(Placeholder&&) = delete; #ifndef POCO_NO_SOO Placeholder(): pHolder(0) { std::memset(holder, 0, sizeof(holder)); } ~Placeholder() { destruct(false); } void swap(Placeholder& other) noexcept { if (!isEmpty() || !other.isEmpty()) std::swap(holder, other.holder); } void erase() { destruct(true); } bool isEmpty() const { static char buf[sizeof(holder)] = {}; return 0 == std::memcmp(holder, buf, sizeof(holder)); } bool isLocal() const { return holder[SizeV] != 0; } template::value>::type* = nullptr> PlaceholderT* assign(const V& value) { erase(); new (reinterpret_cast(holder)) T(value); setLocal(true); return reinterpret_cast(holder); } template::value>::type* = nullptr> PlaceholderT* assign(const V& value) { erase(); pHolder = new T(value); setLocal(false); return pHolder; } PlaceholderT* content() const { if (isLocal()) return reinterpret_cast(holder); else return pHolder; } private: typedef std::max_align_t AlignerType; static_assert(sizeof(AlignerType) <= SizeV + 1, "Aligner type is bigger than the actual storage, so SizeV should be made bigger otherwise you simply waste unused memory."); void setLocal(bool local) const { holder[SizeV] = local ? 1 : 0; } void destruct(bool clear) { if (!isEmpty()) { if (!isLocal()) delete pHolder; else reinterpret_cast(holder)->~PlaceholderT(); if (clear) std::memset(holder, 0, sizeof(holder)); } } mutable unsigned char holder[SizeV+1]; AlignerType aligner; #else // POCO_NO_SOO Placeholder(): pHolder(0) { } ~Placeholder() { delete pHolder; } void swap(Placeholder& other) noexcept { std::swap(pHolder, other.pHolder); } void erase() { delete pHolder; pHolder = 0; } bool isEmpty() const { return 0 == pHolder; } bool isLocal() const { return false; } template PlaceholderT* assign(const V& value) { erase(); return pHolder = new T(value); } PlaceholderT* content() const { return pHolder; } private: #endif // POCO_NO_SOO PlaceholderT* pHolder; }; class Any /// Any class represents a general type and is capable of storing any type, supporting type-safe extraction /// of the internally stored data. /// /// Code taken from the Boost 1.33.1 library. Original copyright by Kevlin Henney. Modified for Poco /// by Applied Informatics. /// /// Modified for small object optimization support (optionally supported through conditional compilation) /// by Alex Fabijanic. { public: Any() /// Creates an empty any type. { } template Any(const ValueType & value) /// Creates an any which stores the init parameter inside. /// /// Example: /// Any a(13); /// Any a(string("12345")); { construct(value); } Any(const Any& other) /// Copy constructor, works with both empty and initialized Any values. { if ((this != &other) && !other.empty()) construct(other); } ~Any() /// Destructor. If Any is locally held, calls ValueHolder destructor; /// otherwise, deletes the placeholder from the heap. { } Any& swap(Any& other) noexcept /// Swaps the content of the two Anys. /// /// If an exception occurs during swapping, the program /// execution is aborted. { if (this == &other) return *this; if (!_valueHolder.isLocal() && !other._valueHolder.isLocal()) { _valueHolder.swap(other._valueHolder); } else { try { Any tmp(*this); construct(other); other = tmp; } catch (...) { std::abort(); } } return *this; } template Any& operator = (const ValueType& rhs) /// Assignment operator for all types != Any. /// /// Example: /// Any a = 13; /// Any a = string("12345"); { construct(rhs); return *this; } Any& operator = (const Any& rhs) /// Assignment operator for Any. { if ((this != &rhs) && !rhs.empty()) construct(rhs); else if ((this != &rhs) && rhs.empty()) _valueHolder.erase(); return *this; } bool empty() const /// Returns true if the Any is empty. { return _valueHolder.isEmpty(); } const std::type_info& type() const /// Returns the type information of the stored content. /// If the Any is empty typeid(void) is returned. /// It is recommended to always query an Any for its type info before /// trying to extract data via an AnyCast/RefAnyCast. { return empty() ? typeid(void) : content()->type(); } bool local() const /// Returns true if data is held locally (ie. not allocated on the heap). /// If POCO_NO_SOO is defined, it always return false. /// The main purpose of this function is use for testing. { return _valueHolder.isLocal(); } private: class ValueHolder { public: virtual ~ValueHolder() = default; virtual const std::type_info & type() const = 0; virtual void clone(Placeholder*) const = 0; }; template class Holder : public ValueHolder { public: Holder(const ValueType & value) : _held(value) { } virtual const std::type_info& type() const { return typeid(ValueType); } virtual void clone(Placeholder* pPlaceholder) const { pPlaceholder->assign, ValueType>(_held); } ValueType _held; private: Holder & operator = (const Holder &); }; ValueHolder* content() const { return _valueHolder.content(); } template void construct(const ValueType& value) { _valueHolder.assign, ValueType>(value); } void construct(const Any& other) { if (!other.empty()) other.content()->clone(&_valueHolder); else _valueHolder.erase(); } Placeholder _valueHolder; template friend ValueType* AnyCast(Any*); template friend const ValueType* AnyCast(const Any*); template friend ValueType* UnsafeAnyCast(Any*); template friend const ValueType& RefAnyCast(const Any&); template friend ValueType& RefAnyCast(Any&); template friend ValueType AnyCast(Any&); }; template ValueType* AnyCast(Any* operand) /// AnyCast operator used to extract the ValueType from an Any*. Will return a pointer /// to the stored value. /// /// Example Usage: /// MyType* pTmp = AnyCast(pAny). /// Returns nullptr if the types don't match. { return operand && operand->type() == typeid(ValueType) ? &static_cast*>(operand->content())->_held : nullptr; } template const ValueType* AnyCast(const Any* operand) /// AnyCast operator used to extract a const ValueType pointer from an const Any*. Will return a const pointer /// to the stored value. /// /// Example Usage: /// const MyType* pTmp = AnyCast(pAny). /// Returns nullptr if the types don't match. { return operand && operand->type() == typeid(ValueType) ? &static_cast*>(operand->content())->_held : nullptr; } template ValueType AnyCast(Any& operand) /// AnyCast operator used to extract a copy of the ValueType from an Any&. /// /// Example Usage: /// MyType tmp = AnyCast(anAny). /// Will throw a BadCastException if the cast fails. /// Do not use an AnyCast in combination with references, i.e. MyType& tmp = ... or const MyType& tmp = ... /// Some compilers will accept this code although a copy is returned. Use the RefAnyCast in /// these cases. { using NonRef = typename TypeWrapper::TYPE; NonRef* result = AnyCast(&operand); if (!result) { std::string s(__func__); s.append(": Failed to convert between Any types "s); if (operand.content()) { s.append(1, '('); s.append(Poco::demangle(operand.content()->type().name())); s.append(" => "); s.append(Poco::demangle()); s.append(1, ')'); } throw BadCastException(s); } return *result; } template ValueType AnyCast(const Any& operand) /// AnyCast operator used to extract a copy of the ValueType from an const Any&. /// /// Example Usage: /// MyType tmp = AnyCast(anAny). /// Will throw a BadCastException if the cast fails. /// Do not use an AnyCast in combination with references, i.e. MyType& tmp = ... or const MyType& = ... /// Some compilers will accept this code although a copy is returned. Use the RefAnyCast in /// these cases. { using NonRef = typename TypeWrapper::TYPE; return AnyCast(const_cast(operand)); } template const ValueType& RefAnyCast(const Any & operand) /// AnyCast operator used to return a const reference to the internal data. /// /// Example Usage: /// const MyType& tmp = RefAnyCast(anAny); { ValueType* result = AnyCast(const_cast(&operand)); if (!result) { std::string s(__func__); s.append(": Failed to convert between Any types "s); if (operand.content()) { s.append(1, '('); s.append(Poco::demangle(operand.content()->type().name())); s.append(" => "); s.append(Poco::demangle()); s.append(1, ')'); } throw BadCastException(s); } return *result; } template ValueType& RefAnyCast(Any& operand) /// AnyCast operator used to return a reference to the internal data. /// /// Example Usage: /// MyType& tmp = RefAnyCast(anAny); { ValueType* result = AnyCast(&operand); if (!result) { std::string s(__func__); s.append(": Failed to convert between Any types "s); if (operand.content()) { s.append(1, '('); s.append(Poco::demangle(operand.content()->type().name())); s.append(" => "); s.append(Poco::demangle()); s.append(1, ')'); } throw BadCastException(s); } return *result; } template ValueType* UnsafeAnyCast(Any* operand) /// The "unsafe" versions of AnyCast are not part of the /// public interface and may be removed at any time. They are /// required where we know what type is stored in the any and can't /// use typeid() comparison, e.g., when our types may travel across /// different shared libraries. { return &static_cast*>(operand->content())->_held; } template const ValueType* UnsafeAnyCast(const Any* operand) /// The "unsafe" versions of AnyCast are not part of the /// public interface and may be removed at any time. They are /// required where we know what type is stored in the any and can't /// use typeid() comparison, e.g., when our types may travel across /// different shared libraries. { return AnyCast(const_cast(operand)); } template bool AnyHoldsNullPtr(const Any& any) /// Returns true if any holds a null pointer. /// Fails to compile if `ValueType` is not a pointer. { poco_static_assert_ptr(ValueType); return (AnyCast(any) == nullptr); } template bool AnyHoldsNullPtr(const Any* pAny) /// Returns true if the Any pointed to holds a null pointer. /// Returns false if `pAny` is a null pointer. { if (!pAny) return false; return (AnyHoldsNullPtr(*pAny)); } } // namespace Poco #endif