IStructSerializerBackend.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Misc/EnumClassFlags.h"
#include "UObject/Field.h"
#include "UObject/UnrealType.h"
 
enum class EStructSerializerBackendFlags
{
    None = 0,
 
    WriteTextAsComplexString = 1<<0,
 
    WriteByteArrayAsByteStream = 1<<1,
 
    WriteCborStandardEndianness = 1 << 2,
 
    WriteLWCTypesAsFloats = 1 << 3,
 
    Legacy = None,
 
    LegacyUE4 = WriteTextAsComplexString | WriteByteArrayAsByteStream | WriteLWCTypesAsFloats,
 
    Default = WriteTextAsComplexString | WriteByteArrayAsByteStream,
};
ENUM_CLASS_FLAGS(EStructSerializerBackendFlags);
 
 
enum class EStructSerializerStateFlags
{
    None = 0,
 
     WritingContainerElement = 1 << 0,
};
ENUM_CLASS_FLAGS(EStructSerializerStateFlags);
 
struct FStructSerializerState
{
    FStructSerializerState() = default;
 
    FStructSerializerState(void* InValuePtr, FProperty* InProperty, EStructSerializerStateFlags InFlags)
        : ValueData(InValuePtr)
        , ValueProperty(InProperty)
        , FieldType(InProperty->GetClass())
        , StateFlags(InFlags)
    {
    }
 
    bool HasBeenProcessed = false;
 
    const void* KeyData = nullptr;
 
    FProperty* KeyProperty = nullptr;
 
    const void* ValueData = nullptr;
 
    FProperty* ValueProperty = nullptr;
 
    UStruct* ValueType = nullptr;
 
    FFieldClass* FieldType = nullptr;
 
    int32 ElementIndex = INDEX_NONE;
 
    EStructSerializerStateFlags StateFlags = EStructSerializerStateFlags::None;
};
 
 
class IStructSerializerBackend
{
public:
 
    virtual void BeginArray(const FStructSerializerState& State) = 0;
 
    virtual void BeginStructure(const FStructSerializerState& State) = 0;
 
    virtual void EndArray(const FStructSerializerState& State) = 0;
 
    virtual void EndStructure(const FStructSerializerState& State) = 0;
 
    virtual void WriteComment(const FString& Comment) = 0;
 
    virtual void WriteProperty(const FStructSerializerState& State, int32 ArrayIndex = 0) = 0;
 
    virtual bool WritePODArray(const FStructSerializerState& State) { return false; };
 
public:
 
    virtual ~IStructSerializerBackend() { }
};