SPL::Functions::String Namespace Reference

C++ counterparts of SPL native functions that deal with string operations. More...

Functions
SPL::int32	length (const SPL::rstring &str)
SPL::int32	length (const SPL::BString &str)
SPL::int32	length (const SPL::ustring &str)
SPL::rstring	lower (const SPL::rstring &str)
template<int32_t msize>
SPL::bstring< msize >	lower (const SPL::bstring< msize > &str)
SPL::ustring	lower (const SPL::ustring &str)
SPL::rstring	upper (const SPL::rstring &str)
template<int32_t msize>
SPL::bstring< msize >	upper (const SPL::bstring< msize > &str)
SPL::ustring	upper (const SPL::ustring &str)
SPL::rstring	trim (const SPL::rstring &str, const SPL::rstring &t)
template<int32_t msize>
SPL::bstring< msize >	trim (const SPL::bstring< msize > &str, const SPL::bstring< msize > &t)
SPL::ustring	trim (const SPL::ustring &str, const SPL::ustring &t)
SPL::rstring	ltrim (const SPL::rstring &str, const SPL::rstring &t)
template<int32_t msize>
SPL::bstring< msize >	ltrim (const SPL::bstring< msize > &str, const SPL::bstring< msize > &t)
SPL::ustring	ltrim (const SPL::ustring &str, const SPL::ustring &t)
SPL::rstring	rtrim (const SPL::rstring &str, const SPL::rstring &t)
SPL::ustring	rtrim (const SPL::ustring &str, const SPL::ustring &t)
template<int32_t msize>
SPL::bstring< msize >	rtrim (const SPL::bstring< msize > &str, const SPL::bstring< msize > &t)
SPL::rstring	substring (const SPL::rstring &str, const SPL::int32 sidx, const SPL::int32 slen)
template<int32_t msize>
SPL::bstring< msize >	substring (const SPL::bstring< msize > &str, const SPL::int32 sidx, const SPL::int32 slen)
SPL::ustring	substring (const SPL::ustring &str, const SPL::int32 sidx, const SPL::int32 slen)
SPL::int32	findFirst (const SPL::rstring &str, const SPL::rstring &ps, const SPL::int32 sidx=0)
SPL::int32	findFirst (const SPL::BString &str, const SPL::BString &ps, const SPL::int32 sidx=0)
SPL::int32	findFirst (const SPL::ustring &str, const SPL::ustring &ps, const SPL::int32 sidx=0)
SPL::int32	findLast (const SPL::rstring &str, const SPL::rstring &ps, const SPL::int32 sidx)
SPL::int32	findLast (const SPL::BString &str, const SPL::BString &ps, const SPL::int32 sidx)
SPL::int32	findLast (const SPL::ustring &str, const SPL::ustring &ps, const SPL::int32 sidx)
SPL::int32	findFirstOf (const SPL::rstring &str, const SPL::rstring &ps, const SPL::int32 sidx=0)
SPL::int32	findFirstOf (const SPL::BString &str, const SPL::BString &ps, const SPL::int32 sidx=0)
SPL::int32	findFirstOf (const SPL::ustring &str, const SPL::ustring &ps, const SPL::int32 &sidx=0)
SPL::int32	findLastOf (const SPL::rstring &str, const SPL::rstring &ps, const SPL::int32 sidx)
SPL::int32	findLastOf (const SPL::BString &str, const SPL::BString &ps, const SPL::int32 sidx)
SPL::int32	findLastOf (const SPL::ustring &str, const SPL::ustring &ps, const SPL::int32 sidx)
SPL::int32	findFirstNotOf (const SPL::rstring &str, const SPL::rstring &ps, const SPL::int32 sidx=0)
SPL::int32	findFirstNotOf (const SPL::BString &str, const SPL::BString &ps, const SPL::int32 sidx=0)
SPL::int32	findFirstNotOf (const SPL::ustring &str, const SPL::ustring &ps, const SPL::int32 sidx=0)
SPL::int32	findLastNotOf (const SPL::rstring &str, const SPL::rstring &ps, const SPL::int32 sidx)
SPL::int32	findLastNotOf (const SPL::BString &str, const SPL::BString &ps, const SPL::int32 sidx)
SPL::int32	findLastNotOf (const SPL::ustring &str, const SPL::ustring &ps, const SPL::int32 sidx)
const SPL::list< SPL::rstring >	tokenize (const SPL::rstring &str, const SPL::rstring &delim, const SPL::boolean keepEmptyTokens)
const SPL::list< SPL::ustring >	tokenize (const SPL::ustring &str, const SPL::ustring &delim, const SPL::boolean keepEmptyTokens)
void	tokenize (const SPL::rstring &str, const SPL::rstring &delim, SPL::boolean keepEmptyTokens, SPL::boolean multipleDelim, SPL::list< SPL::rstring > &tokens)
void	tokenize (const SPL::ustring &str, const SPL::ustring &delim, SPL::boolean keepEmptyTokens, SPL::boolean multipleDelim, SPL::list< SPL::ustring > &tokens)
const SPL::list< SPL::rstring >	csvTokenize (const SPL::rstring &str)
const SPL::list< SPL::ustring >	csvTokenize (const SPL::ustring &str)
SPL::rstring	interpretRStringLiteral (const SPL::rstring &str)
SPL::rstring	makeRStringLiteral (const SPL::rstring &str)
SPL::ustring	interpretUStringLiteral (const SPL::rstring &str)
SPL::rstring	makeUStringLiteral (const SPL::ustring &str)
SPL::list< SPL::rstring >	regexMatch (const SPL::rstring &str, const SPL::rstring &patt)
SPL::list< SPL::ustring >	regexMatch (const SPL::ustring &str, const SPL::ustring &patt)
SPL::rstring	regexReplace (const SPL::rstring &str, const SPL::rstring &searchPatt, const SPL::rstring &substPatt, const SPL::boolean global)
SPL::ustring	regexReplace (const SPL::ustring &str, const SPL::ustring &searchPatt, const SPL::ustring &substPatt, const SPL::boolean global)
SPL::list< SPL::rstring >	regexMatchPerl (const SPL::rstring &str, const SPL::rstring &patt)
SPL::list< SPL::ustring >	regexMatchPerl (const SPL::ustring &str, const SPL::ustring &patt)
SPL::rstring	regexReplacePerl (const SPL::rstring &str, const SPL::rstring &searchPatt, const SPL::rstring &substPatt, const SPL::boolean global)
SPL::ustring	regexReplacePerl (const SPL::ustring &str, const SPL::ustring &searchPatt, const SPL::ustring &substPatt, const SPL::boolean global)
SPL::rstring	convertToUtf8 (const SPL::list< SPL::uint8 > &val, const SPL::rstring &enc)
template<int32_t N>
SPL::rstring	convertToUtf8 (const SPL::blist< SPL::uint8, N > &val, const SPL::rstring &enc)
SPL::rstring	convertToUtf8 (const SPL::rstring &val, const SPL::rstring &enc)
SPL::list< SPL::uint8 >	convertFromUtf8 (const SPL::rstring &str, const SPL::rstring &enc)
SPL::rstring	convertFromUtf8ToString (const SPL::rstring &str, const SPL::rstring &enc)
SPL::uint32	toCharacterCode (const SPL::rstring &str)
SPL::uint32	toCharacterCode (const SPL::BString &str)
SPL::uint32	toCharacterCode (const SPL::ustring &str)
template<class T >
SPL::rstring	toString (const T &v)
template<class T , int32_t size>
SPL::bstring< size >	toString (const T &v)
SPL::rstring	subSlice (const SPL::rstring &s, uint32_t lower, uint32_t upper)
SPL::rstring	subSliceL (const SPL::rstring &s, uint32_t upper)
SPL::rstring	subSliceU (const SPL::rstring &s, uint32_t lower)
template<int32_t msize>
SPL::bstring< msize >	subSlice (const SPL::bstring< msize > &s, uint32_t lower, uint32_t upper)
template<int32_t msize>
SPL::bstring< msize >	subSliceL (const SPL::bstring< msize > &s, uint32_t upper)
template<int32_t msize>
SPL::bstring< msize >	subSliceU (const SPL::bstring< msize > &s, uint32_t lower)
SPL::ustring	subSlice (const SPL::ustring &s, uint32_t lower, uint32_t upper)
SPL::ustring	subSliceL (const SPL::ustring &s, uint32_t upper)
SPL::ustring	subSliceU (const SPL::ustring &s, uint32_t lower)
template<int32_t msize, int msize2>
SPL::rstring	concat (const SPL::bstring< msize > &lstr, const SPL::bstring< msize2 > &rstr)
template<int32_t msize>
SPL::rstring	concat (const SPL::rstring &lstr, const SPL::bstring< msize > &rstr)
template<int32_t msize>
SPL::rstring	concat (const SPL::bstring< msize > &lstr, const SPL::rstring &rstr)
SPL::rstring	concat (const SPL::rstring &lstr, const SPL::rstring &rstr)
template<int32_t msize, int msize2>
void	appendM (SPL::bstring< msize > &str, const SPL::bstring< msize2 > &value)
template<int32_t msize>
void	appendM (SPL::bstring< msize > &str, const SPL::rstring &value)
SPL::rstring	convertFromBlob (const SPL::blob &b)
SPL::blob	convertToBlob (const SPL::rstring &str)

