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)
   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 #ifndef BOOST_NO_MEMBER_TEMPLATE_FRIENDS
  63     friend class save_access;
  64 protected:
  65 #else
  66 public:
  67 #endif
  68     std::basic_streambuf<Elem, Tr> & m_sb;
  69     // return a pointer to the most derived class
  70     Archive * This(){
  71         return static_cast<Archive *>(this);
  72     }
  73     #ifndef BOOST_NO_STD_LOCALE
  74     boost::scoped_ptr<std::locale> archive_locale;
  75     basic_streambuf_locale_saver<Elem, Tr> locale_saver;
  76     #endif
  77     // default saving of primitives.
  78     template<class T>
  79     void save(const T & t)
  80     {
  81         save_binary(& t, sizeof(T));
  82     }
  83
  84     /////////////////////////////////////////////////////////
  85     // fundamental types that need special treatment
  86
  87     // trap usage of invalid uninitialized boolean which would
  88     // otherwise crash on load.
  89     void save(const bool t){
  90         BOOST_ASSERT(0 == static_cast<int>(t) || 1 == static_cast<int>(t));
  91         save_binary(& t, sizeof(t));
  92     }
  93     BOOST_ARCHIVE_OR_WARCHIVE_DECL(void)
  94     save(const std::string &s);
  95     #ifndef BOOST_NO_STD_WSTRING
  96     BOOST_ARCHIVE_OR_WARCHIVE_DECL(void)
  97     save(const std::wstring &ws);
  98     #endif
  99     BOOST_ARCHIVE_OR_WARCHIVE_DECL(void)
 100     save(const char * t);
 101     BOOST_ARCHIVE_OR_WARCHIVE_DECL(void)
 102     save(const wchar_t * t);
 103
 104     BOOST_ARCHIVE_OR_WARCHIVE_DECL(void)
 105     init();
 106
 107     BOOST_ARCHIVE_OR_WARCHIVE_DECL(BOOST_PP_EMPTY())
 108     basic_binary_oprimitive(
 109         std::basic_streambuf<Elem, Tr> & sb,
 110         bool no_codecvt
 111     );
 112     BOOST_ARCHIVE_OR_WARCHIVE_DECL(BOOST_PP_EMPTY())
 113     ~basic_binary_oprimitive();
 114 public:
 115
 116     // we provide an optimized save for all fundamental types
 117     // typedef serialization::is_bitwise_serializable<mpl::_1>
 118     // use_array_optimization;
 119     // workaround without using mpl lambdas
 120     struct use_array_optimization {
 121         template <class T>
 122         #if defined(BOOST_NO_DEPENDENT_NESTED_DERIVATIONS)
 123             struct apply {
 124                 typedef typename boost::serialization::is_bitwise_serializable< T >::type type;
 125             };
 126         #else
 127             struct apply : public boost::serialization::is_bitwise_serializable< T > {};
 128         #endif
 129     };
 130
 131
 132     // the optimized save_array dispatches to save_binary
 133     template <class ValueType>
 134     void save_array(boost::serialization::array<ValueType> const& a, unsigned int)
 135     {
 136       save_binary(a.address(),a.count()*sizeof(ValueType));
 137     }
 138
 139     void save_binary(const void *address, std::size_t count);
 140 };
 141
 142 template<class Archive, class Elem, class Tr>
 143 inline void
 144 basic_binary_oprimitive<Archive, Elem, Tr>::save_binary(
 145     const void *address,
 146     std::size_t count
 147 ){
 148     //BOOST_ASSERT(
 149     //    static_cast<std::size_t>((std::numeric_limits<std::streamsize>::max)()) >= count
 150     //);
 151     // note: if the following assertions fail
 152     // a likely cause is that the output stream is set to "text"
 153     // mode where by cr characters recieve special treatment.
 154     // be sure that the output stream is opened with ios::binary
 155     //if(os.fail())
 156     //    boost::serialization::throw_exception(
 157     //        archive_exception(archive_exception::output_stream_error)
 158     //    );
 159     // figure number of elements to output - round up
 160     count = ( count + sizeof(Elem) - 1)
 161         / sizeof(Elem);
 162     BOOST_ASSERT(count <= std::size_t(boost::integer_traits<std::streamsize>::const_max));
 163     std::streamsize scount = m_sb.sputn(
 164         static_cast<const Elem *>(address),
 165         static_cast<std::streamsize>(count)
 166     );
 167     if(count != static_cast<std::size_t>(scount))
 168         boost::serialization::throw_exception(
 169             archive_exception(archive_exception::output_stream_error)
 170         );
 171     //os.write(
 172     //    static_cast<const typename OStream::char_type *>(address),
 173     //    count
 174     //);
 175     //BOOST_ASSERT(os.good());
 176 }
 177
 178 } //namespace boost
 179 } //namespace archive
 180
 181 #include <boost/archive/detail/abi_suffix.hpp> // pop pragmas
 182
 183 #endif // BOOST_ARCHIVE_BASIC_BINARY_OPRIMITIVE_HPP