StringFormatter.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Containers/UnrealString.h"
#include "Misc/ExpressionParserTypes.h"
#include "Templates/ValueOrError.h"
 
struct FStringFormatArg;
 
template <typename CharType>
class TStringFormatter
{
public:
 
    CORE_API TStringFormatter();
 
    TString<CharType> Format(const CharType* InExpression, const TMap<TString<CharType>, FStringFormatArg>& InArgs) const
    {
        auto Result = FormatInternal(InExpression, InArgs, false);
        if (ensure(Result.IsValid()))
        {
            return MoveTemp(Result.GetValue());
        }
 
        return InExpression;
    }
 
    TString<CharType> Format(const CharType* InExpression, const TArray<FStringFormatArg>& InArgs) const
    {
        auto Result = FormatInternal(InExpression, InArgs, false);
        if (ensure(Result.IsValid()))
        {
            return MoveTemp(Result.GetValue());
        }
        
        return InExpression;
    }
 
    TValueOrError<TString<CharType>, FExpressionError> FormatStrict(const CharType* InExpression, const TMap<TString<CharType>, FStringFormatArg>& InArgs) const
    {
        return FormatInternal(InExpression, InArgs, true);
    }
 
    TValueOrError<TString<CharType>, FExpressionError> FormatStrict(const CharType* InExpression, const TArray<FStringFormatArg>& InArgs) const
    {
        return FormatInternal(InExpression, InArgs, true);
    }
 
private:
 
    CORE_API TValueOrError<TString<CharType>, FExpressionError> FormatInternal(const CharType* InExpression, const TMap<TString<CharType>, FStringFormatArg>& InArgs, bool bStrict) const;
    CORE_API TValueOrError<TString<CharType>, FExpressionError> FormatInternal(const CharType* InExpression, const TArray<FStringFormatArg>& InArgs, bool bStrict) const;
 
    TTokenDefinitions<CharType> NamedDefinitions;
    TTokenDefinitions<CharType> OrderedDefinitions;
 
    TTokenDefinitions<CharType> StrictNamedDefinitions;
    TTokenDefinitions<CharType> StrictOrderedDefinitions;
};
 
extern template class TStringFormatter<ANSICHAR>;
extern template class TStringFormatter<UTF8CHAR>;
extern template class TStringFormatter<WIDECHAR>;