UTF8Str Class Reference

#include <C:/adskgit/3dsmax/3dsmax/3dswin/src/maxsdk/include/strclass.h>

Inheritance diagram for UTF8Str:

Public Member Functions
	UTF8Str ()
	UTF8Str (const char *cs)
	UTF8Str (const UTF8Str &ws)
	UTF8Str (UTF8Str &&ws)
	UTF8Str (const MaxSDK::Util::MaxString &ws)
	UTF8Str (const MaxSDK::Util::MaxStringCastUTF8 &)
	UTF8Str (const QString &qstring)
	Conversion constructor, from QString.
	~UTF8Str ()
char *	dataForWrite (size_t nchars=(size_t) -1)
	Returns a pointer to this string which can be written to with up to 'nchars' characters.
const char *	data () const
	operator const char * () const &
	operator const char * () &&=delete
	operator const char * () const &&=delete
	operator bool () const =delete
	operator QString () const
	Conversion operator to QString.
void	Resize (int nchars)
int	Length () const
int	length () const
int	ByteCount () const
int	LanguageCharacterCount () const
size_t	AllocatedChars () const
bool	isNull () const
UTF8Str &	operator= (const UTF8Str &cs)
UTF8Str &	operator= (UTF8Str &&cs)
UTF8Str &	operator= (const MaxSDK::Util::MaxString &mstr)
UTF8Str &	operator= (const MaxSDK::Util::MaxStringCastUTF8 &)
UTF8Str &	operator= (const char *cs)
UTF8Str	operator+ (const UTF8Str &cs) const
UTF8Str &	operator+= (const UTF8Str &cs)
UTF8Str &	Append (const UTF8Str &cs)
UTF8Str &	append (const UTF8Str &cs)
UTF8Str	MultiByteCharacterSubString (int firstCharacterIndex, int numberOfMBCharacters) const
int	FindMultiByteCharacterFirstByteIndex (int characterIndex) const
int	FindMultiByteCharacterLastByteIndex (int characterIndex) const
bool	operator== (const UTF8Str &cs) const
bool	operator!= (const UTF8Str &cs) const
bool	operator< (const UTF8Str &cs) const
bool	operator<= (const UTF8Str &ws) const
bool	operator> (const UTF8Str &ws) const
bool	operator>= (const UTF8Str &ws) const
void	toUpper ()
void	toLower ()
int	printf (const char *format,...)
	Write a formatted string into this UTF8Str.
int	printf (UTF8Str format,...)
int	printf_l (const char *format, const _locale_t theLocale,...)
	Write a formatted string into this UTF8Str using specified locale.
int	vprintf (const char *format, va_list args)
	Write a formatted string into this UTF8Str.
int	vprintf_l (const char *format, const _locale_t theLocale, va_list args)
	Write a formatted string into this UTF8Str using specified locale.
wchar_t *	ToBSTR () const
MaxSDK::Util::MaxStringCastCP	ToCP (UINT cp, size_t *length=NULL) const
MaxSDK::Util::MaxStringCast< char >	ToACP (size_t *length=NULL) const
MaxSDK::Util::MaxStringCastUTF8	ToUTF8 (size_t *length=NULL) const
MaxSDK::Util::MaxStringCast< WCHAR >	ToOLESTR (size_t *length=NULL) const
MaxSDK::Util::MaxStringCast< WCHAR >	ToUTF16 (size_t *length=NULL) const
MaxSDK::Util::MaxStringCast< unsigned int >	ToUTF32 (size_t *length=NULL) const
MaxSDK::Util::MaxString	ToMaxString () const
void	ToMaxString (MaxSDK::Util::MaxString &) const
UTF8Str	ToUTF8Str () const
WStr	ToWStr () const
MaxSDK::Util::MaxStringCast< wchar_t >	ToMCHAR (size_t *length=NULL) const
WStr	ToMSTR () const
bool	EndsWith (const UTF8Str &s, bool caseSensitive=true) const
	Returns true if the string ends with s; otherwise returns false.
bool	StartsWith (const UTF8Str &s, bool caseSensitive=true) const
	Returns true if the string starts with s; otherwise returns false.
