PropertyNetSerializerInfoRegistry.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Containers/Array.h"
#include "Iris/Serialization/NetSerializer.h"
#include "Iris/Serialization/NetSerializerDelegates.h"
#include "Templates/Casts.h"
#include "Templates/Tuple.h"
#include "UObject/NameTypes.h"
#include "UObject/UnrealType.h"
 
namespace UE::Net
{
 
class FFragmentRegistrationContext;
class FReplicationFragment;
struct FReplicationStateDescriptor;
enum class EReplicationStateTraits : uint32;
typedef FReplicationFragment* (*CreateAndRegisterReplicationFragmentFunc)(UObject*, const FReplicationStateDescriptor*, FFragmentRegistrationContext&);
 
}
 
namespace UE::Net
{
 
template<typename StructName>
constexpr auto IsDeclaredType(StructName*) -> decltype(sizeof(StructName))
{
    return true;
}
 
constexpr auto IsDeclaredType(void*)
{
    return false;
}
 
struct FPropertyNetSerializerInfo
{
    virtual const FFieldClass* GetPropertyTypeClass() const { return nullptr; }
    virtual bool IsSupported(const FProperty* Property) const { return true; }
    virtual const FNetSerializer* GetNetSerializer(const FProperty* Property) const { return nullptr; }
    virtual bool CanUseDefaultConfig(const FProperty* Property) const { return true; }
    virtual const FNetSerializerConfig* BuildNetSerializerConfig(void* NetSerializerConfigBuffer, const FProperty* Property) const { return nullptr; }
    virtual CreateAndRegisterReplicationFragmentFunc GetCreateAndRegisterReplicationFragmentFunction() const { return nullptr; }
 
    bool IsSupportedStruct(FName InStructName) const
    {
        return StructName == InStructName;
    }
 
protected:
    // Used by named struct serializers.
    FName StructName;
};
 
class FPropertyNetSerializerInfoRegistry
{
public:
    IRISCORE_API static void Register(const FPropertyNetSerializerInfo* Info);
    IRISCORE_API static void Unregister(const FPropertyNetSerializerInfo* Info);
 
    IRISCORE_API static void Reset();
 
    IRISCORE_API static void Freeze();
 
    IRISCORE_API static const FPropertyNetSerializerInfo* FindSerializerInfo(const FProperty* Property);
 
    IRISCORE_API static const FPropertyNetSerializerInfo* FindStructSerializerInfo(const FName Name);
 
    IRISCORE_API static const FPropertyNetSerializerInfo* GetNopNetSerializerInfo();
 
private:
    typedef TTuple<const FFieldClass*, const FPropertyNetSerializerInfo*> FRegistryEntry;
    typedef TArray<FRegistryEntry> FNetSerializerInfoRegistry;
 
    static bool bRegistryIsDirty;
    static FNetSerializerInfoRegistry Registry; 
};
 
// Helper to implement simple default PropertyNetSerializerInfo for primitive types
template <typename T, typename ConfigType = FNetSerializerConfig>
struct TSimplePropertyNetSerializerInfo : public FPropertyNetSerializerInfo
{
    const FNetSerializer& Serializer;
 
    TSimplePropertyNetSerializerInfo(const FNetSerializer& InSerializer) : Serializer(InSerializer) {}
    virtual const FFieldClass* GetPropertyTypeClass() const override { return T::StaticClass(); }
    virtual const FNetSerializer* GetNetSerializer(const FProperty* Property) const override { return &Serializer; }
    virtual FNetSerializerConfig* BuildNetSerializerConfig(void* NetSerializerConfigBuffer, const FProperty* Property) const override { return new (NetSerializerConfigBuffer) ConfigType; }
};
 
// Helper to implement simple default PropertyNetSerializerInfo for structs
struct FNamedStructPropertyNetSerializerInfo : public TSimplePropertyNetSerializerInfo<FStructProperty>
{
    typedef TSimplePropertyNetSerializerInfo<FStructProperty> Super;
 
    FNamedStructPropertyNetSerializerInfo(const FName InPropertyFName, const FNetSerializer& InSerializer)
    : Super(InSerializer)
    {
        StructName = InPropertyFName;
    }
 
    virtual bool IsSupported(const FProperty* Property) const override
    {   
        const FStructProperty* StructProp = CastFieldChecked<const FStructProperty>(Property);
        return IsSupportedStruct(StructProp->Struct->GetFName());
    };
 
    virtual CreateAndRegisterReplicationFragmentFunc GetCreateAndRegisterReplicationFragmentFunction() const
    {
        return CreateAndRegisterReplicationFragmentFunction;
    }
 
