helpers.hpp

Go to the documentation of this file.

/*
  Copyright (c) 2014, Randolph Voorhies, Shane Grant
  All rights reserved.

  Redistribution and use in source and binary forms, with or without
  modification, are permitted provided that the following conditions are met:
      * Redistributions of source code must retain the above copyright
        notice, this list of conditions and the following disclaimer.
      * Redistributions in binary form must reproduce the above copyright
        notice, this list of conditions and the following disclaimer in the
        documentation and/or other materials provided with the distribution.
      * Neither the name of cereal nor the
        names of its contributors may be used to endorse or promote products
        derived from this software without specific prior written permission.

  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  DISCLAIMED. IN NO EVENT SHALL RANDOLPH VOORHIES OR SHANE GRANT BE LIABLE FOR ANY
  DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef CEREAL_DETAILS_HELPERS_HPP_
#define CEREAL_DETAILS_HELPERS_HPP_

#include <type_traits>
#include <cstdint>
#include <utility>
#include <memory>
#include <unordered_map>
#include <stdexcept>

#include <cereal/macros.hpp>
#include <cereal/details/static_object.hpp>

namespace cereal
{
  // ######################################################################

  struct Exception : public std::runtime_error
  {
    explicit Exception( const std::string & what_ ) : std::runtime_error(what_) {}
    explicit Exception( const char * what_ ) : std::runtime_error(what_) {}
  };

  // ######################################################################

  using size_type = uint64_t;

  // forward decls
  class BinaryOutputArchive;
  class BinaryInputArchive;

  // ######################################################################
  namespace detail
  {
    struct NameValuePairCore {}; 
  }


  template <class T>
  class NameValuePair : detail::NameValuePairCore
  {
    private:
      // If we get passed an array, keep the type as is, otherwise store
      // a reference if we were passed an l value reference, else copy the value
      using Type = typename std::conditional<std::is_array<typename std::remove_reference<T>::type>::value,
                                             typename std::remove_cv<T>::type,
                                             typename std::conditional<std::is_lvalue_reference<T>::value,
                                                                       T,
                                                                       typename std::decay<T>::type>::type>::type;

      // prevent nested nvps
      static_assert( !std::is_base_of<detail::NameValuePairCore, T>::value,
                     "Cannot pair a name to a NameValuePair" );

      NameValuePair & operator=( NameValuePair const & ) = delete;

    public:

      NameValuePair( char const * n, T && v ) : name(n), value(std::forward<T>(v)) {}

      char const * name;
      Type value;
  };


  template<class Archive, class T> inline
  typename
  std::enable_if<std::is_same<Archive, ::cereal::BinaryInputArchive>::value ||
                 std::is_same<Archive, ::cereal::BinaryOutputArchive>::value,
  T && >::type
  make_nvp( const char *, T && value )
  {
    return std::forward<T>(value);
  }


  template<class Archive, class T> inline
  typename
  std::enable_if<!std::is_same<Archive, ::cereal::BinaryInputArchive>::value &&
                 !std::is_same<Archive, ::cereal::BinaryOutputArchive>::value,
  NameValuePair<T> >::type
  make_nvp( const char * name, T && value)
  {
    return {name, std::forward<T>(value)};
  }


  #define CEREAL_NVP_(name, value) ::cereal::make_nvp<Archive>(name, value)

  // ######################################################################

  template <class T>
  struct BinaryData
  {
    using PT = typename std::conditional<std::is_const<typename std::remove_pointer<T>::type>::value,
                                         const void *,
                                         void *>::type;

    BinaryData( T && d, uint64_t s ) : data(std::forward<T>(d)), size(s) {}

    PT data;       
    uint64_t size; 
  };

  // ######################################################################
  namespace detail
  {
    // base classes for type checking
    /* The rtti virtual function only exists to enable an archive to
       be used in a polymorphic fashion, if necessary.  See the
       archive adapters for an example of this */
    class OutputArchiveBase
    {
      public:
        OutputArchiveBase() = default;
        OutputArchiveBase( OutputArchiveBase && ) CEREAL_NOEXCEPT {}
        OutputArchiveBase & operator=( OutputArchiveBase && ) CEREAL_NOEXCEPT { return *this; }
        virtual ~OutputArchiveBase() CEREAL_NOEXCEPT = default;

      private:
        virtual void rtti() {}
    };

    class InputArchiveBase
    {
      public:
        InputArchiveBase() = default;
        InputArchiveBase( InputArchiveBase && ) CEREAL_NOEXCEPT {}
        InputArchiveBase & operator=( InputArchiveBase && ) CEREAL_NOEXCEPT { return *this; }
        virtual ~InputArchiveBase() CEREAL_NOEXCEPT = default;

      private:
        virtual void rtti() {}
    };

    // forward decls for polymorphic support
    template <class Archive, class T> struct polymorphic_serialization_support;
    struct adl_tag;

    // used during saving pointers
    static const int32_t msb_32bit  = 0x80000000;
    static const int32_t msb2_32bit = 0x40000000;
  }

  // ######################################################################

  template <class T>
  class SizeTag
  {
    private:
      // Store a reference if passed an lvalue reference, otherwise
      // make a copy of the data
      using Type = typename std::conditional<std::is_lvalue_reference<T>::value,
                                             T,
                                             typename std::decay<T>::type>::type;

      SizeTag & operator=( SizeTag const & ) = delete;

    public:
      SizeTag( T && sz ) : size(std::forward<T>(sz)) {}

      Type size;
  };

  class OmittedFieldTag
  { };

  // ######################################################################

  template <class Key, class Value>
  struct MapItem
  {
    using KeyType = typename std::conditional<
      std::is_lvalue_reference<Key>::value,
      Key,
      typename std::decay<Key>::type>::type;

    using ValueType = typename std::conditional<
      std::is_lvalue_reference<Value>::value,
      Value,
      typename std::decay<Value>::type>::type;


    MapItem( Key && key_, Value && value_ ) : key(std::forward<Key>(key_)), value(std::forward<Value>(value_)) {}

    MapItem & operator=( MapItem const & ) = delete;

    KeyType key;
    ValueType value;

    template <class Archive> inline
    void CEREAL_SERIALIZE_FUNCTION_NAME(Archive & archive)
    {
      archive( make_nvp<Archive>("key",   key),
               make_nvp<Archive>("value", value) );
    }
  };


  template <class KeyType, class ValueType> inline
  MapItem<KeyType, ValueType> make_map_item(KeyType && key, ValueType && value)
  {
    return {std::forward<KeyType>(key), std::forward<ValueType>(value)};
  }

  enum class FieldSerialized
  {
      YES,
      NO,
      INTERNAL
  };

  namespace detail
  {

    template<class T>
    class VersionIdTag
    {
      public:
        VersionIdTag()
        {}

        VersionIdTag(std::uint32_t version_id_) : version_id(version_id_)
        {}

        VersionIdTag &operator=(VersionIdTag const &) = delete;

        template<class Archive>
        std::uint32_t save_minimal(Archive const &) const
        {
          return version_id;
        }

        template<class Archive>
        void load_minimal(Archive const &, std::uint32_t const &v)
        {
          version_id = v;
        }

        std::uint32_t version_id;
    };


    template<class T>
    class PolymorphicIdTag
    {
      private:
        // Store a reference if passed an lvalue reference, otherwise
        // make a copy of the data
        using Type = typename std::conditional<std::is_lvalue_reference<T>::value,
            T,
            typename std::decay<T>::type>::type;
        using SimpleType = typename std::decay<T>::type;

        PolymorphicIdTag &operator=(PolymorphicIdTag const &) = delete;

      public:
        PolymorphicIdTag(T &&polymorphic_id_) : polymorphic_id(std::forward<T>(polymorphic_id_))
        {}

        Type polymorphic_id;

        template<class Archive>
        SimpleType save_minimal(Archive const &) const
        {
          return polymorphic_id;
        }

        template<class Archive>
        void load_minimal(Archive const &, SimpleType const &v)
        {
          polymorphic_id = v;
        }
    };

    template<class T>
    inline
    PolymorphicIdTag<T> make_polymorphic_id_tag(T &&polymorphic_id)
    {
      return {std::forward<T>(polymorphic_id)};
    }


    template<class T>
    class PolymorphicKeyTag
    {
      private:
        // Store a reference if passed an lvalue reference, otherwise
        // make a copy of the data
        using Type = typename std::conditional<std::is_lvalue_reference<T>::value,
            T,
            typename std::decay<T>::type>::type;
        using SimpleType = typename std::decay<T>::type;

        PolymorphicKeyTag &operator=(PolymorphicKeyTag const &) = delete;

      public:
        PolymorphicKeyTag(T &&polymorphic_key_) : polymorphic_key(std::forward<T>(polymorphic_key_))
        {}

        Type polymorphic_key;

        template<class Archive>
        SimpleType save_minimal(Archive const &) const
        {
          return polymorphic_key;
        }

        template<class Archive>
        void load_minimal(Archive const &, SimpleType const &v)
        {
          polymorphic_key = v;
        }
    };

    template<class T>
    inline
    PolymorphicKeyTag<T> make_polymorphic_key_tag(T &&polymorphic_key)
    {
      return {std::forward<T>(polymorphic_key)};
    }


    template<class T>
    class ObjectIdTag
    {
      private:
        // Store a reference if passed an lvalue reference, otherwise
        // make a copy of the data
        using Type = typename std::conditional<std::is_lvalue_reference<T>::value,
            T,
            typename std::decay<T>::type>::type;
        using SimpleType = typename std::decay<T>::type;

        ObjectIdTag &operator=(ObjectIdTag const &) = delete;

      public:
        ObjectIdTag(T &&object_id_) : object_id(std::forward<T>(object_id_))
        {}

        Type object_id;

        template<class Archive>
        SimpleType save_minimal(Archive const &) const
        {
          return object_id;
        }

        template<class Archive>
        void load_minimal(Archive const &, SimpleType const &v)
        {
          object_id = v;
        }
    };

    template<class T>
    inline
    ObjectIdTag<T> make_object_id_tag(T &&object_id)
    {
      return {std::forward<T>(object_id)};
    }


    template<class T>
    class PointerValidityTag
    {
      private:
        // Store a reference if passed an lvalue reference, otherwise
        // make a copy of the data
        using Type = typename std::conditional<std::is_lvalue_reference<T>::value,
            T,
            typename std::decay<T>::type>::type;
        using SimpleType = typename std::decay<T>::type;

        PointerValidityTag &operator=(PointerValidityTag const &) = delete;

      public:
        PointerValidityTag(T &&valid_) : valid(std::forward<T>(valid_))
        {};

        Type valid;

        template<class Archive>
        SimpleType save_minimal(Archive const &) const
        {
          return valid;
        }

        template<class Archive>
        void load_minimal(Archive const &, SimpleType const &v)
        {
          valid = v;
        }
    };

    template<class T>
    inline
    PointerValidityTag<T> make_pointer_validity_tag(T &&valid)
    {
      return {std::forward<T>(valid)};
    }

  } // namespace detail


  namespace detail
  {

    namespace{ struct version_binding_tag {}; }

    // ######################################################################

    template <class T, class BindingTag = version_binding_tag> struct Version
    {
      static const std::uint32_t version = 0;
      // we don't need to explicitly register these types since they
      // always get a version number of 0
    };

    struct Versions
    {
      std::unordered_map<std::size_t, std::uint32_t> mapping;

      std::uint32_t find( std::size_t hash, std::uint32_t version )
      {
        const auto found = mapping.find(hash);
        if (mapping.end() != found) {
          return found->second;
        } else {
          return mapping.emplace( hash, version ).first->second;
        }
      }
    }; // struct Versions
  } // namespace detail
} // namespace cereal

#endif // CEREAL_DETAILS_HELPERS_HPP_