1 // Copyright (c) 2009-2010 Satoshi Nakamoto
2 // Copyright (c) 2009-2012 The Bitcoin developers
3 // Copyright (c) 2012 The PPCoin developers
4 // Copyright (c) 2012-2013 The NovaCoin developers
5 // Distributed under the MIT/X11 software license, see the accompanying
6 // file COPYING or http://www.opensource.org/licenses/mit-license.php.
7 #ifndef BITCOIN_SERIALIZE_H
8 #define BITCOIN_SERIALIZE_H
19 #include <boost/type_traits/is_fundamental.hpp>
20 #include <boost/tuple/tuple.hpp>
21 #include <boost/tuple/tuple_comparison.hpp>
22 #include <boost/tuple/tuple_io.hpp>
24 #include "allocators.h"
27 typedef long long int64;
28 typedef unsigned long long uint64;
33 static const unsigned int MAX_SIZE = 0x02000000;
35 // Used to bypass the rule against non-const reference to temporary
36 // where it makes sense with wrappers such as CFlatData or CTxDB
38 inline T& REF(const T& val)
40 return const_cast<T&>(val);
43 /////////////////////////////////////////////////////////////////
45 // Templates for serializing to anything that looks like a stream,
46 // i.e. anything that supports .read(char*, int) and .write(char*, int)
52 SER_NETWORK = (1 << 0),
54 SER_GETHASH = (1 << 2),
57 SER_SKIPSIG = (1 << 16),
58 SER_BLOCKHEADERONLY = (1 << 17),
61 #define IMPLEMENT_SERIALIZE(statements) \
62 unsigned int GetSerializeSize(int nType, int nVersion) const \
64 CSerActionGetSerializeSize ser_action; \
65 const bool fGetSize = true; \
66 const bool fWrite = false; \
67 const bool fRead = false; \
68 unsigned int nSerSize = 0; \
69 ser_streamplaceholder s; \
70 assert(fGetSize||fWrite||fRead); /* suppress warning */ \
72 s.nVersion = nVersion; \
76 template<typename Stream> \
77 void Serialize(Stream& s, int nType, int nVersion) const \
79 CSerActionSerialize ser_action; \
80 const bool fGetSize = false; \
81 const bool fWrite = true; \
82 const bool fRead = false; \
83 unsigned int nSerSize = 0; \
84 assert(fGetSize||fWrite||fRead); /* suppress warning */ \
87 template<typename Stream> \
88 void Unserialize(Stream& s, int nType, int nVersion) \
90 CSerActionUnserialize ser_action; \
91 const bool fGetSize = false; \
92 const bool fWrite = false; \
93 const bool fRead = true; \
94 unsigned int nSerSize = 0; \
95 assert(fGetSize||fWrite||fRead); /* suppress warning */ \
99 #define READWRITE(obj) (nSerSize += ::SerReadWrite(s, (obj), nType, nVersion, ser_action))
109 #define WRITEDATA(s, obj) s.write((char*)&(obj), sizeof(obj))
110 #define READDATA(s, obj) s.read((char*)&(obj), sizeof(obj))
112 inline unsigned int GetSerializeSize(char a, int, int=0) { return sizeof(a); }
113 inline unsigned int GetSerializeSize(signed char a, int, int=0) { return sizeof(a); }
114 inline unsigned int GetSerializeSize(unsigned char a, int, int=0) { return sizeof(a); }
115 inline unsigned int GetSerializeSize(signed short a, int, int=0) { return sizeof(a); }
116 inline unsigned int GetSerializeSize(unsigned short a, int, int=0) { return sizeof(a); }
117 inline unsigned int GetSerializeSize(signed int a, int, int=0) { return sizeof(a); }
118 inline unsigned int GetSerializeSize(unsigned int a, int, int=0) { return sizeof(a); }
119 inline unsigned int GetSerializeSize(signed long a, int, int=0) { return sizeof(a); }
120 inline unsigned int GetSerializeSize(unsigned long a, int, int=0) { return sizeof(a); }
121 inline unsigned int GetSerializeSize(int64 a, int, int=0) { return sizeof(a); }
122 inline unsigned int GetSerializeSize(uint64 a, int, int=0) { return sizeof(a); }
123 inline unsigned int GetSerializeSize(float a, int, int=0) { return sizeof(a); }
124 inline unsigned int GetSerializeSize(double a, int, int=0) { return sizeof(a); }
126 template<typename Stream> inline void Serialize(Stream& s, char a, int, int=0) { WRITEDATA(s, a); }
127 template<typename Stream> inline void Serialize(Stream& s, signed char a, int, int=0) { WRITEDATA(s, a); }
128 template<typename Stream> inline void Serialize(Stream& s, unsigned char a, int, int=0) { WRITEDATA(s, a); }
129 template<typename Stream> inline void Serialize(Stream& s, signed short a, int, int=0) { WRITEDATA(s, a); }
130 template<typename Stream> inline void Serialize(Stream& s, unsigned short a, int, int=0) { WRITEDATA(s, a); }
131 template<typename Stream> inline void Serialize(Stream& s, signed int a, int, int=0) { WRITEDATA(s, a); }
132 template<typename Stream> inline void Serialize(Stream& s, unsigned int a, int, int=0) { WRITEDATA(s, a); }
133 template<typename Stream> inline void Serialize(Stream& s, signed long a, int, int=0) { WRITEDATA(s, a); }
134 template<typename Stream> inline void Serialize(Stream& s, unsigned long a, int, int=0) { WRITEDATA(s, a); }
135 template<typename Stream> inline void Serialize(Stream& s, int64 a, int, int=0) { WRITEDATA(s, a); }
136 template<typename Stream> inline void Serialize(Stream& s, uint64 a, int, int=0) { WRITEDATA(s, a); }
137 template<typename Stream> inline void Serialize(Stream& s, float a, int, int=0) { WRITEDATA(s, a); }
138 template<typename Stream> inline void Serialize(Stream& s, double a, int, int=0) { WRITEDATA(s, a); }
140 template<typename Stream> inline void Unserialize(Stream& s, char& a, int, int=0) { READDATA(s, a); }
141 template<typename Stream> inline void Unserialize(Stream& s, signed char& a, int, int=0) { READDATA(s, a); }
142 template<typename Stream> inline void Unserialize(Stream& s, unsigned char& a, int, int=0) { READDATA(s, a); }
143 template<typename Stream> inline void Unserialize(Stream& s, signed short& a, int, int=0) { READDATA(s, a); }
144 template<typename Stream> inline void Unserialize(Stream& s, unsigned short& a, int, int=0) { READDATA(s, a); }
145 template<typename Stream> inline void Unserialize(Stream& s, signed int& a, int, int=0) { READDATA(s, a); }
146 template<typename Stream> inline void Unserialize(Stream& s, unsigned int& a, int, int=0) { READDATA(s, a); }
147 template<typename Stream> inline void Unserialize(Stream& s, signed long& a, int, int=0) { READDATA(s, a); }
148 template<typename Stream> inline void Unserialize(Stream& s, unsigned long& a, int, int=0) { READDATA(s, a); }
149 template<typename Stream> inline void Unserialize(Stream& s, int64& a, int, int=0) { READDATA(s, a); }
150 template<typename Stream> inline void Unserialize(Stream& s, uint64& a, int, int=0) { READDATA(s, a); }
151 template<typename Stream> inline void Unserialize(Stream& s, float& a, int, int=0) { READDATA(s, a); }
152 template<typename Stream> inline void Unserialize(Stream& s, double& a, int, int=0) { READDATA(s, a); }
154 inline unsigned int GetSerializeSize(bool a, int, int=0) { return sizeof(char); }
155 template<typename Stream> inline void Serialize(Stream& s, bool a, int, int=0) { char f=a; WRITEDATA(s, f); }
156 template<typename Stream> inline void Unserialize(Stream& s, bool& a, int, int=0) { char f; READDATA(s, f); a=f; }
160 #ifndef THROW_WITH_STACKTRACE
161 #define THROW_WITH_STACKTRACE(exception) \
166 void LogStackTrace();
171 // size < 253 -- 1 byte
172 // size <= USHRT_MAX -- 3 bytes (253 + 2 bytes)
173 // size <= UINT_MAX -- 5 bytes (254 + 4 bytes)
174 // size > UINT_MAX -- 9 bytes (255 + 8 bytes)
176 inline unsigned int GetSizeOfCompactSize(uint64 nSize)
178 if (nSize < 253) return sizeof(unsigned char);
179 else if (nSize <= std::numeric_limits<unsigned short>::max()) return sizeof(unsigned char) + sizeof(unsigned short);
180 else if (nSize <= std::numeric_limits<unsigned int>::max()) return sizeof(unsigned char) + sizeof(unsigned int);
181 else return sizeof(unsigned char) + sizeof(uint64);
184 template<typename Stream>
185 void WriteCompactSize(Stream& os, uint64 nSize)
189 unsigned char chSize = nSize;
190 WRITEDATA(os, chSize);
192 else if (nSize <= std::numeric_limits<unsigned short>::max())
194 unsigned char chSize = 253;
195 unsigned short xSize = nSize;
196 WRITEDATA(os, chSize);
197 WRITEDATA(os, xSize);
199 else if (nSize <= std::numeric_limits<unsigned int>::max())
201 unsigned char chSize = 254;
202 unsigned int xSize = nSize;
203 WRITEDATA(os, chSize);
204 WRITEDATA(os, xSize);
208 unsigned char chSize = 255;
209 uint64 xSize = nSize;
210 WRITEDATA(os, chSize);
211 WRITEDATA(os, xSize);
216 template<typename Stream>
217 uint64 ReadCompactSize(Stream& is)
219 unsigned char chSize;
220 READDATA(is, chSize);
226 else if (chSize == 253)
228 unsigned short xSize;
232 else if (chSize == 254)
244 if (nSizeRet > (uint64)MAX_SIZE)
245 THROW_WITH_STACKTRACE(std::ios_base::failure("ReadCompactSize() : size too large"));
251 #define FLATDATA(obj) REF(CFlatData((char*)&(obj), (char*)&(obj) + sizeof(obj)))
253 /** Wrapper for serializing arrays and POD.
254 * There's a clever template way to make arrays serialize normally, but MSVC6 doesn't support it.
262 CFlatData(void* pbeginIn, void* pendIn) : pbegin((char*)pbeginIn), pend((char*)pendIn) { }
263 char* begin() { return pbegin; }
264 const char* begin() const { return pbegin; }
265 char* end() { return pend; }
266 const char* end() const { return pend; }
268 unsigned int GetSerializeSize(int, int=0) const
270 return pend - pbegin;
273 template<typename Stream>
274 void Serialize(Stream& s, int, int=0) const
276 s.write(pbegin, pend - pbegin);
279 template<typename Stream>
280 void Unserialize(Stream& s, int, int=0)
282 s.read(pbegin, pend - pbegin);
287 // Forward declarations
291 template<typename C> unsigned int GetSerializeSize(const std::basic_string<C>& str, int, int=0);
292 template<typename Stream, typename C> void Serialize(Stream& os, const std::basic_string<C>& str, int, int=0);
293 template<typename Stream, typename C> void Unserialize(Stream& is, std::basic_string<C>& str, int, int=0);
296 template<typename T, typename A> unsigned int GetSerializeSize_impl(const std::vector<T, A>& v, int nType, int nVersion, const boost::true_type&);
297 template<typename T, typename A> unsigned int GetSerializeSize_impl(const std::vector<T, A>& v, int nType, int nVersion, const boost::false_type&);
298 template<typename T, typename A> inline unsigned int GetSerializeSize(const std::vector<T, A>& v, int nType, int nVersion);
299 template<typename Stream, typename T, typename A> void Serialize_impl(Stream& os, const std::vector<T, A>& v, int nType, int nVersion, const boost::true_type&);
300 template<typename Stream, typename T, typename A> void Serialize_impl(Stream& os, const std::vector<T, A>& v, int nType, int nVersion, const boost::false_type&);
301 template<typename Stream, typename T, typename A> inline void Serialize(Stream& os, const std::vector<T, A>& v, int nType, int nVersion);
302 template<typename Stream, typename T, typename A> void Unserialize_impl(Stream& is, std::vector<T, A>& v, int nType, int nVersion, const boost::true_type&);
303 template<typename Stream, typename T, typename A> void Unserialize_impl(Stream& is, std::vector<T, A>& v, int nType, int nVersion, const boost::false_type&);
304 template<typename Stream, typename T, typename A> inline void Unserialize(Stream& is, std::vector<T, A>& v, int nType, int nVersion);
306 // others derived from vector
307 extern inline unsigned int GetSerializeSize(const CScript& v, int nType, int nVersion);
308 template<typename Stream> void Serialize(Stream& os, const CScript& v, int nType, int nVersion);
309 template<typename Stream> void Unserialize(Stream& is, CScript& v, int nType, int nVersion);
312 template<typename K, typename T> unsigned int GetSerializeSize(const std::pair<K, T>& item, int nType, int nVersion);
313 template<typename Stream, typename K, typename T> void Serialize(Stream& os, const std::pair<K, T>& item, int nType, int nVersion);
314 template<typename Stream, typename K, typename T> void Unserialize(Stream& is, std::pair<K, T>& item, int nType, int nVersion);
317 template<typename T0, typename T1, typename T2> unsigned int GetSerializeSize(const boost::tuple<T0, T1, T2>& item, int nType, int nVersion);
318 template<typename Stream, typename T0, typename T1, typename T2> void Serialize(Stream& os, const boost::tuple<T0, T1, T2>& item, int nType, int nVersion);
319 template<typename Stream, typename T0, typename T1, typename T2> void Unserialize(Stream& is, boost::tuple<T0, T1, T2>& item, int nType, int nVersion);
322 template<typename T0, typename T1, typename T2, typename T3> unsigned int GetSerializeSize(const boost::tuple<T0, T1, T2, T3>& item, int nType, int nVersion);
323 template<typename Stream, typename T0, typename T1, typename T2, typename T3> void Serialize(Stream& os, const boost::tuple<T0, T1, T2, T3>& item, int nType, int nVersion);
324 template<typename Stream, typename T0, typename T1, typename T2, typename T3> void Unserialize(Stream& is, boost::tuple<T0, T1, T2, T3>& item, int nType, int nVersion);
327 template<typename K, typename T, typename Pred, typename A> unsigned int GetSerializeSize(const std::map<K, T, Pred, A>& m, int nType, int nVersion);
328 template<typename Stream, typename K, typename T, typename Pred, typename A> void Serialize(Stream& os, const std::map<K, T, Pred, A>& m, int nType, int nVersion);
329 template<typename Stream, typename K, typename T, typename Pred, typename A> void Unserialize(Stream& is, std::map<K, T, Pred, A>& m, int nType, int nVersion);
332 template<typename K, typename Pred, typename A> unsigned int GetSerializeSize(const std::set<K, Pred, A>& m, int nType, int nVersion);
333 template<typename Stream, typename K, typename Pred, typename A> void Serialize(Stream& os, const std::set<K, Pred, A>& m, int nType, int nVersion);
334 template<typename Stream, typename K, typename Pred, typename A> void Unserialize(Stream& is, std::set<K, Pred, A>& m, int nType, int nVersion);
341 // If none of the specialized versions above matched, default to calling member function.
342 // "int nType" is changed to "long nType" to keep from getting an ambiguous overload error.
343 // The compiler will only cast int to long if none of the other templates matched.
344 // Thanks to Boost serialization for this idea.
347 inline unsigned int GetSerializeSize(const T& a, long nType, int nVersion)
349 return a.GetSerializeSize((int)nType, nVersion);
352 template<typename Stream, typename T>
353 inline void Serialize(Stream& os, const T& a, long nType, int nVersion)
355 a.Serialize(os, (int)nType, nVersion);
358 template<typename Stream, typename T>
359 inline void Unserialize(Stream& is, T& a, long nType, int nVersion)
361 a.Unserialize(is, (int)nType, nVersion);
372 unsigned int GetSerializeSize(const std::basic_string<C>& str, int, int)
374 return GetSizeOfCompactSize(str.size()) + str.size() * sizeof(str[0]);
377 template<typename Stream, typename C>
378 void Serialize(Stream& os, const std::basic_string<C>& str, int, int)
380 WriteCompactSize(os, str.size());
382 os.write((char*)&str[0], str.size() * sizeof(str[0]));
385 template<typename Stream, typename C>
386 void Unserialize(Stream& is, std::basic_string<C>& str, int, int)
388 unsigned int nSize = ReadCompactSize(is);
391 is.read((char*)&str[0], nSize * sizeof(str[0]));
399 template<typename T, typename A>
400 unsigned int GetSerializeSize_impl(const std::vector<T, A>& v, int nType, int nVersion, const boost::true_type&)
402 return (GetSizeOfCompactSize(v.size()) + v.size() * sizeof(T));
405 template<typename T, typename A>
406 unsigned int GetSerializeSize_impl(const std::vector<T, A>& v, int nType, int nVersion, const boost::false_type&)
408 unsigned int nSize = GetSizeOfCompactSize(v.size());
409 for (typename std::vector<T, A>::const_iterator vi = v.begin(); vi != v.end(); ++vi)
410 nSize += GetSerializeSize((*vi), nType, nVersion);
414 template<typename T, typename A>
415 inline unsigned int GetSerializeSize(const std::vector<T, A>& v, int nType, int nVersion)
417 return GetSerializeSize_impl(v, nType, nVersion, boost::is_fundamental<T>());
421 template<typename Stream, typename T, typename A>
422 void Serialize_impl(Stream& os, const std::vector<T, A>& v, int nType, int nVersion, const boost::true_type&)
424 WriteCompactSize(os, v.size());
426 os.write((char*)&v[0], v.size() * sizeof(T));
429 template<typename Stream, typename T, typename A>
430 void Serialize_impl(Stream& os, const std::vector<T, A>& v, int nType, int nVersion, const boost::false_type&)
432 WriteCompactSize(os, v.size());
433 for (typename std::vector<T, A>::const_iterator vi = v.begin(); vi != v.end(); ++vi)
434 ::Serialize(os, (*vi), nType, nVersion);
437 template<typename Stream, typename T, typename A>
438 inline void Serialize(Stream& os, const std::vector<T, A>& v, int nType, int nVersion)
440 Serialize_impl(os, v, nType, nVersion, boost::is_fundamental<T>());
444 template<typename Stream, typename T, typename A>
445 void Unserialize_impl(Stream& is, std::vector<T, A>& v, int nType, int nVersion, const boost::true_type&)
447 // Limit size per read so bogus size value won't cause out of memory
449 unsigned int nSize = ReadCompactSize(is);
453 unsigned int blk = std::min(nSize - i, (unsigned int)(1 + 4999999 / sizeof(T)));
455 is.read((char*)&v[i], blk * sizeof(T));
460 template<typename Stream, typename T, typename A>
461 void Unserialize_impl(Stream& is, std::vector<T, A>& v, int nType, int nVersion, const boost::false_type&)
464 unsigned int nSize = ReadCompactSize(is);
466 unsigned int nMid = 0;
469 nMid += 5000000 / sizeof(T);
473 for (; i < nMid; i++)
474 Unserialize(is, v[i], nType, nVersion);
478 template<typename Stream, typename T, typename A>
479 inline void Unserialize(Stream& is, std::vector<T, A>& v, int nType, int nVersion)
481 Unserialize_impl(is, v, nType, nVersion, boost::is_fundamental<T>());
487 // others derived from vector
489 inline unsigned int GetSerializeSize(const CScript& v, int nType, int nVersion)
491 return GetSerializeSize((const std::vector<unsigned char>&)v, nType, nVersion);
494 template<typename Stream>
495 void Serialize(Stream& os, const CScript& v, int nType, int nVersion)
497 Serialize(os, (const std::vector<unsigned char>&)v, nType, nVersion);
500 template<typename Stream>
501 void Unserialize(Stream& is, CScript& v, int nType, int nVersion)
503 Unserialize(is, (std::vector<unsigned char>&)v, nType, nVersion);
511 template<typename K, typename T>
512 unsigned int GetSerializeSize(const std::pair<K, T>& item, int nType, int nVersion)
514 return GetSerializeSize(item.first, nType, nVersion) + GetSerializeSize(item.second, nType, nVersion);
517 template<typename Stream, typename K, typename T>
518 void Serialize(Stream& os, const std::pair<K, T>& item, int nType, int nVersion)
520 Serialize(os, item.first, nType, nVersion);
521 Serialize(os, item.second, nType, nVersion);
524 template<typename Stream, typename K, typename T>
525 void Unserialize(Stream& is, std::pair<K, T>& item, int nType, int nVersion)
527 Unserialize(is, item.first, nType, nVersion);
528 Unserialize(is, item.second, nType, nVersion);
536 template<typename T0, typename T1, typename T2>
537 unsigned int GetSerializeSize(const boost::tuple<T0, T1, T2>& item, int nType, int nVersion)
539 unsigned int nSize = 0;
540 nSize += GetSerializeSize(boost::get<0>(item), nType, nVersion);
541 nSize += GetSerializeSize(boost::get<1>(item), nType, nVersion);
542 nSize += GetSerializeSize(boost::get<2>(item), nType, nVersion);
546 template<typename Stream, typename T0, typename T1, typename T2>
547 void Serialize(Stream& os, const boost::tuple<T0, T1, T2>& item, int nType, int nVersion)
549 Serialize(os, boost::get<0>(item), nType, nVersion);
550 Serialize(os, boost::get<1>(item), nType, nVersion);
551 Serialize(os, boost::get<2>(item), nType, nVersion);
554 template<typename Stream, typename T0, typename T1, typename T2>
555 void Unserialize(Stream& is, boost::tuple<T0, T1, T2>& item, int nType, int nVersion)
557 Unserialize(is, boost::get<0>(item), nType, nVersion);
558 Unserialize(is, boost::get<1>(item), nType, nVersion);
559 Unserialize(is, boost::get<2>(item), nType, nVersion);
567 template<typename T0, typename T1, typename T2, typename T3>
568 unsigned int GetSerializeSize(const boost::tuple<T0, T1, T2, T3>& item, int nType, int nVersion)
570 unsigned int nSize = 0;
571 nSize += GetSerializeSize(boost::get<0>(item), nType, nVersion);
572 nSize += GetSerializeSize(boost::get<1>(item), nType, nVersion);
573 nSize += GetSerializeSize(boost::get<2>(item), nType, nVersion);
574 nSize += GetSerializeSize(boost::get<3>(item), nType, nVersion);
578 template<typename Stream, typename T0, typename T1, typename T2, typename T3>
579 void Serialize(Stream& os, const boost::tuple<T0, T1, T2, T3>& item, int nType, int nVersion)
581 Serialize(os, boost::get<0>(item), nType, nVersion);
582 Serialize(os, boost::get<1>(item), nType, nVersion);
583 Serialize(os, boost::get<2>(item), nType, nVersion);
584 Serialize(os, boost::get<3>(item), nType, nVersion);
587 template<typename Stream, typename T0, typename T1, typename T2, typename T3>
588 void Unserialize(Stream& is, boost::tuple<T0, T1, T2, T3>& item, int nType, int nVersion)
590 Unserialize(is, boost::get<0>(item), nType, nVersion);
591 Unserialize(is, boost::get<1>(item), nType, nVersion);
592 Unserialize(is, boost::get<2>(item), nType, nVersion);
593 Unserialize(is, boost::get<3>(item), nType, nVersion);
601 template<typename K, typename T, typename Pred, typename A>
602 unsigned int GetSerializeSize(const std::map<K, T, Pred, A>& m, int nType, int nVersion)
604 unsigned int nSize = GetSizeOfCompactSize(m.size());
605 for (typename std::map<K, T, Pred, A>::const_iterator mi = m.begin(); mi != m.end(); ++mi)
606 nSize += GetSerializeSize((*mi), nType, nVersion);
610 template<typename Stream, typename K, typename T, typename Pred, typename A>
611 void Serialize(Stream& os, const std::map<K, T, Pred, A>& m, int nType, int nVersion)
613 WriteCompactSize(os, m.size());
614 for (typename std::map<K, T, Pred, A>::const_iterator mi = m.begin(); mi != m.end(); ++mi)
615 Serialize(os, (*mi), nType, nVersion);
618 template<typename Stream, typename K, typename T, typename Pred, typename A>
619 void Unserialize(Stream& is, std::map<K, T, Pred, A>& m, int nType, int nVersion)
622 unsigned int nSize = ReadCompactSize(is);
623 typename std::map<K, T, Pred, A>::iterator mi = m.begin();
624 for (unsigned int i = 0; i < nSize; i++)
626 std::pair<K, T> item;
627 Unserialize(is, item, nType, nVersion);
628 mi = m.insert(mi, item);
637 template<typename K, typename Pred, typename A>
638 unsigned int GetSerializeSize(const std::set<K, Pred, A>& m, int nType, int nVersion)
640 unsigned int nSize = GetSizeOfCompactSize(m.size());
641 for (typename std::set<K, Pred, A>::const_iterator it = m.begin(); it != m.end(); ++it)
642 nSize += GetSerializeSize((*it), nType, nVersion);
646 template<typename Stream, typename K, typename Pred, typename A>
647 void Serialize(Stream& os, const std::set<K, Pred, A>& m, int nType, int nVersion)
649 WriteCompactSize(os, m.size());
650 for (typename std::set<K, Pred, A>::const_iterator it = m.begin(); it != m.end(); ++it)
651 Serialize(os, (*it), nType, nVersion);
654 template<typename Stream, typename K, typename Pred, typename A>
655 void Unserialize(Stream& is, std::set<K, Pred, A>& m, int nType, int nVersion)
658 unsigned int nSize = ReadCompactSize(is);
659 typename std::set<K, Pred, A>::iterator it = m.begin();
660 for (unsigned int i = 0; i < nSize; i++)
663 Unserialize(is, key, nType, nVersion);
664 it = m.insert(it, key);
671 // Support for IMPLEMENT_SERIALIZE and READWRITE macro
673 class CSerActionGetSerializeSize { };
674 class CSerActionSerialize { };
675 class CSerActionUnserialize { };
677 template<typename Stream, typename T>
678 inline unsigned int SerReadWrite(Stream& s, const T& obj, int nType, int nVersion, CSerActionGetSerializeSize ser_action)
680 return ::GetSerializeSize(obj, nType, nVersion);
683 template<typename Stream, typename T>
684 inline unsigned int SerReadWrite(Stream& s, const T& obj, int nType, int nVersion, CSerActionSerialize ser_action)
686 ::Serialize(s, obj, nType, nVersion);
690 template<typename Stream, typename T>
691 inline unsigned int SerReadWrite(Stream& s, T& obj, int nType, int nVersion, CSerActionUnserialize ser_action)
693 ::Unserialize(s, obj, nType, nVersion);
697 struct ser_streamplaceholder
714 /** Double ended buffer combining vector and stream-like interfaces.
716 * >> and << read and write unformatted data using the above serialization templates.
717 * Fills with data in linear time; some stringstream implementations take N^2 time.
722 typedef std::vector<char, zero_after_free_allocator<char> > vector_type;
724 unsigned int nReadPos;
731 typedef vector_type::allocator_type allocator_type;
732 typedef vector_type::size_type size_type;
733 typedef vector_type::difference_type difference_type;
734 typedef vector_type::reference reference;
735 typedef vector_type::const_reference const_reference;
736 typedef vector_type::value_type value_type;
737 typedef vector_type::iterator iterator;
738 typedef vector_type::const_iterator const_iterator;
739 typedef vector_type::reverse_iterator reverse_iterator;
741 explicit CDataStream(int nTypeIn, int nVersionIn)
743 Init(nTypeIn, nVersionIn);
746 CDataStream(const_iterator pbegin, const_iterator pend, int nTypeIn, int nVersionIn) : vch(pbegin, pend)
748 Init(nTypeIn, nVersionIn);
751 #if !defined(_MSC_VER) || _MSC_VER >= 1300
752 CDataStream(const char* pbegin, const char* pend, int nTypeIn, int nVersionIn) : vch(pbegin, pend)
754 Init(nTypeIn, nVersionIn);
758 CDataStream(const vector_type& vchIn, int nTypeIn, int nVersionIn) : vch(vchIn.begin(), vchIn.end())
760 Init(nTypeIn, nVersionIn);
763 CDataStream(const std::vector<char>& vchIn, int nTypeIn, int nVersionIn) : vch(vchIn.begin(), vchIn.end())
765 Init(nTypeIn, nVersionIn);
768 CDataStream(const std::vector<unsigned char>& vchIn, int nTypeIn, int nVersionIn) : vch((char*)&vchIn.begin()[0], (char*)&vchIn.end()[0])
770 Init(nTypeIn, nVersionIn);
773 void Init(int nTypeIn, int nVersionIn)
777 nVersion = nVersionIn;
779 exceptmask = std::ios::badbit | std::ios::failbit;
782 CDataStream& operator+=(const CDataStream& b)
784 vch.insert(vch.end(), b.begin(), b.end());
788 friend CDataStream operator+(const CDataStream& a, const CDataStream& b)
795 std::string str() const
797 return (std::string(begin(), end()));
804 const_iterator begin() const { return vch.begin() + nReadPos; }
805 iterator begin() { return vch.begin() + nReadPos; }
806 const_iterator end() const { return vch.end(); }
807 iterator end() { return vch.end(); }
808 size_type size() const { return vch.size() - nReadPos; }
809 bool empty() const { return vch.size() == nReadPos; }
810 void resize(size_type n, value_type c=0) { vch.resize(n + nReadPos, c); }
811 void reserve(size_type n) { vch.reserve(n + nReadPos); }
812 const_reference operator[](size_type pos) const { return vch[pos + nReadPos]; }
813 reference operator[](size_type pos) { return vch[pos + nReadPos]; }
814 void clear() { vch.clear(); nReadPos = 0; }
815 iterator insert(iterator it, const char& x=char()) { return vch.insert(it, x); }
816 void insert(iterator it, size_type n, const char& x) { vch.insert(it, n, x); }
818 void insert(iterator it, const_iterator first, const_iterator last)
820 if (it == vch.begin() + nReadPos && last - first <= nReadPos)
822 // special case for inserting at the front when there's room
823 nReadPos -= (last - first);
824 memcpy(&vch[nReadPos], &first[0], last - first);
827 vch.insert(it, first, last);
830 void insert(iterator it, std::vector<char>::const_iterator first, std::vector<char>::const_iterator last)
832 if (it == vch.begin() + nReadPos && last - first <= nReadPos)
834 // special case for inserting at the front when there's room
835 nReadPos -= (last - first);
836 memcpy(&vch[nReadPos], &first[0], last - first);
839 vch.insert(it, first, last);
842 #if !defined(_MSC_VER) || _MSC_VER >= 1300
843 void insert(iterator it, const char* first, const char* last)
845 if (it == vch.begin() + nReadPos && last - first <= nReadPos)
847 // special case for inserting at the front when there's room
848 nReadPos -= (last - first);
849 memcpy(&vch[nReadPos], &first[0], last - first);
852 vch.insert(it, first, last);
856 iterator erase(iterator it)
858 if (it == vch.begin() + nReadPos)
860 // special case for erasing from the front
861 if (++nReadPos >= vch.size())
863 // whenever we reach the end, we take the opportunity to clear the buffer
865 return vch.erase(vch.begin(), vch.end());
867 return vch.begin() + nReadPos;
870 return vch.erase(it);
873 iterator erase(iterator first, iterator last)
875 if (first == vch.begin() + nReadPos)
877 // special case for erasing from the front
878 if (last == vch.end())
881 return vch.erase(vch.begin(), vch.end());
885 nReadPos = (last - vch.begin());
890 return vch.erase(first, last);
893 inline void Compact()
895 vch.erase(vch.begin(), vch.begin() + nReadPos);
899 bool Rewind(size_type n)
901 // Rewind by n characters if the buffer hasn't been compacted yet
912 void setstate(short bits, const char* psz)
915 if (state & exceptmask)
916 THROW_WITH_STACKTRACE(std::ios_base::failure(psz));
919 bool eof() const { return size() == 0; }
920 bool fail() const { return state & (std::ios::badbit | std::ios::failbit); }
921 bool good() const { return !eof() && (state == 0); }
922 void clear(short n) { state = n; } // name conflict with vector clear()
923 short exceptions() { return exceptmask; }
924 short exceptions(short mask) { short prev = exceptmask; exceptmask = mask; setstate(0, "CDataStream"); return prev; }
925 CDataStream* rdbuf() { return this; }
926 int in_avail() { return size(); }
928 void SetType(int n) { nType = n; }
929 int GetType() { return nType; }
930 void SetVersion(int n) { nVersion = n; }
931 int GetVersion() { return nVersion; }
932 void ReadVersion() { *this >> nVersion; }
933 void WriteVersion() { *this << nVersion; }
935 CDataStream& read(char* pch, int nSize)
937 // Read from the beginning of the buffer
939 unsigned int nReadPosNext = nReadPos + nSize;
940 if (nReadPosNext >= vch.size())
942 if (nReadPosNext > vch.size())
944 setstate(std::ios::failbit, "CDataStream::read() : end of data");
945 memset(pch, 0, nSize);
946 nSize = vch.size() - nReadPos;
948 memcpy(pch, &vch[nReadPos], nSize);
953 memcpy(pch, &vch[nReadPos], nSize);
954 nReadPos = nReadPosNext;
958 CDataStream& ignore(int nSize)
960 // Ignore from the beginning of the buffer
962 unsigned int nReadPosNext = nReadPos + nSize;
963 if (nReadPosNext >= vch.size())
965 if (nReadPosNext > vch.size())
967 setstate(std::ios::failbit, "CDataStream::ignore() : end of data");
968 nSize = vch.size() - nReadPos;
974 nReadPos = nReadPosNext;
978 CDataStream& write(const char* pch, int nSize)
980 // Write to the end of the buffer
982 vch.insert(vch.end(), pch, pch + nSize);
986 template<typename Stream>
987 void Serialize(Stream& s, int nType, int nVersion) const
989 // Special case: stream << stream concatenates like stream += stream
991 s.write((char*)&vch[0], vch.size() * sizeof(vch[0]));
995 unsigned int GetSerializeSize(const T& obj)
997 // Tells the size of the object if serialized to this stream
998 return ::GetSerializeSize(obj, nType, nVersion);
1001 template<typename T>
1002 CDataStream& operator<<(const T& obj)
1004 // Serialize to this stream
1005 ::Serialize(*this, obj, nType, nVersion);
1009 template<typename T>
1010 CDataStream& operator>>(T& obj)
1012 // Unserialize from this stream
1013 ::Unserialize(*this, obj, nType, nVersion);
1018 #ifdef TESTCDATASTREAM
1025 // n=16000 0 seconds
1026 // n=32000 0 seconds
1027 // n=64000 1 seconds
1028 // n=128000 1 seconds
1029 // n=256000 2 seconds
1030 // n=512000 4 seconds
1031 // n=1024000 8 seconds
1032 // n=2048000 16 seconds
1033 // n=4096000 32 seconds
1037 // n=4000 13 seconds
1038 // n=8000 87 seconds
1039 // n=16000 400 seconds
1040 // n=32000 1660 seconds
1041 // n=64000 6749 seconds
1042 // n=128000 27241 seconds
1043 // n=256000 109804 seconds
1045 int main(int argc, char *argv[])
1047 vector<unsigned char> vch(0xcc, 250);
1048 printf("CDataStream:\n");
1049 for (int n = 1000; n <= 4500000; n *= 2)
1052 time_t nStart = time(NULL);
1053 for (int i = 0; i < n; i++)
1054 ss.write((char*)&vch[0], vch.size());
1055 printf("n=%-10d %d seconds\n", n, time(NULL) - nStart);
1057 printf("stringstream:\n");
1058 for (int n = 1000; n <= 4500000; n *= 2)
1061 time_t nStart = time(NULL);
1062 for (int i = 0; i < n; i++)
1063 ss.write((char*)&vch[0], vch.size());
1064 printf("n=%-10d %d seconds\n", n, time(NULL) - nStart);
1078 /** RAII wrapper for FILE*.
1080 * Will automatically close the file when it goes out of scope if not null.
1081 * If you're returning the file pointer, return file.release().
1082 * If you need to close the file early, use file.fclose() instead of fclose(file).
1094 CAutoFile(FILE* filenew, int nTypeIn, int nVersionIn)
1098 nVersion = nVersionIn;
1100 exceptmask = std::ios::badbit | std::ios::failbit;
1110 if (file != NULL && file != stdin && file != stdout && file != stderr)
1115 FILE* release() { FILE* ret = file; file = NULL; return ret; }
1116 operator FILE*() { return file; }
1117 FILE* operator->() { return file; }
1118 FILE& operator*() { return *file; }
1119 FILE** operator&() { return &file; }
1120 FILE* operator=(FILE* pnew) { return file = pnew; }
1121 bool operator!() { return (file == NULL); }
1127 void setstate(short bits, const char* psz)
1130 if (state & exceptmask)
1131 THROW_WITH_STACKTRACE(std::ios_base::failure(psz));
1134 bool fail() const { return state & (std::ios::badbit | std::ios::failbit); }
1135 bool good() const { return state == 0; }
1136 void clear(short n = 0) { state = n; }
1137 short exceptions() { return exceptmask; }
1138 short exceptions(short mask) { short prev = exceptmask; exceptmask = mask; setstate(0, "CAutoFile"); return prev; }
1140 void SetType(int n) { nType = n; }
1141 int GetType() { return nType; }
1142 void SetVersion(int n) { nVersion = n; }
1143 int GetVersion() { return nVersion; }
1144 void ReadVersion() { *this >> nVersion; }
1145 void WriteVersion() { *this << nVersion; }
1147 CAutoFile& read(char* pch, size_t nSize)
1150 throw std::ios_base::failure("CAutoFile::read : file handle is NULL");
1151 if (fread(pch, 1, nSize, file) != nSize)
1152 setstate(std::ios::failbit, feof(file) ? "CAutoFile::read : end of file" : "CAutoFile::read : fread failed");
1156 CAutoFile& write(const char* pch, size_t nSize)
1159 throw std::ios_base::failure("CAutoFile::write : file handle is NULL");
1160 if (fwrite(pch, 1, nSize, file) != nSize)
1161 setstate(std::ios::failbit, "CAutoFile::write : write failed");
1165 template<typename T>
1166 unsigned int GetSerializeSize(const T& obj)
1168 // Tells the size of the object if serialized to this stream
1169 return ::GetSerializeSize(obj, nType, nVersion);
1172 template<typename T>
1173 CAutoFile& operator<<(const T& obj)
1175 // Serialize to this stream
1177 throw std::ios_base::failure("CAutoFile::operator<< : file handle is NULL");
1178 ::Serialize(*this, obj, nType, nVersion);
1182 template<typename T>
1183 CAutoFile& operator>>(T& obj)
1185 // Unserialize from this stream
1187 throw std::ios_base::failure("CAutoFile::operator>> : file handle is NULL");
1188 ::Unserialize(*this, obj, nType, nVersion);