UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Classes | Namespaces | Macros | Enumerations | Functions | Variables
TextHistory.h File Reference
#include "Async/TransactionallySafeMutex.h"
#include "Containers/Array.h"
#include "CoreTypes.h"
#include "HAL/CriticalSection.h"
#include "Internationalization/CulturePointer.h"
#include "Internationalization/ITextData.h"
#include "Internationalization/LocalizedTextSourceTypes.h"
#include "Internationalization/StringTableCoreFwd.h"
#include "Internationalization/Text.h"
#include "Internationalization/TextKey.h"
#include "Misc/DateTime.h"
#include "Misc/TransactionallySafeCriticalSection.h"
#include "Serialization/StructuredArchive.h"
#include "Templates/SharedPointerInternals.h"
#include "Templates/UnrealTemplate.h"
#include "UObject/NameTypes.h"

Go to the source code of this file.

Classes

class  FTextHistory
 
class  FTextHistory_Base
 
class  FTextHistory_Generated
 
class  FTextHistory_NamedFormat
 
class  FTextHistory_OrderedFormat
 
class  FTextHistory_ArgumentDataFormat
 
class  FTextHistory_FormatNumber
 
class  FTextHistory_AsNumber
 
class  FTextHistory_AsPercent
 
class  FTextHistory_AsCurrency
 
class  FTextHistory_AsDate
 
class  FTextHistory_AsTime
 
class  FTextHistory_AsDateTime
 
class  FTextHistory_Transform
 
class  FTextHistory_StringTableEntry
 
class  FTextHistory_TextGenerator
 

Namespaces

namespace  TextStringificationUtil
 

Macros

#define OVERRIDE_TEXT_HISTORY_STRINGIFICATION
 
#define LOC_DEFINE_REGION
 
#define TEXT_STRINGIFICATION_FUNC_MODIFY_BUFFER_AND_VALIDATE(Func, ...)
 
#define TEXT_STRINGIFICATION_PEEK_MARKER(T)   TextStringificationUtil::PeekMarker(Buffer, T, UE_ARRAY_COUNT(T) - 1)
 
#define TEXT_STRINGIFICATION_PEEK_INSENSITIVE_MARKER(T)   TextStringificationUtil::PeekInsensitiveMarker(Buffer, T, UE_ARRAY_COUNT(T) - 1)
 
#define TEXT_STRINGIFICATION_SKIP_MARKER(T)   TEXT_STRINGIFICATION_FUNC_MODIFY_BUFFER_AND_VALIDATE(TextStringificationUtil::SkipMarker, T, UE_ARRAY_COUNT(T) - 1)
 
#define TEXT_STRINGIFICATION_SKIP_INSENSITIVE_MARKER(T)   TEXT_STRINGIFICATION_FUNC_MODIFY_BUFFER_AND_VALIDATE(TextStringificationUtil::SkipInsensitiveMarker, T, UE_ARRAY_COUNT(T) - 1)
 
#define TEXT_STRINGIFICATION_SKIP_MARKER_LEN(T)   Buffer += (UE_ARRAY_COUNT(T) - 1)
 
#define TEXT_STRINGIFICATION_SKIP_WHITESPACE()   TEXT_STRINGIFICATION_FUNC_MODIFY_BUFFER_AND_VALIDATE(TextStringificationUtil::SkipWhitespace)
 
#define TEXT_STRINGIFICATION_SKIP_WHITESPACE_TO_CHAR(C)   TEXT_STRINGIFICATION_FUNC_MODIFY_BUFFER_AND_VALIDATE(TextStringificationUtil::SkipWhitespaceToCharacter, TEXT(C))
 
#define TEXT_STRINGIFICATION_SKIP_WHITESPACE_AND_CHAR(C)   TEXT_STRINGIFICATION_FUNC_MODIFY_BUFFER_AND_VALIDATE(TextStringificationUtil::SkipWhitespaceAndCharacter, TEXT(C))
 
#define TEXT_STRINGIFICATION_READ_NUMBER(V)   TEXT_STRINGIFICATION_FUNC_MODIFY_BUFFER_AND_VALIDATE(TextStringificationUtil::ReadNumberFromBuffer, V)
 
#define TEXT_STRINGIFICATION_READ_ALNUM(V)   TEXT_STRINGIFICATION_FUNC_MODIFY_BUFFER_AND_VALIDATE(TextStringificationUtil::ReadAlnumFromBuffer, V)
 
#define TEXT_STRINGIFICATION_READ_QUOTED_STRING(V)   TEXT_STRINGIFICATION_FUNC_MODIFY_BUFFER_AND_VALIDATE(TextStringificationUtil::ReadQuotedStringFromBuffer, V)
 
#define TEXT_STRINGIFICATION_READ_SCOPED_ENUM(S, V)   TEXT_STRINGIFICATION_FUNC_MODIFY_BUFFER_AND_VALIDATE(TextStringificationUtil::ReadScopedEnumFromBuffer, S, V)
 

Enumerations

