2003-11-25 03:11:50 +01:00
|
|
|
#ifndef _Serialization_H
|
|
|
|
#define _Serialization_H
|
|
|
|
|
2006-06-02 04:10:27 +02:00
|
|
|
#include "lib/lib.h"
|
2003-11-25 03:11:50 +01:00
|
|
|
|
2003-11-30 17:36:43 +01:00
|
|
|
#define Serialize_int_1(_pos, _val) \
|
2005-06-20 17:14:36 +02:00
|
|
|
STMT( *((_pos)++) = (u8)((_val)&0xff); )
|
2003-11-30 17:36:43 +01:00
|
|
|
|
|
|
|
#define Serialize_int_2(_pos, _val) STMT(\
|
2005-06-20 17:14:36 +02:00
|
|
|
Serialize_int_1(_pos, (_val)>>8); \
|
|
|
|
Serialize_int_1(_pos, (_val)); \
|
2003-11-30 17:36:43 +01:00
|
|
|
)
|
|
|
|
|
|
|
|
#define Serialize_int_3(_pos, _val) STMT(\
|
2005-06-20 17:14:36 +02:00
|
|
|
Serialize_int_1(_pos, (_val)>>16); \
|
|
|
|
Serialize_int_2(_pos, (_val)); \
|
2003-11-30 17:36:43 +01:00
|
|
|
)
|
|
|
|
|
|
|
|
#define Serialize_int_4(_pos, _val) STMT(\
|
2005-06-20 17:14:36 +02:00
|
|
|
Serialize_int_1(_pos, (_val)>>24); \
|
|
|
|
Serialize_int_3(_pos, (_val)); \
|
2003-11-30 17:36:43 +01:00
|
|
|
)
|
|
|
|
|
|
|
|
#define Serialize_int_8(_pos, _val) STMT(\
|
2005-06-20 17:14:36 +02:00
|
|
|
Serialize_int_4(_pos, (_val)>>32); \
|
|
|
|
Serialize_int_4(_pos, (_val)); \
|
2003-11-30 17:36:43 +01:00
|
|
|
)
|
|
|
|
|
2004-03-08 03:07:31 +01:00
|
|
|
#define __shift_de(_pos, _val) STMT( \
|
|
|
|
(_val) <<= 8; \
|
2003-11-30 17:36:43 +01:00
|
|
|
(_val) += *((_pos)++); )
|
|
|
|
|
2004-03-08 03:07:31 +01:00
|
|
|
#define Deserialize_int_1(_pos, _val) STMT(\
|
|
|
|
(_val) = *((_pos)++); )
|
|
|
|
|
2003-11-30 17:36:43 +01:00
|
|
|
#define Deserialize_int_2(_pos, _val) STMT(\
|
|
|
|
Deserialize_int_1(_pos, _val); \
|
2004-03-08 03:07:31 +01:00
|
|
|
__shift_de(_pos, _val); )
|
2003-11-30 17:36:43 +01:00
|
|
|
|
|
|
|
#define Deserialize_int_3(_pos, _val) STMT(\
|
|
|
|
Deserialize_int_2(_pos, _val); \
|
2004-03-08 03:07:31 +01:00
|
|
|
__shift_de(_pos, _val); )
|
2003-11-30 17:36:43 +01:00
|
|
|
|
|
|
|
#define Deserialize_int_4(_pos, _val) STMT(\
|
|
|
|
Deserialize_int_3(_pos, _val); \
|
2004-03-08 03:07:31 +01:00
|
|
|
__shift_de(_pos, _val); )
|
2003-11-30 17:36:43 +01:00
|
|
|
|
|
|
|
#define Deserialize_int_8(_pos, _val) STMT(\
|
2004-03-08 03:07:31 +01:00
|
|
|
uint32 _v1; uint32 _v2; \
|
|
|
|
Deserialize_int_4(_pos, _v1); \
|
|
|
|
Deserialize_int_4(_pos, _v2); \
|
2004-11-18 21:51:49 +01:00
|
|
|
_val = _v1; \
|
|
|
|
_val <<= 32; /* janwas: careful! (uint32 << 32) = 0 */ \
|
|
|
|
_val |= _v2; )
|
2003-11-30 17:36:43 +01:00
|
|
|
|
|
|
|
/**
|
|
|
|
* 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
|
2003-11-25 03:11:50 +01:00
|
|
|
{
|
2003-11-30 17:36:43 +01:00
|
|
|
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;
|
|
|
|
};
|
2003-11-25 03:11:50 +01:00
|
|
|
|
|
|
|
#endif
|