ChaosDebugName.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
#pragma once
 
#include "ChaosDebugNameDefines.h"
#include "Containers/UnrealString.h"
#include "Templates/SharedPointer.h"
 
#define UE_API CHAOS_API
 
namespace Chaos
{
    class FSharedDebugName
    {
    public:
        FSharedDebugName() = default;
        FSharedDebugName(const FSharedDebugName& Other) = default;
        FSharedDebugName(FSharedDebugName&& Other) = default;
        FSharedDebugName& operator=(const FSharedDebugName& Other) = default;
        FSharedDebugName& operator=(FSharedDebugName&& Other) = default;
 
        FSharedDebugName(const FString& S);
        FSharedDebugName(FString&& S);
 
        bool IsValid() const;
        const FString& Value() const;
 
    private:
#if CHAOS_DEBUG_NAME
        TSharedPtr<FString, ESPMode::ThreadSafe> Name;
#endif
        static UE_API FString DefaultName;
    };
 
#if !CHAOS_DEBUG_NAME
    inline FSharedDebugName::FSharedDebugName(const FString& S) {}
    inline FSharedDebugName::FSharedDebugName(FString&& S) {}
    inline bool FSharedDebugName::IsValid() const { return false; }
    inline const FString& FSharedDebugName::Value() const { return DefaultName; }
#endif
}
 
#undef UE_API