AssetMetadataTrace.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
#pragma once
 
#include "MetadataTrace.h"
#include "ProfilingDebugging/StringsTrace.h"
#include "Trace/Detail/EventNode.h"
#include "Trace/Trace.h"
 
namespace UE { namespace Trace { class FChannel; } }
 
#if !defined(UE_TRACE_ASSET_METADATA_ENABLED)
    #define UE_TRACE_ASSET_METADATA_ENABLED UE_TRACE_METADATA_ENABLED
#endif
 
#if UE_TRACE_ASSET_METADATA_ENABLED
 
CORE_API UE_TRACE_CHANNEL_EXTERN(AssetMetadataChannel);
 
CORE_API UE_TRACE_METADATA_EVENT_BEGIN_EXTERN(Asset)
    UE_TRACE_METADATA_EVENT_REFERENCE_FIELD(Strings, FName, Name)
    UE_TRACE_METADATA_EVENT_REFERENCE_FIELD(Strings, FName, Class)
    UE_TRACE_METADATA_EVENT_REFERENCE_FIELD(Strings, FName, Package)
UE_TRACE_METADATA_EVENT_END()
 
 
CORE_API UE_TRACE_METADATA_EVENT_BEGIN_EXTERN(PackageId)
    UE_TRACE_METADATA_EVENT_FIELD(uint64, Id)
UE_TRACE_METADATA_EVENT_END()
 
CORE_API UE_TRACE_EVENT_BEGIN_EXTERN(Package, PackageMapping, NoSync)
    UE_TRACE_EVENT_FIELD(uint64, Id)
    UE_TRACE_EVENT_REFERENCE_FIELD(Strings, FName, Package)
UE_TRACE_EVENT_END()
 
#define UE_TRACE_METADATA_SCOPE_ASSET(Object, ObjClass) \
    UE_TRACE_METADATA_SCOPE_ASSET_FNAME(Object->GetFName(), ObjClass->GetFName(), Object->GetPackage()->GetFName())
 
#define UE_TRACE_METADATA_SCOPE_ASSET_FNAME(ObjectName, ObjClassName, PackageName) \
    auto MetaNameRef = bool(MetadataChannel) && bool(AssetMetadataChannel) ? FStringTrace::GetNameRef(ObjectName) : UE::Trace::FEventRef32(0,0); \
    auto ClassNameRef = bool(MetadataChannel) && bool(AssetMetadataChannel) ? FStringTrace::GetNameRef(ObjClassName) : UE::Trace::FEventRef32(0,0); \
    auto PackageNameRef = bool(MetadataChannel) && bool(AssetMetadataChannel) ? FStringTrace::GetNameRef(PackageName) : UE::Trace::FEventRef32(0,0); \
    UE_TRACE_METADATA_SCOPE(Asset, AssetMetadataChannel) \
        << Asset.Name(MetaNameRef) \
        << Asset.Class(ClassNameRef) \
        << Asset.Package(PackageNameRef);
 
/*
 * Utility macro to create a package scope by specifying package id explicitly
 */
#define UE_TRACE_METADATA_SCOPE_PACKAGE_ID(UPackageId) \
    UE_TRACE_METADATA_SCOPE(PackageId, AssetMetadataChannel) \
        << PackageId.Id(UPackageId.Value());
 
#define UE_TRACE_PACKAGE_NAME(UPackageId, PackageName) \
    if (!PackageName.IsNone()) \
    { \
        auto PackageNameRef = bool(MetadataChannel) && bool(AssetMetadataChannel) ? FStringTrace::GetNameRef(PackageName) : UE::Trace::FEventRef32(0,0); \
        UE_TRACE_LOG(Package, PackageMapping, MetadataChannel | AssetMetadataChannel) \
            << PackageMapping.Id(UPackageId.Value()) \
            << PackageMapping.Package(PackageNameRef); \
    }
 
 
#else // UE_TRACE_ASSET_METADATA_ENABLED
 
#define UE_TRACE_METADATA_SCOPE_ASSET(...)
#define UE_TRACE_METADATA_SCOPE_ASSET_FNAME(...)
 
#define UE_TRACE_PACKAGE_NAME(...)
#define UE_TRACE_METADATA_SCOPE_PACKAGE_ID(...)
 
#endif // UE_TRACE_ASSET_METADATA_ENABLED