// Copyright (c) 2008-2023 the Urho3D project // License: MIT #include "../Precompiled.h" #include "../Core/Context.h" #include "../IO/Deserializer.h" #include "../IO/Log.h" #include "../IO/Serializer.h" #include "../Resource/XMLElement.h" #include "../Resource/JSONValue.h" #include "../Scene/ReplicationState.h" #include "../Scene/SceneEvents.h" #include "../Scene/Serializable.h" #include "../DebugNew.h" using namespace std; namespace Urho3D { static unsigned RemapAttributeIndex(const Vector* attributes, const AttributeInfo& netAttr, unsigned netAttrIndex) { if (!attributes) return netAttrIndex; // Could not remap for (unsigned i = 0; i < attributes->Size(); ++i) { const AttributeInfo& attr = attributes->At(i); // Compare accessor to avoid name string compare if (attr.accessor_.Get() && attr.accessor_.Get() == netAttr.accessor_.Get()) return i; } return netAttrIndex; // Could not remap } Serializable::Serializable(Context* context) : Object(context), setInstanceDefault_(false), temporary_(false) { } Serializable::~Serializable() = default; void Serializable::OnSetAttribute(const AttributeInfo& attr, const Variant& src) { // TODO: may be could use an observer pattern here if (setInstanceDefault_) SetInstanceDefault(attr.name_, src); // Check for accessor function mode if (attr.accessor_) { attr.accessor_->Set(this, src); return; } // Get the destination address assert(attr.ptr_); void* dest = attr.ptr_; switch (attr.type_) { case VAR_INT: // If enum type, use the low 8 bits only if (attr.enumNames_) *(reinterpret_cast(dest)) = src.GetI32(); else *(reinterpret_cast(dest)) = src.GetI32(); break; case VAR_INT64: *(reinterpret_cast(dest)) = src.GetI64(); break; case VAR_BOOL: *(reinterpret_cast(dest)) = src.GetBool(); break; case VAR_FLOAT: *(reinterpret_cast(dest)) = src.GetFloat(); break; case VAR_VECTOR2: *(reinterpret_cast(dest)) = src.GetVector2(); break; case VAR_VECTOR3: *(reinterpret_cast(dest)) = src.GetVector3(); break; case VAR_VECTOR4: *(reinterpret_cast(dest)) = src.GetVector4(); break; case VAR_QUATERNION: *(reinterpret_cast(dest)) = src.GetQuaternion(); break; case VAR_COLOR: *(reinterpret_cast(dest)) = src.GetColor(); break; case VAR_STRING: *(reinterpret_cast(dest)) = src.GetString(); break; case VAR_BUFFER: *(reinterpret_cast*>(dest)) = src.GetBuffer(); break; case VAR_RESOURCEREF: *(reinterpret_cast(dest)) = src.GetResourceRef(); break; case VAR_RESOURCEREFLIST: *(reinterpret_cast(dest)) = src.GetResourceRefList(); break; case VAR_VARIANTVECTOR: *(reinterpret_cast(dest)) = src.GetVariantVector(); break; case VAR_STRINGVECTOR: *(reinterpret_cast(dest)) = src.GetStringVector(); break; case VAR_VARIANTMAP: *(reinterpret_cast(dest)) = src.GetVariantMap(); break; case VAR_INTRECT: *(reinterpret_cast(dest)) = src.GetIntRect(); break; case VAR_INTVECTOR2: *(reinterpret_cast(dest)) = src.GetIntVector2(); break; case VAR_INTVECTOR3: *(reinterpret_cast(dest)) = src.GetIntVector3(); break; case VAR_DOUBLE: *(reinterpret_cast(dest)) = src.GetDouble(); break; default: URHO3D_LOGERROR("Unsupported attribute type for OnSetAttribute()"); return; } // If it is a network attribute then mark it for next network update if (attr.mode_ & AM_NET) MarkNetworkUpdate(); } void Serializable::OnGetAttribute(const AttributeInfo& attr, Variant& dest) const { // Check for accessor function mode if (attr.accessor_) { attr.accessor_->Get(this, dest); return; } // Get the source address assert(attr.ptr_); const void* src = attr.ptr_; switch (attr.type_) { case VAR_INT: // If enum type, use the low 8 bits only if (attr.enumNames_) dest = *(reinterpret_cast(src)); else dest = *(reinterpret_cast(src)); break; case VAR_INT64: dest = *(reinterpret_cast(src)); break; case VAR_BOOL: dest = *(reinterpret_cast(src)); break; case VAR_FLOAT: dest = *(reinterpret_cast(src)); break; case VAR_VECTOR2: dest = *(reinterpret_cast(src)); break; case VAR_VECTOR3: dest = *(reinterpret_cast(src)); break; case VAR_VECTOR4: dest = *(reinterpret_cast(src)); break; case VAR_QUATERNION: dest = *(reinterpret_cast(src)); break; case VAR_COLOR: dest = *(reinterpret_cast(src)); break; case VAR_STRING: dest = *(reinterpret_cast(src)); break; case VAR_BUFFER: dest = *(reinterpret_cast*>(src)); break; case VAR_RESOURCEREF: dest = *(reinterpret_cast(src)); break; case VAR_RESOURCEREFLIST: dest = *(reinterpret_cast(src)); break; case VAR_VARIANTVECTOR: dest = *(reinterpret_cast(src)); break; case VAR_STRINGVECTOR: dest = *(reinterpret_cast(src)); break; case VAR_VARIANTMAP: dest = *(reinterpret_cast(src)); break; case VAR_INTRECT: dest = *(reinterpret_cast(src)); break; case VAR_INTVECTOR2: dest = *(reinterpret_cast(src)); break; case VAR_INTVECTOR3: dest = *(reinterpret_cast(src)); break; case VAR_DOUBLE: dest = *(reinterpret_cast(src)); break; default: URHO3D_LOGERROR("Unsupported attribute type for OnGetAttribute()"); return; } } const Vector* Serializable::GetAttributes() const { return context_->GetAttributes(GetType()); } const Vector* Serializable::GetNetworkAttributes() const { return networkState_ ? networkState_->attributes_ : context_->GetNetworkAttributes(GetType()); } bool Serializable::Load(Deserializer& source) { const Vector* attributes = GetAttributes(); if (!attributes) return true; for (unsigned i = 0; i < attributes->Size(); ++i) { const AttributeInfo& attr = attributes->At(i); if (!(attr.mode_ & AM_FILE)) continue; if (source.IsEof()) { URHO3D_LOGERROR("Could not load " + GetTypeName() + ", stream not open or at end"); return false; } Variant varValue = source.ReadVariant(attr.type_); OnSetAttribute(attr, varValue); } return true; } bool Serializable::Save(Serializer& dest) const { const Vector* attributes = GetAttributes(); if (!attributes) return true; Variant value; for (unsigned i = 0; i < attributes->Size(); ++i) { const AttributeInfo& attr = attributes->At(i); if (!(attr.mode_ & AM_FILE) || (attr.mode_ & AM_FILEREADONLY) == AM_FILEREADONLY) continue; OnGetAttribute(attr, value); if (!dest.WriteVariantData(value)) { URHO3D_LOGERROR("Could not save " + GetTypeName() + ", writing to stream failed"); return false; } } return true; } bool Serializable::LoadXML(const XMLElement& source) { if (source.IsNull()) { URHO3D_LOGERROR("Could not load " + GetTypeName() + ", null source element"); return false; } const Vector* attributes = GetAttributes(); if (!attributes) return true; XMLElement attrElem = source.GetChild("attribute"); unsigned startIndex = 0; while (attrElem) { String name = attrElem.GetAttribute("name"); unsigned i = startIndex; unsigned attempts = attributes->Size(); while (attempts) { const AttributeInfo& attr = attributes->At(i); if ((attr.mode_ & AM_FILE) && !attr.name_.Compare(name, true)) { Variant varValue; // If enums specified, do enum lookup and int assignment. Otherwise assign the variant directly if (attr.enumNames_) { String value = attrElem.GetAttribute("value"); bool enumFound = false; int enumValue = 0; const char** enumPtr = attr.enumNames_; while (*enumPtr) { if (!value.Compare(*enumPtr, false)) { enumFound = true; break; } ++enumPtr; ++enumValue; } if (enumFound) varValue = enumValue; else URHO3D_LOGWARNING("Unknown enum value " + value + " in attribute " + attr.name_); } else varValue = attrElem.GetVariantValue(attr.type_); if (!varValue.IsEmpty()) OnSetAttribute(attr, varValue); startIndex = (i + 1) % attributes->Size(); break; } else { i = (i + 1) % attributes->Size(); --attempts; } } if (!attempts) URHO3D_LOGWARNING("Unknown attribute " + name + " in XML data"); attrElem = attrElem.GetNext("attribute"); } return true; } bool Serializable::LoadJSON(const JSONValue& source) { if (source.IsNull()) { URHO3D_LOGERROR("Could not load " + GetTypeName() + ", null JSON source element"); return false; } const Vector* attributes = GetAttributes(); if (!attributes) return true; // Get attributes value JSONValue attributesValue = source.Get("attributes"); if (attributesValue.IsNull()) return true; // Warn if the attributes value isn't an object if (!attributesValue.IsObject()) { URHO3D_LOGWARNING("'attributes' object is present in " + GetTypeName() + " but is not a JSON object; skipping load"); return true; } const JSONObject& attributesObject = attributesValue.GetObject(); unsigned startIndex = 0; for (JSONObject::ConstIterator it = attributesObject.Begin(); it != attributesObject.End();) { String name = it->first_; const JSONValue& value = it->second_; unsigned i = startIndex; unsigned attempts = attributes->Size(); while (attempts) { const AttributeInfo& attr = attributes->At(i); if ((attr.mode_ & AM_FILE) && !attr.name_.Compare(name, true)) { Variant varValue; // If enums specified, do enum lookup ad int assignment. Otherwise assign variant directly if (attr.enumNames_) { const String& valueStr = value.GetString(); bool enumFound = false; int enumValue = 0; const char** enumPtr = attr.enumNames_; while (*enumPtr) { if (!valueStr.Compare(*enumPtr, false)) { enumFound = true; break; } ++enumPtr; ++enumValue; } if (enumFound) varValue = enumValue; else URHO3D_LOGWARNING("Unknown enum value " + valueStr + " in attribute " + attr.name_); } else varValue = value.GetVariantValue(attr.type_); if (!varValue.IsEmpty()) OnSetAttribute(attr, varValue); startIndex = (i + 1) % attributes->Size(); break; } else { i = (i + 1) % attributes->Size(); --attempts; } } if (!attempts) URHO3D_LOGWARNING("Unknown attribute " + name + " in JSON data"); it++; } return true; } bool Serializable::SaveXML(XMLElement& dest) const { if (dest.IsNull()) { URHO3D_LOGERROR("Could not save " + GetTypeName() + ", null destination element"); return false; } const Vector* attributes = GetAttributes(); if (!attributes) return true; Variant value; for (unsigned i = 0; i < attributes->Size(); ++i) { const AttributeInfo& attr = attributes->At(i); if (!(attr.mode_ & AM_FILE) || (attr.mode_ & AM_FILEREADONLY) == AM_FILEREADONLY) continue; OnGetAttribute(attr, value); Variant defaultValue(GetAttributeDefault(i)); // In XML serialization default values can be skipped. This will make the file easier to read or edit manually if (value == defaultValue && !SaveDefaultAttributes()) continue; XMLElement attrElem = dest.CreateChild("attribute"); attrElem.SetAttribute("name", attr.name_); // If enums specified, set as an enum string. Otherwise set directly as a Variant if (attr.enumNames_) { int enumValue = value.GetI32(); attrElem.SetAttribute("value", attr.enumNames_[enumValue]); } else attrElem.SetVariantValue(value); } return true; } bool Serializable::SaveJSON(JSONValue& dest) const { const Vector* attributes = GetAttributes(); if (!attributes) return true; Variant value; JSONValue attributesValue; for (unsigned i = 0; i < attributes->Size(); ++i) { const AttributeInfo& attr = attributes->At(i); if (!(attr.mode_ & AM_FILE) || (attr.mode_ & AM_FILEREADONLY) == AM_FILEREADONLY) continue; OnGetAttribute(attr, value); Variant defaultValue(GetAttributeDefault(i)); // In JSON serialization default values can be skipped. This will make the file easier to read or edit manually if (value == defaultValue && !SaveDefaultAttributes()) continue; JSONValue attrVal; // If enums specified, set as an enum string. Otherwise set directly as a Variant if (attr.enumNames_) { int enumValue = value.GetI32(); attrVal = attr.enumNames_[enumValue]; } else attrVal.SetVariantValue(value, context_); attributesValue.Set(attr.name_, attrVal); } dest.Set("attributes", attributesValue); return true; } bool Serializable::SetAttribute(unsigned index, const Variant& value) { const Vector* attributes = GetAttributes(); if (!attributes) { URHO3D_LOGERROR(GetTypeName() + " has no attributes"); return false; } if (index >= attributes->Size()) { URHO3D_LOGERROR("Attribute index out of bounds"); return false; } const AttributeInfo& attr = attributes->At(index); // Check that the new value's type matches the attribute type if (value.GetType() == attr.type_) { OnSetAttribute(attr, value); return true; } else { URHO3D_LOGERROR("Could not set attribute " + attr.name_ + ": expected type " + Variant::GetTypeName(attr.type_) + " but got " + value.GetTypeName()); return false; } } bool Serializable::SetAttribute(const String& name, const Variant& value) { const Vector* attributes = GetAttributes(); if (!attributes) { URHO3D_LOGERROR(GetTypeName() + " has no attributes"); return false; } for (Vector::ConstIterator i = attributes->Begin(); i != attributes->End(); ++i) { if (!i->name_.Compare(name, true)) { // Check that the new value's type matches the attribute type if (value.GetType() == i->type_) { OnSetAttribute(*i, value); return true; } else { URHO3D_LOGERROR("Could not set attribute " + i->name_ + ": expected type " + Variant::GetTypeName(i->type_) + " but got " + value.GetTypeName()); return false; } } } URHO3D_LOGERROR("Could not find attribute " + name + " in " + GetTypeName()); return false; } void Serializable::ResetToDefault() { const Vector* attributes = GetAttributes(); if (!attributes) return; for (unsigned i = 0; i < attributes->Size(); ++i) { const AttributeInfo& attr = attributes->At(i); if (attr.mode_ & (AM_NOEDIT | AM_NODEID | AM_COMPONENTID | AM_NODEIDVECTOR)) continue; Variant defaultValue = GetInstanceDefault(attr.name_); if (defaultValue.IsEmpty()) defaultValue = attr.defaultValue_; OnSetAttribute(attr, defaultValue); } } void Serializable::RemoveInstanceDefault() { instanceDefaultValues_.reset(); } void Serializable::SetTemporary(bool enable) { if (enable != temporary_) { temporary_ = enable; using namespace TemporaryChanged; VariantMap& eventData = GetEventDataMap(); eventData[P_SERIALIZABLE] = this; SendEvent(E_TEMPORARYCHANGED, eventData); } } void Serializable::SetInterceptNetworkUpdate(const String& attributeName, bool enable) { AllocateNetworkState(); const Vector* attributes = networkState_->attributes_; if (!attributes) return; for (unsigned i = 0; i < attributes->Size(); ++i) { const AttributeInfo& attr = attributes->At(i); if (!attr.name_.Compare(attributeName, true)) { if (enable) networkState_->interceptMask_ |= 1ULL << i; else networkState_->interceptMask_ &= ~(1ULL << i); break; } } } void Serializable::AllocateNetworkState() { if (networkState_) return; const Vector* networkAttributes = GetNetworkAttributes(); networkState_ = make_unique(); networkState_->attributes_ = networkAttributes; if (!networkAttributes) return; unsigned numAttributes = networkAttributes->Size(); if (networkState_->currentValues_.Size() != numAttributes) { networkState_->currentValues_.Resize(numAttributes); networkState_->previousValues_.Resize(numAttributes); // Copy the default attribute values to the previous state as a starting point for (unsigned i = 0; i < numAttributes; ++i) networkState_->previousValues_[i] = networkAttributes->At(i).defaultValue_; } } void Serializable::WriteInitialDeltaUpdate(Serializer& dest, unsigned char timeStamp) { if (!networkState_) { URHO3D_LOGERROR("WriteInitialDeltaUpdate called without allocated NetworkState"); return; } const Vector* attributes = networkState_->attributes_; if (!attributes) return; unsigned numAttributes = attributes->Size(); DirtyBits attributeBits; // Compare against defaults for (unsigned i = 0; i < numAttributes; ++i) { const AttributeInfo& attr = attributes->At(i); if (networkState_->currentValues_[i] != attr.defaultValue_) attributeBits.Set(i); } // First write the change bitfield, then attribute data for non-default attributes dest.WriteU8(timeStamp); dest.Write(attributeBits.data_, (numAttributes + 7) >> 3u); for (unsigned i = 0; i < numAttributes; ++i) { if (attributeBits.IsSet(i)) dest.WriteVariantData(networkState_->currentValues_[i]); } } void Serializable::WriteDeltaUpdate(Serializer& dest, const DirtyBits& attributeBits, unsigned char timeStamp) { if (!networkState_) { URHO3D_LOGERROR("WriteDeltaUpdate called without allocated NetworkState"); return; } const Vector* attributes = networkState_->attributes_; if (!attributes) return; unsigned numAttributes = attributes->Size(); // First write the change bitfield, then attribute data for changed attributes // Note: the attribute bits should not contain LATESTDATA attributes dest.WriteU8(timeStamp); dest.Write(attributeBits.data_, (numAttributes + 7) >> 3u); for (unsigned i = 0; i < numAttributes; ++i) { if (attributeBits.IsSet(i)) dest.WriteVariantData(networkState_->currentValues_[i]); } } void Serializable::WriteLatestDataUpdate(Serializer& dest, unsigned char timeStamp) { if (!networkState_) { URHO3D_LOGERROR("WriteLatestDataUpdate called without allocated NetworkState"); return; } const Vector* attributes = networkState_->attributes_; if (!attributes) return; unsigned numAttributes = attributes->Size(); dest.WriteU8(timeStamp); for (unsigned i = 0; i < numAttributes; ++i) { if (attributes->At(i).mode_ & AM_LATESTDATA) dest.WriteVariantData(networkState_->currentValues_[i]); } } bool Serializable::ReadDeltaUpdate(Deserializer& source) { const Vector* attributes = GetNetworkAttributes(); if (!attributes) return false; unsigned numAttributes = attributes->Size(); DirtyBits attributeBits; bool changed = false; unsigned long long interceptMask = networkState_ ? networkState_->interceptMask_ : 0; unsigned char timeStamp = source.ReadU8(); source.Read(attributeBits.data_, (numAttributes + 7) >> 3u); for (unsigned i = 0; i < numAttributes && !source.IsEof(); ++i) { if (attributeBits.IsSet(i)) { const AttributeInfo& attr = attributes->At(i); if (!(interceptMask & (1ULL << i))) { OnSetAttribute(attr, source.ReadVariant(attr.type_)); changed = true; } else { using namespace InterceptNetworkUpdate; VariantMap& eventData = GetEventDataMap(); eventData[P_SERIALIZABLE] = this; eventData[P_TIMESTAMP] = (unsigned)timeStamp; eventData[P_INDEX] = RemapAttributeIndex(GetAttributes(), attr, i); eventData[P_NAME] = attr.name_; eventData[P_VALUE] = source.ReadVariant(attr.type_); SendEvent(E_INTERCEPTNETWORKUPDATE, eventData); } } } return changed; } bool Serializable::ReadLatestDataUpdate(Deserializer& source) { const Vector* attributes = GetNetworkAttributes(); if (!attributes) return false; unsigned numAttributes = attributes->Size(); bool changed = false; unsigned long long interceptMask = networkState_ ? networkState_->interceptMask_ : 0; unsigned char timeStamp = source.ReadU8(); for (unsigned i = 0; i < numAttributes && !source.IsEof(); ++i) { const AttributeInfo& attr = attributes->At(i); if (attr.mode_ & AM_LATESTDATA) { if (!(interceptMask & (1ULL << i))) { OnSetAttribute(attr, source.ReadVariant(attr.type_)); changed = true; } else { using namespace InterceptNetworkUpdate; VariantMap& eventData = GetEventDataMap(); eventData[P_SERIALIZABLE] = this; eventData[P_TIMESTAMP] = (unsigned)timeStamp; eventData[P_INDEX] = RemapAttributeIndex(GetAttributes(), attr, i); eventData[P_NAME] = attr.name_; eventData[P_VALUE] = source.ReadVariant(attr.type_); SendEvent(E_INTERCEPTNETWORKUPDATE, eventData); } } } return changed; } Variant Serializable::GetAttribute(unsigned index) const { Variant ret; const Vector* attributes = GetAttributes(); if (!attributes) { URHO3D_LOGERROR(GetTypeName() + " has no attributes"); return ret; } if (index >= attributes->Size()) { URHO3D_LOGERROR("Attribute index out of bounds"); return ret; } OnGetAttribute(attributes->At(index), ret); return ret; } Variant Serializable::GetAttribute(const String& name) const { Variant ret; const Vector* attributes = GetAttributes(); if (!attributes) { URHO3D_LOGERROR(GetTypeName() + " has no attributes"); return ret; } for (Vector::ConstIterator i = attributes->Begin(); i != attributes->End(); ++i) { if (!i->name_.Compare(name, true)) { OnGetAttribute(*i, ret); return ret; } } URHO3D_LOGERROR("Could not find attribute " + name + " in " + GetTypeName()); return ret; } Variant Serializable::GetAttributeDefault(unsigned index) const { const Vector* attributes = GetAttributes(); if (!attributes) { URHO3D_LOGERROR(GetTypeName() + " has no attributes"); return Variant::EMPTY; } if (index >= attributes->Size()) { URHO3D_LOGERROR("Attribute index out of bounds"); return Variant::EMPTY; } AttributeInfo attr = attributes->At(index); Variant defaultValue = GetInstanceDefault(attr.name_); return defaultValue.IsEmpty() ? attr.defaultValue_ : defaultValue; } Variant Serializable::GetAttributeDefault(const String& name) const { Variant defaultValue = GetInstanceDefault(name); if (!defaultValue.IsEmpty()) return defaultValue; const Vector* attributes = GetAttributes(); if (!attributes) { URHO3D_LOGERROR(GetTypeName() + " has no attributes"); return Variant::EMPTY; } for (Vector::ConstIterator i = attributes->Begin(); i != attributes->End(); ++i) { if (!i->name_.Compare(name, true)) return i->defaultValue_; } URHO3D_LOGERROR("Could not find attribute " + name + " in " + GetTypeName()); return Variant::EMPTY; } unsigned Serializable::GetNumAttributes() const { const Vector* attributes = GetAttributes(); return attributes ? attributes->Size() : 0; } unsigned Serializable::GetNumNetworkAttributes() const { const Vector* attributes = networkState_ ? networkState_->attributes_ : context_->GetNetworkAttributes(GetType()); return attributes ? attributes->Size() : 0; } bool Serializable::GetInterceptNetworkUpdate(const String& attributeName) const { const Vector* attributes = GetNetworkAttributes(); if (!attributes) return false; unsigned long long interceptMask = networkState_ ? networkState_->interceptMask_ : 0; for (unsigned i = 0; i < attributes->Size(); ++i) { const AttributeInfo& attr = attributes->At(i); if (!attr.name_.Compare(attributeName, true)) return interceptMask & (1ULL << i) ? true : false; } return false; } void Serializable::SetInstanceDefault(const String& name, const Variant& defaultValue) { // Allocate the instance level default value if (!instanceDefaultValues_) instanceDefaultValues_ = make_unique(); instanceDefaultValues_->operator [](name) = defaultValue; } Variant Serializable::GetInstanceDefault(const String& name) const { if (instanceDefaultValues_) { VariantMap::ConstIterator i = instanceDefaultValues_->Find(name); if (i != instanceDefaultValues_->End()) return i->second_; } return Variant::EMPTY; } }