enum class  ETextHistoryType : int8 {
  None = -1 , Base = 0 , NamedFormat , OrderedFormat ,
  ArgumentFormat , AsNumber , AsPercent , AsCurrency ,
  AsDate , AsTime , AsDateTime , Transform ,
  StringTableEntry , TextGenerator
}
 

Functions

bool TextStringificationUtil::PeekMarker (const TCHAR *Buffer, const TCHAR *InMarker, const int32 InMarkerLen)
 
bool TextStringificationUtil::PeekInsensitiveMarker (const TCHAR *Buffer, const TCHAR *InMarker, const int32 InMarkerLen)
 
const TCHAR * TextStringificationUtil::SkipMarker (const TCHAR *Buffer, const TCHAR *InMarker, const int32 InMarkerLen)
 
const TCHAR * TextStringificationUtil::SkipInsensitiveMarker (const TCHAR *Buffer, const TCHAR *InMarker, const int32 InMarkerLen)
 
const TCHAR * TextStringificationUtil::SkipWhitespace (const TCHAR *Buffer)
 
const TCHAR * TextStringificationUtil::SkipWhitespaceToCharacter (const TCHAR *Buffer, const TCHAR InChar)
 
const TCHAR * TextStringificationUtil::SkipWhitespaceAndCharacter (const TCHAR *Buffer, const TCHAR InChar)
 
const TCHAR * TextStringificationUtil::ReadNumberFromBuffer (const TCHAR *Buffer, FFormatArgumentValue &OutValue)
 
const TCHAR * TextStringificationUtil::ReadAlnumFromBuffer (const TCHAR *Buffer, FString &OutValue)
 
const TCHAR * TextStringificationUtil::ReadQuotedStringFromBuffer (const TCHAR *Buffer, FString &OutStr)
 
template<typename T >
const TCHAR * TextStringificationUtil::ReadScopedEnumFromBuffer (const TCHAR *Buffer, const FString &Scope, T &OutValue)
 
template<typename T >
void TextStringificationUtil::WriteScopedEnumToBuffer (FString &Buffer, const TCHAR *Scope, const T Value)
 

Variables

const auto & TextStringificationUtil::TextMarker = TEXT("TEXT")
 
const auto & TextStringificationUtil::InvTextMarker = TEXT("INVTEXT")
 
const auto & TextStringificationUtil::NsLocTextMarker = TEXT("NSLOCTEXT")
 
const auto & TextStringificationUtil::LocTextMarker = TEXT("LOCTEXT")
 
const auto & TextStringificationUtil::LocTableMarker = TEXT("LOCTABLE")
 
const auto & TextStringificationUtil::LocGenNumberMarker = TEXT("LOCGEN_NUMBER")
 
const auto & TextStringificationUtil::LocGenPercentMarker = TEXT("LOCGEN_PERCENT")
 
const auto & TextStringificationUtil::LocGenCurrencyMarker = TEXT("LOCGEN_CURRENCY")
 
const auto & TextStringificationUtil::LocGenDateMarker = TEXT("LOCGEN_DATE")
 
const auto & TextStringificationUtil::LocGenTimeMarker = TEXT("LOCGEN_TIME")
 
const auto & TextStringificationUtil::LocGenDateTimeMarker = TEXT("LOCGEN_DATETIME")
 
const auto & TextStringificationUtil::LocGenToLowerMarker = TEXT("LOCGEN_TOLOWER")
 
const auto & TextStringificationUtil::LocGenToUpperMarker = TEXT("LOCGEN_TOUPPER")
 
const auto & TextStringificationUtil::LocGenFormatOrderedMarker = TEXT("LOCGEN_FORMAT_ORDERED")
 
const auto & TextStringificationUtil::LocGenFormatNamedMarker = TEXT("LOCGEN_FORMAT_NAMED")
 
const auto & TextStringificationUtil::GroupedSuffix = TEXT("_GROUPED")
 
const auto & TextStringificationUtil::UngroupedSuffix = TEXT("_UNGROUPED")
 
const auto & TextStringificationUtil::CustomSuffix = TEXT("_CUSTOM")
 
const auto & TextStringificationUtil::UtcSuffix = TEXT("_UTC")
 
const auto & TextStringificationUtil::LocalSuffix = TEXT("_LOCAL")
 

Macro Definition Documentation

◆ LOC_DEFINE_REGION

#define LOC_DEFINE_REGION

◆ OVERRIDE_TEXT_HISTORY_STRINGIFICATION

#define OVERRIDE_TEXT_HISTORY_STRINGIFICATION
Value:
static bool StaticShouldReadFromBuffer(const TCHAR* Buffer); \
virtual bool ShouldReadFromBuffer(const TCHAR* Buffer) const override { return StaticShouldReadFromBuffer(Buffer); } \
virtual const TCHAR* ReadFromBuffer(const TCHAR* Buffer, const TCHAR* TextNamespace, const TCHAR* PackageNamespace) override; \
virtual bool WriteToBuffer(FString& Buffer, const bool bStripPackageNamespace) const override;
TCHAR
FPlatformTypes::TCHAR TCHAR
Either ANSICHAR or WIDECHAR, depending on whether the platform supports wide characters or the requir...
Definition Platform.h:1135
StaticCastSharedRef
UE_FORCEINLINE_HINT TSharedRef< CastToType, Mode > StaticCastSharedRef(TSharedRef< CastFromType, Mode > const &InSharedRef)
Definition SharedPointer.h:127

