String

Engine/source/core/util/str.h

Inheritance diagram for String ↕

The String class represents a 0-terminated array of characters.

More...

Classes:

class

String::StrFormat

An internal support class for ToString().

class

String::StringData

Interning

Interning maps identical strings to unique instances so that equality amounts to simple pointer comparisons.

Note that using interned strings within global destructors is not safe as table destruction runs within this phase as well. Uses o interned strings in global destructors is thus dependent on object file ordering.

Also, interned strings are not reference-counted. Once interned, a string will persist until shutdown. This is to avoid costly concurrent reference counting that would otherwise be necessary.

String

intern()

Return the interned version of the string.

bool

isInterned()

Return true if this string is interned.

String Utility routines

String

ToString(const char * format, ... )

String

VToString(const char * format, va_list args)

String

ToString(bool v)

String

ToString(U32 v)

String

ToString(S32 v)

String

ToString(F32 v)

String

ToString(F64 v)

String

SpanToString(const char * start, const char * end)

String

ToLower(const String & string)

String

ToUpper(const String & string)

String

GetTrailingNumber(const char * str, S32 & number)

String

GetFirstNumber(const char * str, U32 & startPos, U32 & endPos)

Public Types

enum

Mode {
  Case = 0
  NoCase = 1
  Left = 0
  Right = 2
}

Default mode is case sensitive starting from the left.

U32

SizeType

StringChar

ValueType

Public Static Attributes

const String

EmptyString

A predefined empty string.

const SizeType

NPos

Indicates 'not found' when using find() functions.

Private Attributes

StringData *

_string

Public Functions

String()

String(const String & str)

String(const StringChar * str)

String(const StringChar * str, SizeType size)

Copy from raw data.

String(const UTF16 * str)

~String()

const UTF8 *

c_str()

Return the string as a native type.

void

clear()

Erases all characters in a string.

String

collapseEscapes()

Replace all escape sequences in with their respective character codes.

S32

compare(const String & str, SizeType len, U32 mode)

S32

compare(const StringChar * str, SizeType len, U32 mode)

Compare this string with another.

bool

endsWith(const char * text)

Return true if the string ends with the given text.

bool

equal(const String & str, U32 mode)

Compare two strings for equality.

String &

erase(SizeType pos, SizeType len)

String

expandEscapes()

Replace all characters that need to be escaped for the string to be a valid string literal with their respective escape sequences.

SizeType

find(const String & str, SizeType pos, U32 mode)

SizeType

find(const StringChar * str, SizeType pos, U32 mode)

SizeType

find(StringChar c, SizeType pos, U32 mode)

U32

getHashCaseInsensitive()

Get the case-insensitive hash of the string [only calculates the hash as necessary].

U32

getHashCaseSensitive()

Get the case-sensitive hash of the string [only calculates the hash as necessary].

String &

insert(SizeType pos, const String & str)

String &

insert(SizeType pos, const StringChar * str)

String &

insert(SizeType pos, const StringChar * str, SizeType len)

String &

insert(SizeType pos, const StringChar c)

bool

isEmpty()

Is this an empty string [""]?

bool

isNotEmpty()

Is this not an empty string [""]?

bool

isSame(const String & str)

Return true if both strings refer to the same shared data.

bool

isShared()

Is this string's reference count greater than 1?

SizeType

length()

Returns the length of the string in bytes.

SizeType

numChars()

Returns the length of the string in characters.

operator const StringChar*()

bool

operator!=(const String & str)

bool

operator!=(StringChar c)

String &

operator+=(const String & )

String &

operator+=(const StringChar * )

String &

operator+=(StringChar )

bool

operator<(const String & str)

bool

operator<=(const String & str)

String &

operator=(const String & )

String &

operator=(const StringChar * )

String &

operator=(StringChar )

bool

operator==(const String & str)

bool

operator==(StringChar c)

bool

operator>(const String & str)

bool

operator>=(const String & str)

StringChar

operator[](S32 i)

StringChar

operator[](U32 i)

String &

replace(const String & s1, const String & s2)

Replace all occurrences of StringData 's1' with StringData 's2'.

String &

replace(SizeType pos, SizeType len, const String & str)

String &

replace(SizeType pos, SizeType len, const StringChar * str)

String &

replace(StringChar c1, StringChar c2)

Replace all occurrences of character 'c1' with 'c2'.

SizeType

size()

Returns the length of the string in bytes including the NULL terminator.

void

split(const char * delimiter, Vector< String > & outElements)

Split the string into its components separated by the given delimiter.

bool

startsWith(const char * text)

Return true if the string starts with the given text.

String

substr(SizeType pos, SizeType len)

String

trim()

Remove leading and trailing whitespace.

const UTF16 *

utf16()

const UTF8 *

utf8()

Public Static Functions

S32

compare(const char * str1, const char * str2)

S32

compare(const UTF16 * str1, const UTF16 * str2)

bool

isEmpty(const char * )

Public Friends

String

operator+

String

operator+

String

operator+

String

operator+

String

operator+

Private Functions

String(StringData * str)

operator const bool()

Private Static Functions

void

copy(StringChar * dst, const StringChar * src, U32 size)

Detailed Description