irr::core::string< T, TAlloc > Class Template Reference

Public Types
typedef T	char_type

Public Member Functions
	string ()
	Default constructor.
	string (const string< T, TAlloc > &other)
	Constructor.
template<class B, class A>
	string (const string< B, A > &other)
	Constructor from other string types.
	string (const double number)
	Constructs a string from a float.
	string (int number)
	Constructs a string from an int.
	string (unsigned int number)
	Constructs a string from an unsigned int.
	string (long number)
	Constructs a string from a long.
	string (unsigned long number)
	Constructs a string from an unsigned long.
template<class B>
	string (const B *const c, u32 length)
	Constructor for copying a string from a pointer with a given length.
template<class B>
	string (const B *const c)
	Constructor for unicode and ascii strings.
	~string ()
	Destructor.
string< T, TAlloc > &	operator= (const string< T, TAlloc > &other)
	Assignment operator.
template<class B, class A>
string< T, TAlloc > &	operator= (const string< B, A > &other)
	Assignment operator for other string types.
template<class B>
string< T, TAlloc > &	operator= (const B *const c)
	Assignment operator for strings, ascii and unicode.
string< T, TAlloc >	operator+ (const string< T, TAlloc > &other) const
	Append operator for other strings.
template<class B>
string< T, TAlloc >	operator+ (const B *const c) const
	Append operator for strings, ascii and unicode.
T &	operator[] (const u32 index)
	Direct access operator.
const T &	operator[] (const u32 index) const
	Direct access operator.
bool	operator== (const T *const str) const
	Equality operator.
bool	operator== (const string< T, TAlloc > &other) const
	Equality operator.
bool	operator< (const string< T, TAlloc > &other) const
	Is smaller comparator.
bool	operator!= (const T *const str) const
	Inequality operator.
bool	operator!= (const string< T, TAlloc > &other) const
	Inequality operator.
u32	size () const
	Returns length of the string's content.
bool	empty () const
const T *	c_str () const
	Returns character string.
string< T, TAlloc > &	make_lower ()
	Makes the string lower case.
string< T, TAlloc > &	make_upper ()
	Makes the string upper case.
bool	equals_ignore_case (const string< T, TAlloc > &other) const
	Compares the strings ignoring case.
bool	equals_substring_ignore_case (const string< T, TAlloc > &other, const s32 sourcePos=0) const
	Compares the strings ignoring case.
bool	lower_ignore_case (const string< T, TAlloc > &other) const
	Compares the strings ignoring case.
bool	equalsn (const string< T, TAlloc > &other, u32 n) const
	compares the first n characters of the strings
bool	equalsn (const T *const str, u32 n) const
	compares the first n characters of the strings
string< T, TAlloc > &	append (T character)
	Appends a character to this string.
string< T, TAlloc > &	append (const T *const other, u32 length=0xffffffff)
	Appends a char string to this string.
string< T, TAlloc > &	append (const string< T, TAlloc > &other)
	Appends a string to this string.
string< T, TAlloc > &	append (const string< T, TAlloc > &other, u32 length)
	Appends a string of the length l to this string.
void	reserve (u32 count)
	Reserves some memory.
s32	findFirst (T c) const
	finds first occurrence of character in string
s32	findFirstChar (const T *const c, u32 count=1) const
	finds first occurrence of a character of a list in string
template<class B>
s32	findFirstCharNotInList (const B *const c, u32 count=1) const
	Finds first position of a character not in a given list.
template<class B>
s32	findLastCharNotInList (const B *const c, u32 count=1) const
	Finds last position of a character not in a given list.
s32	findNext (T c, u32 startPos) const
	finds next occurrence of character in string
s32	findLast (T c, s32 start=-1) const
	finds last occurrence of character in string
s32	findLastChar (const T *const c, u32 count=1) const
	finds last occurrence of a character of a list in string
template<class B>
s32	find (const B *const str, const u32 start=0) const
	finds another string in this string
string< T >	subString (u32 begin, s32 length, bool make_lower=false) const
	Returns a substring.
string< T, TAlloc > &	operator+= (T c)
	Appends a character to this string.
string< T, TAlloc > &	operator+= (const T *const c)
	Appends a char string to this string.
string< T, TAlloc > &	operator+= (const string< T, TAlloc > &other)
	Appends a string to this string.
string< T, TAlloc > &	operator+= (const int i)
	Appends a string representation of a number to this string.
string< T, TAlloc > &	operator+= (const unsigned int i)
	Appends a string representation of a number to this string.
string< T, TAlloc > &	operator+= (const long i)
	Appends a string representation of a number to this string.
string< T, TAlloc > &	operator+= (const unsigned long i)
	Appends a string representation of a number to this string.