---

Detailed Description

C++ counterparts of SPL native functions that deal with string operations.

---

Function Documentation

SPL::int32 SPL::Functions::String::length ( const SPL::rstring &  str )

inline

Get the length of a string (the number of raw bytes).

Parameters:

str	Input string.

Returns:

Length of the input string.

SPL::int32 SPL::Functions::String::length ( const SPL::BString &  str )

inline

Get the length of a string (the number of raw bytes).

Parameters:

str	Input string.

Returns:

Length of the input string.

SPL::int32 SPL::Functions::String::length ( const SPL::ustring &  str )

inline

Get the length of a string (the number of logical characters).

Parameters:

str	Input string.

Returns:

Length of the input string.

SPL::rstring SPL::Functions::String::lower ( const SPL::rstring &  str )

inline

Convert a string to lowercase.

Parameters:

str	Input string.

Returns:

Input string in lowercase.

template<int32_t msize>

SPL::bstring<msize> SPL::Functions::String::lower ( const SPL::bstring< msize > &  str )

inline

Convert a string to lowercase.

Parameters:

str	Input string.

Returns:

Input string in lowercase.

SPL::ustring SPL::Functions::String::lower ( const SPL::ustring &  str )

inline

Convert a string to lowercase.

Parameters:

str	Input string.