size_t	NumberOfLines () const
	Returns the number of line feeds inside a string.

Static Public Member Functions
static UTF8Str	FromBSTR (const wchar_t *string, size_t length=(size_t) -1)
static UTF8Str	FromCP (UINT cp, const char *string, size_t length=(size_t) -1)
static UTF8Str	FromACP (const char *string, size_t length=(size_t) -1)
static UTF8Str	FromUTF8 (const char *string, size_t length=(size_t) -1)
static UTF8Str	FromOLESTR (const wchar_t *string, size_t length=(size_t) -1)
static UTF8Str	FromUTF16 (const wchar_t *string, size_t length=(size_t) -1)
static UTF8Str	FromUTF32 (const unsigned int *string, size_t length=(size_t) -1)
static UTF8Str	FromMaxString (MaxSDK::Util::MaxString &string)
static UTF8Str	FromUTF8Str (const UTF8Str &string)
static UTF8Str	FromWStr (const WStr &string)
static UTF8Str	FromMCHAR (const wchar_t *string, size_t length=(size_t) -1)
static UTF8Str	FromMSTR (const WStr &string)
Static Public Member Functions inherited from MaxHeapOperators
static UtilExport void *	operator new (size_t size)
	Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e)
	Standard new operator used to allocate objects if there is insufficient memory, NULL will be returned.
