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"));
248 #define FLATDATA(obj) REF(CFlatData((char*)&(obj), (char*)&(obj) + sizeof(obj)))
250 /** Wrapper for serializing arrays and POD.
258 CFlatData(void* pbeginIn, void* pendIn) : pbegin((char*)pbeginIn), pend((char*)pendIn) { }
259 char* begin() { return pbegin; }
260 const char* begin() const { return pbegin; }
261 char* end() { return pend; }
262 const char* end() const { return pend; }
264 unsigned int GetSerializeSize(int, int=0) const
266 return pend - pbegin;
269 template<typename Stream>
270 void Serialize(Stream& s, int, int=0) const
272 s.write(pbegin, pend - pbegin);
275 template<typename Stream>
276 void Unserialize(Stream& s, int, int=0)
278 s.read(pbegin, pend - pbegin);
283 // Forward declarations
287 template<typename C> unsigned int GetSerializeSize(const std::basic_string<C>& str, int, int=0);
288 template<typename Stream, typename C> void Serialize(Stream& os, const std::basic_string<C>& str, int, int=0);
289 template<typename Stream, typename C> void Unserialize(Stream& is, std::basic_string<C>& str, int, int=0);
292 template<typename T, typename A> unsigned int GetSerializeSize_impl(const std::vector<T, A>& v, int nType, int nVersion, const boost::true_type&);
293 template<typename T, typename A> unsigned int GetSerializeSize_impl(const std::vector<T, A>& v, int nType, int nVersion, const boost::false_type&);
294 template<typename T, typename A> inline unsigned int GetSerializeSize(const std::vector<T, A>& v, int nType, int nVersion);
295 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&);
296 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&);
297 template<typename Stream, typename T, typename A> inline void Serialize(Stream& os, const std::vector<T, A>& v, int nType, int nVersion);
298 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&);
299 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&);
300 template<typename Stream, typename T, typename A> inline void Unserialize(Stream& is, std::vector<T, A>& v, int nType, int nVersion);
302 // others derived from vector
303 extern inline unsigned int GetSerializeSize(const CScript& v, int nType, int nVersion);
304 template<typename Stream> void Serialize(Stream& os, const CScript& v, int nType, int nVersion);
305 template<typename Stream> void Unserialize(Stream& is, CScript& v, int nType, int nVersion);
308 template<typename K, typename T> unsigned int GetSerializeSize(const std::pair<K, T>& item, int nType, int nVersion);
309 template<typename Stream, typename K, typename T> void Serialize(Stream& os, const std::pair<K, T>& item, int nType, int nVersion);
310 template<typename Stream, typename K, typename T> void Unserialize(Stream& is, std::pair<K, T>& item, int nType, int nVersion);
313 template<typename T0, typename T1, typename T2> unsigned int GetSerializeSize(const boost::tuple<T0, T1, T2>& item, int nType, int nVersion);
314 template<typename Stream, typename T0, typename T1, typename T2> void Serialize(Stream& os, const boost::tuple<T0, T1, T2>& item, int nType, int nVersion);
315 template<typename Stream, typename T0, typename T1, typename T2> void Unserialize(Stream& is, boost::tuple<T0, T1, T2>& item, int nType, int nVersion);
318 template<typename T0, typename T1, typename T2, typename T3> unsigned int GetSerializeSize(const boost::tuple<T0, T1, T2, T3>& item, int nType, int nVersion);
319 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);
320 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);
323 template<typename K, typename T, typename Pred, typename A> unsigned int GetSerializeSize(const std::map<K, T, Pred, A>& m, int nType, int nVersion);
324 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);
325 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);
328 template<typename K, typename Pred, typename A> unsigned int GetSerializeSize(const std::set<K, Pred, A>& m, int nType, int nVersion);
329 template<typename Stream, typename K, typename Pred, typename A> void Serialize(Stream& os, const std::set<K, Pred, A>& m, int nType, int nVersion);
330 template<typename Stream, typename K, typename Pred, typename A> void Unserialize(Stream& is, std::set<K, Pred, A>& m, int nType, int nVersion);
337 // If none of the specialized versions above matched, default to calling member function.
338 // "int nType" is changed to "long nType" to keep from getting an ambiguous overload error.
339 // The compiler will only cast int to long if none of the other templates matched.
340 // Thanks to Boost serialization for this idea.
343 inline unsigned int GetSerializeSize(const T& a, long nType, int nVersion)
345 return a.GetSerializeSize((int)nType, nVersion);
348 template<typename Stream, typename T>
349 inline void Serialize(Stream& os, const T& a, long nType, int nVersion)
351 a.Serialize(os, (int)nType, nVersion);
354 template<typename Stream, typename T>
355 inline void Unserialize(Stream& is, T& a, long nType, int nVersion)
357 a.Unserialize(is, (int)nType, nVersion);
368 unsigned int GetSerializeSize(const std::basic_string<C>& str, int, int)
370 return GetSizeOfCompactSize(str.size()) + str.size() * sizeof(str[0]);
373 template<typename Stream, typename C>
374 void Serialize(Stream& os, const std::basic_string<C>& str, int, int)
376 WriteCompactSize(os, str.size());
378 os.write((char*)&str[0], str.size() * sizeof(str[0]));
381 template<typename Stream, typename C>
382 void Unserialize(Stream& is, std::basic_string<C>& str, int, int)
384 unsigned int nSize = ReadCompactSize(is);
387 is.read((char*)&str[0], nSize * sizeof(str[0]));
395 template<typename T, typename A>
396 unsigned int GetSerializeSize_impl(const std::vector<T, A>& v, int nType, int nVersion, const boost::true_type&)
398 return (GetSizeOfCompactSize(v.size()) + v.size() * sizeof(T));
401 template<typename T, typename A>
402 unsigned int GetSerializeSize_impl(const std::vector<T, A>& v, int nType, int nVersion, const boost::false_type&)
404 unsigned int nSize = GetSizeOfCompactSize(v.size());
405 for (typename std::vector<T, A>::const_iterator vi = v.begin(); vi != v.end(); ++vi)
406 nSize += GetSerializeSize((*vi), nType, nVersion);
410 template<typename T, typename A>
411 inline unsigned int GetSerializeSize(const std::vector<T, A>& v, int nType, int nVersion)
413 return GetSerializeSize_impl(v, nType, nVersion, boost::is_fundamental<T>());
417 template<typename Stream, typename T, typename A>
418 void Serialize_impl(Stream& os, const std::vector<T, A>& v, int nType, int nVersion, const boost::true_type&)
420 WriteCompactSize(os, v.size());
422 os.write((char*)&v[0], v.size() * sizeof(T));
425 template<typename Stream, typename T, typename A>
426 void Serialize_impl(Stream& os, const std::vector<T, A>& v, int nType, int nVersion, const boost::false_type&)
428 WriteCompactSize(os, v.size());
429 for (typename std::vector<T, A>::const_iterator vi = v.begin(); vi != v.end(); ++vi)
430 ::Serialize(os, (*vi), nType, nVersion);
433 template<typename Stream, typename T, typename A>
434 inline void Serialize(Stream& os, const std::vector<T, A>& v, int nType, int nVersion)
436 Serialize_impl(os, v, nType, nVersion, boost::is_fundamental<T>());
440 template<typename Stream, typename T, typename A>
441 void Unserialize_impl(Stream& is, std::vector<T, A>& v, int nType, int nVersion, const boost::true_type&)
443 // Limit size per read so bogus size value won't cause out of memory
445 unsigned int nSize = ReadCompactSize(is);
449 unsigned int blk = std::min(nSize - i, (unsigned int)(1 + 4999999 / sizeof(T)));
451 is.read((char*)&v[i], blk * sizeof(T));
456 template<typename Stream, typename T, typename A>
457 void Unserialize_impl(Stream& is, std::vector<T, A>& v, int nType, int nVersion, const boost::false_type&)
460 unsigned int nSize = ReadCompactSize(is);
462 unsigned int nMid = 0;
465 nMid += 5000000 / sizeof(T);
469 for (; i < nMid; i++)
470 Unserialize(is, v[i], nType, nVersion);
474 template<typename Stream, typename T, typename A>
475 inline void Unserialize(Stream& is, std::vector<T, A>& v, int nType, int nVersion)
477 Unserialize_impl(is, v, nType, nVersion, boost::is_fundamental<T>());
483 // others derived from vector
485 inline unsigned int GetSerializeSize(const CScript& v, int nType, int nVersion)
487 return GetSerializeSize((const std::vector<unsigned char>&)v, nType, nVersion);
490 template<typename Stream>
491 void Serialize(Stream& os, const CScript& v, int nType, int nVersion)
493 Serialize(os, (const std::vector<unsigned char>&)v, nType, nVersion);
496 template<typename Stream>
497 void Unserialize(Stream& is, CScript& v, int nType, int nVersion)
499 Unserialize(is, (std::vector<unsigned char>&)v, nType, nVersion);
507 template<typename K, typename T>
508 unsigned int GetSerializeSize(const std::pair<K, T>& item, int nType, int nVersion)
510 return GetSerializeSize(item.first, nType, nVersion) + GetSerializeSize(item.second, nType, nVersion);
513 template<typename Stream, typename K, typename T>
514 void Serialize(Stream& os, const std::pair<K, T>& item, int nType, int nVersion)
516 Serialize(os, item.first, nType, nVersion);
517 Serialize(os, item.second, nType, nVersion);
520 template<typename Stream, typename K, typename T>
521 void Unserialize(Stream& is, std::pair<K, T>& item, int nType, int nVersion)
523 Unserialize(is, item.first, nType, nVersion);
524 Unserialize(is, item.second, nType, nVersion);
532 template<typename T0, typename T1, typename T2>
533 unsigned int GetSerializeSize(const boost::tuple<T0, T1, T2>& item, int nType, int nVersion)
535 unsigned int nSize = 0;
536 nSize += GetSerializeSize(boost::get<0>(item), nType, nVersion);
537 nSize += GetSerializeSize(boost::get<1>(item), nType, nVersion);
538 nSize += GetSerializeSize(boost::get<2>(item), nType, nVersion);
542 template<typename Stream, typename T0, typename T1, typename T2>
543 void Serialize(Stream& os, const boost::tuple<T0, T1, T2>& item, int nType, int nVersion)
545 Serialize(os, boost::get<0>(item), nType, nVersion);
546 Serialize(os, boost::get<1>(item), nType, nVersion);
547 Serialize(os, boost::get<2>(item), nType, nVersion);
550 template<typename Stream, typename T0, typename T1, typename T2>
551 void Unserialize(Stream& is, boost::tuple<T0, T1, T2>& item, int nType, int nVersion)
553 Unserialize(is, boost::get<0>(item), nType, nVersion);
554 Unserialize(is, boost::get<1>(item), nType, nVersion);
555 Unserialize(is, boost::get<2>(item), nType, nVersion);
563 template<typename T0, typename T1, typename T2, typename T3>
564 unsigned int GetSerializeSize(const boost::tuple<T0, T1, T2, T3>& item, int nType, int nVersion)
566 unsigned int nSize = 0;
567 nSize += GetSerializeSize(boost::get<0>(item), nType, nVersion);
568 nSize += GetSerializeSize(boost::get<1>(item), nType, nVersion);
569 nSize += GetSerializeSize(boost::get<2>(item), nType, nVersion);
570 nSize += GetSerializeSize(boost::get<3>(item), nType, nVersion);
574 template<typename Stream, typename T0, typename T1, typename T2, typename T3>
575 void Serialize(Stream& os, const boost::tuple<T0, T1, T2, T3>& item, int nType, int nVersion)
577 Serialize(os, boost::get<0>(item), nType, nVersion);
578 Serialize(os, boost::get<1>(item), nType, nVersion);
579 Serialize(os, boost::get<2>(item), nType, nVersion);
580 Serialize(os, boost::get<3>(item), nType, nVersion);
583 template<typename Stream, typename T0, typename T1, typename T2, typename T3>
584 void Unserialize(Stream& is, boost::tuple<T0, T1, T2, T3>& item, int nType, int nVersion)
586 Unserialize(is, boost::get<0>(item), nType, nVersion);
587 Unserialize(is, boost::get<1>(item), nType, nVersion);
588 Unserialize(is, boost::get<2>(item), nType, nVersion);
589 Unserialize(is, boost::get<3>(item), nType, nVersion);
597 template<typename K, typename T, typename Pred, typename A>
598 unsigned int GetSerializeSize(const std::map<K, T, Pred, A>& m, int nType, int nVersion)
600 unsigned int nSize = GetSizeOfCompactSize(m.size());
601 for (typename std::map<K, T, Pred, A>::const_iterator mi = m.begin(); mi != m.end(); ++mi)
602 nSize += GetSerializeSize((*mi), nType, nVersion);
606 template<typename Stream, typename K, typename T, typename Pred, typename A>
607 void Serialize(Stream& os, const std::map<K, T, Pred, A>& m, int nType, int nVersion)
609 WriteCompactSize(os, m.size());
610 for (typename std::map<K, T, Pred, A>::const_iterator mi = m.begin(); mi != m.end(); ++mi)
611 Serialize(os, (*mi), nType, nVersion);
614 template<typename Stream, typename K, typename T, typename Pred, typename A>
615 void Unserialize(Stream& is, std::map<K, T, Pred, A>& m, int nType, int nVersion)
618 unsigned int nSize = ReadCompactSize(is);
619 typename std::map<K, T, Pred, A>::iterator mi = m.begin();
620 for (unsigned int i = 0; i < nSize; i++)
622 std::pair<K, T> item;
623 Unserialize(is, item, nType, nVersion);
624 mi = m.insert(mi, item);
633 template<typename K, typename Pred, typename A>
634 unsigned int GetSerializeSize(const std::set<K, Pred, A>& m, int nType, int nVersion)
636 unsigned int nSize = GetSizeOfCompactSize(m.size());
637 for (typename std::set<K, Pred, A>::const_iterator it = m.begin(); it != m.end(); ++it)
638 nSize += GetSerializeSize((*it), nType, nVersion);
642 template<typename Stream, typename K, typename Pred, typename A>
643 void Serialize(Stream& os, const std::set<K, Pred, A>& m, int nType, int nVersion)
645 WriteCompactSize(os, m.size());
646 for (typename std::set<K, Pred, A>::const_iterator it = m.begin(); it != m.end(); ++it)
647 Serialize(os, (*it), nType, nVersion);
650 template<typename Stream, typename K, typename Pred, typename A>
651 void Unserialize(Stream& is, std::set<K, Pred, A>& m, int nType, int nVersion)
654 unsigned int nSize = ReadCompactSize(is);
655 typename std::set<K, Pred, A>::iterator it = m.begin();
656 for (unsigned int i = 0; i < nSize; i++)
659 Unserialize(is, key, nType, nVersion);
660 it = m.insert(it, key);
667 // Support for IMPLEMENT_SERIALIZE and READWRITE macro
669 class CSerActionGetSerializeSize { };
670 class CSerActionSerialize { };
671 class CSerActionUnserialize { };
673 template<typename Stream, typename T>
674 inline unsigned int SerReadWrite(Stream& s, const T& obj, int nType, int nVersion, CSerActionGetSerializeSize ser_action)
676 return ::GetSerializeSize(obj, nType, nVersion);
679 template<typename Stream, typename T>
680 inline unsigned int SerReadWrite(Stream& s, const T& obj, int nType, int nVersion, CSerActionSerialize ser_action)
682 ::Serialize(s, obj, nType, nVersion);
686 template<typename Stream, typename T>
687 inline unsigned int SerReadWrite(Stream& s, T& obj, int nType, int nVersion, CSerActionUnserialize ser_action)
689 ::Unserialize(s, obj, nType, nVersion);
693 struct ser_streamplaceholder
710 /** Double ended buffer combining vector and stream-like interfaces.
712 * >> and << read and write unformatted data using the above serialization templates.
713 * Fills with data in linear time; some stringstream implementations take N^2 time.
718 typedef std::vector<char, zero_after_free_allocator<char> > vector_type;
720 unsigned int nReadPos;
727 typedef vector_type::allocator_type allocator_type;
728 typedef vector_type::size_type size_type;
729 typedef vector_type::difference_type difference_type;
730 typedef vector_type::reference reference;
731 typedef vector_type::const_reference const_reference;
732 typedef vector_type::value_type value_type;
733 typedef vector_type::iterator iterator;
734 typedef vector_type::const_iterator const_iterator;
735 typedef vector_type::reverse_iterator reverse_iterator;
737 explicit CDataStream(int nTypeIn, int nVersionIn)
739 Init(nTypeIn, nVersionIn);
742 CDataStream(const_iterator pbegin, const_iterator pend, int nTypeIn, int nVersionIn) : vch(pbegin, pend)
744 Init(nTypeIn, nVersionIn);
747 #if !defined(_MSC_VER) || _MSC_VER >= 1300
748 CDataStream(const char* pbegin, const char* pend, int nTypeIn, int nVersionIn) : vch(pbegin, pend)
750 Init(nTypeIn, nVersionIn);
754 CDataStream(const vector_type& vchIn, int nTypeIn, int nVersionIn) : vch(vchIn.begin(), vchIn.end())
756 Init(nTypeIn, nVersionIn);
759 CDataStream(const std::vector<char>& vchIn, int nTypeIn, int nVersionIn) : vch(vchIn.begin(), vchIn.end())
761 Init(nTypeIn, nVersionIn);
764 CDataStream(const std::vector<unsigned char>& vchIn, int nTypeIn, int nVersionIn) : vch((char*)&vchIn.begin()[0], (char*)&vchIn.end()[0])
766 Init(nTypeIn, nVersionIn);
769 void Init(int nTypeIn, int nVersionIn)
773 nVersion = nVersionIn;
775 exceptmask = std::ios::badbit | std::ios::failbit;
778 CDataStream& operator+=(const CDataStream& b)
780 vch.insert(vch.end(), b.begin(), b.end());
784 friend CDataStream operator+(const CDataStream& a, const CDataStream& b)
791 std::string str() const
793 return (std::string(begin(), end()));
800 const_iterator begin() const { return vch.begin() + nReadPos; }
801 iterator begin() { return vch.begin() + nReadPos; }
802 const_iterator end() const { return vch.end(); }
803 iterator end() { return vch.end(); }
804 size_type size() const { return vch.size() - nReadPos; }
805 bool empty() const { return vch.size() == nReadPos; }
806 void resize(size_type n, value_type c=0) { vch.resize(n + nReadPos, c); }
807 void reserve(size_type n) { vch.reserve(n + nReadPos); }
808 const_reference operator[](size_type pos) const { return vch[pos + nReadPos]; }
809 reference operator[](size_type pos) { return vch[pos + nReadPos]; }
810 void clear() { vch.clear(); nReadPos = 0; }
811 iterator insert(iterator it, const char& x=char()) { return vch.insert(it, x); }
812 void insert(iterator it, size_type n, const char& x) { vch.insert(it, n, x); }
814 void insert(iterator it, const_iterator first, const_iterator last)
816 assert(last - first >= 0);
817 if (it == vch.begin() + nReadPos && (unsigned int)(last - first) <= nReadPos)
819 // special case for inserting at the front when there's room
820 nReadPos -= (last - first);
821 memcpy(&vch[nReadPos], &first[0], last - first);
824 vch.insert(it, first, last);
827 void insert(iterator it, std::vector<char>::const_iterator first, std::vector<char>::const_iterator last)
829 assert(last - first >= 0);
830 if (it == vch.begin() + nReadPos && (unsigned int)(last - first) <= nReadPos)
832 // special case for inserting at the front when there's room
833 nReadPos -= (last - first);
834 memcpy(&vch[nReadPos], &first[0], last - first);
837 vch.insert(it, first, last);
840 #if !defined(_MSC_VER) || _MSC_VER >= 1300
841 void insert(iterator it, const char* first, const char* last)
843 assert(last - first >= 0);
844 if (it == vch.begin() + nReadPos && (unsigned int)(last - first) <= nReadPos)
846 // special case for inserting at the front when there's room
847 nReadPos -= (last - first);
848 memcpy(&vch[nReadPos], &first[0], last - first);
851 vch.insert(it, first, last);
855 iterator erase(iterator it)
857 if (it == vch.begin() + nReadPos)
859 // special case for erasing from the front
860 if (++nReadPos >= vch.size())
862 // whenever we reach the end, we take the opportunity to clear the buffer
864 return vch.erase(vch.begin(), vch.end());
866 return vch.begin() + nReadPos;
869 return vch.erase(it);
872 iterator erase(iterator first, iterator last)
874 if (first == vch.begin() + nReadPos)
876 // special case for erasing from the front
877 if (last == vch.end())
880 return vch.erase(vch.begin(), vch.end());
884 nReadPos = (last - vch.begin());
889 return vch.erase(first, last);
892 inline void Compact()
894 vch.erase(vch.begin(), vch.begin() + nReadPos);
898 bool Rewind(size_type n)
900 // Rewind by n characters if the buffer hasn't been compacted yet
911 void setstate(short bits, const char* psz)
914 if (state & exceptmask)
915 THROW_WITH_STACKTRACE(std::ios_base::failure(psz));
918 bool eof() const { return size() == 0; }
919 bool fail() const { return state & (std::ios::badbit | std::ios::failbit); }
920 bool good() const { return !eof() && (state == 0); }
921 void clear(short n) { state = n; } // name conflict with vector clear()
922 short exceptions() { return exceptmask; }
923 short exceptions(short mask) { short prev = exceptmask; exceptmask = mask; setstate(0, "CDataStream"); return prev; }
924 CDataStream* rdbuf() { return this; }
925 int in_avail() { return size(); }
927 void SetType(int n) { nType = n; }
928 int GetType() { return nType; }
929 void SetVersion(int n) { nVersion = n; }
930 int GetVersion() { return nVersion; }
931 void ReadVersion() { *this >> nVersion; }
932 void WriteVersion() { *this << nVersion; }
934 CDataStream& read(char* pch, int nSize)
936 // Read from the beginning of the buffer
938 unsigned int nReadPosNext = nReadPos + nSize;
939 if (nReadPosNext >= vch.size())
941 if (nReadPosNext > vch.size())
943 setstate(std::ios::failbit, "CDataStream::read() : end of data");
944 memset(pch, 0, nSize);
945 nSize = vch.size() - nReadPos;
947 memcpy(pch, &vch[nReadPos], nSize);
952 memcpy(pch, &vch[nReadPos], nSize);
953 nReadPos = nReadPosNext;
957 CDataStream& ignore(int nSize)
959 // Ignore from the beginning of the buffer
961 unsigned int nReadPosNext = nReadPos + nSize;
962 if (nReadPosNext >= vch.size())
964 if (nReadPosNext > vch.size())
966 setstate(std::ios::failbit, "CDataStream::ignore() : end of data");
967 nSize = vch.size() - nReadPos;
973 nReadPos = nReadPosNext;
977 CDataStream& write(const char* pch, int nSize)
979 // Write to the end of the buffer
981 vch.insert(vch.end(), pch, pch + nSize);
985 template<typename Stream>
986 void Serialize(Stream& s, int nType, int nVersion) const
988 // Special case: stream << stream concatenates like stream += stream
990 s.write((char*)&vch[0], vch.size() * sizeof(vch[0]));
994 unsigned int GetSerializeSize(const T& obj)
996 // Tells the size of the object if serialized to this stream
997 return ::GetSerializeSize(obj, nType, nVersion);
1000 template<typename T>
1001 CDataStream& operator<<(const T& obj)
1003 // Serialize to this stream
1004 ::Serialize(*this, obj, nType, nVersion);
1008 template<typename T>
1009 CDataStream& operator>>(T& obj)
1011 // Unserialize from this stream
1012 ::Unserialize(*this, obj, nType, nVersion);
1026 /** RAII wrapper for FILE*.
1028 * Will automatically close the file when it goes out of scope if not null.
1029 * If you're returning the file pointer, return file.release().
1030 * If you need to close the file early, use file.fclose() instead of fclose(file).
1042 CAutoFile(FILE* filenew, int nTypeIn, int nVersionIn)
1046 nVersion = nVersionIn;
1048 exceptmask = std::ios::badbit | std::ios::failbit;
1058 if (file != NULL && file != stdin && file != stdout && file != stderr)
1063 FILE* release() { FILE* ret = file; file = NULL; return ret; }
1064 operator FILE*() { return file; }
1065 FILE* operator->() { return file; }
1066 FILE& operator*() { return *file; }
1067 FILE** operator&() { return &file; }
1068 FILE* operator=(FILE* pnew) { return file = pnew; }
1069 bool operator!() { return (file == NULL); }
1075 void setstate(short bits, const char* psz)
1078 if (state & exceptmask)
1079 THROW_WITH_STACKTRACE(std::ios_base::failure(psz));
1082 bool fail() const { return state & (std::ios::badbit | std::ios::failbit); }
1083 bool good() const { return state == 0; }
1084 void clear(short n = 0) { state = n; }
1085 short exceptions() { return exceptmask; }
1086 short exceptions(short mask) { short prev = exceptmask; exceptmask = mask; setstate(0, "CAutoFile"); return prev; }
1088 void SetType(int n) { nType = n; }
1089 int GetType() { return nType; }
1090 void SetVersion(int n) { nVersion = n; }
1091 int GetVersion() { return nVersion; }
1092 void ReadVersion() { *this >> nVersion; }
1093 void WriteVersion() { *this << nVersion; }
1095 CAutoFile& read(char* pch, size_t nSize)
1098 throw std::ios_base::failure("CAutoFile::read : file handle is NULL");
1099 if (fread(pch, 1, nSize, file) != nSize)
1100 setstate(std::ios::failbit, feof(file) ? "CAutoFile::read : end of file" : "CAutoFile::read : fread failed");
1104 CAutoFile& write(const char* pch, size_t nSize)
1107 throw std::ios_base::failure("CAutoFile::write : file handle is NULL");
1108 if (fwrite(pch, 1, nSize, file) != nSize)
1109 setstate(std::ios::failbit, "CAutoFile::write : write failed");
1113 template<typename T>
1114 unsigned int GetSerializeSize(const T& obj)
1116 // Tells the size of the object if serialized to this stream
1117 return ::GetSerializeSize(obj, nType, nVersion);
1120 template<typename T>
1121 CAutoFile& operator<<(const T& obj)
1123 // Serialize to this stream
1125 throw std::ios_base::failure("CAutoFile::operator<< : file handle is NULL");
1126 ::Serialize(*this, obj, nType, nVersion);
1130 template<typename T>
1131 CAutoFile& operator>>(T& obj)
1133 // Unserialize from this stream
1135 throw std::ios_base::failure("CAutoFile::operator>> : file handle is NULL");
1136 ::Unserialize(*this, obj, nType, nVersion);