Returns:

Input string in lowercase.

SPL::rstring SPL::Functions::String::upper ( const SPL::rstring &  str )

inline

Convert a string to uppercase.

Parameters:

str	Input string.

Returns:

Input string in uppercase.

template<int32_t msize>

SPL::bstring<msize> SPL::Functions::String::upper ( const SPL::bstring< msize > &  str )

inline

Convert a string to uppercase.

Parameters:

str	Input string.

Returns:

Input string in uppercase.

SPL::ustring SPL::Functions::String::upper ( const SPL::ustring &  str )

inline

Convert a string to uppercase.

Parameters:

str	Input string.

Returns:

Input string in uppercase.

SPL::rstring SPL::Functions::String::trim	(	const SPL::rstring &	str,
		const SPL::rstring &	t
	)

Remove the leading and trailing characters from a string.

Parameters:

str	Input string.
t	Characters to be removed from both sides of the input string.

Returns:

Input string with leading and trailing characters in t removed.

template<int32_t msize>

SPL::bstring<msize> SPL::Functions::String::trim ( const SPL::bstring< msize > &  str, const SPL::bstring< msize > &  t  )

inline

SPL::ustring SPL::Functions::String::trim	(	const SPL::ustring &	str,
		const SPL::ustring &	t
	)

Remove the leading and trailing characters from a string.

Parameters:

str	Input string.
t	Characters to be removed from both sides of the input string.

Returns:

Input string with leading and trailing characters in t removed.

SPL::rstring SPL::Functions::String::ltrim	(	const SPL::rstring &	str,
		const SPL::rstring &	t
	)

Remove the leading characters from a string.

Parameters:

str	Input string.
t	Characters to be removed from the left side of the input string.

Returns:

Input string with leading characters in t removed.

template<int32_t msize>

SPL::bstring<msize> SPL::Functions::String::ltrim ( const SPL::bstring< msize > &  str, const SPL::bstring< msize > &  t  )

inline

Remove the leading characters from a string.

Parameters:

str	Input string.
t	Characters to be removed from the left side of the input string.

Returns:

Input string with leading characters in t removed.

SPL::ustring SPL::Functions::String::ltrim	(	const SPL::ustring &	str,
		const SPL::ustring &	t
	)

Remove the leading characters from a string.

Parameters:

str	Input string.
t	Characters to be removed from the left side of the input string.

Returns:

Input string with leading characters in t removed.

SPL::rstring SPL::Functions::String::rtrim	(	const SPL::rstring &	str,
		const SPL::rstring &	t
	)

Remove the trailing characters from a string.

Parameters:

str	Input string.
t	Characters to be removed from the right side of the input string.

Returns:

Input string with trailing characters in t removed.

SPL::ustring SPL::Functions::String::rtrim	(	const SPL::ustring &	str,
		const SPL::ustring &	t
	)

Remove the trailing characters from a string.

Parameters:

str	Input string.
t	Characters to be removed from the right side of the input string.

Returns:

Input string with trailing characters in t removed.

template<int32_t msize>

SPL::bstring<msize> SPL::Functions::String::rtrim ( const SPL::bstring< msize > &  str, const SPL::bstring< msize > &  t  )

inline

Remove the trailing characters from a string.

Parameters:

str	Input string.
t	Characters to be removed from the right side of the input string.

Returns:

Input string with trailing characters in t removed.

SPL::rstring SPL::Functions::String::substring ( const SPL::rstring &  str, const SPL::int32  sidx, const SPL::int32  slen  )

inline

Get a substring from a string.

Parameters:

str	Input string.
sidx	Start index of the substring, where 0 is the first logical character in the input string.
slen	Number of characters in the substring.

Returns:

Substring of the input string.

template<int32_t msize>

SPL::bstring<msize> SPL::Functions::String::substring ( const SPL::bstring< msize > &  str, const SPL::int32  sidx, const SPL::int32  slen  )

inline

Get a substring from a string.

Parameters:

str	Input string.
sidx	Start index of the substring, where 0 is the first logical character in the input string.
slen	Number of characters in the substring.

Returns:

Substring of the input string.

SPL::ustring SPL::Functions::String::substring ( const SPL::ustring &  str, const SPL::int32  sidx, const SPL::int32  slen  )

inline

Get a substring from a string.

Parameters:

str	Input string.
sidx	Start index of the substring, where 0 is the first logical character in the input string.
slen	Number of characters in the substring.

Returns:

Substring of the input string.

SPL::int32 SPL::Functions::String::findFirst ( const SPL::rstring &  str, const SPL::rstring &  ps, const SPL::int32  sidx = 0  )

inline

Find a substring in a string.

Parameters:

str	Input string.
ps	Substring to be found.
sidx	Start index of the search, where 0 is the first logical character in the input string.

Returns:

Index of the first match, -1 if no match.

SPL::int32 SPL::Functions::String::findFirst ( const SPL::BString &  str, const SPL::BString &  ps, const SPL::int32  sidx = 0  )

inline

Find a substring in a string.

Parameters:

str	Input string.
ps	Substring to be found.
sidx	Start index of the search, where 0 is the first logical character in the input string.

Returns:

Index of the first match, -1 if no match.

