This graph shows which files directly or indirectly include this file:

Typedefs
typedef std::string	AString

typedef std::list< AString >	AStringList

typedef std::map< AString, AString >	AStringMap
	A string dictionary, used for key-value pairs. More...

typedef std::vector< AString >	AStringVector

Functions
template<typename... Args>
AString &	AppendPrintf (AString &a_Dst, const char *a_Format, const Args &... a_Args)

AString	Base64Decode (const AString &a_Base64String)
	Decodes a Base64-encoded string into the raw data. More...

AString	Base64Encode (const AString &a_Input)
	Encodes a string into Base64. More...

AString &	CreateHexDump (AString &a_Out, const void *a_Data, size_t a_Size, size_t a_BytesPerLine)
	Creates a nicely formatted HEX dump of the given memory block. More...

AString	EscapeString (const AString &a_Message)
	Returns a copy of a_Message with all quotes and backslashes escaped by a backslash. More...

int	GetBEInt (const std::byte *a_Mem)
	Reads four bytes from the specified memory location and interprets them as BigEndian int. More...

short	GetBEShort (const std::byte *a_Mem)
	Reads two bytes from the specified memory location and interprets them as BigEndian short. More...

unsigned short	GetBEUShort (const char *a_Mem)
	Reads two bytes from the specified memory location and interprets them as BigEndian unsigned short. More...

template<typename T >
T	GetStringMapInteger (const AStringMap &a_Map, const AString &a_Key, T a_Default)
	Returns a number (of any integer type T) from a key-value string map. More...

AString &	InPlaceLowercase (AString &s)
	In-place string conversion to lowercase. More...

AString &	InPlaceUppercase (AString &s)
	In-place string conversion to uppercase. More...

bool	IsOnlyWhitespace (const AString &a_String)
	Returns true if only whitespace characters are present in the string. More...

AStringVector	MergeStringVectors (const AStringVector &a_Strings1, const AStringVector &a_Strings2)
	Merges the two vectors of strings, removing duplicate entries from the second vector. More...

int	NoCaseCompare (const AString &s1, const AString &s2)
	Case-insensitive string comparison. More...

template<typename... Args>
AString &	Printf (AString &a_Dst, const char *a_Format, const Args &... a_Args)

template<typename... Args>
AString	Printf (const char *a_Format, const Args &... a_Args)

size_t	RateCompareString (const AString &s1, const AString &s2)
	Case-insensitive string comparison that returns a rating of equal-ness between [0 - s1.length()]. More...

AString &	RawBEToUTF8 (const char *a_RawData, size_t a_NumShorts, AString &a_UTF8)
	Converts a stream of BE shorts into UTF-8 string; returns a_UTF8. More...

AString	ReplaceAllCharOccurrences (const AString &a_String, char a_From, char a_To)
	Replaces all occurrences of char a_From inside a_String with char a_To. More...

void	ReplaceString (AString &iHayStack, const AString &iNeedle, const AString &iReplaceWith)
	Replaces each occurence of iNeedle in iHayStack with iReplaceWith. More...

void	ReplaceURL (AString &iHayStack, const AString &iNeedle, const AString &iReplaceWith)
	Replaces each occurence of iNeedle in iHayStack with iReplaceWith, after URL-encoding iReplaceWith. More...

void	SetBEInt (std::byte *a_Mem, Int32 a_Value)
	Writes four bytes to the specified memory location so that they interpret as BigEndian int. More...

bool	SplitZeroTerminatedStrings (const AString &a_Strings, AStringVector &a_Output)
	Splits a string that has embedded \0 characters, on those characters. More...

AString	StringJoin (const AStringVector &a_Strings, const AString &a_Delimiter)
	Join a list of strings with the given delimiter between entries. More...

AString	StringsConcat (const AStringVector &a_Strings, char a_Separator)
	Concatenates the specified strings into a single string, separated by the specified separator character. More...

AStringVector	StringSplit (const AString &str, const AString &delim)
	Split the string at any of the listed delimiters. More...

AStringVector	StringSplitAndTrim (const AString &str, const AString &delim)
	Split the string at any of the listed delimiters and trim each value. More...

AStringVector	StringSplitWithQuotes (const AString &str, const AString &delim)
	Split the string at any of the listed delimiters. More...

bool	StringToFloat (const AString &a_String, float &a_Num)
	Converts a string into a float. More...

template<class T >
bool	StringToInteger (const AString &a_str, T &a_Num)
	Parses any integer type. More...

