#include <GenericPlatformString.h>

Inheritance diagram for FGenericPlatformString:

Static Public Member Functions
template<typename DestEncoding , typename SourceEncoding >
static constexpr bool	CanConvertCodepoint (SourceEncoding Codepoint)

template<typename Encoding >
static const TCHAR *	GetEncodingTypeName ()

static const ANSICHAR *	GetEncodingName ()

template<typename SourceEncoding , typename DestEncoding >
static DestEncoding *	Convert (DestEncoding Dest, int32 DestSize, const SourceEncoding Src)

template<typename SourceEncoding , typename DestEncoding >
static DestEncoding *	Convert (DestEncoding Dest, int32 DestSize, const SourceEncoding Src, int32 SrcSize)

template<typename DestEncoding , typename SourceEncoding >
static int32	ConvertedLength (const SourceEncoding *Src)

template<typename DestEncoding , typename SourceEncoding >
static int32	ConvertedLength (const SourceEncoding *Src, int32 SrcSize)

static CORE_API int32	Strncmp (const ANSICHAR String1, const ANSICHAR String2, SIZE_T Count)

static CORE_API int32	Strncmp (const WIDECHAR String1, const ANSICHAR String2, SIZE_T Count)

static CORE_API int32	Strncmp (const UTF8CHAR String1, const ANSICHAR String2, SIZE_T Count)

static CORE_API int32	Strncmp (const ANSICHAR String1, const WIDECHAR String2, SIZE_T Count)

static CORE_API int32	Strncmp (const WIDECHAR String1, const WIDECHAR String2, SIZE_T Count)

static CORE_API int32	Strncmp (const UTF8CHAR String1, const WIDECHAR String2, SIZE_T Count)

static CORE_API int32	Strncmp (const ANSICHAR String1, const UTF8CHAR String2, SIZE_T Count)

static CORE_API int32	Strncmp (const WIDECHAR String1, const UTF8CHAR String2, SIZE_T Count)

static CORE_API int32	Strncmp (const UTF8CHAR String1, const UTF8CHAR String2, SIZE_T Count)

template<>
const TCHAR *	GetEncodingTypeName ()

template<>
const TCHAR *	GetEncodingTypeName ()

template<>
const TCHAR *	GetEncodingTypeName ()

template<>
const TCHAR *	GetEncodingTypeName ()

Static Public Member Functions inherited from FGenericPlatformStricmp
static CORE_API int32	Stricmp (const ANSICHAR String1, const ANSICHAR String2)

static CORE_API int32	Stricmp (const WIDECHAR String1, const WIDECHAR String2)

static CORE_API int32	Stricmp (const UTF8CHAR String1, const UTF8CHAR String2)

static CORE_API int32	Stricmp (const UTF16CHAR String1, const UTF16CHAR String2)

static CORE_API int32	Stricmp (const UTF32CHAR String1, const UTF32CHAR String2)

static CORE_API int32	Stricmp (const ANSICHAR String1, const WIDECHAR String2)

static CORE_API int32	Stricmp (const ANSICHAR String1, const UTF8CHAR String2)

static CORE_API int32	Stricmp (const ANSICHAR String1, const UTF16CHAR String2)

static CORE_API int32	Stricmp (const ANSICHAR String1, const UTF32CHAR String2)

static CORE_API int32	Stricmp (const WIDECHAR String1, const ANSICHAR String2)

static CORE_API int32	Stricmp (const UTF8CHAR String1, const ANSICHAR String2)

static CORE_API int32	Stricmp (const UTF16CHAR String1, const ANSICHAR String2)

static CORE_API int32	Stricmp (const UTF32CHAR String1, const ANSICHAR String2)

static CORE_API int32	Strnicmp (const ANSICHAR String1, const ANSICHAR String2, SIZE_T Count)

static CORE_API int32	Strnicmp (const WIDECHAR String1, const WIDECHAR String2, SIZE_T Count)

static CORE_API int32	Strnicmp (const UTF8CHAR String1, const UTF8CHAR String2, SIZE_T Count)

static CORE_API int32	Strnicmp (const UTF16CHAR String1, const UTF16CHAR String2, SIZE_T Count)

