@bloomengine/engine 0.3.1

package/native/third_party/JoltPhysics/Jolt/ObjectStream/ObjectStreamIn.h

@@ -0,0 +1,148 @@
+// Jolt Physics Library (https://github.com/jrouwe/JoltPhysics)
+// SPDX-FileCopyrightText: 2021 Jorrit Rouwe
+// SPDX-License-Identifier: MIT
+
+#pragma once
+
+#include <Jolt/ObjectStream/ObjectStream.h>
+#include <Jolt/Core/Reference.h>
+#include <Jolt/Core/RTTI.h>
+#include <Jolt/Core/UnorderedMap.h>
+
+JPH_SUPPRESS_WARNINGS_STD_BEGIN
+#include <fstream>
+JPH_SUPPRESS_WARNINGS_STD_END
+
+#ifdef JPH_OBJECT_STREAM
+
+JPH_NAMESPACE_BEGIN
+
+/// ObjectStreamIn contains all logic for reading an object from disk. It is the base
+/// class for the text and binary input streams (ObjectStreamTextIn and ObjectStreamBinaryIn).
+class JPH_EXPORT ObjectStreamIn : public IObjectStreamIn
+{
+private:
+	struct ClassDescription;
+
+public:
+	/// Main function to read an object from a stream
+	template <class T>
+	static bool sReadObject(istream &inStream, T *&outObject)
+	{
+		// Create the input stream
+		bool result = false;
+		ObjectStreamIn *stream = ObjectStreamIn::Open(inStream);
+		if (stream)
+		{
+			// Read the object
+			outObject = (T *)stream->Read(JPH_RTTI(T));
+			result = (outObject != nullptr);
+			delete stream;
+		}
+		return result;
+	}
+
+	/// Main function to read an object from a stream (reference counting pointer version)
+	template <class T>
+	static bool sReadObject(istream &inStream, Ref<T> &outObject)
+	{
+		T *object = nullptr;
+		bool result = sReadObject(inStream, object);
+		outObject = object;
+		return result;
+	}
+
+	/// Main function to read an object from a file
+	template <class T>
+	static bool sReadObject(const char *inFileName, T *&outObject)
+	{
+		std::ifstream stream;
+		stream.open(inFileName, std::ifstream::in | std::ifstream::binary);
+		if (!stream.is_open())
+			return false;
+		return sReadObject(stream, outObject);
+	}
+
+	/// Main function to read an object from a file (reference counting pointer version)
+	template <class T>
+	static bool sReadObject(const char *inFileName, Ref<T> &outObject)
+	{
+		T *object = nullptr;
+		bool result = sReadObject(inFileName, object);
+		outObject = object;
+		return result;
+	}
+
+	//////////////////////////////////////////////////////
+	// EVERYTHING BELOW THIS SHOULD NOT DIRECTLY BE CALLED
+	//////////////////////////////////////////////////////
+
+	///@name Serialization operations
+	void *						Read(const RTTI *inRTTI);
+	void *						ReadObject(const RTTI *& outRTTI);
+	bool						ReadRTTI();
+	virtual bool				ReadClassData(const char *inClassName, void *inInstance) override;
+	bool						ReadClassData(const ClassDescription &inClassDesc, void *inInstance);
+	virtual bool				ReadPointerData(const RTTI *inRTTI, void **inPointer, int inRefCountOffset = -1) override;
+	bool						SkipAttributeData(int inArrayDepth, EOSDataType inDataType, const char *inClassName);
+
+protected:
+	/// Constructor
+	explicit					ObjectStreamIn(istream &inStream);
+
+	/// Determine the type and version of an object stream
+	static bool					GetInfo(istream &inStream, EStreamType &outType, int &outVersion, int &outRevision);
+
+	/// Static constructor
+	static ObjectStreamIn *		Open(istream &inStream);
+
+	istream &					mStream;
+
+private:
+	/// Class descriptions
+	struct AttributeDescription
+	{
+		int						mArrayDepth = 0;
+		EOSDataType				mSourceType = EOSDataType::Invalid;
+		EOSDataType				mDestinationType = EOSDataType::Invalid;
+		String					mClassName;
+		int						mIndex = -1;
+	};
+
+	struct ClassDescription
+	{
+								ClassDescription() = default;
+		explicit				ClassDescription(const RTTI *inRTTI)					: mRTTI(inRTTI) { }
+
+		const RTTI *			mRTTI = nullptr;
+		Array<AttributeDescription>	mAttributes;
+	};
+
+	struct ObjectInfo
+	{
+								ObjectInfo() = default;
+								ObjectInfo(void *inInstance, const RTTI *inRTTI)		: mInstance(inInstance), mRTTI(inRTTI) { }
+
+		void *					mInstance = nullptr;
+		const RTTI *			mRTTI = nullptr;
+	};
+
+	struct Link
+	{
+		void **					mPointer;
+		int						mRefCountOffset;
+		Identifier				mIdentifier;
+		const RTTI *			mRTTI;
+	};
+
+	using IdentifierMap = UnorderedMap<Identifier, ObjectInfo>;
+	using ClassDescriptionMap = UnorderedMap<String, ClassDescription>;
+
+	ClassDescriptionMap			mClassDescriptionMap;
+	IdentifierMap				mIdentifierMap;											///< Links identifier to an object pointer
+	Array<Link>					mUnresolvedLinks;										///< All pointers (links) are resolved after reading the entire file, e.g. when all object exist
+};
+
+JPH_NAMESPACE_END
+
+#endif // JPH_OBJECT_STREAM