AString	StripColorCodes (const AString &a_Message)
	Removes all control codes used by MC for colors and styles. More...

AString	StrToLower (const AString &s)
	Returns a lower-cased copy of the string. More...

AString	StrToUpper (const AString &s)
	Returns an upper-cased copy of the string. More...

AString	TrimString (const AString &str)
	Trims whitespace at both ends of the string. More...

AString	UnicodeCharToUtf8 (unsigned a_UnicodeChar)
	Converts a unicode character to its UTF8 representation. More...

std::pair< bool, AString >	URLDecode (const AString &a_String)
	URL-Decodes the given string. More...

AString	URLEncode (const AString &a_Text)
	URL-encodes the given string. More...

std::u16string	UTF8ToRawBEUTF16 (const AString &a_String)
	Converts a UTF-8 string into a UTF-16 BE string. More...

AString &	vAppendPrintf (AString &a_Dst, const char *a_Format, fmt::printf_args a_ArgList)
	Add the formated string to the existing data in the string. More...

AString &	vPrintf (AString &a_Dst, const char *a_Format, fmt::printf_args a_ArgList)
	Output the formatted text into the string. More...

AString	vPrintf (const char *a_Format, fmt::printf_args a_ArgList)
	Output the formatted text into string Returns the formatted string by value. More...

Typedef Documentation

◆ AString

typedef std::string AString

Definition at line 11 of file StringUtils.h.

◆ AStringList

typedef std::list<AString> AStringList

Definition at line 13 of file StringUtils.h.

◆ AStringMap

typedef std::map<AString, AString> AStringMap

A string dictionary, used for key-value pairs.

Definition at line 16 of file StringUtils.h.

◆ AStringVector

typedef std::vector<AString> AStringVector

Definition at line 12 of file StringUtils.h.

Function Documentation

◆ AppendPrintf()

template<typename... Args>

AString& AppendPrintf	(	AString &	a_Dst,
		const char *	a_Format,
		const Args &...	a_Args
	)

Definition at line 44 of file StringUtils.h.

◆ Base64Decode()

AString Base64Decode ( const AString & a_Base64String )

Decodes a Base64-encoded string into the raw data.

Definition at line 900 of file StringUtils.cpp.

◆ Base64Encode()

AString Base64Encode ( const AString & a_Input )

Encodes a string into Base64.

Definition at line 936 of file StringUtils.cpp.

◆ CreateHexDump()

AString& CreateHexDump	(	AString &	a_Out,
		const void *	a_Data,
		size_t	a_Size,
		size_t	a_BytesPerLine
	)

Creates a nicely formatted HEX dump of the given memory block.

Definition at line 652 of file StringUtils.cpp.

◆ EscapeString()

AString EscapeString ( const AString & a_Message )

Returns a copy of a_Message with all quotes and backslashes escaped by a backslash.

Definition at line 699 of file StringUtils.cpp.

◆ GetBEInt()

int GetBEInt ( const std::byte * a_Mem )

Reads four bytes from the specified memory location and interprets them as BigEndian int.

Definition at line 1007 of file StringUtils.cpp.

◆ GetBEShort()

short GetBEShort ( const std::byte * a_Mem )

Reads two bytes from the specified memory location and interprets them as BigEndian short.

Definition at line 985 of file StringUtils.cpp.

◆ GetBEUShort()

unsigned short GetBEUShort ( const char * a_Mem )

Reads two bytes from the specified memory location and interprets them as BigEndian unsigned short.

Definition at line 997 of file StringUtils.cpp.

◆ GetStringMapInteger()

template<typename T >

T GetStringMapInteger	(	const AStringMap &	a_Map,
		const AString &	a_Key,
		T	a_Default
	)

Returns a number (of any integer type T) from a key-value string map.

Returns a_Default if the key is not present or the value is not a number representable in type T.

Definition at line 243 of file StringUtils.h.

◆ InPlaceLowercase()

AString& InPlaceLowercase ( AString & s )

In-place string conversion to lowercase.

Returns the same string object.

Definition at line 260 of file StringUtils.cpp.

◆ InPlaceUppercase()

AString& InPlaceUppercase ( AString & s )

In-place string conversion to uppercase.

Returns the same string object.

Definition at line 270 of file StringUtils.cpp.

◆ IsOnlyWhitespace()

bool IsOnlyWhitespace ( const AString & a_String )

Returns true if only whitespace characters are present in the string.

Definition at line 1116 of file StringUtils.cpp.

