boost/archive/basic_binary_oprimitive.hpp

   1 #ifndef BOOST_ARCHIVE_BASIC_BINARY_OPRIMITIVE_HPP
   2 #define BOOST_ARCHIVE_BASIC_BINARY_OPRIMITIVE_HPP
   3
   4 // MS compatible compilers support #pragma once
   5 #if defined(_MSC_VER) && (_MSC_VER >= 1020)
   6 # pragma once
   7 #endif
   8
   9 /////////1/////////2/////////3/////////4/////////5/////////6/////////7/////////8
  10 // basic_binary_oprimitive.hpp
  11
  12 // (C) Copyright 2002 Robert Ramey - http://www.rrsd.com .
  13 // Use, modification and distribution is subject to the Boost Software
  14 // License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
  15 // http://www.boost.org/LICENSE_1_0.txt)
  16
  17 //  See http://www.boost.org for updates, documentation, and revision history.
  18
  19 // archives stored as native binary - this should be the fastest way
  20 // to archive the state of a group of obects.  It makes no attempt to
  21 // convert to any canonical form.
  22
  23 // IN GENERAL, ARCHIVES CREATED WITH THIS CLASS WILL NOT BE READABLE
  24 // ON PLATFORM APART FROM THE ONE THEY ARE CREATE ON
  25
  26 #include <iosfwd>
  27 #include <boost/assert.hpp>
  28 #include <locale>
  29 #include <streambuf> // basic_streambuf
  30 #include <string>
  31 #include <cstddef> // size_t
  32
  33 #include <boost/config.hpp>
  34 #if defined(BOOST_NO_STDC_NAMESPACE)
  35 namespace std{
  36     using ::size_t;
  37 } // namespace std
  38 #endif
  39
  40 #include <boost/cstdint.hpp>
  41 #include <boost/integer.hpp>
  42 #include <boost/integer_traits.hpp>
  43 #include <boost/scoped_ptr.hpp>
  44 #include <boost/serialization/throw_exception.hpp>
  45
  46 #include <boost/archive/basic_streambuf_locale_saver.hpp>
  47 #include <boost/archive/archive_exception.hpp>
  48 #include <boost/serialization/is_bitwise_serializable.hpp>
  49 #include <boost/mpl/placeholders.hpp>
  50 #include <boost/serialization/array.hpp>
  51 #include <boost/archive/detail/auto_link_archive.hpp>
  52 #include <boost/archive/detail/abi_prefix.hpp> // must be the last header
  53
  54 namespace boost {
  55 namespace archive {
  56
  57 /////////////////////////////////////////////////////////////////////////
  58 // class basic_binary_oprimitive - binary output of prmitives
  59
  60 template<class Archive, class Elem, class Tr>
  61 class basic_binary_oprimitive
  62 {
  63 #ifndef BOOST_NO_MEMBER_TEMPLATE_FRIENDS
  64     friend class save_access;
  65 protected:
  66 #else
  67 public:
  68 #endif
  69     std::basic_streambuf<Elem, Tr> & m_sb;
  70     // return a pointer to the most derived class
  71     Archive * This(){
  72         return static_cast<Archive *>(this);
  73     }
  74     #ifndef BOOST_NO_STD_LOCALE
  75     boost::scoped_ptr<std::locale> archive_locale;
  76     basic_streambuf_locale_saver<Elem, Tr> locale_saver;
  77     #endif
  78     // default saving of primitives.
  79     template<class T>
  80     void save(const T & t)
  81     {
  82         save_binary(& t, sizeof(T));
  83     }
  84
  85     /////////////////////////////////////////////////////////
  86     // fundamental types that need special treatment
  87
  88     // trap usage of invalid uninitialized boolean which would
  89     // otherwise crash on load.
  90     void save(const bool t){
  91         BOOST_ASSERT(0 == static_cast<int>(t) || 1 == static_cast<int>(t));
  92         save_binary(& t, sizeof(t));
  93     }
  94     BOOST_ARCHIVE_OR_WARCHIVE_DECL(void)
  95     save(const std::string &s);
  96     #ifndef BOOST_NO_STD_WSTRING
  97     BOOST_ARCHIVE_OR_WARCHIVE_DECL(void)
  98     save(const std::wstring &ws);
  99     #endif
 100     BOOST_ARCHIVE_OR_WARCHIVE_DECL(void)
 101     save(const char * t);
 102     BOOST_ARCHIVE_OR_WARCHIVE_DECL(void)
 103     save(const wchar_t * t);
 104
 105     BOOST_ARCHIVE_OR_WARCHIVE_DECL(void)
 106     init();
 107
 108     BOOST_ARCHIVE_OR_WARCHIVE_DECL(BOOST_PP_EMPTY())
 109     basic_binary_oprimitive(
 110         std::basic_streambuf<Elem, Tr> & sb,
 111         bool no_codecvt
 112     );
 113     BOOST_ARCHIVE_OR_WARCHIVE_DECL(BOOST_PP_EMPTY())
 114     ~basic_binary_oprimitive();
 115 public:
 116
 117     // we provide an optimized save for all fundamental types
 118     // typedef serialization::is_bitwise_serializable<mpl::_1>
 119     // use_array_optimization;
 120     // workaround without using mpl lambdas
 121     struct use_array_optimization {
 122         template <class T>
 123         #if defined(BOOST_NO_DEPENDENT_NESTED_DERIVATIONS)
 124             struct apply {
 125                 typedef BOOST_DEDUCED_TYPENAME boost::serialization::is_bitwise_serializable< T >::type type;
 126             };
 127         #else
 128             struct apply : public boost::serialization::is_bitwise_serializable< T > {};
 129         #endif
 130     };
 131
 132
 133     // the optimized save_array dispatches to save_binary
 134     template <class ValueType>
 135     void save_array(boost::serialization::array<ValueType> const& a, unsigned int)
 136     {
 137       save_binary(a.address(),a.count()*sizeof(ValueType));
 138     }
 139
 140     void save_binary(const void *address, std::size_t count);
 141 };
 142
 143 template<class Archive, class Elem, class Tr>
 144 inline void
 145 basic_binary_oprimitive<Archive, Elem, Tr>::save_binary(
 146     const void *address,
 147     std::size_t count
 148 ){
 149     //BOOST_ASSERT(
 150     //    static_cast<std::size_t>((std::numeric_limits<std::streamsize>::max)()) >= count
 151     //);
 152     // note: if the following assertions fail
 153     // a likely cause is that the output stream is set to "text"
 154     // mode where by cr characters recieve special treatment.
 155     // be sure that the output stream is opened with ios::binary
 156     //if(os.fail())
 157     //    boost::serialization::throw_exception(
 158     //        archive_exception(archive_exception::output_stream_error)
 159     //    );
 160     // figure number of elements to output - round up
 161     count = ( count + sizeof(Elem) - 1)
 162         / sizeof(Elem);
 163     BOOST_ASSERT(count <= std::size_t(boost::integer_traits<std::streamsize>::const_max));
 164     std::streamsize scount = m_sb.sputn(
 165         static_cast<const Elem *>(address),
 166         static_cast<std::streamsize>(count)
 167     );
 168     if(count != static_cast<std::size_t>(scount))
 169         boost::serialization::throw_exception(
 170             archive_exception(archive_exception::output_stream_error)
 171         );
 172     //os.write(
 173     //    static_cast<const BOOST_DEDUCED_TYPENAME OStream::char_type *>(address),
 174     //    count
 175     //);
 176     //BOOST_ASSERT(os.good());
 177 }
 178
 179 } //namespace boost
 180 } //namespace archive
 181
 182 #include <boost/archive/detail/abi_suffix.hpp> // pop pragmas
 183
 184 #endif // BOOST_ARCHIVE_BASIC_BINARY_OPRIMITIVE_HPP