static CORE_API int32	Strnicmp (const UTF32CHAR String1, const UTF32CHAR String2, SIZE_T Count)

static CORE_API int32	Strnicmp (const ANSICHAR String1, const WIDECHAR String2, SIZE_T Count)

static CORE_API int32	Strnicmp (const ANSICHAR String1, const UTF8CHAR String2, SIZE_T Count)

static CORE_API int32	Strnicmp (const ANSICHAR String1, const UTF16CHAR String2, SIZE_T Count)

static CORE_API int32	Strnicmp (const ANSICHAR String1, const UTF32CHAR String2, SIZE_T Count)

static CORE_API int32	Strnicmp (const WIDECHAR String1, const ANSICHAR String2, SIZE_T Count)

static CORE_API int32	Strnicmp (const UTF8CHAR String1, const ANSICHAR String2, SIZE_T Count)

static CORE_API int32	Strnicmp (const UTF16CHAR String1, const ANSICHAR String2, SIZE_T Count)

static CORE_API int32	Strnicmp (const UTF32CHAR String1, const ANSICHAR String2, SIZE_T Count)

Static Public Attributes
static constexpr bool	IsUnicodeEncoded = true

Detailed Description

Generic string implementation for most platforms

Member Function Documentation

◆ CanConvertCodepoint()

template<typename DestEncoding , typename SourceEncoding >

static constexpr bool FGenericPlatformString::CanConvertCodepoint ( SourceEncoding Codepoint )

inlinestaticconstexpr

Tests whether a particular codepoint can be converted to the destination encoding.

Parameters

Ch	The character to test.

Returns: True if Ch can be encoded as a DestEncoding.

◆ Convert() [1/2]

template<typename SourceEncoding , typename DestEncoding >

static DestEncoding * FGenericPlatformString::Convert	(	DestEncoding *	Dest,
		int32	DestSize,
		const SourceEncoding *	Src
	)

inlinestatic

Converts the null-terminated Src string range from SourceEncoding to DestEncoding and writes it to the [Dest, Dest+DestSize) range, including a null terminator. If the Dest range is not big enough to hold the converted output, NULL is returned. In this case, nothing should be assumed about the contents of Dest.

Parameters

Dest	The start of the destination buffer.
DestSize	The size of the destination buffer.
Src	The start of the string to convert.

Returns: A pointer to one past the last-written element.

◆ Convert() [2/2]

template<typename SourceEncoding , typename DestEncoding >

static DestEncoding * FGenericPlatformString::Convert	(	DestEncoding *	Dest,
		int32	DestSize,
		const SourceEncoding *	Src,
		int32	SrcSize
	)

inlinestatic

Converts the [Src, Src+SrcSize) string range from SourceEncoding to DestEncoding and writes it to the [Dest, Dest+DestSize) range. The Src range should contain a null terminator if a null terminator is required in the output. If the Dest range is not big enough to hold the converted output, NULL is returned. In this case, nothing should be assumed about the contents of Dest.

Parameters

Dest	The start of the destination buffer.
DestSize	The size of the destination buffer.
Src	The start of the string to convert.
SrcSize	The number of Src elements to convert.

Returns: A pointer to one past the last-written element.

◆ ConvertedLength() [1/2]

template<typename DestEncoding , typename SourceEncoding >

static int32 FGenericPlatformString::ConvertedLength ( const SourceEncoding * Src )

inlinestatic

Returns the required buffer length for the null-terminated Src string when converted to the DestChar encoding. The returned length includes the space for the null terminator (equivalent to strlen+1).

Parameters

Src	The start of the string to convert.

Returns: The number of DestChar elements that Src will be converted into.

◆ ConvertedLength() [2/2]

template<typename DestEncoding , typename SourceEncoding >

static int32 FGenericPlatformString::ConvertedLength	(	const SourceEncoding *	Src,
		int32	SrcSize
	)

inlinestatic

Returns the required buffer length for the [Src, Src+SrcSize) string when converted to the DestChar encoding. The Src range should contain a null terminator if a null terminator is required in the output.

Parameters

Src	The start of the string to convert.
SrcSize	The number of Src elements to convert.

Returns: The number of DestChar elements that Src will be converted into.

◆ GetEncodingName()

