Clean up serialization

This reverts 1a5b4b3 and further functions in serialize.cpp that are unused

The intend for a sane NetworkPacket/stream replacement was good, but a wrapper
class around i/ostream might be more versatile than introducing a new
vector-based serialization class.
This commit is contained in:
SmallJoker 2020-09-20 13:04:01 +02:00 committed by Loïc Blot
parent 79414aa3e5
commit ca5c2dbefa
3 changed files with 0 additions and 915 deletions

@ -32,18 +32,12 @@ public:
void buildTestStrings(); void buildTestStrings();
void testSerializeString(); void testSerializeString();
void testSerializeWideString();
void testSerializeLongString(); void testSerializeLongString();
void testSerializeJsonString(); void testSerializeJsonString();
void testSerializeHex();
void testDeSerializeString(); void testDeSerializeString();
void testDeSerializeWideString();
void testDeSerializeLongString(); void testDeSerializeLongString();
void testStreamRead(); void testStreamRead();
void testStreamWrite(); void testStreamWrite();
void testVecPut();
void testStringLengthLimits();
void testBufReader();
void testFloatFormat(); void testFloatFormat();
std::string teststring2; std::string teststring2;
@ -61,17 +55,11 @@ void TestSerialization::runTests(IGameDef *gamedef)
TEST(testSerializeString); TEST(testSerializeString);
TEST(testDeSerializeString); TEST(testDeSerializeString);
TEST(testSerializeWideString);
TEST(testDeSerializeWideString);
TEST(testSerializeLongString); TEST(testSerializeLongString);
TEST(testDeSerializeLongString); TEST(testDeSerializeLongString);
TEST(testSerializeJsonString); TEST(testSerializeJsonString);
TEST(testSerializeHex);
TEST(testStreamRead); TEST(testStreamRead);
TEST(testStreamWrite); TEST(testStreamWrite);
TEST(testVecPut);
TEST(testStringLengthLimits);
TEST(testBufReader);
TEST(testFloatFormat); TEST(testFloatFormat);
} }
@ -136,50 +124,6 @@ void TestSerialization::testDeSerializeString()
} }
} }
void TestSerialization::testSerializeWideString()
{
// Test blank string
UASSERT(serializeWideString(L"") == mkstr("\0\0"));
// Test basic string
UASSERT(serializeWideString(utf8_to_wide("Hello world!")) ==
mkstr("\0\14\0H\0e\0l\0l\0o\0 \0w\0o\0r\0l\0d\0!"));
// Test character range
UASSERT(serializeWideString(teststring2_w) ==
mkstr("\1\0") + teststring2_w_encoded);
}
void TestSerialization::testDeSerializeWideString()
{
// Test deserialize
{
std::istringstream is(serializeWideString(teststring2_w), std::ios::binary);
UASSERT(deSerializeWideString(is) == teststring2_w);
UASSERT(!is.eof());
is.get();
UASSERT(is.eof());
}
// Test deserialize an incomplete length specifier
{
std::istringstream is(mkstr("\x53"), std::ios::binary);
EXCEPTION_CHECK(SerializationError, deSerializeWideString(is));
}
// Test deserialize a string with an incomplete character
{
std::istringstream is(mkstr("\x00\x07\0a\0b\0c\0d\0e\0f\0"), std::ios::binary);
EXCEPTION_CHECK(SerializationError, deSerializeWideString(is));
}
// Test deserialize a string with incomplete data
{
std::istringstream is(mkstr("\x00\x08\0a\0b\0c\0d\0e\0f"), std::ios::binary);
EXCEPTION_CHECK(SerializationError, deSerializeWideString(is));
}
}
void TestSerialization::testSerializeLongString() void TestSerialization::testSerializeLongString()
{ {
// Test blank string // Test blank string
@ -268,25 +212,6 @@ void TestSerialization::testSerializeJsonString()
UASSERT(is.eof()); UASSERT(is.eof());
} }
void TestSerialization::testSerializeHex()
{
// Test blank string
UASSERT(serializeHexString("") == "");
UASSERT(serializeHexString("", true) == "");
// Test basic string
UASSERT(serializeHexString("Hello world!") ==
"48656c6c6f20776f726c6421");
UASSERT(serializeHexString("Hello world!", true) ==
"48 65 6c 6c 6f 20 77 6f 72 6c 64 21");
// Test binary string
UASSERT(serializeHexString(mkstr("\x00\x0a\xb0\x63\x1f\x00\xff")) ==
"000ab0631f00ff");
UASSERT(serializeHexString(mkstr("\x00\x0a\xb0\x63\x1f\x00\xff"), true) ==
"00 0a b0 63 1f 00 ff");
}
void TestSerialization::testStreamRead() void TestSerialization::testStreamRead()
{ {
@ -376,255 +301,6 @@ void TestSerialization::testStreamWrite()
} }
void TestSerialization::testVecPut()
{
std::vector<u8> buf;
putU8(&buf, 0x11);
putU16(&buf, 0x2233);
putU32(&buf, 0x44556677);
putU64(&buf, 0x8899AABBCCDDEEFFLL);
putS8(&buf, -128);
putS16(&buf, 30000);
putS32(&buf, -6);
putS64(&buf, -43);
putF1000(&buf, 53.53467f);
putF1000(&buf, -300000.32f);
putF1000(&buf, F1000_MIN);
putF1000(&buf, F1000_MAX);
putString(&buf, "foobar!");
putV2S16(&buf, v2s16(500, 500));
putV3S16(&buf, v3s16(4207, 604, -30));
putV2S32(&buf, v2s32(1920, 1080));
putV3S32(&buf, v3s32(-400, 6400054, 290549855));
putWideString(&buf, L"\x02~woof~\x5455");
putV3F1000(&buf, v3f(500, 10024.2f, -192.54f));
putARGB8(&buf, video::SColor(255, 128, 50, 128));
putLongString(&buf, "some longer string here");
putU16(&buf, 0xF00D);
UASSERT(buf.size() == sizeof(test_serialized_data));
UASSERT(!memcmp(&buf[0], test_serialized_data, sizeof(test_serialized_data)));
}
void TestSerialization::testStringLengthLimits()
{
std::vector<u8> buf;
std::string too_long(STRING_MAX_LEN + 1, 'A');
std::string way_too_large(LONG_STRING_MAX_LEN + 1, 'B');
std::wstring too_long_wide(WIDE_STRING_MAX_LEN + 1, L'C');
EXCEPTION_CHECK(SerializationError, putString(&buf, too_long));
putLongString(&buf, too_long);
too_long.resize(too_long.size() - 1);
putString(&buf, too_long);
EXCEPTION_CHECK(SerializationError, putWideString(&buf, too_long_wide));
too_long_wide.resize(too_long_wide.size() - 1);
putWideString(&buf, too_long_wide);
}
void TestSerialization::testBufReader()
{
u8 u8_data;
u16 u16_data;
u32 u32_data;
u64 u64_data;
s8 s8_data;
s16 s16_data;
s32 s32_data;
s64 s64_data;
f32 f32_data, f32_data2, f32_data3, f32_data4;
video::SColor scolor_data;
v2s16 v2s16_data;
v3s16 v3s16_data;
v2s32 v2s32_data;
v3s32 v3s32_data;
v3f v3f_data;
std::string string_data;
std::wstring widestring_data;
std::string longstring_data;
u8 raw_data[10] = {0};
BufReader buf(test_serialized_data, sizeof(test_serialized_data));
// Try reading data like normal
UASSERT(buf.getU8() == 0x11);
UASSERT(buf.getU16() == 0x2233);
UASSERT(buf.getU32() == 0x44556677);
UASSERT(buf.getU64() == 0x8899AABBCCDDEEFFLL);
UASSERT(buf.getS8() == -128);
UASSERT(buf.getS16() == 30000);
UASSERT(buf.getS32() == -6);
UASSERT(buf.getS64() == -43);
UASSERT(buf.getF1000() == 53.534f);
UASSERT(buf.getF1000() == -300000.32f);
UASSERT(buf.getF1000() == F1000_MIN);
UASSERT(buf.getF1000() == F1000_MAX);
UASSERT(buf.getString() == "foobar!");
UASSERT(buf.getV2S16() == v2s16(500, 500));
UASSERT(buf.getV3S16() == v3s16(4207, 604, -30));
UASSERT(buf.getV2S32() == v2s32(1920, 1080));
UASSERT(buf.getV3S32() == v3s32(-400, 6400054, 290549855));
UASSERT(buf.getWideString() == L"\x02~woof~\x5455");
UASSERT(buf.getV3F1000() == v3f(500, 10024.2f, -192.54f));
UASSERT(buf.getARGB8() == video::SColor(255, 128, 50, 128));
UASSERT(buf.getLongString() == "some longer string here");
// Verify the offset and data is unchanged after a failed read
size_t orig_pos = buf.pos;
u32_data = 0;
UASSERT(buf.getU32NoEx(&u32_data) == false);
UASSERT(buf.pos == orig_pos);
UASSERT(u32_data == 0);
// Now try the same for a failed string read
UASSERT(buf.getStringNoEx(&string_data) == false);
UASSERT(buf.pos == orig_pos);
UASSERT(string_data == "");
// Now try the same for a failed string read
UASSERT(buf.getWideStringNoEx(&widestring_data) == false);
UASSERT(buf.pos == orig_pos);
UASSERT(widestring_data == L"");
UASSERT(buf.getU16() == 0xF00D);
UASSERT(buf.remaining() == 0);
// Check to make sure these each blow exceptions as they're supposed to
EXCEPTION_CHECK(SerializationError, buf.getU8());
EXCEPTION_CHECK(SerializationError, buf.getU16());
EXCEPTION_CHECK(SerializationError, buf.getU32());
EXCEPTION_CHECK(SerializationError, buf.getU64());
EXCEPTION_CHECK(SerializationError, buf.getS8());
EXCEPTION_CHECK(SerializationError, buf.getS16());
EXCEPTION_CHECK(SerializationError, buf.getS32());
EXCEPTION_CHECK(SerializationError, buf.getS64());
EXCEPTION_CHECK(SerializationError, buf.getF1000());
EXCEPTION_CHECK(SerializationError, buf.getARGB8());
EXCEPTION_CHECK(SerializationError, buf.getV2S16());
EXCEPTION_CHECK(SerializationError, buf.getV3S16());
EXCEPTION_CHECK(SerializationError, buf.getV2S32());
EXCEPTION_CHECK(SerializationError, buf.getV3S32());
EXCEPTION_CHECK(SerializationError, buf.getV3F1000());
EXCEPTION_CHECK(SerializationError, buf.getString());
EXCEPTION_CHECK(SerializationError, buf.getWideString());
EXCEPTION_CHECK(SerializationError, buf.getLongString());
EXCEPTION_CHECK(SerializationError,
buf.getRawData(raw_data, sizeof(raw_data)));
// See if we can skip backwards
buf.pos = 5;
UASSERT(buf.getRawDataNoEx(raw_data, 3) == true);
UASSERT(raw_data[0] == 0x66);
UASSERT(raw_data[1] == 0x77);
UASSERT(raw_data[2] == 0x88);
UASSERT(buf.getU32() == 0x99AABBCC);
UASSERT(buf.pos == 12);
// Now let's try it all over again using the NoEx variants
buf.pos = 0;
UASSERT(buf.getU8NoEx(&u8_data));
UASSERT(buf.getU16NoEx(&u16_data));
UASSERT(buf.getU32NoEx(&u32_data));
UASSERT(buf.getU64NoEx(&u64_data));
UASSERT(buf.getS8NoEx(&s8_data));
UASSERT(buf.getS16NoEx(&s16_data));
UASSERT(buf.getS32NoEx(&s32_data));
UASSERT(buf.getS64NoEx(&s64_data));
UASSERT(buf.getF1000NoEx(&f32_data));
UASSERT(buf.getF1000NoEx(&f32_data2));
UASSERT(buf.getF1000NoEx(&f32_data3));
UASSERT(buf.getF1000NoEx(&f32_data4));
UASSERT(buf.getStringNoEx(&string_data));
UASSERT(buf.getV2S16NoEx(&v2s16_data));
UASSERT(buf.getV3S16NoEx(&v3s16_data));
UASSERT(buf.getV2S32NoEx(&v2s32_data));
UASSERT(buf.getV3S32NoEx(&v3s32_data));
UASSERT(buf.getWideStringNoEx(&widestring_data));
UASSERT(buf.getV3F1000NoEx(&v3f_data));
UASSERT(buf.getARGB8NoEx(&scolor_data));
UASSERT(buf.getLongStringNoEx(&longstring_data));
// and make sure we got the correct data
UASSERT(u8_data == 0x11);
UASSERT(u16_data == 0x2233);
UASSERT(u32_data == 0x44556677);
UASSERT(u64_data == 0x8899AABBCCDDEEFFLL);
UASSERT(s8_data == -128);
UASSERT(s16_data == 30000);
UASSERT(s32_data == -6);
UASSERT(s64_data == -43);
UASSERT(f32_data == 53.534f);
UASSERT(f32_data2 == -300000.32f);
UASSERT(f32_data3 == F1000_MIN);
UASSERT(f32_data4 == F1000_MAX);
UASSERT(string_data == "foobar!");
UASSERT(v2s16_data == v2s16(500, 500));
UASSERT(v3s16_data == v3s16(4207, 604, -30));
UASSERT(v2s32_data == v2s32(1920, 1080));
UASSERT(v3s32_data == v3s32(-400, 6400054, 290549855));
UASSERT(widestring_data == L"\x02~woof~\x5455");
UASSERT(v3f_data == v3f(500, 10024.2f, -192.54f));
UASSERT(scolor_data == video::SColor(255, 128, 50, 128));
UASSERT(longstring_data == "some longer string here");
UASSERT(buf.remaining() == 2);
UASSERT(buf.getRawDataNoEx(raw_data, 3) == false);
UASSERT(buf.remaining() == 2);
UASSERT(buf.getRawDataNoEx(raw_data, 2) == true);
UASSERT(raw_data[0] == 0xF0);
UASSERT(raw_data[1] == 0x0D);
UASSERT(buf.remaining() == 0);
// Make sure no more available data causes a failure
UASSERT(!buf.getU8NoEx(&u8_data));
UASSERT(!buf.getU16NoEx(&u16_data));
UASSERT(!buf.getU32NoEx(&u32_data));
UASSERT(!buf.getU64NoEx(&u64_data));
UASSERT(!buf.getS8NoEx(&s8_data));
UASSERT(!buf.getS16NoEx(&s16_data));
UASSERT(!buf.getS32NoEx(&s32_data));
UASSERT(!buf.getS64NoEx(&s64_data));
UASSERT(!buf.getF1000NoEx(&f32_data));
UASSERT(!buf.getARGB8NoEx(&scolor_data));
UASSERT(!buf.getV2S16NoEx(&v2s16_data));
UASSERT(!buf.getV3S16NoEx(&v3s16_data));
UASSERT(!buf.getV2S32NoEx(&v2s32_data));
UASSERT(!buf.getV3S32NoEx(&v3s32_data));
UASSERT(!buf.getV3F1000NoEx(&v3f_data));
UASSERT(!buf.getStringNoEx(&string_data));
UASSERT(!buf.getWideStringNoEx(&widestring_data));
UASSERT(!buf.getLongStringNoEx(&longstring_data));
UASSERT(!buf.getRawDataNoEx(raw_data, sizeof(raw_data)));
}
void TestSerialization::testFloatFormat() void TestSerialization::testFloatFormat()
{ {
FloatType type = getFloatSerializationType(); FloatType type = getFloatSerializationType();

@ -30,74 +30,6 @@ with this program; if not, write to the Free Software Foundation, Inc.,
FloatType g_serialize_f32_type = FLOATTYPE_UNKNOWN; FloatType g_serialize_f32_type = FLOATTYPE_UNKNOWN;
////
//// BufReader
////
bool BufReader::getStringNoEx(std::string *val)
{
u16 num_chars;
if (!getU16NoEx(&num_chars))
return false;
if (pos + num_chars > size) {
pos -= sizeof(num_chars);
return false;
}
val->assign((const char *)data + pos, num_chars);
pos += num_chars;
return true;
}
bool BufReader::getWideStringNoEx(std::wstring *val)
{
u16 num_chars;
if (!getU16NoEx(&num_chars))
return false;
if (pos + num_chars * 2 > size) {
pos -= sizeof(num_chars);
return false;
}
for (size_t i = 0; i != num_chars; i++) {
val->push_back(readU16(data + pos));
pos += 2;
}
return true;
}
bool BufReader::getLongStringNoEx(std::string *val)
{
u32 num_chars;
if (!getU32NoEx(&num_chars))
return false;
if (pos + num_chars > size) {
pos -= sizeof(num_chars);
return false;
}
val->assign((const char *)data + pos, num_chars);
pos += num_chars;
return true;
}
bool BufReader::getRawDataNoEx(void *val, size_t len)
{
if (pos + len > size)
return false;
memcpy(val, data + pos, len);
pos += len;
return true;
}
//// ////
//// String //// String
@ -404,284 +336,3 @@ std::string deSerializeJsonStringIfNeeded(std::istream &is)
return tmp_os.str(); return tmp_os.str();
} }
////
//// String/Struct conversions
////
bool deSerializeStringToStruct(std::string valstr,
std::string format, void *out, size_t olen)
{
size_t len = olen;
std::vector<std::string *> strs_alloced;
std::string *str;
char *f, *snext;
size_t pos;
char *s = &valstr[0];
char *buf = new char[len];
char *bufpos = buf;
char *fmtpos, *fmt = &format[0];
while ((f = strtok_r(fmt, ",", &fmtpos)) && s) {
fmt = nullptr;
bool is_unsigned = false;
int width = 0;
char valtype = *f;
width = (int)strtol(f + 1, &f, 10);
if (width && valtype == 's')
valtype = 'i';
switch (valtype) {
case 'u':
is_unsigned = true;
/* FALLTHROUGH */
case 'i':
if (width == 16) {
bufpos += PADDING(bufpos, u16);
if ((bufpos - buf) + sizeof(u16) <= len) {
if (is_unsigned)
*(u16 *)bufpos = (u16)strtoul(s, &s, 10);
else
*(s16 *)bufpos = (s16)strtol(s, &s, 10);
}
bufpos += sizeof(u16);
} else if (width == 32) {
bufpos += PADDING(bufpos, u32);
if ((bufpos - buf) + sizeof(u32) <= len) {
if (is_unsigned)
*(u32 *)bufpos = (u32)strtoul(s, &s, 10);
else
*(s32 *)bufpos = (s32)strtol(s, &s, 10);
}
bufpos += sizeof(u32);
} else if (width == 64) {
bufpos += PADDING(bufpos, u64);
if ((bufpos - buf) + sizeof(u64) <= len) {
if (is_unsigned)
*(u64 *)bufpos = (u64)strtoull(s, &s, 10);
else
*(s64 *)bufpos = (s64)strtoll(s, &s, 10);
}
bufpos += sizeof(u64);
}
s = strchr(s, ',');
break;
case 'b':
snext = strchr(s, ',');
if (snext)
*snext++ = 0;
bufpos += PADDING(bufpos, bool);
if ((bufpos - buf) + sizeof(bool) <= len)
*(bool *)bufpos = is_yes(std::string(s));
bufpos += sizeof(bool);
s = snext;
break;
case 'f':
bufpos += PADDING(bufpos, float);
if ((bufpos - buf) + sizeof(float) <= len)
*(float *)bufpos = strtof(s, &s);
bufpos += sizeof(float);
s = strchr(s, ',');
break;
case 's':
while (*s == ' ' || *s == '\t')
s++;
if (*s++ != '"') //error, expected string
goto fail;
snext = s;
while (snext[0] && !(snext[-1] != '\\' && snext[0] == '"'))
snext++;
*snext++ = 0;
bufpos += PADDING(bufpos, std::string *);
str = new std::string(s);
pos = 0;
while ((pos = str->find("\\\"", pos)) != std::string::npos)
str->erase(pos, 1);
if ((bufpos - buf) + sizeof(std::string *) <= len)
*(std::string **)bufpos = str;
bufpos += sizeof(std::string *);
strs_alloced.push_back(str);
s = *snext ? snext + 1 : nullptr;
break;
case 'v':
while (*s == ' ' || *s == '\t')
s++;
if (*s++ != '(') //error, expected vector
goto fail;
if (width == 2) {
bufpos += PADDING(bufpos, v2f);
if ((bufpos - buf) + sizeof(v2f) <= len) {
v2f *v = (v2f *)bufpos;
v->X = strtof(s, &s);
s++;
v->Y = strtof(s, &s);
}
bufpos += sizeof(v2f);
} else if (width == 3) {
bufpos += PADDING(bufpos, v3f);
if ((bufpos - buf) + sizeof(v3f) <= len) {
v3f *v = (v3f *)bufpos;
v->X = strtof(s, &s);
s++;
v->Y = strtof(s, &s);
s++;
v->Z = strtof(s, &s);
}
bufpos += sizeof(v3f);
}
s = strchr(s, ',');
break;
default: //error, invalid format specifier
goto fail;
}
if (s && *s == ',')
s++;
if ((size_t)(bufpos - buf) > len) //error, buffer too small
goto fail;
}
if (f && *f) { //error, mismatched number of fields and values
fail:
for (size_t i = 0; i != strs_alloced.size(); i++)
delete strs_alloced[i];
delete[] buf;
return false;
}
memcpy(out, buf, olen);
delete[] buf;
return true;
}
// Casts *buf to a signed or unsigned fixed-width integer of 'w' width
#define SIGN_CAST(w, buf) (is_unsigned ? *((u##w *) buf) : *((s##w *) buf))
bool serializeStructToString(std::string *out,
std::string format, void *value)
{
std::ostringstream os;
std::string str;
char *f;
size_t strpos;
char *bufpos = (char *) value;
char *fmtpos, *fmt = &format[0];
while ((f = strtok_r(fmt, ",", &fmtpos))) {
fmt = nullptr;
bool is_unsigned = false;
int width = 0;
char valtype = *f;
width = (int)strtol(f + 1, &f, 10);
if (width && valtype == 's')
valtype = 'i';
switch (valtype) {
case 'u':
is_unsigned = true;
/* FALLTHROUGH */
case 'i':
if (width == 16) {
bufpos += PADDING(bufpos, u16);
os << SIGN_CAST(16, bufpos);
bufpos += sizeof(u16);
} else if (width == 32) {
bufpos += PADDING(bufpos, u32);
os << SIGN_CAST(32, bufpos);
bufpos += sizeof(u32);
} else if (width == 64) {
bufpos += PADDING(bufpos, u64);
os << SIGN_CAST(64, bufpos);
bufpos += sizeof(u64);
}
break;
case 'b':
bufpos += PADDING(bufpos, bool);
os << std::boolalpha << *((bool *) bufpos);
bufpos += sizeof(bool);
break;
case 'f':
bufpos += PADDING(bufpos, float);
os << *((float *) bufpos);
bufpos += sizeof(float);
break;
case 's':
bufpos += PADDING(bufpos, std::string *);
str = **((std::string **) bufpos);
strpos = 0;
while ((strpos = str.find('"', strpos)) != std::string::npos) {
str.insert(strpos, 1, '\\');
strpos += 2;
}
os << str;
bufpos += sizeof(std::string *);
break;
case 'v':
if (width == 2) {
bufpos += PADDING(bufpos, v2f);
v2f *v = (v2f *) bufpos;
os << '(' << v->X << ", " << v->Y << ')';
bufpos += sizeof(v2f);
} else {
bufpos += PADDING(bufpos, v3f);
v3f *v = (v3f *) bufpos;
os << '(' << v->X << ", " << v->Y << ", " << v->Z << ')';
bufpos += sizeof(v3f);
}
break;
default:
return false;
}
os << ", ";
}
*out = os.str();
// Trim off the trailing comma and space
if (out->size() >= 2)
out->resize(out->size() - 2);
return true;
}
#undef SIGN_CAST
////
//// Other
////
std::string serializeHexString(const std::string &data, bool insert_spaces)
{
std::string result;
result.reserve(data.size() * (2 + insert_spaces));
static const char hex_chars[] = "0123456789abcdef";
const size_t len = data.size();
for (size_t i = 0; i != len; i++) {
u8 byte = data[i];
result.push_back(hex_chars[(byte >> 4) & 0x0F]);
result.push_back(hex_chars[(byte >> 0) & 0x0F]);
if (insert_spaces && i != len - 1)
result.push_back(' ');
}
return result;
}