◆ MergeStringVectors()

AStringVector MergeStringVectors	(	const AStringVector &	a_Strings1,
		const AStringVector &	a_Strings2
	)

Merges the two vectors of strings, removing duplicate entries from the second vector.

The resulting vector contains items from a_Strings1 first, then from a_Strings2. The order of items doesn't change, only the duplicates are removed. If a_Strings1 contains duplicates, the result will still contain those duplicates.

Definition at line 1061 of file StringUtils.cpp.

◆ NoCaseCompare()

int NoCaseCompare	(	const AString &	s1,
		const AString &	s2
	)

Case-insensitive string comparison.

Returns 0 if the strings are the same, <0 if s1 < s2 and >0 if s1 > s2.

Definition at line 304 of file StringUtils.cpp.

◆ Printf() [1/2]

template<typename... Args>

AString& Printf	(	AString &	a_Dst,
		const char *	a_Format,
		const Args &...	a_Args
	)

Definition at line 26 of file StringUtils.h.

◆ Printf() [2/2]

template<typename... Args>

AString Printf	(	const char *	a_Format,
		const Args &...	a_Args
	)

Definition at line 35 of file StringUtils.h.

◆ RateCompareString()

size_t RateCompareString	(	const AString &	s1,
		const AString &	s2
	)

Case-insensitive string comparison that returns a rating of equal-ness between [0 - s1.length()].

Definition at line 317 of file StringUtils.cpp.

◆ RawBEToUTF8()

AString& RawBEToUTF8	(	const char *	a_RawData,
		size_t	a_NumShorts,
		AString &	a_UTF8
	)

Converts a stream of BE shorts into UTF-8 string; returns a_UTF8.

Definition at line 378 of file StringUtils.cpp.

◆ ReplaceAllCharOccurrences()

AString ReplaceAllCharOccurrences	(	const AString &	a_String,
		char	a_From,
		char	a_To
	)

Replaces all occurrences of char a_From inside a_String with char a_To.

Definition at line 855 of file StringUtils.cpp.

◆ ReplaceString()

void ReplaceString	(	AString &	iHayStack,
		const AString &	iNeedle,
		const AString &	iReplaceWith
	)

Replaces each occurence of iNeedle in iHayStack with iReplaceWith.

Definition at line 348 of file StringUtils.cpp.

◆ ReplaceURL()

void ReplaceURL	(	AString &	iHayStack,
		const AString &	iNeedle,
		const AString &	iReplaceWith
	)

Replaces each occurence of iNeedle in iHayStack with iReplaceWith, after URL-encoding iReplaceWith.

Definition at line 368 of file StringUtils.cpp.

◆ SetBEInt()

void SetBEInt	(	std::byte *	a_Mem,
		Int32	a_Value
	)

Writes four bytes to the specified memory location so that they interpret as BigEndian int.

Definition at line 1021 of file StringUtils.cpp.

◆ SplitZeroTerminatedStrings()

bool SplitZeroTerminatedStrings	(	const AString &	a_Strings,
		AStringVector &	a_Output
	)

Splits a string that has embedded \0 characters, on those characters.

a_Output is first cleared and then each separate string is pushed back into a_Output. Returns true if there are at least two strings in a_Output (there was at least one \0 separator).

Definition at line 1033 of file StringUtils.cpp.

◆ StringJoin()

AString StringJoin	(	const AStringVector &	a_Strings,
		const AString &	a_Delimiter
	)

Join a list of strings with the given delimiter between entries.

Definition at line 169 of file StringUtils.cpp.

◆ StringsConcat()

AString StringsConcat	(	const AStringVector &	a_Strings,
		char	a_Separator
	)

Concatenates the specified strings into a single string, separated by the specified separator character.

Use StringJoin() if you need multiple separator characters.

Definition at line 1082 of file StringUtils.cpp.

◆ StringSplit()

AStringVector StringSplit	(	const AString &	str,
		const AString &	delim
	)

Split the string at any of the listed delimiters.

Return the splitted strings as a stringvector.

Definition at line 91 of file StringUtils.cpp.

◆ StringSplitAndTrim()

AStringVector StringSplitAndTrim	(	const AString &	str,
		const AString &	delim
	)

Split the string at any of the listed delimiters and trim each value.

Returns the splitted strings as a stringvector.

Definition at line 205 of file StringUtils.cpp.

◆ StringSplitWithQuotes()

AStringVector StringSplitWithQuotes	(	const AString &	str,
		const AString &	delim
	)

