#include <unistr.h>
Public Types | |
| enum | EInvariant { kInvariant, kInvariant, kInvariant } |
| enum | EInvariant { kInvariant, kInvariant, kInvariant } |
| enum | EInvariant { kInvariant, kInvariant, kInvariant } |
Static Public Member Functions | |
| static UnicodeString | fromUTF8 (const StringPiece &utf8) |
| static UnicodeString | fromUTF32 (const UChar32 *utf32, int32_t length) |
| static UClassID U_EXPORT2 | getStaticClassID () |
| static UnicodeString | fromUTF8 (const StringPiece &utf8) |
| static UnicodeString | fromUTF32 (const UChar32 *utf32, int32_t length) |
| static UClassID U_EXPORT2 | getStaticClassID () |
| static UnicodeString | fromUTF8 (const StringPiece &utf8) |
| static UnicodeString | fromUTF32 (const UChar32 *utf32, int32_t length) |
| static UClassID U_EXPORT2 | getStaticClassID () |
Protected Member Functions | |
| virtual int32_t | getLength () const |
| virtual UChar | getCharAt (int32_t offset) const |
| virtual UChar32 | getChar32At (int32_t offset) const |
| virtual int32_t | getLength () const |
| virtual UChar | getCharAt (int32_t offset) const |
| virtual UChar32 | getChar32At (int32_t offset) const |
| virtual int32_t | getLength () const |
| virtual UChar | getCharAt (int32_t offset) const |
| virtual UChar32 | getChar32At (int32_t offset) const |
 Protected Member Functions inherited from Replaceable | |