SPL::int32 SPL::Functions::String::findFirst ( const SPL::ustring &  str, const SPL::ustring &  ps, const SPL::int32  sidx = 0  )

inline

Find a substring in a string.

Parameters:

str	Input string.
ps	Substring to be found.
sidx	Start index of the search, where 0 is the first logical character in the input string.

Returns:

Index of the first match, -1 if no match.

SPL::int32 SPL::Functions::String::findLast ( const SPL::rstring &  str, const SPL::rstring &  ps, const SPL::int32  sidx  )

inline

Find a substring in a string.

Parameters:

str	Input string.
ps	Substring to be found.
sidx	Index of the last character to be considered, where 0 is the first logical character in the input string.

Returns:

Index of the last match, -1 if no match.

SPL::int32 SPL::Functions::String::findLast ( const SPL::BString &  str, const SPL::BString &  ps, const SPL::int32  sidx  )

inline

Find a substring in a string.

Parameters:

str	Input string.
ps	Substring to be found.
sidx	Index of the last character to be considered, where 0 is the first logical character in the input string.

Returns:

Index of the last match, -1 if no match.

SPL::int32 SPL::Functions::String::findLast ( const SPL::ustring &  str, const SPL::ustring &  ps, const SPL::int32  sidx  )

inline

Find a substring in a string.

Parameters:

str	Input string.
ps	Substring to be found.
sidx	Index of the last character to be considered, where 0 is the first logical character in the input string.

Returns:

Index of the last match, -1 if no match.

SPL::int32 SPL::Functions::String::findFirstOf ( const SPL::rstring &  str, const SPL::rstring &  ps, const SPL::int32  sidx = 0  )

inline

Find a matching character in a string.

Parameters:

str	Input string.
ps	List of characters to look for.
sidx	Start index of the search.

Returns:

Index of the first match, -1 if no match, where 0 is the first logical character in the input string.

SPL::int32 SPL::Functions::String::findFirstOf ( const SPL::BString &  str, const SPL::BString &  ps, const SPL::int32  sidx = 0  )

inline

Find a matching character in a string.

Parameters:

str	Input string.
ps	List of characters to look for.
sidx	Start index of the search, where 0 is the first logical character in the input string.

Returns:

Index of the first match, -1 if no match.

SPL::int32 SPL::Functions::String::findFirstOf ( const SPL::ustring &  str, const SPL::ustring &  ps, const SPL::int32 &  sidx = 0  )

inline

Find a matching character in a string.

Parameters:

str	Input string.
ps	List of characters to look for.
sidx	Start index of the search, where 0 is the first logical character in the input string.

Returns:

Index of the first match, -1 if no match.

SPL::int32 SPL::Functions::String::findLastOf ( const SPL::rstring &  str, const SPL::rstring &  ps, const SPL::int32  sidx  )

inline

Find a matching character in a string.

Parameters:

str	Input string.
ps	List of characters to look for.
sidx	Index of the last character to be considered, where 0 is the first logical character in the input string.

Returns:

Index of the last match, -1 if no match.

SPL::int32 SPL::Functions::String::findLastOf ( const SPL::BString &  str, const SPL::BString &  ps, const SPL::int32  sidx  )

inline

Find a matching character in a string.

Parameters:

str	Input string.
ps	List of characters to look for.
sidx	Index of the last character to be considered, where 0 is the first logical character in the input string.

Returns:

Index of the last match, -1 if no match.

SPL::int32 SPL::Functions::String::findLastOf ( const SPL::ustring &  str, const SPL::ustring &  ps, const SPL::int32  sidx  )

inline

Find a matching character in a string.

Parameters:

str	Input string.
ps	List of characters to look for.
sidx	Index of the last character to be considered, where 0 is the first logical character in the input string.

Returns:

Index of the last match, -1 if no match.

SPL::int32 SPL::Functions::String::findFirstNotOf ( const SPL::rstring &  str, const SPL::rstring &  ps, const SPL::int32  sidx = 0  )

inline

Find a non-matching character in a string.

Parameters:

str	Input string.
ps	List of characters to look for.
sidx	Start index of the search, where 0 is the first logical character in the input string.

Returns:

Index of the first non-match, -1 if all match.

SPL::int32 SPL::Functions::String::findFirstNotOf ( const SPL::BString &  str, const SPL::BString &  ps, const SPL::int32  sidx = 0  )

inline

Find a non-matching character in a string.

Parameters:

str	Input string.
ps	List of characters to look for.
sidx	Start index of the search, where 0 is the first logical character in the input string.

Returns:

Index of the first non-match, -1 if all match.

SPL::int32 SPL::Functions::String::findFirstNotOf ( const SPL::ustring &  str, const SPL::ustring &  ps, const SPL::int32  sidx = 0  )

inline

Find a non-matching character in a string.

Parameters:

str	Input string.
ps	List of characters to look for.
sidx	Start index of the search, where 0 is the first logical character in the input string.

Returns:

Index of the first non-match, -1 if all match.

SPL::int32 SPL::Functions::String::findLastNotOf ( const SPL::rstring &  str, const SPL::rstring &  ps, const SPL::int32  sidx  )

inline

Find the last non-matching character in a string.

Parameters:

str	Input string.
ps	List of characters to look for.
sidx	Index of the last character to be considered, where 0 is the first logical character in the input string.

