Bump version to 0.3.25
[novacoin.git] / src / serialize.h
1 // Copyright (c) 2009-2010 Satoshi Nakamoto
2 // Distributed under the MIT/X11 software license, see the accompanying
3 // file license.txt or http://www.opensource.org/licenses/mit-license.php.
4 #ifndef BITCOIN_SERIALIZE_H
5 #define BITCOIN_SERIALIZE_H
6
7 #include <string>
8 #include <vector>
9 #include <map>
10 #include <set>
11 #include <cassert>
12 #include <climits>
13 #include <cstring>
14 #include <cstdio>
15
16 #include <boost/type_traits/is_fundamental.hpp>
17 #include <boost/tuple/tuple.hpp>
18 #include <boost/tuple/tuple_comparison.hpp>
19 #include <boost/tuple/tuple_io.hpp>
20
21 #if defined(_MSC_VER) || defined(__BORLANDC__)
22 typedef __int64  int64;
23 typedef unsigned __int64  uint64;
24 #else
25 typedef long long  int64;
26 typedef unsigned long long  uint64;
27 #endif
28 #if defined(_MSC_VER) && _MSC_VER < 1300
29 #define for  if (false) ; else for
30 #endif
31
32 #ifdef __WXMSW__
33 // This is used to attempt to keep keying material out of swap
34 // Note that VirtualLock does not provide this as a guarantee on Windows,
35 // but, in practice, memory that has been VirtualLock'd almost never gets written to
36 // the pagefile except in rare circumstances where memory is extremely low.
37 #define mlock(p, n) VirtualLock((p), (n));
38 #define munlock(p, n) VirtualUnlock((p), (n));
39 #else
40 #include <sys/mman.h>
41 #include <limits.h>
42 /* This comes from limits.h if it's not defined there set a sane default */
43 #ifndef PAGESIZE
44 #include <unistd.h>
45 #define PAGESIZE sysconf(_SC_PAGESIZE)
46 #endif
47 #define mlock(a,b) \
48   mlock(((void *)(((size_t)(a)) & (~((PAGESIZE)-1)))),\
49   (((((size_t)(a)) + (b) - 1) | ((PAGESIZE) - 1)) + 1) - (((size_t)(a)) & (~((PAGESIZE) - 1))))
50 #define munlock(a,b) \
51   munlock(((void *)(((size_t)(a)) & (~((PAGESIZE)-1)))),\
52   (((((size_t)(a)) + (b) - 1) | ((PAGESIZE) - 1)) + 1) - (((size_t)(a)) & (~((PAGESIZE) - 1))))
53 #endif
54
55 class CScript;
56 class CDataStream;
57 class CAutoFile;
58 static const unsigned int MAX_SIZE = 0x02000000;
59
60 static const int VERSION = 32500;
61 static const char* pszSubVer = "";
62 static const bool VERSION_IS_BETA = true;
63
64
65
66
67
68
69 /////////////////////////////////////////////////////////////////
70 //
71 // Templates for serializing to anything that looks like a stream,
72 // i.e. anything that supports .read(char*, int) and .write(char*, int)
73 //
74
75 enum
76 {
77     // primary actions
78     SER_NETWORK         = (1 << 0),
79     SER_DISK            = (1 << 1),
80     SER_GETHASH         = (1 << 2),
81
82     // modifiers
83     SER_SKIPSIG         = (1 << 16),
84     SER_BLOCKHEADERONLY = (1 << 17),
85 };
86
87 #define IMPLEMENT_SERIALIZE(statements)    \
88     unsigned int GetSerializeSize(int nType=0, int nVersion=VERSION) const  \
89     {                                           \
90         CSerActionGetSerializeSize ser_action;  \
91         const bool fGetSize = true;             \
92         const bool fWrite = false;              \
93         const bool fRead = false;               \
94         unsigned int nSerSize = 0;              \
95         ser_streamplaceholder s;                \
96         s.nType = nType;                        \
97         s.nVersion = nVersion;                  \
98         {statements}                            \
99         return nSerSize;                        \
100     }                                           \
101     template<typename Stream>                   \
102     void Serialize(Stream& s, int nType=0, int nVersion=VERSION) const  \
103     {                                           \
104         CSerActionSerialize ser_action;         \
105         const bool fGetSize = false;            \
106         const bool fWrite = true;               \
107         const bool fRead = false;               \
108         unsigned int nSerSize = 0;              \
109         {statements}                            \
110     }                                           \
111     template<typename Stream>                   \
112     void Unserialize(Stream& s, int nType=0, int nVersion=VERSION)  \
113     {                                           \
114         CSerActionUnserialize ser_action;       \
115         const bool fGetSize = false;            \
116         const bool fWrite = false;              \
117         const bool fRead = true;                \
118         unsigned int nSerSize = 0;              \
119         {statements}                            \
120     }
121
122 #define READWRITE(obj)      (nSerSize += ::SerReadWrite(s, (obj), nType, nVersion, ser_action))
123
124
125
126
127
128
129 //
130 // Basic types
131 //
132 #define WRITEDATA(s, obj)   s.write((char*)&(obj), sizeof(obj))
133 #define READDATA(s, obj)    s.read((char*)&(obj), sizeof(obj))
134
135 inline unsigned int GetSerializeSize(char a,           int, int=0) { return sizeof(a); }
136 inline unsigned int GetSerializeSize(signed char a,    int, int=0) { return sizeof(a); }
137 inline unsigned int GetSerializeSize(unsigned char a,  int, int=0) { return sizeof(a); }
138 inline unsigned int GetSerializeSize(signed short a,   int, int=0) { return sizeof(a); }
139 inline unsigned int GetSerializeSize(unsigned short a, int, int=0) { return sizeof(a); }
140 inline unsigned int GetSerializeSize(signed int a,     int, int=0) { return sizeof(a); }
141 inline unsigned int GetSerializeSize(unsigned int a,   int, int=0) { return sizeof(a); }
142 inline unsigned int GetSerializeSize(signed long a,    int, int=0) { return sizeof(a); }
143 inline unsigned int GetSerializeSize(unsigned long a,  int, int=0) { return sizeof(a); }
144 inline unsigned int GetSerializeSize(int64 a,          int, int=0) { return sizeof(a); }
145 inline unsigned int GetSerializeSize(uint64 a,         int, int=0) { return sizeof(a); }
146 inline unsigned int GetSerializeSize(float a,          int, int=0) { return sizeof(a); }
147 inline unsigned int GetSerializeSize(double a,         int, int=0) { return sizeof(a); }
148
149 template<typename Stream> inline void Serialize(Stream& s, char a,           int, int=0) { WRITEDATA(s, a); }
150 template<typename Stream> inline void Serialize(Stream& s, signed char a,    int, int=0) { WRITEDATA(s, a); }
151 template<typename Stream> inline void Serialize(Stream& s, unsigned char a,  int, int=0) { WRITEDATA(s, a); }
152 template<typename Stream> inline void Serialize(Stream& s, signed short a,   int, int=0) { WRITEDATA(s, a); }
153 template<typename Stream> inline void Serialize(Stream& s, unsigned short a, int, int=0) { WRITEDATA(s, a); }
154 template<typename Stream> inline void Serialize(Stream& s, signed int a,     int, int=0) { WRITEDATA(s, a); }
155 template<typename Stream> inline void Serialize(Stream& s, unsigned int a,   int, int=0) { WRITEDATA(s, a); }
156 template<typename Stream> inline void Serialize(Stream& s, signed long a,    int, int=0) { WRITEDATA(s, a); }
157 template<typename Stream> inline void Serialize(Stream& s, unsigned long a,  int, int=0) { WRITEDATA(s, a); }
158 template<typename Stream> inline void Serialize(Stream& s, int64 a,          int, int=0) { WRITEDATA(s, a); }
159 template<typename Stream> inline void Serialize(Stream& s, uint64 a,         int, int=0) { WRITEDATA(s, a); }
160 template<typename Stream> inline void Serialize(Stream& s, float a,          int, int=0) { WRITEDATA(s, a); }
161 template<typename Stream> inline void Serialize(Stream& s, double a,         int, int=0) { WRITEDATA(s, a); }
162
163 template<typename Stream> inline void Unserialize(Stream& s, char& a,           int, int=0) { READDATA(s, a); }
164 template<typename Stream> inline void Unserialize(Stream& s, signed char& a,    int, int=0) { READDATA(s, a); }
165 template<typename Stream> inline void Unserialize(Stream& s, unsigned char& a,  int, int=0) { READDATA(s, a); }
166 template<typename Stream> inline void Unserialize(Stream& s, signed short& a,   int, int=0) { READDATA(s, a); }
167 template<typename Stream> inline void Unserialize(Stream& s, unsigned short& a, int, int=0) { READDATA(s, a); }
168 template<typename Stream> inline void Unserialize(Stream& s, signed int& a,     int, int=0) { READDATA(s, a); }
169 template<typename Stream> inline void Unserialize(Stream& s, unsigned int& a,   int, int=0) { READDATA(s, a); }
170 template<typename Stream> inline void Unserialize(Stream& s, signed long& a,    int, int=0) { READDATA(s, a); }
171 template<typename Stream> inline void Unserialize(Stream& s, unsigned long& a,  int, int=0) { READDATA(s, a); }
172 template<typename Stream> inline void Unserialize(Stream& s, int64& a,          int, int=0) { READDATA(s, a); }
173 template<typename Stream> inline void Unserialize(Stream& s, uint64& a,         int, int=0) { READDATA(s, a); }
174 template<typename Stream> inline void Unserialize(Stream& s, float& a,          int, int=0) { READDATA(s, a); }
175 template<typename Stream> inline void Unserialize(Stream& s, double& a,         int, int=0) { READDATA(s, a); }
176
177 inline unsigned int GetSerializeSize(bool a, int, int=0)                          { return sizeof(char); }
178 template<typename Stream> inline void Serialize(Stream& s, bool a, int, int=0)    { char f=a; WRITEDATA(s, f); }
179 template<typename Stream> inline void Unserialize(Stream& s, bool& a, int, int=0) { char f; READDATA(s, f); a=f; }
180
181
182
183
184
185
186 //
187 // Compact size
188 //  size <  253        -- 1 byte
189 //  size <= USHRT_MAX  -- 3 bytes  (253 + 2 bytes)
190 //  size <= UINT_MAX   -- 5 bytes  (254 + 4 bytes)
191 //  size >  UINT_MAX   -- 9 bytes  (255 + 8 bytes)
192 //
193 inline unsigned int GetSizeOfCompactSize(uint64 nSize)
194 {
195     if (nSize < 253)             return sizeof(unsigned char);
196     else if (nSize <= USHRT_MAX) return sizeof(unsigned char) + sizeof(unsigned short);
197     else if (nSize <= UINT_MAX)  return sizeof(unsigned char) + sizeof(unsigned int);
198     else                         return sizeof(unsigned char) + sizeof(uint64);
199 }
200
201 template<typename Stream>
202 void WriteCompactSize(Stream& os, uint64 nSize)
203 {
204     if (nSize < 253)
205     {
206         unsigned char chSize = nSize;
207         WRITEDATA(os, chSize);
208     }
209     else if (nSize <= USHRT_MAX)
210     {
211         unsigned char chSize = 253;
212         unsigned short xSize = nSize;
213         WRITEDATA(os, chSize);
214         WRITEDATA(os, xSize);
215     }
216     else if (nSize <= UINT_MAX)
217     {
218         unsigned char chSize = 254;
219         unsigned int xSize = nSize;
220         WRITEDATA(os, chSize);
221         WRITEDATA(os, xSize);
222     }
223     else
224     {
225         unsigned char chSize = 255;
226         uint64 xSize = nSize;
227         WRITEDATA(os, chSize);
228         WRITEDATA(os, xSize);
229     }
230     return;
231 }
232
233 template<typename Stream>
234 uint64 ReadCompactSize(Stream& is)
235 {
236     unsigned char chSize;
237     READDATA(is, chSize);
238     uint64 nSizeRet = 0;
239     if (chSize < 253)
240     {
241         nSizeRet = chSize;
242     }
243     else if (chSize == 253)
244     {
245         unsigned short xSize;
246         READDATA(is, xSize);
247         nSizeRet = xSize;
248     }
249     else if (chSize == 254)
250     {
251         unsigned int xSize;
252         READDATA(is, xSize);
253         nSizeRet = xSize;
254     }
255     else
256     {
257         uint64 xSize;
258         READDATA(is, xSize);
259         nSizeRet = xSize;
260     }
261     if (nSizeRet > (uint64)MAX_SIZE)
262         throw std::ios_base::failure("ReadCompactSize() : size too large");
263     return nSizeRet;
264 }
265
266
267
268 //
269 // Wrapper for serializing arrays and POD
270 // There's a clever template way to make arrays serialize normally, but MSVC6 doesn't support it
271 //
272 #define FLATDATA(obj)   REF(CFlatData((char*)&(obj), (char*)&(obj) + sizeof(obj)))
273 class CFlatData
274 {
275 protected:
276     char* pbegin;
277     char* pend;
278 public:
279     CFlatData(void* pbeginIn, void* pendIn) : pbegin((char*)pbeginIn), pend((char*)pendIn) { }
280     char* begin() { return pbegin; }
281     const char* begin() const { return pbegin; }
282     char* end() { return pend; }
283     const char* end() const { return pend; }
284
285     unsigned int GetSerializeSize(int, int=0) const
286     {
287         return pend - pbegin;
288     }
289
290     template<typename Stream>
291     void Serialize(Stream& s, int, int=0) const
292     {
293         s.write(pbegin, pend - pbegin);
294     }
295
296     template<typename Stream>
297     void Unserialize(Stream& s, int, int=0)
298     {
299         s.read(pbegin, pend - pbegin);
300     }
301 };
302
303
304
305 //
306 // string stored as a fixed length field
307 //
308 template<std::size_t LEN>
309 class CFixedFieldString
310 {
311 protected:
312     const std::string* pcstr;
313     std::string* pstr;
314 public:
315     explicit CFixedFieldString(const std::string& str) : pcstr(&str), pstr(NULL) { }
316     explicit CFixedFieldString(std::string& str) : pcstr(&str), pstr(&str) { }
317
318     unsigned int GetSerializeSize(int, int=0) const
319     {
320         return LEN;
321     }
322
323     template<typename Stream>
324     void Serialize(Stream& s, int, int=0) const
325     {
326         char pszBuf[LEN];
327         strncpy(pszBuf, pcstr->c_str(), LEN);
328         s.write(pszBuf, LEN);
329     }
330
331     template<typename Stream>
332     void Unserialize(Stream& s, int, int=0)
333     {
334         if (pstr == NULL)
335             throw std::ios_base::failure("CFixedFieldString::Unserialize : trying to unserialize to const string");
336         char pszBuf[LEN+1];
337         s.read(pszBuf, LEN);
338         pszBuf[LEN] = '\0';
339         *pstr = pszBuf;
340     }
341 };
342
343
344
345
346
347 //
348 // Forward declarations
349 //
350
351 // string
352 template<typename C> unsigned int GetSerializeSize(const std::basic_string<C>& str, int, int=0);
353 template<typename Stream, typename C> void Serialize(Stream& os, const std::basic_string<C>& str, int, int=0);
354 template<typename Stream, typename C> void Unserialize(Stream& is, std::basic_string<C>& str, int, int=0);
355
356 // vector
357 template<typename T, typename A> unsigned int GetSerializeSize_impl(const std::vector<T, A>& v, int nType, int nVersion, const boost::true_type&);
358 template<typename T, typename A> unsigned int GetSerializeSize_impl(const std::vector<T, A>& v, int nType, int nVersion, const boost::false_type&);
359 template<typename T, typename A> inline unsigned int GetSerializeSize(const std::vector<T, A>& v, int nType, int nVersion=VERSION);
360 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&);
361 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&);
362 template<typename Stream, typename T, typename A> inline void Serialize(Stream& os, const std::vector<T, A>& v, int nType, int nVersion=VERSION);
363 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&);
364 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&);
365 template<typename Stream, typename T, typename A> inline void Unserialize(Stream& is, std::vector<T, A>& v, int nType, int nVersion=VERSION);
366
367 // others derived from vector
368 extern inline unsigned int GetSerializeSize(const CScript& v, int nType, int nVersion=VERSION);
369 template<typename Stream> void Serialize(Stream& os, const CScript& v, int nType, int nVersion=VERSION);
370 template<typename Stream> void Unserialize(Stream& is, CScript& v, int nType, int nVersion=VERSION);
371
372 // pair
373 template<typename K, typename T> unsigned int GetSerializeSize(const std::pair<K, T>& item, int nType, int nVersion=VERSION);
374 template<typename Stream, typename K, typename T> void Serialize(Stream& os, const std::pair<K, T>& item, int nType, int nVersion=VERSION);
375 template<typename Stream, typename K, typename T> void Unserialize(Stream& is, std::pair<K, T>& item, int nType, int nVersion=VERSION);
376
377 // 3 tuple
378 template<typename T0, typename T1, typename T2> unsigned int GetSerializeSize(const boost::tuple<T0, T1, T2>& item, int nType, int nVersion=VERSION);
379 template<typename Stream, typename T0, typename T1, typename T2> void Serialize(Stream& os, const boost::tuple<T0, T1, T2>& item, int nType, int nVersion=VERSION);
380 template<typename Stream, typename T0, typename T1, typename T2> void Unserialize(Stream& is, boost::tuple<T0, T1, T2>& item, int nType, int nVersion=VERSION);
381
382 // 4 tuple
383 template<typename T0, typename T1, typename T2, typename T3> unsigned int GetSerializeSize(const boost::tuple<T0, T1, T2, T3>& item, int nType, int nVersion=VERSION);
384 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=VERSION);
385 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=VERSION);
386
387 // map
388 template<typename K, typename T, typename Pred, typename A> unsigned int GetSerializeSize(const std::map<K, T, Pred, A>& m, int nType, int nVersion=VERSION);
389 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=VERSION);
390 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=VERSION);
391
392 // set
393 template<typename K, typename Pred, typename A> unsigned int GetSerializeSize(const std::set<K, Pred, A>& m, int nType, int nVersion=VERSION);
394 template<typename Stream, typename K, typename Pred, typename A> void Serialize(Stream& os, const std::set<K, Pred, A>& m, int nType, int nVersion=VERSION);
395 template<typename Stream, typename K, typename Pred, typename A> void Unserialize(Stream& is, std::set<K, Pred, A>& m, int nType, int nVersion=VERSION);
396
397
398
399
400
401 //
402 // If none of the specialized versions above matched, default to calling member function.
403 // "int nType" is changed to "long nType" to keep from getting an ambiguous overload error.
404 // The compiler will only cast int to long if none of the other templates matched.
405 // Thanks to Boost serialization for this idea.
406 //
407 template<typename T>
408 inline unsigned int GetSerializeSize(const T& a, long nType, int nVersion=VERSION)
409 {
410     return a.GetSerializeSize((int)nType, nVersion);
411 }
412
413 template<typename Stream, typename T>
414 inline void Serialize(Stream& os, const T& a, long nType, int nVersion=VERSION)
415 {
416     a.Serialize(os, (int)nType, nVersion);
417 }
418
419 template<typename Stream, typename T>
420 inline void Unserialize(Stream& is, T& a, long nType, int nVersion=VERSION)
421 {
422     a.Unserialize(is, (int)nType, nVersion);
423 }
424
425
426
427
428
429 //
430 // string
431 //
432 template<typename C>
433 unsigned int GetSerializeSize(const std::basic_string<C>& str, int, int)
434 {
435     return GetSizeOfCompactSize(str.size()) + str.size() * sizeof(str[0]);
436 }
437
438 template<typename Stream, typename C>
439 void Serialize(Stream& os, const std::basic_string<C>& str, int, int)
440 {
441     WriteCompactSize(os, str.size());
442     if (!str.empty())
443         os.write((char*)&str[0], str.size() * sizeof(str[0]));
444 }
445
446 template<typename Stream, typename C>
447 void Unserialize(Stream& is, std::basic_string<C>& str, int, int)
448 {
449     unsigned int nSize = ReadCompactSize(is);
450     str.resize(nSize);
451     if (nSize != 0)
452         is.read((char*)&str[0], nSize * sizeof(str[0]));
453 }
454
455
456
457 //
458 // vector
459 //
460 template<typename T, typename A>
461 unsigned int GetSerializeSize_impl(const std::vector<T, A>& v, int nType, int nVersion, const boost::true_type&)
462 {
463     return (GetSizeOfCompactSize(v.size()) + v.size() * sizeof(T));
464 }
465
466 template<typename T, typename A>
467 unsigned int GetSerializeSize_impl(const std::vector<T, A>& v, int nType, int nVersion, const boost::false_type&)
468 {
469     unsigned int nSize = GetSizeOfCompactSize(v.size());
470     for (typename std::vector<T, A>::const_iterator vi = v.begin(); vi != v.end(); ++vi)
471         nSize += GetSerializeSize((*vi), nType, nVersion);
472     return nSize;
473 }
474
475 template<typename T, typename A>
476 inline unsigned int GetSerializeSize(const std::vector<T, A>& v, int nType, int nVersion)
477 {
478     return GetSerializeSize_impl(v, nType, nVersion, boost::is_fundamental<T>());
479 }
480
481
482 template<typename Stream, typename T, typename A>
483 void Serialize_impl(Stream& os, const std::vector<T, A>& v, int nType, int nVersion, const boost::true_type&)
484 {
485     WriteCompactSize(os, v.size());
486     if (!v.empty())
487         os.write((char*)&v[0], v.size() * sizeof(T));
488 }
489
490 template<typename Stream, typename T, typename A>
491 void Serialize_impl(Stream& os, const std::vector<T, A>& v, int nType, int nVersion, const boost::false_type&)
492 {
493     WriteCompactSize(os, v.size());
494     for (typename std::vector<T, A>::const_iterator vi = v.begin(); vi != v.end(); ++vi)
495         ::Serialize(os, (*vi), nType, nVersion);
496 }
497
498 template<typename Stream, typename T, typename A>
499 inline void Serialize(Stream& os, const std::vector<T, A>& v, int nType, int nVersion)
500 {
501     Serialize_impl(os, v, nType, nVersion, boost::is_fundamental<T>());
502 }
503
504
505 template<typename Stream, typename T, typename A>
506 void Unserialize_impl(Stream& is, std::vector<T, A>& v, int nType, int nVersion, const boost::true_type&)
507 {
508     //unsigned int nSize = ReadCompactSize(is);
509     //v.resize(nSize);
510     //is.read((char*)&v[0], nSize * sizeof(T));
511
512     // Limit size per read so bogus size value won't cause out of memory
513     v.clear();
514     unsigned int nSize = ReadCompactSize(is);
515     unsigned int i = 0;
516     while (i < nSize)
517     {
518         unsigned int blk = std::min(nSize - i, (unsigned int)(1 + 4999999 / sizeof(T)));
519         v.resize(i + blk);
520         is.read((char*)&v[i], blk * sizeof(T));
521         i += blk;
522     }
523 }
524
525 template<typename Stream, typename T, typename A>
526 void Unserialize_impl(Stream& is, std::vector<T, A>& v, int nType, int nVersion, const boost::false_type&)
527 {
528     //unsigned int nSize = ReadCompactSize(is);
529     //v.resize(nSize);
530     //for (std::vector<T, A>::iterator vi = v.begin(); vi != v.end(); ++vi)
531     //    Unserialize(is, (*vi), nType, nVersion);
532
533     v.clear();
534     unsigned int nSize = ReadCompactSize(is);
535     unsigned int i = 0;
536     unsigned int nMid = 0;
537     while (nMid < nSize)
538     {
539         nMid += 5000000 / sizeof(T);
540         if (nMid > nSize)
541             nMid = nSize;
542         v.resize(nMid);
543         for (; i < nMid; i++)
544             Unserialize(is, v[i], nType, nVersion);
545     }
546 }
547
548 template<typename Stream, typename T, typename A>
549 inline void Unserialize(Stream& is, std::vector<T, A>& v, int nType, int nVersion)
550 {
551     Unserialize_impl(is, v, nType, nVersion, boost::is_fundamental<T>());
552 }
553
554
555
556 //
557 // others derived from vector
558 //
559 inline unsigned int GetSerializeSize(const CScript& v, int nType, int nVersion)
560 {
561     return GetSerializeSize((const std::vector<unsigned char>&)v, nType, nVersion);
562 }
563
564 template<typename Stream>
565 void Serialize(Stream& os, const CScript& v, int nType, int nVersion)
566 {
567     Serialize(os, (const std::vector<unsigned char>&)v, nType, nVersion);
568 }
569
570 template<typename Stream>
571 void Unserialize(Stream& is, CScript& v, int nType, int nVersion)
572 {
573     Unserialize(is, (std::vector<unsigned char>&)v, nType, nVersion);
574 }
575
576
577
578 //
579 // pair
580 //
581 template<typename K, typename T>
582 unsigned int GetSerializeSize(const std::pair<K, T>& item, int nType, int nVersion)
583 {
584     return GetSerializeSize(item.first, nType, nVersion) + GetSerializeSize(item.second, nType, nVersion);
585 }
586
587 template<typename Stream, typename K, typename T>
588 void Serialize(Stream& os, const std::pair<K, T>& item, int nType, int nVersion)
589 {
590     Serialize(os, item.first, nType, nVersion);
591     Serialize(os, item.second, nType, nVersion);
592 }
593
594 template<typename Stream, typename K, typename T>
595 void Unserialize(Stream& is, std::pair<K, T>& item, int nType, int nVersion)
596 {
597     Unserialize(is, item.first, nType, nVersion);
598     Unserialize(is, item.second, nType, nVersion);
599 }
600
601
602
603 //
604 // 3 tuple
605 //
606 template<typename T0, typename T1, typename T2>
607 unsigned int GetSerializeSize(const boost::tuple<T0, T1, T2>& item, int nType, int nVersion)
608 {
609     unsigned int nSize = 0;
610     nSize += GetSerializeSize(boost::get<0>(item), nType, nVersion);
611     nSize += GetSerializeSize(boost::get<1>(item), nType, nVersion);
612     nSize += GetSerializeSize(boost::get<2>(item), nType, nVersion);
613     return nSize;
614 }
615
616 template<typename Stream, typename T0, typename T1, typename T2>
617 void Serialize(Stream& os, const boost::tuple<T0, T1, T2>& item, int nType, int nVersion)
618 {
619     Serialize(os, boost::get<0>(item), nType, nVersion);
620     Serialize(os, boost::get<1>(item), nType, nVersion);
621     Serialize(os, boost::get<2>(item), nType, nVersion);
622 }
623
624 template<typename Stream, typename T0, typename T1, typename T2>
625 void Unserialize(Stream& is, boost::tuple<T0, T1, T2>& item, int nType, int nVersion)
626 {
627     Unserialize(is, boost::get<0>(item), nType, nVersion);
628     Unserialize(is, boost::get<1>(item), nType, nVersion);
629     Unserialize(is, boost::get<2>(item), nType, nVersion);
630 }
631
632
633
634 //
635 // 4 tuple
636 //
637 template<typename T0, typename T1, typename T2, typename T3>
638 unsigned int GetSerializeSize(const boost::tuple<T0, T1, T2, T3>& item, int nType, int nVersion)
639 {
640     unsigned int nSize = 0;
641     nSize += GetSerializeSize(boost::get<0>(item), nType, nVersion);
642     nSize += GetSerializeSize(boost::get<1>(item), nType, nVersion);
643     nSize += GetSerializeSize(boost::get<2>(item), nType, nVersion);
644     nSize += GetSerializeSize(boost::get<3>(item), nType, nVersion);
645     return nSize;
646 }
647
648 template<typename Stream, typename T0, typename T1, typename T2, typename T3>
649 void Serialize(Stream& os, const boost::tuple<T0, T1, T2, T3>& item, int nType, int nVersion)
650 {
651     Serialize(os, boost::get<0>(item), nType, nVersion);
652     Serialize(os, boost::get<1>(item), nType, nVersion);
653     Serialize(os, boost::get<2>(item), nType, nVersion);
654     Serialize(os, boost::get<3>(item), nType, nVersion);
655 }
656
657 template<typename Stream, typename T0, typename T1, typename T2, typename T3>
658 void Unserialize(Stream& is, boost::tuple<T0, T1, T2, T3>& item, int nType, int nVersion)
659 {
660     Unserialize(is, boost::get<0>(item), nType, nVersion);
661     Unserialize(is, boost::get<1>(item), nType, nVersion);
662     Unserialize(is, boost::get<2>(item), nType, nVersion);
663     Unserialize(is, boost::get<3>(item), nType, nVersion);
664 }
665
666
667
668 //
669 // map
670 //
671 template<typename K, typename T, typename Pred, typename A>
672 unsigned int GetSerializeSize(const std::map<K, T, Pred, A>& m, int nType, int nVersion)
673 {
674     unsigned int nSize = GetSizeOfCompactSize(m.size());
675     for (typename std::map<K, T, Pred, A>::const_iterator mi = m.begin(); mi != m.end(); ++mi)
676         nSize += GetSerializeSize((*mi), nType, nVersion);
677     return nSize;
678 }
679
680 template<typename Stream, typename K, typename T, typename Pred, typename A>
681 void Serialize(Stream& os, const std::map<K, T, Pred, A>& m, int nType, int nVersion)
682 {
683     WriteCompactSize(os, m.size());
684     for (typename std::map<K, T, Pred, A>::const_iterator mi = m.begin(); mi != m.end(); ++mi)
685         Serialize(os, (*mi), nType, nVersion);
686 }
687
688 template<typename Stream, typename K, typename T, typename Pred, typename A>
689 void Unserialize(Stream& is, std::map<K, T, Pred, A>& m, int nType, int nVersion)
690 {
691     m.clear();
692     unsigned int nSize = ReadCompactSize(is);
693     typename std::map<K, T, Pred, A>::iterator mi = m.begin();
694     for (unsigned int i = 0; i < nSize; i++)
695     {
696         std::pair<K, T> item;
697         Unserialize(is, item, nType, nVersion);
698         mi = m.insert(mi, item);
699     }
700 }
701
702
703
704 //
705 // set
706 //
707 template<typename K, typename Pred, typename A>
708 unsigned int GetSerializeSize(const std::set<K, Pred, A>& m, int nType, int nVersion)
709 {
710     unsigned int nSize = GetSizeOfCompactSize(m.size());
711     for (typename std::set<K, Pred, A>::const_iterator it = m.begin(); it != m.end(); ++it)
712         nSize += GetSerializeSize((*it), nType, nVersion);
713     return nSize;
714 }
715
716 template<typename Stream, typename K, typename Pred, typename A>
717 void Serialize(Stream& os, const std::set<K, Pred, A>& m, int nType, int nVersion)
718 {
719     WriteCompactSize(os, m.size());
720     for (typename std::set<K, Pred, A>::const_iterator it = m.begin(); it != m.end(); ++it)
721         Serialize(os, (*it), nType, nVersion);
722 }
723
724 template<typename Stream, typename K, typename Pred, typename A>
725 void Unserialize(Stream& is, std::set<K, Pred, A>& m, int nType, int nVersion)
726 {
727     m.clear();
728     unsigned int nSize = ReadCompactSize(is);
729     typename std::set<K, Pred, A>::iterator it = m.begin();
730     for (unsigned int i = 0; i < nSize; i++)
731     {
732         K key;
733         Unserialize(is, key, nType, nVersion);
734         it = m.insert(it, key);
735     }
736 }
737
738
739
740 //
741 // Support for IMPLEMENT_SERIALIZE and READWRITE macro
742 //
743 class CSerActionGetSerializeSize { };
744 class CSerActionSerialize { };
745 class CSerActionUnserialize { };
746
747 template<typename Stream, typename T>
748 inline unsigned int SerReadWrite(Stream& s, const T& obj, int nType, int nVersion, CSerActionGetSerializeSize ser_action)
749 {
750     return ::GetSerializeSize(obj, nType, nVersion);
751 }
752
753 template<typename Stream, typename T>
754 inline unsigned int SerReadWrite(Stream& s, const T& obj, int nType, int nVersion, CSerActionSerialize ser_action)
755 {
756     ::Serialize(s, obj, nType, nVersion);
757     return 0;
758 }
759
760 template<typename Stream, typename T>
761 inline unsigned int SerReadWrite(Stream& s, T& obj, int nType, int nVersion, CSerActionUnserialize ser_action)
762 {
763     ::Unserialize(s, obj, nType, nVersion);
764     return 0;
765 }
766
767 struct ser_streamplaceholder
768 {
769     int nType;
770     int nVersion;
771 };
772
773
774
775
776
777
778
779
780
781 //
782 // Allocator that locks its contents from being paged
783 // out of memory and clears its contents before deletion.
784 //
785 template<typename T>
786 struct secure_allocator : public std::allocator<T>
787 {
788     // MSVC8 default copy constructor is broken
789     typedef std::allocator<T> base;
790     typedef typename base::size_type size_type;
791     typedef typename base::difference_type  difference_type;
792     typedef typename base::pointer pointer;
793     typedef typename base::const_pointer const_pointer;
794     typedef typename base::reference reference;
795     typedef typename base::const_reference const_reference;
796     typedef typename base::value_type value_type;
797     secure_allocator() throw() {}
798     secure_allocator(const secure_allocator& a) throw() : base(a) {}
799     template <typename U>
800     secure_allocator(const secure_allocator<U>& a) throw() : base(a) {}
801     ~secure_allocator() throw() {}
802     template<typename _Other> struct rebind
803     { typedef secure_allocator<_Other> other; };
804
805     T* allocate(std::size_t n, const void *hint = 0)
806     {
807         T *p;
808         p = std::allocator<T>::allocate(n, hint);
809         if (p != NULL)
810             mlock(p, sizeof(T) * n);
811         return p;
812     }
813
814     void deallocate(T* p, std::size_t n)
815     {
816         if (p != NULL)
817         {
818             memset(p, 0, sizeof(T) * n);
819             munlock(p, sizeof(T) * n);
820         }
821         std::allocator<T>::deallocate(p, n);
822     }
823 };
824
825
826
827 //
828 // Double ended buffer combining vector and stream-like interfaces.
829 // >> and << read and write unformatted data using the above serialization templates.
830 // Fills with data in linear time; some stringstream implementations take N^2 time.
831 //
832 class CDataStream
833 {
834 protected:
835     typedef std::vector<char, secure_allocator<char> > vector_type;
836     vector_type vch;
837     unsigned int nReadPos;
838     short state;
839     short exceptmask;
840 public:
841     int nType;
842     int nVersion;
843
844     typedef vector_type::allocator_type   allocator_type;
845     typedef vector_type::size_type        size_type;
846     typedef vector_type::difference_type  difference_type;
847     typedef vector_type::reference        reference;
848     typedef vector_type::const_reference  const_reference;
849     typedef vector_type::value_type       value_type;
850     typedef vector_type::iterator         iterator;
851     typedef vector_type::const_iterator   const_iterator;
852     typedef vector_type::reverse_iterator reverse_iterator;
853
854     explicit CDataStream(int nTypeIn=SER_NETWORK, int nVersionIn=VERSION)
855     {
856         Init(nTypeIn, nVersionIn);
857     }
858
859     CDataStream(const_iterator pbegin, const_iterator pend, int nTypeIn=SER_NETWORK, int nVersionIn=VERSION) : vch(pbegin, pend)
860     {
861         Init(nTypeIn, nVersionIn);
862     }
863
864 #if !defined(_MSC_VER) || _MSC_VER >= 1300
865     CDataStream(const char* pbegin, const char* pend, int nTypeIn=SER_NETWORK, int nVersionIn=VERSION) : vch(pbegin, pend)
866     {
867         Init(nTypeIn, nVersionIn);
868     }
869 #endif
870
871     CDataStream(const vector_type& vchIn, int nTypeIn=SER_NETWORK, int nVersionIn=VERSION) : vch(vchIn.begin(), vchIn.end())
872     {
873         Init(nTypeIn, nVersionIn);
874     }
875
876     CDataStream(const std::vector<char>& vchIn, int nTypeIn=SER_NETWORK, int nVersionIn=VERSION) : vch(vchIn.begin(), vchIn.end())
877     {
878         Init(nTypeIn, nVersionIn);
879     }
880
881     CDataStream(const std::vector<unsigned char>& vchIn, int nTypeIn=SER_NETWORK, int nVersionIn=VERSION) : vch((char*)&vchIn.begin()[0], (char*)&vchIn.end()[0])
882     {
883         Init(nTypeIn, nVersionIn);
884     }
885
886     void Init(int nTypeIn=SER_NETWORK, int nVersionIn=VERSION)
887     {
888         nReadPos = 0;
889         nType = nTypeIn;
890         nVersion = nVersionIn;
891         state = 0;
892         exceptmask = std::ios::badbit | std::ios::failbit;
893     }
894
895     CDataStream& operator+=(const CDataStream& b)
896     {
897         vch.insert(vch.end(), b.begin(), b.end());
898         return *this;
899     }
900
901     friend CDataStream operator+(const CDataStream& a, const CDataStream& b)
902     {
903         CDataStream ret = a;
904         ret += b;
905         return (ret);
906     }
907
908     std::string str() const
909     {
910         return (std::string(begin(), end()));
911     }
912
913
914     //
915     // Vector subset
916     //
917     const_iterator begin() const                     { return vch.begin() + nReadPos; }
918     iterator begin()                                 { return vch.begin() + nReadPos; }
919     const_iterator end() const                       { return vch.end(); }
920     iterator end()                                   { return vch.end(); }
921     size_type size() const                           { return vch.size() - nReadPos; }
922     bool empty() const                               { return vch.size() == nReadPos; }
923     void resize(size_type n, value_type c=0)         { vch.resize(n + nReadPos, c); }
924     void reserve(size_type n)                        { vch.reserve(n + nReadPos); }
925     const_reference operator[](size_type pos) const  { return vch[pos + nReadPos]; }
926     reference operator[](size_type pos)              { return vch[pos + nReadPos]; }
927     void clear()                                     { vch.clear(); nReadPos = 0; }
928     iterator insert(iterator it, const char& x=char()) { return vch.insert(it, x); }
929     void insert(iterator it, size_type n, const char& x) { vch.insert(it, n, x); }
930
931     void insert(iterator it, const_iterator first, const_iterator last)
932     {
933         if (it == vch.begin() + nReadPos && last - first <= nReadPos)
934         {
935             // special case for inserting at the front when there's room
936             nReadPos -= (last - first);
937             memcpy(&vch[nReadPos], &first[0], last - first);
938         }
939         else
940             vch.insert(it, first, last);
941     }
942
943     void insert(iterator it, std::vector<char>::const_iterator first, std::vector<char>::const_iterator last)
944     {
945         if (it == vch.begin() + nReadPos && last - first <= nReadPos)
946         {
947             // special case for inserting at the front when there's room
948             nReadPos -= (last - first);
949             memcpy(&vch[nReadPos], &first[0], last - first);
950         }
951         else
952             vch.insert(it, first, last);
953     }
954
955 #if !defined(_MSC_VER) || _MSC_VER >= 1300
956     void insert(iterator it, const char* first, const char* last)
957     {
958         if (it == vch.begin() + nReadPos && last - first <= nReadPos)
959         {
960             // special case for inserting at the front when there's room
961             nReadPos -= (last - first);
962             memcpy(&vch[nReadPos], &first[0], last - first);
963         }
964         else
965             vch.insert(it, first, last);
966     }
967 #endif
968
969     iterator erase(iterator it)
970     {
971         if (it == vch.begin() + nReadPos)
972         {
973             // special case for erasing from the front
974             if (++nReadPos >= vch.size())
975             {
976                 // whenever we reach the end, we take the opportunity to clear the buffer
977                 nReadPos = 0;
978                 return vch.erase(vch.begin(), vch.end());
979             }
980             return vch.begin() + nReadPos;
981         }
982         else
983             return vch.erase(it);
984     }
985
986     iterator erase(iterator first, iterator last)
987     {
988         if (first == vch.begin() + nReadPos)
989         {
990             // special case for erasing from the front
991             if (last == vch.end())
992             {
993                 nReadPos = 0;
994                 return vch.erase(vch.begin(), vch.end());
995             }
996             else
997             {
998                 nReadPos = (last - vch.begin());
999                 return last;
1000             }
1001         }
1002         else
1003             return vch.erase(first, last);
1004     }
1005
1006     inline void Compact()
1007     {
1008         vch.erase(vch.begin(), vch.begin() + nReadPos);
1009         nReadPos = 0;
1010     }
1011
1012     bool Rewind(size_type n)
1013     {
1014         // Rewind by n characters if the buffer hasn't been compacted yet
1015         if (n > nReadPos)
1016             return false;
1017         nReadPos -= n;
1018         return true;
1019     }
1020
1021
1022     //
1023     // Stream subset
1024     //
1025     void setstate(short bits, const char* psz)
1026     {
1027         state |= bits;
1028         if (state & exceptmask)
1029             throw std::ios_base::failure(psz);
1030     }
1031
1032     bool eof() const             { return size() == 0; }
1033     bool fail() const            { return state & (std::ios::badbit | std::ios::failbit); }
1034     bool good() const            { return !eof() && (state == 0); }
1035     void clear(short n)          { state = n; }  // name conflict with vector clear()
1036     short exceptions()           { return exceptmask; }
1037     short exceptions(short mask) { short prev = exceptmask; exceptmask = mask; setstate(0, "CDataStream"); return prev; }
1038     CDataStream* rdbuf()         { return this; }
1039     int in_avail()               { return size(); }
1040
1041     void SetType(int n)          { nType = n; }
1042     int GetType()                { return nType; }
1043     void SetVersion(int n)       { nVersion = n; }
1044     int GetVersion()             { return nVersion; }
1045     void ReadVersion()           { *this >> nVersion; }
1046     void WriteVersion()          { *this << nVersion; }
1047
1048     CDataStream& read(char* pch, int nSize)
1049     {
1050         // Read from the beginning of the buffer
1051         assert(nSize >= 0);
1052         unsigned int nReadPosNext = nReadPos + nSize;
1053         if (nReadPosNext >= vch.size())
1054         {
1055             if (nReadPosNext > vch.size())
1056             {
1057                 setstate(std::ios::failbit, "CDataStream::read() : end of data");
1058                 memset(pch, 0, nSize);
1059                 nSize = vch.size() - nReadPos;
1060             }
1061             memcpy(pch, &vch[nReadPos], nSize);
1062             nReadPos = 0;
1063             vch.clear();
1064             return (*this);
1065         }
1066         memcpy(pch, &vch[nReadPos], nSize);
1067         nReadPos = nReadPosNext;
1068         return (*this);
1069     }
1070
1071     CDataStream& ignore(int nSize)
1072     {
1073         // Ignore from the beginning of the buffer
1074         assert(nSize >= 0);
1075         unsigned int nReadPosNext = nReadPos + nSize;
1076         if (nReadPosNext >= vch.size())
1077         {
1078             if (nReadPosNext > vch.size())
1079             {
1080                 setstate(std::ios::failbit, "CDataStream::ignore() : end of data");
1081                 nSize = vch.size() - nReadPos;
1082             }
1083             nReadPos = 0;
1084             vch.clear();
1085             return (*this);
1086         }
1087         nReadPos = nReadPosNext;
1088         return (*this);
1089     }
1090
1091     CDataStream& write(const char* pch, int nSize)
1092     {
1093         // Write to the end of the buffer
1094         assert(nSize >= 0);
1095         vch.insert(vch.end(), pch, pch + nSize);
1096         return (*this);
1097     }
1098
1099     template<typename Stream>
1100     void Serialize(Stream& s, int nType=0, int nVersion=VERSION) const
1101     {
1102         // Special case: stream << stream concatenates like stream += stream
1103         if (!vch.empty())
1104             s.write((char*)&vch[0], vch.size() * sizeof(vch[0]));
1105     }
1106
1107     template<typename T>
1108     unsigned int GetSerializeSize(const T& obj)
1109     {
1110         // Tells the size of the object if serialized to this stream
1111         return ::GetSerializeSize(obj, nType, nVersion);
1112     }
1113
1114     template<typename T>
1115     CDataStream& operator<<(const T& obj)
1116     {
1117         // Serialize to this stream
1118         ::Serialize(*this, obj, nType, nVersion);
1119         return (*this);
1120     }
1121
1122     template<typename T>
1123     CDataStream& operator>>(T& obj)
1124     {
1125         // Unserialize from this stream
1126         ::Unserialize(*this, obj, nType, nVersion);
1127         return (*this);
1128     }
1129 };
1130
1131 #ifdef TESTCDATASTREAM
1132 // VC6sp6
1133 // CDataStream:
1134 // n=1000       0 seconds
1135 // n=2000       0 seconds
1136 // n=4000       0 seconds
1137 // n=8000       0 seconds
1138 // n=16000      0 seconds
1139 // n=32000      0 seconds
1140 // n=64000      1 seconds
1141 // n=128000     1 seconds
1142 // n=256000     2 seconds
1143 // n=512000     4 seconds
1144 // n=1024000    8 seconds
1145 // n=2048000    16 seconds
1146 // n=4096000    32 seconds
1147 // stringstream:
1148 // n=1000       1 seconds
1149 // n=2000       1 seconds
1150 // n=4000       13 seconds
1151 // n=8000       87 seconds
1152 // n=16000      400 seconds
1153 // n=32000      1660 seconds
1154 // n=64000      6749 seconds
1155 // n=128000     27241 seconds
1156 // n=256000     109804 seconds
1157 #include <iostream>
1158 int main(int argc, char *argv[])
1159 {
1160     vector<unsigned char> vch(0xcc, 250);
1161     printf("CDataStream:\n");
1162     for (int n = 1000; n <= 4500000; n *= 2)
1163     {
1164         CDataStream ss;
1165         time_t nStart = time(NULL);
1166         for (int i = 0; i < n; i++)
1167             ss.write((char*)&vch[0], vch.size());
1168         printf("n=%-10d %d seconds\n", n, time(NULL) - nStart);
1169     }
1170     printf("stringstream:\n");
1171     for (int n = 1000; n <= 4500000; n *= 2)
1172     {
1173         stringstream ss;
1174         time_t nStart = time(NULL);
1175         for (int i = 0; i < n; i++)
1176             ss.write((char*)&vch[0], vch.size());
1177         printf("n=%-10d %d seconds\n", n, time(NULL) - nStart);
1178     }
1179 }
1180 #endif
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191 //
1192 // Automatic closing wrapper for FILE*
1193 //  - Will automatically close the file when it goes out of scope if not null.
1194 //  - If you're returning the file pointer, return file.release().
1195 //  - If you need to close the file early, use file.fclose() instead of fclose(file).
1196 //
1197 class CAutoFile
1198 {
1199 protected:
1200     FILE* file;
1201     short state;
1202     short exceptmask;
1203 public:
1204     int nType;
1205     int nVersion;
1206
1207     typedef FILE element_type;
1208
1209     CAutoFile(FILE* filenew=NULL, int nTypeIn=SER_DISK, int nVersionIn=VERSION)
1210     {
1211         file = filenew;
1212         nType = nTypeIn;
1213         nVersion = nVersionIn;
1214         state = 0;
1215         exceptmask = std::ios::badbit | std::ios::failbit;
1216     }
1217
1218     ~CAutoFile()
1219     {
1220         fclose();
1221     }
1222
1223     void fclose()
1224     {
1225         if (file != NULL && file != stdin && file != stdout && file != stderr)
1226             ::fclose(file);
1227         file = NULL;
1228     }
1229
1230     FILE* release()             { FILE* ret = file; file = NULL; return ret; }
1231     operator FILE*()            { return file; }
1232     FILE* operator->()          { return file; }
1233     FILE& operator*()           { return *file; }
1234     FILE** operator&()          { return &file; }
1235     FILE* operator=(FILE* pnew) { return file = pnew; }
1236     bool operator!()            { return (file == NULL); }
1237
1238
1239     //
1240     // Stream subset
1241     //
1242     void setstate(short bits, const char* psz)
1243     {
1244         state |= bits;
1245         if (state & exceptmask)
1246             throw std::ios_base::failure(psz);
1247     }
1248
1249     bool fail() const            { return state & (std::ios::badbit | std::ios::failbit); }
1250     bool good() const            { return state == 0; }
1251     void clear(short n = 0)      { state = n; }
1252     short exceptions()           { return exceptmask; }
1253     short exceptions(short mask) { short prev = exceptmask; exceptmask = mask; setstate(0, "CAutoFile"); return prev; }
1254
1255     void SetType(int n)          { nType = n; }
1256     int GetType()                { return nType; }
1257     void SetVersion(int n)       { nVersion = n; }
1258     int GetVersion()             { return nVersion; }
1259     void ReadVersion()           { *this >> nVersion; }
1260     void WriteVersion()          { *this << nVersion; }
1261
1262     CAutoFile& read(char* pch, int nSize)
1263     {
1264         if (!file)
1265             throw std::ios_base::failure("CAutoFile::read : file handle is NULL");
1266         if (fread(pch, 1, nSize, file) != nSize)
1267             setstate(std::ios::failbit, feof(file) ? "CAutoFile::read : end of file" : "CAutoFile::read : fread failed");
1268         return (*this);
1269     }
1270
1271     CAutoFile& write(const char* pch, int nSize)
1272     {
1273         if (!file)
1274             throw std::ios_base::failure("CAutoFile::write : file handle is NULL");
1275         if (fwrite(pch, 1, nSize, file) != nSize)
1276             setstate(std::ios::failbit, "CAutoFile::write : write failed");
1277         return (*this);
1278     }
1279
1280     template<typename T>
1281     unsigned int GetSerializeSize(const T& obj)
1282     {
1283         // Tells the size of the object if serialized to this stream
1284         return ::GetSerializeSize(obj, nType, nVersion);
1285     }
1286
1287     template<typename T>
1288     CAutoFile& operator<<(const T& obj)
1289     {
1290         // Serialize to this stream
1291         if (!file)
1292             throw std::ios_base::failure("CAutoFile::operator<< : file handle is NULL");
1293         ::Serialize(*this, obj, nType, nVersion);
1294         return (*this);
1295     }
1296
1297     template<typename T>
1298     CAutoFile& operator>>(T& obj)
1299     {
1300         // Unserialize from this stream
1301         if (!file)
1302             throw std::ios_base::failure("CAutoFile::operator>> : file handle is NULL");
1303         ::Unserialize(*this, obj, nType, nVersion);
1304         return (*this);
1305     }
1306 };
1307
1308 #endif