ITextFormatArgumentModifier.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreTypes.h"
#include "Misc/Crc.h"
#include "Containers/UnrealString.h"
#include "Internationalization/CulturePointer.h"
 
class FFormatArgumentValue;
struct FPrivateTextFormatArguments;
 
struct FPrivateTextFormatArguments;
 
class FTextFormatString
{
public:
    FTextFormatString()
        : StringPtr(TEXT(""))
        , StringLen(0)
        , InternalString()
    {
    }
 
    FTextFormatString(FString InStr)
        : StringPtr(nullptr)
        , StringLen(0)
        , InternalString(MoveTemp(InStr))
    {
        StringPtr = *InternalString;
        StringLen = InternalString.Len();
    }
 
    FTextFormatString(const TCHAR* InStr)
        : StringPtr(nullptr)
        , StringLen(0)
        , InternalString(InStr)
    {
        StringPtr = *InternalString;
        StringLen = InternalString.Len();
    }
 
    static FTextFormatString MakeReference(const TCHAR* InStr)
    {
        return FTextFormatString(InStr, FCString::Strlen(InStr));
    }
 
    static FTextFormatString MakeReference(const TCHAR* InStr, const int32 InLen)
    {
        return FTextFormatString(InStr, InLen);
    }
 
    FTextFormatString(const FTextFormatString& Other)
        : StringPtr(Other.StringPtr)
        , StringLen(Other.StringLen)
        , InternalString(Other.InternalString)
    {
        if (Other.StringPtr == *Other.InternalString)
        {
            StringPtr = *InternalString;
        }
    }
 
    FTextFormatString(FTextFormatString&& Other)
        : StringPtr(Other.StringPtr)
        , StringLen(Other.StringLen)
        , InternalString(MoveTemp(Other.InternalString))
    {
    }
 
    FTextFormatString& operator=(const FTextFormatString& Other)
    {
        if (this != &Other)
        {
            StringPtr = Other.StringPtr;
            StringLen = Other.StringLen;
            InternalString = Other.InternalString;
 
            if (Other.StringPtr == *Other.InternalString)
            {
                StringPtr = *InternalString;
            }
        }
        return *this;
    }
 
    FTextFormatString& operator=(FTextFormatString&& Other)
    {
        if (this != &Other)
        {
            StringPtr = Other.StringPtr;
            StringLen = Other.StringLen;
            InternalString = MoveTemp(Other.InternalString);
        }
        return *this;
    }
 
    friend inline uint32 GetTypeHash(const FTextFormatString& InStr)
    {
        return FCrc::MemCrc32(InStr.StringPtr, sizeof(TCHAR) * InStr.StringLen);
    }
 
    const TCHAR* StringPtr;
 
    int32 StringLen;
 
private:
    FString InternalString;
 
    FTextFormatString(const TCHAR* InStr, const int32 InLen)
        : StringPtr(InStr)
        , StringLen(InLen)
        , InternalString()
    {
    }
};
 
inline bool operator==(const FTextFormatString& LHS, const FTextFormatString& RHS)
{
    return LHS.StringLen == RHS.StringLen 
        && FCString::Strncmp(LHS.StringPtr, RHS.StringPtr, LHS.StringLen) == 0;
}
 
inline bool operator!=(const FTextFormatString& LHS, const FTextFormatString& RHS)
{
    return LHS.StringLen != RHS.StringLen
        || FCString::Strncmp(LHS.StringPtr, RHS.StringPtr, LHS.StringLen) != 0;
}
 
inline bool operator<(const FTextFormatString& LHS, const FTextFormatString& RHS)
{
    if (LHS.StringLen < RHS.StringLen)
    {
        return true;
    }
    if (LHS.StringLen > RHS.StringLen)
    {
        return false;
    }
    return FCString::Strncmp(LHS.StringPtr, RHS.StringPtr, LHS.StringLen) < 0;
}
 
class ITextFormatArgumentModifier
{
public:
    virtual ~ITextFormatArgumentModifier() {}
 
    virtual bool Validate(const FCultureRef& InCulture, TArray<FString>& OutValidationErrors) const = 0;
 
    virtual void Evaluate(const FFormatArgumentValue& InValue, const FPrivateTextFormatArguments& InFormatArgs, FString& OutResult) const = 0;
 
    virtual void GetFormatArgumentNames(TArray<FString>& OutArgumentNames) const = 0;
 
    virtual void EstimateLength(int32& OutLength, bool& OutUsesFormatArgs) const = 0;
 
protected:
    CORE_API static bool ParseKeyValueArgs(const FTextFormatString& InArgsString, TSortedMap<FTextFormatString, FTextFormatString>& OutArgKeyValues, const TCHAR InValueSeparator = TEXT('='), const TCHAR InArgSeparator = TEXT(','));
 
    CORE_API static bool ParseValueArgs(const FTextFormatString& InArgsString, TArray<FTextFormatString>& OutArgValues, const TCHAR InArgSeparator = TEXT(','));
};