package/native/third_party/JoltPhysics/Jolt/ObjectStream/ObjectStreamOut.cpp

@@ -0,0 +1,166 @@
+// Jolt Physics Library (https://github.com/jrouwe/JoltPhysics)
+// SPDX-FileCopyrightText: 2021 Jorrit Rouwe
+// SPDX-License-Identifier: MIT
+
+#include <Jolt/Jolt.h>
+
+#include <Jolt/ObjectStream/ObjectStreamOut.h>
+#include <Jolt/ObjectStream/ObjectStreamTextOut.h>
+#include <Jolt/ObjectStream/ObjectStreamBinaryOut.h>
+#include <Jolt/ObjectStream/TypeDeclarations.h>
+
+#ifdef JPH_OBJECT_STREAM
+
+JPH_NAMESPACE_BEGIN
+
+ObjectStreamOut::ObjectStreamOut(ostream &inStream) :
+	mStream(inStream)
+{
+// Add all primitives to the class set
+#define JPH_DECLARE_PRIMITIVE(name)	mClassSet.insert(JPH_RTTI(name));
+#include <Jolt/ObjectStream/ObjectStreamTypes.h>
+}
+
+ObjectStreamOut *ObjectStreamOut::Open(EStreamType inType, ostream &inStream)
+{
+	switch (inType)
+	{
+	case EStreamType::Text:		return new ObjectStreamTextOut(inStream);
+	case EStreamType::Binary:	return new ObjectStreamBinaryOut(inStream);
+	default:					JPH_ASSERT(false);
+	}
+	return nullptr;
+}
+
+bool ObjectStreamOut::Write(const void *inObject, const RTTI *inRTTI)
+{
+	// Assign a new identifier to the object and write it
+	mIdentifierMap.try_emplace(inObject, mNextIdentifier, inRTTI);
+	mNextIdentifier++;
+	WriteObject(inObject);
+
+	// Write all linked objects
+	ObjectQueue::size_type cur = 0;
+	for (; cur < mObjectQueue.size() && !mStream.fail(); ++cur)
+		WriteObject(mObjectQueue[cur]);
+	mObjectQueue.erase(mObjectQueue.begin(), mObjectQueue.begin() + cur);
+
+	return !mStream.fail();
+}
+
+void ObjectStreamOut::WriteObject(const void *inObject)
+{
+	// Find object identifier
+	IdentifierMap::iterator i = mIdentifierMap.find(inObject);
+	JPH_ASSERT(i != mIdentifierMap.end());
+
+	// Write class description and associated descriptions
+	QueueRTTI(i->second.mRTTI);
+	ClassQueue::size_type cur = 0;
+	for (; cur < mClassQueue.size() && !mStream.fail(); ++cur)
+		WriteRTTI(mClassQueue[cur]);
+	mClassQueue.erase(mClassQueue.begin(), mClassQueue.begin() + cur);
+
+	HintNextItem();
+	HintNextItem();
+
+	// Write object header.
+	WriteDataType(EOSDataType::Object);
+	WriteName(i->second.mRTTI->GetName());
+	WriteIdentifier(i->second.mIdentifier);
+
+	// Write attribute data
+	WriteClassData(i->second.mRTTI, inObject);
+}
+
+void ObjectStreamOut::QueueRTTI(const RTTI *inRTTI)
+{
+	ClassSet::const_iterator i = mClassSet.find(inRTTI);
+	if (i == mClassSet.end())
+	{
+		mClassSet.insert(inRTTI);
+		mClassQueue.push_back(inRTTI);
+	}
+}
+
+void ObjectStreamOut::WriteRTTI(const RTTI *inRTTI)
+{
+	HintNextItem();
+	HintNextItem();
+
+	// Write class header. E.g. in text mode: "class <name> <attr-count>"
+	WriteDataType(EOSDataType::Declare);
+	WriteName(inRTTI->GetName());
+	WriteCount(inRTTI->GetAttributeCount());
+
+	// Write class attribute info
+	HintIndentUp();
+	for (int attr_index = 0; attr_index < inRTTI->GetAttributeCount(); ++attr_index)
+	{
+		// Get attribute
+		const SerializableAttribute &attr = inRTTI->GetAttribute(attr_index);
+
+		// Write definition of attribute class if undefined
+		const RTTI *rtti = attr.GetMemberPrimitiveType();
+		if (rtti != nullptr)
+			QueueRTTI(rtti);
+
+		HintNextItem();
+
+		// Write attribute information.
+		WriteName(attr.GetName());
+		attr.WriteDataType(*this);
+	}
+	HintIndentDown();
+}
+
+void ObjectStreamOut::WriteClassData(const RTTI *inRTTI, const void *inInstance)
+{
+	JPH_ASSERT(inInstance);
+
+	// Write attributes
+	HintIndentUp();
+	for (int attr_index = 0; attr_index < inRTTI->GetAttributeCount(); ++attr_index)
+	{
+		// Get attribute
+		const SerializableAttribute &attr = inRTTI->GetAttribute(attr_index);
+		attr.WriteData(*this, inInstance);
+	}
+	HintIndentDown();
+}
+
+void ObjectStreamOut::WritePointerData(const RTTI *inRTTI, const void *inPointer)
+{
+	Identifier identifier;
+
+	if (inPointer)
+	{
+		// Check if this object has an identifier
+		IdentifierMap::iterator i = mIdentifierMap.find(inPointer);
+		if (i != mIdentifierMap.end())
+		{
+			// Object already has an identifier
+			identifier = i->second.mIdentifier;
+		}
+		else
+		{
+			// Assign a new identifier to this object and queue it for serialization
+			identifier = mNextIdentifier++;
+			mIdentifierMap.try_emplace(inPointer, identifier, inRTTI);
+			mObjectQueue.push_back(inPointer);
+		}
+	}
+	else
+	{
+		// Write nullptr pointer
+		identifier = sNullIdentifier;
+	}
+
+	// Write the identifier
+	HintNextItem();
+	WriteIdentifier(identifier);
+}
+
+JPH_NAMESPACE_END
+
+#endif // JPH_OBJECT_STREAM