    void SetCreateAndRegisterReplicationFragmentFunction(CreateAndRegisterReplicationFragmentFunc InCreateAndRegisterReplicationFragmentFunction)
    {
        CreateAndRegisterReplicationFragmentFunction = InCreateAndRegisterReplicationFragmentFunction;
    }
 
private:
    CreateAndRegisterReplicationFragmentFunc CreateAndRegisterReplicationFragmentFunction = nullptr;
};
 
struct FLastResortPropertyNetSerializerInfo : public FPropertyNetSerializerInfo
{
    IRISCORE_API FLastResortPropertyNetSerializerInfo();
    IRISCORE_API explicit FLastResortPropertyNetSerializerInfo(const uint32 InMaxQuantizedSizeBits);
 
    IRISCORE_API virtual const FFieldClass* GetPropertyTypeClass() const override;
    IRISCORE_API virtual bool IsSupported(const FProperty* Property) const override;
    IRISCORE_API virtual const FNetSerializer* GetNetSerializer(const FProperty* Property) const override final;
    IRISCORE_API virtual bool CanUseDefaultConfig(const FProperty* Property) const override final;
    IRISCORE_API virtual FNetSerializerConfig* BuildNetSerializerConfig(void* NetSerializerConfigBuffer, const FProperty* Property) const override final;
 
protected:
    // Maximum size of quantized state in bits
    uint32 MaxQuantizedSizeBits;
 
    // If set this class should not be included in the default state hash.
    bool bExcludeFromDefaultStateHash = false;
};
 
struct FNamedStructLastResortPropertyNetSerializerInfo final : public FLastResortPropertyNetSerializerInfo
{
    FNamedStructLastResortPropertyNetSerializerInfo(const FName InPropertyFName)
    : FLastResortPropertyNetSerializerInfo()
    {
        StructName = InPropertyFName;
    }
 
    FNamedStructLastResortPropertyNetSerializerInfo(const FName InPropertyFName, const uint32 InMaxBits)
    : FLastResortPropertyNetSerializerInfo(InMaxBits)
    {
        StructName = InPropertyFName;
    }
 
    IRISCORE_API virtual const FFieldClass* GetPropertyTypeClass() const override;
    IRISCORE_API virtual bool IsSupported(const FProperty* Property) const override;
};
 
// Issue fatal error if matching trait found in UsedReplicationStateTraits is not set for the Serializer.
void IRISCORE_API ValidateForwardingNetSerializerTraits(const FNetSerializer* Serializer, EReplicationStateTraits UsedReplicationStateTraits);
 
}
 