Returns:

Index of the last non-match, -1 if all match.

SPL::int32 SPL::Functions::String::findLastNotOf ( const SPL::BString &  str, const SPL::BString &  ps, const SPL::int32  sidx  )

inline

Find the last non-matching character in a string.

Parameters:

str	Input string.
ps	List of characters to look for.
sidx	Index of the last character to be considered, where 0 is the first logical character in the input string.

Returns:

Index of the last non-match, -1 if all match.

SPL::int32 SPL::Functions::String::findLastNotOf ( const SPL::ustring &  str, const SPL::ustring &  ps, const SPL::int32  sidx  )

inline

Find the last non-matching character in a string.

Parameters:

str	Input string.
ps	List of characters to look for.
sidx	Index of the last character to be considered, where 0 is the first logical character in the input string.

Returns:

Index of the last non-match, -1 if all match.

const SPL::list<SPL::rstring> SPL::Functions::String::tokenize	(	const SPL::rstring &	str,
		const SPL::rstring &	delim,
		const SPL::boolean	keepEmptyTokens
	)

Tokenize a string.

Parameters:

str	Input string.
delim	Delimiters to use. Each character in delim is a possible delimiter.
keepEmptyTokens	Keep empty tokens in the result.

Returns:

A list of the tokens in the string.

const SPL::list<SPL::ustring> SPL::Functions::String::tokenize	(	const SPL::ustring &	str,
		const SPL::ustring &	delim,
		const SPL::boolean	keepEmptyTokens
	)

Tokenize a string.

Parameters:

str	Input string.
delim	Delimiters to use. Each character in delim is a possible delimiter.
keepEmptyTokens	Keep empty tokens in the result.

Returns:

A list of the tokens in the string.

void SPL::Functions::String::tokenize	(	const SPL::rstring &	str,
		const SPL::rstring &	delim,
		SPL::boolean	keepEmptyTokens,
		SPL::boolean	multipleDelim,
		SPL::list< SPL::rstring > &	tokens
	)

Tokenize a string.

Parameters:

str	Input string.
delim	Delimiters to use.
keepEmptyTokens	Keep empty tokens in the result.
multipleDelim	If 'true', each character in delim is used to tokenize. If 'false', the string in delim is used as a delimiter. This parameter is important only if size(delim) > 1.
tokens	Output list of the tokens in the string.

void SPL::Functions::String::tokenize	(	const SPL::ustring &	str,
		const SPL::ustring &	delim,
		SPL::boolean	keepEmptyTokens,
		SPL::boolean	multipleDelim,
		SPL::list< SPL::ustring > &	tokens
	)

Tokenize a string.

Parameters:

str	Input string.
delim	Delimiters to use.
keepEmptyTokens	Keep empty tokens in the result.
multipleDelim	If 'true', each character in delim is used to tokenize. If 'false', the string in delim is used as a delimiter. This parameter is important only if size(delim) > 1.
tokens	Output list of the tokens in the string.

const SPL::list<SPL::rstring> SPL::Functions::String::csvTokenize

(

const SPL::rstring &

str

)

Tokenize a string containing comma-separated values.

Parameters:

str	Input string in comma-separated values format, like "string1","string2","string3",...,"stringN".

Returns:

A list of the tokens in the string, where the returned tokens are string literals (use interpretRStringLiteral() or interpretUStringLiteral() to interpret them).

const SPL::list<SPL::ustring> SPL::Functions::String::csvTokenize ( const SPL::ustring &  str )

inline

Tokenize a string containing comma-separated values.

Parameters:

str	Input string in comma-separated values format, like "string1","string2","string3",...,"stringN".

Returns:

A list of the tokens in the string, where the returned tokens are string literals (use interpretRStringLiteral() or interpretUStringLiteral() to interpret them).

SPL::rstring SPL::Functions::String::interpretRStringLiteral ( const SPL::rstring &  str )

inline

Interpret a string literal stored in a UTF-8 encoded string as an rstring.

Parameters:

str	String to be interpreted.

Returns:

Interpreted string, with escaped characters replaced with their raw values.

Exceptions:

SPLRuntimeInvalidArgumentException

If the string is not enclosed within double quotes, or if the encoding has errors.

SPL::rstring SPL::Functions::String::makeRStringLiteral ( const SPL::rstring &  str )

inline

Make a string literal from an rstring.

Parameters:

str	The rstring to be converted into a string literal.

Returns:

A string literal, enclosed in double quotes, with non-ascii characters escaped, stored as a UTF-8 encoded string.

SPL::ustring SPL::Functions::String::interpretUStringLiteral ( const SPL::rstring &  str )

inline

Interpret a string literal stored in a UTF-8 encoded string as a ustring.

Parameters:

str	String to be interpreted.

Returns:

Interpreted string, with escaped characters replaced with their raw values.

Exceptions:

SPLRuntimeInvalidArgumentException

If str is not enclosed within double quotes, or if the encoding has errors.

SPL::rstring SPL::Functions::String::makeUStringLiteral ( const SPL::ustring &  str )

inline

Make a string literal from a ustring.

Parameters:

str	The ustring to be converted into a string literal.

Returns:

A string literal, enclosed in double quotes, with non-ascii characters escaped, stored as a UTF-8 encoded string.

