PackageAccessTracking.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreTypes.h"
#include "Misc/Optional.h"
#include "UObject/NameTypes.h"
#include "UObject/ObjectHandleDefines.h"
 
class ITargetPlatform;
 
#define UE_WITH_PACKAGE_ACCESS_TRACKING UE_WITH_OBJECT_HANDLE_TRACKING
 
#if UE_WITH_PACKAGE_ACCESS_TRACKING
#define UE_TRACK_REFERENCING_PACKAGE_SCOPED(Object, OpName) PackageAccessTracking_Private::FPackageAccessRefScope ANONYMOUS_VARIABLE(PackageAccessTracker_)(Object, OpName);
#define UE_TRACK_REFERENCING_PACKAGE_DELAYED_SCOPED(TrackerName, OpName) TOptional<PackageAccessTracking_Private::FPackageAccessRefScope> TrackerName; FName TrackerName##_OpName(OpName);
#define UE_TRACK_REFERENCING_PACKAGE_DELAYED(TrackerName, Package) if (TrackerName) TrackerName->SetPackageName(Package->GetFName()); else TrackerName.Emplace(Package->GetFName(), TrackerName##_OpName);
#define UE_TRACK_REFERENCING_PLATFORM_SCOPED(TargetPlatform) PackageAccessTracking_Private::FPackageAccessRefScope ANONYMOUS_VARIABLE(PackageAccessTracker_)(TargetPlatform);
#define UE_TRACK_REFERENCING_OPNAME_SCOPED(OpName) PackageAccessTracking_Private::FPackageAccessRefScope ANONYMOUS_VARIABLE(PackageAccessTracker_)(OpName);
#define UE_TRACK_REFERENCING_PACKAGE_DECLARE_SCOPE_VARIABLE(VariableName) TOptional<PackageAccessTracking_Private::FPackageAccessRefScope> VariableName;
#define UE_TRACK_REFERENCING_PACKAGE_ACTIVATE_SCOPE_VARIABLE(VariableName, Object, OpName) check(!VariableName.IsSet()); VariableName.Emplace(Object, OpName);
#define UE_TRACK_REFERENCING_PACKAGE_DEACTIVATE_SCOPE_VARIABLE(VariableName) VariableName.Reset();
#else
#define UE_TRACK_REFERENCING_PACKAGE_SCOPED(Package, OpName)
#define UE_TRACK_REFERENCING_PACKAGE_DELAYED_SCOPED(TrackerName, OpName)
#define UE_TRACK_REFERENCING_PACKAGE_DELAYED(TrackerName, Package)
#define UE_TRACK_REFERENCING_PLATFORM_SCOPED(TargetPlatform)
#define UE_TRACK_REFERENCING_OPNAME_SCOPED(OpName)
#define UE_TRACK_REFERENCING_PACKAGE_DECLARE_SCOPE_VARIABLE(VariableName)
#define UE_TRACK_REFERENCING_PACKAGE_ACTIVATE_SCOPE_VARIABLE(VariableName, Object, OpName)
#define UE_TRACK_REFERENCING_PACKAGE_DEACTIVATE_SCOPE_VARIABLE(VariableName)
#endif //UE_WITH_PACKAGE_ACCESS_TRACKING
 
// Cook-specific AccessTracking Scopes
#if WITH_EDITOR && UE_WITH_PACKAGE_ACCESS_TRACKING
#define UE_COOK_RESULTPROJECTION_SCOPED(ProjectionName) \
    PackageAccessTracking_Private::FPackageAccessRefScope ANONYMOUS_VARIABLE(PackageAccessTracker_)( \
        PackageAccessTracking_Private::FPackageAccessRefScope::CookResultProjectionType, ProjectionName)
 
#define UE_COOK_DISABLE_PACKAGE_ACCESS_TRACKING_SCOPED() UE_COOK_RESULTPROJECTION_SCOPED(UE::Cook::ResultProjection::None)
 
#else
#define UE_COOK_RESULTPROJECTION_SCOPED(ProjectionName)
#define UE_COOK_DISABLE_PACKAGE_ACCESS_TRACKING_SCOPED()
#endif //WITH_EDITOR && UE_WITH_PACKAGE_ACCESS_TRACKING
 
 
#if UE_WITH_PACKAGE_ACCESS_TRACKING
namespace PackageAccessTracking_Private
{
    struct FTrackedData
    {
        COREUOBJECT_API FTrackedData(FName PackageNameIn, FName InOpName, FName InCookResultProjection,
            const ITargetPlatform* InTargetPlatform, const UObject* InObject);
 
        COREUOBJECT_API FTrackedData(FTrackedData& DirectData, FTrackedData* OuterAccumulatedData);
 
        FName PackageName;
        FName OpName;
        FName BuildOpName;
        FName CookResultProjection;
        const UObject* Object = nullptr;
        const ITargetPlatform* TargetPlatform = nullptr;
    };
 
    class FPackageAccessRefScope
    {
    public:
        COREUOBJECT_API FPackageAccessRefScope(FName InPackageName, FName InOpName);
        COREUOBJECT_API FPackageAccessRefScope(const UObject* InObject, FName InOpName);
        COREUOBJECT_API FPackageAccessRefScope(FName InOpName);
        COREUOBJECT_API FPackageAccessRefScope(const ITargetPlatform* InTargetPlatform);
        enum ECookResultProjectionType
        {
            CookResultProjectionType,
        };
        COREUOBJECT_API FPackageAccessRefScope(ECookResultProjectionType, FName InCookResultProjection);
 
        COREUOBJECT_API ~FPackageAccessRefScope();
 
        COREUOBJECT_API void SetPackageName(FName InPackageName);
 
        UE_FORCEINLINE_HINT FName GetPackageName() const { return DirectData.PackageName; }
        UE_FORCEINLINE_HINT FName GetOpName() const { return DirectData.OpName; }
        UE_FORCEINLINE_HINT FPackageAccessRefScope* GetOuter() const { return Outer; }
        UE_FORCEINLINE_HINT const ITargetPlatform* GetTargetPlatform() const { return DirectData.TargetPlatform; }
 
        static COREUOBJECT_API FPackageAccessRefScope* GetCurrentThreadScope();
        static COREUOBJECT_API FTrackedData* GetCurrentThreadAccumulatedData();
    private:
        COREUOBJECT_API FPackageAccessRefScope(FName InPackageName, FName InOpName, FName InCookResultProjection,
            const ITargetPlatform* InTargetPlatform, const UObject* InObject);
 
        FTrackedData DirectData;
        FTrackedData AccumulatedData;
        FPackageAccessRefScope* Outer = nullptr;
        static thread_local FPackageAccessRefScope* CurrentThreadScope;
    };
};
#endif // UE_WITH_PACKAGE_ACCESS_TRACKING
 
#if UE_ENABLE_INCLUDE_ORDER_DEPRECATED_IN_5_7
#include "Misc/PackageName.h"
#include "UObject/ObjectHandle.h"
#include "UObject/Package.h"
#endif