blob: 9283974ff105c904f2e37b9aaba63c6505ba90cc [file] [log] [blame]
Brian Silverman88678712018-08-04 23:56:48 -07001#ifndef BOOST_ARCHIVE_BASIC_ARCHIVE_HPP
2#define BOOST_ARCHIVE_BASIC_ARCHIVE_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_archive.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#include <cstring> // count
19#include <boost/assert.hpp>
20#include <boost/config.hpp>
21#include <boost/cstdint.hpp> // size_t
22#include <boost/noncopyable.hpp>
23#include <boost/integer_traits.hpp>
24
25#include <boost/archive/detail/auto_link_archive.hpp>
26#include <boost/archive/detail/abi_prefix.hpp> // must be the last header
27
28namespace boost {
29namespace archive {
30
31#if defined(_MSC_VER)
32#pragma warning( push )
33#pragma warning( disable : 4244 4267 )
34#endif
35
36/* NOTE : Warning : Warning : Warning : Warning : Warning
37 * Don't ever changes this. If you do, they previously created
38 * binary archives won't be readable !!!
39 */
40class library_version_type {
41private:
42 typedef uint_least16_t base_type;
43 base_type t;
44public:
45 library_version_type(): t(0) {};
46 explicit library_version_type(const unsigned int & t_) : t(t_){
47 BOOST_ASSERT(t_ <= boost::integer_traits<base_type>::const_max);
48 }
49 library_version_type(const library_version_type & t_) :
50 t(t_.t)
51 {}
52 library_version_type & operator=(const library_version_type & rhs){
53 t = rhs.t;
54 return *this;
55 }
56 // used for text output
57 operator base_type () const {
58 return t;
59 }
60 // used for text input
61 operator base_type & (){
62 return t;
63 }
64 bool operator==(const library_version_type & rhs) const {
65 return t == rhs.t;
66 }
67 bool operator<(const library_version_type & rhs) const {
68 return t < rhs.t;
69 }
70};
71
72BOOST_ARCHIVE_DECL library_version_type
73BOOST_ARCHIVE_VERSION();
74
75class version_type {
76private:
77 typedef uint_least32_t base_type;
78 base_type t;
79public:
80 // should be private - but MPI fails if it's not!!!
81 version_type(): t(0) {};
82 explicit version_type(const unsigned int & t_) : t(t_){
83 BOOST_ASSERT(t_ <= boost::integer_traits<base_type>::const_max);
84 }
85 version_type(const version_type & t_) :
86 t(t_.t)
87 {}
88 version_type & operator=(const version_type & rhs){
89 t = rhs.t;
90 return *this;
91 }
92 // used for text output
93 operator base_type () const {
94 return t;
95 }
96 // used for text intput
97 operator base_type & (){
98 return t;
99 }
100 bool operator==(const version_type & rhs) const {
101 return t == rhs.t;
102 }
103 bool operator<(const version_type & rhs) const {
104 return t < rhs.t;
105 }
106};
107
108class class_id_type {
109private:
110 typedef int_least16_t base_type;
111 base_type t;
112public:
113 // should be private - but then can't use BOOST_STRONG_TYPE below
114 class_id_type() : t(0) {};
115 explicit class_id_type(const int t_) : t(t_){
116 BOOST_ASSERT(t_ <= boost::integer_traits<base_type>::const_max);
117 }
118 explicit class_id_type(const std::size_t t_) : t(t_){
119 // BOOST_ASSERT(t_ <= boost::integer_traits<base_type>::const_max);
120 }
121 class_id_type(const class_id_type & t_) :
122 t(t_.t)
123 {}
124 class_id_type & operator=(const class_id_type & rhs){
125 t = rhs.t;
126 return *this;
127 }
128
129 // used for text output
130 operator base_type () const {
131 return t;
132 }
133 // used for text input
134 operator base_type &() {
135 return t;
136 }
137 bool operator==(const class_id_type & rhs) const {
138 return t == rhs.t;
139 }
140 bool operator<(const class_id_type & rhs) const {
141 return t < rhs.t;
142 }
143};
144
145#define NULL_POINTER_TAG boost::archive::class_id_type(-1)
146
147class object_id_type {
148private:
149 typedef uint_least32_t base_type;
150 base_type t;
151public:
152 object_id_type(): t(0) {};
153 // note: presumes that size_t >= unsigned int.
154 // use explicit cast to silence useless warning
155 explicit object_id_type(const std::size_t & t_) : t(static_cast<base_type>(t_)){
156 // make quadriple sure that we haven't lost any real integer
157 // precision
158 BOOST_ASSERT(t_ <= boost::integer_traits<base_type>::const_max);
159 }
160 object_id_type(const object_id_type & t_) :
161 t(t_.t)
162 {}
163 object_id_type & operator=(const object_id_type & rhs){
164 t = rhs.t;
165 return *this;
166 }
167 // used for text output
168 operator base_type () const {
169 return t;
170 }
171 // used for text input
172 operator base_type & () {
173 return t;
174 }
175 bool operator==(const object_id_type & rhs) const {
176 return t == rhs.t;
177 }
178 bool operator<(const object_id_type & rhs) const {
179 return t < rhs.t;
180 }
181};
182
183#if defined(_MSC_VER)
184#pragma warning( pop )
185#endif
186
187struct tracking_type {
188 bool t;
189 explicit tracking_type(const bool t_ = false)
190 : t(t_)
191 {};
192 tracking_type(const tracking_type & t_)
193 : t(t_.t)
194 {}
195 operator bool () const {
196 return t;
197 };
198 operator bool & () {
199 return t;
200 };
201 tracking_type & operator=(const bool t_){
202 t = t_;
203 return *this;
204 }
205 bool operator==(const tracking_type & rhs) const {
206 return t == rhs.t;
207 }
208 bool operator==(const bool & rhs) const {
209 return t == rhs;
210 }
211 tracking_type & operator=(const tracking_type & rhs){
212 t = rhs.t;
213 return *this;
214 }
215};
216
217struct class_name_type :
218 private boost::noncopyable
219{
220 char *t;
221 operator const char * & () const {
222 return const_cast<const char * &>(t);
223 }
224 operator char * () {
225 return t;
226 }
227 std::size_t size() const {
228 return std::strlen(t);
229 }
230 explicit class_name_type(const char *key_)
231 : t(const_cast<char *>(key_)){}
232 explicit class_name_type(char *key_)
233 : t(key_){}
234 class_name_type & operator=(const class_name_type & rhs){
235 t = rhs.t;
236 return *this;
237 }
238};
239
240enum archive_flags {
241 no_header = 1, // suppress archive header info
242 no_codecvt = 2, // suppress alteration of codecvt facet
243 no_xml_tag_checking = 4, // suppress checking of xml tags
244 no_tracking = 8, // suppress ALL tracking
245 flags_last = 8
246};
247
248BOOST_ARCHIVE_DECL const char *
249BOOST_ARCHIVE_SIGNATURE();
250
251/* NOTE : Warning : Warning : Warning : Warning : Warning
252 * If any of these are changed to different sized types,
253 * binary_iarchive won't be able to read older archives
254 * unless you rev the library version and include conditional
255 * code based on the library version. There is nothing
256 * inherently wrong in doing this - but you have to be super
257 * careful because it's easy to get wrong and start breaking
258 * old archives !!!
259 */
260
261#define BOOST_ARCHIVE_STRONG_TYPEDEF(T, D) \
262 class D : public T { \
263 public: \
264 explicit D(const T tt) : T(tt){} \
265 }; \
266/**/
267
268BOOST_ARCHIVE_STRONG_TYPEDEF(class_id_type, class_id_reference_type)
269BOOST_ARCHIVE_STRONG_TYPEDEF(class_id_type, class_id_optional_type)
270BOOST_ARCHIVE_STRONG_TYPEDEF(object_id_type, object_reference_type)
271
272}// namespace archive
273}// namespace boost
274
275#include <boost/archive/detail/abi_suffix.hpp> // pops abi_suffix.hpp pragmas
276
277#include <boost/serialization/level.hpp>
278
279// set implementation level to primitive for all types
280// used internally by the serialization library
281
282BOOST_CLASS_IMPLEMENTATION(boost::archive::library_version_type, primitive_type)
283BOOST_CLASS_IMPLEMENTATION(boost::archive::version_type, primitive_type)
284BOOST_CLASS_IMPLEMENTATION(boost::archive::class_id_type, primitive_type)
285BOOST_CLASS_IMPLEMENTATION(boost::archive::class_id_reference_type, primitive_type)
286BOOST_CLASS_IMPLEMENTATION(boost::archive::class_id_optional_type, primitive_type)
287BOOST_CLASS_IMPLEMENTATION(boost::archive::class_name_type, primitive_type)
288BOOST_CLASS_IMPLEMENTATION(boost::archive::object_id_type, primitive_type)
289BOOST_CLASS_IMPLEMENTATION(boost::archive::object_reference_type, primitive_type)
290BOOST_CLASS_IMPLEMENTATION(boost::archive::tracking_type, primitive_type)
291
292#include <boost/serialization/is_bitwise_serializable.hpp>
293
294// set types used internally by the serialization library
295// to be bitwise serializable
296
297BOOST_IS_BITWISE_SERIALIZABLE(boost::archive::library_version_type)
298BOOST_IS_BITWISE_SERIALIZABLE(boost::archive::version_type)
299BOOST_IS_BITWISE_SERIALIZABLE(boost::archive::class_id_type)
300BOOST_IS_BITWISE_SERIALIZABLE(boost::archive::class_id_reference_type)
301BOOST_IS_BITWISE_SERIALIZABLE(boost::archive::class_id_optional_type)
302BOOST_IS_BITWISE_SERIALIZABLE(boost::archive::class_name_type)
303BOOST_IS_BITWISE_SERIALIZABLE(boost::archive::object_id_type)
304BOOST_IS_BITWISE_SERIALIZABLE(boost::archive::object_reference_type)
305BOOST_IS_BITWISE_SERIALIZABLE(boost::archive::tracking_type)
306
307#endif //BOOST_ARCHIVE_BASIC_ARCHIVE_HPP