MyGUI  3.0.3
Data Structures | Public Types | Static Public Attributes | Related Functions
MyGUI::UString Class Reference

A UTF-16 string with implicit conversion to/from std::string and std::wstring. More...

#include <MyGUI_UString.h>

Data Structures

class  _base_iterator
 base iterator class for UString More...
class  _const_fwd_iterator
 const forward iterator for UString More...
class  _const_rev_iterator
 const reverse iterator for UString More...
class  _fwd_iterator
 forward iterator for UString More...
class  _rev_iterator
 forward iterator for UString More...
class  invalid_data
 This exception is used when invalid data streams are encountered. More...

Public Types

typedef size_t size_type
 size type used to indicate string size and character positions within the string
typedef uint32 unicode_char
 a single 32-bit Unicode character
typedef uint16 code_point
 a single UTF-16 code point
typedef code_point value_type
 value type typedef for use in iterators
typedef std::basic_string
< code_point
dstring
typedef std::basic_string
< unicode_char
utf32string
 string type used for returning UTF-32 formatted data
typedef _fwd_iterator iterator
 iterator
typedef _rev_iterator reverse_iterator
 reverse iterator
typedef _const_fwd_iterator const_iterator
 const iterator
typedef _const_rev_iterator const_reverse_iterator
 const reverse iterator

Public Member Functions

Constructors/Destructor
 UString ()
 default constructor, creates an empty string
 UString (const UString &copy)
 copy constructor
 UString (size_type length, const code_point &ch)
 length copies of ch
 UString (const code_point *str)
 duplicate of nul-terminated sequence str
 UString (const code_point *str, size_type length)
 duplicate of str, length code points long
 UString (const UString &str, size_type index, size_type length)
 substring of str starting at index and length code points long
 UString (const wchar_t *w_str)
 duplicate of nul-terminated wchar_t array
 UString (const wchar_t *w_str, size_type length)
 duplicate of w_str, length characters long
 UString (const std::wstring &wstr)
 duplicate of wstr
 UString (const char *c_str)
 duplicate of nul-terminated C-string c_str (UTF-8 encoding)
 UString (const char *c_str, size_type length)
 duplicate of c_str, length characters long (UTF-8 encoding)
 UString (const std::string &str)
 duplicate of str (UTF-8 encoding)
 ~UString ()
 destructor
Utility functions
size_type size () const
 Returns the number of code points in the current string.
size_type length () const
 Returns the number of code points in the current string.
size_type length_Characters () const
 Returns the number of Unicode characters in the string.
size_type max_size () const
 returns the maximum number of UTF-16 code points that the string can hold
void reserve (size_type size)
 sets the capacity of the string to at least size code points
void resize (size_type num, const code_point &val=0)
 changes the size of the string to size, filling in any new area with val
void swap (UString &from)
 exchanges the elements of the current string with those of from
bool empty () const
 returns true if the string has no elements, false otherwise
const code_pointc_str () const
 returns a pointer to the first character in the current string
const code_pointdata () const
 returns a pointer to the first character in the current string
size_type capacity () const
 returns the number of elements that the string can hold before it will need to allocate more space
void clear ()
 deletes all of the elements in the string
UString substr (size_type index, size_type num=npos) const
 returns a substring of the current string, starting at index, and num characters long.
void push_back (unicode_char val)
 appends val to the end of the string
void push_back (wchar_t val)
 appends val to the end of the string
void push_back (code_point val)
 appends val to the end of the string
void push_back (char val)
 appends val to the end of the string
bool inString (unicode_char ch) const
 returns true if the given Unicode character ch is in this string
Stream variations
const std::string & asUTF8 () const
 returns the current string in UTF-8 form within a std::string
const char * asUTF8_c_str () const
 returns the current string in UTF-8 form as a nul-terminated char array
const utf32stringasUTF32 () const
 returns the current string in UTF-32 form within a utf32string
const unicode_charasUTF32_c_str () const
 returns the current string in UTF-32 form as a nul-terminated unicode_char array
const std::wstring & asWStr () const
 returns the current string in the native form of std::wstring
const wchar_t * asWStr_c_str () const
 returns the current string in the native form of a nul-terminated wchar_t array
Single Character Access
code_pointat (size_type loc)
 returns a reference to the element in the string at index loc
const code_pointat (size_type loc) const
 returns a reference to the element in the string at index loc
unicode_char getChar (size_type loc) const
 returns the data point loc evaluated as a UTF-32 value
int setChar (size_type loc, unicode_char ch)
 sets the value of the character at loc to the Unicode value ch (UTF-32)
iterator acquisition
iterator begin ()
 returns an iterator to the first element of the string
const_iterator begin () const
 returns an iterator to the first element of the string
iterator end ()
 returns an iterator just past the end of the string
const_iterator end () const
 returns an iterator just past the end of the string
reverse_iterator rbegin ()
 returns a reverse iterator to the last element of the string
const_reverse_iterator rbegin () const
 returns a reverse iterator to the last element of the string
reverse_iterator rend ()
 returns a reverse iterator just past the beginning of the string
const_reverse_iterator rend () const
 returns a reverse iterator just past the beginning of the string
assign
UStringassign (iterator start, iterator end)
 gives the current string the values from start to end
UStringassign (const UString &str)
 assign str to the current string
UStringassign (const code_point *str)
 assign the nul-terminated str to the current string
UStringassign (const code_point *str, size_type num)
 assign the first num characters of str to the current string
UStringassign (const UString &str, size_type index, size_type len)
 assign len entries from str to the current string, starting at index
UStringassign (size_type num, const code_point &ch)
 assign num copies of ch to the current string
UStringassign (const std::wstring &wstr)
 assign wstr to the current string (wstr is treated as a UTF-16 stream)
UStringassign (const wchar_t *w_str)
 assign w_str to the current string
UStringassign (const wchar_t *w_str, size_type num)
 assign the first num characters of w_str to the current string
UStringassign (const std::string &str)
 assign str to the current string (str is treated as a UTF-8 stream)
UStringassign (const char *c_str)
 assign c_str to the current string (c_str is treated as a UTF-8 stream)
UStringassign (const char *c_str, size_type num)
 assign the first num characters of c_str to the current string (c_str is treated as a UTF-8 stream)
append
UStringappend (const UString &str)
 appends str on to the end of the current string
UStringappend (const code_point *str)
 appends str on to the end of the current string
UStringappend (const UString &str, size_type index, size_type len)
 appends a substring of str starting at index that is len characters long on to the end of the current string
UStringappend (const code_point *str, size_type num)
 appends num characters of str on to the end of the current string
UStringappend (size_type num, code_point ch)
 appends num repetitions of ch on to the end of the current string
UStringappend (iterator start, iterator end)
 appends the sequence denoted by start and end on to the end of the current string
UStringappend (const wchar_t *w_str, size_type num)
 appends num characters of str on to the end of the current string
UStringappend (size_type num, wchar_t ch)
 appends num repetitions of ch on to the end of the current string
UStringappend (const char *c_str, size_type num)
 appends num characters of str on to the end of the current string (UTF-8 encoding)
UStringappend (size_type num, char ch)
 appends num repetitions of ch on to the end of the current string (Unicode values less than 128)
