1
0
forked from 0ad/0ad
0ad/source/network/Serialization.h
janwas 0bb0df5b2c # new year's cleanup (reduce dependencies, clean up headers)
- remove headers always included from PCH
- nommgr.h is only included ifdef REDEFINED_NEW (allows leaving out the
mmgr stuff)
- in lib/*.cpp, moved the corresponding include file to right behind the
PCH (catches headers that aren't compilable by themselves)
- byte_order no longer depends on SDL
- add debug_level (another means of filtering debug output; needed for
thesis)
- split posix stuff up into subdirs (lib/posix and sysdep/win/wposix).
makes including only some of the modules (e.g. sockets, time) much
easier.

This was SVN commit r4728.
2007-01-01 21:25:47 +00:00

89 lines
2.3 KiB
C++

#ifndef _Serialization_H
#define _Serialization_H
#include "lib/lib.h"
#define Serialize_int_1(_pos, _val) \
STMT( *((_pos)++) = (u8)((_val)&0xff); )
#define Serialize_int_2(_pos, _val) STMT(\
Serialize_int_1(_pos, (_val)>>8); \
Serialize_int_1(_pos, (_val)); \
)
#define Serialize_int_3(_pos, _val) STMT(\
Serialize_int_1(_pos, (_val)>>16); \
Serialize_int_2(_pos, (_val)); \
)
#define Serialize_int_4(_pos, _val) STMT(\
Serialize_int_1(_pos, (_val)>>24); \
Serialize_int_3(_pos, (_val)); \
)
#define Serialize_int_8(_pos, _val) STMT(\
Serialize_int_4(_pos, (_val)>>32); \
Serialize_int_4(_pos, (_val)); \
)
#define __shift_de(_pos, _val) STMT( \
(_val) <<= 8; \
(_val) += *((_pos)++); )
#define Deserialize_int_1(_pos, _val) STMT(\
(_val) = *((_pos)++); )
#define Deserialize_int_2(_pos, _val) STMT(\
Deserialize_int_1(_pos, _val); \
__shift_de(_pos, _val); )
#define Deserialize_int_3(_pos, _val) STMT(\
Deserialize_int_2(_pos, _val); \
__shift_de(_pos, _val); )
#define Deserialize_int_4(_pos, _val) STMT(\
Deserialize_int_3(_pos, _val); \
__shift_de(_pos, _val); )
#define Deserialize_int_8(_pos, _val) STMT(\
uint32 _v1; uint32 _v2; \
Deserialize_int_4(_pos, _v1); \
Deserialize_int_4(_pos, _v2); \
_val = _v1; \
_val <<= 32; /* janwas: careful! (uint32 << 32) = 0 */ \
_val |= _v2; )
/**
* An interface for serializable objects. For a serializable object to be usable
* as a network message field, it must have a constructor without arguments.
*/
class ISerializable
{
public:
/**
* Return the length of the serialized form of this object
*/
virtual uint GetSerializedLength() const = 0;
/**
* Serialize the object into the passed buffer.
*
* @return a pointer to the location in the buffer right after the
* serialized object
*/
virtual u8 *Serialize(u8 *buffer) const = 0;
/**
* Deserialize the object (i.e. read in data from the buffer and initialize
* the object's fields). Note that it is up to the deserializer to detect
* errors in data format.
*
* @param buffer A pointer pointing to the start of the serialized data.
* @param end A pointer to the end of the message.
*
* @returns a pointer to the location in the buffer right after the
* serialized object, or NULL if there was a data format error
*/
virtual const u8 *Deserialize(const u8 *buffer, const u8 *end) = 0;
};
#endif