SPL::list<SPL::rstring> SPL::Functions::String::regexMatch	(	const SPL::rstring &	str,
		const SPL::rstring &	patt
	)

Match a string with a regular expression, using POSIX Extended Regular Expressions (ERE), including sub-expression (capture group) matching using parentheses "()".

Note:

ERE matching is used by "grep -E", and has less functionality than Perl regular expressions. This function is currently implemented using the system C++ library for rstring and the ICU library for ustring.

Parameters:

str	Input string.
patt	Search pattern.

Returns:

List of matches, consisting of the whole matched string, if any, followed by any sub-expression matches, in order.

Exceptions:

SPLRuntimeInvalidArgumentException

If the search pattern is an invalid regular expression.

SPL::list<SPL::ustring> SPL::Functions::String::regexMatch	(	const SPL::ustring &	str,
		const SPL::ustring &	patt
	)

Match a string with a regular expression, using POSIX Extended Regular Expressions (ERE), including sub-expression (capture group) matching using parentheses "()".

Note:

ERE matching is used by "grep -E", and has less functionality than Perl regular expressions. This function is currently implemented using the system C++ library for rstring and the ICU library for ustring.

Parameters:

str	Input string.
patt	Search pattern.

Returns:

List of matches, consisting of the whole matched string, if any, followed by any sub-expression matches, in order.

Exceptions:

SPLRuntimeInvalidArgumentException

If the search pattern is an invalid regular expression.

SPL::rstring SPL::Functions::String::regexReplace	(	const SPL::rstring &	str,
		const SPL::rstring &	searchPatt,
		const SPL::rstring &	substPatt,
		const SPL::boolean	global
	)

Match and replace a string with a regular expression, using POSIX Extended Regular Expressions (ERE), including sub-expression (capture group) matching using parentheses "()".

Note:

ERE matching is used by "grep -E", and has less functionality than Perl regular expressions. Match and replace is similar to using "sed". This function is currently implemented using the system C++ library for rstring and the ICU library for ustring.

Parameters:

str	Input string.
searchPatt	Search pattern.
substPatt	Replacement pattern (for the rstring version, matched sub-expressions can be specified through "\\n", as in "\\1"; for the ustring version, "$n", as in "$1", may be used).
global	Whether replacement is to be done globally.

Returns:

Resulting string with replacements.

Exceptions:

SPLRuntimeInvalidArgumentException

If the search pattern is an invalid regular expression.

SPL::ustring SPL::Functions::String::regexReplace	(	const SPL::ustring &	str,
		const SPL::ustring &	searchPatt,
		const SPL::ustring &	substPatt,
		const SPL::boolean	global
	)

Match and replace a string with a regular expression, using POSIX Extended Regular Expressions (ERE), including sub-expression (capture group) matching using parentheses "()".

Note:

ERE matching is used by "grep -E", and has less functionality than Perl regular expressions. Match and replace is similar to using "sed". This function is currently implemented using the system C++ library for rstring and the ICU library for ustring.

Parameters:

str	Input string.
searchPatt	Search pattern.
substPatt	Replacement pattern (for the rstring version, matched sub-expressions can be specified through "\\n", as in "\\1"; for the ustring version, "$n", as in "$1", may be used).
global	Whether replacement is to be done globally.

Returns:

Resulting string with replacements.

Exceptions:

SPLRuntimeInvalidArgumentException

If the search pattern is an invalid regular expression.

SPL::list<SPL::rstring> SPL::Functions::String::regexMatchPerl	(	const SPL::rstring &	str,
		const SPL::rstring &	patt
	)

Match a string with a regular expression, using a Perl regular expression, including sub-expression (capture group) matching using parentheses "()".

Note:

Perl regular expression matching is used by "grep -P", and has more functionality than POSIX Extended Regular Expressions. This function is currently implemented using the Boost C++ library.

Parameters:

str	Input string.
patt	Search pattern (using Boost Perl regular expression syntax).

Returns:

List of matches, consisting of the whole matched string, if any, followed by any sub-expression matches, in order.

Exceptions:

SPLRuntimeInvalidArgumentException

If the search pattern is an invalid regular expression.

SPL::list<SPL::ustring> SPL::Functions::String::regexMatchPerl	(	const SPL::ustring &	str,
		const SPL::ustring &	patt
	)

Match a string with a regular expression, using a Perl regular expression, including sub-expression (capture group) matching using parentheses "()".

Note:

Perl regular expression matching is used by "grep -P", and has more functionality than POSIX Extended Regular Expressions. This function is currently implemented using the Boost C++ library.

Parameters:

str	Input string.
patt	Search pattern (using Boost Perl regular expression syntax).

Returns:

List of matches, consisting of the whole matched string, if any, followed by any sub-expression matches, in order.

Exceptions:

SPLRuntimeInvalidArgumentException

If the search pattern is an invalid regular expression.

SPL::rstring SPL::Functions::String::regexReplacePerl	(	const SPL::rstring &	str,
		const SPL::rstring &	searchPatt,
		const SPL::rstring &	substPatt,
		const SPL::boolean	global
	)

Match and replace a string with a regular expression, using a Perl regular expression, including sub-expression (capture group) matching using parentheses "()".

Note:

Perl regular expression matching is used by "grep -P", and has more functionality than POSIX Extended Regular Expressions. Match and replace is similar to using "sed". This function is currently implemented using the Boost C++ library.