UStringappend (size_type num, unicode_char ch)
 appends num repetitions of ch on to the end of the current string (Full Unicode spectrum)
insert
iterator insert (iterator i, const code_point &ch)
 inserts ch before the code point denoted by i
UStringinsert (size_type index, const UString &str)
 inserts str into the current string, at location index
UStringinsert (size_type index, const code_point *str)
 inserts str into the current string, at location index
UStringinsert (size_type index1, const UString &str, size_type index2, size_type num)
 inserts a substring of str (starting at index2 and num code points long) into the current string, at location index1
void insert (iterator i, iterator start, iterator end)
 inserts the code points denoted by start and end into the current string, before the code point specified by i
UStringinsert (size_type index, const code_point *str, size_type num)
 inserts num code points of str into the current string, at location index
UStringinsert (size_type index, const wchar_t *w_str, size_type num)
 inserts num code points of str into the current string, at location index
UStringinsert (size_type index, const char *c_str, size_type num)
 inserts num code points of str into the current string, at location index
UStringinsert (size_type index, size_type num, code_point ch)
 inserts num copies of ch into the current string, at location index
UStringinsert (size_type index, size_type num, wchar_t ch)
 inserts num copies of ch into the current string, at location index
UStringinsert (size_type index, size_type num, char ch)
 inserts num copies of ch into the current string, at location index
UStringinsert (size_type index, size_type num, unicode_char ch)
 inserts num copies of ch into the current string, at location index
void insert (iterator i, size_type num, const code_point &ch)
 inserts num copies of ch into the current string, before the code point denoted by i
void insert (iterator i, size_type num, const wchar_t &ch)
 inserts num copies of ch into the current string, before the code point denoted by i
void insert (iterator i, size_type num, const char &ch)
 inserts num copies of ch into the current string, before the code point denoted by i
void insert (iterator i, size_type num, const unicode_char &ch)
 inserts num copies of ch into the current string, before the code point denoted by i
erase
iterator erase (iterator loc)
 removes the code point pointed to by loc, returning an iterator to the next character
iterator erase (iterator start, iterator end)
 removes the code points between start and end (including the one at start but not the one at end), returning an iterator to the code point after the last code point removed
UStringerase (size_type index=0, size_type num=npos)
 removes num code points from the current string, starting at index
replace
UStringreplace (size_type index1, size_type num1, const UString &str)
 replaces up to num1 code points of the current string (starting at index1) with str
UStringreplace (size_type index1, size_type num1, const UString &str, size_type num2)
 replaces up to num1 code points of the current string (starting at index1) with up to num2 code points from str
UStringreplace (size_type index1, size_type num1, const UString &str, size_type index2, size_type num2)
 replaces up to num1 code points of the current string (starting at index1) with up to num2 code points from str beginning at index2
UStringreplace (iterator start, iterator end, const UString &str, size_type num=npos)
 replaces code points in the current string from start to end with num code points from str
UStringreplace (size_type index, size_type num1, size_type num2, code_point ch)
 replaces up to num1 code points in the current string (beginning at index) with num2 copies of ch
UStringreplace (iterator start, iterator end, size_type num, code_point ch)
 replaces the code points in the current string from start to end with num copies of ch
compare
int compare (const UString &str) const
 compare str to the current string
int compare (const code_point *str) const
 compare str to the current string
int compare (size_type index, size_type length, const UString &str) const
 compare str to a substring of the current string, starting at index for length characters
int compare (size_type index, size_type length, const UString &str, size_type index2, size_type length2) const
 compare a substring of str to a substring of the current string, where index2 and length2 refer to str and index and length refer to the current string
int compare (size_type index, size_type length, const code_point *str, size_type length2) const
 compare a substring of str to a substring of the current string, where the substring of str begins at zero and is length2 characters long, and the substring of the current string begins at index and is length characters long
int compare (size_type index, size_type length, const wchar_t *w_str, size_type length2) const
 compare a substring of str to a substring of the current string, where the substring of str begins at zero and is length2 elements long, and the substring of the current string begins at index and is length characters long
int compare (size_type index, size_type length, const char *c_str, size_type length2) const
 compare a substring of str to a substring of the current string, where the substring of str begins at zero and is length2 UTF-8 code points long, and the substring of the current string begins at index and is length characters long
find & rfind
size_type find (const UString &str, size_type index=0) const
 returns the index of the first occurrence of str within the current string, starting at index; returns UString::npos if nothing is found
size_type find (const code_point *cp_str, size_type index, size_type length) const
 returns the index of the first occurrence of str within the current string and within length code points, starting at index; returns UString::npos if nothing is found
size_type find (const char *c_str, size_type index, size_type length) const
 returns the index of the first occurrence of str within the current string and within length code points, starting at index; returns UString::npos if nothing is found
size_type find (const wchar_t *w_str, size_type index, size_type length) const
 returns the index of the first occurrence of str within the current string and within length code points, starting at index; returns UString::npos if nothing is found
size_type find (char ch, size_type index=0) const
 returns the index of the first occurrence ch within the current string, starting at index; returns UString::npos if nothing is found
size_type find (code_point ch, size_type index=0) const
 returns the index of the first occurrence ch within the current string, starting at index; returns UString::npos if nothing is found
size_type find (wchar_t ch, size_type index=0) const
 returns the index of the first occurrence ch within the current string, starting at index; returns UString::npos if nothing is found
size_type find (unicode_char ch, size_type index=0) const
 returns the index of the first occurrence ch within the current string, starting at index; returns UString::npos if nothing is found
size_type rfind (const UString &str, size_type index=0) const
 returns the location of the first occurrence of str in the current string, doing a reverse search from index; returns UString::npos if nothing is found
size_type rfind (const code_point *cp_str, size_type index, size_type num) const
 returns the location of the first occurrence of str in the current string, doing a reverse search from index, searching at most num characters; returns UString::npos if nothing is found
size_type rfind (const char *c_str, size_type index, size_type num) const
 returns the location of the first occurrence of str in the current string, doing a reverse search from index, searching at most num characters; returns UString::npos if nothing is found
size_type rfind (const wchar_t *w_str, size_type index, size_type num) const
 returns the location of the first occurrence of str in the current string, doing a reverse search from index, searching at most num characters; returns UString::npos if nothing is found
size_type rfind (char ch, size_type index=0) const
 returns the location of the first occurrence of ch in the current string, doing a reverse search from index; returns UString::npos if nothing is found
size_type rfind (code_point ch, size_type index) const
 returns the location of the first occurrence of ch in the current string, doing a reverse search from index; returns UString::npos if nothing is found
size_type rfind (wchar_t ch, size_type index=0) const
 returns the location of the first occurrence of ch in the current string, doing a reverse search from index; returns UString::npos if nothing is found
size_type rfind (unicode_char ch, size_type index=0) const
 returns the location of the first occurrence of ch in the current string, doing a reverse search from index; returns UString::npos if nothing is found
find_first/last_(not)_of
size_type find_first_of (const UString &str, size_type index=0, size_type num=npos) const
 Returns the index of the first character within the current string that matches any character in str, beginning the search at index and searching at most num characters; returns UString::npos if nothing is found.