string< T, TAlloc > &	operator+= (const double i)
	Appends a string representation of a number to this string.
string< T, TAlloc > &	operator+= (const float i)
	Appends a string representation of a number to this string.
string< T, TAlloc > &	replace (T toReplace, T replaceWith)
	Replaces all characters of a special type with another one.
string< T, TAlloc > &	replace (const string< T, TAlloc > &toReplace, const string< T, TAlloc > &replaceWith)
	Replaces all instances of a string with another one.
string< T, TAlloc > &	remove (T c)
	Removes characters from a string.
string< T, TAlloc > &	remove (const string< T, TAlloc > &toRemove)
	Removes a string from the string.
string< T, TAlloc > &	removeChars (const string< T, TAlloc > &characters)
	Removes characters from a string.
string< T, TAlloc > &	trim (const string< T, TAlloc > &whitespace=" \t\n\r")
	Trims the string.
string< T, TAlloc > &	erase (u32 index)
	Erases a character from the string.
string< T, TAlloc > &	validate ()
	verify the existing string.
T	lastChar () const
	gets the last char of a string or null
template<class container>
u32	split (container &ret, const T *const c, u32 count=1, bool ignoreEmptyTokens=true, bool keepSeparators=false) const
	split string into parts.

Member Function Documentation

append() [1/4]

template<typename T, typename TAlloc = irrAllocator<T>>

string< T, TAlloc > & irr::core::string< T, TAlloc >::append ( const string< T, TAlloc > & other )

inline

Appends a string to this string.

Parameters

other

String to append.

append() [2/4]

template<typename T, typename TAlloc = irrAllocator<T>>

string< T, TAlloc > & irr::core::string< T, TAlloc >::append ( const string< T, TAlloc > & other, u32 length )

inline

Appends a string of the length l to this string.

Parameters

other	other String to append to this string.
length	How much characters of the other string to add to this one.

append() [3/4]

template<typename T, typename TAlloc = irrAllocator<T>>

string< T, TAlloc > & irr::core::string< T, TAlloc >::append ( const T *const other, u32 length = 0xffffffff )

inline

Appends a char string to this string.

Parameters

other	Char string to append.
length	The length of the string to append.

append() [4/4]

template<typename T, typename TAlloc = irrAllocator<T>>

string< T, TAlloc > & irr::core::string< T, TAlloc >::append ( T character )

inline

Appends a character to this string.

Parameters

character

Character to append.

c_str()

template<typename T, typename TAlloc = irrAllocator<T>>

const T * irr::core::string< T, TAlloc >::c_str ( ) const

inline

Returns character string.

Returns

pointer to C-style NUL terminated string.

empty()

template<typename T, typename TAlloc = irrAllocator<T>>

bool irr::core::string< T, TAlloc >::empty ( ) const

inline

Informs if the string is empty or not.

Returns

True if the string is empty, false if not.

equals_ignore_case()

template<typename T, typename TAlloc = irrAllocator<T>>

bool irr::core::string< T, TAlloc >::equals_ignore_case ( const string< T, TAlloc > & other ) const

inline

Compares the strings ignoring case.

Parameters

other

Other string to compare.

Returns

True if the strings are equal ignoring case.

equals_substring_ignore_case()

template<typename T, typename TAlloc = irrAllocator<T>>

bool irr::core::string< T, TAlloc >::equals_substring_ignore_case ( const string< T, TAlloc > & other, const s32 sourcePos = 0 ) const

inline

Compares the strings ignoring case.

Parameters

other	Other string to compare.
sourcePos	where to start to compare in the string

Returns

True if the strings are equal ignoring case.

equalsn() [1/2]

template<typename T, typename TAlloc = irrAllocator<T>>

bool irr::core::string< T, TAlloc >::equalsn ( const string< T, TAlloc > & other, u32 n ) const

inline

compares the first n characters of the strings

Parameters

other	Other string to compare.
n	Number of characters to compare

Returns

True if the n first characters of both strings are equal.

equalsn() [2/2]

template<typename T, typename TAlloc = irrAllocator<T>>

bool irr::core::string< T, TAlloc >::equalsn ( const T *const str, u32 n ) const

inline

compares the first n characters of the strings

Parameters

str	Other string to compare.
n	Number of characters to compare

Returns

True if the n first characters of both strings are equal.

erase()

template<typename T, typename TAlloc = irrAllocator<T>>

string< T, TAlloc > & irr::core::string< T, TAlloc >::erase ( u32 index )

inline

Erases a character from the string.

May be slow, because all elements following after the erased element have to be copied.

Parameters

index

Index of element to be erased.

find()

template<typename T, typename TAlloc = irrAllocator<T>>

template<class B>

s32 irr::core::string< T, TAlloc >::find ( const B *const str, const u32 start = 0 ) const

inline

