1 // Copyright (c) 2009-2010 Satoshi Nakamoto
2 // Copyright (c) 2009-2012 The Bitcoin developers
3 // Distributed under the MIT/X11 software license, see the accompanying
4 // file COPYING or http://www.opensource.org/licenses/mit-license.php.
5 #ifndef BITCOIN_SERIALIZE_H
6 #define BITCOIN_SERIALIZE_H
17 #include <boost/type_traits/is_fundamental.hpp>
18 #include <boost/tuple/tuple.hpp>
19 #include <boost/tuple/tuple_comparison.hpp>
20 #include <boost/tuple/tuple_io.hpp>
22 #include "allocators.h"
25 typedef long long int64;
26 typedef unsigned long long uint64;
31 static const unsigned int MAX_SIZE = 0x02000000;
33 // Used to bypass the rule against non-const reference to temporary
34 // where it makes sense with wrappers such as CFlatData or CTxDB
36 inline T& REF(const T& val)
38 return const_cast<T&>(val);
41 /////////////////////////////////////////////////////////////////
43 // Templates for serializing to anything that looks like a stream,
44 // i.e. anything that supports .read(char*, int) and .write(char*, int)
50 SER_NETWORK = (1 << 0),
52 SER_GETHASH = (1 << 2),
55 SER_SKIPSIG = (1 << 16),
56 SER_BLOCKHEADERONLY = (1 << 17),
59 #define IMPLEMENT_SERIALIZE(statements) \
60 unsigned int GetSerializeSize(int nType, int nVersion) const \
62 CSerActionGetSerializeSize ser_action; \
63 const bool fGetSize = true; \
64 const bool fWrite = false; \
65 const bool fRead = false; \
66 unsigned int nSerSize = 0; \
67 ser_streamplaceholder s; \
68 assert(fGetSize||fWrite||fRead); /* suppress warning */ \
70 s.nVersion = nVersion; \
74 template<typename Stream> \
75 void Serialize(Stream& s, int nType, int nVersion) const \
77 CSerActionSerialize ser_action; \
78 const bool fGetSize = false; \
79 const bool fWrite = true; \
80 const bool fRead = false; \
81 unsigned int nSerSize = 0; \
82 assert(fGetSize||fWrite||fRead); /* suppress warning */ \
85 template<typename Stream> \
86 void Unserialize(Stream& s, int nType, int nVersion) \
88 CSerActionUnserialize ser_action; \
89 const bool fGetSize = false; \
90 const bool fWrite = false; \
91 const bool fRead = true; \
92 unsigned int nSerSize = 0; \
93 assert(fGetSize||fWrite||fRead); /* suppress warning */ \
97 #define READWRITE(obj) (nSerSize += ::SerReadWrite(s, (obj), nType, nVersion, ser_action))
107 #define WRITEDATA(s, obj) s.write((char*)&(obj), sizeof(obj))
108 #define READDATA(s, obj) s.read((char*)&(obj), sizeof(obj))
110 inline unsigned int GetSerializeSize(char a, int, int=0) { return sizeof(a); }
111 inline unsigned int GetSerializeSize(signed char a, int, int=0) { return sizeof(a); }
112 inline unsigned int GetSerializeSize(unsigned char a, int, int=0) { return sizeof(a); }
113 inline unsigned int GetSerializeSize(signed short a, int, int=0) { return sizeof(a); }
114 inline unsigned int GetSerializeSize(unsigned short a, int, int=0) { return sizeof(a); }
115 inline unsigned int GetSerializeSize(signed int a, int, int=0) { return sizeof(a); }
116 inline unsigned int GetSerializeSize(unsigned int a, int, int=0) { return sizeof(a); }
117 inline unsigned int GetSerializeSize(signed long a, int, int=0) { return sizeof(a); }
118 inline unsigned int GetSerializeSize(unsigned long a, int, int=0) { return sizeof(a); }
119 inline unsigned int GetSerializeSize(int64 a, int, int=0) { return sizeof(a); }
120 inline unsigned int GetSerializeSize(uint64 a, int, int=0) { return sizeof(a); }
121 inline unsigned int GetSerializeSize(float a, int, int=0) { return sizeof(a); }
122 inline unsigned int GetSerializeSize(double a, int, int=0) { return sizeof(a); }
124 template<typename Stream> inline void Serialize(Stream& s, char a, int, int=0) { WRITEDATA(s, a); }
125 template<typename Stream> inline void Serialize(Stream& s, signed char a, int, int=0) { WRITEDATA(s, a); }
126 template<typename Stream> inline void Serialize(Stream& s, unsigned char a, int, int=0) { WRITEDATA(s, a); }
127 template<typename Stream> inline void Serialize(Stream& s, signed short a, int, int=0) { WRITEDATA(s, a); }
128 template<typename Stream> inline void Serialize(Stream& s, unsigned short a, int, int=0) { WRITEDATA(s, a); }
129 template<typename Stream> inline void Serialize(Stream& s, signed int a, int, int=0) { WRITEDATA(s, a); }
130 template<typename Stream> inline void Serialize(Stream& s, unsigned int a, int, int=0) { WRITEDATA(s, a); }
131 template<typename Stream> inline void Serialize(Stream& s, signed long a, int, int=0) { WRITEDATA(s, a); }
132 template<typename Stream> inline void Serialize(Stream& s, unsigned long a, int, int=0) { WRITEDATA(s, a); }
133 template<typename Stream> inline void Serialize(Stream& s, int64 a, int, int=0) { WRITEDATA(s, a); }
134 template<typename Stream> inline void Serialize(Stream& s, uint64 a, int, int=0) { WRITEDATA(s, a); }
135 template<typename Stream> inline void Serialize(Stream& s, float a, int, int=0) { WRITEDATA(s, a); }
136 template<typename Stream> inline void Serialize(Stream& s, double a, int, int=0) { WRITEDATA(s, a); }
138 template<typename Stream> inline void Unserialize(Stream& s, char& a, int, int=0) { READDATA(s, a); }
139 template<typename Stream> inline void Unserialize(Stream& s, signed char& a, int, int=0) { READDATA(s, a); }
140 template<typename Stream> inline void Unserialize(Stream& s, unsigned char& a, int, int=0) { READDATA(s, a); }
141 template<typename Stream> inline void Unserialize(Stream& s, signed short& a, int, int=0) { READDATA(s, a); }
142 template<typename Stream> inline void Unserialize(Stream& s, unsigned short& a, int, int=0) { READDATA(s, a); }
143 template<typename Stream> inline void Unserialize(Stream& s, signed int& a, int, int=0) { READDATA(s, a); }
144 template<typename Stream> inline void Unserialize(Stream& s, unsigned int& a, int, int=0) { READDATA(s, a); }
145 template<typename Stream> inline void Unserialize(Stream& s, signed long& a, int, int=0) { READDATA(s, a); }
146 template<typename Stream> inline void Unserialize(Stream& s, unsigned long& a, int, int=0) { READDATA(s, a); }
147 template<typename Stream> inline void Unserialize(Stream& s, int64& a, int, int=0) { READDATA(s, a); }
148 template<typename Stream> inline void Unserialize(Stream& s, uint64& a, int, int=0) { READDATA(s, a); }
149 template<typename Stream> inline void Unserialize(Stream& s, float& a, int, int=0) { READDATA(s, a); }
150 template<typename Stream> inline void Unserialize(Stream& s, double& a, int, int=0) { READDATA(s, a); }
152 inline unsigned int GetSerializeSize(bool a, int, int=0) { return sizeof(char); }
153 template<typename Stream> inline void Serialize(Stream& s, bool a, int, int=0) { char f=a; WRITEDATA(s, f); }
154 template<typename Stream> inline void Unserialize(Stream& s, bool& a, int, int=0) { char f; READDATA(s, f); a=f; }
157 #ifndef THROW_WITH_STACKTRACE
158 #define THROW_WITH_STACKTRACE(exception) \
163 void LogStackTrace();
168 // size < 253 -- 1 byte
169 // size <= USHRT_MAX -- 3 bytes (253 + 2 bytes)
170 // size <= UINT_MAX -- 5 bytes (254 + 4 bytes)
171 // size > UINT_MAX -- 9 bytes (255 + 8 bytes)
173 inline unsigned int GetSizeOfCompactSize(uint64 nSize)
175 if (nSize < 253) return sizeof(unsigned char);
176 else if (nSize <= std::numeric_limits<unsigned short>::max()) return sizeof(unsigned char) + sizeof(unsigned short);
177 else if (nSize <= std::numeric_limits<unsigned int>::max()) return sizeof(unsigned char) + sizeof(unsigned int);
178 else return sizeof(unsigned char) + sizeof(uint64);
181 template<typename Stream>
182 void WriteCompactSize(Stream& os, uint64 nSize)
186 unsigned char chSize = nSize;
187 WRITEDATA(os, chSize);
189 else if (nSize <= std::numeric_limits<unsigned short>::max())
191 unsigned char chSize = 253;
192 unsigned short xSize = nSize;
193 WRITEDATA(os, chSize);
194 WRITEDATA(os, xSize);
196 else if (nSize <= std::numeric_limits<unsigned int>::max())
198 unsigned char chSize = 254;
199 unsigned int xSize = nSize;
200 WRITEDATA(os, chSize);
201 WRITEDATA(os, xSize);
205 unsigned char chSize = 255;
206 uint64 xSize = nSize;
207 WRITEDATA(os, chSize);
208 WRITEDATA(os, xSize);
213 template<typename Stream>
214 uint64 ReadCompactSize(Stream& is)
216 unsigned char chSize;
217 READDATA(is, chSize);
223 else if (chSize == 253)
225 unsigned short xSize;
229 else if (chSize == 254)
241 if (nSizeRet > (uint64)MAX_SIZE)
242 THROW_WITH_STACKTRACE(std::ios_base::failure("ReadCompactSize() : size too large"));
247 // Variable-length integers: bytes are a MSB base-128 encoding of the number.
248 // The high bit in each byte signifies whether another digit follows. To make
249 // the encoding is one-to-one, one is subtracted from all but the last digit.
250 // Thus, the byte sequence a[] with length len, where all but the last byte
251 // has bit 128 set, encodes the number:
253 // (a[len-1] & 0x7F) + sum(i=1..len-1, 128^i*((a[len-i-1] & 0x7F)+1))
256 // * Very small (0-127: 1 byte, 128-16511: 2 bytes, 16512-2113663: 3 bytes)
257 // * Every integer has exactly one encoding
258 // * Encoding does not depend on size of original integer type
259 // * No redundancy: every (infinite) byte sequence corresponds to a list
260 // of encoded integers.
262 // 0: [0x00] 256: [0x81 0x00]
263 // 1: [0x01] 16383: [0xFE 0x7F]
264 // 127: [0x7F] 16384: [0xFF 0x00]
265 // 128: [0x80 0x00] 16511: [0x80 0xFF 0x7F]
266 // 255: [0x80 0x7F] 65535: [0x82 0xFD 0x7F]
267 // 2^32: [0x8E 0xFE 0xFE 0xFF 0x00]
270 inline unsigned int GetSizeOfVarInt(I n)
282 template<typename Stream, typename I>
283 void WriteVarInt(Stream& os, I n)
285 unsigned char tmp[(sizeof(n)*8+6)/7];
288 tmp[len] = (n & 0x7F) | (len ? 0x80 : 0x00);
295 WRITEDATA(os, tmp[len]);
299 template<typename Stream, typename I>
300 I ReadVarInt(Stream& is)
304 unsigned char chData;
305 READDATA(is, chData);
306 n = (n << 7) | (chData & 0x7F);
315 #define FLATDATA(obj) REF(CFlatData((char*)&(obj), (char*)&(obj) + sizeof(obj)))
316 #define VARINT(obj) REF(WrapVarInt(REF(obj)))
318 /** Wrapper for serializing arrays and POD.
326 CFlatData(void* pbeginIn, void* pendIn) : pbegin((char*)pbeginIn), pend((char*)pendIn) { }
327 char* begin() { return pbegin; }
328 const char* begin() const { return pbegin; }
329 char* end() { return pend; }
330 const char* end() const { return pend; }
332 unsigned int GetSerializeSize(int, int=0) const
334 return pend - pbegin;
337 template<typename Stream>
338 void Serialize(Stream& s, int, int=0) const
340 s.write(pbegin, pend - pbegin);
343 template<typename Stream>
344 void Unserialize(Stream& s, int, int=0)
346 s.read(pbegin, pend - pbegin);
356 CVarInt(I& nIn) : n(nIn) { }
358 unsigned int GetSerializeSize(int, int) const {
359 return GetSizeOfVarInt<I>(n);
362 template<typename Stream>
363 void Serialize(Stream &s, int, int) const {
364 WriteVarInt<Stream,I>(s, n);
367 template<typename Stream>
368 void Unserialize(Stream& s, int, int) {
369 n = ReadVarInt<Stream,I>(s);
374 CVarInt<I> WrapVarInt(I& n) { return CVarInt<I>(n); }
377 // Forward declarations
381 template<typename C> unsigned int GetSerializeSize(const std::basic_string<C>& str, int, int=0);
382 template<typename Stream, typename C> void Serialize(Stream& os, const std::basic_string<C>& str, int, int=0);
383 template<typename Stream, typename C> void Unserialize(Stream& is, std::basic_string<C>& str, int, int=0);
386 template<typename T, typename A> unsigned int GetSerializeSize_impl(const std::vector<T, A>& v, int nType, int nVersion, const boost::true_type&);
387 template<typename T, typename A> unsigned int GetSerializeSize_impl(const std::vector<T, A>& v, int nType, int nVersion, const boost::false_type&);
388 template<typename T, typename A> inline unsigned int GetSerializeSize(const std::vector<T, A>& v, int nType, int nVersion);
389 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&);
390 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&);
391 template<typename Stream, typename T, typename A> inline void Serialize(Stream& os, const std::vector<T, A>& v, int nType, int nVersion);
392 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&);
393 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&);
394 template<typename Stream, typename T, typename A> inline void Unserialize(Stream& is, std::vector<T, A>& v, int nType, int nVersion);
396 // others derived from vector
397 extern inline unsigned int GetSerializeSize(const CScript& v, int nType, int nVersion);
398 template<typename Stream> void Serialize(Stream& os, const CScript& v, int nType, int nVersion);
399 template<typename Stream> void Unserialize(Stream& is, CScript& v, int nType, int nVersion);
402 template<typename K, typename T> unsigned int GetSerializeSize(const std::pair<K, T>& item, int nType, int nVersion);
403 template<typename Stream, typename K, typename T> void Serialize(Stream& os, const std::pair<K, T>& item, int nType, int nVersion);
404 template<typename Stream, typename K, typename T> void Unserialize(Stream& is, std::pair<K, T>& item, int nType, int nVersion);
407 template<typename T0, typename T1, typename T2> unsigned int GetSerializeSize(const boost::tuple<T0, T1, T2>& item, int nType, int nVersion);
408 template<typename Stream, typename T0, typename T1, typename T2> void Serialize(Stream& os, const boost::tuple<T0, T1, T2>& item, int nType, int nVersion);
409 template<typename Stream, typename T0, typename T1, typename T2> void Unserialize(Stream& is, boost::tuple<T0, T1, T2>& item, int nType, int nVersion);
412 template<typename T0, typename T1, typename T2, typename T3> unsigned int GetSerializeSize(const boost::tuple<T0, T1, T2, T3>& item, int nType, int nVersion);
413 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);
414 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);
417 template<typename K, typename T, typename Pred, typename A> unsigned int GetSerializeSize(const std::map<K, T, Pred, A>& m, int nType, int nVersion);
418 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);
419 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);
422 template<typename K, typename Pred, typename A> unsigned int GetSerializeSize(const std::set<K, Pred, A>& m, int nType, int nVersion);
423 template<typename Stream, typename K, typename Pred, typename A> void Serialize(Stream& os, const std::set<K, Pred, A>& m, int nType, int nVersion);
424 template<typename Stream, typename K, typename Pred, typename A> void Unserialize(Stream& is, std::set<K, Pred, A>& m, int nType, int nVersion);
431 // If none of the specialized versions above matched, default to calling member function.
432 // "int nType" is changed to "long nType" to keep from getting an ambiguous overload error.
433 // The compiler will only cast int to long if none of the other templates matched.
434 // Thanks to Boost serialization for this idea.
437 inline unsigned int GetSerializeSize(const T& a, long nType, int nVersion)
439 return a.GetSerializeSize((int)nType, nVersion);
442 template<typename Stream, typename T>
443 inline void Serialize(Stream& os, const T& a, long nType, int nVersion)
445 a.Serialize(os, (int)nType, nVersion);
448 template<typename Stream, typename T>
449 inline void Unserialize(Stream& is, T& a, long nType, int nVersion)
451 a.Unserialize(is, (int)nType, nVersion);
462 unsigned int GetSerializeSize(const std::basic_string<C>& str, int, int)
464 return GetSizeOfCompactSize(str.size()) + str.size() * sizeof(str[0]);
467 template<typename Stream, typename C>
468 void Serialize(Stream& os, const std::basic_string<C>& str, int, int)
470 WriteCompactSize(os, str.size());
472 os.write((char*)&str[0], str.size() * sizeof(str[0]));
475 template<typename Stream, typename C>
476 void Unserialize(Stream& is, std::basic_string<C>& str, int, int)
478 unsigned int nSize = ReadCompactSize(is);
481 is.read((char*)&str[0], nSize * sizeof(str[0]));
489 template<typename T, typename A>
490 unsigned int GetSerializeSize_impl(const std::vector<T, A>& v, int nType, int nVersion, const boost::true_type&)
492 return (GetSizeOfCompactSize(v.size()) + v.size() * sizeof(T));
495 template<typename T, typename A>
496 unsigned int GetSerializeSize_impl(const std::vector<T, A>& v, int nType, int nVersion, const boost::false_type&)
498 unsigned int nSize = GetSizeOfCompactSize(v.size());
499 for (typename std::vector<T, A>::const_iterator vi = v.begin(); vi != v.end(); ++vi)
500 nSize += GetSerializeSize((*vi), nType, nVersion);
504 template<typename T, typename A>
505 inline unsigned int GetSerializeSize(const std::vector<T, A>& v, int nType, int nVersion)
507 return GetSerializeSize_impl(v, nType, nVersion, boost::is_fundamental<T>());
511 template<typename Stream, typename T, typename A>
512 void Serialize_impl(Stream& os, const std::vector<T, A>& v, int nType, int nVersion, const boost::true_type&)
514 WriteCompactSize(os, v.size());
516 os.write((char*)&v[0], v.size() * sizeof(T));
519 template<typename Stream, typename T, typename A>
520 void Serialize_impl(Stream& os, const std::vector<T, A>& v, int nType, int nVersion, const boost::false_type&)
522 WriteCompactSize(os, v.size());
523 for (typename std::vector<T, A>::const_iterator vi = v.begin(); vi != v.end(); ++vi)
524 ::Serialize(os, (*vi), nType, nVersion);
527 template<typename Stream, typename T, typename A>
528 inline void Serialize(Stream& os, const std::vector<T, A>& v, int nType, int nVersion)
530 Serialize_impl(os, v, nType, nVersion, boost::is_fundamental<T>());
534 template<typename Stream, typename T, typename A>
535 void Unserialize_impl(Stream& is, std::vector<T, A>& v, int nType, int nVersion, const boost::true_type&)
537 // Limit size per read so bogus size value won't cause out of memory
539 unsigned int nSize = ReadCompactSize(is);
543 unsigned int blk = std::min(nSize - i, (unsigned int)(1 + 4999999 / sizeof(T)));
545 is.read((char*)&v[i], blk * sizeof(T));
550 template<typename Stream, typename T, typename A>
551 void Unserialize_impl(Stream& is, std::vector<T, A>& v, int nType, int nVersion, const boost::false_type&)
554 unsigned int nSize = ReadCompactSize(is);
556 unsigned int nMid = 0;
559 nMid += 5000000 / sizeof(T);
563 for (; i < nMid; i++)
564 Unserialize(is, v[i], nType, nVersion);
568 template<typename Stream, typename T, typename A>
569 inline void Unserialize(Stream& is, std::vector<T, A>& v, int nType, int nVersion)
571 Unserialize_impl(is, v, nType, nVersion, boost::is_fundamental<T>());
577 // others derived from vector
579 inline unsigned int GetSerializeSize(const CScript& v, int nType, int nVersion)
581 return GetSerializeSize((const std::vector<unsigned char>&)v, nType, nVersion);
584 template<typename Stream>
585 void Serialize(Stream& os, const CScript& v, int nType, int nVersion)
587 Serialize(os, (const std::vector<unsigned char>&)v, nType, nVersion);
590 template<typename Stream>
591 void Unserialize(Stream& is, CScript& v, int nType, int nVersion)
593 Unserialize(is, (std::vector<unsigned char>&)v, nType, nVersion);
601 template<typename K, typename T>
602 unsigned int GetSerializeSize(const std::pair<K, T>& item, int nType, int nVersion)
604 return GetSerializeSize(item.first, nType, nVersion) + GetSerializeSize(item.second, nType, nVersion);
607 template<typename Stream, typename K, typename T>
608 void Serialize(Stream& os, const std::pair<K, T>& item, int nType, int nVersion)
610 Serialize(os, item.first, nType, nVersion);
611 Serialize(os, item.second, nType, nVersion);
614 template<typename Stream, typename K, typename T>
615 void Unserialize(Stream& is, std::pair<K, T>& item, int nType, int nVersion)
617 Unserialize(is, item.first, nType, nVersion);
618 Unserialize(is, item.second, nType, nVersion);
626 template<typename T0, typename T1, typename T2>
627 unsigned int GetSerializeSize(const boost::tuple<T0, T1, T2>& item, int nType, int nVersion)
629 unsigned int nSize = 0;
630 nSize += GetSerializeSize(boost::get<0>(item), nType, nVersion);
631 nSize += GetSerializeSize(boost::get<1>(item), nType, nVersion);
632 nSize += GetSerializeSize(boost::get<2>(item), nType, nVersion);
636 template<typename Stream, typename T0, typename T1, typename T2>
637 void Serialize(Stream& os, const boost::tuple<T0, T1, T2>& item, int nType, int nVersion)
639 Serialize(os, boost::get<0>(item), nType, nVersion);
640 Serialize(os, boost::get<1>(item), nType, nVersion);
641 Serialize(os, boost::get<2>(item), nType, nVersion);
644 template<typename Stream, typename T0, typename T1, typename T2>
645 void Unserialize(Stream& is, boost::tuple<T0, T1, T2>& item, int nType, int nVersion)
647 Unserialize(is, boost::get<0>(item), nType, nVersion);
648 Unserialize(is, boost::get<1>(item), nType, nVersion);
649 Unserialize(is, boost::get<2>(item), nType, nVersion);
657 template<typename T0, typename T1, typename T2, typename T3>
658 unsigned int GetSerializeSize(const boost::tuple<T0, T1, T2, T3>& item, int nType, int nVersion)
660 unsigned int nSize = 0;
661 nSize += GetSerializeSize(boost::get<0>(item), nType, nVersion);
662 nSize += GetSerializeSize(boost::get<1>(item), nType, nVersion);
663 nSize += GetSerializeSize(boost::get<2>(item), nType, nVersion);
664 nSize += GetSerializeSize(boost::get<3>(item), nType, nVersion);
668 template<typename Stream, typename T0, typename T1, typename T2, typename T3>
669 void Serialize(Stream& os, const boost::tuple<T0, T1, T2, T3>& item, int nType, int nVersion)
671 Serialize(os, boost::get<0>(item), nType, nVersion);
672 Serialize(os, boost::get<1>(item), nType, nVersion);
673 Serialize(os, boost::get<2>(item), nType, nVersion);
674 Serialize(os, boost::get<3>(item), nType, nVersion);
677 template<typename Stream, typename T0, typename T1, typename T2, typename T3>
678 void Unserialize(Stream& is, boost::tuple<T0, T1, T2, T3>& item, int nType, int nVersion)
680 Unserialize(is, boost::get<0>(item), nType, nVersion);
681 Unserialize(is, boost::get<1>(item), nType, nVersion);
682 Unserialize(is, boost::get<2>(item), nType, nVersion);
683 Unserialize(is, boost::get<3>(item), nType, nVersion);
691 template<typename K, typename T, typename Pred, typename A>
692 unsigned int GetSerializeSize(const std::map<K, T, Pred, A>& m, int nType, int nVersion)
694 unsigned int nSize = GetSizeOfCompactSize(m.size());
695 for (typename std::map<K, T, Pred, A>::const_iterator mi = m.begin(); mi != m.end(); ++mi)
696 nSize += GetSerializeSize((*mi), nType, nVersion);
700 template<typename Stream, typename K, typename T, typename Pred, typename A>
701 void Serialize(Stream& os, const std::map<K, T, Pred, A>& m, int nType, int nVersion)
703 WriteCompactSize(os, m.size());
704 for (typename std::map<K, T, Pred, A>::const_iterator mi = m.begin(); mi != m.end(); ++mi)
705 Serialize(os, (*mi), nType, nVersion);
708 template<typename Stream, typename K, typename T, typename Pred, typename A>
709 void Unserialize(Stream& is, std::map<K, T, Pred, A>& m, int nType, int nVersion)
712 unsigned int nSize = ReadCompactSize(is);
713 typename std::map<K, T, Pred, A>::iterator mi = m.begin();
714 for (unsigned int i = 0; i < nSize; i++)
716 std::pair<K, T> item;
717 Unserialize(is, item, nType, nVersion);
718 mi = m.insert(mi, item);
727 template<typename K, typename Pred, typename A>
728 unsigned int GetSerializeSize(const std::set<K, Pred, A>& m, int nType, int nVersion)
730 unsigned int nSize = GetSizeOfCompactSize(m.size());
731 for (typename std::set<K, Pred, A>::const_iterator it = m.begin(); it != m.end(); ++it)
732 nSize += GetSerializeSize((*it), nType, nVersion);
736 template<typename Stream, typename K, typename Pred, typename A>
737 void Serialize(Stream& os, const std::set<K, Pred, A>& m, int nType, int nVersion)
739 WriteCompactSize(os, m.size());
740 for (typename std::set<K, Pred, A>::const_iterator it = m.begin(); it != m.end(); ++it)
741 Serialize(os, (*it), nType, nVersion);
744 template<typename Stream, typename K, typename Pred, typename A>
745 void Unserialize(Stream& is, std::set<K, Pred, A>& m, int nType, int nVersion)
748 unsigned int nSize = ReadCompactSize(is);
749 typename std::set<K, Pred, A>::iterator it = m.begin();
750 for (unsigned int i = 0; i < nSize; i++)
753 Unserialize(is, key, nType, nVersion);
754 it = m.insert(it, key);
761 // Support for IMPLEMENT_SERIALIZE and READWRITE macro
763 class CSerActionGetSerializeSize { };
764 class CSerActionSerialize { };
765 class CSerActionUnserialize { };
767 template<typename Stream, typename T>
768 inline unsigned int SerReadWrite(Stream& s, const T& obj, int nType, int nVersion, CSerActionGetSerializeSize ser_action)
770 return ::GetSerializeSize(obj, nType, nVersion);
773 template<typename Stream, typename T>
774 inline unsigned int SerReadWrite(Stream& s, const T& obj, int nType, int nVersion, CSerActionSerialize ser_action)
776 ::Serialize(s, obj, nType, nVersion);
780 template<typename Stream, typename T>
781 inline unsigned int SerReadWrite(Stream& s, T& obj, int nType, int nVersion, CSerActionUnserialize ser_action)
783 ::Unserialize(s, obj, nType, nVersion);
787 struct ser_streamplaceholder
804 /** Double ended buffer combining vector and stream-like interfaces.
806 * >> and << read and write unformatted data using the above serialization templates.
807 * Fills with data in linear time; some stringstream implementations take N^2 time.
812 typedef std::vector<char, zero_after_free_allocator<char> > vector_type;
814 unsigned int nReadPos;
821 typedef vector_type::allocator_type allocator_type;
822 typedef vector_type::size_type size_type;
823 typedef vector_type::difference_type difference_type;
824 typedef vector_type::reference reference;
825 typedef vector_type::const_reference const_reference;
826 typedef vector_type::value_type value_type;
827 typedef vector_type::iterator iterator;
828 typedef vector_type::const_iterator const_iterator;
829 typedef vector_type::reverse_iterator reverse_iterator;
831 explicit CDataStream(int nTypeIn, int nVersionIn)
833 Init(nTypeIn, nVersionIn);
836 CDataStream(const_iterator pbegin, const_iterator pend, int nTypeIn, int nVersionIn) : vch(pbegin, pend)
838 Init(nTypeIn, nVersionIn);
841 #if !defined(_MSC_VER) || _MSC_VER >= 1300
842 CDataStream(const char* pbegin, const char* pend, int nTypeIn, int nVersionIn) : vch(pbegin, pend)
844 Init(nTypeIn, nVersionIn);
848 CDataStream(const vector_type& vchIn, int nTypeIn, int nVersionIn) : vch(vchIn.begin(), vchIn.end())
850 Init(nTypeIn, nVersionIn);
853 CDataStream(const std::vector<char>& vchIn, int nTypeIn, int nVersionIn) : vch(vchIn.begin(), vchIn.end())
855 Init(nTypeIn, nVersionIn);
858 CDataStream(const std::vector<unsigned char>& vchIn, int nTypeIn, int nVersionIn) : vch((char*)&vchIn.begin()[0], (char*)&vchIn.end()[0])
860 Init(nTypeIn, nVersionIn);
863 void Init(int nTypeIn, int nVersionIn)
867 nVersion = nVersionIn;
869 exceptmask = std::ios::badbit | std::ios::failbit;
872 CDataStream& operator+=(const CDataStream& b)
874 vch.insert(vch.end(), b.begin(), b.end());
878 friend CDataStream operator+(const CDataStream& a, const CDataStream& b)
885 std::string str() const
887 return (std::string(begin(), end()));
894 const_iterator begin() const { return vch.begin() + nReadPos; }
895 iterator begin() { return vch.begin() + nReadPos; }
896 const_iterator end() const { return vch.end(); }
897 iterator end() { return vch.end(); }
898 size_type size() const { return vch.size() - nReadPos; }
899 bool empty() const { return vch.size() == nReadPos; }
900 void resize(size_type n, value_type c=0) { vch.resize(n + nReadPos, c); }
901 void reserve(size_type n) { vch.reserve(n + nReadPos); }
902 const_reference operator[](size_type pos) const { return vch[pos + nReadPos]; }
903 reference operator[](size_type pos) { return vch[pos + nReadPos]; }
904 void clear() { vch.clear(); nReadPos = 0; }
905 iterator insert(iterator it, const char& x=char()) { return vch.insert(it, x); }
906 void insert(iterator it, size_type n, const char& x) { vch.insert(it, n, x); }
908 void insert(iterator it, const_iterator first, const_iterator last)
910 assert(last - first >= 0);
911 if (it == vch.begin() + nReadPos && (unsigned int)(last - first) <= nReadPos)
913 // special case for inserting at the front when there's room
914 nReadPos -= (last - first);
915 memcpy(&vch[nReadPos], &first[0], last - first);
918 vch.insert(it, first, last);
921 void insert(iterator it, std::vector<char>::const_iterator first, std::vector<char>::const_iterator last)
923 assert(last - first >= 0);
924 if (it == vch.begin() + nReadPos && (unsigned int)(last - first) <= nReadPos)
926 // special case for inserting at the front when there's room
927 nReadPos -= (last - first);
928 memcpy(&vch[nReadPos], &first[0], last - first);
931 vch.insert(it, first, last);
934 #if !defined(_MSC_VER) || _MSC_VER >= 1300
935 void insert(iterator it, const char* first, const char* last)
937 assert(last - first >= 0);
938 if (it == vch.begin() + nReadPos && (unsigned int)(last - first) <= nReadPos)
940 // special case for inserting at the front when there's room
941 nReadPos -= (last - first);
942 memcpy(&vch[nReadPos], &first[0], last - first);
945 vch.insert(it, first, last);
949 iterator erase(iterator it)
951 if (it == vch.begin() + nReadPos)
953 // special case for erasing from the front
954 if (++nReadPos >= vch.size())
956 // whenever we reach the end, we take the opportunity to clear the buffer
958 return vch.erase(vch.begin(), vch.end());
960 return vch.begin() + nReadPos;
963 return vch.erase(it);
966 iterator erase(iterator first, iterator last)
968 if (first == vch.begin() + nReadPos)
970 // special case for erasing from the front
971 if (last == vch.end())
974 return vch.erase(vch.begin(), vch.end());
978 nReadPos = (last - vch.begin());
983 return vch.erase(first, last);
986 inline void Compact()
988 vch.erase(vch.begin(), vch.begin() + nReadPos);
992 bool Rewind(size_type n)
994 // Rewind by n characters if the buffer hasn't been compacted yet
1005 void setstate(short bits, const char* psz)
1008 if (state & exceptmask)
1009 THROW_WITH_STACKTRACE(std::ios_base::failure(psz));
1012 bool eof() const { return size() == 0; }
1013 bool fail() const { return state & (std::ios::badbit | std::ios::failbit); }
1014 bool good() const { return !eof() && (state == 0); }
1015 void clear(short n) { state = n; } // name conflict with vector clear()
1016 short exceptions() { return exceptmask; }
1017 short exceptions(short mask) { short prev = exceptmask; exceptmask = mask; setstate(0, "CDataStream"); return prev; }
1018 CDataStream* rdbuf() { return this; }
1019 int in_avail() { return size(); }
1021 void SetType(int n) { nType = n; }
1022 int GetType() { return nType; }
1023 void SetVersion(int n) { nVersion = n; }
1024 int GetVersion() { return nVersion; }
1025 void ReadVersion() { *this >> nVersion; }
1026 void WriteVersion() { *this << nVersion; }
1028 CDataStream& read(char* pch, int nSize)
1030 // Read from the beginning of the buffer
1032 unsigned int nReadPosNext = nReadPos + nSize;
1033 if (nReadPosNext >= vch.size())
1035 if (nReadPosNext > vch.size())
1037 setstate(std::ios::failbit, "CDataStream::read() : end of data");
1038 memset(pch, 0, nSize);
1039 nSize = vch.size() - nReadPos;
1041 memcpy(pch, &vch[nReadPos], nSize);
1046 memcpy(pch, &vch[nReadPos], nSize);
1047 nReadPos = nReadPosNext;
1051 CDataStream& ignore(int nSize)
1053 // Ignore from the beginning of the buffer
1055 unsigned int nReadPosNext = nReadPos + nSize;
1056 if (nReadPosNext >= vch.size())
1058 if (nReadPosNext > vch.size())
1060 setstate(std::ios::failbit, "CDataStream::ignore() : end of data");
1061 nSize = vch.size() - nReadPos;
1067 nReadPos = nReadPosNext;
1071 CDataStream& write(const char* pch, int nSize)
1073 // Write to the end of the buffer
1075 vch.insert(vch.end(), pch, pch + nSize);
1079 template<typename Stream>
1080 void Serialize(Stream& s, int nType, int nVersion) const
1082 // Special case: stream << stream concatenates like stream += stream
1084 s.write((char*)&vch[0], vch.size() * sizeof(vch[0]));
1087 template<typename T>
1088 unsigned int GetSerializeSize(const T& obj)
1090 // Tells the size of the object if serialized to this stream
1091 return ::GetSerializeSize(obj, nType, nVersion);
1094 template<typename T>
1095 CDataStream& operator<<(const T& obj)
1097 // Serialize to this stream
1098 ::Serialize(*this, obj, nType, nVersion);
1102 template<typename T>
1103 CDataStream& operator>>(T& obj)
1105 // Unserialize from this stream
1106 ::Unserialize(*this, obj, nType, nVersion);
1120 /** RAII wrapper for FILE*.
1122 * Will automatically close the file when it goes out of scope if not null.
1123 * If you're returning the file pointer, return file.release().
1124 * If you need to close the file early, use file.fclose() instead of fclose(file).
1136 CAutoFile(FILE* filenew, int nTypeIn, int nVersionIn)
1140 nVersion = nVersionIn;
1142 exceptmask = std::ios::badbit | std::ios::failbit;
1152 if (file != NULL && file != stdin && file != stdout && file != stderr)
1157 FILE* release() { FILE* ret = file; file = NULL; return ret; }
1158 operator FILE*() { return file; }
1159 FILE* operator->() { return file; }
1160 FILE& operator*() { return *file; }
1161 FILE** operator&() { return &file; }
1162 FILE* operator=(FILE* pnew) { return file = pnew; }
1163 bool operator!() { return (file == NULL); }
1169 void setstate(short bits, const char* psz)
1172 if (state & exceptmask)
1173 THROW_WITH_STACKTRACE(std::ios_base::failure(psz));
1176 bool fail() const { return state & (std::ios::badbit | std::ios::failbit); }
1177 bool good() const { return state == 0; }
1178 void clear(short n = 0) { state = n; }
1179 short exceptions() { return exceptmask; }
1180 short exceptions(short mask) { short prev = exceptmask; exceptmask = mask; setstate(0, "CAutoFile"); return prev; }
1182 void SetType(int n) { nType = n; }
1183 int GetType() { return nType; }
1184 void SetVersion(int n) { nVersion = n; }
1185 int GetVersion() { return nVersion; }
1186 void ReadVersion() { *this >> nVersion; }
1187 void WriteVersion() { *this << nVersion; }
1189 CAutoFile& read(char* pch, size_t nSize)
1192 throw std::ios_base::failure("CAutoFile::read : file handle is NULL");
1193 if (fread(pch, 1, nSize, file) != nSize)
1194 setstate(std::ios::failbit, feof(file) ? "CAutoFile::read : end of file" : "CAutoFile::read : fread failed");
1198 CAutoFile& write(const char* pch, size_t nSize)
1201 throw std::ios_base::failure("CAutoFile::write : file handle is NULL");
1202 if (fwrite(pch, 1, nSize, file) != nSize)
1203 setstate(std::ios::failbit, "CAutoFile::write : write failed");
1207 template<typename T>
1208 unsigned int GetSerializeSize(const T& obj)
1210 // Tells the size of the object if serialized to this stream
1211 return ::GetSerializeSize(obj, nType, nVersion);
1214 template<typename T>
1215 CAutoFile& operator<<(const T& obj)
1217 // Serialize to this stream
1219 throw std::ios_base::failure("CAutoFile::operator<< : file handle is NULL");
1220 ::Serialize(*this, obj, nType, nVersion);
1224 template<typename T>
1225 CAutoFile& operator>>(T& obj)
1227 // Unserialize from this stream
1229 throw std::ios_base::failure("CAutoFile::operator>> : file handle is NULL");
1230 ::Unserialize(*this, obj, nType, nVersion);