TextFormatter.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Containers/Array.h"
#include "Containers/SortedMap.h"
#include "Containers/UnrealString.h"
#include "CoreTypes.h"
#include "Internationalization/ITextFormatArgumentModifier.h"
#include "Internationalization/Text.h"
#include "Misc/ExpressionParserTypes.h"
#include "Misc/TransactionallySafeRWLock.h"
#include "Templates/Function.h"
#include "Templates/SharedPointer.h"
 
struct FPrivateTextFormatArguments;
 
class FTextFormatPatternDefinition : public TSharedFromThis<FTextFormatPatternDefinition, ESPMode::ThreadSafe>
{
public:
    CORE_API FTextFormatPatternDefinition();
 
    static CORE_API FTextFormatPatternDefinitionConstRef GetDefault();
 
    CORE_API const FTokenDefinitions& GetTextFormatDefinitions() const;
 
    inline bool IsValidEscapeChar(const TCHAR InChar) const
    {
        return InChar == EscapeChar
            || InChar == ArgStartChar
            || InChar == ArgEndChar
            || InChar == ArgModChar;
    }
 
    inline bool IsLiteralBreakChar(const TCHAR InChar) const
    {
        return InChar == EscapeChar
            || InChar == ArgStartChar;
    }
 
    TCHAR EscapeChar = TEXT('`');
    FTextFormatPatternDefinition& SetEscapeChar(const TCHAR InChar) { EscapeChar = InChar; return *this; }
 
    TCHAR ArgStartChar = TEXT('{');
    FTextFormatPatternDefinition& SetArgStartChar(const TCHAR InChar) { ArgStartChar = InChar; return *this; }
 
    TCHAR ArgEndChar = TEXT('}');
    FTextFormatPatternDefinition& SetArgEndChar(const TCHAR InChar) { ArgEndChar = InChar; return *this; }
 
    TCHAR ArgModChar = TEXT('|');
    FTextFormatPatternDefinition& SetArgModChar(const TCHAR InChar) { ArgModChar = InChar; return *this; }
 
private:
    FTokenDefinitions TextFormatDefinitions;
};
 
class FTextFormatter
{
public:
    typedef TFunction<TSharedPtr<ITextFormatArgumentModifier>(const FTextFormatString&, FTextFormatPatternDefinitionConstRef)> FCompileTextArgumentModifierFuncPtr;
 
    static CORE_API FTextFormatter& Get();
 
    CORE_API void RegisterTextArgumentModifier(const FTextFormatString& InKeyword, FCompileTextArgumentModifierFuncPtr InCompileFunc);
    CORE_API void UnregisterTextArgumentModifier(const FTextFormatString& InKeyword);
    CORE_API FCompileTextArgumentModifierFuncPtr FindTextArgumentModifier(const FTextFormatString& InKeyword) const;
 
    static CORE_API FText Format(FTextFormat&& InFmt, FFormatNamedArguments&& InArguments, const bool bInRebuildText, const bool bInRebuildAsSource);
    static CORE_API FText Format(FTextFormat&& InFmt, FFormatOrderedArguments&& InArguments, const bool bInRebuildText, const bool bInRebuildAsSource);
    static CORE_API FText Format(FTextFormat&& InFmt, TArray<FFormatArgumentData>&& InArguments, const bool bInRebuildText, const bool bInRebuildAsSource);
 
    static CORE_API FString FormatStr(const FTextFormat& InFmt, const FFormatNamedArguments& InArguments, const bool bInRebuildText, const bool bInRebuildAsSource);
    static CORE_API FString FormatStr(const FTextFormat& InFmt, const FFormatOrderedArguments& InArguments, const bool bInRebuildText, const bool bInRebuildAsSource);
    static CORE_API FString FormatStr(const FTextFormat& InFmt, const TArray<FFormatArgumentData>& InArguments, const bool bInRebuildText, const bool bInRebuildAsSource);
 
    static CORE_API FString Format(const FTextFormat& InFmt, const FPrivateTextFormatArguments& InFormatArgs);
 
    static CORE_API void ArgumentValueToFormattedString(const FFormatArgumentValue& InValue, const FPrivateTextFormatArguments& InFormatArgs, FString& OutResult);
 
private:
    static int32 EstimateArgumentValueLength(const FFormatArgumentValue& ArgumentValue);
 
    FTextFormatter();
 
    TSortedMap<FTextFormatString, FCompileTextArgumentModifierFuncPtr> TextArgumentModifiers;
 
    mutable FTransactionallySafeRWLock TextArgumentModifiersRW;
};