size_type find_first_of (code_point ch, size_type index=0) const
 returns the index of the first occurrence of ch in the current string, starting the search at index; returns UString::npos if nothing is found
size_type find_first_of (char ch, size_type index=0) const
 returns the index of the first occurrence of ch in the current string, starting the search at index; returns UString::npos if nothing is found
size_type find_first_of (wchar_t ch, size_type index=0) const
 returns the index of the first occurrence of ch in the current string, starting the search at index; returns UString::npos if nothing is found
size_type find_first_of (unicode_char ch, size_type index=0) const
 returns the index of the first occurrence of ch in the current string, starting the search at index; returns UString::npos if nothing is found
size_type find_first_not_of (const UString &str, size_type index=0, size_type num=npos) const
 returns the index of the first character within the current string that does not match any character in str, beginning the search at index and searching at most num characters; returns UString::npos if nothing is found
size_type find_first_not_of (code_point ch, size_type index=0) const
 returns the index of the first character within the current string that does not match ch, starting the search at index; returns UString::npos if nothing is found
size_type find_first_not_of (char ch, size_type index=0) const
 returns the index of the first character within the current string that does not match ch, starting the search at index; returns UString::npos if nothing is found
size_type find_first_not_of (wchar_t ch, size_type index=0) const
 returns the index of the first character within the current string that does not match ch, starting the search at index; returns UString::npos if nothing is found
size_type find_first_not_of (unicode_char ch, size_type index=0) const
 returns the index of the first character within the current string that does not match ch, starting the search at index; returns UString::npos if nothing is found
size_type find_last_of (const UString &str, size_type index=npos, size_type num=npos) const
 returns the index of the first character within the current string that matches any character in str, doing a reverse search from index and searching at most num characters; returns UString::npos if nothing is found
size_type find_last_of (code_point ch, size_type index=npos) const
 returns the index of the first occurrence of ch in the current string, doing a reverse search from index; returns UString::npos if nothing is found
size_type find_last_of (char ch, size_type index=npos) const
 returns the index of the first occurrence of ch in the current string, doing a reverse search from index; returns UString::npos if nothing is found
size_type find_last_of (wchar_t ch, size_type index=npos) const
 returns the index of the first occurrence of ch in the current string, doing a reverse search from index; returns UString::npos if nothing is found
size_type find_last_of (unicode_char ch, size_type index=npos) const
 returns the index of the first occurrence of ch in the current string, doing a reverse search from index; returns UString::npos if nothing is found
size_type find_last_not_of (const UString &str, size_type index=npos, size_type num=npos) const
 returns the index of the last character within the current string that does not match any character in str, doing a reverse search from index; returns UString::npos if nothing is found
size_type find_last_not_of (code_point ch, size_type index=npos) const
 returns the index of the last occurrence of a character that does not match ch in the current string, doing a reverse search from index; returns UString::npos if nothing is found
size_type find_last_not_of (char ch, size_type index=npos) const
 returns the index of the last occurrence of a character that does not match ch in the current string, doing a reverse search from index; returns UString::npos if nothing is found
size_type find_last_not_of (wchar_t ch, size_type index=npos) const
 returns the index of the last occurrence of a character that does not match ch in the current string, doing a reverse search from index; returns UString::npos if nothing is found
size_type find_last_not_of (unicode_char ch, size_type index=npos) const
 returns the index of the last occurrence of a character that does not match ch in the current string, doing a reverse search from index; returns UString::npos if nothing is found
Operators
bool operator< (const UString &right) const
 less than operator
bool operator<= (const UString &right) const
 less than or equal operator
bool operator> (const UString &right) const
 greater than operator
bool operator>= (const UString &right) const
 greater than or equal operator
bool operator== (const UString &right) const
 equality operator
bool operator!= (const UString &right) const
 inequality operator
UStringoperator= (const UString &s)
 assignment operator, implicitly casts all compatible types
UStringoperator= (code_point ch)
 assignment operator
UStringoperator= (char ch)
 assignment operator
UStringoperator= (wchar_t ch)
 assignment operator
UStringoperator= (unicode_char ch)
 assignment operator
code_pointoperator[] (size_type index)
 code point dereference operator
const code_pointoperator[] (size_type index) const
 code point dereference operator
Implicit Cast Operators
 operator std::string () const
 implicit cast to std::string
 operator std::wstring () const
 implicit cast to std::wstring

Static Public Member Functions

UTF-16 character encoding/decoding
static bool _utf16_independent_char (code_point cp)
 returns true if cp does not match the signature for the lead of follow code point of a surrogate pair in a UTF-16 sequence
static bool _utf16_surrogate_lead (code_point cp)
 returns true if cp matches the signature of a surrogate pair lead character
static bool _utf16_surrogate_follow (code_point cp)
 returns true if cp matches the signature of a surrogate pair following character
static size_t _utf16_char_length (code_point cp)
 estimates the number of UTF-16 code points in the sequence starting with cp
static size_t _utf16_char_length (unicode_char uc)
 returns the number of UTF-16 code points needed to represent the given UTF-32 character cp
static size_t _utf16_to_utf32 (const code_point in_cp[2], unicode_char &out_uc)
 converts the given UTF-16 character buffer in_cp to a single UTF-32 Unicode character out_uc, returns the number of code points used to create the output character (2 for surrogate pairs, otherwise 1)
static size_t _utf32_to_utf16 (const unicode_char &in_uc, code_point out_cp[2])
 writes the given UTF-32 uc_in to the buffer location out_cp using UTF-16 encoding, returns the number of code points used to encode the input (always 1 or 2)
UTF-8 character encoding/decoding
static bool _utf8_start_char (unsigned char cp)
 returns true if cp is the beginning of a UTF-8 sequence
static size_t _utf8_char_length (unsigned char cp)
 estimates the number of UTF-8 code points in the sequence starting with cp
static size_t _utf8_char_length (unicode_char uc)
 returns the number of UTF-8 code points needed to represent the given UTF-32 character cp
static size_t _utf8_to_utf32 (const unsigned char in_cp[6], unicode_char &out_uc)
 converts the given UTF-8 character buffer to a single UTF-32 Unicode character, returns the number of bytes used to create the output character (maximum of 6)
static size_t _utf32_to_utf8 (const unicode_char &in_uc, unsigned char out_cp[6])
 writes the given UTF-32 uc_in to the buffer location out_cp using UTF-8 encoding, returns the number of bytes used to encode the input
static size_type _verifyUTF8 (const unsigned char *c_str)
 verifies a UTF-8 stream, returning the total number of Unicode characters found
static size_type _verifyUTF8 (const std::string &str)
 verifies a UTF-8 stream, returning the total number of Unicode characters found

Static Public Attributes

static const size_type npos = static_cast<size_type>(~0)
 the usual constant representing: not found, no limit, etc

Related Functions

(Note that these are not member functions.)

UString operator+ (const UString &s1, const UString &s2)
 string addition operator
UString operator+ (const UString &s1, UString::code_point c)
 string addition operator
UString operator+ (const UString &s1, UString::unicode_char c)
 string addition operator
UString operator+ (const UString &s1, char c)
 string addition operator
UString operator+ (const UString &s1, wchar_t c)
 string addition operator