◆ TEXT_STRINGIFICATION_FUNC_MODIFY_BUFFER_AND_VALIDATE

#define TEXT_STRINGIFICATION_FUNC_MODIFY_BUFFER_AND_VALIDATE (   Func,
  ... 
)
Value:
Buffer = Func(Buffer, ##__VA_ARGS__); \
if (!Buffer) { return nullptr; }

◆ TEXT_STRINGIFICATION_PEEK_INSENSITIVE_MARKER

#define TEXT_STRINGIFICATION_PEEK_INSENSITIVE_MARKER (   T)    TextStringificationUtil::PeekInsensitiveMarker(Buffer, T, UE_ARRAY_COUNT(T) - 1)

◆ TEXT_STRINGIFICATION_PEEK_MARKER

#define TEXT_STRINGIFICATION_PEEK_MARKER (   T)    TextStringificationUtil::PeekMarker(Buffer, T, UE_ARRAY_COUNT(T) - 1)

◆ TEXT_STRINGIFICATION_READ_ALNUM

#define TEXT_STRINGIFICATION_READ_ALNUM (   V)    TEXT_STRINGIFICATION_FUNC_MODIFY_BUFFER_AND_VALIDATE(TextStringificationUtil::ReadAlnumFromBuffer, V)

◆ TEXT_STRINGIFICATION_READ_NUMBER

#define TEXT_STRINGIFICATION_READ_NUMBER (   V)    TEXT_STRINGIFICATION_FUNC_MODIFY_BUFFER_AND_VALIDATE(TextStringificationUtil::ReadNumberFromBuffer, V)

◆ TEXT_STRINGIFICATION_READ_QUOTED_STRING

#define TEXT_STRINGIFICATION_READ_QUOTED_STRING (   V)    TEXT_STRINGIFICATION_FUNC_MODIFY_BUFFER_AND_VALIDATE(TextStringificationUtil::ReadQuotedStringFromBuffer, V)

◆ TEXT_STRINGIFICATION_READ_SCOPED_ENUM

#define TEXT_STRINGIFICATION_READ_SCOPED_ENUM (   S,
  V 
)    TEXT_STRINGIFICATION_FUNC_MODIFY_BUFFER_AND_VALIDATE(TextStringificationUtil::ReadScopedEnumFromBuffer, S, V)

◆ TEXT_STRINGIFICATION_SKIP_INSENSITIVE_MARKER

#define TEXT_STRINGIFICATION_SKIP_INSENSITIVE_MARKER (   T)    TEXT_STRINGIFICATION_FUNC_MODIFY_BUFFER_AND_VALIDATE(TextStringificationUtil::SkipInsensitiveMarker, T, UE_ARRAY_COUNT(T) - 1)

◆ TEXT_STRINGIFICATION_SKIP_MARKER

#define TEXT_STRINGIFICATION_SKIP_MARKER (   T)    TEXT_STRINGIFICATION_FUNC_MODIFY_BUFFER_AND_VALIDATE(TextStringificationUtil::SkipMarker, T, UE_ARRAY_COUNT(T) - 1)

◆ TEXT_STRINGIFICATION_SKIP_MARKER_LEN

#define TEXT_STRINGIFICATION_SKIP_MARKER_LEN (   T)    Buffer += (UE_ARRAY_COUNT(T) - 1)

◆ TEXT_STRINGIFICATION_SKIP_WHITESPACE

#define TEXT_STRINGIFICATION_SKIP_WHITESPACE ( )    TEXT_STRINGIFICATION_FUNC_MODIFY_BUFFER_AND_VALIDATE(TextStringificationUtil::SkipWhitespace)

◆ TEXT_STRINGIFICATION_SKIP_WHITESPACE_AND_CHAR

#define TEXT_STRINGIFICATION_SKIP_WHITESPACE_AND_CHAR (   C)    TEXT_STRINGIFICATION_FUNC_MODIFY_BUFFER_AND_VALIDATE(TextStringificationUtil::SkipWhitespaceAndCharacter, TEXT(C))

◆ TEXT_STRINGIFICATION_SKIP_WHITESPACE_TO_CHAR

#define TEXT_STRINGIFICATION_SKIP_WHITESPACE_TO_CHAR (   C)    TEXT_STRINGIFICATION_FUNC_MODIFY_BUFFER_AND_VALIDATE(TextStringificationUtil::SkipWhitespaceToCharacter, TEXT(C))

Enumeration Type Documentation

◆ ETextHistoryType

enum class ETextHistoryType : int8
strong
Enumerator
None 
Base 
NamedFormat 
OrderedFormat 
ArgumentFormat 
AsNumber 
AsPercent 
AsCurrency 
AsDate 
AsTime 
AsDateTime 
Transform 
StringTableEntry 
TextGenerator