phynexis-deps/cereal
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Cleanup on documentation/some other small things

Browse Source 
relates #188
This commit is contained in:
Shane Grant
2015-12-25 17:51:02 -08:00
parent 3f055ae24c
commit 33e421cb32
2 changed files with 16 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files
include/cereal/details/polymorphic_impl.hpp
+11 -19
View File
@@ -38,8 +38,9 @@
(C) Copyright 2006 David Abrahams - http://www.boost.org.
See /boost/serialization/export.hpp and /boost/archive/detail/register_archive.hpp for their
implementation.
See /boost/serialization/export.hpp, /boost/archive/detail/register_archive.hpp,
and /boost/serialization/void_cast.hpp for their implementation. Additional details
found in other files split across serialization and archive.
*/
#ifndef CEREAL_DETAILS_POLYMORPHIC_IMPL_HPP_
#define CEREAL_DETAILS_POLYMORPHIC_IMPL_HPP_
@@ -79,21 +80,17 @@ namespace cereal
//! Base type for polymorphic void casting
/*! Contains functions for casting between registered base and derived types.
This class will be allocated as a StaticObject and only referenced by pointer,
allowing a templated derived version of it to define strongly typed functions
that cast between registered base and derived types.
This is necessary so that cereal can properly cast between polymorphic types
even though void pointers are used, which normally have no type information.
Runtime type information is used instead to index a compile-time made mapping
that can perform the proper cast. */
that can perform the proper cast.
This class will be allocated as a StaticObject and only referenced by pointer,
allowing a templated derived version of it to define strongly typed functions
that cast between registered base and derived types. */
struct PolymorphicCaster
{
//! Downcasts to the proper derived type
/*! This should be overrriden in derived types, which can
be templated to allow the proper base derived type
paring to be used, while allowing generic access
through a void pointer. */
virtual void const * downcast( void const * const ptr ) const = 0;
//! Upcast to proper base type
virtual void * upcast( void * const ptr ) const = 0;
@@ -106,11 +103,8 @@ namespace cereal
all registered mappings between base and derived types. */
struct PolymorphicCasters
{
//! Maps a derived type index to a polymorphic caster
using PolymorphicCasterMap = std::map<std::type_index, PolymorphicCaster const*>;
//! Maps from base type index to derived mapping
std::map<std::type_index, PolymorphicCasterMap> map;
//! Maps from base type index to a map from derived type index to caster
std::map<std::type_index, std::map<std::type_index, PolymorphicCaster const*>> map;
//! Error message used for unregistered polymorphic casts
#define UNREGISTERED_POLYMORPHIC_CAST_EXCEPTION(LoadSave) \
@@ -123,7 +117,7 @@ namespace cereal
/*! Uses the type info from the base and derived class to find the matching
registered caster. If no matching caster exists, calls the exception function.
The returned PolymorphicCaster is capable of upcasting or downcasting between the two types */
The returned PolymorphicCaster is capable of upcasting or downcasting between the two types. */
template <class F>
static PolymorphicCaster const * lookup( std::type_info const & baseInfo, std::type_info const & derivedInfo, F && exceptionFunc )
{
@@ -336,7 +330,6 @@ namespace cereal
ar( CEREAL_NVP_("ptr_wrapper", ::cereal::memory_detail::make_ptr_wrapper(ptr)) );
dptr = PolymorphicCasters::template upcast<T>( ptr, baseInfo );
//dptr = ptr;
};
serializers.unique_ptr =
@@ -347,7 +340,6 @@ namespace cereal
ar( CEREAL_NVP_("ptr_wrapper", ::cereal::memory_detail::make_ptr_wrapper(ptr)) );
//dptr.reset(ptr.release());
dptr.reset( PolymorphicCasters::template upcast<T>( ptr.release(), baseInfo ));
};
include/cereal/types/base_class.hpp
+5 -2
View File
@@ -37,8 +37,9 @@ namespace cereal
{
namespace base_class_detail
{
//! Used to register polymorphic relations and avoid the need to include
//! polymorphic.hpp when no polymorphism is used
//! Used to register polymorphic relations and avoid the need to include
//! polymorphic.hpp when no polymorphism is used
/*! @internal */
template <class Base, class Derived, bool IsPolymorphic = std::is_polymorphic<Base>::value>
struct RegisterPolymorphicBaseClass
{
@@ -46,6 +47,8 @@ namespace cereal
{ }
};
//! Polymorphic version
/*! @internal */
template <class Base, class Derived>
struct RegisterPolymorphicBaseClass<Base, Derived, true>
{