UString operator+ (UString::code_point c, const UString &s2)
 string addition operator
UString operator+ (UString::unicode_char c, const UString &s2)
 string addition operator
UString operator+ (char c, const UString &s2)
 string addition operator
UString operator+ (wchar_t c, const UString &s2)
 string addition operator
std::ostream & operator<< (std::ostream &os, const UString &s)
 std::ostream write operator
std::wostream & operator<< (std::wostream &os, const UString &s)
 std::wostream write operator

Detailed Description

A UTF-16 string with implicit conversion to/from std::string and std::wstring.

This class provides a complete 1 to 1 map of most std::string functions (at least to my knowledge). Implicit conversions allow this string class to work with all common C++ string formats, with specialty functions defined where implicit conversion would cause potential problems or is otherwise unavailable.

Some additional functionality is present to assist in working with characters using the 32-bit UTF-32 encoding. (Which is guaranteed to fit any Unicode character into a single code point.) Note: Reverse iterators do not have this functionality due to the ambiguity that surrounds working with UTF-16 in reverse. (Such as, where should an iterator point to represent the beginning of a surrogate pair?)

Supported Input Types
The supported string types for input, and their assumed encoding schemes, are:
  • std::string (UTF-8)
  • char* (UTF-8)
  • std::wstring (autodetected UTF-16 / UTF-32 based on compiler)
  • wchar_t* (autodetected UTF-16 / UTF-32 based on compiler)
See also:

Definition at line 164 of file MyGUI_UString.h.


Member Typedef Documentation

a single UTF-16 code point

Definition at line 189 of file MyGUI_UString.h.

const iterator

Definition at line 430 of file MyGUI_UString.h.

const reverse iterator

Definition at line 431 of file MyGUI_UString.h.

typedef std::basic_string<code_point> MyGUI::UString::dstring

Definition at line 194 of file MyGUI_UString.h.

iterator

Definition at line 428 of file MyGUI_UString.h.

reverse iterator

Definition at line 429 of file MyGUI_UString.h.

typedef size_t MyGUI::UString::size_type

size type used to indicate string size and character positions within the string

Definition at line 181 of file MyGUI_UString.h.

a single 32-bit Unicode character

Definition at line 186 of file MyGUI_UString.h.

typedef std::basic_string<unicode_char> MyGUI::UString::utf32string

string type used for returning UTF-32 formatted data

Definition at line 197 of file MyGUI_UString.h.

value type typedef for use in iterators

Definition at line 192 of file MyGUI_UString.h.


Constructor & Destructor Documentation

default constructor, creates an empty string

Definition at line 523 of file MyGUI_UString.cpp.

MyGUI::UString::UString ( const UString copy)

copy constructor

Definition at line 528 of file MyGUI_UString.cpp.

MyGUI::UString::UString ( size_type  length,
const code_point ch 
)

length copies of ch

Definition at line 534 of file MyGUI_UString.cpp.

duplicate of nul-terminated sequence str

Definition at line 540 of file MyGUI_UString.cpp.

MyGUI::UString::UString ( const code_point str,
size_type  length 
)

duplicate of str, length code points long

Definition at line 546 of file MyGUI_UString.cpp.

MyGUI::UString::UString ( const UString str,
size_type  index,
size_type  length 
)

substring of str starting at index and length code points long

Definition at line 552 of file MyGUI_UString.cpp.

MyGUI::UString::UString ( const wchar_t *  w_str)

duplicate of nul-terminated wchar_t array

MyGUI::UString::UString ( const wchar_t *  w_str,
size_type  length 
)

duplicate of w_str, length characters long

MyGUI::UString::UString ( const std::wstring &  wstr)

duplicate of wstr

Definition at line 572 of file MyGUI_UString.cpp.

MyGUI::UString::UString ( const char *  c_str)

duplicate of nul-terminated C-string c_str (UTF-8 encoding)

Definition at line 578 of file MyGUI_UString.cpp.

MyGUI::UString::UString ( const char *  c_str,
size_type  length 
)

duplicate of c_str, length characters long (UTF-8 encoding)

Definition at line 584 of file MyGUI_UString.cpp.

MyGUI::UString::UString ( const std::string &  str)

duplicate of str (UTF-8 encoding)

Definition at line 590 of file MyGUI_UString.cpp.

destructor

Definition at line 596 of file MyGUI_UString.cpp.


Member Function Documentation

estimates the number of UTF-16 code points in the sequence starting with cp

Definition at line 1654 of file MyGUI_UString.cpp.

returns the number of UTF-16 code points needed to represent the given UTF-32 character cp

Definition at line 1661 of file MyGUI_UString.cpp.

returns true if cp does not match the signature for the lead of follow code point of a surrogate pair in a UTF-16 sequence

Definition at line 1633 of file MyGUI_UString.cpp.

returns true if cp matches the signature of a surrogate pair following character

Definition at line 1647 of file MyGUI_UString.cpp.

returns true if cp matches the signature of a surrogate pair lead character

Definition at line 1640 of file MyGUI_UString.cpp.

size_t MyGUI::UString::_utf16_to_utf32 ( const code_point  in_cp[2],
unicode_char out_uc 
) [static]

converts the given UTF-16 character buffer in_cp to a single UTF-32 Unicode character out_uc, returns the number of code points used to create the output character (2 for surrogate pairs, otherwise 1)

This function does it's best to prevent error conditions, verifying complete surrogate pairs before applying the algorithm. In the event that half of a pair is found it will happily generate a value in the 0xD800 - 0xDFFF range, which is normally an invalid Unicode value but we preserve them for use as sentinel values.

Definition at line 1668 of file MyGUI_UString.cpp.

size_t MyGUI::UString::_utf32_to_utf16 ( const unicode_char in_uc,
code_point  out_cp[2] 
) [static]

writes the given UTF-32 uc_in to the buffer location out_cp using UTF-16 encoding, returns the number of code points used to encode the input (always 1 or 2)

This function, like its counterpart, will happily create invalid UTF-16 surrogate pairs. These invalid entries will be created for any value of in_uc that falls in the range U+D800 - U+DFFF. These are generally useful as sentinel values to represent various program specific conditions.

Note:
This function will also pass through any single UTF-16 code point without modification, making it a safe method of ensuring a stream that is unknown UTF-32 or UTF-16 is truly UTF-16.

Definition at line 1697 of file MyGUI_UString.cpp.

size_t MyGUI::UString::_utf32_to_utf8 ( const unicode_char in_uc,
unsigned char  out_cp[6] 
) [static]

writes the given UTF-32 uc_in to the buffer location out_cp using UTF-8 encoding, returns the number of bytes used to encode the input

Definition at line 1794 of file MyGUI_UString.cpp.

size_t MyGUI::UString::_utf8_char_length ( unsigned char  cp) [static]

estimates the number of UTF-8 code points in the sequence starting with cp

Definition at line 1725 of file MyGUI_UString.cpp.

returns the number of UTF-8 code points needed to represent the given UTF-32 character cp

Definition at line 1736 of file MyGUI_UString.cpp.

bool MyGUI::UString::_utf8_start_char ( unsigned char  cp) [static]

returns true if cp is the beginning of a UTF-8 sequence

Definition at line 1720 of file MyGUI_UString.cpp.