Parameters:

str	Input string.
searchPatt	Search pattern (using Boost Perl regular expression syntax).
substPatt	Replacement pattern (matched sub-expressions can be specified through "\\n", as in "\\1").
global	Whether replacement is to be done globally.

Returns:

Resulting string with replacements.

Exceptions:

SPLRuntimeInvalidArgumentException

If the search pattern is an invalid regular expression.

SPL::ustring SPL::Functions::String::regexReplacePerl	(	const SPL::ustring &	str,
		const SPL::ustring &	searchPatt,
		const SPL::ustring &	substPatt,
		const SPL::boolean	global
	)

Match and replace a string with a regular expression, using a Perl regular expression, including sub-expression (capture group) matching using parentheses "()".

Note:

Perl regular expression matching is used by "grep -P", and has more functionality than POSIX Extended Regular Expressions. Match and replace is similar to using "sed". This function is currently implemented using the Boost C++ library.

Parameters:

str	Input string.
searchPatt	Search pattern (using Boost Perl regular expression syntax).
substPatt	Replacement pattern (matched sub-expressions can be specified through "\\n", as in "\\1").
global	Whether replacement is to be done globally.

Returns:

Resulting string with replacements.

Exceptions:

SPLRuntimeInvalidArgumentException

If the search pattern is an invalid regular expression.

SPL::rstring SPL::Functions::String::convertToUtf8	(	const SPL::list< SPL::uint8 > &	val,
		const SPL::rstring &	enc
	)

Convert data given as raw bytes with a specified encoding into a UTF-8 encoded string.

Parameters:

val	Input data.
enc	Input data encoding scheme (eg "UTF-16").

Returns:

The UTF-8 encoded string representation.

template<int32_t N>

SPL::rstring SPL::Functions::String::convertToUtf8 ( const SPL::blist< SPL::uint8, N > &  val, const SPL::rstring &  enc  )

inline

Convert data given as raw bytes with a specified encoding into a UTF-8 encoded string.

Parameters:

val	Input data.
enc	Input data encoding scheme (eg "UTF-16").

Returns:

The UTF-8 encoded string representation.

SPL::rstring SPL::Functions::String::convertToUtf8	(	const SPL::rstring &	val,
		const SPL::rstring &	enc
	)

Convert data given as raw bytes with a specified encoding into a UTF-8 encoded string.

Parameters:

val	Input data.
enc	Input data encoding scheme (eg "UTF-16").

Returns:

The UTF-8 encoded string representation.

SPL::list<SPL::uint8> SPL::Functions::String::convertFromUtf8	(	const SPL::rstring &	str,
		const SPL::rstring &	enc
	)

Convert a UTF-8 encoded string into data as raw bytes with a specified encoding.

Parameters:

str	Input string (UTF-8 encoded).
enc	Data encoding scheme (eg "UTF-16") for the output.

Returns:

Data as raw bytes with the specified encoding.

SPL::rstring SPL::Functions::String::convertFromUtf8ToString	(	const SPL::rstring &	str,
		const SPL::rstring &	enc
	)

Convert a UTF-8 encoded string into a string with a specified encoding.

Parameters:

str	Input string (UTF-8 encoded).
enc	Data encoding scheme (eg "UTF-16") for the output.

Returns:

Data as an rstring with the specified encoding.

SPL::uint32 SPL::Functions::String::toCharacterCode ( const SPL::rstring &  str )

inline

Convert the first character of a string to its corresponding ASCII code.

Parameters:

str	Input string.

Returns:

ASCII code of the first character of the string.

SPL::uint32 SPL::Functions::String::toCharacterCode ( const SPL::BString &  str )

inline

Convert the first character of a string to its corresponding ASCII code.

Parameters:

str	Input string.

Returns:

ASCII code of the first character of the string.

SPL::uint32 SPL::Functions::String::toCharacterCode ( const SPL::ustring &  str )

inline

Convert the first character of a string to its corresponding Unicode code point.

Parameters:

str	Input string.

Returns:

Unicode code point of the first character of the string.

template<class T >

SPL::rstring SPL::Functions::String::toString ( const T &  v )

inline

Convert any SPL type to to a serialized string. For example, strings are quoted, and characters escaped.

Parameters:

v	Value to be converted.

Returns:

Serialized string form of v.

Exceptions:

SPLRuntimeInvalidArgumentException

If conversion fails.

template<class T , int32_t size>

SPL::bstring<size> SPL::Functions::String::toString ( const T &  v )

inline

Convert any SPL type to to a serialized string. For example, strings are quoted, and characters escaped.

Parameters:

v	Value to be converted.

Returns:

Serialized string form of v.

Exceptions:

SPLRuntimeInvalidArgumentException

If conversion fails.

SPL::rstring SPL::Functions::String::subSlice	(	const SPL::rstring &	s,
		uint32_t	lower,
		uint32_t	upper
	)

Return a slice from a string [lower..upper-1].

Parameters:

s	Input string.
lower	First index to be included.
upper	Last index (not included in result).

Returns:

The slice s[lower..upper-1].

Exceptions:

SPLRuntimeInvalidArgumentException

If lower > s.size().

SPL::rstring SPL::Functions::String::subSliceL	(	const SPL::rstring &	s,
		uint32_t	upper
	)