static const ANSICHAR * FGenericPlatformString::GetEncodingName ( )

inlinestatic

◆ GetEncodingTypeName() [1/5]

template<>

const TCHAR * FGenericPlatformString::GetEncodingTypeName ( )

static

◆ GetEncodingTypeName() [2/5]

template<>

const TCHAR * FGenericPlatformString::GetEncodingTypeName ( )

static

◆ GetEncodingTypeName() [3/5]

template<>

const TCHAR * FGenericPlatformString::GetEncodingTypeName ( )

static

◆ GetEncodingTypeName() [4/5]

template<>

const TCHAR * FGenericPlatformString::GetEncodingTypeName ( )

static

◆ GetEncodingTypeName() [5/5]

template<typename Encoding >

static const TCHAR * FGenericPlatformString::GetEncodingTypeName ( )

static

Returns the string representing the name of the given encoding type.

Returns: The name of the CharType as a TCHAR string.

◆ Strncmp() [1/9]

int32 FGenericPlatformString::Strncmp	(	const ANSICHAR *	String1,
		const ANSICHAR *	String2,
		SIZE_T	Count
	)

static

◆ Strncmp() [2/9]

int32 FGenericPlatformString::Strncmp	(	const ANSICHAR *	String1,
		const UTF8CHAR *	String2,
		SIZE_T	Count
	)

static

◆ Strncmp() [3/9]

int32 FGenericPlatformString::Strncmp	(	const ANSICHAR *	String1,
		const WIDECHAR *	String2,
		SIZE_T	Count
	)

static

◆ Strncmp() [4/9]

int32 FGenericPlatformString::Strncmp	(	const UTF8CHAR *	String1,
		const ANSICHAR *	String2,
		SIZE_T	Count
	)

static

◆ Strncmp() [5/9]

int32 FGenericPlatformString::Strncmp	(	const UTF8CHAR *	String1,
		const UTF8CHAR *	String2,
		SIZE_T	Count
	)

static

◆ Strncmp() [6/9]

int32 FGenericPlatformString::Strncmp	(	const UTF8CHAR *	String1,
		const WIDECHAR *	String2,
		SIZE_T	Count
	)

static

◆ Strncmp() [7/9]

int32 FGenericPlatformString::Strncmp	(	const WIDECHAR *	String1,
		const ANSICHAR *	String2,
		SIZE_T	Count
	)

static

◆ Strncmp() [8/9]

int32 FGenericPlatformString::Strncmp	(	const WIDECHAR *	String1,
		const UTF8CHAR *	String2,
		SIZE_T	Count
	)

static

◆ Strncmp() [9/9]

int32 FGenericPlatformString::Strncmp	(	const WIDECHAR *	String1,
		const WIDECHAR *	String2,
		SIZE_T	Count
	)

static

Member Data Documentation

◆ IsUnicodeEncoded

constexpr bool FGenericPlatformString::IsUnicodeEncoded = true

staticconstexpr

True if the encoding type of the string is some form of unicode

The documentation for this struct was generated from the following files:

Engine/Source/Runtime/Core/Public/GenericPlatform/GenericPlatformString.h
Engine/Source/Runtime/Core/Private/GenericPlatform/GenericPlatformString.cpp

Static Public Member Functions

Static Public Attributes

Detailed Description

Member Function Documentation

◆ CanConvertCodepoint()

◆ Convert() [1/2]

◆ Convert() [2/2]

◆ ConvertedLength() [1/2]

◆ ConvertedLength() [2/2]

◆ GetEncodingName()

◆ GetEncodingTypeName() [1/5]

◆ GetEncodingTypeName() [2/5]

◆ GetEncodingTypeName() [3/5]

◆ GetEncodingTypeName() [4/5]

◆ GetEncodingTypeName() [5/5]

◆ Strncmp() [1/9]

◆ Strncmp() [2/9]

◆ Strncmp() [3/9]

◆ Strncmp() [4/9]

◆ Strncmp() [5/9]

◆ Strncmp() [6/9]

◆ Strncmp() [7/9]

◆ Strncmp() [8/9]

◆ Strncmp() [9/9]

Member Data Documentation

◆ IsUnicodeEncoded