size_t MyGUI::UString::_utf8_to_utf32 ( const unsigned char  in_cp[6],
unicode_char out_uc 
) [static]

converts the given UTF-8 character buffer to a single UTF-32 Unicode character, returns the number of bytes used to create the output character (maximum of 6)

Definition at line 1755 of file MyGUI_UString.cpp.

UString::size_type MyGUI::UString::_verifyUTF8 ( const unsigned char *  c_str) [static]

verifies a UTF-8 stream, returning the total number of Unicode characters found

Definition at line 1832 of file MyGUI_UString.cpp.

UString::size_type MyGUI::UString::_verifyUTF8 ( const std::string &  str) [static]

verifies a UTF-8 stream, returning the total number of Unicode characters found

Definition at line 1838 of file MyGUI_UString.cpp.

appends str on to the end of the current string

Definition at line 989 of file MyGUI_UString.cpp.

appends str on to the end of the current string

Definition at line 995 of file MyGUI_UString.cpp.

UString & MyGUI::UString::append ( const UString str,
size_type  index,
size_type  len 
)

appends a substring of str starting at index that is len characters long on to the end of the current string

Definition at line 1001 of file MyGUI_UString.cpp.

UString & MyGUI::UString::append ( const code_point str,
size_type  num 
)

appends num characters of str on to the end of the current string

Definition at line 1007 of file MyGUI_UString.cpp.

appends num repetitions of ch on to the end of the current string

Definition at line 1013 of file MyGUI_UString.cpp.

appends the sequence denoted by start and end on to the end of the current string

Definition at line 1019 of file MyGUI_UString.cpp.

UString& MyGUI::UString::append ( const wchar_t *  w_str,
size_type  num 
)

appends num characters of str on to the end of the current string

UString& MyGUI::UString::append ( size_type  num,
wchar_t  ch 
)

appends num repetitions of ch on to the end of the current string

UString & MyGUI::UString::append ( const char *  c_str,
size_type  num 
)

appends num characters of str on to the end of the current string (UTF-8 encoding)

Definition at line 1037 of file MyGUI_UString.cpp.

UString & MyGUI::UString::append ( size_type  num,
char  ch 
)

appends num repetitions of ch on to the end of the current string (Unicode values less than 128)

Definition at line 1044 of file MyGUI_UString.cpp.

appends num repetitions of ch on to the end of the current string (Full Unicode spectrum)

Definition at line 1050 of file MyGUI_UString.cpp.

gives the current string the values from start to end

Definition at line 866 of file MyGUI_UString.cpp.

assign str to the current string

Definition at line 872 of file MyGUI_UString.cpp.

assign the nul-terminated str to the current string

Definition at line 878 of file MyGUI_UString.cpp.

UString & MyGUI::UString::assign ( const code_point str,
size_type  num 
)

assign the first num characters of str to the current string

Definition at line 884 of file MyGUI_UString.cpp.

UString & MyGUI::UString::assign ( const UString str,
size_type  index,
size_type  len 
)

assign len entries from str to the current string, starting at index

Definition at line 890 of file MyGUI_UString.cpp.

UString & MyGUI::UString::assign ( size_type  num,
const code_point ch 
)

assign num copies of ch to the current string

Definition at line 896 of file MyGUI_UString.cpp.

UString & MyGUI::UString::assign ( const std::wstring &  wstr)

assign wstr to the current string (wstr is treated as a UTF-16 stream)

Definition at line 902 of file MyGUI_UString.cpp.

UString& MyGUI::UString::assign ( const wchar_t *  w_str)

assign w_str to the current string

UString& MyGUI::UString::assign ( const wchar_t *  w_str,
size_type  num 
)

assign the first num characters of w_str to the current string

UString & MyGUI::UString::assign ( const std::string &  str)

assign str to the current string (str is treated as a UTF-8 stream)

Definition at line 943 of file MyGUI_UString.cpp.

UString & MyGUI::UString::assign ( const char *  c_str)

assign c_str to the current string (c_str is treated as a UTF-8 stream)

Definition at line 976 of file MyGUI_UString.cpp.

UString & MyGUI::UString::assign ( const char *  c_str,
size_type  num 
)

assign the first num characters of c_str to the current string (c_str is treated as a UTF-8 stream)

Definition at line 982 of file MyGUI_UString.cpp.

returns the current string in UTF-32 form within a utf32string

Definition at line 724 of file MyGUI_UString.cpp.

returns the current string in UTF-32 form as a nul-terminated unicode_char array

Definition at line 730 of file MyGUI_UString.cpp.

const std::string & MyGUI::UString::asUTF8 ( ) const

returns the current string in UTF-8 form within a std::string

Definition at line 712 of file MyGUI_UString.cpp.

const char * MyGUI::UString::asUTF8_c_str ( ) const

returns the current string in UTF-8 form as a nul-terminated char array

Definition at line 718 of file MyGUI_UString.cpp.

const std::wstring & MyGUI::UString::asWStr ( ) const

returns the current string in the native form of std::wstring

Definition at line 736 of file MyGUI_UString.cpp.

const wchar_t * MyGUI::UString::asWStr_c_str ( ) const

returns the current string in the native form of a nul-terminated wchar_t array

Definition at line 742 of file MyGUI_UString.cpp.

returns a reference to the element in the string at index loc

Definition at line 748 of file MyGUI_UString.cpp.

returns a reference to the element in the string at index loc

Definition at line 753 of file MyGUI_UString.cpp.

returns an iterator to the first element of the string

Definition at line 802 of file MyGUI_UString.cpp.

returns an iterator to the first element of the string

Definition at line 810 of file MyGUI_UString.cpp.

returns a pointer to the first character in the current string

Definition at line 647 of file MyGUI_UString.cpp.

returns the number of elements that the string can hold before it will need to allocate more space

Definition at line 657 of file MyGUI_UString.cpp.

deletes all of the elements in the string

Definition at line 662 of file MyGUI_UString.cpp.

int MyGUI::UString::compare ( const UString str) const

compare str to the current string

Definition at line 1246 of file MyGUI_UString.cpp.

int MyGUI::UString::compare ( const code_point str) const

compare str to the current string

Definition at line 1251 of file MyGUI_UString.cpp.

int MyGUI::UString::compare ( size_type  index,
size_type  length,
const UString str 
) const

compare str to a substring of the current string, starting at index for length characters

Definition at line 1256 of file MyGUI_UString.cpp.

int MyGUI::UString::compare ( size_type  index,
size_type  length,
const UString str,
size_type  index2,
size_type  length2 
) const

compare a substring of str to a substring of the current string, where index2 and length2 refer to str and index and length refer to the current string

Definition at line 1261 of file MyGUI_UString.cpp.

int MyGUI::UString::compare ( size_type  index,
size_type  length,
const code_point str,
size_type  length2 
) const

compare a substring of str to a substring of the current string, where the substring of str begins at zero and is length2 characters long, and the substring of the current string begins at index and is length characters long

Definition at line 1266 of file MyGUI_UString.cpp.

int MyGUI::UString::compare ( size_type  index,
size_type  length,
const wchar_t *  w_str,
size_type  length2 
) const

