PropertyHelper.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
#pragma once
 
#include "CoreTypes.h"
#include "Logging/LogMacros.h"
#include "UObject/NameTypes.h"
#include "UObject/PropertyPathName.h"
#include "UObject/PropertyTypeName.h"
#include "UObject/ScriptDelegateFwd.h"
#include "UObject/UObjectThreadContext.h"
#include "UObject/WeakObjectPtrFwd.h"
#include "UObject/ObjectMacros.h"
#include "UObject/ScriptMacros.h"
 
#include "PropertyHelper.generated.h"
 
class FProperty;
class UField;
class UFunction;
class UObject;
 
DECLARE_LOG_CATEGORY_EXTERN(LogEnum, Log, All);
DECLARE_LOG_CATEGORY_EXTERN(LogProperty, Log, All);
 
UENUM()
enum class EFallbackEnum : uint8
{
};
 
COREUOBJECT_API void SkipWhitespace(const TCHAR*& Str);
 
COREUOBJECT_API bool AreInstancedObjectsIdentical( UObject* ObjectA, UObject* ObjectB, uint32 PortFlags );
 
struct FDeltaIndexHelper
{
    FDeltaIndexHelper() = default;
 
    COREUOBJECT_API bool SerializeNext(FArchive &Ar, int32& Index);
 
    COREUOBJECT_API void SerializeNext(FArchive &OutBunch, FArchive &OutFull, int32 Index);
 
    void Increment(int32 NewIndex)
    {
        LastIndex = NewIndex;
    }
 
    COREUOBJECT_API void SerializeEarlyEnd(FArchive &Ar);
 
    int32 LastIndex     = -1; // Start at -1 so index 0 can be serialized as delta=1 (so that 0 can be reserved for 'no more')
    int32 LastIndexFull = -1; // Separate index for full state since it will never be rolled back
};
 
namespace DelegatePropertyTools
{
    COREUOBJECT_API const TCHAR* ImportDelegateFromText( FScriptDelegate& Delegate, const UFunction* SignatureFunction, const TCHAR* Buffer, UObject* Parent, FOutputDevice* ErrorText );
}
 
namespace UE
{
 
UObject* FindObjectByTypePath(UClass* Class, FPropertyTypeName TypePath);
 
template <typename T>
T* FindObjectByTypePath(FPropertyTypeName TypePath)
{
    return (T*)FindObjectByTypePath(T::StaticClass(), TypePath);
}
 
#if WITH_EDITORONLY_DATA
inline const FName NAME_OriginalType(ANSITEXTVIEW("OriginalType"));
const FString* FindOriginalTypeName(const UField* Field);
const FString* FindOriginalTypeName(const FProperty* Property);
FPropertyTypeName FindOriginalType(const UField* Field);
FPropertyTypeName FindOriginalType(const FProperty* Property);
#endif // WITH_EDITORONLY_DATA
 
FPropertyTypeName ApplyRedirectsToPropertyType(FPropertyTypeName OldTypeName, const FProperty* Property = nullptr);
 
class FSerializedPropertyPathScope
{
public:
    [[nodiscard]] FSerializedPropertyPathScope(FUObjectSerializeContext* InContext, const FPropertyPathNameSegment& InSegment)
    {
    #if WITH_EDITORONLY_DATA
        if (InContext->bTrackSerializedPropertyPath)
        {
            Context = InContext;
            Context->SerializedPropertyPath.Push(InSegment);
        }
    #endif
    }
 
    ~FSerializedPropertyPathScope()
    {
    #if WITH_EDITORONLY_DATA
        if (Context)
        {
            Context->SerializedPropertyPath.Pop();
        }
    #endif
    }
 
    FSerializedPropertyPathScope(const FSerializedPropertyPathScope&) = delete;
    FSerializedPropertyPathScope& operator=(const FSerializedPropertyPathScope&) = delete;
 
private:
    FUObjectSerializeContext* Context = nullptr;
};
 
} // UE