libki/include/ki/serialization/SerializerBinary.h

#pragma once
#include <cstdint>
#include "ki/pclass/TypeSystem.h"
#include "ki/pclass/Property.h"
#include "ki/pclass/PropertyClass.h"
#include "ki/util/BitStream.h"
#include "ki/util/FlagsEnum.h"

namespace ki
{
namespace serialization
{
	/**
	 * TODO: Documentation
	 */
	class SerializerBinary
	{
	public:
		/**
		 * These flags control how the serializer reads/writes data.
		 */
		enum class flags : uint32_t
		{
			NONE = 0,

			/**
			 * When enabled, the flags the serializer was constructed with are written
			 * into an unsigned 32-bit integer before writing any data.
			 */
			WRITE_SERIALIZER_FLAGS = 0x01,

			/**
			 * When enabled, the serialized data (after the flags, if present) is compressed.
			 */
			COMPRESSED = 0x08
		};

		/**
		 * Construct a new binary serializer.
		 * @param type_system The TypeSystem instance to acquire Type information from.
		 * @param is_file Determines whether or not to write type sizes, and property headers.
		 * @param flags Determines how serialized data is formatted.
		 */
		explicit SerializerBinary(const pclass::TypeSystem *type_system,
			bool is_file, flags flags);
		virtual ~SerializerBinary() {}

		void save(const pclass::PropertyClass *object, BitStream &stream);
		void load(pclass::PropertyClass *&dest, BitStream &stream);

	protected:
		virtual void presave_object(const pclass::PropertyClass *object, BitStream &stream) const;
		void save_object(const pclass::PropertyClass *object, BitStream &stream) const;
		void save_property(const pclass::PropertyBase *prop, BitStream &stream) const;

		virtual void preload_object(pclass::PropertyClass *&dest, BitStream &stream) const;
		void load_object(pclass::PropertyClass *&dest, BitStream &stream) const;
		void load_property(pclass::PropertyBase *prop, BitStream &stream) const;

	private:
		const pclass::TypeSystem *m_type_system;
		bool m_is_file;
		flags m_flags;

		const pclass::PropertyClass *m_root_object;
	};
}
}

// Make sure the flags enum can be used like a bitflag
MAKE_FLAGS_ENUM(ki::serialization::SerializerBinary::flags);