compare a substring of str to a substring of the current string, where the substring of str begins at zero and is length2 elements long, and the substring of the current string begins at index and is length characters long

int MyGUI::UString::compare ( size_type  index,
size_type  length,
const char *  c_str,
size_type  length2 
) const

compare a substring of str to a substring of the current string, where the substring of str begins at zero and is length2 UTF-8 code points long, and the substring of the current string begins at index and is length characters long

Definition at line 1279 of file MyGUI_UString.cpp.

returns a pointer to the first character in the current string

Definition at line 652 of file MyGUI_UString.cpp.

bool MyGUI::UString::empty ( ) const

returns true if the string has no elements, false otherwise

Definition at line 642 of file MyGUI_UString.cpp.

returns an iterator just past the end of the string

Definition at line 818 of file MyGUI_UString.cpp.

returns an iterator just past the end of the string

Definition at line 826 of file MyGUI_UString.cpp.

removes the code point pointed to by loc, returning an iterator to the next character

Definition at line 1179 of file MyGUI_UString.cpp.

removes the code points between start and end (including the one at start but not the one at end), returning an iterator to the code point after the last code point removed

Definition at line 1187 of file MyGUI_UString.cpp.

UString & MyGUI::UString::erase ( size_type  index = 0,
size_type  num = npos 
)

removes num code points from the current string, starting at index

Definition at line 1195 of file MyGUI_UString.cpp.

UString::size_type MyGUI::UString::find ( const UString str,
size_type  index = 0 
) const

returns the index of the first occurrence of str within the current string, starting at index; returns UString::npos if nothing is found

str is a UTF-16 encoded string, but through implicit casting can also be a UTF-8 encoded string (const char* or std::string)

Definition at line 1285 of file MyGUI_UString.cpp.

UString::size_type MyGUI::UString::find ( const code_point cp_str,
size_type  index,
size_type  length 
) const

returns the index of the first occurrence of str within the current string and within length code points, starting at index; returns UString::npos if nothing is found

cp_str is a UTF-16 encoded string

Definition at line 1290 of file MyGUI_UString.cpp.

UString::size_type MyGUI::UString::find ( const char *  c_str,
size_type  index,
size_type  length 
) const

returns the index of the first occurrence of str within the current string and within length code points, starting at index; returns UString::npos if nothing is found

cp_str is a UTF-8 encoded string

Definition at line 1296 of file MyGUI_UString.cpp.

size_type MyGUI::UString::find ( const wchar_t *  w_str,
size_type  index,
size_type  length 
) const

returns the index of the first occurrence of str within the current string and within length code points, starting at index; returns UString::npos if nothing is found

cp_str is a UTF-16 encoded string

UString::size_type MyGUI::UString::find ( char  ch,
size_type  index = 0 
) const

returns the index of the first occurrence ch within the current string, starting at index; returns UString::npos if nothing is found

ch is only capable of representing Unicode values up to U+007F (127)

Definition at line 1310 of file MyGUI_UString.cpp.

returns the index of the first occurrence ch within the current string, starting at index; returns UString::npos if nothing is found

ch is only capable of representing Unicode values up to U+FFFF (65535)

Definition at line 1315 of file MyGUI_UString.cpp.

size_type MyGUI::UString::find ( wchar_t  ch,
size_type  index = 0 
) const

returns the index of the first occurrence ch within the current string, starting at index; returns UString::npos if nothing is found

ch is only capable of representing Unicode values up to U+FFFF (65535)

returns the index of the first occurrence ch within the current string, starting at index; returns UString::npos if nothing is found

ch can fully represent any Unicode character

Definition at line 1327 of file MyGUI_UString.cpp.

UString::size_type MyGUI::UString::find_first_not_of ( const UString str,
size_type  index = 0,
size_type  num = npos 
) const

returns the index of the first character within the current string that does not match any character in str, beginning the search at index and searching at most num characters; returns UString::npos if nothing is found

Definition at line 1422 of file MyGUI_UString.cpp.

returns the index of the first character within the current string that does not match ch, starting the search at index; returns UString::npos if nothing is found

Definition at line 1435 of file MyGUI_UString.cpp.

returns the index of the first character within the current string that does not match ch, starting the search at index; returns UString::npos if nothing is found

Definition at line 1442 of file MyGUI_UString.cpp.

size_type MyGUI::UString::find_first_not_of ( wchar_t  ch,
size_type  index = 0 
) const

returns the index of the first character within the current string that does not match ch, starting the search at index; returns UString::npos if nothing is found

returns the index of the first character within the current string that does not match ch, starting the search at index; returns UString::npos if nothing is found

Definition at line 1454 of file MyGUI_UString.cpp.

UString::size_type MyGUI::UString::find_first_of ( const UString str,
size_type  index = 0,
size_type  num = npos 
) const

Returns the index of the first character within the current string that matches any character in str, beginning the search at index and searching at most num characters; returns UString::npos if nothing is found.

Definition at line 1383 of file MyGUI_UString.cpp.

returns the index of the first occurrence of ch in the current string, starting the search at index; returns UString::npos if nothing is found

Definition at line 1396 of file MyGUI_UString.cpp.

UString::size_type MyGUI::UString::find_first_of ( char  ch,
size_type  index = 0 
) const

returns the index of the first occurrence of ch in the current string, starting the search at index; returns UString::npos if nothing is found

Definition at line 1403 of file MyGUI_UString.cpp.

size_type MyGUI::UString::find_first_of ( wchar_t  ch,
size_type  index = 0 
) const

returns the index of the first occurrence of ch in the current string, starting the search at index; returns UString::npos if nothing is found

returns the index of the first occurrence of ch in the current string, starting the search at index; returns UString::npos if nothing is found

Definition at line 1415 of file MyGUI_UString.cpp.

returns the index of the last character within the current string that does not match any character in str, doing a reverse search from index; returns UString::npos if nothing is found

Definition at line 1503 of file MyGUI_UString.cpp.

returns the index of the last occurrence of a character that does not match ch in the current string, doing a reverse search from index; returns UString::npos if nothing is found

Definition at line 1524 of file MyGUI_UString.cpp.

returns the index of the last occurrence of a character that does not match ch in the current string, doing a reverse search from index; returns UString::npos if nothing is found

Definition at line 1531 of file MyGUI_UString.cpp.

size_type MyGUI::UString::find_last_not_of ( wchar_t  ch,
size_type  index = npos 
) const

returns the index of the last occurrence of a character that does not match ch in the current string, doing a reverse search from index; returns UString::npos if nothing is found

returns the index of the last occurrence of a character that does not match ch in the current string, doing a reverse search from index; returns UString::npos if nothing is found

Definition at line 1543 of file MyGUI_UString.cpp.

UString::size_type MyGUI::UString::find_last_of ( const UString str,
size_type  index = npos,
size_type  num = npos 
) const

returns the index of the first character within the current string that matches any character in str, doing a reverse search from index and searching at most num characters; returns UString::npos if nothing is found

Definition at line 1461 of file MyGUI_UString.cpp.

returns the index of the first occurrence of ch in the current string, doing a reverse search from index; returns UString::npos if nothing is found

Definition at line 1482 of file MyGUI_UString.cpp.

size_type MyGUI::UString::find_last_of ( char  ch,
size_type  index = npos 
) const [inline]