// Produce a compiler error if the name does not correspond to a declared UE type.
#define UE_NET_IS_DECLARED_TYPE(Name) \
    static_assert( \
    UE::Net::IsDeclaredType((struct F##Name*)nullptr) || \
    UE::Net::IsDeclaredType((struct U##Name*)nullptr) \
    , "The UE type name '" #Name "' cannot be found. Make sure you have removed the 'F' or 'U' prefix from the type name.");
 
// Only needed if we want to export PropertyNetSerializerInfo, this goes in the header if we need to export it
#define UE_NET_DECLARE_NETSERIALIZER_INFO(NetSerializerInfo) \
const UE::Net::FPropertyNetSerializerInfo& GetPropertyNetSerializerInfo_##NetSerializerInfo();
 
// Implement FPropertyNetSerializerInfo from struct, this goes in the cpp file
#define UE_NET_IMPLEMENT_NETSERIALIZER_INFO(NetSerializerInfo) \
const UE::Net::FPropertyNetSerializerInfo& GetPropertyNetSerializerInfo_##NetSerializerInfo() { static NetSerializerInfo StaticInstance; return StaticInstance; };
 
// Implement simple FPropertyNetSerializerInfo binding a SerializerType to the property
#define UE_NET_IMPLEMENT_SIMPLE_NETSERIALIZER_INFO(PropertyType, SerializerName) \
const UE::Net::FPropertyNetSerializerInfo& GetPropertyNetSerializerInfo_##PropertyType() { static UE::Net::TSimplePropertyNetSerializerInfo<PropertyType> StaticInstance(UE_NET_GET_SERIALIZER(SerializerName)); return StaticInstance; };
 
// Implement simple FPropertyNetSerializerInfo for struct types with custom serializers
#define UE_NET_IMPLEMENT_NAMED_STRUCT_NETSERIALIZER_INFO(Name, SerializerName) \
const UE::Net::FPropertyNetSerializerInfo& GetPropertyNetSerializerInfo_##Name() { static UE::Net::FNamedStructPropertyNetSerializerInfo StaticInstance(Name, UE_NET_GET_SERIALIZER(SerializerName)); return StaticInstance; };
 
#define UE_NET_IMPLEMENT_NAMED_STRUCT_NETSERIALIZER_WITH_CUSTOM_FRAGMENT_INFO(Name, SerializerName, CreateAndRegisterReplicationFragmentFunction) \
const UE::Net::FPropertyNetSerializerInfo& GetPropertyNetSerializerInfo_##Name() \
{ \
    static UE::Net::FNamedStructPropertyNetSerializerInfo StaticInstance(Name, UE_NET_GET_SERIALIZER(SerializerName)); \
    StaticInstance.SetCreateAndRegisterReplicationFragmentFunction(CreateAndRegisterReplicationFragmentFunction); \
    return StaticInstance; \
};
 
// Implement FPropertyNetSerializerInfo for cases where LastResortPropertyNetSerializer is needed for struct with custom serialization.
#define UE_NET_IMPLEMENT_NAMED_STRUCT_LASTRESORT_NETSERIALIZER_INFO(StructName) \
const UE::Net::FPropertyNetSerializerInfo& GetPropertyNetSerializerInfo_##StructName() { static UE::Net::FNamedStructLastResortPropertyNetSerializerInfo StaticInstance(StructName); return StaticInstance; };
 
// Implement FPropertyNetSerializerInfo for cases where LastResortPropertyNetSerializer is needed for struct with custom serialization, with quantized state size override.
#define UE_NET_IMPLEMENT_NAMED_STRUCT_LASTRESORT_NETSERIALIZER_INFO_WITH_SIZE_OVERRIDE(StructName, MaxBits) \
const UE::Net::FPropertyNetSerializerInfo& GetPropertyNetSerializerInfo_##StructName() { static UE::Net::FNamedStructLastResortPropertyNetSerializerInfo StaticInstance(StructName, MaxBits); return StaticInstance; };
 
// Register 
#define UE_NET_REGISTER_NETSERIALIZER_INFO(Name) \
UE::Net::FPropertyNetSerializerInfoRegistry::Register(&GetPropertyNetSerializerInfo_##Name());
 
// Unregister
#if !IS_MONOLITHIC
#define UE_NET_UNREGISTER_NETSERIALIZER_INFO(Name) \
UE::Net::FPropertyNetSerializerInfoRegistry::Unregister(&GetPropertyNetSerializerInfo_##Name());
#else
#define UE_NET_UNREGISTER_NETSERIALIZER_INFO(...) 
#endif
 
// Implement minimal required delegates for a NetSerializer
#define UE_NET_IMPLEMENT_NETSERIALIZER_REGISTRY_DELEGATES(Name) \
struct F##Name##NetSerializerRegistryDelegates : protected UE::Net::FNetSerializerRegistryDelegates \
{ \
    ~F##Name##NetSerializerRegistryDelegates() { UE_NET_UNREGISTER_NETSERIALIZER_INFO(PropertyNetSerializerRegistry_NAME_##Name); } \
    virtual void OnPreFreezeNetSerializerRegistry() override { UE_NET_REGISTER_NETSERIALIZER_INFO(PropertyNetSerializerRegistry_NAME_##Name); } \
}; \
static F##Name##NetSerializerRegistryDelegates Name##NetSerializerRegistryDelegates;
 
// Utility that can be used to forward serialization of a Struct to a specific NetSerializer
#define UE_NET_IMPLEMENT_FORWARDING_NETSERIALIZER_AND_REGISTRY_DELEGATES(Name, SerializerName) \
    static const FName PropertyNetSerializerRegistry_NAME_##Name( PREPROCESSOR_TO_STRING(Name) ); \
    UE_NET_IMPLEMENT_NAMED_STRUCT_NETSERIALIZER_INFO(PropertyNetSerializerRegistry_NAME_##Name, SerializerName); \
    UE_NET_IMPLEMENT_NETSERIALIZER_REGISTRY_DELEGATES(Name)
 
 
// Utility that can be used to forward serialization of a Struct to a last resort net serializer
#define UE_NET_IMPLEMENT_NAMED_STRUCT_LASTRESORT_NETSERIALIZER_AND_REGISTRY_DELEGATES(Name) \
    UE_NET_IS_DECLARED_TYPE(Name); \
    static const FName PropertyNetSerializerRegistry_NAME_##Name( PREPROCESSOR_TO_STRING(Name) ); \
    UE_NET_IMPLEMENT_NAMED_STRUCT_LASTRESORT_NETSERIALIZER_INFO(PropertyNetSerializerRegistry_NAME_##Name); \
    UE_NET_IMPLEMENT_NETSERIALIZER_REGISTRY_DELEGATES(Name)
 
// Utility that can be used to forward serialization of a Struct to a last resort net serializer with a maximum quantized size
#define UE_NET_IMPLEMENT_NAMED_STRUCT_LASTRESORT_NETSERIALIZER_AND_REGISTRY_DELEGATES_WITH_SIZE_OVERRIDE(Name, MaxBits) \
    UE_NET_IS_DECLARED_TYPE(Name); \
    static const FName PropertyNetSerializerRegistry_NAME_##Name( PREPROCESSOR_TO_STRING(Name) ); \
    UE_NET_IMPLEMENT_NAMED_STRUCT_LASTRESORT_NETSERIALIZER_INFO_WITH_SIZE_OVERRIDE(PropertyNetSerializerRegistry_NAME_##Name, MaxBits); \
    UE_NET_IMPLEMENT_NETSERIALIZER_REGISTRY_DELEGATES(Name)