Serializer.hpp

Go to the documentation of this file.

//
//  CeresEngine - A game development framework
//
//  Created by Rogiel Sulzbach.
//  Copyright (c) 2018-2022 Rogiel Sulzbach. All rights reserved.
//
 
#pragma once
 
#include "Forward.hpp"
#include "CeresEngine/Reflection/Forward.hpp"
 
#include "Serialization.hpp"
 
#include "CeresEngine/DataTypes.hpp"
 
#include "CeresEngine/Foundation/Function.hpp"
#include "CeresEngine/Foundation/Container/Map.hpp"
#include "CeresEngine/Foundation/IO/Stream.hpp"
 
namespace CeresEngine {
 
#define CE_SERIALIZER_PRIMITIVE_TYPES(F) \
    F(float, Float)                      \
    F(double, Double)                    \
    F(UInt8, UInt8)                      \
    F(UInt16, UInt16)                    \
    F(UInt32, UInt32)                    \
    F(UInt64, UInt64)                    \
    F(Int8, Int8)                        \
    F(Int16, Int16)                      \
    F(Int32, Int32)                      \
    F(Int64, Int64)                      \
    F(bool, Boolean)
 
    class ISerializer {
    public:
        virtual ~ISerializer() noexcept = default;
 
    public:
        virtual void serialize(const Box& value) = 0;
    };
 
    class SerializerState final : public SerializationState {
    public:
        SerializedObjectID nextObjectID = 0;
 
        HashMap<Pair<TypeID, const void*>, SerializedObjectID> serializedObjects;
    };
 
    class Serializer : public ISerializer {
    public:
        const SerializationContext& context;
 
        SerializerState state;
 
    public:
        explicit Serializer(const SerializationContext& context = SerializationContext::getDefault());
 
        ~Serializer() noexcept override;
 
    public: // Serializer interface
        void serialize(const Box& value) final;
 
        virtual void resetState();
 
    protected: // Object Encoding
        virtual void beginObject(const SerializedObjectMetadata& metadata) = 0;
 
        virtual void endObject() = 0;
 
        virtual void beginObjectProperty(const SerializedPropertyMetadata& metadata) = 0;
 
        virtual void endObjectProperty() = 0;
 
        virtual void encodeObjectReference(SerializedObjectID referenceID) = 0;
 
        virtual void beginCustomObject(const SerializedCustomObjectMetadata& metadata) = 0;
 
        virtual void endCustomObject() = 0;
 
    protected: // Array encoding
        virtual void beginArray(const SerializedArrayMetadata& metadata) = 0;
 
        virtual void endArray() = 0;
 
    protected: // Map encoding
        virtual void beginMap(const SerializedMapMetadata& metadata) = 0;
 
        virtual void endMap() = 0;
 
    protected: // Primitive encoding
#define CE_SERIALIZER_ENCODER_PRIMITIVE_TYPE(T, N) virtual void encode##N(T value) = 0;
        CE_SERIALIZER_PRIMITIVE_TYPES(CE_SERIALIZER_ENCODER_PRIMITIVE_TYPE)
#undef CE_SERIALIZER_ENCODER_PRIMITIVE_TYPE
        virtual void encodeString(StringView string) = 0;
        virtual void encodeBinary(MemoryView<const Byte> data) = 0;
 
        virtual void encodeUndefined() = 0;
 
        virtual void encodeNull() = 0;
 
    private: // Reflection visiting
        void visit(const Box& value);
 
        void visitObject(const Box& value);
 
        void visitObjectProperty(const Box& value, const ClassProperty& metaProperty);
 
        void visitEnum(const Box& value);
 
        void visitArray(const Box& value);
 
        void visitMap(const Box& value);
 
    private:
        [[nodiscard]] bool shouldSerializeObjectProperty(const Box& value, const ClassProperty& property) const;
    };
 
} // namespace CeresEngine