returns the index of the first occurrence of ch in the current string, doing a reverse search from index; returns UString::npos if nothing is found

Definition at line 833 of file MyGUI_UString.h.

size_type MyGUI::UString::find_last_of ( wchar_t  ch,
size_type  index = npos 
) const

returns the index of the first occurrence of ch in the current string, doing a reverse search from index; returns UString::npos if nothing is found

returns the index of the first occurrence of ch in the current string, doing a reverse search from index; returns UString::npos if nothing is found

Definition at line 1496 of file MyGUI_UString.cpp.

returns the data point loc evaluated as a UTF-32 value

This function will will only properly decode surrogate pairs when loc points to the index of a lead code point that is followed by a trailing code point. Evaluating the trailing code point itself, or pointing to a code point that is a sentinel value (part of a broken pair) will return the value of just that code point (not a valid Unicode value, but useful as a sentinel value).

Definition at line 758 of file MyGUI_UString.cpp.

inserts ch before the code point denoted by i

Definition at line 1066 of file MyGUI_UString.cpp.

UString & MyGUI::UString::insert ( size_type  index,
const UString str 
)

inserts str into the current string, at location index

Definition at line 1074 of file MyGUI_UString.cpp.

UString& MyGUI::UString::insert ( size_type  index,
const code_point str 
) [inline]

inserts str into the current string, at location index

Definition at line 653 of file MyGUI_UString.h.

UString & MyGUI::UString::insert ( size_type  index1,
const UString str,
size_type  index2,
size_type  num 
)

inserts a substring of str (starting at index2 and num code points long) into the current string, at location index1

Definition at line 1080 of file MyGUI_UString.cpp.

void MyGUI::UString::insert ( iterator  i,
iterator  start,
iterator  end 
)

inserts the code points denoted by start and end into the current string, before the code point specified by i

Definition at line 1086 of file MyGUI_UString.cpp.

UString & MyGUI::UString::insert ( size_type  index,
const code_point str,
size_type  num 
)

inserts num code points of str into the current string, at location index

Definition at line 1091 of file MyGUI_UString.cpp.

UString& MyGUI::UString::insert ( size_type  index,
const wchar_t *  w_str,
size_type  num 
)

inserts num code points of str into the current string, at location index

UString & MyGUI::UString::insert ( size_type  index,
const char *  c_str,
size_type  num 
)

inserts num code points of str into the current string, at location index

Definition at line 1106 of file MyGUI_UString.cpp.

inserts num copies of ch into the current string, at location index

Definition at line 1113 of file MyGUI_UString.cpp.

UString& MyGUI::UString::insert ( size_type  index,
size_type  num,
wchar_t  ch 
)

inserts num copies of ch into the current string, at location index

UString & MyGUI::UString::insert ( size_type  index,
size_type  num,
char  ch 
)

inserts num copies of ch into the current string, at location index

Definition at line 1127 of file MyGUI_UString.cpp.

inserts num copies of ch into the current string, at location index

Definition at line 1133 of file MyGUI_UString.cpp.

void MyGUI::UString::insert ( iterator  i,
size_type  num,
const code_point ch 
)

inserts num copies of ch into the current string, before the code point denoted by i

Definition at line 1148 of file MyGUI_UString.cpp.

void MyGUI::UString::insert ( iterator  i,
size_type  num,
const wchar_t &  ch 
)

inserts num copies of ch into the current string, before the code point denoted by i

void MyGUI::UString::insert ( iterator  i,
size_type  num,
const char &  ch 
)

inserts num copies of ch into the current string, before the code point denoted by i

Definition at line 1159 of file MyGUI_UString.cpp.

void MyGUI::UString::insert ( iterator  i,
size_type  num,
const unicode_char ch 
)

inserts num copies of ch into the current string, before the code point denoted by i

Definition at line 1164 of file MyGUI_UString.cpp.

returns true if the given Unicode character ch is in this string

Definition at line 702 of file MyGUI_UString.cpp.

Returns the number of code points in the current string.

Definition at line 606 of file MyGUI_UString.cpp.

Returns the number of Unicode characters in the string.

Executes in linear time.

Definition at line 611 of file MyGUI_UString.cpp.

returns the maximum number of UTF-16 code points that the string can hold

Definition at line 622 of file MyGUI_UString.cpp.

MyGUI::UString::operator std::string ( ) const

implicit cast to std::string

Definition at line 1621 of file MyGUI_UString.cpp.

MyGUI::UString::operator std::wstring ( ) const

implicit cast to std::wstring

Definition at line 1627 of file MyGUI_UString.cpp.

bool MyGUI::UString::operator!= ( const UString right) const

inequality operator

Definition at line 1606 of file MyGUI_UString.cpp.

bool MyGUI::UString::operator< ( const UString right) const

less than operator

Definition at line 1550 of file MyGUI_UString.cpp.

bool MyGUI::UString::operator<= ( const UString right) const

less than or equal operator

Definition at line 1555 of file MyGUI_UString.cpp.

UString & MyGUI::UString::operator= ( const UString s)

assignment operator, implicitly casts all compatible types

Definition at line 1560 of file MyGUI_UString.cpp.

UString & MyGUI::UString::operator= ( code_point  ch)

assignment operator

Definition at line 1565 of file MyGUI_UString.cpp.

UString & MyGUI::UString::operator= ( char  ch)

assignment operator

Definition at line 1571 of file MyGUI_UString.cpp.

UString& MyGUI::UString::operator= ( wchar_t  ch)

assignment operator

UString & MyGUI::UString::operator= ( unicode_char  ch)

assignment operator

Definition at line 1585 of file MyGUI_UString.cpp.

bool MyGUI::UString::operator== ( const UString right) const

equality operator

Definition at line 1601 of file MyGUI_UString.cpp.

bool MyGUI::UString::operator> ( const UString right) const

greater than operator

Definition at line 1591 of file MyGUI_UString.cpp.

bool MyGUI::UString::operator>= ( const UString right) const

greater than or equal operator

Definition at line 1596 of file MyGUI_UString.cpp.

UString::code_point & MyGUI::UString::operator[] ( size_type  index)

code point dereference operator

Definition at line 1611 of file MyGUI_UString.cpp.

const UString::code_point & MyGUI::UString::operator[] ( size_type  index) const

code point dereference operator

Definition at line 1616 of file MyGUI_UString.cpp.

appends val to the end of the string

Definition at line 676 of file MyGUI_UString.cpp.

void MyGUI::UString::push_back ( wchar_t  val)

appends val to the end of the string

appends val to the end of the string

This can be used to push surrogate pair code points, you'll just need to push them one after the other.

Definition at line 692 of file MyGUI_UString.cpp.

void MyGUI::UString::push_back ( char  val)

appends val to the end of the string

Limited to characters under the 127 value barrier.

Definition at line 697 of file MyGUI_UString.cpp.

returns a reverse iterator to the last element of the string

Definition at line 834 of file MyGUI_UString.cpp.

returns a reverse iterator to the last element of the string

Definition at line 842 of file MyGUI_UString.cpp.

returns a reverse iterator just past the beginning of the string

Definition at line 850 of file MyGUI_UString.cpp.

