qzdoom-gpl/src/serializer.cpp

1270 lines
26 KiB
C++

#define RAPIDJSON_48BITPOINTER_OPTIMIZATION 0 // disable this insanity which is bound to make the code break over time.
#define RAPIDJSON_HAS_CXX11_RVALUE_REFS 1
#define RAPIDJSON_HAS_CXX11_RANGE_FOR 1
#define RAPIDJSON_PARSE_DEFAULT_FLAGS kParseFullPrecisionFlag
//#define PRETTY
#include "rapidjson/rapidjson.h"
#include "rapidjson/writer.h"
#include "rapidjson/prettywriter.h"
#include "rapidjson/stringbuffer.h"
#include "rapidjson/document.h"
#include "serializer.h"
#include "r_data/colormaps.h"
#include "r_data/r_interpolate.h"
#include "r_defs.h"
#include "r_state.h"
#include "p_lnspec.h"
#include "i_system.h"
#include "w_wad.h"
#include "p_terrain.h"
#include "c_dispatch.h"
#include "p_setup.h"
#include "p_conversation.h"
#include "dsectoreffect.h"
#include "d_player.h"
#include "r_data/r_interpolate.h"
#include "g_shared/a_sharedglobal.h"
char nulspace[1024 * 1024 * 4];
//==========================================================================
//
//
//
//==========================================================================
struct FJSONObject
{
rapidjson::Value *mObject;
rapidjson::Value::MemberIterator mIterator;
int mIndex;
FJSONObject(rapidjson::Value *v)
{
mObject = v;
if (v->IsObject()) mIterator = v->MemberBegin();
else if (v->IsArray()) mIndex = 0;
}
};
//==========================================================================
//
// some wrapper stuff to keep the RapidJSON dependencies out of the global headers.
// FSerializer should not expose any of this.
//
//==========================================================================
struct FWriter
{
// Since this is done by template parameters, we'd have to template the entire serializer to allow this switch at run time. Argh!
#ifndef PRETTY
typedef rapidjson::Writer<rapidjson::StringBuffer, rapidjson::ASCII<> > Writer;
#else
typedef rapidjson::PrettyWriter<rapidjson::StringBuffer, rapidjson::ASCII<> > Writer;
#endif
Writer mWriter;
TArray<bool> mInObject;
rapidjson::StringBuffer mOutString;
TArray<DObject *> mDObjects;
TMap<DObject *, int> mObjectMap;
FWriter() : mWriter(mOutString)
{}
bool inObject() const
{
return mInObject.Size() > 0 && mInObject.Last();
}
};
//==========================================================================
//
//
//
//==========================================================================
struct FReader
{
TArray<FJSONObject> mObjects;
rapidjson::Value mDocObj; // just because RapidJSON is stupid and does not allow direct access to what's in the document.
FReader(const char *buffer, size_t length)
{
rapidjson::Document doc;
doc.Parse(buffer, length);
mDocObj = doc.GetObject();
mObjects.Push(FJSONObject(&mDocObj));
}
rapidjson::Value *FindKey(const char *key)
{
FJSONObject &obj = mObjects.Last();
if (obj.mObject->IsObject())
{
if (obj.mIterator != obj.mObject->MemberEnd())
{
if (!strcmp(key, obj.mIterator->name.GetString()))
{
return &(obj.mIterator++)->value;
}
}
}
else if (obj.mObject->IsArray())
{
return &obj.mObject[obj.mIndex++];
}
return nullptr;
}
};
//==========================================================================
//
//
//
//==========================================================================
bool FSerializer::OpenWriter()
{
if (w != nullptr || r != nullptr) return false;
w = new FWriter;
return true;
}
//==========================================================================
//
//
//
//==========================================================================
bool FSerializer::OpenReader(const char *buffer, size_t length)
{
if (w != nullptr || r != nullptr) return false;
r = new FReader(buffer, length);
return true;
}
//==========================================================================
//
//
//
//==========================================================================
void FSerializer::Close()
{
if (w != nullptr)
{
delete w;
w = nullptr;
}
if (r != nullptr)
{
delete r;
r = nullptr;
}
}
//==========================================================================
//
//
//
//==========================================================================
int FSerializer::ArraySize()
{
if (r != nullptr && r->mObjects.Last().mObject->IsArray())
{
return r->mObjects.Last().mObject->Size();
}
else
{
return 0;
}
}
//==========================================================================
//
//
//
//==========================================================================
bool FSerializer::canSkip() const
{
return isWriting() && w->inObject();
}
//==========================================================================
//
//
//
//==========================================================================
void FSerializer::WriteKey(const char *key)
{
if (isWriting() && w->inObject())
{
if (key == nullptr)
{
I_Error("missing element name");
}
w->mWriter.Key(key);
}
}
//==========================================================================
//
//
//
//==========================================================================
bool FSerializer::BeginObject(const char *name)
{
if (isWriting())
{
WriteKey(name);
w->mWriter.StartObject();
w->mInObject.Push(true);
}
else
{
auto val = r->FindKey(name);
if (val != nullptr)
{
if (val->IsObject())
{
r->mObjects.Push(FJSONObject(val));
}
else
{
I_Error("Object expected for '%s'", name);
}
}
else
{
return false;
}
}
return true;
}
//==========================================================================
//
//
//
//==========================================================================
void FSerializer::EndObject()
{
if (isWriting())
{
if (w->inObject())
{
w->mWriter.EndObject();
w->mInObject.Pop();
}
else
{
I_Error("EndObject call not inside an object");
}
}
else
{
r->mObjects.Pop();
}
}
//==========================================================================
//
//
//
//==========================================================================
bool FSerializer::BeginArray(const char *name)
{
if (isWriting())
{
WriteKey(name);
w->mWriter.StartArray();
w->mInObject.Push(false);
}
else
{
auto val = r->FindKey(name);
if (val != nullptr)
{
if (val->IsArray())
{
r->mObjects.Push(FJSONObject(val));
}
else
{
I_Error("Array expected for '%s'", name);
}
}
else
{
return false;
}
}
return true;
}
//==========================================================================
//
//
//
//==========================================================================
void FSerializer::EndArray()
{
if (isWriting())
{
if (!w->inObject())
{
w->mWriter.EndArray();
w->mInObject.Pop();
}
else
{
I_Error("EndArray call not inside an array");
}
}
else
{
r->mObjects.Pop();
}
}
//==========================================================================
//
// Special handler for args (because ACS specials' arg0 needs special treatment.)
//
//==========================================================================
FSerializer &FSerializer::Args(const char *key, int *args, int *defargs, int special)
{
if (isWriting())
{
if (w->inObject() && defargs != nullptr && !memcmp(args, defargs, 5 * sizeof(int)))
{
return *this;
}
WriteKey(key);
w->mWriter.StartArray();
for (int i = 0; i < 5; i++)
{
if (i == 0 && args[i] < 0 && P_IsACSSpecial(special))
{
w->mWriter.String(FName(ENamedName(-args[i])).GetChars());
}
else
{
w->mWriter.Int(args[i]);
}
}
w->mWriter.EndArray();
}
else
{
auto val = r->FindKey(key);
if (val != nullptr)
{
if (val->IsArray())
{
unsigned int cnt = MIN<unsigned>(val->Size(), 5);
for (unsigned int i = 0; i < cnt; i++)
{
const rapidjson::Value &aval = (*val)[i];
if (aval.IsInt())
{
args[i] = aval.GetInt();
}
else if (i == 0 && aval.IsString())
{
args[i] = -FName(aval.GetString());
}
else
{
I_Error("Integer expected for '%s[%d]'", key, i);
}
}
}
else
{
I_Error("array expected for '%s'", key);
}
}
}
return *this;
}
//==========================================================================
//
//
//
//==========================================================================
FSerializer &FSerializer::Terrain(const char *key, int &terrain, int *def)
{
if (isWriting() && def != nullptr && terrain == *def)
{
return *this;
}
FName terr = P_GetTerrainName(terrain);
Serialize(*this, key, terr, nullptr);
if (isReading())
{
terrain = P_FindTerrain(terr);
}
return *this;
}
//==========================================================================
//
//
//
//==========================================================================
FSerializer &FSerializer::Sprite(const char *key, uint16_t &spritenum, uint16_t *def)
{
if (isWriting())
{
if (w->inObject() && def != nullptr && *def == spritenum) return *this;
WriteKey(key);
w->mWriter.String(sprites[spritenum].name, 4);
}
else
{
auto val = r->FindKey(key);
if (val != nullptr)
{
if (val->IsString())
{
int name = *reinterpret_cast<const int*>(val->GetString());
for (auto hint = NumStdSprites; hint-- != 0; )
{
if (sprites[hint].dwName == name)
{
spritenum = hint;
break;
}
}
}
}
}
return *this;
}
//==========================================================================
//
//
//
//==========================================================================
FSerializer &FSerializer::StringPtr(const char *key, const char *&charptr)
{
if (isWriting())
{
WriteKey(key);
w->mWriter.String(charptr);
}
else
{
auto val = r->FindKey(key);
if (val != nullptr)
{
if (val->IsString())
{
charptr = val->GetString();
}
}
}
return *this;
}
//==========================================================================
//
// Writes out all collected objects
//
//==========================================================================
void FSerializer::WriteObjects()
{
if (isWriting())
{
BeginArray("objects");
for (unsigned i = 0; i < w->mDObjects.Size(); i++)
{
BeginObject(nullptr);
WriteKey("classtype");
w->mWriter.String(w->mDObjects[i]->GetClass()->TypeName.GetChars());
w->mDObjects[i]->SerializeUserVars(*this);
w->mDObjects[i]->Serialize(*this);
w->mDObjects[i]->CheckIfSerialized();
EndObject();
}
EndArray();
}
}
const char *FSerializer::GetOutput(unsigned *len)
{
if (len != nullptr)
{
*len = (unsigned)w->mOutString.GetSize();
}
return w->mOutString.GetString();
}
//==========================================================================
//
//
//
//==========================================================================
FSerializer &Serialize(FSerializer &arc, const char *key, bool &value, bool *defval)
{
if (arc.isWriting())
{
if (!arc.w->inObject() || defval == nullptr || value != *defval)
{
arc.WriteKey(key);
arc.w->mWriter.Bool(value);
}
}
else
{
auto val = arc.r->FindKey(key);
if (val != nullptr)
{
if (val->IsBool())
{
value = val->GetBool();
}
else
{
I_Error("boolean type expected for '%s'", key);
}
}
}
return arc;
}
//==========================================================================
//
//
//
//==========================================================================
FSerializer &Serialize(FSerializer &arc, const char *key, int64_t &value, int64_t *defval)
{
if (arc.isWriting())
{
if (!arc.w->inObject() || defval == nullptr || value != *defval)
{
arc.WriteKey(key);
arc.w->mWriter.Int64(value);
}
}
else
{
auto val = arc.r->FindKey(key);
if (val != nullptr)
{
if (val->IsInt64())
{
value = val->GetInt64();
}
else
{
I_Error("integer type expected for '%s'", key);
}
}
}
return arc;
}
//==========================================================================
//
//
//
//==========================================================================
FSerializer &Serialize(FSerializer &arc, const char *key, uint64_t &value, uint64_t *defval)
{
if (arc.isWriting())
{
if (!arc.w->inObject() || defval == nullptr || value != *defval)
{
arc.WriteKey(key);
arc.w->mWriter.Uint64(value);
}
}
else
{
auto val = arc.r->FindKey(key);
if (val != nullptr)
{
if (val->IsUint64())
{
value = val->GetUint64();
}
else
{
I_Error("integer type expected for '%s'", key);
}
}
}
return arc;
}
//==========================================================================
//
//
//
//==========================================================================
FSerializer &Serialize(FSerializer &arc, const char *key, int32_t &value, int32_t *defval)
{
if (arc.isWriting())
{
if (!arc.w->inObject() || defval == nullptr || value != *defval)
{
arc.WriteKey(key);
arc.w->mWriter.Int(value);
}
}
else
{
auto val = arc.r->FindKey(key);
if (val != nullptr)
{
if (val->IsInt())
{
value = val->GetInt();
}
else
{
I_Error("integer type expected for '%s'", key);
}
}
}
return arc;
}
//==========================================================================
//
//
//
//==========================================================================
FSerializer &Serialize(FSerializer &arc, const char *key, uint32_t &value, uint32_t *defval)
{
if (arc.isWriting())
{
if (!arc.w->inObject() || defval == nullptr || value != *defval)
{
arc.WriteKey(key);
arc.w->mWriter.Uint(value);
}
}
else
{
auto val = arc.r->FindKey(key);
if (val != nullptr)
{
if (val->IsUint())
{
value = val->GetUint();
}
else
{
I_Error("integer type expected for '%s'", key);
}
}
}
return arc;
}
//==========================================================================
//
//
//
//==========================================================================
FSerializer &Serialize(FSerializer &arc, const char *key, int8_t &value, int8_t *defval)
{
int32_t vv = value;
int32_t vvd = defval? *defval : value-1;
Serialize(arc, key, vv, &vvd);
value = (int8_t)vv;
return arc;
}
FSerializer &Serialize(FSerializer &arc, const char *key, uint8_t &value, uint8_t *defval)
{
uint32_t vv = value;
uint32_t vvd = defval ? *defval : value - 1;
Serialize(arc, key, vv, &vvd);
value = (uint8_t)vv;
return arc;
}
FSerializer &Serialize(FSerializer &arc, const char *key, int16_t &value, int16_t *defval)
{
int32_t vv = value;
int32_t vvd = defval ? *defval : value - 1;
Serialize(arc, key, vv, &vvd);
value = (int16_t)vv;
return arc;
}
FSerializer &Serialize(FSerializer &arc, const char *key, uint16_t &value, uint16_t *defval)
{
uint32_t vv = value;
uint32_t vvd = defval ? *defval : value - 1;
Serialize(arc, key, vv, &vvd);
value = (uint16_t)vv;
return arc;
}
//==========================================================================
//
//
//
//==========================================================================
FSerializer &Serialize(FSerializer &arc, const char *key, double &value, double *defval)
{
if (arc.isWriting())
{
if (!arc.w->inObject() || defval == nullptr || value != *defval)
{
arc.WriteKey(key);
arc.w->mWriter.Double(value);
}
}
else
{
auto val = arc.r->FindKey(key);
if (val != nullptr)
{
if (val->IsDouble())
{
value = val->GetDouble();
}
else
{
I_Error("float type expected for '%s'", key);
}
}
}
return arc;
}
//==========================================================================
//
//
//
//==========================================================================
FSerializer &Serialize(FSerializer &arc, const char *key, float &value, float *defval)
{
double vv = value;
double vvd = defval ? *defval : value - 1;
Serialize(arc, key, vv, &vvd);
value = (float)vv;
return arc;
}
//==========================================================================
//
//
//
//==========================================================================
template<class T>
FSerializer &SerializePointer(FSerializer &arc, const char *key, T *&value, T **defval, T *base)
{
if (arc.isReading() || !arc.w->inObject() || defval == nullptr || value != *defval)
{
ptrdiff_t vv = value == nullptr ? -1 : value - base;
Serialize(arc, key, vv, nullptr);
value = vv < 0 ? nullptr : base + vv;
}
return arc;
}
FSerializer &Serialize(FSerializer &arc, const char *key, side_t *&value, side_t **defval)
{
return SerializePointer(arc, key, value, defval, sides);
}
FSerializer &Serialize(FSerializer &arc, const char *key, sector_t *&value, sector_t **defval)
{
return SerializePointer(arc, key, value, defval, sectors);
}
FSerializer &Serialize(FSerializer &arc, const char *key, player_t *&value, player_t **defval)
{
return SerializePointer(arc, key, value, defval, players);
}
FSerializer &Serialize(FSerializer &arc, const char *key, line_t *&value, line_t **defval)
{
return SerializePointer(arc, key, value, defval, lines);
}
//==========================================================================
//
//
//
//==========================================================================
FSerializer &Serialize(FSerializer &arc, const char *key, FTextureID &value, FTextureID *defval)
{
if (arc.isWriting())
{
if (!arc.w->inObject() || defval == nullptr || value != *defval)
{
if (!value.Exists())
{
arc.WriteKey(key);
arc.w->mWriter.Null();
return arc;
}
if (value.isNull())
{
// save 'no texture' in a more space saving way
arc.WriteKey(key);
arc.w->mWriter.Int(0);
return arc;
}
FTextureID chk = value;
if (chk.GetIndex() >= TexMan.NumTextures()) chk.SetNull();
FTexture *pic = TexMan[chk];
const char *name;
if (Wads.GetLinkedTexture(pic->SourceLump) == pic)
{
name = Wads.GetLumpFullName(pic->SourceLump);
}
else
{
name = pic->Name;
}
arc.WriteKey(key);
arc.w->mWriter.StartArray();
arc.w->mWriter.String(name);
arc.w->mWriter.Int(pic->UseType);
arc.w->mWriter.EndArray();
}
}
else
{
auto val = arc.r->FindKey(key);
if (val != nullptr)
{
if (val->IsObject())
{
const rapidjson::Value &nameval = (*val)[0];
const rapidjson::Value &typeval = (*val)[1];
if (nameval.IsString() && typeval.IsInt())
{
value = TexMan.GetTexture(nameval.GetString(), typeval.GetInt());
}
else
{
I_Error("object does not represent a texture for '%s'", key);
}
}
else if (val->IsNull())
{
value.SetInvalid();
}
else if (val->IsInt() && val->GetInt() == 0)
{
value.SetNull();
}
else
{
I_Error("object does not represent a texture for '%s'", key);
}
}
}
return arc;
}
//==========================================================================
//
// This never uses defval and instead uses 'null' as default
// because object pointers cannot be safely defaulted to anything else.
//
//==========================================================================
FSerializer &Serialize(FSerializer &arc, const char *key, DObject *&value, DObject ** /*defval*/)
{
if (arc.isWriting())
{
if (value != nullptr)
{
int ndx;
int *pndx = arc.w->mObjectMap.CheckKey(value);
if (pndx != nullptr) ndx = *pndx;
else
{
ndx = arc.w->mDObjects.Push(value);
arc.w->mObjectMap[value] = ndx;
}
Serialize(arc, key, ndx, nullptr);
}
}
else
{
auto val = arc.r->FindKey(key);
if (val != nullptr)
{
}
else
{
value = nullptr;
}
}
return arc;
}
//==========================================================================
//
//
//
//==========================================================================
FSerializer &Serialize(FSerializer &arc, const char *key, FName &value, FName *defval)
{
if (arc.isWriting())
{
if (!arc.w->inObject() || defval == nullptr || value != *defval)
{
arc.WriteKey(key);
arc.w->mWriter.String(value.GetChars());
}
}
else
{
auto val = arc.r->FindKey(key);
if (val != nullptr)
{
if (val->IsString())
{
value = val->GetString();
}
else
{
I_Error("String expected for '%s'", key);
}
}
}
return arc;
}
//==========================================================================
//
//
//
//==========================================================================
FSerializer &Serialize(FSerializer &arc, const char *key, FDynamicColormap *&cm, FDynamicColormap **def)
{
if (arc.isWriting())
{
if (arc.w->inObject() && def != nullptr && cm->Color == (*def)->Color && cm->Fade == (*def)->Fade && cm->Desaturate == (*def)->Desaturate)
{
return arc;
}
arc.WriteKey(key);
arc.w->mWriter.StartArray();
arc.w->mWriter.Uint(cm->Color);
arc.w->mWriter.Uint(cm->Fade);
arc.w->mWriter.Uint(cm->Desaturate);
arc.w->mWriter.EndArray();
}
else
{
auto val = arc.r->FindKey(key);
if (val != nullptr)
{
if (val->IsObject())
{
const rapidjson::Value &colorval = (*val)[0];
const rapidjson::Value &fadeval = (*val)[1];
const rapidjson::Value &desatval = (*val)[2];
if (colorval.IsUint() && fadeval.IsUint() && desatval.IsUint())
{
cm = GetSpecialLights(colorval.GetUint(), fadeval.GetUint(), desatval.GetUint());
}
else
{
I_Error("object does not represent a colormap for '%s'", key);
}
}
else
{
I_Error("object does not represent a colormap for '%s'", key);
}
}
}
return arc;
}
//==========================================================================
//
//
//
//==========================================================================
FSerializer &Serialize(FSerializer &arc, const char *key, FSoundID &sid, FSoundID *def)
{
if (arc.isWriting())
{
if (arc.w->inObject() && def != nullptr && sid != *def)
{
arc.WriteKey(key);
const char *sn = (const char*)sid;
if (sn != nullptr) arc.w->mWriter.String(sn);
else arc.w->mWriter.Null();
}
}
else
{
auto val = arc.r->FindKey(key);
if (val != nullptr)
{
if (val->IsString())
{
sid = val->GetString();
}
else if (val->IsNull())
{
sid = 0;
}
else
{
I_Error("string type expected for '%s'", key);
}
}
}
return arc;
}
//==========================================================================
//
//
//
//==========================================================================
FSerializer &Serialize(FSerializer &arc, const char *key, PClassActor *&clst, PClassActor **def)
{
if (arc.isWriting())
{
if (arc.w->inObject() && def != nullptr && clst != *def)
{
arc.WriteKey(key);
arc.w->mWriter.String(clst->TypeName.GetChars());
}
}
else
{
auto val = arc.r->FindKey(key);
if (val != nullptr)
{
if (val->IsString())
{
clst = PClass::FindActor(val->GetString());
}
else
{
I_Error("string type expected for '%s'", key);
}
}
}
return arc;
}
//==========================================================================
//
//
//
//==========================================================================
FSerializer &Serialize(FSerializer &arc, const char *key, FState *&state, FState **def)
{
if (arc.isWriting())
{
if (arc.w->inObject() && def != nullptr && state != *def)
{
arc.WriteKey(key);
if (state == nullptr)
{
arc.w->mWriter.Null();
}
else
{
PClassActor *info = FState::StaticFindStateOwner(state);
if (info != NULL)
{
arc.w->mWriter.StartArray();
arc.w->mWriter.String(info->TypeName.GetChars());
arc.w->mWriter.Uint((uint32_t)(state - info->OwnedStates));
arc.w->mWriter.EndArray();
}
else
{
arc.w->mWriter.Null();
}
}
}
}
else
{
auto val = arc.r->FindKey(key);
if (val != nullptr)
{
if (val->IsNull())
{
state = nullptr;
}
else if (val->IsArray())
{
const rapidjson::Value &cls = (*val)[0];
const rapidjson::Value &ndx = (*val)[1];
state = nullptr;
if (cls.IsString() && ndx.IsInt())
{
PClassActor *clas = PClass::FindActor(cls.GetString());
if (clas)
{
state = clas->OwnedStates + ndx.GetInt();
}
}
}
else
{
I_Error("array type expected for '%s'", key);
}
}
}
return arc;
}
//==========================================================================
//
//
//
//==========================================================================
FSerializer &Serialize(FSerializer &arc, const char *key, FStrifeDialogueNode *&node, FStrifeDialogueNode **def)
{
if (arc.isWriting())
{
if (arc.w->inObject() && def != nullptr && node != *def)
{
arc.WriteKey(key);
if (node == nullptr)
{
arc.w->mWriter.Null();
}
else
{
arc.w->mWriter.Uint(node->ThisNodeNum);
}
}
}
else
{
auto val = arc.r->FindKey(key);
if (val != nullptr)
{
if (val->IsNull())
{
node = nullptr;
}
else if (val->IsUint())
{
if (val->GetUint() >= StrifeDialogues.Size())
{
node = NULL;
}
else
{
node = StrifeDialogues[val->GetUint()];
}
}
else
{
I_Error("integer expected for '%s'", key);
}
}
}
return arc;
}
//==========================================================================
//
//
//
//==========================================================================
FSerializer &Serialize(FSerializer &arc, const char *key, FString *&pstr, FString **def)
{
if (arc.isWriting())
{
if (arc.w->inObject() && def != nullptr && pstr != *def)
{
arc.WriteKey(key);
if (pstr == nullptr)
{
arc.w->mWriter.Null();
}
else
{
arc.w->mWriter.String(pstr->GetChars());
}
}
}
else
{
auto val = arc.r->FindKey(key);
if (val != nullptr)
{
if (val->IsNull())
{
pstr = nullptr;
}
else if (val->IsString())
{
pstr = AActor::mStringPropertyData.Alloc(val->GetString());
}
else
{
I_Error("string expected for '%s'", key);
}
}
}
return arc;
}