@ -442,15 +442,9 @@ MAKE_STREAM_WRITE_FXN(video::SColor, ARGB8, 4);
// Creates a string with the length as the first two bytes // Creates a string with the length as the first two bytes
std::string serializeString(const std::string &plain); std::string serializeString(const std::string &plain);
// Creates a string with the length as the first two bytes from wide string
std::string serializeWideString(const std::wstring &plain);
// Reads a string with the length as the first two bytes // Reads a string with the length as the first two bytes
std::string deSerializeString(std::istream &is); std::string deSerializeString(std::istream &is);
// Reads a wide string with the length as the first two bytes
std::wstring deSerializeWideString(std::istream &is);
// Creates a string with the length as the first four bytes // Creates a string with the length as the first four bytes
std::string serializeLongString(const std::string &plain); std::string serializeLongString(const std::string &plain);
@ -469,239 +463,3 @@ std::string serializeJsonStringIfNeeded(const std::string &s);
// Parses a string serialized by serializeJsonStringIfNeeded. // Parses a string serialized by serializeJsonStringIfNeeded.
std::string deSerializeJsonStringIfNeeded(std::istream &is); std::string deSerializeJsonStringIfNeeded(std::istream &is);
// Creates a string consisting of the hexadecimal representation of `data`
std::string serializeHexString(const std::string &data, bool insert_spaces=false);
// Creates a string containing comma delimited values of a struct whose layout is
// described by the parameter format
bool serializeStructToString(std::string *out,
std::string format, void *value);
// Reads a comma delimited string of values into a struct whose layout is
// decribed by the parameter format
bool deSerializeStringToStruct(std::string valstr,
std::string format, void *out, size_t olen);
////
//// BufReader
////
#define MAKE_BUFREADER_GETNOEX_FXN(T, N, S) \
inline bool get ## N ## NoEx(T *val) \
{ \
if (pos + S > size) \
return false; \
*val = read ## N(data + pos); \
pos += S; \
return true; \
}
#define MAKE_BUFREADER_GET_FXN(T, N) \
inline T get ## N() \
{ \
T val; \
if (!get ## N ## NoEx(&val)) \
throw SerializationError("Attempted read past end of data"); \
return val; \
}
class BufReader {
public:
BufReader(const u8 *data_, size_t size_) :
data(data_),
size(size_)
{
}
MAKE_BUFREADER_GETNOEX_FXN(u8, U8, 1);
MAKE_BUFREADER_GETNOEX_FXN(u16, U16, 2);
MAKE_BUFREADER_GETNOEX_FXN(u32, U32, 4);
MAKE_BUFREADER_GETNOEX_FXN(u64, U64, 8);
MAKE_BUFREADER_GETNOEX_FXN(s8, S8, 1);
MAKE_BUFREADER_GETNOEX_FXN(s16, S16, 2);
MAKE_BUFREADER_GETNOEX_FXN(s32, S32, 4);
MAKE_BUFREADER_GETNOEX_FXN(s64, S64, 8);
MAKE_BUFREADER_GETNOEX_FXN(f32, F1000, 4);
MAKE_BUFREADER_GETNOEX_FXN(v2s16, V2S16, 4);
MAKE_BUFREADER_GETNOEX_FXN(v3s16, V3S16, 6);
MAKE_BUFREADER_GETNOEX_FXN(v2s32, V2S32, 8);
MAKE_BUFREADER_GETNOEX_FXN(v3s32, V3S32, 12);
MAKE_BUFREADER_GETNOEX_FXN(v3f, V3F1000, 12);
MAKE_BUFREADER_GETNOEX_FXN(video::SColor, ARGB8, 4);
bool getStringNoEx(std::string *val);
bool getWideStringNoEx(std::wstring *val);
bool getLongStringNoEx(std::string *val);
bool getRawDataNoEx(void *data, size_t len);
MAKE_BUFREADER_GET_FXN(u8, U8);
MAKE_BUFREADER_GET_FXN(u16, U16);
MAKE_BUFREADER_GET_FXN(u32, U32);
MAKE_BUFREADER_GET_FXN(u64, U64);
MAKE_BUFREADER_GET_FXN(s8, S8);
MAKE_BUFREADER_GET_FXN(s16, S16);
MAKE_BUFREADER_GET_FXN(s32, S32);
MAKE_BUFREADER_GET_FXN(s64, S64);
MAKE_BUFREADER_GET_FXN(f32, F1000);
MAKE_BUFREADER_GET_FXN(v2s16, V2S16);
MAKE_BUFREADER_GET_FXN(v3s16, V3S16);
MAKE_BUFREADER_GET_FXN(v2s32, V2S32);
MAKE_BUFREADER_GET_FXN(v3s32, V3S32);
MAKE_BUFREADER_GET_FXN(v3f, V3F1000);
MAKE_BUFREADER_GET_FXN(video::SColor, ARGB8);
MAKE_BUFREADER_GET_FXN(std::string, String);
MAKE_BUFREADER_GET_FXN(std::wstring, WideString);
MAKE_BUFREADER_GET_FXN(std::string, LongString);
inline void getRawData(void *val, size_t len)
{
if (!getRawDataNoEx(val, len))
throw SerializationError("Attempted read past end of data");
}
inline size_t remaining()
{
assert(pos <= size);
return size - pos;
}
const u8 *data;
size_t size;
size_t pos = 0;
};
#undef MAKE_BUFREADER_GET_FXN
#undef MAKE_BUFREADER_GETNOEX_FXN
////
//// Vector-based write routines
////
inline void putU8(std::vector<u8> *dest, u8 val)
{
dest->push_back((val >> 0) & 0xFF);
}
inline void putU16(std::vector<u8> *dest, u16 val)
{
dest->push_back((val >> 8) & 0xFF);
dest->push_back((val >> 0) & 0xFF);
}
inline void putU32(std::vector<u8> *dest, u32 val)
{
dest->push_back((val >> 24) & 0xFF);
dest->push_back((val >> 16) & 0xFF);
dest->push_back((val >> 8) & 0xFF);
dest->push_back((val >> 0) & 0xFF);
}
inline void putU64(std::vector<u8> *dest, u64 val)
{
dest->push_back((val >> 56) & 0xFF);
dest->push_back((val >> 48) & 0xFF);
dest->push_back((val >> 40) & 0xFF);
dest->push_back((val >> 32) & 0xFF);
dest->push_back((val >> 24) & 0xFF);
dest->push_back((val >> 16) & 0xFF);
dest->push_back((val >> 8) & 0xFF);
dest->push_back((val >> 0) & 0xFF);
}
inline void putS8(std::vector<u8> *dest, s8 val)
{
putU8(dest, val);
}
inline void putS16(std::vector<u8> *dest, s16 val)
{
putU16(dest, val);
}
inline void putS32(std::vector<u8> *dest, s32 val)
{
putU32(dest, val);
}
inline void putS64(std::vector<u8> *dest, s64 val)
{
putU64(dest, val);
}
inline void putF1000(std::vector<u8> *dest, f32 val)
{
putS32(dest, val * FIXEDPOINT_FACTOR);
}
inline void putV2S16(std::vector<u8> *dest, v2s16 val)
{
putS16(dest, val.X);
putS16(dest, val.Y);
}
inline void putV3S16(std::vector<u8> *dest, v3s16 val)
{
putS16(dest, val.X);
putS16(dest, val.Y);
putS16(dest, val.Z);
}
inline void putV2S32(std::vector<u8> *dest, v2s32 val)
{
putS32(dest, val.X);
putS32(dest, val.Y);
}
inline void putV3S32(std::vector<u8> *dest, v3s32 val)
{
putS32(dest, val.X);
putS32(dest, val.Y);
putS32(dest, val.Z);
}
inline void putV3F1000(std::vector<u8> *dest, v3f val)
{
putF1000(dest, val.X);
putF1000(dest, val.Y);
putF1000(dest, val.Z);
}
inline void putARGB8(std::vector<u8> *dest, video::SColor val)
{
putU32(dest, val.color);
}
inline void putString(std::vector<u8> *dest, const std::string &val)
{
if (val.size() > STRING_MAX_LEN)
throw SerializationError("String too long");
putU16(dest, val.size());
dest->insert(dest->end(), val.begin(), val.end());
}
inline void putWideString(std::vector<u8> *dest, const std::wstring &val)
{
if (val.size() > WIDE_STRING_MAX_LEN)
throw SerializationError("String too long");
putU16(dest, val.size());
for (size_t i = 0; i != val.size(); i++)
putU16(dest, val[i]);
}
inline void putLongString(std::vector<u8> *dest, const std::string &val)
{
if (val.size() > LONG_STRING_MAX_LEN)
throw SerializationError("String too long");
putU32(dest, val.size());
dest->insert(dest->end(), val.begin(), val.end());
}
inline void putRawData(std::vector<u8> *dest, const void *src, size_t len)
{
dest->insert(dest->end(), (u8 *)src, (u8 *)src + len);
}