package/native/third_party/JoltPhysics/Jolt/ObjectStream/ObjectStreamOut.h

@@ -0,0 +1,101 @@
+// Jolt Physics Library (https://github.com/jrouwe/JoltPhysics)
+// SPDX-FileCopyrightText: 2021 Jorrit Rouwe
+// SPDX-License-Identifier: MIT
+
+#pragma once
+
+#include <Jolt/ObjectStream/ObjectStream.h>
+#include <Jolt/Core/RTTI.h>
+#include <Jolt/Core/UnorderedMap.h>
+#include <Jolt/Core/UnorderedSet.h>
+
+JPH_SUPPRESS_WARNINGS_STD_BEGIN
+#include <fstream>
+JPH_SUPPRESS_WARNINGS_STD_END
+
+#ifdef JPH_OBJECT_STREAM
+
+JPH_NAMESPACE_BEGIN
+
+/// ObjectStreamOut contains all logic for writing an object to disk. It is the base
+/// class for the text and binary output streams (ObjectStreamTextOut and ObjectStreamBinaryOut).
+class JPH_EXPORT ObjectStreamOut : public IObjectStreamOut
+{
+private:
+	struct ObjectInfo;
+
+public:
+	/// Main function to write an object to a stream
+	template <class T>
+	static bool	sWriteObject(ostream &inStream, ObjectStream::EStreamType inType, const T &inObject)
+	{
+		// Create the output stream
+		bool result = false;
+		ObjectStreamOut *stream = ObjectStreamOut::Open(inType, inStream);
+		if (stream)
+		{
+			// Write the object to the stream
+			result = stream->Write((void *)&inObject, GetRTTI(&inObject));
+			delete stream;
+		}
+
+		return result;
+	}
+
+	/// Main function to write an object to a file
+	template <class T>
+	static bool	sWriteObject(const char *inFileName, ObjectStream::EStreamType inType, const T &inObject)
+	{
+		std::ofstream stream;
+		stream.open(inFileName, std::ofstream::out | std::ofstream::trunc | std::ofstream::binary);
+		if (!stream.is_open())
+			return false;
+		return sWriteObject(stream, inType, inObject);
+	}
+
+	//////////////////////////////////////////////////////
+	// EVERYTHING BELOW THIS SHOULD NOT DIRECTLY BE CALLED
+	//////////////////////////////////////////////////////
+
+	///@name Serialization operations
+	bool						Write(const void *inObject, const RTTI *inRTTI);
+	void						WriteObject(const void *inObject);
+	void						QueueRTTI(const RTTI *inRTTI);
+	void						WriteRTTI(const RTTI *inRTTI);
+	virtual void				WriteClassData(const RTTI *inRTTI, const void *inInstance) override;
+	virtual void				WritePointerData(const RTTI *inRTTI, const void *inPointer) override;
+
+protected:
+	/// Static constructor
+	static ObjectStreamOut *	Open(EStreamType inType, ostream &inStream);
+
+	/// Constructor
+	explicit					ObjectStreamOut(ostream &inStream);
+
+	ostream &					mStream;
+
+private:
+	struct ObjectInfo
+	{
+								ObjectInfo()												: mIdentifier(0), mRTTI(nullptr) { }
+								ObjectInfo(Identifier inIdentifier, const RTTI *inRTTI)		: mIdentifier(inIdentifier), mRTTI(inRTTI) { }
+
+		Identifier				mIdentifier;
+		const RTTI *			mRTTI;
+	};
+
+	using IdentifierMap = UnorderedMap<const void *, ObjectInfo>;
+	using ClassSet = UnorderedSet<const RTTI *>;
+	using ObjectQueue = Array<const void *>;
+	using ClassQueue = Array<const RTTI *>;
+
+	Identifier					mNextIdentifier = sNullIdentifier + 1;						///< Next free identifier for this stream
+	IdentifierMap				mIdentifierMap;												///< Links object pointer to an identifier
+	ObjectQueue					mObjectQueue;												///< Queue of objects to be written
+	ClassSet					mClassSet;													///< List of classes already written
+	ClassQueue					mClassQueue;												///< List of classes waiting to be written
+};
+
+JPH_NAMESPACE_END
+
+#endif // JPH_OBJECT_STREAM