finds another string in this string

Parameters

str	Another string
start	Start position of the search

Returns

Positions where the string has been found, or -1 if not found.

findFirst()

template<typename T, typename TAlloc = irrAllocator<T>>

s32 irr::core::string< T, TAlloc >::findFirst ( T c ) const

inline

finds first occurrence of character in string

Parameters

c	Character to search for.

Returns

Position where the character has been found, or -1 if not found.

findFirstChar()

template<typename T, typename TAlloc = irrAllocator<T>>

s32 irr::core::string< T, TAlloc >::findFirstChar ( const T *const c, u32 count = 1 ) const

inline

finds first occurrence of a character of a list in string

Parameters

c	List of characters to find. For example if the method should find the first occurrence of 'a' or 'b', this parameter should be "ab".
count	Amount of characters in the list. Usually, this should be strlen(c)

Returns

Position where one of the characters has been found, or -1 if not found.

findFirstCharNotInList()

template<typename T, typename TAlloc = irrAllocator<T>>

template<class B>

s32 irr::core::string< T, TAlloc >::findFirstCharNotInList ( const B *const c, u32 count = 1 ) const

inline

Finds first position of a character not in a given list.

Parameters

c	List of characters not to find. For example if the method should find the first occurrence of a character not 'a' or 'b', this parameter should be "ab".
count	Amount of characters in the list. Usually, this should be strlen(c)

Returns

Position where the character has been found, or -1 if not found.

findLast()

template<typename T, typename TAlloc = irrAllocator<T>>

s32 irr::core::string< T, TAlloc >::findLast ( T c, s32 start = -1 ) const

inline

finds last occurrence of character in string

Parameters

c	Character to search for.
start	start to search reverse ( default = -1, on end )

Returns

Position where the character has been found, or -1 if not found.

findLastChar()

template<typename T, typename TAlloc = irrAllocator<T>>

s32 irr::core::string< T, TAlloc >::findLastChar ( const T *const c, u32 count = 1 ) const

inline

finds last occurrence of a character of a list in string

Parameters

c	List of strings to find. For example if the method should find the last occurrence of 'a' or 'b', this parameter should be "ab".
count	Amount of characters in the list. Usually, this should be strlen(c)

Returns

Position where one of the characters has been found, or -1 if not found.

findLastCharNotInList()

template<typename T, typename TAlloc = irrAllocator<T>>

template<class B>

s32 irr::core::string< T, TAlloc >::findLastCharNotInList ( const B *const c, u32 count = 1 ) const

inline

Finds last position of a character not in a given list.

Parameters

c	List of characters not to find. For example if the method should find the first occurrence of a character not 'a' or 'b', this parameter should be "ab".
count	Amount of characters in the list. Usually, this should be strlen(c)

Returns

Position where the character has been found, or -1 if not found.

findNext()

template<typename T, typename TAlloc = irrAllocator<T>>

s32 irr::core::string< T, TAlloc >::findNext ( T c, u32 startPos ) const

inline

finds next occurrence of character in string

Parameters

c	Character to search for.
startPos	Position in string to start searching.

Returns

Position where the character has been found, or -1 if not found.

lower_ignore_case()

template<typename T, typename TAlloc = irrAllocator<T>>

bool irr::core::string< T, TAlloc >::lower_ignore_case ( const string< T, TAlloc > & other ) const

inline

Compares the strings ignoring case.

Parameters

other

Other string to compare.

Returns

True if this string is smaller ignoring case.

operator+=() [1/9]

template<typename T, typename TAlloc = irrAllocator<T>>

string< T, TAlloc > & irr::core::string< T, TAlloc >::operator+= ( const double i )

inline

Appends a string representation of a number to this string.

Parameters

i	Number to append.

operator+=() [2/9]

template<typename T, typename TAlloc = irrAllocator<T>>

string< T, TAlloc > & irr::core::string< T, TAlloc >::operator+= ( const float i )

inline

Appends a string representation of a number to this string.

Parameters

i	Number to append.

operator+=() [3/9]

template<typename T, typename TAlloc = irrAllocator<T>>

string< T, TAlloc > & irr::core::string< T, TAlloc >::operator+= ( const int i )

inline

Appends a string representation of a number to this string.

Parameters

i	Number to append.

operator+=() [4/9]

template<typename T, typename TAlloc = irrAllocator<T>>

string< T, TAlloc > & irr::core::string< T, TAlloc >::operator+= ( const long i )

inline

Appends a string representation of a number to this string.

Parameters

i	Number to append.

operator+=() [5/9]

template<typename T, typename TAlloc = irrAllocator<T>>

string< T, TAlloc > & irr::core::string< T, TAlloc >::operator+= ( const string< T, TAlloc > & other )

inline

Appends a string to this string.

