30 #ifndef CEREAL_TYPES_POLYMORPHIC_HPP_ 31 #define CEREAL_TYPES_POLYMORPHIC_HPP_ 42 #define CEREAL_STATIC_CONSTEXPR static 44 #define CEREAL_STATIC_CONSTEXPR static constexpr 82 #define CEREAL_REGISTER_TYPE(...) \ 86 struct binding_name<__VA_ARGS__> \ 88 CEREAL_STATIC_CONSTEXPR char const * name() { return #__VA_ARGS__; } \ 91 CEREAL_BIND_TO_ARCHIVES(__VA_ARGS__) 99 #define CEREAL_REGISTER_TYPE_WITH_NAME(T, Name) \ 103 struct binding_name<T> \ 104 { CEREAL_STATIC_CONSTEXPR char const * name() { return Name; } }; \ 106 CEREAL_BIND_TO_ARCHIVES(T) 121 #define CEREAL_REGISTER_POLYMORPHIC_RELATION(Base, Derived) \ 125 struct PolymorphicRelation<Base, Derived> \ 126 { static void bind() { RegisterPolymorphicCaster<Base, Derived>::bind(); } }; \ 155 #define CEREAL_REGISTER_DYNAMIC_INIT(LibName) \ 158 void CEREAL_DLL_EXPORT dynamic_init_dummy_##LibName() {} \ 168 #define CEREAL_FORCE_DYNAMIC_INIT(LibName) \ 171 void dynamic_init_dummy_##LibName(); \ 174 void dynamic_init_##LibName() \ 176 ::cereal::detail::dynamic_init_dummy_##LibName(); \ 182 namespace polymorphic_detail
186 #define UNREGISTERED_POLYMORPHIC_EXCEPTION(LoadSave, Name) \ 187 throw cereal::Exception("Trying to " #LoadSave " an unregistered polymorphic type (" + Name + ").\n" \ 188 "Make sure your type is registered with CEREAL_REGISTER_TYPE and that the archive " \ 189 "you are using was included (and registered with CEREAL_REGISTER_ARCHIVE) prior to calling CEREAL_REGISTER_TYPE.\n" \ 190 "If your type is already registered and you still see this error, you may need to use CEREAL_REGISTER_DYNAMIC_INIT."); 194 template<
class Archive>
inline 195 typename ::cereal::detail::InputBindingMap<Archive>::Serializers
getInputBinding(Archive & ar, std::uint32_t
const nameid)
200 typename ::cereal::detail::InputBindingMap<Archive>::Serializers emptySerializers;
201 emptySerializers.shared_ptr = [](
void*, std::shared_ptr<void> & ptr, std::type_info
const &) { ptr.reset(); };
202 emptySerializers.unique_ptr = [](
void*, std::unique_ptr<void, ::cereal::detail::EmptyDeleter<void>> & ptr, std::type_info
const &) { ptr.reset(
nullptr ); };
203 return emptySerializers;
207 if(nameid & detail::msb_32bit)
210 ar.registerPolymorphicName(nameid, name);
213 name = ar.getPolymorphicName(nameid);
217 auto binding = bindingMap.find(name);
218 if(binding == bindingMap.end())
220 return binding->second;
230 template<
class Archive,
class T>
inline 231 typename std::enable_if<(traits::is_default_constructible<T>::value
233 && !std::is_abstract<T>::value,
bool>::type
236 if(nameid & detail::msb2_32bit)
238 ar(
CEREAL_NVP_(
"ptr_wrapper", memory_detail::make_ptr_wrapper(ptr)) );
248 template<
class Archive,
class T,
class D>
inline 249 typename std::enable_if<(traits::is_default_constructible<T>::value
251 && !std::is_abstract<T>::value,
bool>::type
254 if(nameid & detail::msb2_32bit)
256 ar(
CEREAL_NVP_(
"ptr_wrapper", memory_detail::make_ptr_wrapper(ptr)) );
268 template<
class Archive,
class T>
inline 269 typename std::enable_if<(!traits::is_default_constructible<T>::value
271 || std::is_abstract<T>::value,
bool>::type
274 if(nameid & detail::msb2_32bit)
275 throw cereal::Exception(
"Cannot load a polymorphic type that is not default constructable and does not have a load_and_construct function");
285 template<
class Archive,
class T,
class D>
inline 286 typename std::enable_if<(!traits::is_default_constructible<T>::value
288 || std::is_abstract<T>::value,
bool>::type
291 if(nameid & detail::msb2_32bit)
292 throw cereal::Exception(
"Cannot load a polymorphic type that is not default constructable and does not have a load_and_construct function");
301 template <
class Archive,
class T>
inline 302 typename std::enable_if<std::is_polymorphic<T>::value && std::is_abstract<T>::value,
void>::type
308 ar(
CEREAL_NVP_(
"polymorphic_id", std::uint32_t(0)) );
312 std::type_info
const & ptrinfo =
typeid(*ptr.get());
313 static std::type_info
const & tinfo =
typeid(T);
320 auto binding = bindingMap.find(std::type_index(ptrinfo));
321 if(binding == bindingMap.end())
324 binding->second.shared_ptr(&ar, ptr.get(), tinfo);
328 template <
class Archive,
class T>
inline 329 typename std::enable_if<std::is_polymorphic<T>::value && !std::is_abstract<T>::value,
void>::type
335 ar(
CEREAL_NVP_(
"polymorphic_id", std::uint32_t(0)) );
339 std::type_info
const & ptrinfo =
typeid(*ptr.get());
340 static std::type_info
const & tinfo =
typeid(T);
346 ar(
CEREAL_NVP_(
"polymorphic_id", detail::msb2_32bit) );
348 ar(
CEREAL_NVP_(
"ptr_wrapper", memory_detail::make_ptr_wrapper(ptr)) );
355 auto binding = bindingMap.find(std::type_index(ptrinfo));
356 if(binding == bindingMap.end())
359 binding->second.shared_ptr(&ar, ptr.get(), tinfo);
363 template <
class Archive,
class T>
inline 364 typename std::enable_if<std::is_polymorphic<T>::value,
void>::type
367 std::uint32_t nameid;
371 if(polymorphic_detail::serialize_wrapper(ar, ptr, nameid))
374 auto binding = polymorphic_detail::getInputBinding(ar, nameid);
375 std::shared_ptr<void> result;
376 binding.shared_ptr(&ar, result,
typeid(T));
377 ptr = std::static_pointer_cast<T>(result);
381 template <
class Archive,
class T>
inline 382 typename std::enable_if<std::is_polymorphic<T>::value,
void>::type
385 auto const sptr = ptr.lock();
390 template <
class Archive,
class T>
inline 391 typename std::enable_if<std::is_polymorphic<T>::value,
void>::type
394 std::shared_ptr<T> sptr;
400 template <
class Archive,
class T,
class D>
inline 401 typename std::enable_if<std::is_polymorphic<T>::value && std::is_abstract<T>::value,
void>::type
407 ar(
CEREAL_NVP_(
"polymorphic_id", std::uint32_t(0)) );
411 std::type_info
const & ptrinfo =
typeid(*ptr.get());
412 static std::type_info
const & tinfo =
typeid(T);
419 auto binding = bindingMap.find(std::type_index(ptrinfo));
420 if(binding == bindingMap.end())
423 binding->second.unique_ptr(&ar, ptr.get(), tinfo);
427 template <
class Archive,
class T,
class D>
inline 428 typename std::enable_if<std::is_polymorphic<T>::value && !std::is_abstract<T>::value,
void>::type
434 ar(
CEREAL_NVP_(
"polymorphic_id", std::uint32_t(0)) );
438 std::type_info
const & ptrinfo =
typeid(*ptr.get());
439 static std::type_info
const & tinfo =
typeid(T);
445 ar(
CEREAL_NVP_(
"polymorphic_id", detail::msb2_32bit) );
447 ar(
CEREAL_NVP_(
"ptr_wrapper", memory_detail::make_ptr_wrapper(ptr)) );
454 auto binding = bindingMap.find(std::type_index(ptrinfo));
455 if(binding == bindingMap.end())
458 binding->second.unique_ptr(&ar, ptr.get(), tinfo);
462 template <
class Archive,
class T,
class D>
inline 463 typename std::enable_if<std::is_polymorphic<T>::value,
void>::type
466 std::uint32_t nameid;
470 if(polymorphic_detail::serialize_wrapper(ar, ptr, nameid))
473 auto binding = polymorphic_detail::getInputBinding(ar, nameid);
474 std::unique_ptr<void, ::cereal::detail::EmptyDeleter<void>> result;
475 binding.unique_ptr(&ar, result,
typeid(T));
476 ptr.reset(static_cast<T*>(result.release()));
479 #undef UNREGISTERED_POLYMORPHIC_EXCEPTION 481 #endif // CEREAL_TYPES_POLYMORPHIC_HPP_ Non member load and construct check.
Definition: traits.hpp:917
#define CEREAL_NVP_(name, value)
Convenience for creating a templated NVP.
Definition: helpers.hpp:199
std::enable_if<(traits::is_default_constructible< T >::value||traits::has_load_and_construct< T, Archive >::value) &&!std::is_abstract< T >::value, bool >::type serialize_wrapper(Archive &ar, std::shared_ptr< T > &ptr, std::uint32_t const nameid)
Serialize a shared_ptr if the 2nd msb in the nameid is set, and if we can actually construct the poin...
Definition: polymorphic.hpp:234
typename ::cereal::detail::InputBindingMap< Archive >::Serializers getInputBinding(Archive &ar, std::uint32_t const nameid)
Get an input binding from the given archive by deserializing the type meta data.
Definition: polymorphic.hpp:195
#define UNREGISTERED_POLYMORPHIC_EXCEPTION(LoadSave, Name)
Error message used for unregistered polymorphic types.
Definition: polymorphic.hpp:186
Internal type trait support.
Internal helper functionality.
Definition: access.hpp:40
Main cereal functionality.
#define CEREAL_LOAD_FUNCTION_NAME
The deserialization (load) function name to search for.
Definition: macros.hpp:85
Internal polymorphism support.
#define CEREAL_SAVE_FUNCTION_NAME
The serialization (save) function name to search for.
Definition: macros.hpp:92
A static, pre-execution object.
Definition: static_object.hpp:67
Support for types found in <memory>
An exception class thrown when things go wrong at runtime.
Definition: helpers.hpp:48