| Replaceable () | |
| Replaceable () | |
| Replaceable () | |
Friends | |
| class | StringThreadTest |
| class | UnicodeStringAppendable |
| union | StackBufferOrFields |
Detailed Description
UnicodeString is a string class that stores Unicode characters directly and provides similar functionality as the Java String and StringBuffer classes. It is a concrete implementation of the abstract class Replaceable (for transliteration).
The UnicodeString class is not suitable for subclassing.
For an overview of Unicode strings in C and C++ see the User Guide Strings chapter.
In ICU, a Unicode string consists of 16-bit Unicode code units. A Unicode character may be stored with either one code unit (the most common case) or with a matched pair of special code units ("surrogates"). The data type for code units is UChar. For single-character handling, a Unicode character code point is a value in the range 0..0x10ffff. ICU uses the UChar32 type for code points.
Indexes and offsets into and lengths of strings always count code units, not code points. This is the same as with multi-byte char* strings in traditional string handling. Operations on partial strings typically do not test for code point boundaries. If necessary, the user needs to take care of such boundaries by testing for the code unit values or by using functions like UnicodeString::getChar32Start() and UnicodeString::getChar32Limit() (or, in C, the equivalent macros U16_SET_CP_START() and U16_SET_CP_LIMIT(), see utf.h).
UnicodeString methods are more lenient with regard to input parameter values than other ICU APIs. In particular:
- If indexes are out of bounds for a UnicodeString object (<0 or >length()) then they are "pinned" to the nearest boundary.
- If primitive string pointer values (e.g., const UChar * or char *) for input strings are NULL, then those input string parameters are treated as if they pointed to an empty string. However, this is not the case for char * parameters for charset names or other IDs.
- Most UnicodeString methods do not take a UErrorCode parameter because there are usually very few opportunities for failure other than a shortage of memory, error codes in low-level C++ string methods would be inconvenient, and the error code as the last parameter (ICU convention) would prevent the use of default parameter values. Instead, such methods set the UnicodeString into a "bogus" state (see isBogus()) if an error occurs.
In string comparisons, two UnicodeString objects that are both "bogus" compare equal (to be transitive and prevent endless loops in sorting), and a "bogus" string compares less than any non-"bogus" one.
Const UnicodeString methods are thread-safe. Multiple threads can use const methods on the same UnicodeString object simultaneously, but non-const methods must not be called concurrently (in multiple threads) with any other (const or non-const) methods.
Similarly, const UnicodeString & parameters are thread-safe. One object may be passed in as such a parameter concurrently in multiple threads. This includes the const UnicodeString & parameters for copy construction, assignment, and cloning.
UnicodeString uses several storage methods. String contents can be stored inside the UnicodeString object itself, in an allocated and shared buffer, or in an outside buffer that is "aliased". Most of this is done transparently, but careful aliasing in particular provides significant performance improvements. Also, the internal buffer is accessible via special functions. For details see the User Guide Strings chapter.
- See also
- utf.h
- CharacterIterator ICU 2.0
Member Enumeration Documentation
◆ EInvariant [1/3]
Constant to be used in the UnicodeString(char *, int32_t, EInvariant) constructor which constructs a Unicode string from an invariant-character char * string. Use the macro US_INV instead of the full qualification for this value.
- See also
- US_INV ICU 3.2
| Enumerator | |
|---|---|
| kInvariant |
|
| kInvariant |
|
| kInvariant |
|
◆ EInvariant [2/3]
Constant to be used in the UnicodeString(char *, int32_t, EInvariant) constructor which constructs a Unicode string from an invariant-character char * string. Use the macro US_INV instead of the full qualification for this value.
- See also
- US_INV ICU 3.2
| Enumerator | |
|---|---|
| kInvariant |
|
| kInvariant |
|
| kInvariant |
|
◆ EInvariant [3/3]
Constant to be used in the UnicodeString(char *, int32_t, EInvariant) constructor which constructs a Unicode string from an invariant-character char * string. Use the macro US_INV instead of the full qualification for this value.
- See also
- US_INV ICU 3.2
| Enumerator | |
|---|---|
| kInvariant |
|
| kInvariant |
|
| kInvariant |
|
Constructor & Destructor Documentation
◆ UnicodeString() [1/51]
|
inline |
Construct an empty UnicodeString. ICU 2.0
◆ UnicodeString() [2/51]
Construct a UnicodeString with capacity to hold capacity UChars
- Parameters
-
capacity the number of UChars this UnicodeString should hold before a resize is necessary; if count is greater than 0 and count code points c take up more space than capacity, then capacity is adjusted accordingly. c is used to initially fill the string count specifies how many code points c are to be written in the string ICU 2.0
◆ UnicodeString() [3/51]
| UNISTR_FROM_CHAR_EXPLICIT UnicodeString::UnicodeString | ( | UChar | ch | ) |
Single UChar (code unit) constructor.
It is recommended to mark this constructor "explicit" by -DUNISTR_FROM_CHAR_EXPLICIT=explicit on the compiler command line or similar.
- Parameters
-
ch the character to place in the UnicodeString ICU 2.0
◆ UnicodeString() [4/51]
| UNISTR_FROM_CHAR_EXPLICIT UnicodeString::UnicodeString | ( | UChar32 | ch | ) |
Single UChar32 (code point) constructor.
It is recommended to mark this constructor "explicit" by -DUNISTR_FROM_CHAR_EXPLICIT=explicit on the compiler command line or similar.
- Parameters
-
ch the character to place in the UnicodeString ICU 2.0
◆ UnicodeString() [5/51]
| UNISTR_FROM_STRING_EXPLICIT UnicodeString::UnicodeString | ( | const UChar * | text | ) |
UChar* constructor.
It is recommended to mark this constructor "explicit" by -DUNISTR_FROM_STRING_EXPLICIT=explicit on the compiler command line or similar.
- Parameters
-
text The characters to place in the UnicodeString. textmust be NULL (U+0000) terminated. ICU 2.0
◆ UnicodeString() [6/51]
UChar* constructor.
- Parameters
-
text The characters to place in the UnicodeString. textLength The number of Unicode characters in textto copy. ICU 2.0
◆ UnicodeString() [7/51]
Readonly-aliasing UChar* constructor. The text will be used for the UnicodeString object, but it will not be released when the UnicodeString is destroyed. This has copy-on-write semantics: When the string is modified, then the buffer is first copied into newly allocated memory. The aliased buffer is never modified.
In an assignment to another UnicodeString, when using the copy constructor or the assignment operator, the text will be copied. When using fastCopyFrom(), the text will be aliased again, so that both strings then alias the same readonly-text.
- Parameters
-
isTerminated specifies if textisNUL-terminated. This must be true iftextLength==-1.text The characters to alias for the UnicodeString. textLength The number of Unicode characters in textto alias. If -1, then this constructor will determine the length by callingu_strlen(). ICU 2.0
◆ UnicodeString() [8/51]
Writable-aliasing UChar* constructor. The text will be used for the UnicodeString object, but it will not be released when the UnicodeString is destroyed. This has write-through semantics: For as long as the capacity of the buffer is sufficient, write operations will directly affect the buffer. When more capacity is necessary, then a new buffer will be allocated and the contents copied as with regularly constructed strings. In an assignment to another UnicodeString, the buffer will be copied. The extract(UChar *dst) function detects whether the dst pointer is the same as the string buffer itself and will in this case not copy the contents.
- Parameters
-
buffer The characters to alias for the UnicodeString. buffLength The number of Unicode characters in bufferto alias.buffCapacity The size of bufferin UChars. ICU 2.0
◆ UnicodeString() [9/51]
| UNISTR_FROM_STRING_EXPLICIT UnicodeString::UnicodeString | ( | const char * | codepageData | ) |
char* constructor. Uses the default converter (and thus depends on the ICU conversion code) unless U_CHARSET_IS_UTF8 is set to 1.
For ASCII (really "invariant character") strings it is more efficient to use the constructor that takes a US_INV (for its enum EInvariant). For ASCII (invariant-character) string literals, see UNICODE_STRING and UNICODE_STRING_SIMPLE.
It is recommended to mark this constructor "explicit" by -DUNISTR_FROM_STRING_EXPLICIT=explicit on the compiler command line or similar.
- Parameters
-
codepageData an array of bytes, null-terminated, in the platform's default codepage. ICU 2.0
- See also
- UNICODE_STRING
- UNICODE_STRING_SIMPLE
◆ UnicodeString() [10/51]
| UnicodeString::UnicodeString | ( | const char * | codepageData, |
| int32_t | dataLength | ||
| ) |
char* constructor. Uses the default converter (and thus depends on the ICU conversion code) unless U_CHARSET_IS_UTF8 is set to 1.
- Parameters
-
codepageData an array of bytes in the platform's default codepage. dataLength The number of bytes in codepageData. ICU 2.0
◆ UnicodeString() [11/51]
| UnicodeString::UnicodeString | ( | const char * | codepageData, |
| const char * | codepage | ||
| ) |
char* constructor.
- Parameters
-
codepageData an array of bytes, null-terminated codepage the encoding of codepageData. The special value 0 forcodepageindicates that the text is in the platform's default codepage.
If codepage is an empty string (""), then a simple conversion is performed on the codepage-invariant subset ("invariant characters") of the platform encoding. See utypes.h. Recommendation: For invariant-character strings use the constructor UnicodeString(const char *src, int32_t length, enum EInvariant inv) because it avoids object code dependencies of UnicodeString on the conversion code.
ICU 2.0
◆ UnicodeString() [12/51]
| UnicodeString::UnicodeString | ( | const char * | codepageData, |
| int32_t | dataLength, | ||
| const char * | codepage | ||
| ) |
char* constructor.
- Parameters
-
codepageData an array of bytes. dataLength The number of bytes in codepageData.codepage the encoding of codepageData. The special value 0 forcodepageindicates that the text is in the platform's default codepage. Ifcodepageis an empty string (""), then a simple conversion is performed on the codepage-invariant subset ("invariant characters") of the platform encoding. See utypes.h. Recommendation: For invariant-character strings use the constructor UnicodeString(const char *src, int32_t length, enum EInvariant inv) because it avoids object code dependencies of UnicodeString on the conversion code.
ICU 2.0
◆ UnicodeString() [13/51]
| UnicodeString::UnicodeString | ( | const char * | src, |
| int32_t | srcLength, | ||
| UConverter * | cnv, | ||
| UErrorCode & | errorCode | ||
| ) |
char * / UConverter constructor. This constructor uses an existing UConverter object to convert the codepage string to Unicode and construct a UnicodeString from that.
The converter is reset at first. If the error code indicates a failure before this constructor is called, or if an error occurs during conversion or construction, then the string will be bogus.
This function avoids the overhead of opening and closing a converter if multiple strings are constructed.
- Parameters
-
src input codepage string srcLength length of the input string, can be -1 for NUL-terminated strings cnv converter object (ucnv_resetToUnicode() will be called), can be NULL for the default converter errorCode normal ICU error code ICU 2.0
◆ UnicodeString() [14/51]
| UnicodeString::UnicodeString | ( | const char * | src, |
| int32_t | length, | ||
| enum EInvariant | inv | ||
| ) |
Constructs a Unicode string from an invariant-character char * string. About invariant characters see utypes.h. This constructor has no runtime dependency on conversion code and is therefore recommended over ones taking a charset name string (where the empty string "" indicates invariant-character conversion).
Use the macro US_INV as the third, signature-distinguishing parameter.
For example:
- Parameters
-
src String using only invariant characters. length Length of src, or -1 if NUL-terminated. inv Signature-distinguishing paramater, use US_INV.
- See also
- US_INV ICU 3.2
◆ UnicodeString() [15/51]
| UnicodeString::UnicodeString | ( | const UnicodeString & | that | ) |
Copy constructor.
- Parameters
-
that The UnicodeString object to copy. ICU 2.0
◆ UnicodeString() [16/51]
| UnicodeString::UnicodeString | ( | const UnicodeString & | src, |
| int32_t | srcStart | ||
| ) |
'Substring' constructor from tail of source string.
- Parameters
-
src The UnicodeString object to copy. srcStart The offset into srcat which to start copying. ICU 2.2
◆ UnicodeString() [17/51]
| UnicodeString::UnicodeString | ( | const UnicodeString & | src, |
| int32_t | srcStart, | ||
| int32_t | srcLength | ||
| ) |
'Substring' constructor from subrange of source string.
- Parameters
-
src The UnicodeString object to copy. srcStart The offset into srcat which to start copying.srcLength The number of characters from srcto copy. ICU 2.2
◆ ~UnicodeString() [1/3]
|
virtual |
Destructor. ICU 2.0
◆ UnicodeString() [18/51]
|
inline |
Construct an empty UnicodeString. ICU 2.0
◆ UnicodeString() [19/51]
Construct a UnicodeString with capacity to hold capacity UChars
- Parameters
-
capacity the number of UChars this UnicodeString should hold before a resize is necessary; if count is greater than 0 and count code points c take up more space than capacity, then capacity is adjusted accordingly. c is used to initially fill the string count specifies how many code points c are to be written in the string ICU 2.0
◆ UnicodeString() [20/51]
| UNISTR_FROM_CHAR_EXPLICIT UnicodeString::UnicodeString | ( | UChar | ch | ) |
Single UChar (code unit) constructor.
It is recommended to mark this constructor "explicit" by -DUNISTR_FROM_CHAR_EXPLICIT=explicit on the compiler command line or similar.
- Parameters
-
ch the character to place in the UnicodeString ICU 2.0
◆ UnicodeString() [21/51]
| UNISTR_FROM_CHAR_EXPLICIT UnicodeString::UnicodeString | ( | UChar32 | ch | ) |
Single UChar32 (code point) constructor.
It is recommended to mark this constructor "explicit" by -DUNISTR_FROM_CHAR_EXPLICIT=explicit on the compiler command line or similar.
- Parameters
-
ch the character to place in the UnicodeString ICU 2.0
◆ UnicodeString() [22/51]
| UNISTR_FROM_STRING_EXPLICIT UnicodeString::UnicodeString | ( | const UChar * | text | ) |
UChar* constructor.
It is recommended to mark this constructor "explicit" by -DUNISTR_FROM_STRING_EXPLICIT=explicit on the compiler command line or similar.
- Parameters
-
text The characters to place in the UnicodeString. textmust be NULL (U+0000) terminated. ICU 2.0
◆ UnicodeString() [23/51]
UChar* constructor.
- Parameters
-
text The characters to place in the UnicodeString. textLength The number of Unicode characters in textto copy. ICU 2.0
◆ UnicodeString() [24/51]
Readonly-aliasing UChar* constructor. The text will be used for the UnicodeString object, but it will not be released when the UnicodeString is destroyed. This has copy-on-write semantics: When the string is modified, then the buffer is first copied into newly allocated memory. The aliased buffer is never modified.
In an assignment to another UnicodeString, when using the copy constructor or the assignment operator, the text will be copied. When using fastCopyFrom(), the text will be aliased again, so that both strings then alias the same readonly-text.
- Parameters
-
isTerminated specifies if textisNUL-terminated. This must be true iftextLength==-1.text The characters to alias for the UnicodeString. textLength The number of Unicode characters in textto alias. If -1, then this constructor will determine the length by callingu_strlen(). ICU 2.0
◆ UnicodeString() [25/51]
Writable-aliasing UChar* constructor. The text will be used for the UnicodeString object, but it will not be released when the UnicodeString is destroyed. This has write-through semantics: For as long as the capacity of the buffer is sufficient, write operations will directly affect the buffer. When more capacity is necessary, then a new buffer will be allocated and the contents copied as with regularly constructed strings. In an assignment to another UnicodeString, the buffer will be copied. The extract(UChar *dst) function detects whether the dst pointer is the same as the string buffer itself and will in this case not copy the contents.
- Parameters
-
buffer The characters to alias for the UnicodeString. buffLength The number of Unicode characters in bufferto alias.buffCapacity The size of bufferin UChars. ICU 2.0
◆ UnicodeString() [26/51]
| UNISTR_FROM_STRING_EXPLICIT UnicodeString::UnicodeString | ( | const char * | codepageData | ) |
char* constructor. Uses the default converter (and thus depends on the ICU conversion code) unless U_CHARSET_IS_UTF8 is set to 1.
For ASCII (really "invariant character") strings it is more efficient to use the constructor that takes a US_INV (for its enum EInvariant). For ASCII (invariant-character) string literals, see UNICODE_STRING and UNICODE_STRING_SIMPLE.
It is recommended to mark this constructor "explicit" by -DUNISTR_FROM_STRING_EXPLICIT=explicit on the compiler command line or similar.
- Parameters
-
codepageData an array of bytes, null-terminated, in the platform's default codepage. ICU 2.0
- See also
- UNICODE_STRING
- UNICODE_STRING_SIMPLE
◆ UnicodeString() [27/51]
| UnicodeString::UnicodeString | ( | const char * | codepageData, |
| int32_t | dataLength | ||
| ) |
char* constructor. Uses the default converter (and thus depends on the ICU conversion code) unless U_CHARSET_IS_UTF8 is set to 1.
- Parameters
-
codepageData an array of bytes in the platform's default codepage. dataLength The number of bytes in codepageData. ICU 2.0
◆ UnicodeString() [28/51]
| UnicodeString::UnicodeString | ( | const char * | codepageData, |
| const char * | codepage | ||
| ) |
char* constructor.
- Parameters
-
codepageData an array of bytes, null-terminated codepage the encoding of codepageData. The special value 0 forcodepageindicates that the text is in the platform's default codepage.
If codepage is an empty string (""), then a simple conversion is performed on the codepage-invariant subset ("invariant characters") of the platform encoding. See utypes.h. Recommendation: For invariant-character strings use the constructor UnicodeString(const char *src, int32_t length, enum EInvariant inv) because it avoids object code dependencies of UnicodeString on the conversion code.
ICU 2.0
◆ UnicodeString() [29/51]
| UnicodeString::UnicodeString | ( | const char * | codepageData, |
| int32_t | dataLength, | ||
| const char * | codepage | ||
| ) |
char* constructor.
- Parameters
-
codepageData an array of bytes. dataLength The number of bytes in codepageData.codepage the encoding of codepageData. The special value 0 forcodepageindicates that the text is in the platform's default codepage. Ifcodepageis an empty string (""), then a simple conversion is performed on the codepage-invariant subset ("invariant characters") of the platform encoding. See utypes.h. Recommendation: For invariant-character strings use the constructor UnicodeString(const char *src, int32_t length, enum EInvariant inv) because it avoids object code dependencies of UnicodeString on the conversion code.
ICU 2.0
◆ UnicodeString() [30/51]
| UnicodeString::UnicodeString | ( | const char * | src, |
| int32_t | srcLength, | ||
| UConverter * | cnv, | ||
| UErrorCode & | errorCode | ||
| ) |
char * / UConverter constructor. This constructor uses an existing UConverter object to convert the codepage string to Unicode and construct a UnicodeString from that.
The converter is reset at first. If the error code indicates a failure before this constructor is called, or if an error occurs during conversion or construction, then the string will be bogus.
This function avoids the overhead of opening and closing a converter if multiple strings are constructed.
- Parameters
-
src input codepage string srcLength length of the input string, can be -1 for NUL-terminated strings cnv converter object (ucnv_resetToUnicode() will be called), can be NULL for the default converter errorCode normal ICU error code ICU 2.0
◆ UnicodeString() [31/51]
| UnicodeString::UnicodeString | ( | const char * | src, |
| int32_t | length, | ||
| enum EInvariant | inv | ||
| ) |
Constructs a Unicode string from an invariant-character char * string. About invariant characters see utypes.h. This constructor has no runtime dependency on conversion code and is therefore recommended over ones taking a charset name string (where the empty string "" indicates invariant-character conversion).
Use the macro US_INV as the third, signature-distinguishing parameter.
For example:
- Parameters
-
src String using only invariant characters. length Length of src, or -1 if NUL-terminated. inv Signature-distinguishing paramater, use US_INV.
- See also
- US_INV ICU 3.2
◆ UnicodeString() [32/51]
| UnicodeString::UnicodeString | ( | const UnicodeString & | that | ) |
Copy constructor.
- Parameters
-
that The UnicodeString object to copy. ICU 2.0
◆ UnicodeString() [33/51]
| UnicodeString::UnicodeString | ( | const UnicodeString & | src, |
| int32_t | srcStart | ||
| ) |
'Substring' constructor from tail of source string.
- Parameters
-
src The UnicodeString object to copy. srcStart The offset into srcat which to start copying. ICU 2.2
◆ UnicodeString() [34/51]
| UnicodeString::UnicodeString | ( | const UnicodeString & | src, |
| int32_t | srcStart, | ||
| int32_t | srcLength | ||
| ) |
'Substring' constructor from subrange of source string.
- Parameters
-
src The UnicodeString object to copy. srcStart The offset into srcat which to start copying.srcLength The number of characters from srcto copy. ICU 2.2
◆ ~UnicodeString() [2/3]
|
virtual |
Destructor. ICU 2.0
◆ UnicodeString() [35/51]
|
inline |
Construct an empty UnicodeString. ICU 2.0
◆ UnicodeString() [36/51]
Construct a UnicodeString with capacity to hold capacity UChars
- Parameters
-
capacity the number of UChars this UnicodeString should hold before a resize is necessary; if count is greater than 0 and count code points c take up more space than capacity, then capacity is adjusted accordingly. c is used to initially fill the string count specifies how many code points c are to be written in the string ICU 2.0
◆ UnicodeString() [37/51]
| UNISTR_FROM_CHAR_EXPLICIT UnicodeString::UnicodeString | ( | UChar | ch | ) |
Single UChar (code unit) constructor.
It is recommended to mark this constructor "explicit" by -DUNISTR_FROM_CHAR_EXPLICIT=explicit on the compiler command line or similar.
- Parameters
-
ch the character to place in the UnicodeString ICU 2.0
◆ UnicodeString() [38/51]
| UNISTR_FROM_CHAR_EXPLICIT UnicodeString::UnicodeString | ( | UChar32 | ch | ) |
Single UChar32 (code point) constructor.
It is recommended to mark this constructor "explicit" by -DUNISTR_FROM_CHAR_EXPLICIT=explicit on the compiler command line or similar.
- Parameters
-
ch the character to place in the UnicodeString ICU 2.0
◆ UnicodeString() [39/51]
| UNISTR_FROM_STRING_EXPLICIT UnicodeString::UnicodeString | ( | const UChar * | text | ) |
UChar* constructor.
It is recommended to mark this constructor "explicit" by -DUNISTR_FROM_STRING_EXPLICIT=explicit on the compiler command line or similar.
- Parameters
-
text The characters to place in the UnicodeString. textmust be NULL (U+0000) terminated. ICU 2.0
◆ UnicodeString() [40/51]
UChar* constructor.
- Parameters
-
text The characters to place in the UnicodeString. textLength The number of Unicode characters in textto copy. ICU 2.0
◆ UnicodeString() [41/51]
Readonly-aliasing UChar* constructor. The text will be used for the UnicodeString object, but it will not be released when the UnicodeString is destroyed. This has copy-on-write semantics: When the string is modified, then the buffer is first copied into newly allocated memory. The aliased buffer is never modified.
In an assignment to another UnicodeString, when using the copy constructor or the assignment operator, the text will be copied. When using fastCopyFrom(), the text will be aliased again, so that both strings then alias the same readonly-text.
- Parameters
-
isTerminated specifies if textisNUL-terminated. This must be true iftextLength==-1.text The characters to alias for the UnicodeString. textLength The number of Unicode characters in textto alias. If -1, then this constructor will determine the length by callingu_strlen(). ICU 2.0
◆ UnicodeString() [42/51]
Writable-aliasing UChar* constructor. The text will be used for the UnicodeString object, but it will not be released when the UnicodeString is destroyed. This has write-through semantics: For as long as the capacity of the buffer is sufficient, write operations will directly affect the buffer. When more capacity is necessary, then a new buffer will be allocated and the contents copied as with regularly constructed strings. In an assignment to another UnicodeString, the buffer will be copied. The extract(UChar *dst) function detects whether the dst pointer is the same as the string buffer itself and will in this case not copy the contents.
- Parameters
-
buffer The characters to alias for the UnicodeString. buffLength The number of Unicode characters in bufferto alias.buffCapacity The size of bufferin UChars. ICU 2.0
◆ UnicodeString() [43/51]
| UNISTR_FROM_STRING_EXPLICIT UnicodeString::UnicodeString | ( | const char * | codepageData | ) |
char* constructor. Uses the default converter (and thus depends on the ICU conversion code) unless U_CHARSET_IS_UTF8 is set to 1.
For ASCII (really "invariant character") strings it is more efficient to use the constructor that takes a US_INV (for its enum EInvariant). For ASCII (invariant-character) string literals, see UNICODE_STRING and UNICODE_STRING_SIMPLE.
It is recommended to mark this constructor "explicit" by -DUNISTR_FROM_STRING_EXPLICIT=explicit on the compiler command line or similar.
- Parameters
-
codepageData an array of bytes, null-terminated, in the platform's default codepage. ICU 2.0
- See also
- UNICODE_STRING
- UNICODE_STRING_SIMPLE
◆ UnicodeString() [44/51]
| UnicodeString::UnicodeString | ( | const char * | codepageData, |
| int32_t | dataLength | ||
| ) |
char* constructor. Uses the default converter (and thus depends on the ICU conversion code) unless U_CHARSET_IS_UTF8 is set to 1.
- Parameters
-
codepageData an array of bytes in the platform's default codepage. dataLength The number of bytes in codepageData. ICU 2.0
◆ UnicodeString() [45/51]
| UnicodeString::UnicodeString | ( | const char * | codepageData, |
| const char * | codepage | ||
| ) |
char* constructor.
- Parameters
-
codepageData an array of bytes, null-terminated codepage the encoding of codepageData. The special value 0 forcodepageindicates that the text is in the platform's default codepage.
If codepage is an empty string (""), then a simple conversion is performed on the codepage-invariant subset ("invariant characters") of the platform encoding. See utypes.h. Recommendation: For invariant-character strings use the constructor UnicodeString(const char *src, int32_t length, enum EInvariant inv) because it avoids object code dependencies of UnicodeString on the conversion code.
ICU 2.0
◆ UnicodeString() [46/51]
| UnicodeString::UnicodeString | ( | const char * | codepageData, |
| int32_t | dataLength, | ||
| const char * | codepage | ||
| ) |
char* constructor.
- Parameters
-
codepageData an array of bytes. dataLength The number of bytes in codepageData.codepage the encoding of codepageData. The special value 0 forcodepageindicates that the text is in the platform's default codepage. Ifcodepageis an empty string (""), then a simple conversion is performed on the codepage-invariant subset ("invariant characters") of the platform encoding. See utypes.h. Recommendation: For invariant-character strings use the constructor UnicodeString(const char *src, int32_t length, enum EInvariant inv) because it avoids object code dependencies of UnicodeString on the conversion code.
ICU 2.0
◆ UnicodeString() [47/51]
| UnicodeString::UnicodeString | ( | const char * | src, |
| int32_t | srcLength, | ||
| UConverter * | cnv, | ||
| UErrorCode & | errorCode | ||
| ) |
char * / UConverter constructor. This constructor uses an existing UConverter object to convert the codepage string to Unicode and construct a UnicodeString from that.
The converter is reset at first. If the error code indicates a failure before this constructor is called, or if an error occurs during conversion or construction, then the string will be bogus.
This function avoids the overhead of opening and closing a converter if multiple strings are constructed.
- Parameters
-
src input codepage string srcLength length of the input string, can be -1 for NUL-terminated strings cnv converter object (ucnv_resetToUnicode() will be called), can be NULL for the default converter errorCode normal ICU error code ICU 2.0
◆ UnicodeString() [48/51]
| UnicodeString::UnicodeString | ( | const char * | src, |
| int32_t | length, | ||
| enum EInvariant | inv | ||
| ) |
Constructs a Unicode string from an invariant-character char * string. About invariant characters see utypes.h. This constructor has no runtime dependency on conversion code and is therefore recommended over ones taking a charset name string (where the empty string "" indicates invariant-character conversion).
Use the macro US_INV as the third, signature-distinguishing parameter.
For example:
- Parameters
-
src String using only invariant characters. length Length of src, or -1 if NUL-terminated. inv Signature-distinguishing paramater, use US_INV.
- See also
- US_INV ICU 3.2
◆ UnicodeString() [49/51]
| UnicodeString::UnicodeString | ( | const UnicodeString & | that | ) |
Copy constructor.
- Parameters
-
that The UnicodeString object to copy. ICU 2.0
◆ UnicodeString() [50/51]
| UnicodeString::UnicodeString | ( | const UnicodeString & | src, |
| int32_t | srcStart | ||
| ) |
'Substring' constructor from tail of source string.
- Parameters
-
src The UnicodeString object to copy. srcStart The offset into srcat which to start copying. ICU 2.2
◆ UnicodeString() [51/51]
| UnicodeString::UnicodeString | ( | const UnicodeString & | src, |
| int32_t | srcStart, | ||
| int32_t | srcLength | ||
| ) |
'Substring' constructor from subrange of source string.
- Parameters
-
src The UnicodeString object to copy. srcStart The offset into srcat which to start copying.srcLength The number of characters from srcto copy. ICU 2.2
◆ ~UnicodeString() [3/3]
|
virtual |
Destructor. ICU 2.0
Member Function Documentation
◆ append() [1/18]
|
inline |
Append the characters in srcText in the range [srcStart, srcStart + srcLength) to the UnicodeString object at offset start. srcText is not modified.
- Parameters
-
srcText the source for the new characters srcStart the offset into srcTextwhere new characters will be obtainedsrcLength the number of characters in srcTextin the append string
- Returns
- a reference to this ICU 2.0
◆ append() [2/18]
|
inline |
Append the characters in srcText in the range [srcStart, srcStart + srcLength) to the UnicodeString object at offset start. srcText is not modified.
- Parameters
-
srcText the source for the new characters srcStart the offset into srcTextwhere new characters will be obtainedsrcLength the number of characters in srcTextin the append string
- Returns
- a reference to this ICU 2.0
◆ append() [3/18]
|
inline |
Append the characters in srcText in the range [srcStart, srcStart + srcLength) to the UnicodeString object at offset start. srcText is not modified.
- Parameters
-
srcText the source for the new characters srcStart the offset into srcTextwhere new characters will be obtainedsrcLength the number of characters in srcTextin the append string
- Returns
- a reference to this ICU 2.0
◆ append() [4/18]
|
inline |
Append the characters in srcText to the UnicodeString object. srcText is not modified.
- Parameters
-
srcText the source for the new characters
- Returns
- a reference to this ICU 2.0
◆ append() [5/18]
|
inline |
Append the characters in srcText to the UnicodeString object. srcText is not modified.
- Parameters
-
srcText the source for the new characters
- Returns
- a reference to this ICU 2.0
◆ append() [6/18]
|
inline |
Append the characters in srcText to the UnicodeString object. srcText is not modified.
- Parameters
-
srcText the source for the new characters
- Returns
- a reference to this ICU 2.0
◆ append() [7/18]
|
inline |
Append the characters in srcChars in the range [srcStart, srcStart + srcLength) to the UnicodeString object at offset start. srcChars is not modified.
- Parameters
-
srcChars the source for the new characters srcStart the offset into srcCharswhere new characters will be obtainedsrcLength the number of characters in srcCharsin the append string; can be -1 ifsrcCharsis NUL-terminated
- Returns
- a reference to this ICU 2.0
◆ append() [8/18]
|
inline |
Append the characters in srcChars in the range [srcStart, srcStart + srcLength) to the UnicodeString object at offset start. srcChars is not modified.
- Parameters
-
srcChars the source for the new characters srcStart the offset into srcCharswhere new characters will be obtainedsrcLength the number of characters in srcCharsin the append string; can be -1 ifsrcCharsis NUL-terminated
- Returns
- a reference to this ICU 2.0
◆ append() [9/18]
|
inline |
Append the characters in srcChars in the range [srcStart, srcStart + srcLength) to the UnicodeString object at offset start. srcChars is not modified.
- Parameters
-
srcChars the source for the new characters srcStart the offset into srcCharswhere new characters will be obtainedsrcLength the number of characters in srcCharsin the append string; can be -1 ifsrcCharsis NUL-terminated
- Returns
- a reference to this ICU 2.0
◆ append() [10/18]
|
inline |
Append the characters in srcChars to the UnicodeString object at offset start. srcChars is not modified.
- Parameters
-
srcChars the source for the new characters srcLength the number of Unicode characters in srcChars; can be -1 ifsrcCharsis NUL-terminated
- Returns
- a reference to this ICU 2.0
◆ append() [11/18]
|
inline |
Append the characters in srcChars to the UnicodeString object at offset start. srcChars is not modified.
- Parameters
-
srcChars the source for the new characters srcLength the number of Unicode characters in srcChars; can be -1 ifsrcCharsis NUL-terminated
- Returns
- a reference to this ICU 2.0
◆ append() [12/18]
|
inline |
Append the characters in srcChars to the UnicodeString object at offset start. srcChars is not modified.
- Parameters
-
srcChars the source for the new characters srcLength the number of Unicode characters in srcChars; can be -1 ifsrcCharsis NUL-terminated
- Returns
- a reference to this ICU 2.0
◆ append() [13/18]
|
inline |
Append the code unit srcChar to the UnicodeString object.
- Parameters
-
srcChar the code unit to append
- Returns
- a reference to this ICU 2.0
◆ append() [14/18]
|
inline |
Append the code unit srcChar to the UnicodeString object.
- Parameters
-
srcChar the code unit to append
- Returns
- a reference to this ICU 2.0
◆ append() [15/18]
|
inline |
Append the code unit srcChar to the UnicodeString object.
- Parameters
-
srcChar the code unit to append
- Returns
- a reference to this ICU 2.0
◆ append() [16/18]
| UnicodeString& UnicodeString::append | ( | UChar32 | srcChar | ) |
Append the code point srcChar to the UnicodeString object.
- Parameters
-
srcChar the code point to append
- Returns
- a reference to this ICU 2.0
◆ append() [17/18]
| UnicodeString& UnicodeString::append | ( | UChar32 | srcChar | ) |
Append the code point srcChar to the UnicodeString object.
- Parameters
-
srcChar the code point to append
- Returns
- a reference to this ICU 2.0
◆ append() [18/18]
| UnicodeString& UnicodeString::append | ( | UChar32 | srcChar | ) |
Append the code point srcChar to the UnicodeString object.
- Parameters
-
srcChar the code point to append
- Returns
- a reference to this ICU 2.0
◆ caseCompare() [1/18]
|
inline |
Compare two strings case-insensitively using full case folding. This is equivalent to this->foldCase(options).compare(text.foldCase(options)).
- Parameters
-
text Another string to compare this one to. options A bit set of options: - U_FOLD_CASE_DEFAULT or 0 is used for default options: Comparison in code unit order with default case folding.
- U_COMPARE_CODE_POINT_ORDER Set to choose code point order instead of code unit order (see u_strCompare for details).
- U_FOLD_CASE_EXCLUDE_SPECIAL_I
- Returns
- A negative, zero, or positive integer indicating the comparison result. ICU 2.0
◆ caseCompare() [2/18]
|
inline |
Compare two strings case-insensitively using full case folding. This is equivalent to this->foldCase(options).compare(text.foldCase(options)).
- Parameters
-
text Another string to compare this one to. options A bit set of options: - U_FOLD_CASE_DEFAULT or 0 is used for default options: Comparison in code unit order with default case folding.
- U_COMPARE_CODE_POINT_ORDER Set to choose code point order instead of code unit order (see u_strCompare for details).
- U_FOLD_CASE_EXCLUDE_SPECIAL_I
- Returns
- A negative, zero, or positive integer indicating the comparison result. ICU 2.0
◆ caseCompare() [3/18]
|
inline |
Compare two strings case-insensitively using full case folding. This is equivalent to this->foldCase(options).compare(text.foldCase(options)).
- Parameters
-
text Another string to compare this one to. options A bit set of options: - U_FOLD_CASE_DEFAULT or 0 is used for default options: Comparison in code unit order with default case folding.
- U_COMPARE_CODE_POINT_ORDER Set to choose code point order instead of code unit order (see u_strCompare for details).
- U_FOLD_CASE_EXCLUDE_SPECIAL_I
- Returns
- A negative, zero, or positive integer indicating the comparison result. ICU 2.0
◆ caseCompare() [4/18]
|
inline |
Compare two strings case-insensitively using full case folding. This is equivalent to this->foldCase(options).compare(srcText.foldCase(options)).
- Parameters
-
start The start offset in this string at which the compare operation begins. length The number of code units from this string to compare. srcText Another string to compare this one to. options A bit set of options: - U_FOLD_CASE_DEFAULT or 0 is used for default options: Comparison in code unit order with default case folding.
- U_COMPARE_CODE_POINT_ORDER Set to choose code point order instead of code unit order (see u_strCompare for details).
- U_FOLD_CASE_EXCLUDE_SPECIAL_I
- Returns
- A negative, zero, or positive integer indicating the comparison result. ICU 2.0
◆ caseCompare() [5/18]
|
inline |
Compare two strings case-insensitively using full case folding. This is equivalent to this->foldCase(options).compare(srcText.foldCase(options)).
- Parameters
-
start The start offset in this string at which the compare operation begins. length The number of code units from this string to compare. srcText Another string to compare this one to. options A bit set of options: - U_FOLD_CASE_DEFAULT or 0 is used for default options: Comparison in code unit order with default case folding.
- U_COMPARE_CODE_POINT_ORDER Set to choose code point order instead of code unit order (see u_strCompare for details).
- U_FOLD_CASE_EXCLUDE_SPECIAL_I
- Returns
- A negative, zero, or positive integer indicating the comparison result. ICU 2.0
◆ caseCompare() [6/18]
|
inline |
Compare two strings case-insensitively using full case folding. This is equivalent to this->foldCase(options).compare(srcText.foldCase(options)).
- Parameters
-
start The start offset in this string at which the compare operation begins. length The number of code units from this string to compare. srcText Another string to compare this one to. options A bit set of options: - U_FOLD_CASE_DEFAULT or 0 is used for default options: Comparison in code unit order with default case folding.
- U_COMPARE_CODE_POINT_ORDER Set to choose code point order instead of code unit order (see u_strCompare for details).
- U_FOLD_CASE_EXCLUDE_SPECIAL_I
- Returns
- A negative, zero, or positive integer indicating the comparison result. ICU 2.0
◆ caseCompare() [7/18]
|
inline |
Compare two strings case-insensitively using full case folding. This is equivalent to this->foldCase(options).compare(srcText.foldCase(options)).
- Parameters
-
start The start offset in this string at which the compare operation begins. length The number of code units from this string to compare. srcText Another string to compare this one to. srcStart The start offset in that string at which the compare operation begins. srcLength The number of code units from that string to compare. options A bit set of options: - U_FOLD_CASE_DEFAULT or 0 is used for default options: Comparison in code unit order with default case folding.
- U_COMPARE_CODE_POINT_ORDER Set to choose code point order instead of code unit order (see u_strCompare for details).
- U_FOLD_CASE_EXCLUDE_SPECIAL_I
- Returns
- A negative, zero, or positive integer indicating the comparison result. ICU 2.0
◆ caseCompare() [8/18]
|
inline |
Compare two strings case-insensitively using full case folding. This is equivalent to this->foldCase(options).compare(srcText.foldCase(options)).
- Parameters
-
start The start offset in this string at which the compare operation begins. length The number of code units from this string to compare. srcText Another string to compare this one to. srcStart The start offset in that string at which the compare operation begins. srcLength The number of code units from that string to compare. options A bit set of options: - U_FOLD_CASE_DEFAULT or 0 is used for default options: Comparison in code unit order with default case folding.
- U_COMPARE_CODE_POINT_ORDER Set to choose code point order instead of code unit order (see u_strCompare for details).
- U_FOLD_CASE_EXCLUDE_SPECIAL_I
- Returns
- A negative, zero, or positive integer indicating the comparison result. ICU 2.0
◆ caseCompare() [9/18]
|
inline |
Compare two strings case-insensitively using full case folding. This is equivalent to this->foldCase(options).compare(srcText.foldCase(options)).
- Parameters
-
start The start offset in this string at which the compare operation begins. length The number of code units from this string to compare. srcText Another string to compare this one to. srcStart The start offset in that string at which the compare operation begins. srcLength The number of code units from that string to compare. options A bit set of options: - U_FOLD_CASE_DEFAULT or 0 is used for default options: Comparison in code unit order with default case folding.
- U_COMPARE_CODE_POINT_ORDER Set to choose code point order instead of code unit order (see u_strCompare for details).
- U_FOLD_CASE_EXCLUDE_SPECIAL_I
- Returns
- A negative, zero, or positive integer indicating the comparison result. ICU 2.0
◆ caseCompare() [10/18]
|
inline |
Compare two strings case-insensitively using full case folding. This is equivalent to this->foldCase(options).compare(srcChars.foldCase(options)).
- Parameters
-
srcChars A pointer to another string to compare this one to. srcLength The number of code units from that string to compare. options A bit set of options: - U_FOLD_CASE_DEFAULT or 0 is used for default options: Comparison in code unit order with default case folding.
- U_COMPARE_CODE_POINT_ORDER Set to choose code point order instead of code unit order (see u_strCompare for details).
- U_FOLD_CASE_EXCLUDE_SPECIAL_I
- Returns
- A negative, zero, or positive integer indicating the comparison result. ICU 2.0
◆ caseCompare() [11/18]
|
inline |
Compare two strings case-insensitively using full case folding. This is equivalent to this->foldCase(options).compare(srcChars.foldCase(options)).
- Parameters
-
srcChars A pointer to another string to compare this one to. srcLength The number of code units from that string to compare. options A bit set of options: - U_FOLD_CASE_DEFAULT or 0 is used for default options: Comparison in code unit order with default case folding.
- U_COMPARE_CODE_POINT_ORDER Set to choose code point order instead of code unit order (see u_strCompare for details).
- U_FOLD_CASE_EXCLUDE_SPECIAL_I
- Returns
- A negative, zero, or positive integer indicating the comparison result. ICU 2.0
◆ caseCompare() [12/18]
|
inline |
Compare two strings case-insensitively using full case folding. This is equivalent to this->foldCase(options).compare(srcChars.foldCase(options)).
- Parameters
-
srcChars A pointer to another string to compare this one to. srcLength The number of code units from that string to compare. options A bit set of options: - U_FOLD_CASE_DEFAULT or 0 is used for default options: Comparison in code unit order with default case folding.
- U_COMPARE_CODE_POINT_ORDER Set to choose code point order instead of code unit order (see u_strCompare for details).
- U_FOLD_CASE_EXCLUDE_SPECIAL_I
- Returns
- A negative, zero, or positive integer indicating the comparison result. ICU 2.0
◆ caseCompare() [13/18]
|
inline |
Compare two strings case-insensitively using full case folding. This is equivalent to this->foldCase(options).compare(srcChars.foldCase(options)).
- Parameters
-
start The start offset in this string at which the compare operation begins. length The number of code units from this string to compare. srcChars A pointer to another string to compare this one to. options A bit set of options: - U_FOLD_CASE_DEFAULT or 0 is used for default options: Comparison in code unit order with default case folding.
- U_COMPARE_CODE_POINT_ORDER Set to choose code point order instead of code unit order (see u_strCompare for details).
- U_FOLD_CASE_EXCLUDE_SPECIAL_I
- Returns
- A negative, zero, or positive integer indicating the comparison result. ICU 2.0
◆ caseCompare() [14/18]
|
inline |
Compare two strings case-insensitively using full case folding. This is equivalent to this->foldCase(options).compare(srcChars.foldCase(options)).
- Parameters
-
start The start offset in this string at which the compare operation begins. length The number of code units from this string to compare. srcChars A pointer to another string to compare this one to. options A bit set of options: - U_FOLD_CASE_DEFAULT or 0 is used for default options: Comparison in code unit order with default case folding.
- U_COMPARE_CODE_POINT_ORDER Set to choose code point order instead of code unit order (see u_strCompare for details).
- U_FOLD_CASE_EXCLUDE_SPECIAL_I
- Returns
- A negative, zero, or positive integer indicating the comparison result. ICU 2.0
◆ caseCompare() [15/18]
|
inline |
Compare two strings case-insensitively using full case folding. This is equivalent to this->foldCase(options).compare(srcChars.foldCase(options)).
- Parameters
-
start The start offset in this string at which the compare operation begins. length The number of code units from this string to compare. srcChars A pointer to another string to compare this one to. options A bit set of options: - U_FOLD_CASE_DEFAULT or 0 is used for default options: Comparison in code unit order with default case folding.
- U_COMPARE_CODE_POINT_ORDER Set to choose code point order instead of code unit order (see u_strCompare for details).
- U_FOLD_CASE_EXCLUDE_SPECIAL_I
- Returns
- A negative, zero, or positive integer indicating the comparison result. ICU 2.0
◆ caseCompare() [16/18]
|
inline |
Compare two strings case-insensitively using full case folding. This is equivalent to this->foldCase(options).compare(srcChars.foldCase(options)).
- Parameters
-
start The start offset in this string at which the compare operation begins. length The number of code units from this string to compare. srcChars A pointer to another string to compare this one to. srcStart The start offset in that string at which the compare operation begins. srcLength The number of code units from that string to compare. options A bit set of options: - U_FOLD_CASE_DEFAULT or 0 is used for default options: Comparison in code unit order with default case folding.
- U_COMPARE_CODE_POINT_ORDER Set to choose code point order instead of code unit order (see u_strCompare for details).
- U_FOLD_CASE_EXCLUDE_SPECIAL_I
- Returns
- A negative, zero, or positive integer indicating the comparison result. ICU 2.0
◆ caseCompare() [17/18]
|
inline |
Compare two strings case-insensitively using full case folding. This is equivalent to this->foldCase(options).compare(srcChars.foldCase(options)).
- Parameters
-
start The start offset in this string at which the compare operation begins. length The number of code units from this string to compare. srcChars A pointer to another string to compare this one to. srcStart The start offset in that string at which the compare operation begins. srcLength The number of code units from that string to compare. options A bit set of options: - U_FOLD_CASE_DEFAULT or 0 is used for default options: Comparison in code unit order with default case folding.
- U_COMPARE_CODE_POINT_ORDER Set to choose code point order instead of code unit order (see u_strCompare for details).
- U_FOLD_CASE_EXCLUDE_SPECIAL_I
- Returns
- A negative, zero, or positive integer indicating the comparison result. ICU 2.0
◆ caseCompare() [18/18]
|
inline |
Compare two strings case-insensitively using full case folding. This is equivalent to this->foldCase(options).compare(srcChars.foldCase(options)).
- Parameters
-
start The start offset in this string at which the compare operation begins. length The number of code units from this string to compare. srcChars A pointer to another string to compare this one to. srcStart The start offset in that string at which the compare operation begins. srcLength The number of code units from that string to compare. options A bit set of options: - U_FOLD_CASE_DEFAULT or 0 is used for default options: Comparison in code unit order with default case folding.
- U_COMPARE_CODE_POINT_ORDER Set to choose code point order instead of code unit order (see u_strCompare for details).
- U_FOLD_CASE_EXCLUDE_SPECIAL_I
- Returns
- A negative, zero, or positive integer indicating the comparison result. ICU 2.0
◆ caseCompareBetween() [1/3]
|
inline |
Compare two strings case-insensitively using full case folding. This is equivalent to this->foldCase(options).compareBetween(text.foldCase(options)).
- Parameters
-
start The start offset in this string at which the compare operation begins. limit The offset after the last code unit from this string to compare. srcText Another string to compare this one to. srcStart The start offset in that string at which the compare operation begins. srcLimit The offset after the last code unit from that string to compare. options A bit set of options: - U_FOLD_CASE_DEFAULT or 0 is used for default options: Comparison in code unit order with default case folding.
- U_COMPARE_CODE_POINT_ORDER Set to choose code point order instead of code unit order (see u_strCompare for details).
- U_FOLD_CASE_EXCLUDE_SPECIAL_I
- Returns
- A negative, zero, or positive integer indicating the comparison result. ICU 2.0
◆ caseCompareBetween() [2/3]
|
inline |
Compare two strings case-insensitively using full case folding. This is equivalent to this->foldCase(options).compareBetween(text.foldCase(options)).
- Parameters
-
start The start offset in this string at which the compare operation begins. limit The offset after the last code unit from this string to compare. srcText Another string to compare this one to. srcStart The start offset in that string at which the compare operation begins. srcLimit The offset after the last code unit from that string to compare. options A bit set of options: - U_FOLD_CASE_DEFAULT or 0 is used for default options: Comparison in code unit order with default case folding.
- U_COMPARE_CODE_POINT_ORDER Set to choose code point order instead of code unit order (see u_strCompare for details).
- U_FOLD_CASE_EXCLUDE_SPECIAL_I
- Returns
- A negative, zero, or positive integer indicating the comparison result. ICU 2.0
◆ caseCompareBetween() [3/3]
|
inline |
Compare two strings case-insensitively using full case folding. This is equivalent to this->foldCase(options).compareBetween(text.foldCase(options)).
- Parameters
-
start The start offset in this string at which the compare operation begins. limit The offset after the last code unit from this string to compare. srcText Another string to compare this one to. srcStart The start offset in that string at which the compare operation begins. srcLimit The offset after the last code unit from that string to compare. options A bit set of options: - U_FOLD_CASE_DEFAULT or 0 is used for default options: Comparison in code unit order with default case folding.
- U_COMPARE_CODE_POINT_ORDER Set to choose code point order instead of code unit order (see u_strCompare for details).
- U_FOLD_CASE_EXCLUDE_SPECIAL_I
- Returns
- A negative, zero, or positive integer indicating the comparison result. ICU 2.0
◆ char32At() [1/3]
Return the code point that contains the code unit at offset offset. If the offset is not valid (0..length()-1) then U+ffff is returned.
- Parameters
-
offset a valid offset into the text that indicates the text offset of any of the code units that will be assembled into a code point (21-bit value) and returned
- Returns
- the code point of text at
offsetor 0xffff if the offset is not valid for this string ICU 2.0
◆ char32At() [2/3]
Return the code point that contains the code unit at offset offset. If the offset is not valid (0..length()-1) then U+ffff is returned.
- Parameters
-
offset a valid offset into the text that indicates the text offset of any of the code units that will be assembled into a code point (21-bit value) and returned
- Returns
- the code point of text at
offsetor 0xffff if the offset is not valid for this string ICU 2.0
◆ char32At() [3/3]
Return the code point that contains the code unit at offset offset. If the offset is not valid (0..length()-1) then U+ffff is returned.
- Parameters
-
offset a valid offset into the text that indicates the text offset of any of the code units that will be assembled into a code point (21-bit value) and returned
- Returns
- the code point of text at
offsetor 0xffff if the offset is not valid for this string ICU 2.0
◆ charAt() [1/3]
Return the code unit at offset offset. If the offset is not valid (0..length()-1) then U+ffff is returned.
- Parameters
-
offset a valid offset into the text
- Returns
- the code unit at offset
offsetor 0xffff if the offset is not valid for this string ICU 2.0
◆ charAt() [2/3]
Return the code unit at offset offset. If the offset is not valid (0..length()-1) then U+ffff is returned.
- Parameters
-
offset a valid offset into the text
- Returns
- the code unit at offset
offsetor 0xffff if the offset is not valid for this string ICU 2.0
◆ charAt() [3/3]
Return the code unit at offset offset. If the offset is not valid (0..length()-1) then U+ffff is returned.
- Parameters
-
offset a valid offset into the text
- Returns
- the code unit at offset
offsetor 0xffff if the offset is not valid for this string ICU 2.0
◆ clone() [1/3]
|
virtual |
Clone this object, an instance of a subclass of Replaceable. Clones can be used concurrently in multiple threads. If a subclass does not implement clone(), or if an error occurs, then NULL is returned. The clone functions in all subclasses return a pointer to a Replaceable because some compilers do not support covariant (same-as-this) return types; cast to the appropriate subclass if necessary. The caller must delete the clone.
- Returns
- a clone of this object
- See also
- Replaceable::clone
- getDynamicClassID ICU 2.6
Reimplemented from Replaceable.
◆ clone() [2/3]
|
virtual |
Clone this object, an instance of a subclass of Replaceable. Clones can be used concurrently in multiple threads. If a subclass does not implement clone(), or if an error occurs, then NULL is returned. The clone functions in all subclasses return a pointer to a Replaceable because some compilers do not support covariant (same-as-this) return types; cast to the appropriate subclass if necessary. The caller must delete the clone.
- Returns
- a clone of this object
- See also
- Replaceable::clone
- getDynamicClassID ICU 2.6
Reimplemented from Replaceable.
◆ clone() [3/3]
|
virtual |
Clone this object, an instance of a subclass of Replaceable. Clones can be used concurrently in multiple threads. If a subclass does not implement clone(), or if an error occurs, then NULL is returned. The clone functions in all subclasses return a pointer to a Replaceable because some compilers do not support covariant (same-as-this) return types; cast to the appropriate subclass if necessary. The caller must delete the clone.
- Returns
- a clone of this object
- See also
- Replaceable::clone
- getDynamicClassID ICU 2.6
Reimplemented from Replaceable.
◆ compare() [1/18]
|
inline |
Compare the characters bitwise in this UnicodeString to the characters in text.
- Parameters
-
text The UnicodeString to compare to this one.
- Returns
- The result of bitwise character comparison: 0 if this contains the same characters as
text, -1 if the characters in this are bitwise less than the characters intext, +1 if the characters in this are bitwise greater than the characters intext. ICU 2.0
◆ compare() [2/18]
|
inline |
Compare the characters bitwise in this UnicodeString to the characters in text.
- Parameters
-
text The UnicodeString to compare to this one.
- Returns
- The result of bitwise character comparison: 0 if this contains the same characters as
text, -1 if the characters in this are bitwise less than the characters intext, +1 if the characters in this are bitwise greater than the characters intext. ICU 2.0
◆ compare() [3/18]
|
inline |
Compare the characters bitwise in this UnicodeString to the characters in text.
- Parameters
-
text The UnicodeString to compare to this one.
- Returns
- The result of bitwise character comparison: 0 if this contains the same characters as
text, -1 if the characters in this are bitwise less than the characters intext, +1 if the characters in this are bitwise greater than the characters intext. ICU 2.0
◆ compare() [4/18]
|
inline |
Compare the characters bitwise in the range [start, start + length) with the characters in the entire string text. (The parameters "start" and "length" are not applied to the other text "text".)
- Parameters
-
start the offset at which the compare operation begins length the number of characters of text to compare. text the other text to be compared against this string.
- Returns
- The result of bitwise character comparison: 0 if this contains the same characters as
text, -1 if the characters in this are bitwise less than the characters intext, +1 if the characters in this are bitwise greater than the characters intext. ICU 2.0
◆ compare() [5/18]
|
inline |
Compare the characters bitwise in the range [start, start + length) with the characters in the entire string text. (The parameters "start" and "length" are not applied to the other text "text".)
- Parameters
-
start the offset at which the compare operation begins length the number of characters of text to compare. text the other text to be compared against this string.
- Returns
- The result of bitwise character comparison: 0 if this contains the same characters as
text, -1 if the characters in this are bitwise less than the characters intext, +1 if the characters in this are bitwise greater than the characters intext. ICU 2.0
◆ compare() [6/18]
|
inline |
Compare the characters bitwise in the range [start, start + length) with the characters in the entire string text. (The parameters "start" and "length" are not applied to the other text "text".)
- Parameters
-
start the offset at which the compare operation begins length the number of characters of text to compare. text the other text to be compared against this string.
- Returns
- The result of bitwise character comparison: 0 if this contains the same characters as
text, -1 if the characters in this are bitwise less than the characters intext, +1 if the characters in this are bitwise greater than the characters intext. ICU 2.0
◆ compare() [7/18]
|
inline |
Compare the characters bitwise in the range [start, start + length) with the characters in srcText in the range [srcStart, srcStart + srcLength).
- Parameters
-
start the offset at which the compare operation begins length the number of characters in this to compare. srcText the text to be compared srcStart the offset into srcTextto start comparisonsrcLength the number of characters in srcto compare
- Returns
- The result of bitwise character comparison: 0 if this contains the same characters as
srcText, -1 if the characters in this are bitwise less than the characters insrcText, +1 if the characters in this are bitwise greater than the characters insrcText. ICU 2.0
◆ compare() [8/18]
|
inline |
Compare the characters bitwise in the range [start, start + length) with the characters in srcText in the range [srcStart, srcStart + srcLength).
- Parameters
-
start the offset at which the compare operation begins length the number of characters in this to compare. srcText the text to be compared srcStart the offset into srcTextto start comparisonsrcLength the number of characters in srcto compare
- Returns
- The result of bitwise character comparison: 0 if this contains the same characters as
srcText, -1 if the characters in this are bitwise less than the characters insrcText, +1 if the characters in this are bitwise greater than the characters insrcText. ICU 2.0
◆ compare() [9/18]
|
inline |
Compare the characters bitwise in the range [start, start + length) with the characters in srcText in the range [srcStart, srcStart + srcLength).
- Parameters
-
start the offset at which the compare operation begins length the number of characters in this to compare. srcText the text to be compared srcStart the offset into srcTextto start comparisonsrcLength the number of characters in srcto compare
- Returns
- The result of bitwise character comparison: 0 if this contains the same characters as
srcText, -1 if the characters in this are bitwise less than the characters insrcText, +1 if the characters in this are bitwise greater than the characters insrcText. ICU 2.0
◆ compare() [10/18]
Compare the characters bitwise in this UnicodeString with the first srcLength characters in srcChars.
- Parameters
-
srcChars The characters to compare to this UnicodeString. srcLength the number of characters in srcCharsto compare
- Returns
- The result of bitwise character comparison: 0 if this contains the same characters as
srcChars, -1 if the characters in this are bitwise less than the characters insrcChars, +1 if the characters in this are bitwise greater than the characters insrcChars. ICU 2.0
◆ compare() [11/18]
Compare the characters bitwise in this UnicodeString with the first srcLength characters in srcChars.
- Parameters
-
srcChars The characters to compare to this UnicodeString. srcLength the number of characters in srcCharsto compare
- Returns
- The result of bitwise character comparison: 0 if this contains the same characters as
srcChars, -1 if the characters in this are bitwise less than the characters insrcChars, +1 if the characters in this are bitwise greater than the characters insrcChars. ICU 2.0
◆ compare() [12/18]
Compare the characters bitwise in this UnicodeString with the first srcLength characters in srcChars.
- Parameters
-
srcChars The characters to compare to this UnicodeString. srcLength the number of characters in srcCharsto compare
- Returns
- The result of bitwise character comparison: 0 if this contains the same characters as
srcChars, -1 if the characters in this are bitwise less than the characters insrcChars, +1 if the characters in this are bitwise greater than the characters insrcChars. ICU 2.0
◆ compare() [13/18]
|
inline |
Compare the characters bitwise in the range [start, start + length) with the first length characters in srcChars
- Parameters
-
start the offset at which the compare operation begins length the number of characters to compare. srcChars the characters to be compared
- Returns
- The result of bitwise character comparison: 0 if this contains the same characters as
srcChars, -1 if the characters in this are bitwise less than the characters insrcChars, +1 if the characters in this are bitwise greater than the characters insrcChars. ICU 2.0
◆ compare() [14/18]
|
inline |
Compare the characters bitwise in the range [start, start + length) with the first length characters in srcChars
- Parameters
-
start the offset at which the compare operation begins length the number of characters to compare. srcChars the characters to be compared
- Returns
- The result of bitwise character comparison: 0 if this contains the same characters as
srcChars, -1 if the characters in this are bitwise less than the characters insrcChars, +1 if the characters in this are bitwise greater than the characters insrcChars. ICU 2.0
◆ compare() [15/18]
|
inline |
Compare the characters bitwise in the range [start, start + length) with the first length characters in srcChars
- Parameters
-
start the offset at which the compare operation begins length the number of characters to compare. srcChars the characters to be compared
- Returns
- The result of bitwise character comparison: 0 if this contains the same characters as
srcChars, -1 if the characters in this are bitwise less than the characters insrcChars, +1 if the characters in this are bitwise greater than the characters insrcChars. ICU 2.0
◆ compare() [16/18]
|
inline |
Compare the characters bitwise in the range [start, start + length) with the characters in srcChars in the range [srcStart, srcStart + srcLength).
- Parameters
-
start the offset at which the compare operation begins length the number of characters in this to compare srcChars the characters to be compared srcStart the offset into srcCharsto start comparisonsrcLength the number of characters in srcCharsto compare
- Returns
- The result of bitwise character comparison: 0 if this contains the same characters as
srcChars, -1 if the characters in this are bitwise less than the characters insrcChars, +1 if the characters in this are bitwise greater than the characters insrcChars. ICU 2.0
◆ compare() [17/18]
|
inline |
Compare the characters bitwise in the range [start, start + length) with the characters in srcChars in the range [srcStart, srcStart + srcLength).
- Parameters
-
start the offset at which the compare operation begins length the number of characters in this to compare srcChars the characters to be compared srcStart the offset into srcCharsto start comparisonsrcLength the number of characters in srcCharsto compare
- Returns
- The result of bitwise character comparison: 0 if this contains the same characters as
srcChars, -1 if the characters in this are bitwise less than the characters insrcChars, +1 if the characters in this are bitwise greater than the characters insrcChars. ICU 2.0
◆ compare() [18/18]
|
inline |
Compare the characters bitwise in the range [start, start + length) with the characters in srcChars in the range [srcStart, srcStart + srcLength).
- Parameters
-
start the offset at which the compare operation begins length the number of characters in this to compare srcChars the characters to be compared srcStart the offset into srcCharsto start comparisonsrcLength the number of characters in srcCharsto compare
- Returns
- The result of bitwise character comparison: 0 if this contains the same characters as
srcChars, -1 if the characters in this are bitwise less than the characters insrcChars, +1 if the characters in this are bitwise greater than the characters insrcChars. ICU 2.0
◆ compareBetween() [1/3]
|
inline |
Compare the characters bitwise in the range [start, limit) with the characters in srcText in the range [srcStart, srcLimit).
- Parameters
-
start the offset at which the compare operation begins limit the offset immediately following the compare operation srcText the text to be compared srcStart the offset into srcTextto start comparisonsrcLimit the offset into srcTextto limit comparison
- Returns
- The result of bitwise character comparison: 0 if this contains the same characters as
srcText, -1 if the characters in this are bitwise less than the characters insrcText, +1 if the characters in this are bitwise greater than the characters insrcText. ICU 2.0
◆ compareBetween() [2/3]
|
inline |
Compare the characters bitwise in the range [start, limit) with the characters in srcText in the range [srcStart, srcLimit).
- Parameters
-
start the offset at which the compare operation begins limit the offset immediately following the compare operation srcText the text to be compared srcStart the offset into srcTextto start comparisonsrcLimit the offset into srcTextto limit comparison
- Returns
- The result of bitwise character comparison: 0 if this contains the same characters as
srcText, -1 if the characters in this are bitwise less than the characters insrcText, +1 if the characters in this are bitwise greater than the characters insrcText. ICU 2.0
◆ compareBetween() [3/3]
|
inline |
Compare the characters bitwise in the range [start, limit) with the characters in srcText in the range [srcStart, srcLimit).
- Parameters
-
start the offset at which the compare operation begins limit the offset immediately following the compare operation srcText the text to be compared srcStart the offset into srcTextto start comparisonsrcLimit the offset into srcTextto limit comparison
- Returns
- The result of bitwise character comparison: 0 if this contains the same characters as
srcText, -1 if the characters in this are bitwise less than the characters insrcText, +1 if the characters in this are bitwise greater than the characters insrcText. ICU 2.0
◆ compareCodePointOrder() [1/18]
|
inline |
Compare two Unicode strings in code point order. The result may be different from the results of compare(), operator<, etc. if supplementary characters are present:
In UTF-16, supplementary characters (with code points U+10000 and above) are stored with pairs of surrogate code units. These have values from 0xd800 to 0xdfff, which means that they compare as less than some other BMP characters like U+feff. This function compares Unicode strings in code point order. If either of the UTF-16 strings is malformed (i.e., it contains unpaired surrogates), then the result is not defined.
- Parameters
-
text Another string to compare this one to.
- Returns
- a negative/zero/positive integer corresponding to whether this string is less than/equal to/greater than the second one in code point order ICU 2.0
◆ compareCodePointOrder() [2/18]
|
inline |
Compare two Unicode strings in code point order. The result may be different from the results of compare(), operator<, etc. if supplementary characters are present:
In UTF-16, supplementary characters (with code points U+10000 and above) are stored with pairs of surrogate code units. These have values from 0xd800 to 0xdfff, which means that they compare as less than some other BMP characters like U+feff. This function compares Unicode strings in code point order. If either of the UTF-16 strings is malformed (i.e., it contains unpaired surrogates), then the result is not defined.
- Parameters
-
text Another string to compare this one to.
- Returns
- a negative/zero/positive integer corresponding to whether this string is less than/equal to/greater than the second one in code point order ICU 2.0
◆ compareCodePointOrder() [3/18]
|
inline |
Compare two Unicode strings in code point order. The result may be different from the results of compare(), operator<, etc. if supplementary characters are present:
In UTF-16, supplementary characters (with code points U+10000 and above) are stored with pairs of surrogate code units. These have values from 0xd800 to 0xdfff, which means that they compare as less than some other BMP characters like U+feff. This function compares Unicode strings in code point order. If either of the UTF-16 strings is malformed (i.e., it contains unpaired surrogates), then the result is not defined.
- Parameters
-
text Another string to compare this one to.
- Returns
- a negative/zero/positive integer corresponding to whether this string is less than/equal to/greater than the second one in code point order ICU 2.0
◆ compareCodePointOrder() [4/18]
|
inline |
Compare two Unicode strings in code point order. The result may be different from the results of compare(), operator<, etc. if supplementary characters are present:
In UTF-16, supplementary characters (with code points U+10000 and above) are stored with pairs of surrogate code units. These have values from 0xd800 to 0xdfff, which means that they compare as less than some other BMP characters like U+feff. This function compares Unicode strings in code point order. If either of the UTF-16 strings is malformed (i.e., it contains unpaired surrogates), then the result is not defined.
- Parameters
-
start The start offset in this string at which the compare operation begins. length The number of code units from this string to compare. srcText Another string to compare this one to.
- Returns
- a negative/zero/positive integer corresponding to whether this string is less than/equal to/greater than the second one in code point order ICU 2.0
◆ compareCodePointOrder() [5/18]
|
inline |
Compare two Unicode strings in code point order. The result may be different from the results of compare(), operator<, etc. if supplementary characters are present:
In UTF-16, supplementary characters (with code points U+10000 and above) are stored with pairs of surrogate code units. These have values from 0xd800 to 0xdfff, which means that they compare as less than some other BMP characters like U+feff. This function compares Unicode strings in code point order. If either of the UTF-16 strings is malformed (i.e., it contains unpaired surrogates), then the result is not defined.
- Parameters
-
start The start offset in this string at which the compare operation begins. length The number of code units from this string to compare. srcText Another string to compare this one to.
- Returns
- a negative/zero/positive integer corresponding to whether this string is less than/equal to/greater than the second one in code point order ICU 2.0
◆ compareCodePointOrder() [6/18]
|
inline |
Compare two Unicode strings in code point order. The result may be different from the results of compare(), operator<, etc. if supplementary characters are present:
In UTF-16, supplementary characters (with code points U+10000 and above) are stored with pairs of surrogate code units. These have values from 0xd800 to 0xdfff, which means that they compare as less than some other BMP characters like U+feff. This function compares Unicode strings in code point order. If either of the UTF-16 strings is malformed (i.e., it contains unpaired surrogates), then the result is not defined.
- Parameters
-
start The start offset in this string at which the compare operation begins. length The number of code units from this string to compare. srcText Another string to compare this one to.
- Returns
- a negative/zero/positive integer corresponding to whether this string is less than/equal to/greater than the second one in code point order ICU 2.0
◆ compareCodePointOrder() [7/18]
|
inline |
Compare two Unicode strings in code point order. The result may be different from the results of compare(), operator<, etc. if supplementary characters are present:
In UTF-16, supplementary characters (with code points U+10000 and above) are stored with pairs of surrogate code units. These have values from 0xd800 to 0xdfff, which means that they compare as less than some other BMP characters like U+feff. This function compares Unicode strings in code point order. If either of the UTF-16 strings is malformed (i.e., it contains unpaired surrogates), then the result is not defined.
- Parameters
-
start The start offset in this string at which the compare operation begins. length The number of code units from this string to compare. srcText Another string to compare this one to. srcStart The start offset in that string at which the compare operation begins. srcLength The number of code units from that string to compare.
- Returns
- a negative/zero/positive integer corresponding to whether this string is less than/equal to/greater than the second one in code point order ICU 2.0
◆ compareCodePointOrder() [8/18]
|
inline |
Compare two Unicode strings in code point order. The result may be different from the results of compare(), operator<, etc. if supplementary characters are present:
In UTF-16, supplementary characters (with code points U+10000 and above) are stored with pairs of surrogate code units. These have values from 0xd800 to 0xdfff, which means that they compare as less than some other BMP characters like U+feff. This function compares Unicode strings in code point order. If either of the UTF-16 strings is malformed (i.e., it contains unpaired surrogates), then the result is not defined.
- Parameters
-
start The start offset in this string at which the compare operation begins. length The number of code units from this string to compare. srcText Another string to compare this one to. srcStart The start offset in that string at which the compare operation begins. srcLength The number of code units from that string to compare.
- Returns
- a negative/zero/positive integer corresponding to whether this string is less than/equal to/greater than the second one in code point order ICU 2.0
◆ compareCodePointOrder() [9/18]
|
inline |
Compare two Unicode strings in code point order. The result may be different from the results of compare(), operator<, etc. if supplementary characters are present:
In UTF-16, supplementary characters (with code points U+10000 and above) are stored with pairs of surrogate code units. These have values from 0xd800 to 0xdfff, which means that they compare as less than some other BMP characters like U+feff. This function compares Unicode strings in code point order. If either of the UTF-16 strings is malformed (i.e., it contains unpaired surrogates), then the result is not defined.
- Parameters
-
start The start offset in this string at which the compare operation begins. length The number of code units from this string to compare. srcText Another string to compare this one to. srcStart The start offset in that string at which the compare operation begins. srcLength The number of code units from that string to compare.
- Returns
- a negative/zero/positive integer corresponding to whether this string is less than/equal to/greater than the second one in code point order ICU 2.0
◆ compareCodePointOrder() [10/18]
|
inline |
Compare two Unicode strings in code point order. The result may be different from the results of compare(), operator<, etc. if supplementary characters are present:
In UTF-16, supplementary characters (with code points U+10000 and above) are stored with pairs of surrogate code units. These have values from 0xd800 to 0xdfff, which means that they compare as less than some other BMP characters like U+feff. This function compares Unicode strings in code point order. If either of the UTF-16 strings is malformed (i.e., it contains unpaired surrogates), then the result is not defined.
- Parameters
-
srcChars A pointer to another string to compare this one to. srcLength The number of code units from that string to compare.
- Returns
- a negative/zero/positive integer corresponding to whether this string is less than/equal to/greater than the second one in code point order ICU 2.0
◆ compareCodePointOrder() [11/18]
|
inline |
Compare two Unicode strings in code point order. The result may be different from the results of compare(), operator<, etc. if supplementary characters are present:
In UTF-16, supplementary characters (with code points U+10000 and above) are stored with pairs of surrogate code units. These have values from 0xd800 to 0xdfff, which means that they compare as less than some other BMP characters like U+feff. This function compares Unicode strings in code point order. If either of the UTF-16 strings is malformed (i.e., it contains unpaired surrogates), then the result is not defined.
- Parameters
-
srcChars A pointer to another string to compare this one to. srcLength The number of code units from that string to compare.
- Returns
- a negative/zero/positive integer corresponding to whether this string is less than/equal to/greater than the second one in code point order ICU 2.0
◆ compareCodePointOrder() [12/18]
|
inline |
Compare two Unicode strings in code point order. The result may be different from the results of compare(), operator<, etc. if supplementary characters are present:
In UTF-16, supplementary characters (with code points U+10000 and above) are stored with pairs of surrogate code units. These have values from 0xd800 to 0xdfff, which means that they compare as less than some other BMP characters like U+feff. This function compares Unicode strings in code point order. If either of the UTF-16 strings is malformed (i.e., it contains unpaired surrogates), then the result is not defined.
- Parameters
-
srcChars A pointer to another string to compare this one to. srcLength The number of code units from that string to compare.
- Returns
- a negative/zero/positive integer corresponding to whether this string is less than/equal to/greater than the second one in code point order ICU 2.0
◆ compareCodePointOrder() [13/18]
|
inline |
Compare two Unicode strings in code point order. The result may be different from the results of compare(), operator<, etc. if supplementary characters are present:
In UTF-16, supplementary characters (with code points U+10000 and above) are stored with pairs of surrogate code units. These have values from 0xd800 to 0xdfff, which means that they compare as less than some other BMP characters like U+feff. This function compares Unicode strings in code point order. If either of the UTF-16 strings is malformed (i.e., it contains unpaired surrogates), then the result is not defined.
- Parameters
-
start The start offset in this string at which the compare operation begins. length The number of code units from this string to compare. srcChars A pointer to another string to compare this one to.
- Returns
- a negative/zero/positive integer corresponding to whether this string is less than/equal to/greater than the second one in code point order ICU 2.0
◆ compareCodePointOrder() [14/18]
|
inline |
Compare two Unicode strings in code point order. The result may be different from the results of compare(), operator<, etc. if supplementary characters are present:
In UTF-16, supplementary characters (with code points U+10000 and above) are stored with pairs of surrogate code units. These have values from 0xd800 to 0xdfff, which means that they compare as less than some other BMP characters like U+feff. This function compares Unicode strings in code point order. If either of the UTF-16 strings is malformed (i.e., it contains unpaired surrogates), then the result is not defined.
- Parameters
-
start The start offset in this string at which the compare operation begins. length The number of code units from this string to compare. srcChars A pointer to another string to compare this one to.
- Returns
- a negative/zero/positive integer corresponding to whether this string is less than/equal to/greater than the second one in code point order ICU 2.0
◆ compareCodePointOrder() [15/18]
|
inline |
Compare two Unicode strings in code point order. The result may be different from the results of compare(), operator<, etc. if supplementary characters are present:
In UTF-16, supplementary characters (with code points U+10000 and above) are stored with pairs of surrogate code units. These have values from 0xd800 to 0xdfff, which means that they compare as less than some other BMP characters like U+feff. This function compares Unicode strings in code point order. If either of the UTF-16 strings is malformed (i.e., it contains unpaired surrogates), then the result is not defined.
- Parameters
-
start The start offset in this string at which the compare operation begins. length The number of code units from this string to compare. srcChars A pointer to another string to compare this one to.
- Returns
- a negative/zero/positive integer corresponding to whether this string is less than/equal to/greater than the second one in code point order ICU 2.0
◆ compareCodePointOrder() [16/18]
|
inline |
Compare two Unicode strings in code point order. The result may be different from the results of compare(), operator<, etc. if supplementary characters are present:
In UTF-16, supplementary characters (with code points U+10000 and above) are stored with pairs of surrogate code units. These have values from 0xd800 to 0xdfff, which means that they compare as less than some other BMP characters like U+feff. This function compares Unicode strings in code point order. If either of the UTF-16 strings is malformed (i.e., it contains unpaired surrogates), then the result is not defined.
- Parameters
-
start The start offset in this string at which the compare operation begins. length The number of code units from this string to compare. srcChars A pointer to another string to compare this one to. srcStart The start offset in that string at which the compare operation begins. srcLength The number of code units from that string to compare.
- Returns
- a negative/zero/positive integer corresponding to whether this string is less than/equal to/greater than the second one in code point order ICU 2.0
◆ compareCodePointOrder() [17/18]
|
inline |
Compare two Unicode strings in code point order. The result may be different from the results of compare(), operator<, etc. if supplementary characters are present:
In UTF-16, supplementary characters (with code points U+10000 and above) are stored with pairs of surrogate code units. These have values from 0xd800 to 0xdfff, which means that they compare as less than some other BMP characters like U+feff. This function compares Unicode strings in code point order. If either of the UTF-16 strings is malformed (i.e., it contains unpaired surrogates), then the result is not defined.
- Parameters
-
start The start offset in this string at which the compare operation begins. length The number of code units from this string to compare. srcChars A pointer to another string to compare this one to. srcStart The start offset in that string at which the compare operation begins. srcLength The number of code units from that string to compare.
- Returns
- a negative/zero/positive integer corresponding to whether this string is less than/equal to/greater than the second one in code point order ICU 2.0
◆ compareCodePointOrder() [18/18]
|
inline |
Compare two Unicode strings in code point order. The result may be different from the results of compare(), operator<, etc. if supplementary characters are present:
In UTF-16, supplementary characters (with code points U+10000 and above) are stored with pairs of surrogate code units. These have values from 0xd800 to 0xdfff, which means that they compare as less than some other BMP characters like U+feff. This function compares Unicode strings in code point order. If either of the UTF-16 strings is malformed (i.e., it contains unpaired surrogates), then the result is not defined.
- Parameters
-
start The start offset in this string at which the compare operation begins. length The number of code units from this string to compare. srcChars A pointer to another string to compare this one to. srcStart The start offset in that string at which the compare operation begins. srcLength The number of code units from that string to compare.
- Returns
- a negative/zero/positive integer corresponding to whether this string is less than/equal to/greater than the second one in code point order ICU 2.0
◆ compareCodePointOrderBetween() [1/3]
|
inline |
Compare two Unicode strings in code point order. The result may be different from the results of compare(), operator<, etc. if supplementary characters are present:
In UTF-16, supplementary characters (with code points U+10000 and above) are stored with pairs of surrogate code units. These have values from 0xd800 to 0xdfff, which means that they compare as less than some other BMP characters like U+feff. This function compares Unicode strings in code point order. If either of the UTF-16 strings is malformed (i.e., it contains unpaired surrogates), then the result is not defined.
- Parameters
-
start The start offset in this string at which the compare operation begins. limit The offset after the last code unit from this string to compare. srcText Another string to compare this one to. srcStart The start offset in that string at which the compare operation begins. srcLimit The offset after the last code unit from that string to compare.
- Returns
- a negative/zero/positive integer corresponding to whether this string is less than/equal to/greater than the second one in code point order ICU 2.0
◆ compareCodePointOrderBetween() [2/3]
|
inline |
Compare two Unicode strings in code point order. The result may be different from the results of compare(), operator<, etc. if supplementary characters are present:
In UTF-16, supplementary characters (with code points U+10000 and above) are stored with pairs of surrogate code units. These have values from 0xd800 to 0xdfff, which means that they compare as less than some other BMP characters like U+feff. This function compares Unicode strings in code point order. If either of the UTF-16 strings is malformed (i.e., it contains unpaired surrogates), then the result is not defined.
- Parameters
-
start The start offset in this string at which the compare operation begins. limit The offset after the last code unit from this string to compare. srcText Another string to compare this one to. srcStart The start offset in that string at which the compare operation begins. srcLimit The offset after the last code unit from that string to compare.
- Returns
- a negative/zero/positive integer corresponding to whether this string is less than/equal to/greater than the second one in code point order ICU 2.0
◆ compareCodePointOrderBetween() [3/3]
|
inline |
Compare two Unicode strings in code point order. The result may be different from the results of compare(), operator<, etc. if supplementary characters are present:
In UTF-16, supplementary characters (with code points U+10000 and above) are stored with pairs of surrogate code units. These have values from 0xd800 to 0xdfff, which means that they compare as less than some other BMP characters like U+feff. This function compares Unicode strings in code point order. If either of the UTF-16 strings is malformed (i.e., it contains unpaired surrogates), then the result is not defined.
- Parameters
-
start The start offset in this string at which the compare operation begins. limit The offset after the last code unit from this string to compare. srcText Another string to compare this one to. srcStart The start offset in that string at which the compare operation begins. srcLimit The offset after the last code unit from that string to compare.
- Returns
- a negative/zero/positive integer corresponding to whether this string is less than/equal to/greater than the second one in code point order ICU 2.0
◆ copy() [1/3]
Copy a substring of this object, retaining attribute (out-of-band) information. This method is used to duplicate or reorder substrings. The destination index must not overlap the source range.
- Parameters
-
start the beginning index, inclusive; 0 <= start <= limit.limit the ending index, exclusive; start <= limit <= length().dest the destination index. The characters from start..limit-1will be copied todest. Implementations of this method may assume thatdest <= start || dest >= limit. ICU 2.0
Implements Replaceable.
◆ copy() [2/3]
Copy a substring of this object, retaining attribute (out-of-band) information. This method is used to duplicate or reorder substrings. The destination index must not overlap the source range.
- Parameters
-
start the beginning index, inclusive; 0 <= start <= limit.limit the ending index, exclusive; start <= limit <= length().dest the destination index. The characters from start..limit-1will be copied todest. Implementations of this method may assume thatdest <= start || dest >= limit. ICU 2.0
Implements Replaceable.
◆ copy() [3/3]
Copy a substring of this object, retaining attribute (out-of-band) information. This method is used to duplicate or reorder substrings. The destination index must not overlap the source range.
- Parameters
-
start the beginning index, inclusive; 0 <= start <= limit.limit the ending index, exclusive; start <= limit <= length().dest the destination index. The characters from start..limit-1will be copied todest. Implementations of this method may assume thatdest <= start || dest >= limit. ICU 2.0
Implements Replaceable.
◆ countChar32() [1/3]
Count Unicode code points in the length UChar code units of the string. A code point may occupy either one or two UChar code units. Counting code points involves reading all code units.
This functions is basically the inverse of moveIndex32().
- Parameters
-
start the index of the first code unit to check length the number of UChar code units to check
- Returns
- the number of code points in the specified code units
- See also
- length ICU 2.0
◆ countChar32() [2/3]
Count Unicode code points in the length UChar code units of the string. A code point may occupy either one or two UChar code units. Counting code points involves reading all code units.
This functions is basically the inverse of moveIndex32().
- Parameters
-
start the index of the first code unit to check length the number of UChar code units to check
- Returns
- the number of code points in the specified code units
- See also
- length ICU 2.0
◆ countChar32() [3/3]
Count Unicode code points in the length UChar code units of the string. A code point may occupy either one or two UChar code units. Counting code points involves reading all code units.
This functions is basically the inverse of moveIndex32().
- Parameters
-
start the index of the first code unit to check length the number of UChar code units to check
- Returns
- the number of code points in the specified code units
- See also
- length ICU 2.0
◆ endsWith() [1/12]
|
inline |
Determine if this ends with the characters in text
- Parameters
-
text The text to match.
- Returns
- TRUE if this ends with the characters in
text, FALSE otherwise ICU 2.0
◆ endsWith() [2/12]
|
inline |
Determine if this ends with the characters in text
- Parameters
-
text The text to match.
- Returns
- TRUE if this ends with the characters in
text, FALSE otherwise ICU 2.0
◆ endsWith() [3/12]
|
inline |
Determine if this ends with the characters in text
- Parameters
-
text The text to match.
- Returns
- TRUE if this ends with the characters in
text, FALSE otherwise ICU 2.0
◆ endsWith() [4/12]
|
inline |
Determine if this ends with the characters in srcText in the range [srcStart, srcStart + srcLength).
- Parameters
-
srcText The text to match. srcStart the offset into srcTextto start matchingsrcLength the number of characters in srcTextto match
- Returns
- TRUE if this ends with the characters in
text, FALSE otherwise ICU 2.0
◆ endsWith() [5/12]
|
inline |
Determine if this ends with the characters in srcText in the range [srcStart, srcStart + srcLength).
- Parameters
-
srcText The text to match. srcStart the offset into srcTextto start matchingsrcLength the number of characters in srcTextto match
- Returns
- TRUE if this ends with the characters in
text, FALSE otherwise ICU 2.0
◆ endsWith() [6/12]
|
inline |
Determine if this ends with the characters in srcText in the range [srcStart, srcStart + srcLength).
- Parameters
-
srcText The text to match. srcStart the offset into srcTextto start matchingsrcLength the number of characters in srcTextto match
- Returns
- TRUE if this ends with the characters in
text, FALSE otherwise ICU 2.0
◆ endsWith() [7/12]
Determine if this ends with the characters in srcChars
- Parameters
-
srcChars The characters to match. srcLength the number of characters in srcChars
- Returns
- TRUE if this ends with the characters in
srcChars, FALSE otherwise ICU 2.0
◆ endsWith() [8/12]
Determine if this ends with the characters in srcChars
- Parameters
-
srcChars The characters to match. srcLength the number of characters in srcChars
- Returns
- TRUE if this ends with the characters in
srcChars, FALSE otherwise ICU 2.0
◆ endsWith() [9/12]
Determine if this ends with the characters in srcChars
- Parameters
-
srcChars The characters to match. srcLength the number of characters in srcChars
- Returns
- TRUE if this ends with the characters in
srcChars, FALSE otherwise ICU 2.0
◆ endsWith() [10/12]
|
inline |
Determine if this ends with the characters in srcChars in the range [srcStart, srcStart + srcLength).
- Parameters
-
srcChars The characters to match. srcStart the offset into srcTextto start matchingsrcLength the number of characters in srcCharsto match
- Returns
- TRUE if this ends with the characters in
srcChars, FALSE otherwise ICU 2.0
◆ endsWith() [11/12]
|
inline |
Determine if this ends with the characters in srcChars in the range [srcStart, srcStart + srcLength).
- Parameters
-
srcChars The characters to match. srcStart the offset into srcTextto start matchingsrcLength the number of characters in srcCharsto match
- Returns
- TRUE if this ends with the characters in
srcChars, FALSE otherwise ICU 2.0
◆ endsWith() [12/12]
|
inline |
Determine if this ends with the characters in srcChars in the range [srcStart, srcStart + srcLength).
- Parameters
-
srcChars The characters to match. srcStart the offset into srcTextto start matchingsrcLength the number of characters in srcCharsto match
- Returns
- TRUE if this ends with the characters in
srcChars, FALSE otherwise ICU 2.0
◆ extract() [1/24]
|
inline |
Copy the characters in the range [start, start + length) into the array dst, beginning at dstStart. If the string aliases to dst itself as an external buffer, then extract() will not copy the contents.
- Parameters
-
start offset of first character which will be copied into the array length the number of characters to extract dst array in which to copy characters. The length of dstmust be at least (dstStart + length).dstStart the offset in dstwhere the first character will be extracted ICU 2.0
◆ extract() [2/24]
|
inline |
Copy the characters in the range [start, start + length) into the array dst, beginning at dstStart. If the string aliases to dst itself as an external buffer, then extract() will not copy the contents.
- Parameters
-
start offset of first character which will be copied into the array length the number of characters to extract dst array in which to copy characters. The length of dstmust be at least (dstStart + length).dstStart the offset in dstwhere the first character will be extracted ICU 2.0
◆ extract() [3/24]
|
inline |
Copy the characters in the range [start, start + length) into the array dst, beginning at dstStart. If the string aliases to dst itself as an external buffer, then extract() will not copy the contents.
- Parameters
-
start offset of first character which will be copied into the array length the number of characters to extract dst array in which to copy characters. The length of dstmust be at least (dstStart + length).dstStart the offset in dstwhere the first character will be extracted ICU 2.0
◆ extract() [4/24]
| int32_t UnicodeString::extract | ( | UChar * | dest, |
| int32_t | destCapacity, | ||
| UErrorCode & | errorCode | ||
| ) | const |
Copy the contents of the string into dest. This is a convenience function that checks if there is enough space in dest, extracts the entire string if possible, and NUL-terminates dest if possible.
If the string fits into dest but cannot be NUL-terminated (length()==destCapacity) then the error code is set to U_STRING_NOT_TERMINATED_WARNING. If the string itself does not fit into dest (length()>destCapacity) then the error code is set to U_BUFFER_OVERFLOW_ERROR.
If the string aliases to dest itself as an external buffer, then extract() will not copy the contents.
- Parameters
-
dest Destination string buffer. destCapacity Number of UChars available at dest. errorCode ICU error code.
- Returns
- length() ICU 2.0
◆ extract() [5/24]
| int32_t UnicodeString::extract | ( | UChar * | dest, |
| int32_t | destCapacity, | ||
| UErrorCode & | errorCode | ||
| ) | const |
Copy the contents of the string into dest. This is a convenience function that checks if there is enough space in dest, extracts the entire string if possible, and NUL-terminates dest if possible.
If the string fits into dest but cannot be NUL-terminated (length()==destCapacity) then the error code is set to U_STRING_NOT_TERMINATED_WARNING. If the string itself does not fit into dest (length()>destCapacity) then the error code is set to U_BUFFER_OVERFLOW_ERROR.
If the string aliases to dest itself as an external buffer, then extract() will not copy the contents.
- Parameters
-
dest Destination string buffer. destCapacity Number of UChars available at dest. errorCode ICU error code.
- Returns
- length() ICU 2.0
◆ extract() [6/24]
| int32_t UnicodeString::extract | ( | UChar * | dest, |
| int32_t | destCapacity, | ||
| UErrorCode & | errorCode | ||
| ) | const |
Copy the contents of the string into dest. This is a convenience function that checks if there is enough space in dest, extracts the entire string if possible, and NUL-terminates dest if possible.
If the string fits into dest but cannot be NUL-terminated (length()==destCapacity) then the error code is set to U_STRING_NOT_TERMINATED_WARNING. If the string itself does not fit into dest (length()>destCapacity) then the error code is set to U_BUFFER_OVERFLOW_ERROR.
If the string aliases to dest itself as an external buffer, then extract() will not copy the contents.
- Parameters
-
dest Destination string buffer. destCapacity Number of UChars available at dest. errorCode ICU error code.
- Returns
- length() ICU 2.0
◆ extract() [7/24]
|
inline |
Copy the characters in the range [start, start + length) into the UnicodeString target.
- Parameters
-
start offset of first character which will be copied length the number of characters to extract target UnicodeString into which to copy characters.
- Returns
- A reference to
targetICU 2.0
◆ extract() [8/24]
|
inline |
Copy the characters in the range [start, start + length) into the UnicodeString target.
- Parameters
-
start offset of first character which will be copied length the number of characters to extract target UnicodeString into which to copy characters.
- Returns
- A reference to
targetICU 2.0
◆ extract() [9/24]
|
inline |
Copy the characters in the range [start, start + length) into the UnicodeString target.
- Parameters
-
start offset of first character which will be copied length the number of characters to extract target UnicodeString into which to copy characters.
- Returns
- A reference to
targetICU 2.0
◆ extract() [10/24]
| int32_t UnicodeString::extract | ( | int32_t | start, |
| int32_t | startLength, | ||
| char * | target, | ||
| int32_t | targetCapacity, | ||
| enum EInvariant | inv | ||
| ) | const |
Copy the characters in the range [start, start + length) into an array of characters. All characters must be invariant (see utypes.h). Use US_INV as the last, signature-distinguishing parameter.
This function does not write any more than targetLength characters but returns the length of the entire output string so that one can allocate a larger buffer and call the function again if necessary. The output string is NUL-terminated if possible.
- Parameters
-
start offset of first character which will be copied startLength the number of characters to extract target the target buffer for extraction, can be NULL if targetLength is 0 targetCapacity the length of the target buffer inv Signature-distinguishing paramater, use US_INV.
- Returns
- the output string length, not including the terminating NUL ICU 3.2
◆ extract() [11/24]
| int32_t UnicodeString::extract | ( | int32_t | start, |
| int32_t | startLength, | ||
| char * | target, | ||
| int32_t | targetCapacity, | ||
| enum EInvariant | inv | ||
| ) | const |
Copy the characters in the range [start, start + length) into an array of characters. All characters must be invariant (see utypes.h). Use US_INV as the last, signature-distinguishing parameter.
This function does not write any more than targetLength characters but returns the length of the entire output string so that one can allocate a larger buffer and call the function again if necessary. The output string is NUL-terminated if possible.
- Parameters
-
start offset of first character which will be copied startLength the number of characters to extract target the target buffer for extraction, can be NULL if targetLength is 0 targetCapacity the length of the target buffer inv Signature-distinguishing paramater, use US_INV.
- Returns
- the output string length, not including the terminating NUL ICU 3.2
◆ extract() [12/24]
| int32_t UnicodeString::extract | ( | int32_t | start, |
| int32_t | startLength, | ||
| char * | target, | ||
| int32_t | targetCapacity, | ||
| enum EInvariant | inv | ||
| ) | const |
Copy the characters in the range [start, start + length) into an array of characters. All characters must be invariant (see utypes.h). Use US_INV as the last, signature-distinguishing parameter.
This function does not write any more than targetLength characters but returns the length of the entire output string so that one can allocate a larger buffer and call the function again if necessary. The output string is NUL-terminated if possible.
- Parameters
-
start offset of first character which will be copied startLength the number of characters to extract target the target buffer for extraction, can be NULL if targetLength is 0 targetCapacity the length of the target buffer inv Signature-distinguishing paramater, use US_INV.
- Returns
- the output string length, not including the terminating NUL ICU 3.2
◆ extract() [13/24]
| int32_t UnicodeString::extract | ( | int32_t | start, |
| int32_t | startLength, | ||
| char * | target, | ||
| uint32_t | targetLength | ||
| ) | const |
Copy the characters in the range [start, start + length) into an array of characters in the platform's default codepage. This function does not write any more than targetLength characters but returns the length of the entire output string so that one can allocate a larger buffer and call the function again if necessary. The output string is NUL-terminated if possible.
- Parameters
-
start offset of first character which will be copied startLength the number of characters to extract target the target buffer for extraction targetLength the length of the target buffer If targetis NULL, then the number of bytes required fortargetis returned.
- Returns
- the output string length, not including the terminating NUL ICU 2.0
◆ extract() [14/24]
| int32_t UnicodeString::extract | ( | int32_t | start, |
| int32_t | startLength, | ||
| char * | target, | ||
| uint32_t | targetLength | ||
| ) | const |
Copy the characters in the range [start, start + length) into an array of characters in the platform's default codepage. This function does not write any more than targetLength characters but returns the length of the entire output string so that one can allocate a larger buffer and call the function again if necessary. The output string is NUL-terminated if possible.
- Parameters
-
start offset of first character which will be copied startLength the number of characters to extract target the target buffer for extraction targetLength the length of the target buffer If targetis NULL, then the number of bytes required fortargetis returned.
- Returns
- the output string length, not including the terminating NUL ICU 2.0
◆ extract() [15/24]
| int32_t UnicodeString::extract | ( | int32_t | start, |
| int32_t | startLength, | ||
| char * | target, | ||
| uint32_t | targetLength | ||
| ) | const |
Copy the characters in the range [start, start + length) into an array of characters in the platform's default codepage. This function does not write any more than targetLength characters but returns the length of the entire output string so that one can allocate a larger buffer and call the function again if necessary. The output string is NUL-terminated if possible.
- Parameters
-
start offset of first character which will be copied startLength the number of characters to extract target the target buffer for extraction targetLength the length of the target buffer If targetis NULL, then the number of bytes required fortargetis returned.
- Returns
- the output string length, not including the terminating NUL ICU 2.0
◆ extract() [16/24]
|
inline |
Copy the characters in the range [start, start + length) into an array of characters in a specified codepage. The output string is NUL-terminated.
Recommendation: For invariant-character strings use extract(int32_t start, int32_t length, char *target, int32_t targetCapacity, enum EInvariant inv) const because it avoids object code dependencies of UnicodeString on the conversion code.
- Parameters
-
start offset of first character which will be copied startLength the number of characters to extract target the target buffer for extraction codepage the desired codepage for the characters. 0 has the special meaning of the default codepage If codepageis an empty string (""), then a simple conversion is performed on the codepage-invariant subset ("invariant characters") of the platform encoding. See utypes.h. Iftargetis NULL, then the number of bytes required fortargetis returned. It is assumed that the target is big enough to fit all of the characters.
- Returns
- the output string length, not including the terminating NUL ICU 2.0
◆ extract() [17/24]
|
inline |
Copy the characters in the range [start, start + length) into an array of characters in a specified codepage. The output string is NUL-terminated.
Recommendation: For invariant-character strings use extract(int32_t start, int32_t length, char *target, int32_t targetCapacity, enum EInvariant inv) const because it avoids object code dependencies of UnicodeString on the conversion code.
- Parameters
-
start offset of first character which will be copied startLength the number of characters to extract target the target buffer for extraction codepage the desired codepage for the characters. 0 has the special meaning of the default codepage If codepageis an empty string (""), then a simple conversion is performed on the codepage-invariant subset ("invariant characters") of the platform encoding. See utypes.h. Iftargetis NULL, then the number of bytes required fortargetis returned. It is assumed that the target is big enough to fit all of the characters.
- Returns
- the output string length, not including the terminating NUL ICU 2.0
◆ extract() [18/24]
|
inline |
Copy the characters in the range [start, start + length) into an array of characters in a specified codepage. The output string is NUL-terminated.
Recommendation: For invariant-character strings use extract(int32_t start, int32_t length, char *target, int32_t targetCapacity, enum EInvariant inv) const because it avoids object code dependencies of UnicodeString on the conversion code.
- Parameters
-
start offset of first character which will be copied startLength the number of characters to extract target the target buffer for extraction codepage the desired codepage for the characters. 0 has the special meaning of the default codepage If codepageis an empty string (""), then a simple conversion is performed on the codepage-invariant subset ("invariant characters") of the platform encoding. See utypes.h. Iftargetis NULL, then the number of bytes required fortargetis returned. It is assumed that the target is big enough to fit all of the characters.
- Returns
- the output string length, not including the terminating NUL ICU 2.0
◆ extract() [19/24]
| int32_t UnicodeString::extract | ( | int32_t | start, |
| int32_t | startLength, | ||
| char * | target, | ||
| uint32_t | targetLength, | ||
| const char * | codepage | ||
| ) | const |
Copy the characters in the range [start, start + length) into an array of characters in a specified codepage. This function does not write any more than targetLength characters but returns the length of the entire output string so that one can allocate a larger buffer and call the function again if necessary. The output string is NUL-terminated if possible.
Recommendation: For invariant-character strings use extract(int32_t start, int32_t length, char *target, int32_t targetCapacity, enum EInvariant inv) const because it avoids object code dependencies of UnicodeString on the conversion code.
- Parameters
-
start offset of first character which will be copied startLength the number of characters to extract target the target buffer for extraction targetLength the length of the target buffer codepage the desired codepage for the characters. 0 has the special meaning of the default codepage If codepageis an empty string (""), then a simple conversion is performed on the codepage-invariant subset ("invariant characters") of the platform encoding. See utypes.h. Iftargetis NULL, then the number of bytes required fortargetis returned.
- Returns
- the output string length, not including the terminating NUL ICU 2.0
◆ extract() [20/24]
| int32_t UnicodeString::extract | ( | int32_t | start, |
| int32_t | startLength, | ||
| char * | target, | ||
| uint32_t | targetLength, | ||
| const char * | codepage | ||
| ) | const |
Copy the characters in the range [start, start + length) into an array of characters in a specified codepage. This function does not write any more than targetLength characters but returns the length of the entire output string so that one can allocate a larger buffer and call the function again if necessary. The output string is NUL-terminated if possible.
Recommendation: For invariant-character strings use extract(int32_t start, int32_t length, char *target, int32_t targetCapacity, enum EInvariant inv) const because it avoids object code dependencies of UnicodeString on the conversion code.
- Parameters
-
start offset of first character which will be copied startLength the number of characters to extract target the target buffer for extraction targetLength the length of the target buffer codepage the desired codepage for the characters. 0 has the special meaning of the default codepage If codepageis an empty string (""), then a simple conversion is performed on the codepage-invariant subset ("invariant characters") of the platform encoding. See utypes.h. Iftargetis NULL, then the number of bytes required fortargetis returned.
- Returns
- the output string length, not including the terminating NUL ICU 2.0
◆ extract() [21/24]
| int32_t UnicodeString::extract | ( | int32_t | start, |
| int32_t | startLength, | ||
| char * | target, | ||
| uint32_t | targetLength, | ||
| const char * | codepage | ||
| ) | const |
Copy the characters in the range [start, start + length) into an array of characters in a specified codepage. This function does not write any more than targetLength characters but returns the length of the entire output string so that one can allocate a larger buffer and call the function again if necessary. The output string is NUL-terminated if possible.
Recommendation: For invariant-character strings use extract(int32_t start, int32_t length, char *target, int32_t targetCapacity, enum EInvariant inv) const because it avoids object code dependencies of UnicodeString on the conversion code.
- Parameters
-
start offset of first character which will be copied startLength the number of characters to extract target the target buffer for extraction targetLength the length of the target buffer codepage the desired codepage for the characters. 0 has the special meaning of the default codepage If codepageis an empty string (""), then a simple conversion is performed on the codepage-invariant subset ("invariant characters") of the platform encoding. See utypes.h. Iftargetis NULL, then the number of bytes required fortargetis returned.
- Returns
- the output string length, not including the terminating NUL ICU 2.0
◆ extract() [22/24]
| int32_t UnicodeString::extract | ( | char * | dest, |
| int32_t | destCapacity, | ||
| UConverter * | cnv, | ||
| UErrorCode & | errorCode | ||
| ) | const |
Convert the UnicodeString into a codepage string using an existing UConverter. The output string is NUL-terminated if possible.
This function avoids the overhead of opening and closing a converter if multiple strings are extracted.
- Parameters
-
dest destination string buffer, can be NULL if destCapacity==0 destCapacity the number of chars available at dest cnv the converter object to be used (ucnv_resetFromUnicode() will be called), or NULL for the default converter errorCode normal ICU error code
- Returns
- the length of the output string, not counting the terminating NUL; if the length is greater than destCapacity, then the string will not fit and a buffer of the indicated length would need to be passed in ICU 2.0
◆ extract() [23/24]
| int32_t UnicodeString::extract | ( | char * | dest, |
| int32_t | destCapacity, | ||
| UConverter * | cnv, | ||
| UErrorCode & | errorCode | ||
| ) | const |
Convert the UnicodeString into a codepage string using an existing UConverter. The output string is NUL-terminated if possible.
This function avoids the overhead of opening and closing a converter if multiple strings are extracted.
- Parameters
-
dest destination string buffer, can be NULL if destCapacity==0 destCapacity the number of chars available at dest cnv the converter object to be used (ucnv_resetFromUnicode() will be called), or NULL for the default converter errorCode normal ICU error code
- Returns
- the length of the output string, not counting the terminating NUL; if the length is greater than destCapacity, then the string will not fit and a buffer of the indicated length would need to be passed in ICU 2.0
◆ extract() [24/24]
| int32_t UnicodeString::extract | ( | char * | dest, |
| int32_t | destCapacity, | ||
| UConverter * | cnv, | ||
| UErrorCode & | errorCode | ||
| ) | const |
Convert the UnicodeString into a codepage string using an existing UConverter. The output string is NUL-terminated if possible.
This function avoids the overhead of opening and closing a converter if multiple strings are extracted.
- Parameters
-
dest destination string buffer, can be NULL if destCapacity==0 destCapacity the number of chars available at dest cnv the converter object to be used (ucnv_resetFromUnicode() will be called), or NULL for the default converter errorCode normal ICU error code
- Returns
- the length of the output string, not counting the terminating NUL; if the length is greater than destCapacity, then the string will not fit and a buffer of the indicated length would need to be passed in ICU 2.0
◆ extractBetween() [1/6]
|
inline |
Copy the characters in the range [start, limit) into the array dst, beginning at dstStart.
- Parameters
-
start offset of first character which will be copied into the array limit offset immediately following the last character to be copied dst array in which to copy characters. The length of dstmust be at least (dstStart + (limit - start)).dstStart the offset in dstwhere the first character will be extracted ICU 2.0
◆ extractBetween() [2/6]
|
inline |
Copy the characters in the range [start, limit) into the array dst, beginning at dstStart.
- Parameters
-
start offset of first character which will be copied into the array limit offset immediately following the last character to be copied dst array in which to copy characters. The length of dstmust be at least (dstStart + (limit - start)).dstStart the offset in dstwhere the first character will be extracted ICU 2.0
◆ extractBetween() [3/6]
|
inline |
Copy the characters in the range [start, limit) into the array dst, beginning at dstStart.
- Parameters
-
start offset of first character which will be copied into the array limit offset immediately following the last character to be copied dst array in which to copy characters. The length of dstmust be at least (dstStart + (limit - start)).dstStart the offset in dstwhere the first character will be extracted ICU 2.0
◆ extractBetween() [4/6]
|
virtual |
Copy the characters in the range [start, limit) into the UnicodeString target. Replaceable API.
- Parameters
-
start offset of first character which will be copied limit offset immediately following the last character to be copied target UnicodeString into which to copy characters.
- Returns
- A reference to
targetICU 2.0
Implements Replaceable.
◆ extractBetween() [5/6]
|
virtual |
Copy the characters in the range [start, limit) into the UnicodeString target. Replaceable API.
- Parameters
-
start offset of first character which will be copied limit offset immediately following the last character to be copied target UnicodeString into which to copy characters.
- Returns
- A reference to
targetICU 2.0
Implements Replaceable.
◆ extractBetween() [6/6]
|
virtual |
Copy the characters in the range [start, limit) into the UnicodeString target. Replaceable API.
- Parameters
-
start offset of first character which will be copied limit offset immediately following the last character to be copied target UnicodeString into which to copy characters.
- Returns
- A reference to
targetICU 2.0
Implements Replaceable.
◆ fastCopyFrom() [1/3]
| UnicodeString& UnicodeString::fastCopyFrom | ( | const UnicodeString & | src | ) |
Almost the same as the assignment operator. Replace the characters in this UnicodeString with the characters from srcText.
This function works the same as the assignment operator for all strings except for ones that are readonly aliases.
Starting with ICU 2.4, the assignment operator and the copy constructor allocate a new buffer and copy the buffer contents even for readonly aliases. This function implements the old, more efficient but less safe behavior of making this string also a readonly alias to the same buffer.
The fastCopyFrom function must be used only if it is known that the lifetime of this UnicodeString does not exceed the lifetime of the aliased buffer including its contents, for example for strings from resource bundles or aliases to string constants.
- Parameters
-
src The text containing the characters to replace.
- Returns
- a reference to this ICU 2.4
◆ fastCopyFrom() [2/3]
| UnicodeString& UnicodeString::fastCopyFrom | ( | const UnicodeString & | src | ) |
Almost the same as the assignment operator. Replace the characters in this UnicodeString with the characters from srcText.
This function works the same as the assignment operator for all strings except for ones that are readonly aliases.
Starting with ICU 2.4, the assignment operator and the copy constructor allocate a new buffer and copy the buffer contents even for readonly aliases. This function implements the old, more efficient but less safe behavior of making this string also a readonly alias to the same buffer.
The fastCopyFrom function must be used only if it is known that the lifetime of this UnicodeString does not exceed the lifetime of the aliased buffer including its contents, for example for strings from resource bundles or aliases to string constants.
- Parameters
-
src The text containing the characters to replace.
- Returns
- a reference to this ICU 2.4
◆ fastCopyFrom() [3/3]
| UnicodeString& UnicodeString::fastCopyFrom | ( | const UnicodeString & | src | ) |
Almost the same as the assignment operator. Replace the characters in this UnicodeString with the characters from srcText.
This function works the same as the assignment operator for all strings except for ones that are readonly aliases.
Starting with ICU 2.4, the assignment operator and the copy constructor allocate a new buffer and copy the buffer contents even for readonly aliases. This function implements the old, more efficient but less safe behavior of making this string also a readonly alias to the same buffer.
The fastCopyFrom function must be used only if it is known that the lifetime of this UnicodeString does not exceed the lifetime of the aliased buffer including its contents, for example for strings from resource bundles or aliases to string constants.
- Parameters
-
src The text containing the characters to replace.
- Returns
- a reference to this ICU 2.4
◆ findAndReplace() [1/9]
|
inline |
Replace all occurrences of characters in oldText with the characters in newText
- Parameters
-
oldText the text containing the search text newText the text containing the replacement text
- Returns
- a reference to this ICU 2.0
◆ findAndReplace() [2/9]
|
inline |
Replace all occurrences of characters in oldText with the characters in newText
- Parameters
-
oldText the text containing the search text newText the text containing the replacement text
- Returns
- a reference to this ICU 2.0
◆ findAndReplace() [3/9]
|
inline |
Replace all occurrences of characters in oldText with the characters in newText
- Parameters
-
oldText the text containing the search text newText the text containing the replacement text
- Returns
- a reference to this ICU 2.0
◆ findAndReplace() [4/9]
|
inline |
Replace all occurrences of characters in oldText with characters in newText in the range [start, start + length).
- Parameters
-
start the start of the range in which replace will performed length the length of the range in which replace will be performed oldText the text containing the search text newText the text containing the replacement text
- Returns
- a reference to this ICU 2.0
◆ findAndReplace() [5/9]
|
inline |
Replace all occurrences of characters in oldText with characters in newText in the range [start, start + length).
- Parameters
-
start the start of the range in which replace will performed length the length of the range in which replace will be performed oldText the text containing the search text newText the text containing the replacement text
- Returns
- a reference to this ICU 2.0
◆ findAndReplace() [6/9]
|
inline |
Replace all occurrences of characters in oldText with characters in newText in the range [start, start + length).
- Parameters
-
start the start of the range in which replace will performed length the length of the range in which replace will be performed oldText the text containing the search text newText the text containing the replacement text
- Returns
- a reference to this ICU 2.0
◆ findAndReplace() [7/9]
| UnicodeString& UnicodeString::findAndReplace | ( | int32_t | start, |
| int32_t | length, | ||
| const UnicodeString & | oldText, | ||
| int32_t | oldStart, | ||
| int32_t | oldLength, | ||
| const UnicodeString & | newText, | ||
| int32_t | newStart, | ||
| int32_t | newLength | ||
| ) |
Replace all occurrences of characters in oldText in the range [oldStart, oldStart + oldLength) with the characters in newText in the range [newStart, newStart + newLength) in the range [start, start + length).
- Parameters
-
start the start of the range in which replace will performed length the length of the range in which replace will be performed oldText the text containing the search text oldStart the start of the search range in oldTextoldLength the length of the search range in oldTextnewText the text containing the replacement text newStart the start of the replacement range in newTextnewLength the length of the replacement range in newText
- Returns
- a reference to this ICU 2.0
◆ findAndReplace() [8/9]
| UnicodeString& UnicodeString::findAndReplace | ( | int32_t | start, |
| int32_t | length, | ||
| const UnicodeString & | oldText, | ||
| int32_t | oldStart, | ||
| int32_t | oldLength, | ||
| const UnicodeString & | newText, | ||
| int32_t | newStart, | ||
| int32_t | newLength | ||
| ) |
Replace all occurrences of characters in oldText in the range [oldStart, oldStart + oldLength) with the characters in newText in the range [newStart, newStart + newLength) in the range [start, start + length).
- Parameters
-
start the start of the range in which replace will performed length the length of the range in which replace will be performed oldText the text containing the search text oldStart the start of the search range in oldTextoldLength the length of the search range in oldTextnewText the text containing the replacement text newStart the start of the replacement range in newTextnewLength the length of the replacement range in newText
- Returns
- a reference to this ICU 2.0
◆ findAndReplace() [9/9]
| UnicodeString& UnicodeString::findAndReplace | ( | int32_t | start, |
| int32_t | length, | ||
| const UnicodeString & | oldText, | ||
| int32_t | oldStart, | ||
| int32_t | oldLength, | ||
| const UnicodeString & | newText, | ||
| int32_t | newStart, | ||
| int32_t | newLength | ||
| ) |
Replace all occurrences of characters in oldText in the range [oldStart, oldStart + oldLength) with the characters in newText in the range [newStart, newStart + newLength) in the range [start, start + length).
- Parameters
-
start the start of the range in which replace will performed length the length of the range in which replace will be performed oldText the text containing the search text oldStart the start of the search range in oldTextoldLength the length of the search range in oldTextnewText the text containing the replacement text newStart the start of the replacement range in newTextnewLength the length of the replacement range in newText
- Returns
- a reference to this ICU 2.0
◆ foldCase() [1/3]
| UnicodeString& UnicodeString::foldCase | ( | uint32_t | options = 0 | ) |
Case-folds the characters in this string.
Case-folding is locale-independent and not context-sensitive, but there is an option for whether to include or exclude mappings for dotted I and dotless i that are marked with 'T' in CaseFolding.txt.
The result may be longer or shorter than the original.
- Parameters
-
options Either U_FOLD_CASE_DEFAULT or U_FOLD_CASE_EXCLUDE_SPECIAL_I
- Returns
- A reference to this. ICU 2.0
◆ foldCase() [2/3]
| UnicodeString& UnicodeString::foldCase | ( | uint32_t | options = 0 | ) |
Case-folds the characters in this string.
Case-folding is locale-independent and not context-sensitive, but there is an option for whether to include or exclude mappings for dotted I and dotless i that are marked with 'T' in CaseFolding.txt.
The result may be longer or shorter than the original.
- Parameters
-
options Either U_FOLD_CASE_DEFAULT or U_FOLD_CASE_EXCLUDE_SPECIAL_I
- Returns
- A reference to this. ICU 2.0
◆ foldCase() [3/3]
| UnicodeString& UnicodeString::foldCase | ( | uint32_t | options = 0 | ) |
Case-folds the characters in this string.
Case-folding is locale-independent and not context-sensitive, but there is an option for whether to include or exclude mappings for dotted I and dotless i that are marked with 'T' in CaseFolding.txt.
The result may be longer or shorter than the original.
- Parameters
-
options Either U_FOLD_CASE_DEFAULT or U_FOLD_CASE_EXCLUDE_SPECIAL_I
- Returns
- A reference to this. ICU 2.0
◆ fromUTF32() [1/3]
|
static |
Create a UnicodeString from a UTF-32 string. Illegal input is replaced with U+FFFD. Otherwise, errors result in a bogus string. Calls u_strFromUTF32WithSub().
- Parameters
-
utf32 UTF-32 input string. Must not be NULL. length Length of the input string, or -1 if NUL-terminated.
- Returns
- A UnicodeString with equivalent UTF-16 contents.
- See also
- toUTF32 ICU 4.2
◆ fromUTF32() [2/3]
|
static |
Create a UnicodeString from a UTF-32 string. Illegal input is replaced with U+FFFD. Otherwise, errors result in a bogus string. Calls u_strFromUTF32WithSub().
- Parameters
-
utf32 UTF-32 input string. Must not be NULL. length Length of the input string, or -1 if NUL-terminated.
- Returns
- A UnicodeString with equivalent UTF-16 contents.
- See also
- toUTF32 ICU 4.2
◆ fromUTF32() [3/3]
|
static |
Create a UnicodeString from a UTF-32 string. Illegal input is replaced with U+FFFD. Otherwise, errors result in a bogus string. Calls u_strFromUTF32WithSub().
- Parameters
-
utf32 UTF-32 input string. Must not be NULL. length Length of the input string, or -1 if NUL-terminated.
- Returns
- A UnicodeString with equivalent UTF-16 contents.
- See also
- toUTF32 ICU 4.2
◆ fromUTF8() [1/3]
|
static |
Create a UnicodeString from a UTF-8 string. Illegal input is replaced with U+FFFD. Otherwise, errors result in a bogus string. Calls u_strFromUTF8WithSub().
- Parameters
-
utf8 UTF-8 input string. Note that a StringPiece can be implicitly constructed from a std::string or a NUL-terminated const char * string.
- Returns
- A UnicodeString with equivalent UTF-16 contents.
- See also
- toUTF8
- toUTF8String ICU 4.2
◆ fromUTF8() [2/3]
|
static |
Create a UnicodeString from a UTF-8 string. Illegal input is replaced with U+FFFD. Otherwise, errors result in a bogus string. Calls u_strFromUTF8WithSub().
- Parameters
-
utf8 UTF-8 input string. Note that a StringPiece can be implicitly constructed from a std::string or a NUL-terminated const char * string.
- Returns
- A UnicodeString with equivalent UTF-16 contents.
- See also
- toUTF8
- toUTF8String ICU 4.2
◆ fromUTF8() [3/3]
|
static |
Create a UnicodeString from a UTF-8 string. Illegal input is replaced with U+FFFD. Otherwise, errors result in a bogus string. Calls u_strFromUTF8WithSub().
- Parameters
-
utf8 UTF-8 input string. Note that a StringPiece can be implicitly constructed from a std::string or a NUL-terminated const char * string.
- Returns
- A UnicodeString with equivalent UTF-16 contents.
- See also
- toUTF8
- toUTF8String ICU 4.2
◆ getBuffer() [1/6]
Get a read/write pointer to the internal buffer. The buffer is guaranteed to be large enough for at least minCapacity UChars, writable, and is still owned by the UnicodeString object. Calls to getBuffer(minCapacity) must not be nested, and must be matched with calls to releaseBuffer(newLength). If the string buffer was read-only or shared, then it will be reallocated and copied.
An attempted nested call will return 0, and will not further modify the state of the UnicodeString object. It also returns 0 if the string is bogus.
The actual capacity of the string buffer may be larger than minCapacity. getCapacity() returns the actual capacity. For many operations, the full capacity should be used to avoid reallocations.
While the buffer is "open" between getBuffer(minCapacity) and releaseBuffer(newLength), the following applies:
- The string length is set to 0.
- Any read API call on the UnicodeString object will behave like on a 0-length string.
- Any write API call on the UnicodeString object is disallowed and will have no effect.
- You can read from and write to the returned buffer.
- The previous string contents will still be in the buffer; if you want to use it, then you need to call length() before getBuffer(minCapacity). If the length() was greater than minCapacity, then any contents after minCapacity may be lost. The buffer contents is not NUL-terminated by getBuffer(). If length()<getCapacity() then you can terminate it by writing a NUL at index length().
- You must call releaseBuffer(newLength) before and in order to return to normal UnicodeString operation.
- Parameters
-
minCapacity the minimum number of UChars that are to be available in the buffer, starting at the returned pointer; default to the current string capacity if minCapacity==-1
- Returns
- a writable pointer to the internal string buffer, or 0 if an error occurs (nested calls, out of memory)
- See also
- releaseBuffer
- getTerminatedBuffer() ICU 2.0
◆ getBuffer() [2/6]
Get a read/write pointer to the internal buffer. The buffer is guaranteed to be large enough for at least minCapacity UChars, writable, and is still owned by the UnicodeString object. Calls to getBuffer(minCapacity) must not be nested, and must be matched with calls to releaseBuffer(newLength). If the string buffer was read-only or shared, then it will be reallocated and copied.
An attempted nested call will return 0, and will not further modify the state of the UnicodeString object. It also returns 0 if the string is bogus.
The actual capacity of the string buffer may be larger than minCapacity. getCapacity() returns the actual capacity. For many operations, the full capacity should be used to avoid reallocations.
While the buffer is "open" between getBuffer(minCapacity) and releaseBuffer(newLength), the following applies:
- The string length is set to 0.
- Any read API call on the UnicodeString object will behave like on a 0-length string.
- Any write API call on the UnicodeString object is disallowed and will have no effect.
- You can read from and write to the returned buffer.
- The previous string contents will still be in the buffer; if you want to use it, then you need to call length() before getBuffer(minCapacity). If the length() was greater than minCapacity, then any contents after minCapacity may be lost. The buffer contents is not NUL-terminated by getBuffer(). If length()<getCapacity() then you can terminate it by writing a NUL at index length().
- You must call releaseBuffer(newLength) before and in order to return to normal UnicodeString operation.
- Parameters
-
minCapacity the minimum number of UChars that are to be available in the buffer, starting at the returned pointer; default to the current string capacity if minCapacity==-1
- Returns
- a writable pointer to the internal string buffer, or 0 if an error occurs (nested calls, out of memory)
- See also
- releaseBuffer
- getTerminatedBuffer() ICU 2.0
◆ getBuffer() [3/6]
Get a read/write pointer to the internal buffer. The buffer is guaranteed to be large enough for at least minCapacity UChars, writable, and is still owned by the UnicodeString object. Calls to getBuffer(minCapacity) must not be nested, and must be matched with calls to releaseBuffer(newLength). If the string buffer was read-only or shared, then it will be reallocated and copied.
An attempted nested call will return 0, and will not further modify the state of the UnicodeString object. It also returns 0 if the string is bogus.
The actual capacity of the string buffer may be larger than minCapacity. getCapacity() returns the actual capacity. For many operations, the full capacity should be used to avoid reallocations.
While the buffer is "open" between getBuffer(minCapacity) and releaseBuffer(newLength), the following applies:
- The string length is set to 0.
- Any read API call on the UnicodeString object will behave like on a 0-length string.
- Any write API call on the UnicodeString object is disallowed and will have no effect.
- You can read from and write to the returned buffer.
- The previous string contents will still be in the buffer; if you want to use it, then you need to call length() before getBuffer(minCapacity). If the length() was greater than minCapacity, then any contents after minCapacity may be lost. The buffer contents is not NUL-terminated by getBuffer(). If length()<getCapacity() then you can terminate it by writing a NUL at index length().
- You must call releaseBuffer(newLength) before and in order to return to normal UnicodeString operation.
- Parameters
-
minCapacity the minimum number of UChars that are to be available in the buffer, starting at the returned pointer; default to the current string capacity if minCapacity==-1
- Returns
- a writable pointer to the internal string buffer, or 0 if an error occurs (nested calls, out of memory)
- See also
- releaseBuffer
- getTerminatedBuffer() ICU 2.0
◆ getBuffer() [4/6]
|
inline |
Get a read-only pointer to the internal buffer. This can be called at any time on a valid UnicodeString.
It returns 0 if the string is bogus, or during an "open" getBuffer(minCapacity).
It can be called as many times as desired. The pointer that it returns will remain valid until the UnicodeString object is modified, at which time the pointer is semantically invalidated and must not be used any more.
The capacity of the buffer can be determined with getCapacity(). The part after length() may or may not be initialized and valid, depending on the history of the UnicodeString object.
The buffer contents is (probably) not NUL-terminated. You can check if it is with (s.length()<s.getCapacity() && buffer[s.length()]==0). (See getTerminatedBuffer().)
The buffer may reside in read-only memory. Its contents must not be modified.
- Returns
- a read-only pointer to the internal string buffer, or 0 if the string is empty or bogus
- See also
- getBuffer(int32_t minCapacity)
- getTerminatedBuffer() ICU 2.0
◆ getBuffer() [5/6]
|
inline |
Get a read-only pointer to the internal buffer. This can be called at any time on a valid UnicodeString.
It returns 0 if the string is bogus, or during an "open" getBuffer(minCapacity).
It can be called as many times as desired. The pointer that it returns will remain valid until the UnicodeString object is modified, at which time the pointer is semantically invalidated and must not be used any more.
The capacity of the buffer can be determined with getCapacity(). The part after length() may or may not be initialized and valid, depending on the history of the UnicodeString object.
The buffer contents is (probably) not NUL-terminated. You can check if it is with (s.length()<s.getCapacity() && buffer[s.length()]==0). (See getTerminatedBuffer().)
The buffer may reside in read-only memory. Its contents must not be modified.
- Returns
- a read-only pointer to the internal string buffer, or 0 if the string is empty or bogus
- See also
- getBuffer(int32_t minCapacity)
- getTerminatedBuffer() ICU 2.0
◆ getBuffer() [6/6]
|
inline |
Get a read-only pointer to the internal buffer. This can be called at any time on a valid UnicodeString.
It returns 0 if the string is bogus, or during an "open" getBuffer(minCapacity).
It can be called as many times as desired. The pointer that it returns will remain valid until the UnicodeString object is modified, at which time the pointer is semantically invalidated and must not be used any more.
The capacity of the buffer can be determined with getCapacity(). The part after length() may or may not be initialized and valid, depending on the history of the UnicodeString object.
The buffer contents is (probably) not NUL-terminated. You can check if it is with (s.length()<s.getCapacity() && buffer[s.length()]==0). (See getTerminatedBuffer().)
The buffer may reside in read-only memory. Its contents must not be modified.
- Returns
- a read-only pointer to the internal string buffer, or 0 if the string is empty or bogus
- See also
- getBuffer(int32_t minCapacity)
- getTerminatedBuffer() ICU 2.0
◆ getCapacity() [1/3]
Return the capacity of the internal buffer of the UnicodeString object. This is useful together with the getBuffer functions. See there for details.
- Returns
- the number of UChars available in the internal buffer
- See also
- getBuffer ICU 2.0
◆ getCapacity() [2/3]
Return the capacity of the internal buffer of the UnicodeString object. This is useful together with the getBuffer functions. See there for details.
- Returns
- the number of UChars available in the internal buffer
- See also
- getBuffer ICU 2.0
◆ getCapacity() [3/3]
Return the capacity of the internal buffer of the UnicodeString object. This is useful together with the getBuffer functions. See there for details.
- Returns
- the number of UChars available in the internal buffer
- See also
- getBuffer ICU 2.0
◆ getChar32At() [1/3]
The change in Replaceable to use virtual getChar32At() allows UnicodeString::char32At() to be inline again (see jitterbug 709). ICU 2.4
Implements Replaceable.
◆ getChar32At() [2/3]
The change in Replaceable to use virtual getChar32At() allows UnicodeString::char32At() to be inline again (see jitterbug 709). ICU 2.4
Implements Replaceable.
◆ getChar32At() [3/3]
The change in Replaceable to use virtual getChar32At() allows UnicodeString::char32At() to be inline again (see jitterbug 709). ICU 2.4
Implements Replaceable.
◆ getChar32Limit() [1/3]
Adjust a random-access offset so that it points behind a Unicode character. The offset that is passed in points behind any code unit of a code point, while the returned offset will point behind the last code unit of the same code point. In UTF-16, if the input offset points behind the first surrogate (i.e., to the second surrogate) of a surrogate pair, then the returned offset will point behind the second surrogate (i.e., to the first surrogate).
- Parameters
-
offset a valid offset after any code unit of a code point of the text
- Returns
- offset of the first code unit after the same code point
- See also
- U16_SET_CP_LIMIT ICU 2.0
◆ getChar32Limit() [2/3]
Adjust a random-access offset so that it points behind a Unicode character. The offset that is passed in points behind any code unit of a code point, while the returned offset will point behind the last code unit of the same code point. In UTF-16, if the input offset points behind the first surrogate (i.e., to the second surrogate) of a surrogate pair, then the returned offset will point behind the second surrogate (i.e., to the first surrogate).
- Parameters
-
offset a valid offset after any code unit of a code point of the text
- Returns
- offset of the first code unit after the same code point
- See also
- U16_SET_CP_LIMIT ICU 2.0
◆ getChar32Limit() [3/3]
Adjust a random-access offset so that it points behind a Unicode character. The offset that is passed in points behind any code unit of a code point, while the returned offset will point behind the last code unit of the same code point. In UTF-16, if the input offset points behind the first surrogate (i.e., to the second surrogate) of a surrogate pair, then the returned offset will point behind the second surrogate (i.e., to the first surrogate).
- Parameters
-
offset a valid offset after any code unit of a code point of the text
- Returns
- offset of the first code unit after the same code point
- See also
- U16_SET_CP_LIMIT ICU 2.0
◆ getChar32Start() [1/3]
Adjust a random-access offset so that it points to the beginning of a Unicode character. The offset that is passed in points to any code unit of a code point, while the returned offset will point to the first code unit of the same code point. In UTF-16, if the input offset points to a second surrogate of a surrogate pair, then the returned offset will point to the first surrogate.
- Parameters
-
offset a valid offset into one code point of the text
- Returns
- offset of the first code unit of the same code point
- See also
- U16_SET_CP_START ICU 2.0
◆ getChar32Start() [2/3]
Adjust a random-access offset so that it points to the beginning of a Unicode character. The offset that is passed in points to any code unit of a code point, while the returned offset will point to the first code unit of the same code point. In UTF-16, if the input offset points to a second surrogate of a surrogate pair, then the returned offset will point to the first surrogate.
- Parameters
-
offset a valid offset into one code point of the text
- Returns
- offset of the first code unit of the same code point
- See also
- U16_SET_CP_START ICU 2.0
◆ getChar32Start() [3/3]
Adjust a random-access offset so that it points to the beginning of a Unicode character. The offset that is passed in points to any code unit of a code point, while the returned offset will point to the first code unit of the same code point. In UTF-16, if the input offset points to a second surrogate of a surrogate pair, then the returned offset will point to the first surrogate.
- Parameters
-
offset a valid offset into one code point of the text
- Returns
- offset of the first code unit of the same code point
- See also
- U16_SET_CP_START ICU 2.0
◆ getCharAt() [1/3]
The change in Replaceable to use virtual getCharAt() allows UnicodeString::charAt() to be inline again (see jitterbug 709). ICU 2.4
Implements Replaceable.
◆ getCharAt() [2/3]
The change in Replaceable to use virtual getCharAt() allows UnicodeString::charAt() to be inline again (see jitterbug 709). ICU 2.4
Implements Replaceable.
◆ getCharAt() [3/3]
The change in Replaceable to use virtual getCharAt() allows UnicodeString::charAt() to be inline again (see jitterbug 709). ICU 2.4
Implements Replaceable.
◆ getDynamicClassID() [1/3]
|
virtual |
◆ getDynamicClassID() [2/3]
|
virtual |
◆ getDynamicClassID() [3/3]
|
virtual |
◆ getLength() [1/3]
|
protectedvirtual |
Implement Replaceable::getLength() (see jitterbug 1027). ICU 2.4
Implements Replaceable.
◆ getLength() [2/3]
|
protectedvirtual |
Implement Replaceable::getLength() (see jitterbug 1027). ICU 2.4
Implements Replaceable.
◆ getLength() [3/3]
|
protectedvirtual |
Implement Replaceable::getLength() (see jitterbug 1027). ICU 2.4
Implements Replaceable.
◆ getStaticClassID() [1/3]
ICU "poor man's RTTI", returns a UClassID for this class.
ICU 2.2
◆ getStaticClassID() [2/3]
ICU "poor man's RTTI", returns a UClassID for this class.
ICU 2.2
◆ getStaticClassID() [3/3]
ICU "poor man's RTTI", returns a UClassID for this class.
ICU 2.2
◆ getTerminatedBuffer() [1/3]
| const UChar* UnicodeString::getTerminatedBuffer | ( | ) |
Get a read-only pointer to the internal buffer, making sure that it is NUL-terminated. This can be called at any time on a valid UnicodeString.
It returns 0 if the string is bogus, or during an "open" getBuffer(minCapacity), or if the buffer cannot be NUL-terminated (because memory allocation failed).
It can be called as many times as desired. The pointer that it returns will remain valid until the UnicodeString object is modified, at which time the pointer is semantically invalidated and must not be used any more.
The capacity of the buffer can be determined with getCapacity(). The part after length()+1 may or may not be initialized and valid, depending on the history of the UnicodeString object.
The buffer contents is guaranteed to be NUL-terminated. getTerminatedBuffer() may reallocate the buffer if a terminating NUL is written. For this reason, this function is not const, unlike getBuffer(). Note that a UnicodeString may also contain NUL characters as part of its contents.
The buffer may reside in read-only memory. Its contents must not be modified.
- Returns
- a read-only pointer to the internal string buffer, or 0 if the string is empty or bogus
- See also
- getBuffer(int32_t minCapacity)
- getBuffer() ICU 2.2
◆ getTerminatedBuffer() [2/3]
| const UChar* UnicodeString::getTerminatedBuffer | ( | ) |
Get a read-only pointer to the internal buffer, making sure that it is NUL-terminated. This can be called at any time on a valid UnicodeString.
It returns 0 if the string is bogus, or during an "open" getBuffer(minCapacity), or if the buffer cannot be NUL-terminated (because memory allocation failed).
It can be called as many times as desired. The pointer that it returns will remain valid until the UnicodeString object is modified, at which time the pointer is semantically invalidated and must not be used any more.
The capacity of the buffer can be determined with getCapacity(). The part after length()+1 may or may not be initialized and valid, depending on the history of the UnicodeString object.
The buffer contents is guaranteed to be NUL-terminated. getTerminatedBuffer() may reallocate the buffer if a terminating NUL is written. For this reason, this function is not const, unlike getBuffer(). Note that a UnicodeString may also contain NUL characters as part of its contents.
The buffer may reside in read-only memory. Its contents must not be modified.
- Returns
- a read-only pointer to the internal string buffer, or 0 if the string is empty or bogus
- See also
- getBuffer(int32_t minCapacity)
- getBuffer() ICU 2.2
◆ getTerminatedBuffer() [3/3]
| const UChar* UnicodeString::getTerminatedBuffer | ( | ) |
Get a read-only pointer to the internal buffer, making sure that it is NUL-terminated. This can be called at any time on a valid UnicodeString.
It returns 0 if the string is bogus, or during an "open" getBuffer(minCapacity), or if the buffer cannot be NUL-terminated (because memory allocation failed).
It can be called as many times as desired. The pointer that it returns will remain valid until the UnicodeString object is modified, at which time the pointer is semantically invalidated and must not be used any more.
The capacity of the buffer can be determined with getCapacity(). The part after length()+1 may or may not be initialized and valid, depending on the history of the UnicodeString object.
The buffer contents is guaranteed to be NUL-terminated. getTerminatedBuffer() may reallocate the buffer if a terminating NUL is written. For this reason, this function is not const, unlike getBuffer(). Note that a UnicodeString may also contain NUL characters as part of its contents.
The buffer may reside in read-only memory. Its contents must not be modified.
- Returns
- a read-only pointer to the internal string buffer, or 0 if the string is empty or bogus
- See also
- getBuffer(int32_t minCapacity)
- getBuffer() ICU 2.2
◆ handleReplaceBetween() [1/3]
|
virtual |
Replace a substring of this object with the given text.
- Parameters
-
start the beginning index, inclusive; 0 <= start <= limit.limit the ending index, exclusive; start <= limit <= length().text the text to replace characters starttolimit - 1ICU 2.0
Implements Replaceable.
◆ handleReplaceBetween() [2/3]
|
virtual |
Replace a substring of this object with the given text.
- Parameters
-
start the beginning index, inclusive; 0 <= start <= limit.limit the ending index, exclusive; start <= limit <= length().text the text to replace characters starttolimit - 1ICU 2.0
Implements Replaceable.
◆ handleReplaceBetween() [3/3]
|
virtual |
Replace a substring of this object with the given text.
- Parameters
-
start the beginning index, inclusive; 0 <= start <= limit.limit the ending index, exclusive; start <= limit <= length().text the text to replace characters starttolimit - 1ICU 2.0
Implements Replaceable.
◆ hashCode() [1/3]
Generate a hash code for this object.
- Returns
- The hash code of this UnicodeString. ICU 2.0
◆ hashCode() [2/3]
Generate a hash code for this object.
- Returns
- The hash code of this UnicodeString. ICU 2.0
◆ hashCode() [3/3]
Generate a hash code for this object.
- Returns
- The hash code of this UnicodeString. ICU 2.0
◆ hasMetaData() [1/3]
|
virtual |
◆ hasMetaData() [2/3]
|
virtual |
◆ hasMetaData() [3/3]
|
virtual |
◆ hasMoreChar32Than() [1/3]
Check if the length UChar code units of the string contain more Unicode code points than a certain number. This is more efficient than counting all code points in this part of the string and comparing that number with a threshold. This function may not need to scan the string at all if the length falls within a certain range, and never needs to count more than 'number+1' code points. Logically equivalent to (countChar32(start, length)>number). A Unicode code point may occupy either one or two UChar code units.
- Parameters
-
start the index of the first code unit to check (0 for the entire string) length the number of UChar code units to check (use INT32_MAX for the entire string; remember that start/length values are pinned) number The number of code points in the (sub)string is compared against the 'number' parameter.
- Returns
- Boolean value for whether the string contains more Unicode code points than 'number'. Same as (u_countChar32(s, length)>number).
- See also
- countChar32
- u_strHasMoreChar32Than ICU 2.4
◆ hasMoreChar32Than() [2/3]
Check if the length UChar code units of the string contain more Unicode code points than a certain number. This is more efficient than counting all code points in this part of the string and comparing that number with a threshold. This function may not need to scan the string at all if the length falls within a certain range, and never needs to count more than 'number+1' code points. Logically equivalent to (countChar32(start, length)>number). A Unicode code point may occupy either one or two UChar code units.
- Parameters
-
start the index of the first code unit to check (0 for the entire string) length the number of UChar code units to check (use INT32_MAX for the entire string; remember that start/length values are pinned) number The number of code points in the (sub)string is compared against the 'number' parameter.
- Returns
- Boolean value for whether the string contains more Unicode code points than 'number'. Same as (u_countChar32(s, length)>number).
- See also
- countChar32
- u_strHasMoreChar32Than ICU 2.4
◆ hasMoreChar32Than() [3/3]
Check if the length UChar code units of the string contain more Unicode code points than a certain number. This is more efficient than counting all code points in this part of the string and comparing that number with a threshold. This function may not need to scan the string at all if the length falls within a certain range, and never needs to count more than 'number+1' code points. Logically equivalent to (countChar32(start, length)>number). A Unicode code point may occupy either one or two UChar code units.
- Parameters
-
start the index of the first code unit to check (0 for the entire string) length the number of UChar code units to check (use INT32_MAX for the entire string; remember that start/length values are pinned) number The number of code points in the (sub)string is compared against the 'number' parameter.
- Returns
- Boolean value for whether the string contains more Unicode code points than 'number'. Same as (u_countChar32(s, length)>number).
- See also
- countChar32
- u_strHasMoreChar32Than ICU 2.4
◆ indexOf() [1/39]
|
inline |
◆ indexOf() [2/39]
|
inline |
◆ indexOf() [3/39]
|
inline |
◆ indexOf() [4/39]
|
inline |
◆ indexOf() [5/39]
|
inline |
◆ indexOf() [6/39]
|
inline |
◆ indexOf() [7/39]
|
inline |
Locate in this the first occurrence in the range [start, start + length) of the characters in text, using bitwise comparison.
- Parameters
-
text The text to search for. start The offset at which searching will start. length The number of characters to search
- Returns
- The offset into this of the start of
text, or -1 if not found. ICU 2.0
◆ indexOf() [8/39]
|
inline |
Locate in this the first occurrence in the range [start, start + length) of the characters in text, using bitwise comparison.
- Parameters
-
text The text to search for. start The offset at which searching will start. length The number of characters to search
- Returns
- The offset into this of the start of
text, or -1 if not found. ICU 2.0
◆ indexOf() [9/39]
|
inline |
Locate in this the first occurrence in the range [start, start + length) of the characters in text, using bitwise comparison.
- Parameters
-
text The text to search for. start The offset at which searching will start. length The number of characters to search
- Returns
- The offset into this of the start of
text, or -1 if not found. ICU 2.0
◆ indexOf() [10/39]
|
inline |
Locate in this the first occurrence in the range [start, start + length) of the characters in srcText in the range [srcStart, srcStart + srcLength), using bitwise comparison.
- Parameters
-
srcText The text to search for. srcStart the offset into srcTextat which to start matchingsrcLength the number of characters in srcTextto matchstart the offset into this at which to start matching length the number of characters in this to search
- Returns
- The offset into this of the start of
text, or -1 if not found. ICU 2.0
◆ indexOf() [11/39]
|
inline |
Locate in this the first occurrence in the range [start, start + length) of the characters in srcText in the range [srcStart, srcStart + srcLength), using bitwise comparison.
- Parameters
-
srcText The text to search for. srcStart the offset into srcTextat which to start matchingsrcLength the number of characters in srcTextto matchstart the offset into this at which to start matching length the number of characters in this to search
- Returns
- The offset into this of the start of
text, or -1 if not found. ICU 2.0
◆ indexOf() [12/39]
|
inline |
Locate in this the first occurrence in the range [start, start + length) of the characters in srcText in the range [srcStart, srcStart + srcLength), using bitwise comparison.
- Parameters
-
srcText The text to search for. srcStart the offset into srcTextat which to start matchingsrcLength the number of characters in srcTextto matchstart the offset into this at which to start matching length the number of characters in this to search
- Returns
- The offset into this of the start of
text, or -1 if not found. ICU 2.0
◆ indexOf() [13/39]
|
inline |
Locate in this the first occurrence of the characters in srcChars starting at offset start, using bitwise comparison.
- Parameters
-
srcChars The text to search for. srcLength the number of characters in srcCharsto matchstart the offset into this at which to start matching
- Returns
- The offset into this of the start of
text, or -1 if not found. ICU 2.0
◆ indexOf() [14/39]
|
inline |
Locate in this the first occurrence of the characters in srcChars starting at offset start, using bitwise comparison.
- Parameters
-
srcChars The text to search for. srcLength the number of characters in srcCharsto matchstart the offset into this at which to start matching
- Returns
- The offset into this of the start of
text, or -1 if not found. ICU 2.0
◆ indexOf() [15/39]
|
inline |
Locate in this the first occurrence of the characters in srcChars starting at offset start, using bitwise comparison.
- Parameters
-
srcChars The text to search for. srcLength the number of characters in srcCharsto matchstart the offset into this at which to start matching
- Returns
- The offset into this of the start of
text, or -1 if not found. ICU 2.0
◆ indexOf() [16/39]
|
inline |
Locate in this the first occurrence in the range [start, start + length) of the characters in srcChars, using bitwise comparison.
- Parameters
-
srcChars The text to search for. srcLength the number of characters in srcCharsstart The offset at which searching will start. length The number of characters to search
- Returns
- The offset into this of the start of
srcChars, or -1 if not found. ICU 2.0
◆ indexOf() [17/39]
|
inline |
Locate in this the first occurrence in the range [start, start + length) of the characters in srcChars, using bitwise comparison.
- Parameters
-
srcChars The text to search for. srcLength the number of characters in srcCharsstart The offset at which searching will start. length The number of characters to search
- Returns
- The offset into this of the start of
srcChars, or -1 if not found. ICU 2.0
◆ indexOf() [18/39]
|
inline |
Locate in this the first occurrence in the range [start, start + length) of the characters in srcChars, using bitwise comparison.
- Parameters
-
srcChars The text to search for. srcLength the number of characters in srcCharsstart The offset at which searching will start. length The number of characters to search
- Returns
- The offset into this of the start of
srcChars, or -1 if not found. ICU 2.0
◆ indexOf() [19/39]
| int32_t UnicodeString::indexOf | ( | const UChar * | srcChars, |
| int32_t | srcStart, | ||
| int32_t | srcLength, | ||
| int32_t | start, | ||
| int32_t | length | ||
| ) | const |
Locate in this the first occurrence in the range [start, start + length) of the characters in srcChars in the range [srcStart, srcStart + srcLength), using bitwise comparison.
- Parameters
-
srcChars The text to search for. srcStart the offset into srcCharsat which to start matchingsrcLength the number of characters in srcCharsto matchstart the offset into this at which to start matching length the number of characters in this to search
- Returns
- The offset into this of the start of
text, or -1 if not found. ICU 2.0
◆ indexOf() [20/39]
| int32_t UnicodeString::indexOf | ( | const UChar * | srcChars, |
| int32_t | srcStart, | ||
| int32_t | srcLength, | ||
| int32_t | start, | ||
| int32_t | length | ||
| ) | const |
Locate in this the first occurrence in the range [start, start + length) of the characters in srcChars in the range [srcStart, srcStart + srcLength), using bitwise comparison.
- Parameters
-
srcChars The text to search for. srcStart the offset into srcCharsat which to start matchingsrcLength the number of characters in srcCharsto matchstart the offset into this at which to start matching length the number of characters in this to search
- Returns
- The offset into this of the start of
text, or -1 if not found. ICU 2.0
◆ indexOf() [21/39]
| int32_t UnicodeString::indexOf | ( | const UChar * | srcChars, |
| int32_t | srcStart, | ||
| int32_t | srcLength, | ||
| int32_t | start, | ||
| int32_t | length | ||
| ) | const |
Locate in this the first occurrence in the range [start, start + length) of the characters in srcChars in the range [srcStart, srcStart + srcLength), using bitwise comparison.
- Parameters
-
srcChars The text to search for. srcStart the offset into srcCharsat which to start matchingsrcLength the number of characters in srcCharsto matchstart the offset into this at which to start matching length the number of characters in this to search
- Returns
- The offset into this of the start of
text, or -1 if not found. ICU 2.0
◆ indexOf() [22/39]
◆ indexOf() [23/39]
◆ indexOf() [24/39]
◆ indexOf() [25/39]
◆ indexOf() [26/39]
◆ indexOf() [27/39]
◆ indexOf() [28/39]
◆ indexOf() [29/39]
◆ indexOf() [30/39]
◆ indexOf() [31/39]
◆ indexOf() [32/39]
◆ indexOf() [33/39]
◆ indexOf() [34/39]
Locate in this the first occurrence of the BMP code point c in the range [start, start + length), using bitwise comparison.
- Parameters
-
c The code unit to search for. start the offset into this at which to start matching length the number of characters in this to search
- Returns
- The offset into this of
c, or -1 if not found. ICU 2.0
◆ indexOf() [35/39]
Locate in this the first occurrence of the BMP code point c in the range [start, start + length), using bitwise comparison.
- Parameters
-
c The code unit to search for. start the offset into this at which to start matching length the number of characters in this to search
- Returns
- The offset into this of
c, or -1 if not found. ICU 2.0
◆ indexOf() [36/39]
Locate in this the first occurrence of the BMP code point c in the range [start, start + length), using bitwise comparison.
- Parameters
-
c The code unit to search for. start the offset into this at which to start matching length the number of characters in this to search
- Returns
- The offset into this of
c, or -1 if not found. ICU 2.0
◆ indexOf() [37/39]
Locate in this the first occurrence of the code point c in the range [start, start + length), using bitwise comparison.
- Parameters
-
c The code point to search for. start the offset into this at which to start matching length the number of characters in this to search
- Returns
- The offset into this of
c, or -1 if not found. ICU 2.0
◆ indexOf() [38/39]
Locate in this the first occurrence of the code point c in the range [start, start + length), using bitwise comparison.
- Parameters
-
c The code point to search for. start the offset into this at which to start matching length the number of characters in this to search
- Returns
- The offset into this of
c, or -1 if not found. ICU 2.0
◆ indexOf() [39/39]
Locate in this the first occurrence of the code point c in the range [start, start + length), using bitwise comparison.
- Parameters
-
c The code point to search for. start the offset into this at which to start matching length the number of characters in this to search
- Returns
- The offset into this of
c, or -1 if not found. ICU 2.0
◆ insert() [1/18]
|
inline |
Insert the characters in srcText in the range [srcStart, srcStart + srcLength) into the UnicodeString object at offset start. srcText is not modified.
- Parameters
-
start the offset where the insertion begins srcText the source for the new characters srcStart the offset into srcTextwhere new characters will be obtainedsrcLength the number of characters in srcTextin the insert string
- Returns
- a reference to this ICU 2.0
◆ insert() [2/18]
|
inline |
Insert the characters in srcText in the range [srcStart, srcStart + srcLength) into the UnicodeString object at offset start. srcText is not modified.
- Parameters
-
start the offset where the insertion begins srcText the source for the new characters srcStart the offset into srcTextwhere new characters will be obtainedsrcLength the number of characters in srcTextin the insert string
- Returns
- a reference to this ICU 2.0
◆ insert() [3/18]
|
inline |
Insert the characters in srcText in the range [srcStart, srcStart + srcLength) into the UnicodeString object at offset start. srcText is not modified.
- Parameters
-
start the offset where the insertion begins srcText the source for the new characters srcStart the offset into srcTextwhere new characters will be obtainedsrcLength the number of characters in srcTextin the insert string
- Returns
- a reference to this ICU 2.0
◆ insert() [4/18]
|
inline |
Insert the characters in srcText into the UnicodeString object at offset start. srcText is not modified.
- Parameters
-
start the offset where the insertion begins srcText the source for the new characters
- Returns
- a reference to this ICU 2.0
◆ insert() [5/18]
|
inline |
Insert the characters in srcText into the UnicodeString object at offset start. srcText is not modified.
- Parameters
-
start the offset where the insertion begins srcText the source for the new characters
- Returns
- a reference to this ICU 2.0
◆ insert() [6/18]
|
inline |
Insert the characters in srcText into the UnicodeString object at offset start. srcText is not modified.
- Parameters
-
start the offset where the insertion begins srcText the source for the new characters
- Returns
- a reference to this ICU 2.0
◆ insert() [7/18]
|
inline |
Insert the characters in srcChars in the range [srcStart, srcStart + srcLength) into the UnicodeString object at offset start. srcChars is not modified.
- Parameters
-
start the offset at which the insertion begins srcChars the source for the new characters srcStart the offset into srcCharswhere new characters will be obtainedsrcLength the number of characters in srcCharsin the insert string
- Returns
- a reference to this ICU 2.0
◆ insert() [8/18]
|
inline |
Insert the characters in srcChars in the range [srcStart, srcStart + srcLength) into the UnicodeString object at offset start. srcChars is not modified.
- Parameters
-
start the offset at which the insertion begins srcChars the source for the new characters srcStart the offset into srcCharswhere new characters will be obtainedsrcLength the number of characters in srcCharsin the insert string
- Returns
- a reference to this ICU 2.0
◆ insert() [9/18]
|
inline |
Insert the characters in srcChars in the range [srcStart, srcStart + srcLength) into the UnicodeString object at offset start. srcChars is not modified.
- Parameters
-
start the offset at which the insertion begins srcChars the source for the new characters srcStart the offset into srcCharswhere new characters will be obtainedsrcLength the number of characters in srcCharsin the insert string
- Returns
- a reference to this ICU 2.0
◆ insert() [10/18]
|
inline |
Insert the characters in srcChars into the UnicodeString object at offset start. srcChars is not modified.
- Parameters
-
start the offset where the insertion begins srcChars the source for the new characters srcLength the number of Unicode characters in srcChars.
- Returns
- a reference to this ICU 2.0
◆ insert() [11/18]
|
inline |
Insert the characters in srcChars into the UnicodeString object at offset start. srcChars is not modified.
- Parameters
-
start the offset where the insertion begins srcChars the source for the new characters srcLength the number of Unicode characters in srcChars.
- Returns
- a reference to this ICU 2.0
◆ insert() [12/18]
|
inline |
Insert the characters in srcChars into the UnicodeString object at offset start. srcChars is not modified.
- Parameters
-
start the offset where the insertion begins srcChars the source for the new characters srcLength the number of Unicode characters in srcChars.
- Returns
- a reference to this ICU 2.0
◆ insert() [13/18]
|
inline |
Insert the code unit srcChar into the UnicodeString object at offset start.
- Parameters
-
start the offset at which the insertion occurs srcChar the code unit to insert
- Returns
- a reference to this ICU 2.0
◆ insert() [14/18]
|
inline |
Insert the code unit srcChar into the UnicodeString object at offset start.
- Parameters
-
start the offset at which the insertion occurs srcChar the code unit to insert
- Returns
- a reference to this ICU 2.0
◆ insert() [15/18]
|
inline |
Insert the code unit srcChar into the UnicodeString object at offset start.
- Parameters
-
start the offset at which the insertion occurs srcChar the code unit to insert
- Returns
- a reference to this ICU 2.0
◆ insert() [16/18]
|
inline |
Insert the code point srcChar into the UnicodeString object at offset start.
- Parameters
-
start the offset at which the insertion occurs srcChar the code point to insert
- Returns
- a reference to this ICU 2.0
◆ insert() [17/18]
|
inline |
Insert the code point srcChar into the UnicodeString object at offset start.
- Parameters
-
start the offset at which the insertion occurs srcChar the code point to insert
- Returns
- a reference to this ICU 2.0
◆ insert() [18/18]
|
inline |
Insert the code point srcChar into the UnicodeString object at offset start.
- Parameters
-
start the offset at which the insertion occurs srcChar the code point to insert
- Returns
- a reference to this ICU 2.0
◆ isBogus() [1/3]
Determine if this object contains a valid string. A bogus string has no value. It is different from an empty string, although in both cases isEmpty() returns TRUE and length() returns 0. setToBogus() and isBogus() can be used to indicate that no string value is available. For a bogus string, getBuffer() and getTerminatedBuffer() return NULL, and length() returns 0.
- Returns
- TRUE if the string is bogus/invalid, FALSE otherwise
- See also
- setToBogus() ICU 2.0
◆ isBogus() [2/3]
Determine if this object contains a valid string. A bogus string has no value. It is different from an empty string, although in both cases isEmpty() returns TRUE and length() returns 0. setToBogus() and isBogus() can be used to indicate that no string value is available. For a bogus string, getBuffer() and getTerminatedBuffer() return NULL, and length() returns 0.
- Returns
- TRUE if the string is bogus/invalid, FALSE otherwise
- See also
- setToBogus() ICU 2.0
◆ isBogus() [3/3]
Determine if this object contains a valid string. A bogus string has no value. It is different from an empty string, although in both cases isEmpty() returns TRUE and length() returns 0. setToBogus() and isBogus() can be used to indicate that no string value is available. For a bogus string, getBuffer() and getTerminatedBuffer() return NULL, and length() returns 0.
- Returns
- TRUE if the string is bogus/invalid, FALSE otherwise
- See also
- setToBogus() ICU 2.0
◆ isEmpty() [1/3]
Determine if this string is empty.
- Returns
- TRUE if this string contains 0 characters, FALSE otherwise. ICU 2.0
◆ isEmpty() [2/3]
Determine if this string is empty.
- Returns
- TRUE if this string contains 0 characters, FALSE otherwise. ICU 2.0
◆ isEmpty() [3/3]
Determine if this string is empty.
- Returns
- TRUE if this string contains 0 characters, FALSE otherwise. ICU 2.0
◆ lastIndexOf() [1/39]
|
inline |
◆ lastIndexOf() [2/39]
|
inline |
◆ lastIndexOf() [3/39]
|
inline |
◆ lastIndexOf() [4/39]
|
inline |
◆ lastIndexOf() [5/39]
|
inline |
◆ lastIndexOf() [6/39]
|
inline |
◆ lastIndexOf() [7/39]
|
inline |
Locate in this the last occurrence in the range [start, start + length) of the characters in text, using bitwise comparison.
- Parameters
-
text The text to search for. start The offset at which searching will start. length The number of characters to search
- Returns
- The offset into this of the start of
text, or -1 if not found. ICU 2.0
◆ lastIndexOf() [8/39]
|
inline |
Locate in this the last occurrence in the range [start, start + length) of the characters in text, using bitwise comparison.
- Parameters
-
text The text to search for. start The offset at which searching will start. length The number of characters to search
- Returns
- The offset into this of the start of
text, or -1 if not found. ICU 2.0
◆ lastIndexOf() [9/39]
|
inline |
Locate in this the last occurrence in the range [start, start + length) of the characters in text, using bitwise comparison.
- Parameters
-
text The text to search for. start The offset at which searching will start. length The number of characters to search
- Returns
- The offset into this of the start of
text, or -1 if not found. ICU 2.0
◆ lastIndexOf() [10/39]
|
inline |
Locate in this the last occurrence in the range [start, start + length) of the characters in srcText in the range [srcStart, srcStart + srcLength), using bitwise comparison.
- Parameters
-
srcText The text to search for. srcStart the offset into srcTextat which to start matchingsrcLength the number of characters in srcTextto matchstart the offset into this at which to start matching length the number of characters in this to search
- Returns
- The offset into this of the start of
text, or -1 if not found. ICU 2.0
◆ lastIndexOf() [11/39]
|
inline |
Locate in this the last occurrence in the range [start, start + length) of the characters in srcText in the range [srcStart, srcStart + srcLength), using bitwise comparison.
- Parameters
-
srcText The text to search for. srcStart the offset into srcTextat which to start matchingsrcLength the number of characters in srcTextto matchstart the offset into this at which to start matching length the number of characters in this to search
- Returns
- The offset into this of the start of
text, or -1 if not found. ICU 2.0
◆ lastIndexOf() [12/39]
|
inline |
Locate in this the last occurrence in the range [start, start + length) of the characters in srcText in the range [srcStart, srcStart + srcLength), using bitwise comparison.
- Parameters
-
srcText The text to search for. srcStart the offset into srcTextat which to start matchingsrcLength the number of characters in srcTextto matchstart the offset into this at which to start matching length the number of characters in this to search
- Returns
- The offset into this of the start of
text, or -1 if not found. ICU 2.0
◆ lastIndexOf() [13/39]
|
inline |
Locate in this the last occurrence of the characters in srcChars starting at offset start, using bitwise comparison.
- Parameters
-
srcChars The text to search for. srcLength the number of characters in srcCharsto matchstart the offset into this at which to start matching
- Returns
- The offset into this of the start of
text, or -1 if not found. ICU 2.0
◆ lastIndexOf() [14/39]
|
inline |
Locate in this the last occurrence of the characters in srcChars starting at offset start, using bitwise comparison.
- Parameters
-
srcChars The text to search for. srcLength the number of characters in srcCharsto matchstart the offset into this at which to start matching
- Returns
- The offset into this of the start of
text, or -1 if not found. ICU 2.0
◆ lastIndexOf() [15/39]
|
inline |
Locate in this the last occurrence of the characters in srcChars starting at offset start, using bitwise comparison.
- Parameters
-
srcChars The text to search for. srcLength the number of characters in srcCharsto matchstart the offset into this at which to start matching
- Returns
- The offset into this of the start of
text, or -1 if not found. ICU 2.0
◆ lastIndexOf() [16/39]
|
inline |
Locate in this the last occurrence in the range [start, start + length) of the characters in srcChars, using bitwise comparison.
- Parameters
-
srcChars The text to search for. srcLength the number of characters in srcCharsstart The offset at which searching will start. length The number of characters to search
- Returns
- The offset into this of the start of
srcChars, or -1 if not found. ICU 2.0
◆ lastIndexOf() [17/39]
|
inline |
Locate in this the last occurrence in the range [start, start + length) of the characters in srcChars, using bitwise comparison.
- Parameters
-
srcChars The text to search for. srcLength the number of characters in srcCharsstart The offset at which searching will start. length The number of characters to search
- Returns
- The offset into this of the start of
srcChars, or -1 if not found. ICU 2.0
◆ lastIndexOf() [18/39]
|
inline |
Locate in this the last occurrence in the range [start, start + length) of the characters in srcChars, using bitwise comparison.
- Parameters
-
srcChars The text to search for. srcLength the number of characters in srcCharsstart The offset at which searching will start. length The number of characters to search
- Returns
- The offset into this of the start of
srcChars, or -1 if not found. ICU 2.0
◆ lastIndexOf() [19/39]
| int32_t UnicodeString::lastIndexOf | ( | const UChar * | srcChars, |
| int32_t | srcStart, | ||
| int32_t | srcLength, | ||
| int32_t | start, | ||
| int32_t | length | ||
| ) | const |
Locate in this the last occurrence in the range [start, start + length) of the characters in srcChars in the range [srcStart, srcStart + srcLength), using bitwise comparison.
- Parameters
-
srcChars The text to search for. srcStart the offset into srcCharsat which to start matchingsrcLength the number of characters in srcCharsto matchstart the offset into this at which to start matching length the number of characters in this to search
- Returns
- The offset into this of the start of
text, or -1 if not found. ICU 2.0
◆ lastIndexOf() [20/39]
| int32_t UnicodeString::lastIndexOf | ( | const UChar * | srcChars, |
| int32_t | srcStart, | ||
| int32_t | srcLength, | ||
| int32_t | start, | ||
| int32_t | length | ||
| ) | const |
Locate in this the last occurrence in the range [start, start + length) of the characters in srcChars in the range [srcStart, srcStart + srcLength), using bitwise comparison.
- Parameters
-
srcChars The text to search for. srcStart the offset into srcCharsat which to start matchingsrcLength the number of characters in srcCharsto matchstart the offset into this at which to start matching length the number of characters in this to search
- Returns
- The offset into this of the start of
text, or -1 if not found. ICU 2.0
◆ lastIndexOf() [21/39]
| int32_t UnicodeString::lastIndexOf | ( | const UChar * | srcChars, |
| int32_t | srcStart, | ||
| int32_t | srcLength, | ||
| int32_t | start, | ||
| int32_t | length | ||
| ) | const |
Locate in this the last occurrence in the range [start, start + length) of the characters in srcChars in the range [srcStart, srcStart + srcLength), using bitwise comparison.
- Parameters
-
srcChars The text to search for. srcStart the offset into srcCharsat which to start matchingsrcLength the number of characters in srcCharsto matchstart the offset into this at which to start matching length the number of characters in this to search
- Returns
- The offset into this of the start of
text, or -1 if not found. ICU 2.0
◆ lastIndexOf() [22/39]
◆ lastIndexOf() [23/39]
◆ lastIndexOf() [24/39]
◆ lastIndexOf() [25/39]
◆ lastIndexOf() [26/39]
◆ lastIndexOf() [27/39]
◆ lastIndexOf() [28/39]
◆ lastIndexOf() [29/39]
◆ lastIndexOf() [30/39]
◆ lastIndexOf() [31/39]
◆ lastIndexOf() [32/39]
◆ lastIndexOf() [33/39]
◆ lastIndexOf() [34/39]
Locate in this the last occurrence of the BMP code point c in the range [start, start + length), using bitwise comparison.
- Parameters
-
c The code unit to search for. start the offset into this at which to start matching length the number of characters in this to search
- Returns
- The offset into this of
c, or -1 if not found. ICU 2.0
◆ lastIndexOf() [35/39]
Locate in this the last occurrence of the BMP code point c in the range [start, start + length), using bitwise comparison.
- Parameters
-
c The code unit to search for. start the offset into this at which to start matching length the number of characters in this to search
- Returns
- The offset into this of
c, or -1 if not found. ICU 2.0
◆ lastIndexOf() [36/39]
Locate in this the last occurrence of the BMP code point c in the range [start, start + length), using bitwise comparison.
- Parameters
-
c The code unit to search for. start the offset into this at which to start matching length the number of characters in this to search
- Returns
- The offset into this of
c, or -1 if not found. ICU 2.0
◆ lastIndexOf() [37/39]
Locate in this the last occurrence of the code point c in the range [start, start + length), using bitwise comparison.
- Parameters
-
c The code point to search for. start the offset into this at which to start matching length the number of characters in this to search
- Returns
- The offset into this of
c, or -1 if not found. ICU 2.0
◆ lastIndexOf() [38/39]
Locate in this the last occurrence of the code point c in the range [start, start + length), using bitwise comparison.
- Parameters
-
c The code point to search for. start the offset into this at which to start matching length the number of characters in this to search
- Returns
- The offset into this of
c, or -1 if not found. ICU 2.0
◆ lastIndexOf() [39/39]
Locate in this the last occurrence of the code point c in the range [start, start + length), using bitwise comparison.
- Parameters
-
c The code point to search for. start the offset into this at which to start matching length the number of characters in this to search
- Returns
- The offset into this of
c, or -1 if not found. ICU 2.0
◆ length() [1/3]
Return the length of the UnicodeString object. The length is the number of UChar code units are in the UnicodeString. If you want the number of code points, please use countChar32().
- Returns
- the length of the UnicodeString object
- See also
- countChar32 ICU 2.0
◆ length() [2/3]
Return the length of the UnicodeString object. The length is the number of UChar code units are in the UnicodeString. If you want the number of code points, please use countChar32().
- Returns
- the length of the UnicodeString object
- See also
- countChar32 ICU 2.0
◆ length() [3/3]
Return the length of the UnicodeString object. The length is the number of UChar code units are in the UnicodeString. If you want the number of code points, please use countChar32().
- Returns
- the length of the UnicodeString object
- See also
- countChar32 ICU 2.0
◆ moveIndex32() [1/3]
Move the code unit index along the string by delta code points. Interpret the input index as a code unit-based offset into the string, move the index forward or backward by delta code points, and return the resulting index. The input index should point to the first code unit of a code point, if there is more than one.
Both input and output indexes are code unit-based as for all string indexes/offsets in ICU (and other libraries, like MBCS char*). If delta<0 then the index is moved backward (toward the start of the string). If delta>0 then the index is moved forward (toward the end of the string).
This behaves like CharacterIterator::move32(delta, kCurrent).
Behavior for out-of-bounds indexes: moveIndex32 pins the input index to 0..length(), i.e., if the input index<0 then it is pinned to 0; if it is index>length() then it is pinned to length(). Afterwards, the index is moved by delta code points forward or backward, but no further backward than to 0 and no further forward than to length(). The resulting index return value will be in between 0 and length(), inclusively.
Examples:
// s has code points 'a' U+10000 'b' U+10ffff U+2029 UnicodeString s=UNICODE_STRING("a\\U00010000b\\U0010ffff\\u2029", 31).unescape();
// initial index: position of U+10000 int32_t index=1;
// the following examples will all result in index==4, position of U+10ffff
// skip 2 code points from some position in the string index=s.moveIndex32(index, 2); // skips U+10000 and 'b'
// go to the 3rd code point from the start of s (0-based) index=s.moveIndex32(0, 3); // skips 'a', U+10000, and 'b'
// go to the next-to-last code point of s index=s.moveIndex32(s.length(), -2); // backward-skips U+2029 and U+10ffff
- Parameters
-
index input code unit index delta (signed) code point count to move the index forward or backward in the string
- Returns
- the resulting code unit index ICU 2.0
◆ moveIndex32() [2/3]
Move the code unit index along the string by delta code points. Interpret the input index as a code unit-based offset into the string, move the index forward or backward by delta code points, and return the resulting index. The input index should point to the first code unit of a code point, if there is more than one.
Both input and output indexes are code unit-based as for all string indexes/offsets in ICU (and other libraries, like MBCS char*). If delta<0 then the index is moved backward (toward the start of the string). If delta>0 then the index is moved forward (toward the end of the string).
This behaves like CharacterIterator::move32(delta, kCurrent).
Behavior for out-of-bounds indexes: moveIndex32 pins the input index to 0..length(), i.e., if the input index<0 then it is pinned to 0; if it is index>length() then it is pinned to length(). Afterwards, the index is moved by delta code points forward or backward, but no further backward than to 0 and no further forward than to length(). The resulting index return value will be in between 0 and length(), inclusively.
Examples:
// s has code points 'a' U+10000 'b' U+10ffff U+2029 UnicodeString s=UNICODE_STRING("a\\U00010000b\\U0010ffff\\u2029", 31).unescape();
// initial index: position of U+10000 int32_t index=1;
// the following examples will all result in index==4, position of U+10ffff
// skip 2 code points from some position in the string index=s.moveIndex32(index, 2); // skips U+10000 and 'b'
// go to the 3rd code point from the start of s (0-based) index=s.moveIndex32(0, 3); // skips 'a', U+10000, and 'b'
// go to the next-to-last code point of s index=s.moveIndex32(s.length(), -2); // backward-skips U+2029 and U+10ffff
- Parameters
-
index input code unit index delta (signed) code point count to move the index forward or backward in the string
- Returns
- the resulting code unit index ICU 2.0
◆ moveIndex32() [3/3]
Move the code unit index along the string by delta code points. Interpret the input index as a code unit-based offset into the string, move the index forward or backward by delta code points, and return the resulting index. The input index should point to the first code unit of a code point, if there is more than one.
Both input and output indexes are code unit-based as for all string indexes/offsets in ICU (and other libraries, like MBCS char*). If delta<0 then the index is moved backward (toward the start of the string). If delta>0 then the index is moved forward (toward the end of the string).
This behaves like CharacterIterator::move32(delta, kCurrent).
Behavior for out-of-bounds indexes: moveIndex32 pins the input index to 0..length(), i.e., if the input index<0 then it is pinned to 0; if it is index>length() then it is pinned to length(). Afterwards, the index is moved by delta code points forward or backward, but no further backward than to 0 and no further forward than to length(). The resulting index return value will be in between 0 and length(), inclusively.
Examples:
// s has code points 'a' U+10000 'b' U+10ffff U+2029 UnicodeString s=UNICODE_STRING("a\\U00010000b\\U0010ffff\\u2029", 31).unescape();
// initial index: position of U+10000 int32_t index=1;
// the following examples will all result in index==4, position of U+10ffff
// skip 2 code points from some position in the string index=s.moveIndex32(index, 2); // skips U+10000 and 'b'
// go to the 3rd code point from the start of s (0-based) index=s.moveIndex32(0, 3); // skips 'a', U+10000, and 'b'
// go to the next-to-last code point of s index=s.moveIndex32(s.length(), -2); // backward-skips U+2029 and U+10ffff
- Parameters
-
index input code unit index delta (signed) code point count to move the index forward or backward in the string
- Returns
- the resulting code unit index ICU 2.0
◆ operator!=() [1/3]
|
inline |
Inequality operator. Performs only bitwise comparison.
- Parameters
-
text The UnicodeString to compare to this one.
- Returns
- FALSE if
textcontains the same characters as this one, TRUE otherwise. ICU 2.0
◆ operator!=() [2/3]
|
inline |
Inequality operator. Performs only bitwise comparison.
- Parameters
-
text The UnicodeString to compare to this one.
- Returns
- FALSE if
textcontains the same characters as this one, TRUE otherwise. ICU 2.0
◆ operator!=() [3/3]
|
inline |
Inequality operator. Performs only bitwise comparison.
- Parameters
-
text The UnicodeString to compare to this one.
- Returns
- FALSE if
textcontains the same characters as this one, TRUE otherwise. ICU 2.0
◆ operator+=() [1/9]
|
inline |
Append operator. Append the code unit ch to the UnicodeString object.
- Parameters
-
ch the code unit to be appended
- Returns
- a reference to this ICU 2.0
◆ operator+=() [2/9]
|
inline |
Append operator. Append the code unit ch to the UnicodeString object.
- Parameters
-
ch the code unit to be appended
- Returns
- a reference to this ICU 2.0
◆ operator+=() [3/9]
|
inline |
Append operator. Append the code unit ch to the UnicodeString object.
- Parameters
-
ch the code unit to be appended
- Returns
- a reference to this ICU 2.0
◆ operator+=() [4/9]
|
inline |
Append operator. Append the code point ch to the UnicodeString object.
- Parameters
-
ch the code point to be appended
- Returns
- a reference to this ICU 2.0
◆ operator+=() [5/9]
|
inline |
Append operator. Append the code point ch to the UnicodeString object.
- Parameters
-
ch the code point to be appended
- Returns
- a reference to this ICU 2.0
◆ operator+=() [6/9]
|
inline |
Append operator. Append the code point ch to the UnicodeString object.
- Parameters
-
ch the code point to be appended
- Returns
- a reference to this ICU 2.0
◆ operator+=() [7/9]
|
inline |
Append operator. Append the characters in srcText to the UnicodeString object. srcText is not modified.
- Parameters
-
srcText the source for the new characters
- Returns
- a reference to this ICU 2.0
◆ operator+=() [8/9]
|
inline |
Append operator. Append the characters in srcText to the UnicodeString object. srcText is not modified.
- Parameters
-
srcText the source for the new characters
- Returns
- a reference to this ICU 2.0
◆ operator+=() [9/9]
|
inline |
Append operator. Append the characters in srcText to the UnicodeString object. srcText is not modified.
- Parameters
-
srcText the source for the new characters
- Returns
- a reference to this ICU 2.0
◆ operator<() [1/3]
|
inline |
Less than operator. Performs only bitwise comparison.
- Parameters
-
text The UnicodeString to compare to this one.
- Returns
- TRUE if the characters in this are bitwise less than the characters in
text, FALSE otherwise ICU 2.0
◆ operator<() [2/3]
|
inline |
Less than operator. Performs only bitwise comparison.
- Parameters
-
text The UnicodeString to compare to this one.
- Returns
- TRUE if the characters in this are bitwise less than the characters in
text, FALSE otherwise ICU 2.0
◆ operator<() [3/3]
|
inline |
Less than operator. Performs only bitwise comparison.
- Parameters
-
text The UnicodeString to compare to this one.
- Returns
- TRUE if the characters in this are bitwise less than the characters in
text, FALSE otherwise ICU 2.0
◆ operator<=() [1/3]
|
inline |
Less than or equal operator. Performs only bitwise comparison.
- Parameters
-
text The UnicodeString to compare to this one.
- Returns
- TRUE if the characters in this are bitwise less than or equal to the characters in
text, FALSE otherwise ICU 2.0
◆ operator<=() [2/3]
|
inline |
Less than or equal operator. Performs only bitwise comparison.
- Parameters
-
text The UnicodeString to compare to this one.
- Returns
- TRUE if the characters in this are bitwise less than or equal to the characters in
text, FALSE otherwise ICU 2.0
◆ operator<=() [3/3]
|
inline |
Less than or equal operator. Performs only bitwise comparison.
- Parameters
-
text The UnicodeString to compare to this one.
- Returns
- TRUE if the characters in this are bitwise less than or equal to the characters in
text, FALSE otherwise ICU 2.0
◆ operator=() [1/9]
| UnicodeString& UnicodeString::operator= | ( | const UnicodeString & | srcText | ) |
Assignment operator. Replace the characters in this UnicodeString with the characters from srcText.
- Parameters
-
srcText The text containing the characters to replace
- Returns
- a reference to this ICU 2.0
◆ operator=() [2/9]
| UnicodeString& UnicodeString::operator= | ( | const UnicodeString & | srcText | ) |
Assignment operator. Replace the characters in this UnicodeString with the characters from srcText.
- Parameters
-
srcText The text containing the characters to replace
- Returns
- a reference to this ICU 2.0
◆ operator=() [3/9]
| UnicodeString& UnicodeString::operator= | ( | const UnicodeString & | srcText | ) |
Assignment operator. Replace the characters in this UnicodeString with the characters from srcText.
- Parameters
-
srcText The text containing the characters to replace
- Returns
- a reference to this ICU 2.0
◆ operator=() [4/9]
|
inline |
Assignment operator. Replace the characters in this UnicodeString with the code unit ch.
- Parameters
-
ch the code unit to replace
- Returns
- a reference to this ICU 2.0
◆ operator=() [5/9]
|
inline |
Assignment operator. Replace the characters in this UnicodeString with the code unit ch.
- Parameters
-
ch the code unit to replace
- Returns
- a reference to this ICU 2.0
◆ operator=() [6/9]
|
inline |
Assignment operator. Replace the characters in this UnicodeString with the code unit ch.
- Parameters
-
ch the code unit to replace
- Returns
- a reference to this ICU 2.0
◆ operator=() [7/9]
|
inline |
Assignment operator. Replace the characters in this UnicodeString with the code point ch.
- Parameters
-
ch the code point to replace
- Returns
- a reference to this ICU 2.0
◆ operator=() [8/9]
|
inline |
Assignment operator. Replace the characters in this UnicodeString with the code point ch.
- Parameters
-
ch the code point to replace
- Returns
- a reference to this ICU 2.0
◆ operator=() [9/9]
|
inline |
Assignment operator. Replace the characters in this UnicodeString with the code point ch.
- Parameters
-
ch the code point to replace
- Returns
- a reference to this ICU 2.0
◆ operator==() [1/3]
|
inline |
Equality operator. Performs only bitwise comparison.
- Parameters
-
text The UnicodeString to compare to this one.
- Returns
- TRUE if
textcontains the same characters as this one, FALSE otherwise. ICU 2.0
◆ operator==() [2/3]
|
inline |
Equality operator. Performs only bitwise comparison.
- Parameters
-
text The UnicodeString to compare to this one.
- Returns
- TRUE if
textcontains the same characters as this one, FALSE otherwise. ICU 2.0
◆ operator==() [3/3]
|
inline |
Equality operator. Performs only bitwise comparison.
- Parameters
-
text The UnicodeString to compare to this one.
- Returns
- TRUE if
textcontains the same characters as this one, FALSE otherwise. ICU 2.0
◆ operator>() [1/3]
|
inline |
Greater than operator. Performs only bitwise comparison.
- Parameters
-
text The UnicodeString to compare to this one.
- Returns
- TRUE if the characters in this are bitwise greater than the characters in
text, FALSE otherwise ICU 2.0
◆ operator>() [2/3]
|
inline |
Greater than operator. Performs only bitwise comparison.
- Parameters
-
text The UnicodeString to compare to this one.
- Returns
- TRUE if the characters in this are bitwise greater than the characters in
text, FALSE otherwise ICU 2.0
◆ operator>() [3/3]
|
inline |
Greater than operator. Performs only bitwise comparison.
- Parameters
-
text The UnicodeString to compare to this one.
- Returns
- TRUE if the characters in this are bitwise greater than the characters in
text, FALSE otherwise ICU 2.0
◆ operator>=() [1/3]
|
inline |
Greater than or equal operator. Performs only bitwise comparison.
- Parameters
-
text The UnicodeString to compare to this one.
- Returns
- TRUE if the characters in this are bitwise greater than or equal to the characters in
text, FALSE otherwise ICU 2.0
◆ operator>=() [2/3]
|
inline |
Greater than or equal operator. Performs only bitwise comparison.
- Parameters
-
text The UnicodeString to compare to this one.
- Returns
- TRUE if the characters in this are bitwise greater than or equal to the characters in
text, FALSE otherwise ICU 2.0
◆ operator>=() [3/3]
|
inline |
Greater than or equal operator. Performs only bitwise comparison.
- Parameters
-
text The UnicodeString to compare to this one.
- Returns
- TRUE if the characters in this are bitwise greater than or equal to the characters in
text, FALSE otherwise ICU 2.0
◆ operator[]() [1/3]
Return the code unit at offset offset. If the offset is not valid (0..length()-1) then U+ffff is returned.
- Parameters
-
offset a valid offset into the text
- Returns
- the code unit at offset
offsetICU 2.0
◆ operator[]() [2/3]
Return the code unit at offset offset. If the offset is not valid (0..length()-1) then U+ffff is returned.
- Parameters
-
offset a valid offset into the text
- Returns
- the code unit at offset
offsetICU 2.0
◆ operator[]() [3/3]
Return the code unit at offset offset. If the offset is not valid (0..length()-1) then U+ffff is returned.
- Parameters
-
offset a valid offset into the text
- Returns
- the code unit at offset
offsetICU 2.0
◆ padLeading() [1/3]
Pad the start of this UnicodeString with the character padChar. If the length of this UnicodeString is less than targetLength, length() - targetLength copies of padChar will be added to the beginning of this UnicodeString.
- Parameters
-
targetLength the desired length of the string padChar the character to use for padding. Defaults to space (U+0020)
- Returns
- TRUE if the text was padded, FALSE otherwise. ICU 2.0
◆ padLeading() [2/3]
Pad the start of this UnicodeString with the character padChar. If the length of this UnicodeString is less than targetLength, length() - targetLength copies of padChar will be added to the beginning of this UnicodeString.
- Parameters
-
targetLength the desired length of the string padChar the character to use for padding. Defaults to space (U+0020)
- Returns
- TRUE if the text was padded, FALSE otherwise. ICU 2.0
◆ padLeading() [3/3]
Pad the start of this UnicodeString with the character padChar. If the length of this UnicodeString is less than targetLength, length() - targetLength copies of padChar will be added to the beginning of this UnicodeString.
- Parameters
-
targetLength the desired length of the string padChar the character to use for padding. Defaults to space (U+0020)
- Returns
- TRUE if the text was padded, FALSE otherwise. ICU 2.0
◆ padTrailing() [1/3]
Pad the end of this UnicodeString with the character padChar. If the length of this UnicodeString is less than targetLength, length() - targetLength copies of padChar will be added to the end of this UnicodeString.
- Parameters
-
targetLength the desired length of the string padChar the character to use for padding. Defaults to space (U+0020)
- Returns
- TRUE if the text was padded, FALSE otherwise. ICU 2.0
◆ padTrailing() [2/3]
Pad the end of this UnicodeString with the character padChar. If the length of this UnicodeString is less than targetLength, length() - targetLength copies of padChar will be added to the end of this UnicodeString.
- Parameters
-
targetLength the desired length of the string padChar the character to use for padding. Defaults to space (U+0020)
- Returns
- TRUE if the text was padded, FALSE otherwise. ICU 2.0
◆ padTrailing() [3/3]
Pad the end of this UnicodeString with the character padChar. If the length of this UnicodeString is less than targetLength, length() - targetLength copies of padChar will be added to the end of this UnicodeString.
- Parameters
-
targetLength the desired length of the string padChar the character to use for padding. Defaults to space (U+0020)
- Returns
- TRUE if the text was padded, FALSE otherwise. ICU 2.0
◆ releaseBuffer() [1/3]
Release a read/write buffer on a UnicodeString object with an "open" getBuffer(minCapacity). This function must be called in a matched pair with getBuffer(minCapacity). releaseBuffer(newLength) must be called if and only if a getBuffer(minCapacity) is "open".
It will set the string length to newLength, at most to the current capacity. If newLength==-1 then it will set the length according to the first NUL in the buffer, or to the capacity if there is no NUL.
After calling releaseBuffer(newLength) the UnicodeString is back to normal operation.
- Parameters
-
newLength the new length of the UnicodeString object; defaults to the current capacity if newLength is greater than that; if newLength==-1, it defaults to u_strlen(buffer) but not more than the current capacity of the string
- See also
- getBuffer(int32_t minCapacity) ICU 2.0
◆ releaseBuffer() [2/3]
Release a read/write buffer on a UnicodeString object with an "open" getBuffer(minCapacity). This function must be called in a matched pair with getBuffer(minCapacity). releaseBuffer(newLength) must be called if and only if a getBuffer(minCapacity) is "open".
It will set the string length to newLength, at most to the current capacity. If newLength==-1 then it will set the length according to the first NUL in the buffer, or to the capacity if there is no NUL.
After calling releaseBuffer(newLength) the UnicodeString is back to normal operation.
- Parameters
-
newLength the new length of the UnicodeString object; defaults to the current capacity if newLength is greater than that; if newLength==-1, it defaults to u_strlen(buffer) but not more than the current capacity of the string
- See also
- getBuffer(int32_t minCapacity) ICU 2.0
◆ releaseBuffer() [3/3]
Release a read/write buffer on a UnicodeString object with an "open" getBuffer(minCapacity). This function must be called in a matched pair with getBuffer(minCapacity). releaseBuffer(newLength) must be called if and only if a getBuffer(minCapacity) is "open".
It will set the string length to newLength, at most to the current capacity. If newLength==-1 then it will set the length according to the first NUL in the buffer, or to the capacity if there is no NUL.
After calling releaseBuffer(newLength) the UnicodeString is back to normal operation.
- Parameters
-
newLength the new length of the UnicodeString object; defaults to the current capacity if newLength is greater than that; if newLength==-1, it defaults to u_strlen(buffer) but not more than the current capacity of the string
- See also
- getBuffer(int32_t minCapacity) ICU 2.0
◆ remove() [1/6]
|
inline |
Remove all characters from the UnicodeString object.
- Returns
- a reference to this ICU 2.0
◆ remove() [2/6]
|
inline |
Remove all characters from the UnicodeString object.
- Returns
- a reference to this ICU 2.0
◆ remove() [3/6]
|
inline |
Remove all characters from the UnicodeString object.
- Returns
- a reference to this ICU 2.0
◆ remove() [4/6]
|
inline |
Remove the characters in the range [start, start + length) from the UnicodeString object.
- Parameters
-
start the offset of the first character to remove length the number of characters to remove
- Returns
- a reference to this ICU 2.0
◆ remove() [5/6]
|
inline |
Remove the characters in the range [start, start + length) from the UnicodeString object.
- Parameters
-
start the offset of the first character to remove length the number of characters to remove
- Returns
- a reference to this ICU 2.0
◆ remove() [6/6]
|
inline |
Remove the characters in the range [start, start + length) from the UnicodeString object.
- Parameters
-
start the offset of the first character to remove length the number of characters to remove
- Returns
- a reference to this ICU 2.0
◆ removeBetween() [1/3]
|
inline |
Remove the characters in the range [start, limit) from the UnicodeString object.
- Parameters
-
start the offset of the first character to remove limit the offset immediately following the range to remove
- Returns
- a reference to this ICU 2.0
◆ removeBetween() [2/3]
|
inline |
Remove the characters in the range [start, limit) from the UnicodeString object.
- Parameters
-
start the offset of the first character to remove limit the offset immediately following the range to remove
- Returns
- a reference to this ICU 2.0
◆ removeBetween() [3/3]
|
inline |
Remove the characters in the range [start, limit) from the UnicodeString object.
- Parameters
-
start the offset of the first character to remove limit the offset immediately following the range to remove
- Returns
- a reference to this ICU 2.0
◆ replace() [1/18]
| UnicodeString& UnicodeString::replace | ( | int32_t | start, |
| int32_t | length, | ||
| const UnicodeString & | srcText, | ||
| int32_t | srcStart, | ||
| int32_t | srcLength | ||
| ) |
Replace the characters in the range [start, start + length) with the characters in srcText in the range [srcStart, srcStart + srcLength). srcText is not modified.
- Parameters
-
start the offset at which the replace operation begins length the number of characters to replace. The character at start + lengthis not modified.srcText the source for the new characters srcStart the offset into srcTextwhere new characters will be obtainedsrcLength the number of characters in srcTextin the replace string
- Returns
- a reference to this ICU 2.0
◆ replace() [2/18]
| UnicodeString& UnicodeString::replace | ( | int32_t | start, |
| int32_t | length, | ||
| const UnicodeString & | srcText, | ||
| int32_t | srcStart, | ||
| int32_t | srcLength | ||
| ) |
Replace the characters in the range [start, start + length) with the characters in srcText in the range [srcStart, srcStart + srcLength). srcText is not modified.
- Parameters
-
start the offset at which the replace operation begins length the number of characters to replace. The character at start + lengthis not modified.srcText the source for the new characters srcStart the offset into srcTextwhere new characters will be obtainedsrcLength the number of characters in srcTextin the replace string
- Returns
- a reference to this ICU 2.0
◆ replace() [3/18]
|
inline |
Replace the characters in the range [start, start + length) with the characters in srcText in the range [srcStart, srcStart + srcLength). srcText is not modified.
- Parameters
-
start the offset at which the replace operation begins length the number of characters to replace. The character at start + lengthis not modified.srcText the source for the new characters srcStart the offset into srcTextwhere new characters will be obtainedsrcLength the number of characters in srcTextin the replace string
- Returns
- a reference to this ICU 2.0
◆ replace() [4/18]
| UnicodeString& UnicodeString::replace | ( | int32_t | start, |
| int32_t | length, | ||
| const UnicodeString & | srcText | ||
| ) |
Replace the characters in the range [start, start + length) with the characters in srcText. srcText is not modified.
- Parameters
-
start the offset at which the replace operation begins length the number of characters to replace. The character at start + lengthis not modified.srcText the source for the new characters
- Returns
- a reference to this ICU 2.0
◆ replace() [5/18]
| UnicodeString& UnicodeString::replace | ( | int32_t | start, |
| int32_t | length, | ||
| const UnicodeString & | srcText | ||
| ) |
Replace the characters in the range [start, start + length) with the characters in srcText. srcText is not modified.
- Parameters
-
start the offset at which the replace operation begins length the number of characters to replace. The character at start + lengthis not modified.srcText the source for the new characters
- Returns
- a reference to this ICU 2.0
◆ replace() [6/18]
|
inline |
Replace the characters in the range [start, start + length) with the characters in srcText. srcText is not modified.
- Parameters
-
start the offset at which the replace operation begins length the number of characters to replace. The character at start + lengthis not modified.srcText the source for the new characters
- Returns
- a reference to this ICU 2.0
◆ replace() [7/18]
|
inline |
Replace the characters in the range [start, start + length) with the characters in srcChars in the range [srcStart, srcStart + srcLength). srcChars is not modified.
- Parameters
-
start the offset at which the replace operation begins length the number of characters to replace. The character at start + lengthis not modified.srcChars the source for the new characters srcStart the offset into srcCharswhere new characters will be obtainedsrcLength the number of characters in srcCharsin the replace string
- Returns
- a reference to this ICU 2.0
◆ replace() [8/18]
| UnicodeString& UnicodeString::replace | ( | int32_t | start, |
| int32_t | length, | ||
| const UChar * | srcChars, | ||
| int32_t | srcStart, | ||
| int32_t | srcLength | ||
| ) |
Replace the characters in the range [start, start + length) with the characters in srcChars in the range [srcStart, srcStart + srcLength). srcChars is not modified.
- Parameters
-
start the offset at which the replace operation begins length the number of characters to replace. The character at start + lengthis not modified.srcChars the source for the new characters srcStart the offset into srcCharswhere new characters will be obtainedsrcLength the number of characters in srcCharsin the replace string
- Returns
- a reference to this ICU 2.0
◆ replace() [9/18]
| UnicodeString& UnicodeString::replace | ( | int32_t | start, |
| int32_t | length, | ||
| const UChar * | srcChars, | ||
| int32_t | srcStart, | ||
| int32_t | srcLength | ||
| ) |
Replace the characters in the range [start, start + length) with the characters in srcChars in the range [srcStart, srcStart + srcLength). srcChars is not modified.
- Parameters
-
start the offset at which the replace operation begins length the number of characters to replace. The character at start + lengthis not modified.srcChars the source for the new characters srcStart the offset into srcCharswhere new characters will be obtainedsrcLength the number of characters in srcCharsin the replace string
- Returns
- a reference to this ICU 2.0
◆ replace() [10/18]
|
inline |
Replace the characters in the range [start, start + length) with the characters in srcChars. srcChars is not modified.
- Parameters
-
start the offset at which the replace operation begins length number of characters to replace. The character at start + lengthis not modified.srcChars the source for the new characters srcLength the number of Unicode characters in srcChars
- Returns
- a reference to this ICU 2.0
◆ replace() [11/18]
|
inline |
Replace the characters in the range [start, start + length) with the characters in srcChars. srcChars is not modified.
- Parameters
-
start the offset at which the replace operation begins length number of characters to replace. The character at start + lengthis not modified.srcChars the source for the new characters srcLength the number of Unicode characters in srcChars
- Returns
- a reference to this ICU 2.0
◆ replace() [12/18]
|
inline |
Replace the characters in the range [start, start + length) with the characters in srcChars. srcChars is not modified.
- Parameters
-
start the offset at which the replace operation begins length number of characters to replace. The character at start + lengthis not modified.srcChars the source for the new characters srcLength the number of Unicode characters in srcChars
- Returns
- a reference to this ICU 2.0
◆ replace() [13/18]
|
inline |
Replace the characters in the range [start, start + length) with the code unit srcChar.
- Parameters
-
start the offset at which the replace operation begins length the number of characters to replace. The character at start + lengthis not modified.srcChar the new code unit
- Returns
- a reference to this ICU 2.0
◆ replace() [14/18]
|
inline |
Replace the characters in the range [start, start + length) with the code unit srcChar.
- Parameters
-
start the offset at which the replace operation begins length the number of characters to replace. The character at start + lengthis not modified.srcChar the new code unit
- Returns
- a reference to this ICU 2.0
◆ replace() [15/18]
|
inline |
Replace the characters in the range [start, start + length) with the code unit srcChar.
- Parameters
-
start the offset at which the replace operation begins length the number of characters to replace. The character at start + lengthis not modified.srcChar the new code unit
- Returns
- a reference to this ICU 2.0
◆ replace() [16/18]
| UnicodeString& UnicodeString::replace | ( | int32_t | start, |
| int32_t | length, | ||
| UChar32 | srcChar | ||
| ) |
Replace the characters in the range [start, start + length) with the code point srcChar.
- Parameters
-
start the offset at which the replace operation begins length the number of characters to replace. The character at start + lengthis not modified.srcChar the new code point
- Returns
- a reference to this ICU 2.0
◆ replace() [17/18]
| UnicodeString& UnicodeString::replace | ( | int32_t | start, |
| int32_t | length, | ||
| UChar32 | srcChar | ||
| ) |
Replace the characters in the range [start, start + length) with the code point srcChar.
- Parameters
-
start the offset at which the replace operation begins length the number of characters to replace. The character at start + lengthis not modified.srcChar the new code point
- Returns
- a reference to this ICU 2.0
◆ replace() [18/18]
| UnicodeString& UnicodeString::replace | ( | int32_t | start, |
| int32_t | length, | ||
| UChar32 | srcChar | ||
| ) |
Replace the characters in the range [start, start + length) with the code point srcChar.
- Parameters
-
start the offset at which the replace operation begins length the number of characters to replace. The character at start + lengthis not modified.srcChar the new code point
- Returns
- a reference to this ICU 2.0
◆ replaceBetween() [1/6]
|
inline |
Replace the characters in the range [start, limit) with the characters in srcText. srcText is not modified.
- Parameters
-
start the offset at which the replace operation begins limit the offset immediately following the replace range srcText the source for the new characters
- Returns
- a reference to this ICU 2.0
◆ replaceBetween() [2/6]
|
inline |
Replace the characters in the range [start, limit) with the characters in srcText. srcText is not modified.
- Parameters
-
start the offset at which the replace operation begins limit the offset immediately following the replace range srcText the source for the new characters
- Returns
- a reference to this ICU 2.0
◆ replaceBetween() [3/6]
|
inline |
Replace the characters in the range [start, limit) with the characters in srcText. srcText is not modified.
- Parameters
-
start the offset at which the replace operation begins limit the offset immediately following the replace range srcText the source for the new characters
- Returns
- a reference to this ICU 2.0
◆ replaceBetween() [4/6]
|
inline |
Replace the characters in the range [start, limit) with the characters in srcText in the range [srcStart, srcLimit). srcText is not modified.
- Parameters
-
start the offset at which the replace operation begins limit the offset immediately following the replace range srcText the source for the new characters srcStart the offset into srcCharswhere new characters will be obtainedsrcLimit the offset immediately following the range to copy in srcText
- Returns
- a reference to this ICU 2.0
◆ replaceBetween() [5/6]
|
inline |
Replace the characters in the range [start, limit) with the characters in srcText in the range [srcStart, srcLimit). srcText is not modified.
- Parameters
-
start the offset at which the replace operation begins limit the offset immediately following the replace range srcText the source for the new characters srcStart the offset into srcCharswhere new characters will be obtainedsrcLimit the offset immediately following the range to copy in srcText
- Returns
- a reference to this ICU 2.0
◆ replaceBetween() [6/6]
|
inline |
Replace the characters in the range [start, limit) with the characters in srcText in the range [srcStart, srcLimit). srcText is not modified.
- Parameters
-
start the offset at which the replace operation begins limit the offset immediately following the replace range srcText the source for the new characters srcStart the offset into srcCharswhere new characters will be obtainedsrcLimit the offset immediately following the range to copy in srcText
- Returns
- a reference to this ICU 2.0
◆ retainBetween() [1/3]
|
inline |
Retain only the characters in the range [start, limit) from the UnicodeString object. Removes characters before start and at and after limit.
- Parameters
-
start the offset of the first character to retain limit the offset immediately following the range to retain
- Returns
- a reference to this ICU 4.4
◆ retainBetween() [2/3]
|
inline |
Retain only the characters in the range [start, limit) from the UnicodeString object. Removes characters before start and at and after limit.
- Parameters
-
start the offset of the first character to retain limit the offset immediately following the range to retain
- Returns
- a reference to this ICU 4.4
◆ retainBetween() [3/3]
|
inline |
Retain only the characters in the range [start, limit) from the UnicodeString object. Removes characters before start and at and after limit.
- Parameters
-
start the offset of the first character to retain limit the offset immediately following the range to retain
- Returns
- a reference to this ICU 4.4
◆ reverse() [1/6]
|
inline |
Reverse this UnicodeString in place.
- Returns
- a reference to this ICU 2.0
◆ reverse() [2/6]
|
inline |
Reverse this UnicodeString in place.
- Returns
- a reference to this ICU 2.0
◆ reverse() [3/6]
|
inline |
Reverse this UnicodeString in place.
- Returns
- a reference to this ICU 2.0
◆ reverse() [4/6]
|
inline |
Reverse the range [start, start + length) in this UnicodeString.
- Parameters
-
start the start of the range to reverse length the number of characters to to reverse
- Returns
- a reference to this ICU 2.0
◆ reverse() [5/6]
|
inline |
Reverse the range [start, start + length) in this UnicodeString.
- Parameters
-
start the start of the range to reverse length the number of characters to to reverse
- Returns
- a reference to this ICU 2.0
◆ reverse() [6/6]
|
inline |
Reverse the range [start, start + length) in this UnicodeString.
- Parameters
-
start the start of the range to reverse length the number of characters to to reverse
- Returns
- a reference to this ICU 2.0
◆ setCharAt() [1/3]
| UnicodeString& UnicodeString::setCharAt | ( | int32_t | offset, |
| UChar | ch | ||
| ) |
◆ setCharAt() [2/3]
| UnicodeString& UnicodeString::setCharAt | ( | int32_t | offset, |
| UChar | ch | ||
| ) |
◆ setCharAt() [3/3]
| UnicodeString& UnicodeString::setCharAt | ( | int32_t | offset, |
| UChar | ch | ||
| ) |
◆ setTo() [1/24]
|
inline |
Set the text in the UnicodeString object to the characters in srcText in the range [srcStart, srcText.length()). srcText is not modified.
- Parameters
-
srcText the source for the new characters srcStart the offset into srcTextwhere new characters will be obtained
- Returns
- a reference to this ICU 2.2
◆ setTo() [2/24]
|
inline |
Set the text in the UnicodeString object to the characters in srcText in the range [srcStart, srcText.length()). srcText is not modified.
- Parameters
-
srcText the source for the new characters srcStart the offset into srcTextwhere new characters will be obtained
- Returns
- a reference to this ICU 2.2
◆ setTo() [3/24]
|
inline |
Set the text in the UnicodeString object to the characters in srcText in the range [srcStart, srcText.length()). srcText is not modified.
- Parameters
-
srcText the source for the new characters srcStart the offset into srcTextwhere new characters will be obtained
- Returns
- a reference to this ICU 2.2
◆ setTo() [4/24]
|
inline |
Set the text in the UnicodeString object to the characters in srcText in the range [srcStart, srcStart + srcLength). srcText is not modified.
- Parameters
-
srcText the source for the new characters srcStart the offset into srcTextwhere new characters will be obtainedsrcLength the number of characters in srcTextin the replace string.
- Returns
- a reference to this ICU 2.0
◆ setTo() [5/24]
|
inline |
Set the text in the UnicodeString object to the characters in srcText in the range [srcStart, srcStart + srcLength). srcText is not modified.
- Parameters
-
srcText the source for the new characters srcStart the offset into srcTextwhere new characters will be obtainedsrcLength the number of characters in srcTextin the replace string.
- Returns
- a reference to this ICU 2.0
◆ setTo() [6/24]
|
inline |
Set the text in the UnicodeString object to the characters in srcText in the range [srcStart, srcStart + srcLength). srcText is not modified.
- Parameters
-
srcText the source for the new characters srcStart the offset into srcTextwhere new characters will be obtainedsrcLength the number of characters in srcTextin the replace string.
- Returns
- a reference to this ICU 2.0
◆ setTo() [7/24]
|
inline |
Set the text in the UnicodeString object to the characters in srcText. srcText is not modified.
- Parameters
-
srcText the source for the new characters
- Returns
- a reference to this ICU 2.0
◆ setTo() [8/24]
|
inline |
Set the text in the UnicodeString object to the characters in srcText. srcText is not modified.
- Parameters
-
srcText the source for the new characters
- Returns
- a reference to this ICU 2.0
◆ setTo() [9/24]
|
inline |
Set the text in the UnicodeString object to the characters in srcText. srcText is not modified.
- Parameters
-
srcText the source for the new characters
- Returns
- a reference to this ICU 2.0
◆ setTo() [10/24]
|
inline |
Set the characters in the UnicodeString object to the characters in srcChars. srcChars is not modified.
- Parameters
-
srcChars the source for the new characters srcLength the number of Unicode characters in srcChars.
- Returns
- a reference to this ICU 2.0
◆ setTo() [11/24]
|
inline |
Set the characters in the UnicodeString object to the characters in srcChars. srcChars is not modified.
- Parameters
-
srcChars the source for the new characters srcLength the number of Unicode characters in srcChars.
- Returns
- a reference to this ICU 2.0
◆ setTo() [12/24]
|
inline |
Set the characters in the UnicodeString object to the characters in srcChars. srcChars is not modified.
- Parameters
-
srcChars the source for the new characters srcLength the number of Unicode characters in srcChars.
- Returns
- a reference to this ICU 2.0
◆ setTo() [13/24]
| UnicodeString& UnicodeString::setTo | ( | UChar | srcChar | ) |
Set the characters in the UnicodeString object to the code unit srcChar.
- Parameters
-
srcChar the code unit which becomes the UnicodeString's character content
- Returns
- a reference to this ICU 2.0
◆ setTo() [14/24]
| UnicodeString& UnicodeString::setTo | ( | UChar | srcChar | ) |
Set the characters in the UnicodeString object to the code unit srcChar.
- Parameters
-
srcChar the code unit which becomes the UnicodeString's character content
- Returns
- a reference to this ICU 2.0
◆ setTo() [15/24]
|
inline |
Set the characters in the UnicodeString object to the code unit srcChar.
- Parameters
-
srcChar the code unit which becomes the UnicodeString's character content
- Returns
- a reference to this ICU 2.0
◆ setTo() [16/24]
|
inline |
Set the characters in the UnicodeString object to the code point srcChar.
- Parameters
-
srcChar the code point which becomes the UnicodeString's character content
- Returns
- a reference to this ICU 2.0
◆ setTo() [17/24]
| UnicodeString& UnicodeString::setTo | ( | UChar32 | srcChar | ) |
Set the characters in the UnicodeString object to the code point srcChar.
- Parameters
-
srcChar the code point which becomes the UnicodeString's character content
- Returns
- a reference to this ICU 2.0
◆ setTo() [18/24]
| UnicodeString& UnicodeString::setTo | ( | UChar32 | srcChar | ) |
Set the characters in the UnicodeString object to the code point srcChar.
- Parameters
-
srcChar the code point which becomes the UnicodeString's character content
- Returns
- a reference to this ICU 2.0
◆ setTo() [19/24]
| UnicodeString& UnicodeString::setTo | ( | UBool | isTerminated, |
| const UChar * | text, | ||
| int32_t | textLength | ||
| ) |
Aliasing setTo() function, analogous to the readonly-aliasing UChar* constructor. The text will be used for the UnicodeString object, but it will not be released when the UnicodeString is destroyed. This has copy-on-write semantics: When the string is modified, then the buffer is first copied into newly allocated memory. The aliased buffer is never modified.
In an assignment to another UnicodeString, when using the copy constructor or the assignment operator, the text will be copied. When using fastCopyFrom(), the text will be aliased again, so that both strings then alias the same readonly-text.
- Parameters
-
isTerminated specifies if textisNUL-terminated. This must be true iftextLength==-1.text The characters to alias for the UnicodeString. textLength The number of Unicode characters in textto alias. If -1, then this constructor will determine the length by callingu_strlen().
- Returns
- a reference to this ICU 2.0
◆ setTo() [20/24]
| UnicodeString& UnicodeString::setTo | ( | UBool | isTerminated, |
| const UChar * | text, | ||
| int32_t | textLength | ||
| ) |
Aliasing setTo() function, analogous to the readonly-aliasing UChar* constructor. The text will be used for the UnicodeString object, but it will not be released when the UnicodeString is destroyed. This has copy-on-write semantics: When the string is modified, then the buffer is first copied into newly allocated memory. The aliased buffer is never modified.
In an assignment to another UnicodeString, when using the copy constructor or the assignment operator, the text will be copied. When using fastCopyFrom(), the text will be aliased again, so that both strings then alias the same readonly-text.
- Parameters
-
isTerminated specifies if textisNUL-terminated. This must be true iftextLength==-1.text The characters to alias for the UnicodeString. textLength The number of Unicode characters in textto alias. If -1, then this constructor will determine the length by callingu_strlen().
- Returns
- a reference to this ICU 2.0
◆ setTo() [21/24]
| UnicodeString& UnicodeString::setTo | ( | UBool | isTerminated, |
| const UChar * | text, | ||
| int32_t | textLength | ||
| ) |
Aliasing setTo() function, analogous to the readonly-aliasing UChar* constructor. The text will be used for the UnicodeString object, but it will not be released when the UnicodeString is destroyed. This has copy-on-write semantics: When the string is modified, then the buffer is first copied into newly allocated memory. The aliased buffer is never modified.
In an assignment to another UnicodeString, when using the copy constructor or the assignment operator, the text will be copied. When using fastCopyFrom(), the text will be aliased again, so that both strings then alias the same readonly-text.
- Parameters
-
isTerminated specifies if textisNUL-terminated. This must be true iftextLength==-1.text The characters to alias for the UnicodeString. textLength The number of Unicode characters in textto alias. If -1, then this constructor will determine the length by callingu_strlen().
- Returns
- a reference to this ICU 2.0
◆ setTo() [22/24]
| UnicodeString& UnicodeString::setTo | ( | UChar * | buffer, |
| int32_t | buffLength, | ||
| int32_t | buffCapacity | ||
| ) |
Aliasing setTo() function, analogous to the writable-aliasing UChar* constructor. The text will be used for the UnicodeString object, but it will not be released when the UnicodeString is destroyed. This has write-through semantics: For as long as the capacity of the buffer is sufficient, write operations will directly affect the buffer. When more capacity is necessary, then a new buffer will be allocated and the contents copied as with regularly constructed strings. In an assignment to another UnicodeString, the buffer will be copied. The extract(UChar *dst) function detects whether the dst pointer is the same as the string buffer itself and will in this case not copy the contents.
- Parameters
-
buffer The characters to alias for the UnicodeString. buffLength The number of Unicode characters in bufferto alias.buffCapacity The size of bufferin UChars.
- Returns
- a reference to this ICU 2.0
◆ setTo() [23/24]
| UnicodeString& UnicodeString::setTo | ( | UChar * | buffer, |
| int32_t | buffLength, | ||
| int32_t | buffCapacity | ||
| ) |
Aliasing setTo() function, analogous to the writable-aliasing UChar* constructor. The text will be used for the UnicodeString object, but it will not be released when the UnicodeString is destroyed. This has write-through semantics: For as long as the capacity of the buffer is sufficient, write operations will directly affect the buffer. When more capacity is necessary, then a new buffer will be allocated and the contents copied as with regularly constructed strings. In an assignment to another UnicodeString, the buffer will be copied. The extract(UChar *dst) function detects whether the dst pointer is the same as the string buffer itself and will in this case not copy the contents.
- Parameters
-
buffer The characters to alias for the UnicodeString. buffLength The number of Unicode characters in bufferto alias.buffCapacity The size of bufferin UChars.
- Returns
- a reference to this ICU 2.0
◆ setTo() [24/24]
| UnicodeString& UnicodeString::setTo | ( | UChar * | buffer, |
| int32_t | buffLength, | ||
| int32_t | buffCapacity | ||
| ) |
Aliasing setTo() function, analogous to the writable-aliasing UChar* constructor. The text will be used for the UnicodeString object, but it will not be released when the UnicodeString is destroyed. This has write-through semantics: For as long as the capacity of the buffer is sufficient, write operations will directly affect the buffer. When more capacity is necessary, then a new buffer will be allocated and the contents copied as with regularly constructed strings. In an assignment to another UnicodeString, the buffer will be copied. The extract(UChar *dst) function detects whether the dst pointer is the same as the string buffer itself and will in this case not copy the contents.
- Parameters
-
buffer The characters to alias for the UnicodeString. buffLength The number of Unicode characters in bufferto alias.buffCapacity The size of bufferin UChars.
- Returns
- a reference to this ICU 2.0
◆ setToBogus() [1/3]
| void UnicodeString::setToBogus | ( | ) |
Make this UnicodeString object invalid. The string will test TRUE with isBogus().
A bogus string has no value. It is different from an empty string. It can be used to indicate that no string value is available. getBuffer() and getTerminatedBuffer() return NULL, and length() returns 0.
This utility function is used throughout the UnicodeString implementation to indicate that a UnicodeString operation failed, and may be used in other functions, especially but not exclusively when such functions do not take a UErrorCode for simplicity.
The following methods, and no others, will clear a string object's bogus flag:
- remove()
- remove(0, INT32_MAX)
- truncate(0)
- operator=() (assignment operator)
- setTo(...)
The simplest ways to turn a bogus string into an empty one is to use the remove() function. Examples for other functions that are equivalent to "set to empty string":
- See also
- isBogus() ICU 2.0
◆ setToBogus() [2/3]
| void UnicodeString::setToBogus | ( | ) |
Make this UnicodeString object invalid. The string will test TRUE with isBogus().
A bogus string has no value. It is different from an empty string. It can be used to indicate that no string value is available. getBuffer() and getTerminatedBuffer() return NULL, and length() returns 0.
This utility function is used throughout the UnicodeString implementation to indicate that a UnicodeString operation failed, and may be used in other functions, especially but not exclusively when such functions do not take a UErrorCode for simplicity.
The following methods, and no others, will clear a string object's bogus flag:
- remove()
- remove(0, INT32_MAX)
- truncate(0)
- operator=() (assignment operator)
- setTo(...)
The simplest ways to turn a bogus string into an empty one is to use the remove() function. Examples for other functions that are equivalent to "set to empty string":
- See also
- isBogus() ICU 2.0
◆ setToBogus() [3/3]
| void UnicodeString::setToBogus | ( | ) |
Make this UnicodeString object invalid. The string will test TRUE with isBogus().
A bogus string has no value. It is different from an empty string. It can be used to indicate that no string value is available. getBuffer() and getTerminatedBuffer() return NULL, and length() returns 0.
This utility function is used throughout the UnicodeString implementation to indicate that a UnicodeString operation failed, and may be used in other functions, especially but not exclusively when such functions do not take a UErrorCode for simplicity.
The following methods, and no others, will clear a string object's bogus flag:
- remove()
- remove(0, INT32_MAX)
- truncate(0)
- operator=() (assignment operator)
- setTo(...)
The simplest ways to turn a bogus string into an empty one is to use the remove() function. Examples for other functions that are equivalent to "set to empty string":
- See also
- isBogus() ICU 2.0
◆ startsWith() [1/12]
|
inline |
Determine if this starts with the characters in text
- Parameters
-
text The text to match.
- Returns
- TRUE if this starts with the characters in
text, FALSE otherwise ICU 2.0
◆ startsWith() [2/12]
|
inline |
Determine if this starts with the characters in text
- Parameters
-
text The text to match.
- Returns
- TRUE if this starts with the characters in
text, FALSE otherwise ICU 2.0
◆ startsWith() [3/12]
|
inline |
Determine if this starts with the characters in text
- Parameters
-
text The text to match.
- Returns
- TRUE if this starts with the characters in
text, FALSE otherwise ICU 2.0
◆ startsWith() [4/12]
|
inline |
Determine if this starts with the characters in srcText in the range [srcStart, srcStart + srcLength).
- Parameters
-
srcText The text to match. srcStart the offset into srcTextto start matchingsrcLength the number of characters in srcTextto match
- Returns
- TRUE if this starts with the characters in
text, FALSE otherwise ICU 2.0
◆ startsWith() [5/12]
|
inline |
Determine if this starts with the characters in srcText in the range [srcStart, srcStart + srcLength).
- Parameters
-
srcText The text to match. srcStart the offset into srcTextto start matchingsrcLength the number of characters in srcTextto match
- Returns
- TRUE if this starts with the characters in
text, FALSE otherwise ICU 2.0
◆ startsWith() [6/12]
|
inline |
Determine if this starts with the characters in srcText in the range [srcStart, srcStart + srcLength).
- Parameters
-
srcText The text to match. srcStart the offset into srcTextto start matchingsrcLength the number of characters in srcTextto match
- Returns
- TRUE if this starts with the characters in
text, FALSE otherwise ICU 2.0
◆ startsWith() [7/12]
Determine if this starts with the characters in srcChars
- Parameters
-
srcChars The characters to match. srcLength the number of characters in srcChars
- Returns
- TRUE if this starts with the characters in
srcChars, FALSE otherwise ICU 2.0
◆ startsWith() [8/12]
Determine if this starts with the characters in srcChars
- Parameters
-
srcChars The characters to match. srcLength the number of characters in srcChars
- Returns
- TRUE if this starts with the characters in
srcChars, FALSE otherwise ICU 2.0
◆ startsWith() [9/12]
Determine if this starts with the characters in srcChars
- Parameters
-
srcChars The characters to match. srcLength the number of characters in srcChars
- Returns
- TRUE if this starts with the characters in
srcChars, FALSE otherwise ICU 2.0
◆ startsWith() [10/12]
|
inline |
Determine if this ends with the characters in srcChars in the range [srcStart, srcStart + srcLength).
- Parameters
-
srcChars The characters to match. srcStart the offset into srcTextto start matchingsrcLength the number of characters in srcCharsto match
- Returns
- TRUE if this ends with the characters in
srcChars, FALSE otherwise ICU 2.0
◆ startsWith() [11/12]
|
inline |
Determine if this ends with the characters in srcChars in the range [srcStart, srcStart + srcLength).
- Parameters
-
srcChars The characters to match. srcStart the offset into srcTextto start matchingsrcLength the number of characters in srcCharsto match
- Returns
- TRUE if this ends with the characters in
srcChars, FALSE otherwise ICU 2.0
◆ startsWith() [12/12]
|
inline |
Determine if this ends with the characters in srcChars in the range [srcStart, srcStart + srcLength).
- Parameters
-
srcChars The characters to match. srcStart the offset into srcTextto start matchingsrcLength the number of characters in srcCharsto match
- Returns
- TRUE if this ends with the characters in
srcChars, FALSE otherwise ICU 2.0
◆ tempSubString() [1/3]
| UnicodeString UnicodeString::tempSubString | ( | int32_t | start = 0, |
| int32_t | length = INT32_MAX |
||
| ) | const |
Create a temporary substring for the specified range. Unlike the substring constructor and setTo() functions, the object returned here will be a read-only alias (using getBuffer()) rather than copying the text. As a result, this substring operation is much faster but requires that the original string not be modified or deleted during the lifetime of the returned substring object.
- Parameters
-
start offset of the first character visible in the substring length length of the substring
- Returns
- a read-only alias UnicodeString object for the substring ICU 4.4
◆ tempSubString() [2/3]
| UnicodeString UnicodeString::tempSubString | ( | int32_t | start = 0, |
| int32_t | length = INT32_MAX |
||
| ) | const |
Create a temporary substring for the specified range. Unlike the substring constructor and setTo() functions, the object returned here will be a read-only alias (using getBuffer()) rather than copying the text. As a result, this substring operation is much faster but requires that the original string not be modified or deleted during the lifetime of the returned substring object.
- Parameters
-
start offset of the first character visible in the substring length length of the substring
- Returns
- a read-only alias UnicodeString object for the substring ICU 4.4
◆ tempSubString() [3/3]
| UnicodeString UnicodeString::tempSubString | ( | int32_t | start = 0, |
| int32_t | length = INT32_MAX |
||
| ) | const |
Create a temporary substring for the specified range. Unlike the substring constructor and setTo() functions, the object returned here will be a read-only alias (using getBuffer()) rather than copying the text. As a result, this substring operation is much faster but requires that the original string not be modified or deleted during the lifetime of the returned substring object.
- Parameters
-
start offset of the first character visible in the substring length length of the substring
- Returns
- a read-only alias UnicodeString object for the substring ICU 4.4
◆ tempSubStringBetween() [1/3]
|
inline |
Create a temporary substring for the specified range. Same as tempSubString(start, length) except that the substring range is specified as a (start, limit) pair (with an exclusive limit index) rather than a (start, length) pair.
- Parameters
-
start offset of the first character visible in the substring limit offset immediately following the last character visible in the substring
- Returns
- a read-only alias UnicodeString object for the substring ICU 4.4
◆ tempSubStringBetween() [2/3]
|
inline |
Create a temporary substring for the specified range. Same as tempSubString(start, length) except that the substring range is specified as a (start, limit) pair (with an exclusive limit index) rather than a (start, length) pair.
- Parameters
-
start offset of the first character visible in the substring limit offset immediately following the last character visible in the substring
- Returns
- a read-only alias UnicodeString object for the substring ICU 4.4
◆ tempSubStringBetween() [3/3]
|
inline |
Create a temporary substring for the specified range. Same as tempSubString(start, length) except that the substring range is specified as a (start, limit) pair (with an exclusive limit index) rather than a (start, length) pair.
- Parameters
-
start offset of the first character visible in the substring limit offset immediately following the last character visible in the substring
- Returns
- a read-only alias UnicodeString object for the substring ICU 4.4
◆ toLower() [1/6]
| UnicodeString& UnicodeString::toLower | ( | void | ) |
Convert the characters in this to lower case following the conventions of the default locale.
- Returns
- A reference to this. ICU 2.0
◆ toLower() [2/6]
| UnicodeString& UnicodeString::toLower | ( | void | ) |
Convert the characters in this to lower case following the conventions of the default locale.
- Returns
- A reference to this. ICU 2.0
◆ toLower() [3/6]
| UnicodeString& UnicodeString::toLower | ( | void | ) |
Convert the characters in this to lower case following the conventions of the default locale.
- Returns
- A reference to this. ICU 2.0
◆ toLower() [4/6]
| UnicodeString& UnicodeString::toLower | ( | const Locale & | locale | ) |
◆ toLower() [5/6]
| UnicodeString& UnicodeString::toLower | ( | const Locale & | locale | ) |
◆ toLower() [6/6]
| UnicodeString& UnicodeString::toLower | ( | const Locale & | locale | ) |
◆ toTitle() [1/9]
| UnicodeString& UnicodeString::toTitle | ( | BreakIterator * | titleIter | ) |
Titlecase this string, convenience function using the default locale.
Casing is locale-dependent and context-sensitive. Titlecasing uses a break iterator to find the first characters of words that are to be titlecased. It titlecases those characters and lowercases all others.
The titlecase break iterator can be provided to customize for arbitrary styles, using rules and dictionaries beyond the standard iterators. It may be more efficient to always provide an iterator to avoid opening and closing one for each string. The standard titlecase iterator for the root locale implements the algorithm of Unicode TR 21.
This function uses only the setText(), first() and next() methods of the provided break iterator.
- Parameters
-
titleIter A break iterator to find the first characters of words that are to be titlecased. If none is provided (0), then a standard titlecase break iterator is opened. Otherwise the provided iterator is set to the string's text.
- Returns
- A reference to this. ICU 2.1
◆ toTitle() [2/9]
| UnicodeString& UnicodeString::toTitle | ( | BreakIterator * | titleIter | ) |
Titlecase this string, convenience function using the default locale.
Casing is locale-dependent and context-sensitive. Titlecasing uses a break iterator to find the first characters of words that are to be titlecased. It titlecases those characters and lowercases all others.
The titlecase break iterator can be provided to customize for arbitrary styles, using rules and dictionaries beyond the standard iterators. It may be more efficient to always provide an iterator to avoid opening and closing one for each string. The standard titlecase iterator for the root locale implements the algorithm of Unicode TR 21.
This function uses only the setText(), first() and next() methods of the provided break iterator.
- Parameters
-
titleIter A break iterator to find the first characters of words that are to be titlecased. If none is provided (0), then a standard titlecase break iterator is opened. Otherwise the provided iterator is set to the string's text.
- Returns
- A reference to this. ICU 2.1
◆ toTitle() [3/9]
| UnicodeString& UnicodeString::toTitle | ( | BreakIterator * | titleIter | ) |
Titlecase this string, convenience function using the default locale.
Casing is locale-dependent and context-sensitive. Titlecasing uses a break iterator to find the first characters of words that are to be titlecased. It titlecases those characters and lowercases all others.
The titlecase break iterator can be provided to customize for arbitrary styles, using rules and dictionaries beyond the standard iterators. It may be more efficient to always provide an iterator to avoid opening and closing one for each string. The standard titlecase iterator for the root locale implements the algorithm of Unicode TR 21.
This function uses only the setText(), first() and next() methods of the provided break iterator.
- Parameters
-
titleIter A break iterator to find the first characters of words that are to be titlecased. If none is provided (0), then a standard titlecase break iterator is opened. Otherwise the provided iterator is set to the string's text.
- Returns
- A reference to this. ICU 2.1
◆ toTitle() [4/9]
| UnicodeString& UnicodeString::toTitle | ( | BreakIterator * | titleIter, |
| const Locale & | locale | ||
| ) |
Titlecase this string.
Casing is locale-dependent and context-sensitive. Titlecasing uses a break iterator to find the first characters of words that are to be titlecased. It titlecases those characters and lowercases all others.
The titlecase break iterator can be provided to customize for arbitrary styles, using rules and dictionaries beyond the standard iterators. It may be more efficient to always provide an iterator to avoid opening and closing one for each string. The standard titlecase iterator for the root locale implements the algorithm of Unicode TR 21.
This function uses only the setText(), first() and next() methods of the provided break iterator.
- Parameters
-
titleIter A break iterator to find the first characters of words that are to be titlecased. If none is provided (0), then a standard titlecase break iterator is opened. Otherwise the provided iterator is set to the string's text. locale The locale to consider.
- Returns
- A reference to this. ICU 2.1
◆ toTitle() [5/9]
| UnicodeString& UnicodeString::toTitle | ( | BreakIterator * | titleIter, |
| const Locale & | locale | ||
| ) |
Titlecase this string.
Casing is locale-dependent and context-sensitive. Titlecasing uses a break iterator to find the first characters of words that are to be titlecased. It titlecases those characters and lowercases all others.
The titlecase break iterator can be provided to customize for arbitrary styles, using rules and dictionaries beyond the standard iterators. It may be more efficient to always provide an iterator to avoid opening and closing one for each string. The standard titlecase iterator for the root locale implements the algorithm of Unicode TR 21.
This function uses only the setText(), first() and next() methods of the provided break iterator.
- Parameters
-
titleIter A break iterator to find the first characters of words that are to be titlecased. If none is provided (0), then a standard titlecase break iterator is opened. Otherwise the provided iterator is set to the string's text. locale The locale to consider.
- Returns
- A reference to this. ICU 2.1
◆ toTitle() [6/9]
| UnicodeString& UnicodeString::toTitle | ( | BreakIterator * | titleIter, |
| const Locale & | locale | ||
| ) |
Titlecase this string.
Casing is locale-dependent and context-sensitive. Titlecasing uses a break iterator to find the first characters of words that are to be titlecased. It titlecases those characters and lowercases all others.
The titlecase break iterator can be provided to customize for arbitrary styles, using rules and dictionaries beyond the standard iterators. It may be more efficient to always provide an iterator to avoid opening and closing one for each string. The standard titlecase iterator for the root locale implements the algorithm of Unicode TR 21.
This function uses only the setText(), first() and next() methods of the provided break iterator.
- Parameters
-
titleIter A break iterator to find the first characters of words that are to be titlecased. If none is provided (0), then a standard titlecase break iterator is opened. Otherwise the provided iterator is set to the string's text. locale The locale to consider.
- Returns
- A reference to this. ICU 2.1
◆ toTitle() [7/9]
| UnicodeString& UnicodeString::toTitle | ( | BreakIterator * | titleIter, |
| const Locale & | locale, | ||
| uint32_t | options | ||
| ) |
Titlecase this string, with options.
Casing is locale-dependent and context-sensitive. Titlecasing uses a break iterator to find the first characters of words that are to be titlecased. It titlecases those characters and lowercases all others. (This can be modified with options.)
The titlecase break iterator can be provided to customize for arbitrary styles, using rules and dictionaries beyond the standard iterators. It may be more efficient to always provide an iterator to avoid opening and closing one for each string. The standard titlecase iterator for the root locale implements the algorithm of Unicode TR 21.
This function uses only the setText(), first() and next() methods of the provided break iterator.
- Parameters
-
titleIter A break iterator to find the first characters of words that are to be titlecased. If none is provided (0), then a standard titlecase break iterator is opened. Otherwise the provided iterator is set to the string's text. locale The locale to consider. options Options bit set, see ucasemap_open().
- Returns
- A reference to this.
- See also
- U_TITLECASE_NO_LOWERCASE
- U_TITLECASE_NO_BREAK_ADJUSTMENT
- ucasemap_open ICU 3.8
◆ toTitle() [8/9]
| UnicodeString& UnicodeString::toTitle | ( | BreakIterator * | titleIter, |
| const Locale & | locale, | ||
| uint32_t | options | ||
| ) |
Titlecase this string, with options.
Casing is locale-dependent and context-sensitive. Titlecasing uses a break iterator to find the first characters of words that are to be titlecased. It titlecases those characters and lowercases all others. (This can be modified with options.)
The titlecase break iterator can be provided to customize for arbitrary styles, using rules and dictionaries beyond the standard iterators. It may be more efficient to always provide an iterator to avoid opening and closing one for each string. The standard titlecase iterator for the root locale implements the algorithm of Unicode TR 21.
This function uses only the setText(), first() and next() methods of the provided break iterator.
- Parameters
-
titleIter A break iterator to find the first characters of words that are to be titlecased. If none is provided (0), then a standard titlecase break iterator is opened. Otherwise the provided iterator is set to the string's text. locale The locale to consider. options Options bit set, see ucasemap_open().
- Returns
- A reference to this.
- See also
- U_TITLECASE_NO_LOWERCASE
- U_TITLECASE_NO_BREAK_ADJUSTMENT
- ucasemap_open ICU 3.8
◆ toTitle() [9/9]
| UnicodeString& UnicodeString::toTitle | ( | BreakIterator * | titleIter, |
| const Locale & | locale, | ||
| uint32_t | options | ||
| ) |
Titlecase this string, with options.
Casing is locale-dependent and context-sensitive. Titlecasing uses a break iterator to find the first characters of words that are to be titlecased. It titlecases those characters and lowercases all others. (This can be modified with options.)
The titlecase break iterator can be provided to customize for arbitrary styles, using rules and dictionaries beyond the standard iterators. It may be more efficient to always provide an iterator to avoid opening and closing one for each string. The standard titlecase iterator for the root locale implements the algorithm of Unicode TR 21.
This function uses only the setText(), first() and next() methods of the provided break iterator.
- Parameters
-
titleIter A break iterator to find the first characters of words that are to be titlecased. If none is provided (0), then a standard titlecase break iterator is opened. Otherwise the provided iterator is set to the string's text. locale The locale to consider. options Options bit set, see ucasemap_open().
- Returns
- A reference to this.
- See also
- U_TITLECASE_NO_LOWERCASE
- U_TITLECASE_NO_BREAK_ADJUSTMENT
- ucasemap_open ICU 3.8
◆ toUpper() [1/6]
| UnicodeString& UnicodeString::toUpper | ( | void | ) |
Convert the characters in this to UPPER CASE following the conventions of the default locale.
- Returns
- A reference to this. ICU 2.0
◆ toUpper() [2/6]
| UnicodeString& UnicodeString::toUpper | ( | void | ) |
Convert the characters in this to UPPER CASE following the conventions of the default locale.
- Returns
- A reference to this. ICU 2.0
◆ toUpper() [3/6]
| UnicodeString& UnicodeString::toUpper | ( | void | ) |
Convert the characters in this to UPPER CASE following the conventions of the default locale.
- Returns
- A reference to this. ICU 2.0
◆ toUpper() [4/6]
| UnicodeString& UnicodeString::toUpper | ( | const Locale & | locale | ) |
◆ toUpper() [5/6]
| UnicodeString& UnicodeString::toUpper | ( | const Locale & | locale | ) |
◆ toUpper() [6/6]
| UnicodeString& UnicodeString::toUpper | ( | const Locale & | locale | ) |
◆ toUTF32() [1/3]
| int32_t UnicodeString::toUTF32 | ( | UChar32 * | utf32, |
| int32_t | capacity, | ||
| UErrorCode & | errorCode | ||
| ) | const |
Convert the UnicodeString to UTF-32. Unpaired surrogates are replaced with U+FFFD. Calls u_strToUTF32WithSub().
- Parameters
-
utf32 destination string buffer, can be NULL if capacity==0 capacity the number of UChar32s available at utf32 errorCode Standard ICU error code. Its input value must pass the U_SUCCESS() test, or else the function returns immediately. Check for U_FAILURE() on output or use with function chaining. (See User Guide for details.)
- Returns
- The length of the UTF-32 string.
- See also
- fromUTF32 ICU 4.2
◆ toUTF32() [2/3]
| int32_t UnicodeString::toUTF32 | ( | UChar32 * | utf32, |
| int32_t | capacity, | ||
| UErrorCode & | errorCode | ||
| ) | const |
Convert the UnicodeString to UTF-32. Unpaired surrogates are replaced with U+FFFD. Calls u_strToUTF32WithSub().
- Parameters
-
utf32 destination string buffer, can be NULL if capacity==0 capacity the number of UChar32s available at utf32 errorCode Standard ICU error code. Its input value must pass the U_SUCCESS() test, or else the function returns immediately. Check for U_FAILURE() on output or use with function chaining. (See User Guide for details.)
- Returns
- The length of the UTF-32 string.
- See also
- fromUTF32 ICU 4.2
◆ toUTF32() [3/3]
| int32_t UnicodeString::toUTF32 | ( | UChar32 * | utf32, |
| int32_t | capacity, | ||
| UErrorCode & | errorCode | ||
| ) | const |
Convert the UnicodeString to UTF-32. Unpaired surrogates are replaced with U+FFFD. Calls u_strToUTF32WithSub().
- Parameters
-
utf32 destination string buffer, can be NULL if capacity==0 capacity the number of UChar32s available at utf32 errorCode Standard ICU error code. Its input value must pass the U_SUCCESS() test, or else the function returns immediately. Check for U_FAILURE() on output or use with function chaining. (See User Guide for details.)
- Returns
- The length of the UTF-32 string.
- See also
- fromUTF32 ICU 4.2
◆ toUTF8() [1/3]
Convert the UnicodeString to UTF-8 and write the result to a ByteSink. This is called by toUTF8String(). Unpaired surrogates are replaced with U+FFFD. Calls u_strToUTF8WithSub().
- Parameters
-
sink A ByteSink to which the UTF-8 version of the string is written. sink.Flush() is called at the end. ICU 4.2
- See also
- toUTF8String
◆ toUTF8() [2/3]
Convert the UnicodeString to UTF-8 and write the result to a ByteSink. This is called by toUTF8String(). Unpaired surrogates are replaced with U+FFFD. Calls u_strToUTF8WithSub().
- Parameters
-
sink A ByteSink to which the UTF-8 version of the string is written. sink.Flush() is called at the end. ICU 4.2
- See also
- toUTF8String
◆ toUTF8() [3/3]
Convert the UnicodeString to UTF-8 and write the result to a ByteSink. This is called by toUTF8String(). Unpaired surrogates are replaced with U+FFFD. Calls u_strToUTF8WithSub().
- Parameters
-
sink A ByteSink to which the UTF-8 version of the string is written. sink.Flush() is called at the end. ICU 4.2
- See also
- toUTF8String
◆ trim() [1/3]
| UnicodeString& UnicodeString::trim | ( | void | ) |
Trims leading and trailing whitespace from this UnicodeString.
- Returns
- a reference to this ICU 2.0
◆ trim() [2/3]
| UnicodeString& UnicodeString::trim | ( | void | ) |
Trims leading and trailing whitespace from this UnicodeString.
- Returns
- a reference to this ICU 2.0
◆ trim() [3/3]
| UnicodeString& UnicodeString::trim | ( | void | ) |
Trims leading and trailing whitespace from this UnicodeString.
- Returns
- a reference to this ICU 2.0
◆ truncate() [1/3]
Truncate this UnicodeString to the targetLength.
- Parameters
-
targetLength the desired length of this UnicodeString.
- Returns
- TRUE if the text was truncated, FALSE otherwise ICU 2.0
◆ truncate() [2/3]
Truncate this UnicodeString to the targetLength.
- Parameters
-
targetLength the desired length of this UnicodeString.
- Returns
- TRUE if the text was truncated, FALSE otherwise ICU 2.0
◆ truncate() [3/3]
Truncate this UnicodeString to the targetLength.
- Parameters
-
targetLength the desired length of this UnicodeString.
- Returns
- TRUE if the text was truncated, FALSE otherwise ICU 2.0
◆ unescape() [1/3]
| UnicodeString UnicodeString::unescape | ( | ) | const |
Unescape a string of characters and return a string containing the result. The following escape sequences are recognized:
\uhhhh 4 hex digits; h in [0-9A-Fa-f] \Uhhhhhhhh 8 hex digits \xhh 1-2 hex digits \ooo 1-3 octal digits; o in [0-7] \cX control-X; X is masked with 0x1F
as well as the standard ANSI C escapes:
\a => U+0007, \b => U+0008, \t => U+0009, \n => U+000A, \v => U+000B, \f => U+000C, \r => U+000D, \e => U+001B, \" => U+0022, \' => U+0027, \? => U+003F, \\ => U+005C
Anything else following a backslash is generically escaped. For example, "[a\\-z]" returns "[a-z]".
If an escape sequence is ill-formed, this method returns an empty string. An example of an ill-formed sequence is "\\u" followed by fewer than 4 hex digits.
This function is similar to u_unescape() but not identical to it. The latter takes a source char*, so it does escape recognition and also invariant conversion.
- Returns
- a string with backslash escapes interpreted, or an empty string on error.
- See also
- UnicodeString::unescapeAt()
- u_unescape()
- u_unescapeAt() ICU 2.0
◆ unescape() [2/3]
| UnicodeString UnicodeString::unescape | ( | ) | const |
Unescape a string of characters and return a string containing the result. The following escape sequences are recognized:
\uhhhh 4 hex digits; h in [0-9A-Fa-f] \Uhhhhhhhh 8 hex digits \xhh 1-2 hex digits \ooo 1-3 octal digits; o in [0-7] \cX control-X; X is masked with 0x1F
as well as the standard ANSI C escapes:
\a => U+0007, \b => U+0008, \t => U+0009, \n => U+000A, \v => U+000B, \f => U+000C, \r => U+000D, \e => U+001B, \" => U+0022, \' => U+0027, \? => U+003F, \\ => U+005C
Anything else following a backslash is generically escaped. For example, "[a\\-z]" returns "[a-z]".
If an escape sequence is ill-formed, this method returns an empty string. An example of an ill-formed sequence is "\\u" followed by fewer than 4 hex digits.
This function is similar to u_unescape() but not identical to it. The latter takes a source char*, so it does escape recognition and also invariant conversion.
- Returns
- a string with backslash escapes interpreted, or an empty string on error.
- See also
- UnicodeString::unescapeAt()
- u_unescape()
- u_unescapeAt() ICU 2.0
◆ unescape() [3/3]
| UnicodeString UnicodeString::unescape | ( | ) | const |
Unescape a string of characters and return a string containing the result. The following escape sequences are recognized:
\uhhhh 4 hex digits; h in [0-9A-Fa-f] \Uhhhhhhhh 8 hex digits \xhh 1-2 hex digits \ooo 1-3 octal digits; o in [0-7] \cX control-X; X is masked with 0x1F
as well as the standard ANSI C escapes:
\a => U+0007, \b => U+0008, \t => U+0009, \n => U+000A, \v => U+000B, \f => U+000C, \r => U+000D, \e => U+001B, \" => U+0022, \' => U+0027, \? => U+003F, \\ => U+005C
Anything else following a backslash is generically escaped. For example, "[a\\-z]" returns "[a-z]".
If an escape sequence is ill-formed, this method returns an empty string. An example of an ill-formed sequence is "\\u" followed by fewer than 4 hex digits.
This function is similar to u_unescape() but not identical to it. The latter takes a source char*, so it does escape recognition and also invariant conversion.
- Returns
- a string with backslash escapes interpreted, or an empty string on error.
- See also
- UnicodeString::unescapeAt()
- u_unescape()
- u_unescapeAt() ICU 2.0
◆ unescapeAt() [1/3]
Unescape a single escape sequence and return the represented character. See unescape() for a listing of the recognized escape sequences. The character at offset-1 is assumed (without checking) to be a backslash. If the escape sequence is ill-formed, or the offset is out of range, U_SENTINEL=-1 is returned.
- Parameters
-
offset an input output parameter. On input, it is the offset into this string where the escape sequence is located, after the initial backslash. On output, it is advanced after the last character parsed. On error, it is not advanced at all.
- Returns
- the character represented by the escape sequence at offset, or U_SENTINEL=-1 on error.
- See also
- UnicodeString::unescape()
- u_unescape()
- u_unescapeAt() ICU 2.0
◆ unescapeAt() [2/3]
Unescape a single escape sequence and return the represented character. See unescape() for a listing of the recognized escape sequences. The character at offset-1 is assumed (without checking) to be a backslash. If the escape sequence is ill-formed, or the offset is out of range, U_SENTINEL=-1 is returned.
- Parameters
-
offset an input output parameter. On input, it is the offset into this string where the escape sequence is located, after the initial backslash. On output, it is advanced after the last character parsed. On error, it is not advanced at all.
- Returns
- the character represented by the escape sequence at offset, or U_SENTINEL=-1 on error.
- See also
- UnicodeString::unescape()
- u_unescape()
- u_unescapeAt() ICU 2.0
◆ unescapeAt() [3/3]
Unescape a single escape sequence and return the represented character. See unescape() for a listing of the recognized escape sequences. The character at offset-1 is assumed (without checking) to be a backslash. If the escape sequence is ill-formed, or the offset is out of range, U_SENTINEL=-1 is returned.
- Parameters
-
offset an input output parameter. On input, it is the offset into this string where the escape sequence is located, after the initial backslash. On output, it is advanced after the last character parsed. On error, it is not advanced at all.
- Returns
- the character represented by the escape sequence at offset, or U_SENTINEL=-1 on error.
- See also
- UnicodeString::unescape()
- u_unescape()
- u_unescapeAt() ICU 2.0
Friends And Related Function Documentation
◆ StackBufferOrFields
|
friend |
◆ StringThreadTest
|
friend |
◆ UnicodeStringAppendable
|
friend |
The documentation for this class was generated from the following file:
- DerivedData/WebKit/Build/Products/Debug/WebCore.framework/Versions/A/PrivateHeaders/icu/unicode/unistr.h