Parameters

other

String to append.

operator+=() [6/9]

template<typename T, typename TAlloc = irrAllocator<T>>

string< T, TAlloc > & irr::core::string< T, TAlloc >::operator+= ( const T *const c )

inline

Appends a char string to this string.

Parameters

c	Char string to append.

operator+=() [7/9]

template<typename T, typename TAlloc = irrAllocator<T>>

string< T, TAlloc > & irr::core::string< T, TAlloc >::operator+= ( const unsigned int i )

inline

Appends a string representation of a number to this string.

Parameters

i	Number to append.

operator+=() [8/9]

template<typename T, typename TAlloc = irrAllocator<T>>

string< T, TAlloc > & irr::core::string< T, TAlloc >::operator+= ( const unsigned long i )

inline

Appends a string representation of a number to this string.

Parameters

i	Number to append.

operator+=() [9/9]

template<typename T, typename TAlloc = irrAllocator<T>>

string< T, TAlloc > & irr::core::string< T, TAlloc >::operator+= ( T c )

inline

Appends a character to this string.

Parameters

c	Character to append.

remove() [1/2]

template<typename T, typename TAlloc = irrAllocator<T>>

string< T, TAlloc > & irr::core::string< T, TAlloc >::remove ( const string< T, TAlloc > & toRemove )

inline

Removes a string from the string.

Parameters

toRemove

String to remove.

remove() [2/2]

template<typename T, typename TAlloc = irrAllocator<T>>

string< T, TAlloc > & irr::core::string< T, TAlloc >::remove ( T c )

inline

Removes characters from a string.

Parameters

c	Character to remove.

removeChars()

template<typename T, typename TAlloc = irrAllocator<T>>

string< T, TAlloc > & irr::core::string< T, TAlloc >::removeChars ( const string< T, TAlloc > & characters )

inline

Removes characters from a string.

Parameters

characters

Characters to remove.

replace() [1/2]

template<typename T, typename TAlloc = irrAllocator<T>>

string< T, TAlloc > & irr::core::string< T, TAlloc >::replace ( const string< T, TAlloc > & toReplace, const string< T, TAlloc > & replaceWith )

inline

Replaces all instances of a string with another one.

Parameters

toReplace	The string to replace.
replaceWith	The string replacing the old one.

replace() [2/2]

template<typename T, typename TAlloc = irrAllocator<T>>

string< T, TAlloc > & irr::core::string< T, TAlloc >::replace ( T toReplace, T replaceWith )

inline

Replaces all characters of a special type with another one.

Parameters

toReplace	Character to replace.
replaceWith	Character replacing the old one.

reserve()

template<typename T, typename TAlloc = irrAllocator<T>>

void irr::core::string< T, TAlloc >::reserve ( u32 count )

inline

Reserves some memory.

Parameters

count

Amount of characters to reserve.

size()

template<typename T, typename TAlloc = irrAllocator<T>>

u32 irr::core::string< T, TAlloc >::size ( ) const

inline

Returns length of the string's content.

Returns

Length of the string's content in characters, excluding the trailing NUL.

split()

template<typename T, typename TAlloc = irrAllocator<T>>

template<class container>

u32 irr::core::string< T, TAlloc >::split ( container & ret, const T *const c, u32 count = 1, bool ignoreEmptyTokens = true, bool keepSeparators = false ) const

inline

split string into parts.

This method will split a string at certain delimiter characters into the container passed in as reference. The type of the container has to be given as template parameter. It must provide a push_back and a size method.

Parameters

ret	The result container
c	C-style string of delimiter characters
count	Number of delimiter characters
ignoreEmptyTokens	Flag to avoid empty substrings in the result container. If two delimiters occur without a character in between, an empty substring would be placed in the result. If this flag is set, only non-empty strings are stored.
keepSeparators	Flag which allows to add the separator to the result string. If this flag is true, the concatenation of the substrings results in the original string. Otherwise, only the characters between the delimiters are returned.

Returns

The number of resulting substrings

subString()

template<typename T, typename TAlloc = irrAllocator<T>>

string< T > irr::core::string< T, TAlloc >::subString ( u32 begin, s32 length, bool make_lower = false ) const

inline

Returns a substring.

Parameters

begin	Start of substring.
length	Length of substring.
make_lower	copy only lower case

trim()

template<typename T, typename TAlloc = irrAllocator<T>>

string< T, TAlloc > & irr::core::string< T, TAlloc >::trim ( const string< T, TAlloc > & whitespace = " \t\n\r" )

inline

Trims the string.

Removes the specified characters (by default, Latin-1 whitespace) from the begining and the end of the string.

---

The documentation for this class was generated from the following file:

• C:/Projects/skylicht-engine/Projects/Irrlicht/Include/irrString.h