MyGUI
3.0.1
|
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... | |
union | Buffer |
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 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_point * | c_str () const |
returns a pointer to the first character in the current string | |
const code_point * | data () 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 utf32string & | asUTF32 () const |
returns the current string in UTF-32 form within a utf32string | |
const unicode_char * | asUTF32_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_point & | at (size_type loc) |
returns a reference to the element in the string at index loc | |
const code_point & | at (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 | |
UString & | assign (iterator start, iterator end) |
gives the current string the values from start to end | |
UString & | assign (const UString &str) |
assign str to the current string | |
UString & | assign (const code_point *str) |
assign the nul-terminated str to the current string | |
UString & | assign (const code_point *str, size_type num) |
assign the first num characters of str to the current string | |
UString & | assign (const UString &str, size_type index, size_type len) |
assign len entries from str to the current string, starting at index | |
UString & | assign (size_type num, const code_point &ch) |
assign num copies of ch to the current string | |
UString & | assign (const std::wstring &wstr) |
assign wstr to the current string (wstr is treated as a UTF-16 stream) | |
UString & | assign (const wchar_t *w_str) |
assign w_str to the current string | |
UString & | assign (const wchar_t *w_str, size_type num) |
assign the first num characters of w_str to the current string | |
UString & | assign (const std::string &str) |
assign str to the current string (str is treated as a UTF-8 stream) | |
UString & | assign (const char *c_str) |
assign c_str to the current string (c_str is treated as a UTF-8 stream) | |
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) | |
append | |
UString & | append (const UString &str) |
appends str on to the end of the current string | |
UString & | append (const code_point *str) |
appends str on to the end of the current string | |
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 | |
UString & | append (const code_point *str, size_type num) |
appends num characters of str on to the end of the current string | |
UString & | append (size_type num, code_point ch) |
appends num repetitions of ch on to the end of the current string | |
UString & | append (iterator start, iterator end) |
appends the sequence denoted by start and end on to the end of the current string | |
UString & | append (const wchar_t *w_str, size_type num) |
appends num characters of str on to the end of the current string | |
UString & | append (size_type num, wchar_t ch) |
appends num repetitions of ch on to the end of the current string | |
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) | |
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) | |
UString & | append (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 | |
UString & | insert (size_type index, const UString &str) |
inserts str into the current string, at location index | |
UString & | insert (size_type index, const code_point *str) |
inserts str into the current string, at location index | |
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 | |
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 | |
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 | |
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 & | insert (size_type index, const char *c_str, size_type num) |
inserts num code points of str into the current string, at location index | |
UString & | insert (size_type index, size_type num, code_point ch) |
inserts num copies of ch into the current string, at location index | |
UString & | insert (size_type index, size_type num, wchar_t ch) |
inserts num copies of ch into the current string, at location index | |
UString & | insert (size_type index, size_type num, char ch) |
inserts num copies of ch into the current string, at location index | |
UString & | insert (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 | |
UString & | erase (size_type index=0, size_type num=npos) |
removes num code points from the current string, starting at index | |
replace | |
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 | |
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 | |
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 | |
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 | |
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 | |
UString & | replace (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 | |
UString & | operator= (const UString &s) |
assignment operator, implicitly casts all compatible types | |
UString & | operator= (code_point ch) |
assignment operator | |
UString & | operator= (char ch) |
assignment operator | |
UString & | operator= (wchar_t ch) |
assignment operator | |
UString & | operator= (unicode_char ch) |
assignment operator | |
code_point & | operator[] (size_type index) |
code point dereference operator | |
const code_point & | operator[] (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 = ~(size_t)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 |
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?)
Definition at line 167 of file MyGUI_UString.h.
typedef uint16 MyGUI::UString::code_point |
a single UTF-16 code point
Definition at line 193 of file MyGUI_UString.h.
const iterator
Definition at line 905 of file MyGUI_UString.h.
const reverse iterator
Definition at line 906 of file MyGUI_UString.h.
typedef std::basic_string<code_point> MyGUI::UString::dstring |
Definition at line 198 of file MyGUI_UString.h.
iterator
Definition at line 903 of file MyGUI_UString.h.
reverse iterator
Definition at line 904 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 185 of file MyGUI_UString.h.
typedef uint32 MyGUI::UString::unicode_char |
a single 32-bit Unicode character
Definition at line 190 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 201 of file MyGUI_UString.h.
typedef code_point MyGUI::UString::value_type |
value type typedef for use in iterators
Definition at line 196 of file MyGUI_UString.h.
MyGUI::UString::UString | ( | ) | [inline] |
default constructor, creates an empty string
Definition at line 912 of file MyGUI_UString.h.
MyGUI::UString::UString | ( | const UString & | copy | ) | [inline] |
copy constructor
Definition at line 917 of file MyGUI_UString.h.
MyGUI::UString::UString | ( | size_type | length, |
const code_point & | ch | ||
) | [inline] |
length copies of ch
Definition at line 923 of file MyGUI_UString.h.
MyGUI::UString::UString | ( | const code_point * | str | ) | [inline] |
duplicate of nul-terminated sequence str
Definition at line 929 of file MyGUI_UString.h.
MyGUI::UString::UString | ( | const code_point * | str, |
size_type | length | ||
) | [inline] |
duplicate of str, length code points long
Definition at line 935 of file MyGUI_UString.h.
MyGUI::UString::UString | ( | const UString & | str, |
size_type | index, | ||
size_type | length | ||
) | [inline] |
substring of str starting at index and length code points long
Definition at line 941 of file MyGUI_UString.h.
MyGUI::UString::UString | ( | const wchar_t * | w_str | ) | [inline] |
duplicate of nul-terminated wchar_t
array
Definition at line 948 of file MyGUI_UString.h.
MyGUI::UString::UString | ( | const wchar_t * | w_str, |
size_type | length | ||
) | [inline] |
duplicate of w_str, length characters long
Definition at line 954 of file MyGUI_UString.h.
MyGUI::UString::UString | ( | const std::wstring & | wstr | ) | [inline] |
duplicate of wstr
Definition at line 961 of file MyGUI_UString.h.
MyGUI::UString::UString | ( | const char * | c_str | ) | [inline] |
duplicate of nul-terminated C-string c_str (UTF-8 encoding)
Definition at line 967 of file MyGUI_UString.h.
MyGUI::UString::UString | ( | const char * | c_str, |
size_type | length | ||
) | [inline] |
duplicate of c_str, length characters long (UTF-8 encoding)
Definition at line 973 of file MyGUI_UString.h.
MyGUI::UString::UString | ( | const std::string & | str | ) | [inline] |
duplicate of str (UTF-8 encoding)
Definition at line 979 of file MyGUI_UString.h.
MyGUI::UString::~UString | ( | ) | [inline] |
destructor
Definition at line 985 of file MyGUI_UString.h.
static size_t MyGUI::UString::_utf16_char_length | ( | code_point | cp | ) | [inline, static] |
estimates the number of UTF-16 code points in the sequence starting with cp
Definition at line 2195 of file MyGUI_UString.h.
static size_t MyGUI::UString::_utf16_char_length | ( | unicode_char | uc | ) | [inline, static] |
returns the number of UTF-16 code points needed to represent the given UTF-32 character cp
Definition at line 2202 of file MyGUI_UString.h.
static bool MyGUI::UString::_utf16_independent_char | ( | code_point | cp | ) | [inline, static] |
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 2174 of file MyGUI_UString.h.
static bool MyGUI::UString::_utf16_surrogate_follow | ( | code_point | cp | ) | [inline, static] |
returns true
if cp matches the signature of a surrogate pair following character
Definition at line 2188 of file MyGUI_UString.h.
static bool MyGUI::UString::_utf16_surrogate_lead | ( | code_point | cp | ) | [inline, static] |
returns true
if cp matches the signature of a surrogate pair lead character
Definition at line 2181 of file MyGUI_UString.h.
static size_t MyGUI::UString::_utf16_to_utf32 | ( | const code_point | in_cp[2], |
unicode_char & | out_uc | ||
) | [inline, 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 2213 of file MyGUI_UString.h.
static size_t MyGUI::UString::_utf32_to_utf16 | ( | const unicode_char & | in_uc, |
code_point | out_cp[2] | ||
) | [inline, 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.
Definition at line 2249 of file MyGUI_UString.h.
static size_t MyGUI::UString::_utf32_to_utf8 | ( | const unicode_char & | in_uc, |
unsigned char | out_cp[6] | ||
) | [inline, 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 2357 of file MyGUI_UString.h.
static size_t MyGUI::UString::_utf8_char_length | ( | unsigned char | cp | ) | [inline, static] |
estimates the number of UTF-8 code points in the sequence starting with cp
Definition at line 2284 of file MyGUI_UString.h.
static size_t MyGUI::UString::_utf8_char_length | ( | unicode_char | uc | ) | [inline, static] |
returns the number of UTF-8 code points needed to represent the given UTF-32 character cp
Definition at line 2295 of file MyGUI_UString.h.
static bool MyGUI::UString::_utf8_start_char | ( | unsigned char | cp | ) | [inline, static] |
returns true
if cp is the beginning of a UTF-8 sequence
Definition at line 2279 of file MyGUI_UString.h.
static size_t MyGUI::UString::_utf8_to_utf32 | ( | const unsigned char | in_cp[6], |
unicode_char & | out_uc | ||
) | [inline, 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 2315 of file MyGUI_UString.h.
static size_type MyGUI::UString::_verifyUTF8 | ( | const unsigned char * | c_str | ) | [inline, static] |
verifies a UTF-8 stream, returning the total number of Unicode characters found
Definition at line 2398 of file MyGUI_UString.h.
static size_type MyGUI::UString::_verifyUTF8 | ( | const std::string & | str | ) | [inline, static] |
verifies a UTF-8 stream, returning the total number of Unicode characters found
Definition at line 2404 of file MyGUI_UString.h.
UString& MyGUI::UString::append | ( | const UString & | str | ) | [inline] |
appends str on to the end of the current string
Definition at line 1436 of file MyGUI_UString.h.
UString& MyGUI::UString::append | ( | const code_point * | str | ) | [inline] |
appends str on to the end of the current string
Definition at line 1442 of file MyGUI_UString.h.
UString& MyGUI::UString::append | ( | const UString & | str, |
size_type | index, | ||
size_type | len | ||
) | [inline] |
appends a substring of str starting at index that is len characters long on to the end of the current string
Definition at line 1448 of file MyGUI_UString.h.
UString& MyGUI::UString::append | ( | const code_point * | str, |
size_type | num | ||
) | [inline] |
appends num characters of str on to the end of the current string
Definition at line 1454 of file MyGUI_UString.h.
UString& MyGUI::UString::append | ( | size_type | num, |
code_point | ch | ||
) | [inline] |
appends num repetitions of ch on to the end of the current string
Definition at line 1460 of file MyGUI_UString.h.
UString& MyGUI::UString::append | ( | iterator | start, |
iterator | end | ||
) | [inline] |
appends the sequence denoted by start and end on to the end of the current string
Definition at line 1466 of file MyGUI_UString.h.
UString& MyGUI::UString::append | ( | const wchar_t * | w_str, |
size_type | num | ||
) | [inline] |
appends num characters of str on to the end of the current string
Definition at line 1473 of file MyGUI_UString.h.
UString& MyGUI::UString::append | ( | size_type | num, |
wchar_t | ch | ||
) | [inline] |
appends num repetitions of ch on to the end of the current string
Definition at line 1479 of file MyGUI_UString.h.
UString& MyGUI::UString::append | ( | const char * | c_str, |
size_type | num | ||
) | [inline] |
appends num characters of str on to the end of the current string (UTF-8 encoding)
Definition at line 1485 of file MyGUI_UString.h.
UString& MyGUI::UString::append | ( | size_type | num, |
char | ch | ||
) | [inline] |
appends num repetitions of ch on to the end of the current string (Unicode values less than 128)
Definition at line 1492 of file MyGUI_UString.h.
UString& MyGUI::UString::append | ( | size_type | num, |
unicode_char | ch | ||
) | [inline] |
appends num repetitions of ch on to the end of the current string (Full Unicode spectrum)
Definition at line 1498 of file MyGUI_UString.h.
UString& MyGUI::UString::assign | ( | iterator | start, |
iterator | end | ||
) | [inline] |
gives the current string the values from start to end
Definition at line 1303 of file MyGUI_UString.h.
UString& MyGUI::UString::assign | ( | const UString & | str | ) | [inline] |
assign str to the current string
Definition at line 1309 of file MyGUI_UString.h.
UString& MyGUI::UString::assign | ( | const code_point * | str | ) | [inline] |
assign the nul-terminated str to the current string
Definition at line 1315 of file MyGUI_UString.h.
UString& MyGUI::UString::assign | ( | const code_point * | str, |
size_type | num | ||
) | [inline] |
assign the first num characters of str to the current string
Definition at line 1321 of file MyGUI_UString.h.
UString& MyGUI::UString::assign | ( | const UString & | str, |
size_type | index, | ||
size_type | len | ||
) | [inline] |
assign len entries from str to the current string, starting at index
Definition at line 1327 of file MyGUI_UString.h.
UString& MyGUI::UString::assign | ( | size_type | num, |
const code_point & | ch | ||
) | [inline] |
assign num copies of ch to the current string
Definition at line 1333 of file MyGUI_UString.h.
UString& MyGUI::UString::assign | ( | const std::wstring & | wstr | ) | [inline] |
assign wstr to the current string (wstr is treated as a UTF-16 stream)
Definition at line 1339 of file MyGUI_UString.h.
UString& MyGUI::UString::assign | ( | const wchar_t * | w_str | ) | [inline] |
assign w_str to the current string
Definition at line 1367 of file MyGUI_UString.h.
UString& MyGUI::UString::assign | ( | const wchar_t * | w_str, |
size_type | num | ||
) | [inline] |
assign the first num characters of w_str to the current string
Definition at line 1374 of file MyGUI_UString.h.
UString& MyGUI::UString::assign | ( | const std::string & | str | ) | [inline] |
assign str to the current string (str is treated as a UTF-8 stream)
Definition at line 1382 of file MyGUI_UString.h.
UString& MyGUI::UString::assign | ( | const char * | c_str | ) | [inline] |
assign c_str to the current string (c_str is treated as a UTF-8 stream)
Definition at line 1417 of file MyGUI_UString.h.
UString& MyGUI::UString::assign | ( | const char * | c_str, |
size_type | num | ||
) | [inline] |
assign the first num characters of c_str to the current string (c_str is treated as a UTF-8 stream)
Definition at line 1423 of file MyGUI_UString.h.
const utf32string& MyGUI::UString::asUTF32 | ( | ) | const [inline] |
returns the current string in UTF-32 form within a utf32string
Definition at line 1132 of file MyGUI_UString.h.
const unicode_char* MyGUI::UString::asUTF32_c_str | ( | ) | const [inline] |
returns the current string in UTF-32 form as a nul-terminated unicode_char array
Definition at line 1138 of file MyGUI_UString.h.
const std::string& MyGUI::UString::asUTF8 | ( | ) | const [inline] |
returns the current string in UTF-8 form within a std::string
Definition at line 1120 of file MyGUI_UString.h.
const char* MyGUI::UString::asUTF8_c_str | ( | ) | const [inline] |
returns the current string in UTF-8 form as a nul-terminated char array
Definition at line 1126 of file MyGUI_UString.h.
const std::wstring& MyGUI::UString::asWStr | ( | ) | const [inline] |
returns the current string in the native form of std::wstring
Definition at line 1144 of file MyGUI_UString.h.
const wchar_t* MyGUI::UString::asWStr_c_str | ( | ) | const [inline] |
returns the current string in the native form of a nul-terminated wchar_t array
Definition at line 1150 of file MyGUI_UString.h.
code_point& MyGUI::UString::at | ( | size_type | loc | ) | [inline] |
returns a reference to the element in the string at index loc
Definition at line 1162 of file MyGUI_UString.h.
const code_point& MyGUI::UString::at | ( | size_type | loc | ) | const [inline] |
returns a reference to the element in the string at index loc
Definition at line 1167 of file MyGUI_UString.h.
iterator MyGUI::UString::begin | ( | ) | [inline] |
returns an iterator to the first element of the string
Definition at line 1233 of file MyGUI_UString.h.
const_iterator MyGUI::UString::begin | ( | ) | const [inline] |
returns an iterator to the first element of the string
Definition at line 1241 of file MyGUI_UString.h.
const code_point* MyGUI::UString::c_str | ( | ) | const [inline] |
returns a pointer to the first character in the current string
Definition at line 1044 of file MyGUI_UString.h.
size_type MyGUI::UString::capacity | ( | ) | const [inline] |
returns the number of elements that the string can hold before it will need to allocate more space
Definition at line 1054 of file MyGUI_UString.h.
void MyGUI::UString::clear | ( | ) | [inline] |
deletes all of the elements in the string
Definition at line 1059 of file MyGUI_UString.h.
int MyGUI::UString::compare | ( | const UString & | str | ) | const [inline] |
compare str to the current string
Definition at line 1736 of file MyGUI_UString.h.
int MyGUI::UString::compare | ( | const code_point * | str | ) | const [inline] |
compare str to the current string
Definition at line 1741 of file MyGUI_UString.h.
int MyGUI::UString::compare | ( | size_type | index, |
size_type | length, | ||
const UString & | str | ||
) | const [inline] |
compare str to a substring of the current string, starting at index for length characters
Definition at line 1746 of file MyGUI_UString.h.
int MyGUI::UString::compare | ( | size_type | index, |
size_type | length, | ||
const UString & | str, | ||
size_type | index2, | ||
size_type | length2 | ||
) | const [inline] |
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 1751 of file MyGUI_UString.h.
int MyGUI::UString::compare | ( | size_type | index, |
size_type | length, | ||
const code_point * | str, | ||
size_type | length2 | ||
) | const [inline] |
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 1756 of file MyGUI_UString.h.
int MyGUI::UString::compare | ( | size_type | index, |
size_type | length, | ||
const wchar_t * | w_str, | ||
size_type | length2 | ||
) | const [inline] |
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
Definition at line 1762 of file MyGUI_UString.h.
int MyGUI::UString::compare | ( | size_type | index, |
size_type | length, | ||
const char * | c_str, | ||
size_type | length2 | ||
) | const [inline] |
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 1769 of file MyGUI_UString.h.
const code_point* MyGUI::UString::data | ( | ) | const [inline] |
returns a pointer to the first character in the current string
Definition at line 1049 of file MyGUI_UString.h.
bool MyGUI::UString::empty | ( | ) | const [inline] |
returns true
if the string has no elements, false
otherwise
Definition at line 1039 of file MyGUI_UString.h.
iterator MyGUI::UString::end | ( | ) | [inline] |
returns an iterator just past the end of the string
Definition at line 1249 of file MyGUI_UString.h.
const_iterator MyGUI::UString::end | ( | ) | const [inline] |
returns an iterator just past the end of the string
Definition at line 1257 of file MyGUI_UString.h.
iterator MyGUI::UString::erase | ( | iterator | loc | ) | [inline] |
removes the code point pointed to by loc, returning an iterator to the next character
Definition at line 1657 of file MyGUI_UString.h.
iterator MyGUI::UString::erase | ( | iterator | start, |
iterator | end | ||
) | [inline] |
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 1665 of file MyGUI_UString.h.
UString& MyGUI::UString::erase | ( | size_type | index = 0 , |
size_type | num = npos |
||
) | [inline] |
removes num code points from the current string, starting at index
Definition at line 1673 of file MyGUI_UString.h.
size_type MyGUI::UString::find | ( | const UString & | str, |
size_type | index = 0 |
||
) | const [inline] |
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 1782 of file MyGUI_UString.h.
size_type MyGUI::UString::find | ( | const code_point * | cp_str, |
size_type | index, | ||
size_type | length | ||
) | const [inline] |
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 1788 of file MyGUI_UString.h.
size_type MyGUI::UString::find | ( | const char * | c_str, |
size_type | index, | ||
size_type | length | ||
) | const [inline] |
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 1795 of file MyGUI_UString.h.
size_type MyGUI::UString::find | ( | const wchar_t * | w_str, |
size_type | index, | ||
size_type | length | ||
) | const [inline] |
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 1803 of file MyGUI_UString.h.
size_type MyGUI::UString::find | ( | char | ch, |
size_type | index = 0 |
||
) | const [inline] |
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 1811 of file MyGUI_UString.h.
size_type MyGUI::UString::find | ( | code_point | ch, |
size_type | index = 0 |
||
) | const [inline] |
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 1817 of file MyGUI_UString.h.
size_type MyGUI::UString::find | ( | wchar_t | ch, |
size_type | index = 0 |
||
) | const [inline] |
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 1824 of file MyGUI_UString.h.
size_type MyGUI::UString::find | ( | unicode_char | ch, |
size_type | index = 0 |
||
) | const [inline] |
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 1831 of file MyGUI_UString.h.
size_type MyGUI::UString::find_first_not_of | ( | const UString & | str, |
size_type | index = 0 , |
||
size_type | num = npos |
||
) | const [inline] |
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 1935 of file MyGUI_UString.h.
size_type MyGUI::UString::find_first_not_of | ( | code_point | ch, |
size_type | index = 0 |
||
) | const [inline] |
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 1949 of file MyGUI_UString.h.
size_type MyGUI::UString::find_first_not_of | ( | char | ch, |
size_type | index = 0 |
||
) | const [inline] |
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 1956 of file MyGUI_UString.h.
size_type MyGUI::UString::find_first_not_of | ( | wchar_t | ch, |
size_type | index = 0 |
||
) | const [inline] |
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 1962 of file MyGUI_UString.h.
size_type MyGUI::UString::find_first_not_of | ( | unicode_char | ch, |
size_type | index = 0 |
||
) | const [inline] |
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 1968 of file MyGUI_UString.h.
size_type MyGUI::UString::find_first_of | ( | const UString & | str, |
size_type | index = 0 , |
||
size_type | num = npos |
||
) | const [inline] |
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 1894 of file MyGUI_UString.h.
size_type MyGUI::UString::find_first_of | ( | code_point | ch, |
size_type | index = 0 |
||
) | const [inline] |
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 1908 of file MyGUI_UString.h.
size_type MyGUI::UString::find_first_of | ( | char | ch, |
size_type | index = 0 |
||
) | const [inline] |
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 1915 of file MyGUI_UString.h.
size_type MyGUI::UString::find_first_of | ( | wchar_t | ch, |
size_type | index = 0 |
||
) | const [inline] |
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 1921 of file MyGUI_UString.h.
size_type MyGUI::UString::find_first_of | ( | unicode_char | ch, |
size_type | index = 0 |
||
) | const [inline] |
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 1927 of file MyGUI_UString.h.
size_type MyGUI::UString::find_last_not_of | ( | const UString & | str, |
size_type | index = npos , |
||
size_type | num = npos |
||
) | const [inline] |
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 2026 of file MyGUI_UString.h.
size_type MyGUI::UString::find_last_not_of | ( | code_point | ch, |
size_type | index = npos |
||
) | const [inline] |
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 2049 of file MyGUI_UString.h.
size_type MyGUI::UString::find_last_not_of | ( | char | ch, |
size_type | index = npos |
||
) | const [inline] |
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 2056 of file MyGUI_UString.h.
size_type MyGUI::UString::find_last_not_of | ( | wchar_t | ch, |
size_type | index = npos |
||
) | const [inline] |
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 2062 of file MyGUI_UString.h.
size_type MyGUI::UString::find_last_not_of | ( | unicode_char | ch, |
size_type | index = npos |
||
) | const [inline] |
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 2068 of file MyGUI_UString.h.
size_type MyGUI::UString::find_last_of | ( | const UString & | str, |
size_type | index = npos , |
||
size_type | num = npos |
||
) | const [inline] |
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 1976 of file MyGUI_UString.h.
size_type MyGUI::UString::find_last_of | ( | code_point | 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 1999 of file MyGUI_UString.h.
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 2006 of file MyGUI_UString.h.
size_type MyGUI::UString::find_last_of | ( | wchar_t | 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 2012 of file MyGUI_UString.h.
size_type MyGUI::UString::find_last_of | ( | unicode_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 2018 of file MyGUI_UString.h.
unicode_char MyGUI::UString::getChar | ( | size_type | loc | ) | const [inline] |
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 1176 of file MyGUI_UString.h.
iterator MyGUI::UString::insert | ( | iterator | i, |
const code_point & | ch | ||
) | [inline] |
inserts ch before the code point denoted by i
Definition at line 1525 of file MyGUI_UString.h.
UString& MyGUI::UString::insert | ( | size_type | index, |
const UString & | str | ||
) | [inline] |
inserts str into the current string, at location index
Definition at line 1533 of file MyGUI_UString.h.
UString& MyGUI::UString::insert | ( | size_type | index, |
const code_point * | str | ||
) | [inline] |
inserts str into the current string, at location index
Definition at line 1539 of file MyGUI_UString.h.
UString& MyGUI::UString::insert | ( | size_type | index1, |
const UString & | str, | ||
size_type | index2, | ||
size_type | num | ||
) | [inline] |
inserts a substring of str (starting at index2 and num code points long) into the current string, at location index1
Definition at line 1545 of file MyGUI_UString.h.
void MyGUI::UString::insert | ( | iterator | i, |
iterator | start, | ||
iterator | end | ||
) | [inline] |
inserts the code points denoted by start and end into the current string, before the code point specified by i
Definition at line 1551 of file MyGUI_UString.h.
UString& MyGUI::UString::insert | ( | size_type | index, |
const code_point * | str, | ||
size_type | num | ||
) | [inline] |
inserts num code points of str into the current string, at location index
Definition at line 1556 of file MyGUI_UString.h.
UString& MyGUI::UString::insert | ( | size_type | index, |
const wchar_t * | w_str, | ||
size_type | num | ||
) | [inline] |
inserts num code points of str into the current string, at location index
Definition at line 1563 of file MyGUI_UString.h.
UString& MyGUI::UString::insert | ( | size_type | index, |
const char * | c_str, | ||
size_type | num | ||
) | [inline] |
inserts num code points of str into the current string, at location index
Definition at line 1571 of file MyGUI_UString.h.
UString& MyGUI::UString::insert | ( | size_type | index, |
size_type | num, | ||
code_point | ch | ||
) | [inline] |
inserts num copies of ch into the current string, at location index
Definition at line 1578 of file MyGUI_UString.h.
UString& MyGUI::UString::insert | ( | size_type | index, |
size_type | num, | ||
wchar_t | ch | ||
) | [inline] |
inserts num copies of ch into the current string, at location index
Definition at line 1585 of file MyGUI_UString.h.
UString& MyGUI::UString::insert | ( | size_type | index, |
size_type | num, | ||
char | ch | ||
) | [inline] |
inserts num copies of ch into the current string, at location index
Definition at line 1592 of file MyGUI_UString.h.
UString& MyGUI::UString::insert | ( | size_type | index, |
size_type | num, | ||
unicode_char | ch | ||
) | [inline] |
inserts num copies of ch into the current string, at location index
Definition at line 1598 of file MyGUI_UString.h.
void MyGUI::UString::insert | ( | iterator | i, |
size_type | num, | ||
const code_point & | ch | ||
) | [inline] |
inserts num copies of ch into the current string, before the code point denoted by i
Definition at line 1615 of file MyGUI_UString.h.
void MyGUI::UString::insert | ( | iterator | i, |
size_type | num, | ||
const wchar_t & | ch | ||
) | [inline] |
inserts num copies of ch into the current string, before the code point denoted by i
Definition at line 1621 of file MyGUI_UString.h.
void MyGUI::UString::insert | ( | iterator | i, |
size_type | num, | ||
const char & | ch | ||
) | [inline] |
inserts num copies of ch into the current string, before the code point denoted by i
Definition at line 1627 of file MyGUI_UString.h.
void MyGUI::UString::insert | ( | iterator | i, |
size_type | num, | ||
const unicode_char & | ch | ||
) | [inline] |
inserts num copies of ch into the current string, before the code point denoted by i
Definition at line 1632 of file MyGUI_UString.h.
bool MyGUI::UString::inString | ( | unicode_char | ch | ) | const [inline] |
returns true
if the given Unicode character ch is in this string
Definition at line 1103 of file MyGUI_UString.h.
size_type MyGUI::UString::length | ( | ) | const [inline] |
Returns the number of code points in the current string.
Definition at line 1001 of file MyGUI_UString.h.
size_type MyGUI::UString::length_Characters | ( | ) | const [inline] |
Returns the number of Unicode characters in the string.
Executes in linear time.
Definition at line 1007 of file MyGUI_UString.h.
size_type MyGUI::UString::max_size | ( | ) | const [inline] |
returns the maximum number of UTF-16 code points that the string can hold
Definition at line 1019 of file MyGUI_UString.h.
MyGUI::UString::operator std::string | ( | ) | const [inline] |
implicit cast to std::string
Definition at line 2158 of file MyGUI_UString.h.
MyGUI::UString::operator std::wstring | ( | ) | const [inline] |
implicit cast to std::wstring
Definition at line 2163 of file MyGUI_UString.h.
bool MyGUI::UString::operator!= | ( | const UString & | right | ) | const [inline] |
inequality operator
Definition at line 2106 of file MyGUI_UString.h.
bool MyGUI::UString::operator< | ( | const UString & | right | ) | const [inline] |
less than operator
Definition at line 2081 of file MyGUI_UString.h.
bool MyGUI::UString::operator<= | ( | const UString & | right | ) | const [inline] |
less than or equal operator
Definition at line 2086 of file MyGUI_UString.h.
assignment operator, implicitly casts all compatible types
Definition at line 2111 of file MyGUI_UString.h.
UString& MyGUI::UString::operator= | ( | code_point | ch | ) | [inline] |
assignment operator
Definition at line 2116 of file MyGUI_UString.h.
UString& MyGUI::UString::operator= | ( | char | ch | ) | [inline] |
assignment operator
Definition at line 2122 of file MyGUI_UString.h.
UString& MyGUI::UString::operator= | ( | wchar_t | ch | ) | [inline] |
assignment operator
Definition at line 2129 of file MyGUI_UString.h.
UString& MyGUI::UString::operator= | ( | unicode_char | ch | ) | [inline] |
assignment operator
Definition at line 2136 of file MyGUI_UString.h.
bool MyGUI::UString::operator== | ( | const UString & | right | ) | const [inline] |
equality operator
Definition at line 2101 of file MyGUI_UString.h.
bool MyGUI::UString::operator> | ( | const UString & | right | ) | const [inline] |
greater than operator
Definition at line 2091 of file MyGUI_UString.h.
bool MyGUI::UString::operator>= | ( | const UString & | right | ) | const [inline] |
greater than or equal operator
Definition at line 2096 of file MyGUI_UString.h.
code_point& MyGUI::UString::operator[] | ( | size_type | index | ) | [inline] |
code point dereference operator
Definition at line 2142 of file MyGUI_UString.h.
const code_point& MyGUI::UString::operator[] | ( | size_type | index | ) | const [inline] |
code point dereference operator
Definition at line 2147 of file MyGUI_UString.h.
void MyGUI::UString::push_back | ( | unicode_char | val | ) | [inline] |
appends val to the end of the string
Definition at line 1074 of file MyGUI_UString.h.
void MyGUI::UString::push_back | ( | wchar_t | val | ) | [inline] |
appends val to the end of the string
Definition at line 1083 of file MyGUI_UString.h.
void MyGUI::UString::push_back | ( | code_point | val | ) | [inline] |
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 1092 of file MyGUI_UString.h.
void MyGUI::UString::push_back | ( | char | val | ) | [inline] |
appends val to the end of the string
Limited to characters under the 127 value barrier.
Definition at line 1098 of file MyGUI_UString.h.
reverse_iterator MyGUI::UString::rbegin | ( | ) | [inline] |
returns a reverse iterator to the last element of the string
Definition at line 1265 of file MyGUI_UString.h.
const_reverse_iterator MyGUI::UString::rbegin | ( | ) | const [inline] |
returns a reverse iterator to the last element of the string
Definition at line 1273 of file MyGUI_UString.h.
reverse_iterator MyGUI::UString::rend | ( | ) | [inline] |
returns a reverse iterator just past the beginning of the string
Definition at line 1281 of file MyGUI_UString.h.
const_reverse_iterator MyGUI::UString::rend | ( | ) | const [inline] |
returns a reverse iterator just past the beginning of the string
Definition at line 1289 of file MyGUI_UString.h.
UString& MyGUI::UString::replace | ( | size_type | index1, |
size_type | num1, | ||
const UString & | str | ||
) | [inline] |
replaces up to num1 code points of the current string (starting at index1) with str
Definition at line 1688 of file MyGUI_UString.h.
UString& MyGUI::UString::replace | ( | size_type | index1, |
size_type | num1, | ||
const UString & | str, | ||
size_type | num2 | ||
) | [inline] |
replaces up to num1 code points of the current string (starting at index1) with up to num2 code points from str
Definition at line 1694 of file MyGUI_UString.h.
UString& MyGUI::UString::replace | ( | size_type | index1, |
size_type | num1, | ||
const UString & | str, | ||
size_type | index2, | ||
size_type | num2 | ||
) | [inline] |
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 1700 of file MyGUI_UString.h.
UString& MyGUI::UString::replace | ( | iterator | start, |
iterator | end, | ||
const UString & | str, | ||
size_type | num = npos |
||
) | [inline] |
replaces code points in the current string from start to end with num code points from str
Definition at line 1706 of file MyGUI_UString.h.
UString& MyGUI::UString::replace | ( | size_type | index, |
size_type | num1, | ||
size_type | num2, | ||
code_point | ch | ||
) | [inline] |
replaces up to num1 code points in the current string (beginning at index) with num2
copies of ch
Definition at line 1715 of file MyGUI_UString.h.
UString& MyGUI::UString::replace | ( | iterator | start, |
iterator | end, | ||
size_type | num, | ||
code_point | ch | ||
) | [inline] |
replaces the code points in the current string from start to end with num copies of ch
Definition at line 1721 of file MyGUI_UString.h.
void MyGUI::UString::reserve | ( | size_type | size | ) | [inline] |
sets the capacity of the string to at least size code points
Definition at line 1024 of file MyGUI_UString.h.
void MyGUI::UString::resize | ( | size_type | num, |
const code_point & | val = 0 |
||
) | [inline] |
changes the size of the string to size, filling in any new area with val
Definition at line 1029 of file MyGUI_UString.h.
size_type MyGUI::UString::rfind | ( | const UString & | str, |
size_type | index = 0 |
||
) | const [inline] |
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 1839 of file MyGUI_UString.h.
size_type MyGUI::UString::rfind | ( | const code_point * | cp_str, |
size_type | index, | ||
size_type | num | ||
) | const [inline] |
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 1844 of file MyGUI_UString.h.
size_type MyGUI::UString::rfind | ( | const char * | c_str, |
size_type | index, | ||
size_type | num | ||
) | const [inline] |
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 1850 of file MyGUI_UString.h.
size_type MyGUI::UString::rfind | ( | const wchar_t * | w_str, |
size_type | index, | ||
size_type | num | ||
) | const [inline] |
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 1857 of file MyGUI_UString.h.
size_type MyGUI::UString::rfind | ( | char | ch, |
size_type | index = 0 |
||
) | const [inline] |
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 1864 of file MyGUI_UString.h.
size_type MyGUI::UString::rfind | ( | code_point | ch, |
size_type | index | ||
) | const [inline] |
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 1869 of file MyGUI_UString.h.
size_type MyGUI::UString::rfind | ( | wchar_t | ch, |
size_type | index = 0 |
||
) | const [inline] |
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 1875 of file MyGUI_UString.h.
size_type MyGUI::UString::rfind | ( | unicode_char | ch, |
size_type | index = 0 |
||
) | const [inline] |
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 1881 of file MyGUI_UString.h.
int MyGUI::UString::setChar | ( | size_type | loc, |
unicode_char | ch | ||
) | [inline] |
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.
Definition at line 1200 of file MyGUI_UString.h.
size_type MyGUI::UString::size | ( | ) | const [inline] |
Returns the number of code points in the current string.
Definition at line 996 of file MyGUI_UString.h.
UString MyGUI::UString::substr | ( | size_type | index, |
size_type | num = npos |
||
) | const [inline] |
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 1065 of file MyGUI_UString.h.
void MyGUI::UString::swap | ( | UString & | from | ) | [inline] |
exchanges the elements of the current string with those of from
Definition at line 1034 of file MyGUI_UString.h.
string addition operator
Definition at line 2639 of file MyGUI_UString.h.
UString operator+ | ( | const UString & | s1, |
UString::code_point | c | ||
) | [related] |
string addition operator
Definition at line 2644 of file MyGUI_UString.h.
UString operator+ | ( | const UString & | s1, |
UString::unicode_char | c | ||
) | [related] |
string addition operator
Definition at line 2649 of file MyGUI_UString.h.
string addition operator
Definition at line 2654 of file MyGUI_UString.h.
string addition operator
Definition at line 2660 of file MyGUI_UString.h.
UString operator+ | ( | UString::code_point | c, |
const UString & | s2 | ||
) | [related] |
string addition operator
Definition at line 2666 of file MyGUI_UString.h.
UString operator+ | ( | UString::unicode_char | c, |
const UString & | s2 | ||
) | [related] |
string addition operator
Definition at line 2671 of file MyGUI_UString.h.
string addition operator
Definition at line 2676 of file MyGUI_UString.h.
string addition operator
Definition at line 2682 of file MyGUI_UString.h.
std::ostream & operator<< | ( | std::ostream & | os, |
const UString & | s | ||
) | [related] |
std::ostream write operator
Definition at line 2750 of file MyGUI_UString.h.
const size_type MyGUI::UString::npos = ~(size_t)0 [static] |
the usual constant representing: not found, no limit, etc
Definition at line 187 of file MyGUI_UString.h.