SourceLocationUtils.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreTypes.h"
#include "Containers/StringFwd.h"
#include "Containers/UnrealString.h"
#include "Misc/SourceLocation.h"
#include "Misc/StringBuilder.h"
 
class FCbWriter;
 
namespace UE::SourceLocation::Private
{
 
    CORE_API void SerializeForLogFull(FCbWriter& Writer, const FSourceLocation& Location);
    CORE_API void SerializeForLogFileAndLine(FCbWriter& Writer, const FSourceLocation& Location);
 
}  // namespace UE::SourceLocation::Private
 
namespace UE::SourceLocation
{
 
    struct FFullAdapter
    {
        const FSourceLocation& Location;
 
        [[nodiscard]] CORE_API FString ToString() const;
        [[nodiscard]] CORE_API FUtf8String ToUtf8String() const;
 
        CORE_API void ToString(FWideString& Out) const;
        CORE_API void ToString(FUtf8String& Out) const;
 
        CORE_API void AppendString(FWideStringBuilderBase& Out) const;
        CORE_API void AppendString(FUtf8StringBuilderBase& Out) const;
 
        friend void SerializeForLog(FCbWriter& Writer, const FFullAdapter& Adapter)
        {
            Private::SerializeForLogFull(Writer, Adapter.Location);
        }
 
        friend FWideStringBuilderBase& operator<<(FWideStringBuilderBase& Builder, const FFullAdapter& Adapter)
        {
            Adapter.AppendString(Builder);
            return Builder;
        }
        friend FUtf8StringBuilderBase& operator<<(FUtf8StringBuilderBase& Builder, const FFullAdapter& Adapter)
        {
            Adapter.AppendString(Builder);
            return Builder;
        }
    };
 
    struct FFileAndLineAdapter
    {
        const FSourceLocation& Location;
 
        [[nodiscard]] CORE_API FString ToString() const;
        [[nodiscard]] CORE_API FUtf8String ToUtf8String() const;
 
        CORE_API void ToString(FWideString& Out) const;
        CORE_API void ToString(FUtf8String& Out) const;
 
        CORE_API void AppendString(FWideStringBuilderBase& Out) const;
        CORE_API void AppendString(FUtf8StringBuilderBase& Out) const;
 
        friend void SerializeForLog(FCbWriter& Writer, const FFileAndLineAdapter& Adapter)
        {
            Private::SerializeForLogFileAndLine(Writer, Adapter.Location);
        }
 
        friend FWideStringBuilderBase& operator<<(FWideStringBuilderBase& Builder, const FFileAndLineAdapter& Adapter)
        {
            Adapter.AppendString(Builder);
            return Builder;
        }
        friend FUtf8StringBuilderBase& operator<<(FUtf8StringBuilderBase& Builder, const FFileAndLineAdapter& Adapter)
        {
            Adapter.AppendString(Builder);
            return Builder;
        }
    };
 
    inline FFullAdapter Full(const FSourceLocation& Location)
    {
        return { Location };
    }
 
    inline FFileAndLineAdapter FileAndLine(const FSourceLocation& Location)
    {
        return { Location };
    }
 
    UE_DEPRECATED(5.6, "Use UE::SourceLocation::Full(Location).ToString() instead.")
    static inline FString ToFullString(const FSourceLocation& Location)
    {
        return Full(Location).ToString();
    }
 
    UE_DEPRECATED(5.6, "Use UE::SourceLocation::FileAndLine(Location).ToString() instead.")
    static inline FString ToFileAndLineString(const FSourceLocation& Location)
    {
        return FileAndLine(Location).ToString();
    }
 
}  // namespace UE::SourceLocation