static UtilExport void *	operator new (size_t size, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate objects that takes the type of memory, filename and line number where the new was called If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, NULL will be returned.
static UtilExport void *	operator new (size_t size, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, NULL will be returned.
static UtilExport void *	operator new[] (size_t size)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned.
static UtilExport void *	operator new[] (size_t size, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new[] (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate arrays of objects.
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned.
static UtilExport void *	operator new[] (size_t size, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown.
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned.
static UtilExport void	operator delete (void *ptr)
	Standard delete operator used to deallocate an object If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an object If the pointer is invalid, nothing will happen.
static UtilExport void	operator delete (void *ptr, const char *filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete (void *ptr, int block_type, const char *filename, int line)
	Delete operator used to deallocate an object that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, const char *filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen.
static UtilExport void	operator delete (void *ptr, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, nothing will happen.
static UtilExport void	operator delete[] (void *ptr)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, nothing will happen.
static UtilExport void	operator delete[] (void *ptr, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete[] (void *ptr, int block_type, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen.
static UtilExport void	operator delete[] (void *ptr, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown.
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown.
static UtilExport void *	operator new (size_t size, void *placement_ptr)
	Placement new operator.
static UtilExport void	operator delete (void *ptr, void *placement_ptr)
	Placement delete operator.
static UtilExport void *	aligned_malloc (size_t size, size_t alignment)
	Allocates memory on a specified alignment boundary.
static UtilExport void *	aligned_realloc (void *ptr, size_t size, size_t alignment)
	Reallocates memory on a specified alignment boundary.
static UtilExport void	aligned_free (void *ptr)
	Frees a block of memory that was allocated with aligned_malloc/aligned_realloc.

Detailed Description

See also

Class CStr, WStr and MaxString, ~{ Guidelines for Handling Character Strings }~.

Description:

A UTF8 encoded character string class. This class uses UTF8 encode to hold each character. This UTF8Str class provide very basic functionality Methods and operators are provided for calculating lengths, concatenation, case conversion, comparison.

Note

The memory occupied by a UTF8Str object is cannot be larger than 2Gb.

Constructor & Destructor Documentation

UTF8Str() [1/7]

UTF8Str

(

)

Remarks

Constructor. The string is set to NULL.

UTF8Str() [2/7]

UTF8Str

(

const char *

cs

)

Remarks

Constructor. The string is initialized to the string passed.

UTF8Str() [3/7]

UTF8Str

(

const UTF8Str &

ws

)

Remarks

Constructor. The string is initialized to the string passed.

UTF8Str() [4/7]

UTF8Str

(

UTF8Str &&

ws

)

Remarks

Constructor. The string is initialized to the string passed.

UTF8Str() [5/7]

UTF8Str

(

const MaxSDK::Util::MaxString &

ws

)

Remarks

Constructor. The string is initialized to the string passed.

UTF8Str() [6/7]

UTF8Str

(

const MaxSDK::Util::MaxStringCastUTF8 &

)

Remarks

Constructor. The string is initialized to the string passed.

UTF8Str() [7/7]

UTF8Str

(

const QString &

qstring

)

Conversion constructor, from QString.

~UTF8Str()

~UTF8Str

(

)

Remarks

Destructor. The string is deleted.

Member Function Documentation

dataForWrite()

char * dataForWrite

(

size_t

nchars = (size_t) -1

)

Returns a pointer to this string which can be written to with up to 'nchars' characters.

Remarks

The terminating null character is not included in nchars, so technically up to nchars+1 characters may be written.

Parameters

nchars

The minimum number of characters to allocate in the string buffer (excluding the terminating null character). A value of -1 specifies that the existing buffer should be re-used.

data()

const char * data

(

)

const

Remarks

Returns a const pointer to the string. If the string is NULL, a pointer to 0 is returned.

operator const char *() [1/3]

operator const char *

(

)

const &

Remarks

Returns a const pointer to the string. If the string is NULL, a pointer to 0 is returned.

operator const char *() [2/3]

operator const char * ( ) &&

delete

Remarks

Delete these two overloads to prevent accidental dangling pointers from temporary strings. This will cause compile errors in cases like this: const MCHAR* dangle = MSTR(_T("Hello")); Consider using .data() explicitly if the error is a false positive. Although it is not recommended, you can define MSTR_DISABLE_DANGLING_CHECKS to disble this compiler check.

operator const char *() [3/3]

operator const char * ( ) const &&

delete

operator bool()

operator bool ( ) const

explicitdelete

operator QString()

operator QString

(

)

const

Conversion operator to QString.

Resize()

void Resize

(

int

nchars

)

Remarks

Reallocates the string to contain nchars characters. If the string is enlarged it is padded with blanks.

Parameters:

int nchars

Specifies the new number of characters for the string.

Length()

int Length ( ) const

inline

Remarks

Returns the number of chars used to store the string in memory, including spaces, but excluding the terminating NULL character.

{ return ByteCount(); }

length()

int length ( ) const

inline

Remarks

Returns the number of chars used to store the string in memory, including spaces, but excluding the terminating NULL character.

{ return Length(); }

ByteCount()

int ByteCount

(

)

const

Remarks

Returns the number of bytes used to store the string in memory, including spaces, but excluding the terminating NULL character.

LanguageCharacterCount()

int LanguageCharacterCount

(

)

const

Remarks

Returns the number of natural language characters the string is represented on, including spaces, but excluding the terminal NULL character. This may be equal or less than the amount of bytes used to store the string in memory. For example, a Chinese character might take up to 4 bytes. Length() or ByteCount() will count the character as up to 4 distinct chars. LanguageCharacterCount() will count it as a single char.

AllocatedChars()

size_t AllocatedChars

(

)

const

Remarks

Returns the total number of char allocated to store the string. Including the NULL character and any unused char.

isNull()

bool isNull ( ) const

inline

Remarks

Returns TRUE if the string length is 0; otherwise FALSE.

{ return data()[0]==0; }

operator=() [1/5]

UTF8Str & operator=

(

const UTF8Str &

cs

)

Remarks

Assignment operator.

operator=() [2/5]

UTF8Str & operator=

(

UTF8Str &&

cs

)

Remarks

Assignment operator.

operator=() [3/5]

UTF8Str & operator=

(

const MaxSDK::Util::MaxString &

mstr

)

Remarks

Assignment operator.

operator=() [4/5]

UTF8Str & operator=

(

const MaxSDK::Util::MaxStringCastUTF8 &

)

Remarks

Assignment operator.

operator=() [5/5]

UTF8Str & operator=

(

const char *

cs

)

Remarks

Assignment operator. In release 3.0 and later this method check for self-assignment.

operator+()

UTF8Str operator+

(

const UTF8Str &

cs

)

const

Remarks

Concatenation operator. Returns a new string that is this string with string cs appended.

operator+=()

UTF8Str & operator+=

(

const UTF8Str &

cs

)

Remarks

Concatenation. Returns this string with cs appended.

Append()

UTF8Str & Append ( const UTF8Str & cs )

inline

Remarks

Concatenation. Returns this string with cs appended.

{ return ((*this) += cs); }

append()

UTF8Str & append ( const UTF8Str & cs )

inline

Remarks

Concatenation. Returns this string with cs appended to the end.

{ return ((*this) += cs); }

MultiByteCharacterSubString()

UTF8Str MultiByteCharacterSubString	(	int	firstCharacterIndex,
		int	numberOfMBCharacters ) const

Remarks

Returns a substring of this string, beginning at multi-byte character position firstCharacterIndex, of length numberOfMBCharacters.

FindMultiByteCharacterFirstByteIndex()

int FindMultiByteCharacterFirstByteIndex

(

int

characterIndex

)

const

Remarks

Returns the first byte index value of the multi-byte character position characterIndex.

FindMultiByteCharacterLastByteIndex()

int FindMultiByteCharacterLastByteIndex

(

int

characterIndex

)

const

Remarks

Returns the last byte index value of the multi-byte character position characterIndex.

operator==()

bool operator==

(

const UTF8Str &

cs

)

const

Remarks

Equality operator.

Returns

true if the strings are equal; otherwise false.

operator!=()

bool operator!=

(

const UTF8Str &

cs

)

const

Remarks

Inequality operator.

Returns

false if the strings are equal; otherwise true.

operator<()

bool operator<

(

const UTF8Str &

cs

)

const

Remarks

Returns true if this string is less than cs; otherwise false.

operator<=()

bool operator<=

(

const UTF8Str &

ws

)

const

Remarks

Returns true if this string is less than or equal to ws; otherwise false.

operator>()

bool operator>

(

const UTF8Str &

ws

)

const

Remarks

Returns true if this string is greater than ws; otherwise false.

operator>=()

bool operator>=

(

const UTF8Str &

ws

)

const

Remarks

Returns true if this string is greater than or equal to ws; otherwise false.

toUpper()

void toUpper

(

)

Remarks

Converts all character of this string to uppercase.

toLower()

void toLower

(

)

Remarks

Converts all character of this string to lowercase.

printf() [1/2]

int printf	(	const char *	format,
			... )

Write a formatted string into this UTF8Str.

Writes the format string, filled in by the optional arguments into this UTF8Str. See the ISO C++ documentation for more information on printf and format strings. Note: do not use ls formatting since conversion from wide string to narrow string will occur using active code page encoding rather than utf8 encoding

Parameters

format	Specifies how to format the destination string.
...	optional arguments to format into the destination string.

Precondition

format is not null.

There are the correct number of elliptical arguments to fill the format string.

Postcondition

This string is replaced with the formatted string.

Returns

The number of characters written to this string, not including the null terminating character, or a negative value if an error occurs.

printf() [2/2]

int printf	(	UTF8Str	format,
			... )

printf_l()

int printf_l	(	const char *	format,
		const _locale_t	theLocale,
			... )

Write a formatted string into this UTF8Str using specified locale.

Writes the format string, filled in by the optional arguments into this UTF8Str. See the ISO C++ documentation for more information on printf_l and format strings. Note: do not use ls formatting since conversion from wide string to narrow string will occur using active code page encoding rather than utf8 encoding

Parameters

format	Specifies how to format the destination string.
theLocale	The locale to use.
...	optional arguments to format into the destination string.

Precondition

format is not null.

There are the correct number of elliptical arguments to fill the format string.

Postcondition

This string is replaced with the formatted string.

Returns

The number of characters written to this string, not including the null terminating character, or a negative value if an error occurs.

vprintf()

int vprintf	(	const char *	format,
		va_list	args )

Write a formatted string into this UTF8Str.

This method is similar to UTF8Str::printf. Instead of taking a variable list of arguments as parameter, it takes a structure representing a variable list of arguments. This allows UTF8Str objects to be used to build strings based on a format string and a variable number of arguments. Note: do not use ls formatting since conversion from wide string to narrow string will occur using active code page encoding rather than utf8 encoding

vprintf_l()

int vprintf_l	(	const char *	format,
		const _locale_t	theLocale,
		va_list	args )

Write a formatted string into this UTF8Str using specified locale.

This method is similar to UTF8Str::printf_l. Instead of taking a variable list of arguments as parameter, it takes a structure representing a variable list of arguments. This allows UTF8Str objects to be used to build strings based on a format string, a locale, and a variable number of arguments. Note: do not use ls formatting since conversion from wide string to narrow string will occur using active code page encoding rather than utf8 encoding

ToBSTR()

wchar_t * ToBSTR

(

)

const

Remarks

Returns the string in memory allocated by SysAllocString. Caller is responsible for freeing memory using SysFreeString.

FromBSTR()

UTF8Str FromBSTR ( const wchar_t * string, size_t length = (size_t) -1 )

static

ToCP()

MaxSDK::Util::MaxStringCastCP ToCP	(	UINT	cp,
		size_t *	length = NULL ) const

FromCP()

UTF8Str FromCP ( UINT cp, const char * string, size_t length = (size_t) -1 )

static

ToACP()

MaxSDK::Util::MaxStringCast< char > ToACP

(

size_t *

length = NULL

)

const

FromACP()

UTF8Str FromACP ( const char * string, size_t length = (size_t) -1 )

static

ToUTF8()

MaxSDK::Util::MaxStringCastUTF8 ToUTF8

(

size_t *

length = NULL

)

const

FromUTF8()

UTF8Str FromUTF8 ( const char * string, size_t length = (size_t) -1 )

static

ToOLESTR()

MaxSDK::Util::MaxStringCast< WCHAR > ToOLESTR

(

size_t *

length = NULL

)

const

FromOLESTR()

UTF8Str FromOLESTR ( const wchar_t * string, size_t length = (size_t) -1 )

static

ToUTF16()

MaxSDK::Util::MaxStringCast< WCHAR > ToUTF16

(

size_t *

length = NULL

)

const

FromUTF16()

UTF8Str FromUTF16 ( const wchar_t * string, size_t length = (size_t) -1 )

static

ToUTF32()

MaxSDK::Util::MaxStringCast< unsigned int > ToUTF32

(

size_t *

length = NULL

)

const

FromUTF32()

UTF8Str FromUTF32 ( const unsigned int * string, size_t length = (size_t) -1 )

static

ToMaxString() [1/2]

MaxSDK::Util::MaxString ToMaxString

(

)

const

ToMaxString() [2/2]

void ToMaxString

(

MaxSDK::Util::MaxString &

)

const

FromMaxString()

UTF8Str FromMaxString ( MaxSDK::Util::MaxString & string )

inlinestatic

{ return UTF8Str(string); }

ToUTF8Str()

UTF8Str ToUTF8Str ( ) const

inline

{ return *this; }

FromUTF8Str()

UTF8Str FromUTF8Str ( const UTF8Str & string )

inlinestatic

{ return UTF8Str(string); }

ToWStr()

WStr ToWStr

(

)

const

FromWStr()

UTF8Str FromWStr ( const WStr & string )

static

ToMCHAR()

MaxSDK::Util::MaxStringCast< wchar_t > ToMCHAR ( size_t * length = NULL ) const

inline

{ return ToUTF16(length); }

FromMCHAR()

UTF8Str FromMCHAR ( const wchar_t * string, size_t length = (size_t)-1 )

inlinestatic

{ return FromUTF16(string, length); }

ToMSTR()

WStr ToMSTR

(

)

const

FromMSTR()

UTF8Str FromMSTR ( const WStr & string )

static

EndsWith()

bool EndsWith	(	const UTF8Str &	s,
		bool	caseSensitive = true ) const

Returns true if the string ends with s; otherwise returns false.

Parameters

s	The string to be searched.
caseSensitive	If it is true(default), the search is case sensitive; otherwise the search is case insensitive.

StartsWith()

bool StartsWith	(	const UTF8Str &	s,
		bool	caseSensitive = true ) const

Returns true if the string starts with s; otherwise returns false.

Parameters

s	The string to be searched.
caseSensitive	If it is true(default), the search is case sensitive; otherwise the search is case insensitive.

NumberOfLines()

size_t NumberOfLines

(

)

const

Returns the number of line feeds inside a string.