Return a slice from a string [0..upper-1].

Parameters:

s	Input string.
upper	Last index (not included in result).

Returns:

The slice s[0..upper-1].

SPL::rstring SPL::Functions::String::subSliceU	(	const SPL::rstring &	s,
		uint32_t	lower
	)

Return a slice from a string [lower..<end of string>].

Parameters:

s	Input string.
lower	First index to be included.

Returns:

The slice s[lower..<end of string>].

Exceptions:

SPLRuntimeInvalidArgumentException

If lower > s.size().

template<int32_t msize>

SPL::bstring<msize> SPL::Functions::String::subSlice	(	const SPL::bstring< msize > &	s,
		uint32_t	lower,
		uint32_t	upper
	)

Return a slice from a bounded string [lower..upper-1].

Parameters:

s	Input string.
lower	First index to be included.
upper	Last index (not included in result).

Returns:

The slice s[lower..upper-1].

Exceptions:

SPLRuntimeInvalidArgumentException

If lower > s.size().

template<int32_t msize>

SPL::bstring<msize> SPL::Functions::String::subSliceL	(	const SPL::bstring< msize > &	s,
		uint32_t	upper
	)

Return a slice from a bounded string [0..upper-1].

Parameters:

s	Input string.
upper	Last index (not included in result).

Returns:

The slice s[0..upper-1].

template<int32_t msize>

SPL::bstring<msize> SPL::Functions::String::subSliceU	(	const SPL::bstring< msize > &	s,
		uint32_t	lower
	)

Return a slice from a bounded string [lower..<end of string>].

Parameters:

s	Input string.
lower	First index to be included.

Returns:

The slice s[lower..<end of string>].

Exceptions:

SPLRuntimeInvalidArgumentException

If lower > s.size().

SPL::ustring SPL::Functions::String::subSlice	(	const SPL::ustring &	s,
		uint32_t	lower,
		uint32_t	upper
	)

Return a slice from a string [lower..upper-1].

Parameters:

s	Input string.
lower	First index to be included.
upper	Last index (not included in result).

Returns:

The slice s[lower..upper-1].

Exceptions:

SPLRuntimeInvalidArgumentException

If lower > s.size().

SPL::ustring SPL::Functions::String::subSliceL	(	const SPL::ustring &	s,
		uint32_t	upper
	)

Return a slice from a string [0..upper-1].

Parameters:

s	Input string.
upper	Last index (not included in result).

Returns:

The slice s[0..upper-1].

SPL::ustring SPL::Functions::String::subSliceU	(	const SPL::ustring &	s,
		uint32_t	lower
	)

Return a slice from a string [lower..<end of string>].

Parameters:

s	Input string.
lower	First index to be included.

Returns:

The slice s[lower..<end of string>].

Exceptions:

SPLRuntimeInvalidArgumentException

If lower > s.size().

template<int32_t msize, int msize2>

SPL::rstring SPL::Functions::String::concat ( const SPL::bstring< msize > &  lstr, const SPL::bstring< msize2 > &  rstr  )

inline

Concatenate two bounded rstring strings, returning an rstring.

Parameters:

lstr	Input bounded rstring.
rstr	Input bounded rstring.

Returns:

The concatenation of lstr to rstr.

template<int32_t msize>

SPL::rstring SPL::Functions::String::concat ( const SPL::rstring &  lstr, const SPL::bstring< msize > &  rstr  )

inline

Concatenate an rstring with a bounded rstring, returning an rstring.

Parameters:

lstr	Input rstring.
rstr	Input bounded rstring.

Returns:

The concatenation of lstr to rstr.

template<int32_t msize>

SPL::rstring SPL::Functions::String::concat ( const SPL::bstring< msize > &  lstr, const SPL::rstring &  rstr  )

inline

Concatenate a bounded rstring with an rstring, returning an rstring.

Parameters:

lstr	Input bounded rstring.
rstr	Input rstring.

Returns:

The concatenation of lstr to rstr.

SPL::rstring SPL::Functions::String::concat ( const SPL::rstring &  lstr, const SPL::rstring &  rstr  )

inline

Concatenate two rstring strings, returning an rstring.

Parameters:

lstr	Input rstring.
rstr	Input rstring.

Returns:

The concatenation of lstr to rstr.

template<int32_t msize, int msize2>

void SPL::Functions::String::appendM ( SPL::bstring< msize > &  str, const SPL::bstring< msize2 > &  value  )

inline

Append a bounded rstring to a bounded rstring.

Parameters:

str	The bounded rstring to be appended to.
value	The bounded rstring to be appended.

template<int32_t msize>

void SPL::Functions::String::appendM ( SPL::bstring< msize > &  str, const SPL::rstring &  value  )

inline

Append an rstring to a bounded rstring.

Parameters:

str	The bounded rstring to be appended to.
value	The rstring to be appended.

SPL::rstring SPL::Functions::String::convertFromBlob ( const SPL::blob &  b )

inline

Convert a blob to an rstring.

Parameters:

b	The blob to be converted.

Returns:

An rstring with the characters from the blob.

SPL::blob SPL::Functions::String::convertToBlob ( const SPL::rstring &  str )

inline

Convert an rstring to a blob.

Parameters:

str	String to be converted.

Returns:

A blob with the characters from the rstring.