returns a reverse iterator just past the beginning of the string

Definition at line 858 of file MyGUI_UString.cpp.

UString & MyGUI::UString::replace ( size_type  index1,
size_type  num1,
const UString str 
)

replaces up to num1 code points of the current string (starting at index1) with str

Definition at line 1204 of file MyGUI_UString.cpp.

UString & MyGUI::UString::replace ( size_type  index1,
size_type  num1,
const UString str,
size_type  num2 
)

replaces up to num1 code points of the current string (starting at index1) with up to num2 code points from str

Definition at line 1210 of file MyGUI_UString.cpp.

UString & MyGUI::UString::replace ( size_type  index1,
size_type  num1,
const UString str,
size_type  index2,
size_type  num2 
)

replaces up to num1 code points of the current string (starting at index1) with up to num2 code points from str beginning at index2

Definition at line 1216 of file MyGUI_UString.cpp.

UString & MyGUI::UString::replace ( iterator  start,
iterator  end,
const UString str,
size_type  num = npos 
)

replaces code points in the current string from start to end with num code points from str

Definition at line 1222 of file MyGUI_UString.cpp.

UString & MyGUI::UString::replace ( size_type  index,
size_type  num1,
size_type  num2,
code_point  ch 
)

replaces up to num1 code points in the current string (beginning at index) with num2 copies of ch

Definition at line 1231 of file MyGUI_UString.cpp.

replaces the code points in the current string from start to end with num copies of ch

Definition at line 1237 of file MyGUI_UString.cpp.

sets the capacity of the string to at least size code points

Definition at line 627 of file MyGUI_UString.cpp.

void MyGUI::UString::resize ( size_type  num,
const code_point val = 0 
)

changes the size of the string to size, filling in any new area with val

Definition at line 632 of file MyGUI_UString.cpp.

UString::size_type MyGUI::UString::rfind ( const UString str,
size_type  index = 0 
) const

returns the location of the first occurrence of str in the current string, doing a reverse search from index; returns UString::npos if nothing is found

Definition at line 1334 of file MyGUI_UString.cpp.

UString::size_type MyGUI::UString::rfind ( const code_point cp_str,
size_type  index,
size_type  num 
) const

returns the location of the first occurrence of str in the current string, doing a reverse search from index, searching at most num characters; returns UString::npos if nothing is found

Definition at line 1339 of file MyGUI_UString.cpp.

UString::size_type MyGUI::UString::rfind ( const char *  c_str,
size_type  index,
size_type  num 
) const

returns the location of the first occurrence of str in the current string, doing a reverse search from index, searching at most num characters; returns UString::npos if nothing is found

Definition at line 1345 of file MyGUI_UString.cpp.

size_type MyGUI::UString::rfind ( const wchar_t *  w_str,
size_type  index,
size_type  num 
) const

returns the location of the first occurrence of str in the current string, doing a reverse search from index, searching at most num characters; returns UString::npos if nothing is found

UString::size_type MyGUI::UString::rfind ( char  ch,
size_type  index = 0 
) const

returns the location of the first occurrence of ch in the current string, doing a reverse search from index; returns UString::npos if nothing is found

Definition at line 1359 of file MyGUI_UString.cpp.

returns the location of the first occurrence of ch in the current string, doing a reverse search from index; returns UString::npos if nothing is found

Definition at line 1364 of file MyGUI_UString.cpp.

size_type MyGUI::UString::rfind ( wchar_t  ch,
size_type  index = 0 
) const

returns the location of the first occurrence of ch in the current string, doing a reverse search from index; returns UString::npos if nothing is found

returns the location of the first occurrence of ch in the current string, doing a reverse search from index; returns UString::npos if nothing is found

Definition at line 1376 of file MyGUI_UString.cpp.

sets the value of the character at loc to the Unicode value ch (UTF-32)

Providing sentinel values (values between U+D800-U+DFFF) are accepted, but you should be aware that you can also unwittingly create a valid surrogate pair if you don't pay attention to what you are doing.

Note:
This operation may also lengthen the string if a surrogate pair is needed to represent the value given, but one is not available to replace; or alternatively shorten the string if an existing surrogate pair is replaced with a character that is representable without a surrogate pair. The return value will signify any lengthening or shortening performed, returning 0 if no change was made, -1 if the string was shortened, or 1 if the string was lengthened. Any single call can only change the string length by + or - 1.

Definition at line 775 of file MyGUI_UString.cpp.

Returns the number of code points in the current string.

Definition at line 601 of file MyGUI_UString.cpp.

UString MyGUI::UString::substr ( size_type  index,
size_type  num = npos 
) const

returns a substring of the current string, starting at index, and num characters long.

If num is omitted, it will default to UString::npos, and the substr() function will simply return the remainder of the string starting at index.

Definition at line 667 of file MyGUI_UString.cpp.

void MyGUI::UString::swap ( UString from)

exchanges the elements of the current string with those of from

Definition at line 637 of file MyGUI_UString.cpp.


Friends And Related Function Documentation

UString operator+ ( const UString s1,
const UString s2 
) [related]

string addition operator

Definition at line 997 of file MyGUI_UString.h.

UString operator+ ( const UString s1,
UString::code_point  c 
) [related]

string addition operator

Definition at line 1001 of file MyGUI_UString.h.

UString operator+ ( const UString s1,
UString::unicode_char  c 
) [related]

string addition operator

Definition at line 1005 of file MyGUI_UString.h.

UString operator+ ( const UString s1,
char  c 
) [related]

string addition operator

Definition at line 1009 of file MyGUI_UString.h.

UString operator+ ( const UString s1,
wchar_t  c 
) [related]

string addition operator

Definition at line 1014 of file MyGUI_UString.h.

UString operator+ ( UString::code_point  c,
const UString s2 
) [related]

string addition operator

Definition at line 1019 of file MyGUI_UString.h.

UString operator+ ( UString::unicode_char  c,
const UString s2 
) [related]

string addition operator

Definition at line 1023 of file MyGUI_UString.h.

UString operator+ ( char  c,
const UString s2 
) [related]

string addition operator

Definition at line 1027 of file MyGUI_UString.h.

UString operator+ ( wchar_t  c,
const UString s2 
) [related]

string addition operator

Definition at line 1032 of file MyGUI_UString.h.

std::ostream & operator<< ( std::ostream &  os,
const UString s 
) [related]

std::ostream write operator

Definition at line 1085 of file MyGUI_UString.h.

std::wostream & operator<< ( std::wostream &  os,
const UString s 
) [related]

std::wostream write operator

Definition at line 1090 of file MyGUI_UString.h.


Field Documentation

std::string* MyGUI::UString::mStrBuffer [mutable]

Definition at line 989 of file MyGUI_UString.h.

Definition at line 991 of file MyGUI_UString.h.

void* MyGUI::UString::mVoidBuffer [mutable]

Definition at line 988 of file MyGUI_UString.h.

std::wstring* MyGUI::UString::mWStrBuffer [mutable]

Definition at line 990 of file MyGUI_UString.h.

const size_type MyGUI::UString::npos = static_cast<size_type>(~0) [static]

the usual constant representing: not found, no limit, etc

Definition at line 183 of file MyGUI_UString.h.


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