Split the string at any of the listed delimiters.

Keeps quoted content together Resolves issue #490 Return the splitted strings as a stringvector.

Definition at line 112 of file StringUtils.cpp.

◆ StringToFloat()

bool StringToFloat	(	const AString &	a_String,
		float &	a_Num
	)

Converts a string into a float.

Returns false if the conversion fails.

Definition at line 1105 of file StringUtils.cpp.

◆ StringToInteger()

template<class T >

bool StringToInteger	(	const AString &	a_str,
		T &	a_Num
	)

Parses any integer type.

Checks bounds and returns errors out of band.

Definition at line 170 of file StringUtils.h.

◆ StripColorCodes()

AString StripColorCodes ( const AString & a_Message )

Removes all control codes used by MC for colors and styles.

Definition at line 736 of file StringUtils.cpp.

◆ StrToLower()

AString StrToLower ( const AString & s )

Returns a lower-cased copy of the string.

Definition at line 280 of file StringUtils.cpp.

◆ StrToUpper()

AString StrToUpper ( const AString & s )

Returns an upper-cased copy of the string.

Definition at line 292 of file StringUtils.cpp.

◆ TrimString()

AString TrimString ( const AString & str )

Trims whitespace at both ends of the string.

Returns a trimmed copy of the original string.

Definition at line 226 of file StringUtils.cpp.

◆ UnicodeCharToUtf8()

AString UnicodeCharToUtf8 ( unsigned a_UnicodeChar )

Converts a unicode character to its UTF8 representation.

Definition at line 393 of file StringUtils.cpp.

◆ URLDecode()

std::pair<bool, AString> URLDecode ( const AString & a_String )

URL-Decodes the given string.

The first value specifies whether the decoding was successful. The second value is the decoded string, if successful.

Definition at line 755 of file StringUtils.cpp.

◆ URLEncode()

AString URLEncode ( const AString & a_Text )

URL-encodes the given string.

Definition at line 825 of file StringUtils.cpp.

◆ UTF8ToRawBEUTF16()

std::u16string UTF8ToRawBEUTF16 ( const AString & a_String )

Converts a UTF-8 string into a UTF-16 BE string.

Definition at line 547 of file StringUtils.cpp.

◆ vAppendPrintf()

AString& vAppendPrintf	(	AString &	a_Dst,
		const char *	a_Format,
		fmt::printf_args	a_ArgList
	)

Add the formated string to the existing data in the string.

Returns a_Dst.

Definition at line 78 of file StringUtils.cpp.

◆ vPrintf() [1/2]

AString& vPrintf	(	AString &	a_Dst,
		const char *	a_Format,
		fmt::printf_args	a_ArgList
	)

Output the formatted text into the string.

Returns a_Dst.

Definition at line 55 of file StringUtils.cpp.

◆ vPrintf() [2/2]

AString vPrintf	(	const char *	a_Format,
		fmt::printf_args	a_ArgList
	)

Output the formatted text into string Returns the formatted string by value.

Definition at line 68 of file StringUtils.cpp.

Typedefs

Functions

Typedef Documentation

◆ AString

◆ AStringList

◆ AStringMap

◆ AStringVector

Function Documentation

◆ AppendPrintf()

◆ Base64Decode()

◆ Base64Encode()

◆ CreateHexDump()

◆ EscapeString()

◆ GetBEInt()

◆ GetBEShort()

◆ GetBEUShort()

◆ GetStringMapInteger()

◆ InPlaceLowercase()

◆ InPlaceUppercase()

◆ IsOnlyWhitespace()

◆ MergeStringVectors()

◆ NoCaseCompare()

◆ Printf() [1/2]

◆ Printf() [2/2]

◆ RateCompareString()

◆ RawBEToUTF8()

◆ ReplaceAllCharOccurrences()

◆ ReplaceString()

◆ ReplaceURL()

◆ SetBEInt()

◆ SplitZeroTerminatedStrings()

◆ StringJoin()

◆ StringsConcat()

◆ StringSplit()

◆ StringSplitAndTrim()

◆ StringSplitWithQuotes()

◆ StringToFloat()

◆ StringToInteger()

◆ StripColorCodes()

◆ StrToLower()

◆ StrToUpper()

◆ TrimString()

◆ UnicodeCharToUtf8()

◆ URLDecode()

◆ URLEncode()

◆ UTF8ToRawBEUTF16()

◆ vAppendPrintf()

◆ vPrintf() [1/2]

◆ vPrintf() [2/2]