VVMVerseEnum.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Containers/Utf8String.h"
#include "CoreMinimal.h"
#include "Misc/EnumClassFlags.h"
#include "UObject/Class.h"
#include "UObject/Package.h"
#if WITH_VERSE_VM || defined(__INTELLISENSE__)
#include "VerseVM/VVMEnumeration.h"
#endif
#include "UObject/ObjectMacros.h"
#include "UObject/ScriptMacros.h"
 
#include "VVMVerseEnum.generated.h"
 
class UEnumCookedMetaData;
struct FVniTypeDesc;
namespace uLang
{
class CEnumeration;
}
 
UENUM(Flags)
enum class EVerseEnumFlags : uint32
{
    None = 0x00000000u,
    NativeBound = 0x00000001u,
    UHTNative = 0x00000002u,
};
ENUM_CLASS_FLAGS(EVerseEnumFlags)
 
UCLASS(MinimalAPI)
class UVerseEnum : public UEnum
{
    GENERATED_BODY()
public:
    COREUOBJECT_API UVerseEnum(const FObjectInitializer& ObjectInitialzer);
 
#if UE_WITH_CONSTINIT_UOBJECT
    consteval UVerseEnum(
        UE::CodeGen::ConstInit::FObjectParams ObjectParams,
        UE::CodeGen::ConstInit::FUFieldParams UFieldParams,
        UE::CodeGen::ConstInit::FEnumParams EnumParams,
        UE::CodeGen::ConstInit::FVerseEnumParams InEnumParams)
        : Super(ObjectParams, UFieldParams, EnumParams)
        , CompiledInQualifiedName(InEnumParams.QualifiedName)
        , VerseEnumFlags(EVerseEnumFlags::UHTNative)
        , QualifiedName(ConstEval)
    {
    }
#endif
 
#if UE_WITH_CONSTINIT_UOBJECT
    // CONSTINIT_UOBJECT_TODO: Size increase
    const UTF8CHAR* CompiledInQualifiedName = nullptr;
#endif // UE_WITH_CONSTINIT_UOBJECT
 
    UPROPERTY()
    EVerseEnumFlags VerseEnumFlags = EVerseEnumFlags::None;
 
    UPROPERTY()
    FUtf8String QualifiedName;
 
    // UObject interface.
    COREUOBJECT_API virtual void Serialize(FArchive& Ar) override;
    COREUOBJECT_API virtual void PreSave(FObjectPreSaveContext ObjectSaveContext) override;
 
    bool IsNativeBound() const { return EnumHasAnyFlags(VerseEnumFlags, EVerseEnumFlags::NativeBound); }
    bool IsUHTNative() const { return EnumHasAnyFlags(VerseEnumFlags, EVerseEnumFlags::UHTNative); }
 
    void SetNativeBound() { VerseEnumFlags |= EVerseEnumFlags::NativeBound; }
 
#if WITH_VERSE_VM || defined(__INTELLISENSE__)
    Verse::TWriteBarrier<Verse::VEnumeration> Enumeration;
#endif
 
    const FVniTypeDesc* GetNativeTypeDesc()
    {
        return NativeTypeDesc;
    }
    void SetNativeTypeDesc(const FVniTypeDesc* InNativeTypeDesc) { NativeTypeDesc = InNativeTypeDesc; }
 
private:
#if WITH_EDITORONLY_DATA
    UPROPERTY()
    TObjectPtr<UEnumCookedMetaData> CachedCookedMetaDataPtr;
#endif // WITH_EDITORONLY_DATA
 
    const FVniTypeDesc* NativeTypeDesc{nullptr};
};
 
UENUM()
enum class EVerseFalse : uint8
{
    Value // UHT doesn't correctly support empty enums, so we need a dummy case to make it compile.
};
 
UENUM()
enum class EVerseTrue : uint8
{
    Value // UHT errors if this is called "False".
};