UniversalObjectLocatorFragmentType.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreTypes.h"
#include "Misc/AssertionMacros.h"
#include "Misc/AsciiSet.h"
#include "Misc/StringBuilder.h"
#include "Containers/PagedArray.h"
#include "Containers/StringView.h"
 
#include "UObject/ObjectPtr.h"
#include "UObject/Class.h"
 
#include "UniversalObjectLocatorFwd.h"
#include "UniversalObjectLocatorResolveParams.h"
#include "UniversalObjectLocatorFragmentDebugging.h"
 
namespace UE::UniversalObjectLocator
{
 
struct IPayloadDebugging;
struct IFragmentTypeDebuggingAssistant;
 
enum class EFragmentTypeFlags : uint8
{
    None,
 
    CanBeLoaded = 1 << 0,
 
    LoadedByDefault = 1 << 1,
};
 
ENUM_CLASS_FLAGS(EFragmentTypeFlags)
 
 
 
struct FFragmentType
{
    FResolveResult ResolvePayload(const void* Payload, const FResolveParams& Params) const;
    FInitializeResult InitializePayload(void* Payload, const FInitializeParams& InParams) const;
    void ToString(const void* Payload, FStringBuilderBase& OutStringBuilder) const;
    FParseStringResult TryParseString(void* Payload, FStringView InString, const FParseStringParams& Params) const;
 
    uint32 ComputePriority(const UObject* Object, const UObject* Context) const;
 
    using FResolveCallback    = FResolveResult (*)(const void* /* Payload */, const FResolveParams& /* Params */);
    using FInitializeCallback = FInitializeResult (*)(void* /* Payload */, const FInitializeParams&);
    using FToString           = void (*)(const void* /* Payload */, FStringBuilderBase& /* OutStringBuilder */);
    using FTryParseString     = FParseStringResult (*)(void* /* Payload */, FStringView /* InString */, const FParseStringParams& /* Params */);
 
    using FPriorityCallback   = uint32 (*)(const UObject* /* Object */, const UObject* /* Context */);
 
#if UE_UNIVERSALOBJECTLOCATOR_DEBUG
    using FFragmentDebugInitializer = void (*)(void*);
#endif
 
    struct
    {
        FInitializeCallback Initialize;
        FResolveCallback    Resolve;
        FToString           ToString;
        FTryParseString     TryParseString;
    } InstanceBindings;
 
    struct
    {
        FPriorityCallback   Priority;
#if UE_UNIVERSALOBJECTLOCATOR_DEBUG
        FFragmentDebugInitializer FragmentDebugInitializer;
#endif
    } StaticBindings;
 
    TObjectPtr<const UScriptStruct> PayloadType;
 
    FText DisplayText;
 
    FName FragmentTypeID;
 
    FName PrimaryEditorType;
 
    EFragmentTypeFlags Flags;
 
    UScriptStruct* GetStruct() const
    {
        return const_cast<UScriptStruct*>(PayloadType.Get());
    }
};
 
template<typename T>
struct TFragmentType : FFragmentType
{
};
 
} // namespace UE::UniversalObjectLocator