blob: e9aeef7bddfd4f93df2c653578082e9580bce273 [file] [log] [blame]
/*
**********************************************************************
* Copyright (C) 1998-2001, International Business Machines
* Corporation and others. All Rights Reserved.
**********************************************************************
*
* File unistr.h
*
* Modification History:
*
* Date Name Description
* 09/25/98 stephen Creation.
* 11/11/98 stephen Changed per 11/9 code review.
* 04/20/99 stephen Overhauled per 4/16 code review.
* 11/18/99 aliu Made to inherit from Replaceable. Added method
* handleReplaceBetween(); other methods unchanged.
* 06/25/01 grhoten Remove dependency on iostream.
******************************************************************************
*/
#ifndef UNISTR_H
#define UNISTR_H
#include "unicode/utypes.h"
#include "unicode/rep.h"
#include "unicode/uchar.h"
struct UConverter; // unicode/ucnv.h
U_NAMESPACE_BEGIN
class Locale; // unicode/locid.h
class UCharReference;
class UnicodeConverter; // unicode/convert.h
class StringCharacterIterator;
class SearchIterator;
class StringSearch;
/* The <iostream> include has been moved to unicode/ustream.h */
/**
* Unicode String literals in C++.
* Dependent on the platform properties, different UnicodeString
* constructors should be used to create a UnicodeString object from
* a string literal.
* The macros are defined for maximum performance.
* They work only for strings that contain "invariant characters", i.e.,
* only latin letters, digits, and some punctuation.
* See utypes.h for details.
*
* The string parameter must be a C string literal.
* The length of the string, not including the terminating
* <code>NUL</code>, must be specified as a constant.
* The U_STRING_DECL macro should be invoked exactly once for one
* such string variable before it is used.
*/
#if U_SIZEOF_WCHAR_T==U_SIZEOF_UCHAR && U_CHARSET_FAMILY==U_ASCII_FAMILY
# define UNICODE_STRING(cs, length) UnicodeString(TRUE, (UChar *)L ## cs, length)
#elif U_SIZEOF_UCHAR==1 && U_CHARSET_FAMILY==U_ASCII_FAMILY
# define UNICODE_STRING(cs, length) UnicodeString(TRUE, (UChar *)cs, length)
#else
# define UNICODE_STRING(cs, length) UnicodeString(cs, length, "")
#endif
/**
* UnicodeString is a string class that stores Unicode characters directly and provides
* similar functionality as the Java String class.
* It is a concrete implementation of the abstract class Replaceable (for transliteration).
*
* <p>In ICU, strings are stored and used as UTF-16.
* This means that a string internally consists of 16-bit Unicode <i>code units</i>.<br>
* UTF-16 is a variable-length encoding: A Unicode character may be stored with either
* one code unit &mdash; which is the most common case &mdash; or with a matched pair of
* special code units ("surrogates").
* The data type for code units is UChar.<br>
* For single-character handling, a Unicode character code <i>point</i> is a scalar value
* in the range 0..0x10ffff. ICU uses the UChar32 type for code points.</p>
*
* <p>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 UTF_SET_CHAR_START() and UTF_SET_CHAR_LIMIT(), see utf.h).</p>
*
* <p>UnicodeString uses four storage models:
* <ol>
* <li>Short strings are normally stored inside the UnicodeString object itself.
* The object has fields for the "bookkeeping" and a small UChar array.
* When the object is copied, then the internal characters are copied
* into the destination object.</li>
* <li>Longer strings are normally stored in allocated memory.
* The allocated UChar array is preceeded by a reference counter.
* When the string object is copied, then the allocated buffer is shared by
* incrementing the reference counter.</li>
* <li>A UnicodeString can be constructed or setTo() such that it aliases a read-only
* buffer instead of copying the characters. In this case, the string object
* uses this aliased buffer for as long as it is not modified, and it will never
* attempt to modify or release the buffer. This has copy-on-write semantics:
* When the string object is modified, then the buffer contents is first copied
* into writable memory (inside the object for short strings, or allocated
* buffer for longer strings). When a UnicodeString with a read-only alias
* is assigned to another UnicodeString, then both string objects will
* share the same read-only alias.</li>
* <li>A UnicodeString can be constructed or setTo() such that it aliases a writable
* buffer instead of copying the characters. The difference from the above is that
* the string object will write through to this aliased buffer for write
* operations. Only when the capacity of the buffer is not sufficient is
* a new buffer allocated and the contents copied.
* An efficient way to get the string contents into the original buffer is
* to use the extract(..., UChar *dst, ...) function: It will only copy the
* string contents if the dst buffer is different from the buffer of the string
* object itself. If a string grows and shrinks during a sequence of operations,
* then it will not use the same buffer any more, but may fit into it again.
* When a UnicodeString with a writable alias is assigned to another UnicodeString,
* then the contents is always copied. The destination string will not alias
* to the buffer that the source string aliases.</li>
* </ol></p>
*
* @see Unicode
*/
class U_COMMON_API UnicodeString : public Replaceable
{
public:
//========================================
// Read-only operations
//========================================
/* Comparison - bitwise only - for international comparison use collation */
/**
* Equality operator. Performs only bitwise comparison.
* @param text The UnicodeString to compare to this one.
* @return TRUE if <TT>text</TT> contains the same characters as this one,
* FALSE otherwise.
* @stable
*/
inline UBool operator== (const UnicodeString& text) const;
/**
* Inequality operator. Performs only bitwise comparison.
* @param text The UnicodeString to compare to this one.
* @return FALSE if <TT>text</TT> contains the same characters as this one,
* TRUE otherwise.
* @stable
*/
inline UBool operator!= (const UnicodeString& text) const;
/**
* Greater than operator. Performs only bitwise comparison.
* @param text The UnicodeString to compare to this one.
* @return TRUE if the characters in <TT>text</TT> are bitwise
* greater than the characters in this, FALSE otherwise
* @stable
*/
inline UBool operator> (const UnicodeString& text) const;
/**
* Less than operator. Performs only bitwise comparison.
* @param text The UnicodeString to compare to this one.
* @return TRUE if the characters in <TT>text</TT> are bitwise
* less than the characters in this, FALSE otherwise
* @stable
*/
inline UBool operator< (const UnicodeString& text) const;
/**
* Greater than or equal operator. Performs only bitwise comparison.
* @param text The UnicodeString to compare to this one.
* @return TRUE if the characters in <TT>text</TT> are bitwise
* greater than or equal to the characters in this, FALSE otherwise
* @stable
*/
inline UBool operator>= (const UnicodeString& text) const;
/**
* Less than or equal operator. Performs only bitwise comparison.
* @param text The UnicodeString to compare to this one.
* @return TRUE if the characters in <TT>text</TT> are bitwise
* less than or equal to the characters in this, FALSE otherwise
* @stable
*/
inline UBool operator<= (const UnicodeString& text) const;
/**
* Compare the characters bitwise in this UnicodeString to
* the characters in <TT>text</TT>.
* @param text The UnicodeString to compare to this one.
* @return The result of bitwise character comparison: 0 if <TT>text</TT>
* contains the same characters as this, -1 if the characters in
* <TT>text</TT> are bitwise less than the characters in this, +1 if the
* characters in <TT>text</TT> are bitwise greater than the characters
* in this.
* @stable
*/
inline int8_t compare(const UnicodeString& text) const;
/**
* Compare the characters bitwise in the range
* [<TT>start</TT>, <TT>start + length</TT>) with the characters
* in <TT>srcText</TT>
* @param start the offset at which the compare operation begins
* @param length the number of characters of text to compare.
* @param srcText the text to be compared
* @return The result of bitwise character comparison: 0 if <TT>text</TT>
* contains the same characters as this, -1 if the characters in
* <TT>text</TT> are bitwise less than the characters in this, +1 if the
* characters in <TT>text</TT> are bitwise greater than the characters
* in this.
* @stable
*/
inline int8_t compare(UTextOffset start,
int32_t length,
const UnicodeString& srcText) const;
/**
* Compare the characters bitwise in the range
* [<TT>start</TT>, <TT>start + length</TT>) with the characters
* in <TT>srcText</TT> in the range
* [<TT>srcStart</TT>, <TT>srcStart + srcLength</TT>).
* @param start the offset at which the compare operation begins
* @param length the number of characters in this to compare.
* @param srcText the text to be compared
* @param srcStart the offset into <TT>srcText</TT> to start comparison
* @param srcLength the number of characters in <TT>src</TT> to compare
* @return The result of bitwise character comparison: 0 if <TT>text</TT>
* contains the same characters as this, -1 if the characters in
* <TT>text</TT> are bitwise less than the characters in this, +1 if the
* characters in <TT>text</TT> are bitwise greater than the characters
* in this.
* @stable
*/
inline int8_t compare(UTextOffset start,
int32_t length,
const UnicodeString& srcText,
UTextOffset srcStart,
int32_t srcLength) const;
/**
* Compare the characters bitwise in this UnicodeString with the first
* <TT>srcLength</TT> characters in <TT>srcChars</TT>.
* @param srcChars The characters to compare to this UnicodeString.
* @param srcLength the number of characters in <TT>srcChars</TT> to compare
* @return The result of bitwise character comparison: 0 if <TT>text</TT>
* contains the same characters as this, -1 if the characters in
* <TT>text</TT> are bitwise less than the characters in this, +1 if the
* characters in <TT>text</TT> are bitwise greater than the characters
* in this.
* @stable
*/
inline int8_t compare(const UChar *srcChars,
int32_t srcLength) const;
/**
* Compare the characters bitwise in the range
* [<TT>start</TT>, <TT>start + length</TT>) with the first
* <TT>length</TT> characters in <TT>srcChars</TT>
* @param start the offset at which the compare operation begins
* @param length the number of characters to compare.
* @param srcChars the characters to be compared
* @return The result of bitwise character comparison: 0 if <TT>text</TT>
* contains the same characters as this, -1 if the characters in
* <TT>text</TT> are bitwise less than the characters in this, +1 if the
* characters in <TT>text</TT> are bitwise greater than the characters
* in this.
* @stable
*/
inline int8_t compare(UTextOffset start,
int32_t length,
const UChar *srcChars) const;
/**
* Compare the characters bitwise in the range
* [<TT>start</TT>, <TT>start + length</TT>) with the characters
* in <TT>srcChars</TT> in the range
* [<TT>srcStart</TT>, <TT>srcStart + srcLength</TT>).
* @param start the offset at which the compare operation begins
* @param length the number of characters in this to compare
* @param srcChars the characters to be compared
* @param srcStart the offset into <TT>srcChars</TT> to start comparison
* @param srcLength the number of characters in <TT>srcChars</TT> to compare
* @return The result of bitwise character comparison: 0 if <TT>text</TT>
* contains the same characters as this, -1 if the characters in
* <TT>text</TT> are bitwise less than the characters in this, +1 if the
* characters in <TT>text</TT> are bitwise greater than the characters
* in this.
* @stable
*/
inline int8_t compare(UTextOffset start,
int32_t length,
const UChar *srcChars,
UTextOffset srcStart,
int32_t srcLength) const;
/**
* Compare the characters bitwise in the range
* [<TT>start</TT>, <TT>limit</TT>) with the characters
* in <TT>srcText</TT> in the range
* [<TT>srcStart</TT>, <TT>srcLimit</TT>).
* @param start the offset at which the compare operation begins
* @param limit the offset immediately following the compare operation
* @param srcText the text to be compared
* @param srcStart the offset into <TT>srcText</TT> to start comparison
* @param srcLimit the offset into <TT>srcText</TT> to limit comparison
* @return The result of bitwise character comparison: 0 if <TT>text</TT>
* contains the same characters as this, -1 if the characters in
* <TT>text</TT> are bitwise less than the characters in this, +1 if the
* characters in <TT>text</TT> are bitwise greater than the characters
* in this.
* @stable
*/
inline int8_t compareBetween(UTextOffset start,
UTextOffset limit,
const UnicodeString& srcText,
UTextOffset srcStart,
UTextOffset srcLimit) const;
/**
* Compare two Unicode strings in code point order.
* This is different in UTF-16 from how compare(), operator==, startsWith() etc. work
* 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.
*
* @param text Another string to compare this one to.
* @return a negative/zero/positive integer corresponding to whether
* this string is less than/equal to/greater than the second one
* in code point order
* @draft
*/
inline int8_t compareCodePointOrder(const UnicodeString& text) const;
/**
* Compare two Unicode strings in code point order.
* This is different in UTF-16 from how compare(), operator==, startsWith() etc. work
* 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.
*
* @param start The start offset in this string at which the compare operation begins.
* @param length The number of code units from this string to compare.
* @param srcText Another string to compare this one to.
* @return a negative/zero/positive integer corresponding to whether
* this string is less than/equal to/greater than the second one
* in code point order
* @draft
*/
inline int8_t compareCodePointOrder(UTextOffset start,
int32_t length,
const UnicodeString& srcText) const;
/**
* Compare two Unicode strings in code point order.
* This is different in UTF-16 from how compare(), operator==, startsWith() etc. work
* 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.
*
* @param start The start offset in this string at which the compare operation begins.
* @param length The number of code units from this string to compare.
* @param srcText Another string to compare this one to.
* @param srcStart The start offset in that string at which the compare operation begins.
* @param srcLength The number of code units from that string to compare.
* @return a negative/zero/positive integer corresponding to whether
* this string is less than/equal to/greater than the second one
* in code point order
* @draft
*/
inline int8_t compareCodePointOrder(UTextOffset start,
int32_t length,
const UnicodeString& srcText,
UTextOffset srcStart,
int32_t srcLength) const;
/**
* Compare two Unicode strings in code point order.
* This is different in UTF-16 from how compare(), operator==, startsWith() etc. work
* 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.
*
* @param srcChars A pointer to another string to compare this one to.
* @param srcLength The number of code units from that string to compare.
* @return a negative/zero/positive integer corresponding to whether
* this string is less than/equal to/greater than the second one
* in code point order
* @draft
*/
inline int8_t compareCodePointOrder(const UChar *srcChars,
int32_t srcLength) const;
/**
* Compare two Unicode strings in code point order.
* This is different in UTF-16 from how compare(), operator==, startsWith() etc. work
* 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.
*
* @param start The start offset in this string at which the compare operation begins.
* @param length The number of code units from this string to compare.
* @param srcChars A pointer to another string to compare this one to.
* @return a negative/zero/positive integer corresponding to whether
* this string is less than/equal to/greater than the second one
* in code point order
* @draft
*/
inline int8_t compareCodePointOrder(UTextOffset start,
int32_t length,
const UChar *srcChars) const;
/**
* Compare two Unicode strings in code point order.
* This is different in UTF-16 from how compare(), operator==, startsWith() etc. work
* 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.
*
* @param start The start offset in this string at which the compare operation begins.
* @param length The number of code units from this string to compare.
* @param srcChars A pointer to another string to compare this one to.
* @param srcStart The start offset in that string at which the compare operation begins.
* @param srcLength The number of code units from that string to compare.
* @return a negative/zero/positive integer corresponding to whether
* this string is less than/equal to/greater than the second one
* in code point order
* @draft
*/
inline int8_t compareCodePointOrder(UTextOffset start,
int32_t length,
const UChar *srcChars,
UTextOffset srcStart,
int32_t srcLength) const;
/**
* Compare two Unicode strings in code point order.
* This is different in UTF-16 from how compare(), operator==, startsWith() etc. work
* 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.
*
* @param start The start offset in this string at which the compare operation begins.
* @param limit The offset after the last code unit from this string to compare.
* @param srcText Another string to compare this one to.
* @param srcStart The start offset in that string at which the compare operation begins.
* @param srcLimit The offset after the last code unit from that string to compare.
* @return a negative/zero/positive integer corresponding to whether
* this string is less than/equal to/greater than the second one
* in code point order
* @draft
*/
inline int8_t compareCodePointOrderBetween(UTextOffset start,
UTextOffset limit,
const UnicodeString& srcText,
UTextOffset srcStart,
UTextOffset srcLimit) const;
/**
* Compare two strings case-insensitively using full case folding.
* This is equivalent to this->foldCase(options).compare(text.foldCase(options)).
*
* @param text Another string to compare this one to.
* @param options Either U_FOLD_CASE_DEFAULT or U_FOLD_CASE_EXCLUDE_SPECIAL_I
* @return A negative, zero, or positive integer indicating the comparison result.
* @draft
*/
inline int8_t caseCompare(const UnicodeString& text, uint32_t options) const;
/**
* Compare two strings case-insensitively using full case folding.
* This is equivalent to this->foldCase(options).compare(srcText.foldCase(options)).
*
* @param start The start offset in this string at which the compare operation begins.
* @param length The number of code units from this string to compare.
* @param srcText Another string to compare this one to.
* @param options Either U_FOLD_CASE_DEFAULT or U_FOLD_CASE_EXCLUDE_SPECIAL_I
* @return A negative, zero, or positive integer indicating the comparison result.
* @draft
*/
inline int8_t caseCompare(UTextOffset start,
int32_t length,
const UnicodeString& srcText,
uint32_t options) const;
/**
* Compare two strings case-insensitively using full case folding.
* This is equivalent to this->foldCase(options).compare(srcText.foldCase(options)).
*
* @param start The start offset in this string at which the compare operation begins.
* @param length The number of code units from this string to compare.
* @param srcText Another string to compare this one to.
* @param srcStart The start offset in that string at which the compare operation begins.
* @param srcLength The number of code units from that string to compare.
* @param options Either U_FOLD_CASE_DEFAULT or U_FOLD_CASE_EXCLUDE_SPECIAL_I
* @return A negative, zero, or positive integer indicating the comparison result.
* @draft
*/
inline int8_t caseCompare(UTextOffset start,
int32_t length,
const UnicodeString& srcText,
UTextOffset srcStart,
int32_t srcLength,
uint32_t options) const;
/**
* Compare two strings case-insensitively using full case folding.
* This is equivalent to this->foldCase(options).compare(srcChars.foldCase(options)).
*
* @param srcChars A pointer to another string to compare this one to.
* @param srcLength The number of code units from that string to compare.
* @param options Either U_FOLD_CASE_DEFAULT or U_FOLD_CASE_EXCLUDE_SPECIAL_I
* @return A negative, zero, or positive integer indicating the comparison result.
* @draft
*/
inline int8_t caseCompare(const UChar *srcChars,
int32_t srcLength,
uint32_t options) const;
/**
* Compare two strings case-insensitively using full case folding.
* This is equivalent to this->foldCase(options).compare(srcChars.foldCase(options)).
*
* @param start The start offset in this string at which the compare operation begins.
* @param length The number of code units from this string to compare.
* @param srcChars A pointer to another string to compare this one to.
* @param options Either U_FOLD_CASE_DEFAULT or U_FOLD_CASE_EXCLUDE_SPECIAL_I
* @return A negative, zero, or positive integer indicating the comparison result.
* @draft
*/
inline int8_t caseCompare(UTextOffset start,
int32_t length,
const UChar *srcChars,
uint32_t options) const;
/**
* Compare two strings case-insensitively using full case folding.
* This is equivalent to this->foldCase(options).compare(srcChars.foldCase(options)).
*
* @param start The start offset in this string at which the compare operation begins.
* @param length The number of code units from this string to compare.
* @param srcChars A pointer to another string to compare this one to.
* @param srcStart The start offset in that string at which the compare operation begins.
* @param srcLength The number of code units from that string to compare.
* @param options Either U_FOLD_CASE_DEFAULT or U_FOLD_CASE_EXCLUDE_SPECIAL_I
* @return A negative, zero, or positive integer indicating the comparison result.
* @draft
*/
inline int8_t caseCompare(UTextOffset start,
int32_t length,
const UChar *srcChars,
UTextOffset srcStart,
int32_t srcLength,
uint32_t options) const;
/**
* Compare two strings case-insensitively using full case folding.
* This is equivalent to this->foldCase(options).compareBetween(text.foldCase(options)).
*
* @param start The start offset in this string at which the compare operation begins.
* @param limit The offset after the last code unit from this string to compare.
* @param srcText Another string to compare this one to.
* @param srcStart The start offset in that string at which the compare operation begins.
* @param srcLimit The offset after the last code unit from that string to compare.
* @param options Either U_FOLD_CASE_DEFAULT or U_FOLD_CASE_EXCLUDE_SPECIAL_I
* @return A negative, zero, or positive integer indicating the comparison result.
* @draft
*/
inline int8_t caseCompareBetween(UTextOffset start,
UTextOffset limit,
const UnicodeString& srcText,
UTextOffset srcStart,
UTextOffset srcLimit,
uint32_t options) const;
/**
* Determine if this starts with the characters in <TT>text</TT>
* @param text The text to match.
* @return TRUE if this starts with the characters in <TT>text</TT>,
* FALSE otherwise
* @stable
*/
inline UBool startsWith(const UnicodeString& text) const;
/**
* Determine if this starts with the characters in <TT>srcText</TT>
* in the range [<TT>srcStart</TT>, <TT>srcStart + srcLength</TT>).
* @param srcText The text to match.
* @param srcStart the offset into <TT>srcText</TT> to start matching
* @param srcLength the number of characters in <TT>srcText</TT> to match
* @return TRUE if this starts with the characters in <TT>text</TT>,
* FALSE otherwise
* @stable
*/
inline UBool startsWith(const UnicodeString& srcText,
UTextOffset srcStart,
int32_t srcLength) const;
/**
* Determine if this starts with the characters in <TT>srcChars</TT>
* @param srcChars The characters to match.
* @param srcLength the number of characters in <TT>srcChars</TT>
* @return TRUE if this starts with the characters in <TT>srcChars</TT>,
* FALSE otherwise
* @stable
*/
inline UBool startsWith(const UChar *srcChars,
int32_t srcLength) const;
/**
* Determine if this ends with the characters in <TT>srcChars</TT>
* in the range [<TT>srcStart</TT>, <TT>srcStart + srcLength</TT>).
* @param srcChars The characters to match.
* @param srcStart the offset into <TT>srcText</TT> to start matching
* @param srcLength the number of characters in <TT>srcChars</TT> to match
* @return TRUE if this ends with the characters in <TT>srcChars</TT>,
FALSE otherwise
* @stable
*/
inline UBool startsWith(const UChar *srcChars,
UTextOffset srcStart,
int32_t srcLength) const;
/**
* Determine if this ends with the characters in <TT>text</TT>
* @param text The text to match.
* @return TRUE if this ends with the characters in <TT>text</TT>,
* FALSE otherwise
* @stable
*/
inline UBool endsWith(const UnicodeString& text) const;
/**
* Determine if this ends with the characters in <TT>srcText</TT>
* in the range [<TT>srcStart</TT>, <TT>srcStart + srcLength</TT>).
* @param srcText The text to match.
* @param srcStart the offset into <TT>srcText</TT> to start matching
* @param srcLength the number of characters in <TT>srcText</TT> to match
* @return TRUE if this ends with the characters in <TT>text</TT>,
* FALSE otherwise
* @stable
*/
inline UBool endsWith(const UnicodeString& srcText,
UTextOffset srcStart,
int32_t srcLength) const;
/**
* Determine if this ends with the characters in <TT>srcChars</TT>
* @param srcChars The characters to match.
* @param srcLength the number of characters in <TT>srcChars</TT>
* @return TRUE if this ends with the characters in <TT>srcChars</TT>,
* FALSE otherwise
* @stable
*/
inline UBool endsWith(const UChar *srcChars,
int32_t srcLength) const;
/**
* Determine if this ends with the characters in <TT>srcChars</TT>
* in the range [<TT>srcStart</TT>, <TT>srcStart + srcLength</TT>).
* @param srcChars The characters to match.
* @param srcStart the offset into <TT>srcText</TT> to start matching
* @param srcLength the number of characters in <TT>srcChars</TT> to match
* @return TRUE if this ends with the characters in <TT>srcChars</TT>,
* FALSE otherwise
* @stable
*/
inline UBool endsWith(const UChar *srcChars,
UTextOffset srcStart,
int32_t srcLength) const;
/* Searching - bitwise only */
/**
* Locate in this the first occurrence of the characters in <TT>text</TT>,
* using bitwise comparison.
* @param text The text to search for.
* @return The offset into this of the start of <TT>text</TT>,
* or -1 if not found.
* @stable
*/
inline UTextOffset indexOf(const UnicodeString& text) const;
/**
* Locate in this the first occurrence of the characters in <TT>text</TT>
* starting at offset <TT>start</TT>, using bitwise comparison.
* @param text The text to search for.
* @param start The offset at which searching will start.
* @return The offset into this of the start of <TT>text</TT>,
* or -1 if not found.
* @stable
*/
inline UTextOffset indexOf(const UnicodeString& text,
UTextOffset start) const;
/**
* Locate in this the first occurrence in the range
* [<TT>start</TT>, <TT>start + length</TT>) of the characters
* in <TT>text</TT>, using bitwise comparison.
* @param text The text to search for.
* @param start The offset at which searching will start.
* @param length The number of characters to search
* @return The offset into this of the start of <TT>text</TT>,
* or -1 if not found.
* @stable
*/
inline UTextOffset indexOf(const UnicodeString& text,
UTextOffset start,
int32_t length) const;
/**
* Locate in this the first occurrence in the range
* [<TT>start</TT>, <TT>start + length</TT>) of the characters
* in <TT>srcText</TT> in the range
* [<TT>srcStart</TT>, <TT>srcStart + srcLength</TT>),
* using bitwise comparison.
* @param text The text to search for.
* @param srcStart the offset into <TT>srcText</TT> at which
* to start matching
* @param srcLength the number of characters in <TT>srcText</TT> to match
* @param start the offset into this at which to start matching
* @param length the number of characters in this to search
* @return The offset into this of the start of <TT>text</TT>,
* or -1 if not found.
* @stable
*/
inline UTextOffset indexOf(const UnicodeString& srcText,
UTextOffset srcStart,
int32_t srcLength,
UTextOffset start,
int32_t length) const;
/**
* Locate in this the first occurrence of the characters in
* <TT>srcChars</TT>
* starting at offset <TT>start</TT>, using bitwise comparison.
* @param srcChars The text to search for.
* @param srcLength the number of characters in <TT>srcChars</TT> to match
* @param start the offset into this at which to start matching
* @return The offset into this of the start of <TT>text</TT>,
* or -1 if not found.
* @stable
*/
inline UTextOffset indexOf(const UChar *srcChars,
int32_t srcLength,
UTextOffset start) const;
/**
* Locate in this the first occurrence in the range
* [<TT>start</TT>, <TT>start + length</TT>) of the characters
* in <TT>srcChars</TT>, using bitwise comparison.
* @param text The text to search for.
* @param srcLength the number of characters in <TT>srcChars</TT>
* @param start The offset at which searching will start.
* @param length The number of characters to search
* @return The offset into this of the start of <TT>srcChars</TT>,
* or -1 if not found.
* @stable
*/
inline UTextOffset indexOf(const UChar *srcChars,
int32_t srcLength,
UTextOffset start,
int32_t length) const;
/**
* Locate in this the first occurrence in the range
* [<TT>start</TT>, <TT>start + length</TT>) of the characters
* in <TT>srcChars</TT> in the range
* [<TT>srcStart</TT>, <TT>srcStart + srcLength</TT>),
* using bitwise comparison.
* @param srcChars The text to search for.
* @param srcStart the offset into <TT>srcChars</TT> at which
* to start matching
* @param srcLength the number of characters in <TT>srcChars</TT> to match
* @param start the offset into this at which to start matching
* @param length the number of characters in this to search
* @return The offset into this of the start of <TT>text</TT>,
* or -1 if not found.
* @stable
*/
UTextOffset indexOf(const UChar *srcChars,
UTextOffset srcStart,
int32_t srcLength,
UTextOffset start,
int32_t length) const;
/**
* Locate in this the first occurrence of the code unit <TT>c</TT>,
* using bitwise comparison.
* @param c The code unit to search for.
* @return The offset into this of <TT>c</TT>, or -1 if not found.
* @draft
*/
inline UTextOffset indexOf(UChar c) const;
/**
* Locate in this the first occurrence of the code point <TT>c</TT>,
* using bitwise comparison.
* @param c The code point to search for.
* @return The offset into this of <TT>c</TT>, or -1 if not found.
* @draft
*/
inline UTextOffset indexOf(UChar32 c) const;
/**
* Locate in this the first occurrence of the code unit <TT>c</TT>
* starting at offset <TT>start</TT>, using bitwise comparison.
* @param c The code unit to search for.
* @param start The offset at which searching will start.
* @return The offset into this of <TT>c</TT>, or -1 if not found.
* @draft
*/
inline UTextOffset indexOf(UChar c,
UTextOffset start) const;
/**
* Locate in this the first occurrence of the code point <TT>c</TT>
* starting at offset <TT>start</TT>, using bitwise comparison.
* @param c The code point to search for.
* @param start The offset at which searching will start.
* @return The offset into this of <TT>c</TT>, or -1 if not found.
* @draft
*/
inline UTextOffset indexOf(UChar32 c,
UTextOffset start) const;
/**
* Locate in this the first occurrence of the code unit <TT>c</TT>
* in the range [<TT>start</TT>, <TT>start + length</TT>),
* using bitwise comparison.
* @param c The code unit to search for.
* @param start the offset into this at which to start matching
* @param length the number of characters in this to search
* @return The offset into this of <TT>c</TT>, or -1 if not found.
* @draft
*/
inline UTextOffset indexOf(UChar c,
UTextOffset start,
int32_t length) const;
/**
* Locate in this the first occurrence of the code point <TT>c</TT>
* in the range [<TT>start</TT>, <TT>start + length</TT>),
* using bitwise comparison.
* @param c The code point to search for.
* @param start the offset into this at which to start matching
* @param length the number of characters in this to search
* @return The offset into this of <TT>c</TT>, or -1 if not found.
* @draft
*/
inline UTextOffset indexOf(UChar32 c,
UTextOffset start,
int32_t length) const;
/**
* Locate in this the last occurrence of the characters in <TT>text</TT>,
* using bitwise comparison.
* @param text The text to search for.
* @return The offset into this of the start of <TT>text</TT>,
* or -1 if not found.
* @stable
*/
inline UTextOffset lastIndexOf(const UnicodeString& text) const;
/**
* Locate in this the last occurrence of the characters in <TT>text</TT>
* starting at offset <TT>start</TT>, using bitwise comparison.
* @param text The text to search for.
* @param start The offset at which searching will start.
* @return The offset into this of the start of <TT>text</TT>,
* or -1 if not found.
* @stable
*/
inline UTextOffset lastIndexOf(const UnicodeString& text,
UTextOffset start) const;
/**
* Locate in this the last occurrence in the range
* [<TT>start</TT>, <TT>start + length</TT>) of the characters
* in <TT>text</TT>, using bitwise comparison.
* @param text The text to search for.
* @param start The offset at which searching will start.
* @param length The number of characters to search
* @return The offset into this of the start of <TT>text</TT>,
* or -1 if not found.
* @stable
*/
inline UTextOffset lastIndexOf(const UnicodeString& text,
UTextOffset start,
int32_t length) const;
/**
* Locate in this the last occurrence in the range
* [<TT>start</TT>, <TT>start + length</TT>) of the characters
* in <TT>srcText</TT> in the range
* [<TT>srcStart</TT>, <TT>srcStart + srcLength</TT>),
* using bitwise comparison.
* @param text The text to search for.
* @param srcStart the offset into <TT>srcText</TT> at which
* to start matching
* @param srcLength the number of characters in <TT>srcText</TT> to match
* @param start the offset into this at which to start matching
* @param length the number of characters in this to search
* @return The offset into this of the start of <TT>text</TT>,
* or -1 if not found.
* @stable
*/
inline UTextOffset lastIndexOf(const UnicodeString& srcText,
UTextOffset srcStart,
int32_t srcLength,
UTextOffset start,
int32_t length) const;
/**
* Locate in this the last occurrence of the characters in <TT>srcChars</TT>
* starting at offset <TT>start</TT>, using bitwise comparison.
* @param srcChars The text to search for.
* @param srcLength the number of characters in <TT>srcChars</TT> to match
* @param start the offset into this at which to start matching
* @return The offset into this of the start of <TT>text</TT>,
* or -1 if not found.
* @stable
*/
inline UTextOffset lastIndexOf(const UChar *srcChars,
int32_t srcLength,
UTextOffset start) const;
/**
* Locate in this the last occurrence in the range
* [<TT>start</TT>, <TT>start + length</TT>) of the characters
* in <TT>srcChars</TT>, using bitwise comparison.
* @param text The text to search for.
* @param srcLength the number of characters in <TT>srcChars</TT>
* @param start The offset at which searching will start.
* @param length The number of characters to search
* @return The offset into this of the start of <TT>srcChars</TT>,
* or -1 if not found.
* @stable
*/
inline UTextOffset lastIndexOf(const UChar *srcChars,
int32_t srcLength,
UTextOffset start,
int32_t length) const;
/**
* Locate in this the last occurrence in the range
* [<TT>start</TT>, <TT>start + length</TT>) of the characters
* in <TT>srcChars</TT> in the range
* [<TT>srcStart</TT>, <TT>srcStart + srcLength</TT>),
* using bitwise comparison.
* @param srcChars The text to search for.
* @param srcStart the offset into <TT>srcChars</TT> at which
* to start matching
* @param srcLength the number of characters in <TT>srcChars</TT> to match
* @param start the offset into this at which to start matching
* @param length the number of characters in this to search
* @return The offset into this of the start of <TT>text</TT>,
* or -1 if not found.
* @stable
*/
UTextOffset lastIndexOf(const UChar *srcChars,
UTextOffset srcStart,
int32_t srcLength,
UTextOffset start,
int32_t length) const;
/**
* Locate in this the last occurrence of the code unit <TT>c</TT>,
* using bitwise comparison.
* @param c The code unit to search for.
* @return The offset into this of <TT>c</TT>, or -1 if not found.
* @draft
*/
inline UTextOffset lastIndexOf(UChar c) const;
/**
* Locate in this the last occurrence of the code point <TT>c</TT>,
* using bitwise comparison.
* @param c The code point to search for.
* @return The offset into this of <TT>c</TT>, or -1 if not found.
* @draft
*/
inline UTextOffset lastIndexOf(UChar32 c) const;
/**
* Locate in this the last occurrence of the code unit <TT>c</TT>
* starting at offset <TT>start</TT>, using bitwise comparison.
* @param c The code unit to search for.
* @param start The offset at which searching will start.
* @return The offset into this of <TT>c</TT>, or -1 if not found.
* @draft
*/
inline UTextOffset lastIndexOf(UChar c,
UTextOffset start) const;
/**
* Locate in this the last occurrence of the code point <TT>c</TT>
* starting at offset <TT>start</TT>, using bitwise comparison.
* @param c The code point to search for.
* @param start The offset at which searching will start.
* @return The offset into this of <TT>c</TT>, or -1 if not found.
* @draft
*/
inline UTextOffset lastIndexOf(UChar32 c,
UTextOffset start) const;
/**
* Locate in this the last occurrence of the code unit <TT>c</TT>
* in the range [<TT>start</TT>, <TT>start + length</TT>),
* using bitwise comparison.
* @param c The code unit to search for.
* @param start the offset into this at which to start matching
* @param length the number of characters in this to search
* @return The offset into this of <TT>c</TT>, or -1 if not found.
* @draft
*/
inline UTextOffset lastIndexOf(UChar c,
UTextOffset start,
int32_t length) const;
/**
* Locate in this the last occurrence of the code point <TT>c</TT>
* in the range [<TT>start</TT>, <TT>start + length</TT>),
* using bitwise comparison.
* @param c The code point to search for.
* @param start the offset into this at which to start matching
* @param length the number of characters in this to search
* @return The offset into this of <TT>c</TT>, or -1 if not found.
* @draft
*/
inline UTextOffset lastIndexOf(UChar32 c,
UTextOffset start,
int32_t length) const;
/* Character access */
/**
* Return the code unit at offset <tt>offset</tt>.
* @param offset a valid offset into the text
* @returns the code unit at offset <tt>offset</tt>
* @draft
*/
inline UChar charAt(UTextOffset offset) const;
/**
* Return the code unit at offset <tt>offset</tt>.
* @param offset a valid offset into the text
* @returns the code unit at offset <tt>offset</tt>
* @draft
*/
inline UChar operator [] (UTextOffset offset) const;
/**
* Return the code point that contains the code unit
* at offset <tt>offset</tt>.
* @param 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 <tt>offset</tt>
* @draft
*/
inline UChar32 char32At(UTextOffset offset) const;
/**
* 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.
* @param offset a valid offset into one code point of the text
* @return offset of the first code unit of the same code point
* @draft ICU 2.0
*/
inline UTextOffset getChar32Start(UTextOffset offset) const;
/**
* Same as getChar32Start().
* This original function name (without "32")
* was meant to look like UTF_SET_CHAR_START,
* but since most code point-related function names in C++ APIs
* contain a "32", this caused confusion.
*
* 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.
* @param offset a valid offset into one code point of the text
* @return offset of the first code unit of the same code point
* @deprecated To be removed after 2002-sep-30. Use getChar32Start().
*/
inline UTextOffset getCharStart(UTextOffset offset) const;
/**
* 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).
* @param offset a valid offset after any code unit of a code point of the text
* @return offset of the first code unit after the same code point
* @draft ICU 2.0
*/
inline UTextOffset getChar32Limit(UTextOffset offset) const;
/**
* Same as getChar32Limit().
* This original function name (without "32")
* was meant to look like UTF_SET_CHAR_LIMIT,
* but since most code point-related function names in C++ APIs
* contain a "32", this caused confusion.
*
* 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).
* @param offset a valid offset after any code unit of a code point of the text
* @return offset of the first code unit after the same code point
* @deprecated To be removed after 2002-sep-30. Use getChar32Limit().
*/
inline UTextOffset getCharLimit(UTextOffset offset) const;
/**
* 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).
*
* Examples:
* <pre>
* // 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
* UTextOffset 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
* </pre>
*
* @param index input code unit index
* @param delta (signed) code point count to move the index forward or backward
* in the string
* @return the resulting code unit index
* @draft
*/
UTextOffset moveIndex32(UTextOffset index, int32_t delta) const;
/* Substring extraction */
/**
* Copy the characters in the range
* [<tt>start</tt>, <tt>start + length</tt>) into the array <tt>dst</tt>,
* beginning at <tt>dstStart</tt>.
* If the string aliases to <code>dst</code> itself as an external buffer,
* then extract() will not copy the contents.
*
* @param start offset of first character which will be copied into the array
* @param length the number of characters to extract
* @param dst array in which to copy characters. The length of <tt>dst</tt>
* must be at least (<tt>dstStart + length</tt>).
* @param dstStart the offset in <TT>dst</TT> where the first character
* will be extracted
* @stable
*/
inline void extract(UTextOffset start,
int32_t length,
UChar *dst,
UTextOffset dstStart = 0) 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 <code>dest</code> itself as an external buffer,
* then extract() will not copy the contents.
*
* @param dest Destination string buffer.
* @param destCapacity Number of UChars available at dest.
* @param errorCode ICU error code.
* @return length()
* @draft
*/
int32_t
extract(UChar *dest, int32_t destCapacity,
UErrorCode &errorCode) const;
/**
* Copy the characters in the range
* [<tt>start</tt>, <tt>start + length</tt>) into the UnicodeString
* <tt>target</tt>.
* @param start offset of first character which will be copied
* @param length the number of characters to extract
* @param target UnicodeString into which to copy characters.
* @return A reference to <TT>target</TT>
* @stable
*/
inline void extract(UTextOffset start,
int32_t length,
UnicodeString& target) const;
/**
* Copy the characters in the range [<tt>start</tt>, <tt>limit</tt>)
* into the array <tt>dst</tt>, beginning at <tt>dstStart</tt>.
* @param start offset of first character which will be copied into the array
* @param limit offset immediately following the last character to be copied
* @param dst array in which to copy characters. The length of <tt>dst</tt>
* must be at least (<tt>dstStart + (limit - start)</tt>).
* @param dstStart the offset in <TT>dst</TT> where the first character
* will be extracted
* @stable
*/
inline void extractBetween(UTextOffset start,
UTextOffset limit,
UChar *dst,
UTextOffset dstStart = 0) const;
/**
* Copy the characters in the range [<tt>start</tt>, <tt>limit</tt>)
* into the UnicodeString <tt>target</tt>.
* @param start offset of first character which will be copied
* @param limit offset immediately following the last character to be copied
* @param target UnicodeString into which to copy characters.
* @return A reference to <TT>target</TT>
* @stable
*/
inline void extractBetween(UTextOffset start,
UTextOffset limit,
UnicodeString& target) const;
/**
* Copy the characters in the range
* [<tt>start</TT>, <tt>start + length</TT>) into an array of characters
* in a specified codepage.
* The output string is NUL-terminated.
*
* @param start offset of first character which will be copied
* @param startLength the number of characters to extract
* @param target the target buffer for extraction
* @param codepage the desired codepage for the characters. 0 has
* the special meaning of the default codepage
* If <code>codepage</code> is an empty string (<code>""</code>),
* then a simple conversion is performed on the codepage-invariant
* subset ("invariant characters") of the platform encoding. See utypes.h.
* If <TT>target</TT> is NULL, then the number of bytes required for
* <TT>target</TT> is returned. It is assumed that the target is big enough
* to fit all of the characters.
* @return the output string length, not including the terminating NUL
* @stable
*/
inline int32_t extract(UTextOffset start,
int32_t startLength,
char *target,
const char *codepage = 0) const;
/**
* Copy the characters in the range
* [<tt>start</TT>, <tt>start + length</TT>) into an array of characters
* in a specified codepage.
* This function does not write any more than <code>targetLength</code>
* 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.
*
* @param start offset of first character which will be copied
* @param startLength the number of characters to extract
* @param target the target buffer for extraction
* @param targetLength the length of the target buffer
* @param codepage the desired codepage for the characters. 0 has
* the special meaning of the default codepage
* If <code>codepage</code> is an empty string (<code>""</code>),
* then a simple conversion is performed on the codepage-invariant
* subset ("invariant characters") of the platform encoding. See utypes.h.
* If <TT>target</TT> is NULL, then the number of bytes required for
* <TT>target</TT> is returned.
* @return the output string length, not including the terminating NUL
* @stable
*/
int32_t extract(UTextOffset start,
int32_t startLength,
char *target,
uint32_t targetLength,
const char *codepage = 0) 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.
*
* @param dest destination string buffer, can be NULL if destCapacity==0
* @param destCapacity the number of chars available at dest
* @param cnv the converter object to be used (ucnv_resetFromUnicode() will be called),
* or NULL for the default converter
* @param errorCode normal ICU error code
* @return 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
* @draft
*/
int32_t extract(char *dest, int32_t destCapacity,
UConverter *cnv,
UErrorCode &errorCode) const;
/* Length operations */
/**
* Return the length of the UnicodeString object.
* The length is the number of characters in the text.
* @returns the length of the UnicodeString object
* @stable
*/
inline int32_t length(void) const;
/**
* 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().
*
* @param start the index of the first code unit to check
* @param length the number of UChar code units to check
* @return the number of code points in the specified code units
* @draft ICU 2.0
*/
int32_t
countChar32(UTextOffset start=0, int32_t length=0x7fffffff) const;
/**
* Determine if this string is empty.
* @return TRUE if this string contains 0 characters, FALSE otherwise.
* @draft ICU 2.0
*/
inline UBool isEmpty(void) const;
/**
* Determine if this string is empty.
* This function was renamed to isEmtpy() because it caused confusion.
* If you need to determine if a string is empty, then use isEmpty().
* If you want to remove a string's contents, then call truncate(0).
*
* @return TRUE if this string contains 0 characters, FALSE otherwise.
* @deprecated To be removed after 2002-sep-30. Use isEmtpy() or truncate(0).
*/
inline UBool empty(void) const;
/**
* Return the capacity of the internal buffer of the UnicodeString object.
* This is useful together with the getBuffer functions.
* See there for details.
*
* @return the number of UChars available in the internal buffer
* @see getBuffer
* @draft ICU 2.0 was private before
*/
inline int32_t getCapacity(void) const;
/* Other operations */
/**
* Generate a hash code for this object.
* @return The hash code of this UnicodeString.
* @stable
*/
inline int32_t hashCode(void) const;
/**
* Determine if this string is still valid.
* @return TRUE if the string is valid, FALSE otherwise
* @see setToBogus()
* @draft
*/
inline UBool isBogus(void) const;
//========================================
// Write operations
//========================================
/* Assignment operations */
/**
* Assignment operator. Replace the characters in this UnicodeString
* with the characters from <TT>srcText</TT>.
* @param srcText The text containing the characters to replace
* @return a reference to this
* @stable
*/
UnicodeString& operator= (const UnicodeString& srcText);
/**
* Assignment operator. Replace the characters in this UnicodeString
* with the code unit <TT>ch</TT>.
* @param ch the code unit to replace
* @return a reference to this
* @draft
*/
inline UnicodeString& operator= (UChar ch);
/**
* Assignment operator. Replace the characters in this UnicodeString
* with the code point <TT>ch</TT>.
* @param ch the code point to replace
* @return a reference to this
* @draft
*/
inline UnicodeString& operator= (UChar32 ch);
/**
* Set the text in the UnicodeString object to the characters
* in <TT>srcText</TT> in the range
* [<TT>srcStart</TT>, <TT>srcStart + srcLength</TT>).
* <TT>srcText</TT> is not modified.
* @param srcText the source for the new characters
* @param srcStart the offset into <TT>srcText</TT> where new characters
* will be obtained
* @param srcLength the number of characters in <TT>srcText</TT> in the
* replace string.
* @return a reference to this
* @stable
*/
inline UnicodeString& setTo(const UnicodeString& srcText,
UTextOffset srcStart,
int32_t srcLength);
/**
* Set the text in the UnicodeString object to the characters in
* <TT>srcText</TT>.
* <TT>srcText</TT> is not modified.
* @param srcText the source for the new characters
* @return a reference to this
* @stable
*/
inline UnicodeString& setTo(const UnicodeString& srcText);
/**
* Set the characters in the UnicodeString object to the characters
* in <TT>srcChars</TT>. <TT>srcChars</TT> is not modified.
* @param srcChars the source for the new characters
* @param srcLength the number of Unicode characters in srcChars.
* @return a reference to this
* @stable
*/
inline UnicodeString& setTo(const UChar *srcChars,
int32_t srcLength);
/**
* Set the characters in the UnicodeString object to the code unit
* <TT>srcChar</TT>.
* @param srcChar the code unit which becomes the UnicodeString's character
* content
* @return a reference to this
* @draft
*/
UnicodeString& setTo(UChar srcChar);
/**
* Set the characters in the UnicodeString object to the code point
* <TT>srcChar</TT>.
* @param srcChar the code point which becomes the UnicodeString's character
* content
* @return a reference to this
* @draft
*/
UnicodeString& setTo(UChar32 srcChar);
/**
* 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, the text will be aliased again,
* so that both strings then alias the same readonly-text.
*
* @param isTerminated specifies if <code>text</code> is <code>NUL</code>-terminated.
* This must be true if <code>textLength==-1</code>.
* @param text The characters to alias for the UnicodeString.
* @param textLength The number of Unicode characters in <code>text</code> to alias.
* If -1, then this constructor will determine the length
* by calling <code>u_strlen()</code>.
* @draft
*/
UnicodeString &setTo(UBool isTerminated,
const UChar *text,
int32_t textLength);
/**
* 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.
*
* @param buffer The characters to alias for the UnicodeString.
* @param buffLength The number of Unicode characters in <code>buffer</code> to alias.
* @param buffCapacity The size of <code>buffer</code> in UChars.
* @draft
*/
UnicodeString &setTo(UChar *buffer,
int32_t buffLength,
int32_t buffCapacity);
/**
* Make this UnicodeString object invalid.
* The string will test TRUE with isBogus().
*
* This is used to indicate that an operation failed, and that
* the result string is "bogus" - which can be tested with isBogus().
* This utility function is used throughout the UnicodeString
* implementation, and may be used in other functions,
* especially but not exclusively when such functions do not
* take a UErrorCode for simplicity.
*
* A "bogus" string is essentially empty, and getBuffer() const
* will return 0.
*
* The string object can be "revived" by assigning (operator=)
* another string, or by using one of the other setToXYZ functions,
* or simply by modifying it (which will work like with an empty string).
*
* @see isBogus()
* @draft ICU 2.0 was private in earlier releases
*/
void setToBogus();
/**
* Set the character at the specified offset to the specified character.
* @param offset A valid offset into the text of the character to set
* @param ch The new character
* @return A reference to this
* @draft
*/
UnicodeString& setCharAt(UTextOffset offset,
UChar ch);
/* Append operations */
/**
* Append operator. Append the code unit <TT>ch</TT> to the UnicodeString
* object.
* @param ch the code unit to be appended
* @return a reference to this
* @draft
*/
inline UnicodeString& operator+= (UChar ch);
/**
* Append operator. Append the code point <TT>ch</TT> to the UnicodeString
* object.
* @param ch the code point to be appended
* @return a reference to this
* @draft
*/
inline UnicodeString& operator+= (UChar32 ch);
/**
* Append operator. Append the characters in <TT>srcText</TT> to the
* UnicodeString object at offset <TT>start</TT>. <TT>srcText</TT> is
* not modified.
* @param srcText the source for the new characters
* @return a reference to this
* @stable
*/
inline UnicodeString& operator+= (const UnicodeString& srcText);
/**
* Append the characters
* in <TT>srcText</TT> in the range
* [<TT>srcStart</TT>, <TT>srcStart + srcLength</TT>) to the
* UnicodeString object at offset <TT>start</TT>. <TT>srcText</TT>
* is not modified.
* @param srcText the source for the new characters
* @param srcStart the offset into <TT>srcText</TT> where new characters
* will be obtained
* @param srcLength the number of characters in <TT>srcText</TT> in
* the append string
* @return a reference to this
* @stable
*/
inline UnicodeString& append(const UnicodeString& srcText,
UTextOffset srcStart,
int32_t srcLength);
/**
* Append the characters in <TT>srcText</TT> to the UnicodeString object at
* offset <TT>start</TT>. <TT>srcText</TT> is not modified.
* @param srcText the source for the new characters
* @return a reference to this
* @stable
*/
inline UnicodeString& append(const UnicodeString& srcText);
/**
* Append the characters in <TT>srcChars</TT> in the range
* [<TT>srcStart</TT>, <TT>srcStart + srcLength</TT>) to the UnicodeString
* object at offset
* <TT>start</TT>. <TT>srcChars</TT> is not modified.
* @param srcChars the source for the new characters
* @param srcStart the offset into <TT>srcChars</TT> where new characters
* will be obtained
* @param srcLength the number of characters in <TT>srcChars</TT> in
* the append string
* @return a reference to this
* @stable
*/
inline UnicodeString& append(const UChar *srcChars,
UTextOffset srcStart,
int32_t srcLength);
/**
* Append the characters in <TT>srcChars</TT> to the UnicodeString object
* at offset <TT>start</TT>. <TT>srcChars</TT> is not modified.
* @param srcChars the source for the new characters
* @param srcLength the number of Unicode characters in <TT>srcChars</TT>
* @return a reference to this
* @stable
*/
inline UnicodeString& append(const UChar *srcChars,
int32_t srcLength);
/**
* Append the code unit <TT>srcChar</TT> to the UnicodeString object.
* @param srcChar the code unit to append
* @return a reference to this
* @draft
*/
inline UnicodeString& append(UChar srcChar);
/**
* Append the code point <TT>srcChar</TT> to the UnicodeString object.
* @param srcChar the code point to append
* @return a reference to this
* @draft
*/
inline UnicodeString& append(UChar32 srcChar);
/* Insert operations */
/**
* Insert the characters in <TT>srcText</TT> in the range
* [<TT>srcStart</TT>, <TT>srcStart + srcLength</TT>) into the UnicodeString
* object at offset <TT>start</TT>. <TT>srcText</TT> is not modified.
* @param start the offset where the insertion begins
* @param srcText the source for the new characters
* @param srcStart the offset into <TT>srcText</TT> where new characters
* will be obtained
* @param srcLength the number of characters in <TT>srcText</TT> in
* the insert string
* @return a reference to this
* @stable
*/
inline UnicodeString& insert(UTextOffset start,
const UnicodeString& srcText,
UTextOffset srcStart,
int32_t srcLength);
/**
* Insert the characters in <TT>srcText</TT> into the UnicodeString object
* at offset <TT>start</TT>. <TT>srcText</TT> is not modified.
* @param start the offset where the insertion begins
* @param srcText the source for the new characters
* @return a reference to this
* @stable
*/
inline UnicodeString& insert(UTextOffset start,
const UnicodeString& srcText);
/**
* Insert the characters in <TT>srcChars</TT> in the range
* [<TT>srcStart</TT>, <TT>srcStart + srcLength</TT>) into the UnicodeString
* object at offset <TT>start</TT>. <TT>srcChars</TT> is not modified.
* @param start the offset at which the insertion begins
* @param srcChars the source for the new characters
* @param srcStart the offset into <TT>srcChars</TT> where new characters
* will be obtained
* @param srcLength the number of characters in <TT>srcChars</TT>
* in the insert string
* @return a reference to this
* @stable
*/
inline UnicodeString& insert(UTextOffset start,
const UChar *srcChars,
UTextOffset srcStart,
int32_t srcLength);
/**
* Insert the characters in <TT>srcChars</TT> into the UnicodeString object
* at offset <TT>start</TT>. <TT>srcChars</TT> is not modified.
* @param start the offset where the insertion begins
* @param srcChars the source for the new characters
* @param srcLength the number of Unicode characters in srcChars.
* @return a reference to this
* @stable
*/
inline UnicodeString& insert(UTextOffset start,
const UChar *srcChars,
int32_t srcLength);
/**
* Insert the code unit <TT>srcChar</TT> into the UnicodeString object at
* offset <TT>start</TT>.
* @param start the offset at which the insertion occurs
* @param srcChar the code unit to insert
* @return a reference to this
* @draft
*/
inline UnicodeString& insert(UTextOffset start,
UChar srcChar);
/**
* Insert the code point <TT>srcChar</TT> into the UnicodeString object at
* offset <TT>start</TT>.
* @param start the offset at which the insertion occurs
* @param srcChar the code point to insert
* @return a reference to this
* @draft
*/
inline UnicodeString& insert(UTextOffset start,
UChar32 srcChar);
/* Replace operations */
/**
* Replace the characters in the range
* [<TT>start</TT>, <TT>start + length</TT>) with the characters in
* <TT>srcText</TT> in the range
* [<TT>srcStart</TT>, <TT>srcStart + srcLength</TT>).
* <TT>srcText</TT> is not modified.
* @param start the offset at which the replace operation begins
* @param length the number of characters to replace. The character at
* <TT>start + length</TT> is not modified.
* @param srcText the source for the new characters
* @param srcStart the offset into <TT>srcText</TT> where new characters
* will be obtained
* @param srcLength the number of characters in <TT>srcText</TT> in
* the replace string
* @return a reference to this
* @stable
*/
UnicodeString& replace(UTextOffset start,
int32_t length,
const UnicodeString& srcText,
UTextOffset srcStart,
int32_t srcLength);
/**
* Replace the characters in the range
* [<TT>start</TT>, <TT>start + length</TT>)
* with the characters in <TT>srcText</TT>. <TT>srcText</TT> is
* not modified.
* @param start the offset at which the replace operation begins
* @param length the number of characters to replace. The character at
* <TT>start + length</TT> is not modified.
* @param srcText the source for the new characters
* @return a reference to this
* @stable
*/
UnicodeString& replace(UTextOffset start,
int32_t length,
const UnicodeString& srcText);
/**
* Replace the characters in the range
* [<TT>start</TT>, <TT>start + length</TT>) with the characters in
* <TT>srcChars</TT> in the range
* [<TT>srcStart</TT>, <TT>srcStart + srcLength</TT>). <TT>srcChars</TT>
* is not modified.
* @param start the offset at which the replace operation begins
* @param length the number of characters to replace. The character at
* <TT>start + length</TT> is not modified.
* @param srcChars the source for the new characters
* @param srcStart the offset into <TT>srcChars</TT> where new characters
* will be obtained
* @param srcLength the number of characters in <TT>srcChars</TT>
* in the replace string
* @return a reference to this
* @stable
*/
UnicodeString& replace(UTextOffset start,
int32_t length,
const UChar *srcChars,
UTextOffset srcStart,
int32_t srcLength);
/**
* Replace the characters in the range
* [<TT>start</TT>, <TT>start + length</TT>) with the characters in
* <TT>srcChars</TT>. <TT>srcChars</TT> is not modified.
* @param start the offset at which the replace operation begins
* @param length number of characters to replace. The character at
* <TT>start + length</TT> is not modified.
* @param srcChars the source for the new characters
* @param srcLength the number of Unicode characters in srcChars
* @return a reference to this
* @stable
*/
inline UnicodeString& replace(UTextOffset start,
int32_t length,
const UChar *srcChars,
int32_t srcLength);
/**
* Replace the characters in the range
* [<TT>start</TT>, <TT>start + length</TT>) with the code unit
* <TT>srcChar</TT>.
* @param start the offset at which the replace operation begins
* @param length the number of characters to replace. The character at
* <TT>start + length</TT> is not modified.
* @param srcChar the new code unit
* @return a reference to this
* @draft
*/
inline UnicodeString& replace(UTextOffset start,
int32_t length,
UChar srcChar);
/**
* Replace the characters in the range
* [<TT>start</TT>, <TT>start + length</TT>) with the code point
* <TT>srcChar</TT>.
* @param start the offset at which the replace operation begins
* @param length the number of characters to replace. The character at
* <TT>start + length</TT> is not modified.
* @param srcChar the new code point
* @return a reference to this
* @draft
*/
inline UnicodeString& replace(UTextOffset start,
int32_t length,
UChar32 srcChar);
/**
* Replace the characters in the range [<TT>start</TT>, <TT>limit</TT>)
* with the characters in <TT>srcText</TT>. <TT>srcText</TT> is not modified.
* @param start the offset at which the replace operation begins
* @param limit the offset immediately following the replace range
* @param srcText the source for the new characters
* @return a reference to this
* @stable
*/
inline UnicodeString& replaceBetween(UTextOffset start,
UTextOffset limit,
const UnicodeString& srcText);
/**
* Replace the characters in the range [<TT>start</TT>, <TT>limit</TT>)
* with the characters in <TT>srcText</TT> in the range
* [<TT>srcStart</TT>, <TT>srcLimit</TT>). <TT>srcText</TT> is not modified.
* @param start the offset at which the replace operation begins
* @param limit the offset immediately following the replace range
* @param srcText the source for the new characters
* @param srcStart the offset into <TT>srcChars</TT> where new characters
* will be obtained
* @param srcLimit the offset immediately following the range to copy
* in <TT>srcText</TT>
* @return a reference to this
* @stable
*/
inline UnicodeString& replaceBetween(UTextOffset start,
UTextOffset limit,
const UnicodeString& srcText,
UTextOffset srcStart,
UTextOffset srcLimit);
/**
* Replace a substring of this object with the given text.
* @param start the beginning index, inclusive; <code>0 <= start
* <= limit</code>.
* @param limit the ending index, exclusive; <code>start <= limit
* <= length()</code>.
* @param text the text to replace characters <code>start</code>
* to <code>limit - 1</code>
* @stable
*/
virtual void handleReplaceBetween(UTextOffset start,
UTextOffset limit,
const UnicodeString& text);
/**
* 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.
*
* @param start the beginning index, inclusive; <code>0 <= start <=
* limit</code>.
* @param limit the ending index, exclusive; <code>start <= limit <=
* length()</code>.
* @param dest the destination index. The characters from
* <code>start..limit-1</code> will be copied to <code>dest</code>.
* Implementations of this method may assume that <code>dest <= start ||
* dest >= limit</code>.
*/
virtual void copy(int32_t start, int32_t limit, int32_t dest);
/* Search and replace operations */
/**
* Replace all occurrences of characters in oldText with the characters
* in newText
* @param oldText the text containing the search text
* @param newText the text containing the replacement text
* @return a reference to this
* @stable
*/
inline UnicodeString& findAndReplace(const UnicodeString& oldText,
const UnicodeString& newText);
/**
* Replace all occurrences of characters in oldText with characters
* in newText
* in the range [<TT>start</TT>, <TT>start + length</TT>).
* @param start the start of the range in which replace will performed
* @param length the length of the range in which replace will be performed
* @param oldText the text containing the search text
* @param newText the text containing the replacement text
* @return a reference to this
* @stable
*/
inline UnicodeString& findAndReplace(UTextOffset start,
int32_t length,
const UnicodeString& oldText,
const UnicodeString& newText);
/**
* Replace all occurrences of characters in oldText in the range
* [<TT>oldStart</TT>, <TT>oldStart + oldLength</TT>) with the characters
* in newText in the range
* [<TT>newStart</TT>, <TT>newStart + newLength</TT>)
* in the range [<TT>start</TT>, <TT>start + length</TT>).
* @param start the start of the range in which replace will performed
* @param length the length of the range in which replace will be performed
* @param oldText the text containing the search text
* @param oldStart the start of the search range in <TT>oldText</TT>
* @param oldLength the length of the search range in <TT>oldText</TT>
* @param newText the text containing the replacement text
* @param newStart the start of the replacement range in <TT>newText</TT>
* @param newLength the length of the replacement range in <TT>newText</TT>
* @return a reference to this
* @stable
*/
UnicodeString& findAndReplace(UTextOffset start,
int32_t length,
const UnicodeString& oldText,
UTextOffset oldStart,
int32_t oldLength,
const UnicodeString& newText,
UTextOffset newStart,
int32_t newLength);
/* Remove operations */
/**
* Remove all characters from the UnicodeString object.
* @return a reference to this
* @stable
*/
inline UnicodeString& remove(void);
/**
* Remove the characters in the range
* [<TT>start</TT>, <TT>start + length</TT>) from the UnicodeString object.
* @param start the offset of the first character to remove
* @param length the number of characters to remove
* @return a reference to this
* @stable
*/
inline UnicodeString& remove(UTextOffset start,
int32_t length = (int32_t)INT32_MAX);
/**
* Remove the characters in the range
* [<TT>start</TT>, <TT>limit</TT>) from the UnicodeString object.
* @param start the offset of the first character to remove
* @param limit the offset immediately following the range to remove
* @return a reference to this
* @stable
*/
inline UnicodeString& removeBetween(UTextOffset start,
UTextOffset limit = (int32_t)INT32_MAX);
/* Length operations */
/**
* Pad the start of this UnicodeString with the character <TT>padChar</TT>.
* If the length of this UnicodeString is less than targetLength,
* length() - targetLength copies of padChar will be added to the
* beginning of this UnicodeString.
* @param targetLength the desired length of the string
* @param padChar the character to use for padding. Defaults to
* space (U+0020)
* @return TRUE if the text was padded, FALSE otherwise.
* @draft
*/
UBool padLeading(int32_t targetLength,
UChar padChar = 0x0020);
/**
* Pad the end of this UnicodeString with the character <TT>padChar</TT>.
* If the length of this UnicodeString is less than targetLength,
* length() - targetLength copies of padChar will be added to the
* end of this UnicodeString.
* @param targetLength the desired length of the string
* @param padChar the character to use for padding. Defaults to
* space (U+0020)
* @return TRUE if the text was padded, FALSE otherwise.
* @draft
*/
UBool padTrailing(int32_t targetLength,
UChar padChar = 0x0020);
/**
* Truncate this UnicodeString to the <TT>targetLength</TT>.
* @param targetLength the desired length of this UnicodeString.
* @return TRUE if the text was truncated, FALSE otherwise
* @stable
*/
inline UBool truncate(int32_t targetLength);
/**
* Trims leading and trailing whitespace from this UnicodeString.
* @return a reference to this
* @stable
*/
UnicodeString& trim(void);
/* Miscellaneous operations */
/**
* Reverse this UnicodeString in place.
* @return a reference to this
* @stable
*/
inline UnicodeString& reverse(void);
/**
* Reverse the range [<TT>start</TT>, <TT>start + length</TT>) in
* this UnicodeString.
* @param start the start of the range to reverse
* @param length the number of characters to to reverse
* @return a reference to this
* @stable
*/
inline UnicodeString& reverse(UTextOffset start,
int32_t length);
/**
* Convert the characters in this to UPPER CASE following the conventions of
* the default locale.
* @return A reference to this.
* @stable
*/
UnicodeString& toUpper(void);
/**
* Convert the characters in this to UPPER CASE following the conventions of
* a specific locale.
* @param locale The locale containing the conventions to use.
* @return A reference to this.
* @stable
*/
UnicodeString& toUpper(const Locale& locale);
/**
* Convert the characters in this to lower case following the conventions of
* the default locale.
* @return A reference to this.
* @stable
*/
UnicodeString& toLower(void);
/**
* Convert the characters in this to lower case following the conventions of
* a specific locale.
* @param locale The locale containing the conventions to use.
* @return A reference to this.
* @stable
*/
UnicodeString& toLower(const Locale& locale);
/**
* Case-fold 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 'I' in CaseFolding.txt.
* The result may be longer or shorter than the original.
*
* @param options Either U_FOLD_CASE_DEFAULT or U_FOLD_CASE_EXCLUDE_SPECIAL_I
* @return A reference to this.
* @draft
*/
UnicodeString &foldCase(uint32_t options=U_FOLD_CASE_DEFAULT);
//========================================
// Access to the internal buffer
//========================================
/**
* 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.
*
* 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().
* - You must call releaseBuffer(newLength) before and in order to
* return to normal UnicodeString operation.
*
* @param 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
* @return a writable pointer to the internal string buffer,
* or 0 if an error occurs (nested calls, out of memory)
*
* @see releaseBuffer
* @draft
*/
UChar *getBuffer(int32_t minCapacity);
/**
* 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.
*
* @param 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 getBuffer(int32_t minCapacity)
* @draft
*/
void releaseBuffer(int32_t newLength=-1);
/**
* 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
* <code>(s.length()<s.getCapacity() && buffer[s.length()]==0)</code>.
*
* The buffer may reside in read-only memory. Its contents must not
* be modified.
*
* @return a read-only pointer to the internal string buffer,
* or 0 if the string is empty or bogus
*
* @see getBuffer(int32_t minCapacity)
* @draft
*/
inline const UChar *getBuffer() const;
//========================================
// Constructors
//========================================
/** Construct an empty UnicodeString.
* @stable
*/
UnicodeString();
/**
* Construct a UnicodeString with capacity to hold <TT>capacity</TT> UChars
* @param 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.
* @param c is used to initially fill the string
* @param count specifies how many code points c are to be written in the
* string
* @draft
*/
UnicodeString(int32_t capacity, UChar32 c, int32_t count);
/**
* Single UChar (code unit) constructor.
* @param ch the character to place in the UnicodeString
* @draft
*/
UnicodeString(UChar ch);
/**
* Single UChar32 (code point) constructor.
* @param ch the character to place in the UnicodeString
* @draft
*/
UnicodeString(UChar32 ch);
/**
* UChar* constructor.
* @param text The characters to place in the UnicodeString. <TT>text</TT>
* must be NULL (U+0000) terminated.
* @stable
*/
UnicodeString(const UChar *text);
/**
* UChar* constructor.
* @param text The characters to place in the UnicodeString.
* @param textLength The number of Unicode characters in <TT>text</TT>
* to copy.
* @stable
*/
UnicodeString(const UChar *text,
int32_t textLength);
/**
* 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, the text will be aliased again,
* so that both strings then alias the same readonly-text.
*
* @param isTerminated specifies if <code>text</code> is <code>NUL</code>-terminated.
* This must be true if <code>textLength==-1</code>.
* @param text The characters to alias for the UnicodeString.
* @param textLength The number of Unicode characters in <code>text</code> to alias.
* If -1, then this constructor will determine the length
* by calling <code>u_strlen()</code>.
* @stable
*/
UnicodeString(UBool isTerminated,
const UChar *text,
int32_t textLength);
/**
* 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.
*
* @param buffer The characters to alias for the UnicodeString.
* @param buffLength The number of Unicode characters in <code>buffer</code> to alias.
* @param buffCapacity The size of <code>buffer</code> in UChars.
* @draft
*/
UnicodeString(UChar *buffer, int32_t buffLength, int32_t buffCapacity);
/**
* char* constructor.
* @param codepageData an array of bytes, null-terminated
* @param codepage the encoding of <TT>codepageData</TT>. The special
* value 0 for <TT>codepage</TT> indicates that the text is in the
* platform's default codepage.
* If <code>codepage</code> is an empty string (<code>""</code>),
* then a simple conversion is performed on the codepage-invariant
* subset ("invariant characters") of the platform encoding. See utypes.h.
* @stable
*/
UnicodeString(const char *codepageData,
const char *codepage = 0);
/**
* char* constructor.
* @param codepageData an array of bytes.
* @param dataLength The number of bytes in <TT>codepageData</TT>.
* @param codepage the encoding of <TT>codepageData</TT>. The special
* value 0 for <TT>codepage</TT> indicates that the text is in the
* platform's default codepage.
* If <code>codepage</code> is an empty string (<code>""</code>),
* then a simple conversion is performed on the codepage-invariant
* subset ("invariant characters") of the platform encoding. See utypes.h.
* @stable
*/
UnicodeString(const char *codepageData,
int32_t dataLength,
const char *codepage = 0);
/**
* 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.
*
* @param src input codepage string
* @param srcLength length of the input string, can be -1 for NUL-terminated strings
* @param cnv converter object (ucnv_resetToUnicode() will be called),
* can be NULL for the default converter
* @param errorCode normal ICU error code
* @draft
*/
UnicodeString(
const char *src, int32_t srcLength,
UConverter *cnv,
UErrorCode &errorCode);
/**
* Copy constructor.
* @param that The UnicodeString object to copy.
* @stable
*/
UnicodeString(const UnicodeString& that);
/** Destructor.
* @stable
*/
~UnicodeString();
/* Miscellaneous operations */
/**
* Returns the number of display cells occupied by the range
* [<TT>start</TT>, <TT>length</TT>).
* This function is designed for Asian text and properly takes into account
* halfwidth and fullwidth variants of various CJK characters and the
* combining behavior of the Hangul Jamo characters (with some limitations;
* see documentation for Unicode::getCellWidth()).<BR>
* In order to avoid dealing with fractions, this function can either be
* construed to return twice the actual number of display cells or to
* treat a "cell" as the width of a halfwidth character rather than the
* width of a fullwidth character.
* @param start the start of the range
* @param length the number of characters to measure
* @param asian The <TT>asian</TT> parameter controls whether characters
* considered NEUTRAL by the Unicode class are treated as halfwidth or
* fullwidth here. If you set <TT>asian</TT> to FALSE, neutrals are
* treated as halfwidth, and this function returns a close approximation
* of how many Latin display cells the text will take up in a monospaced
* font.
* @return the number of display cells occupied by the specified substring.
* @stable
*/
int32_t numDisplayCells(UTextOffset start = 0,
int32_t length = INT32_MAX,
UBool asian = TRUE) const;
UCharReference operator[] (UTextOffset pos);
/**
* 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]
*
* 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,
* \" => 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.
*
* @return a string with backslash escapes interpreted, or an
* empty string on error.
* @see UnicodeString#unescapeAt()
* @see u_unescape()
* @see u_unescapeAt()
*/
UnicodeString unescape() const;
/**
* 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, (UChar32)0xFFFFFFFF is
* returned.
*
* @param 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.
* @return the character represented by the escape sequence at
* offset, or (UChar32)0xFFFFFFFF on error.
* @see UnicodeString#unescape()
* @see u_unescape()
* @see u_unescapeAt()
*/
UChar32 unescapeAt(int32_t &offset) const;
//========================================
// Implementation methods
//========================================
protected:
/**
* Implement Replaceable::getLength() (see jitterbug 1027).
*/
virtual int32_t getLength() const;
/**
* The change in Replaceable to use virtual getCharAt() allows
* UnicodeString::charAt() to be inline again (see jitterbug 709).
*/
virtual UChar getCharAt(UTextOffset offset) const;
/**
* The change in Replaceable to use virtual getChar32At() allows
* UnicodeString::char32At() to be inline again (see jitterbug 709).
*/
virtual UChar32 getChar32At(UTextOffset offset) const;
private:
inline int8_t
doCompare(UTextOffset start,
int32_t length,
const UnicodeString& srcText,
UTextOffset srcStart,
int32_t srcLength) const;
int8_t doCompare(UTextOffset start,
int32_t length,
const UChar *srcChars,
UTextOffset srcStart,
int32_t srcLength) const;
inline int8_t
doCompareCodePointOrder(UTextOffset start,
int32_t length,
const UnicodeString& srcText,
UTextOffset srcStart,
int32_t srcLength) const;
int8_t doCompareCodePointOrder(UTextOffset start,
int32_t length,
const UChar *srcChars,
UTextOffset srcStart,
int32_t srcLength) const;
inline int8_t
doCaseCompare(UTextOffset start,
int32_t length,
const UnicodeString &srcText,
UTextOffset srcStart,
int32_t srcLength,
uint32_t options) const;
int8_t
doCaseCompare(UTextOffset start,
int32_t length,
const UChar *srcChars,
UTextOffset srcStart,
int32_t srcLength,
uint32_t options) const;
UTextOffset doIndexOf(UChar c,
UTextOffset start,
int32_t length) const;
UTextOffset doLastIndexOf(UChar c,
UTextOffset start,
int32_t length) const;
void doExtract(UTextOffset start,
int32_t length,
UChar *dst,
UTextOffset dstStart) const;
inline void doExtract(UTextOffset start,
int32_t length,
UnicodeString& target) const;
inline UChar doCharAt(UTextOffset offset) const;
UnicodeString& doReplace(UTextOffset start,
int32_t length,
const UnicodeString& srcText,
UTextOffset srcStart,
int32_t srcLength);
UnicodeString& doReplace(UTextOffset start,
int32_t length,
const UChar *srcChars,
UTextOffset srcStart,
int32_t srcLength);
UnicodeString& doReverse(UTextOffset start,
int32_t length);
// calculate hash code
int32_t doHashCode(void) const;
// get pointer to start of array
inline UChar* getArrayStart(void);
inline const UChar* getArrayStart(void) const;
// allocate the array; result may be fStackBuffer
// sets refCount to 1 if appropriate
// sets fArray, fCapacity, and fFlags
// returns boolean for success or failure
UBool allocate(int32_t capacity);
// release the array if owned
inline void releaseArray();
// Pin start and limit to acceptable values.
inline void pinIndices(UTextOffset& start,
int32_t& length) const;
/* Internal extract() using UConverter. */
int32_t doExtract(UTextOffset start, int32_t length,
char *dest, int32_t destCapacity,
UConverter *cnv,
UErrorCode &errorCode) const;
/*
* Real constructor for converting from codepage data.
* It assumes that it is called with !fRefCounted.
*
* If <code>codepage==0</code>, then the default converter
* is used for the platform encoding.
* If <code>codepage</code> is an empty string (<code>""</code>),
* then a simple conversion is performed on the codepage-invariant
* subset ("invariant characters") of the platform encoding. See utypes.h.
*/
void doCodepageCreate(const char *codepageData,
int32_t dataLength,
const char *codepage);
/*
* Worker function for creating a UnicodeString from
* a codepage string using a UConverter.
*/
void
doCodepageCreate(const char *codepageData,
int32_t dataLength,
UConverter *converter,
UErrorCode &status);
/*
* This function is called when write access to the array
* is necessary.
*
* We need to make a copy of the array if
* the buffer is read-only, or
* the buffer is refCounted (shared), and refCount>1, or
* the buffer is too small.
*
* Return FALSE if memory could not be allocated.
*/
UBool cloneArrayIfNeeded(int32_t newCapacity = -1,
int32_t growCapacity = -1,
UBool doCopyArray = TRUE,
int32_t **pBufferToDelete = 0,
UBool forceClone = FALSE);
// UGrowBuffer function for string case mapping and similar
static UBool U_CALLCONV
growBuffer(void *context,
UChar **buffer, int32_t *pCapacity, int32_t reqCapacity,
int32_t length);
// common function for case mappings
UnicodeString &
caseMap(const Locale& locale,
uint32_t options,
int32_t toWhichCase);
// ref counting
inline int32_t addRef(void);
inline int32_t removeRef(void);
inline int32_t refCount(void) const;
inline int32_t setRefCount(int32_t count);
// constants
enum {
#if UTF_SIZE==8
US_STACKBUF_SIZE=14, // Size of stack buffer for small strings
#elif UTF_SIZE==16
US_STACKBUF_SIZE=7, // Size of stack buffer for small strings
#else // UTF_SIZE==32
US_STACKBUF_SIZE=3, // Size of stack buffer for small strings
#endif
kInvalidUChar=0xffff, // invalid UChar index
kGrowSize=128, // grow size for this buffer
kInvalidHashCode=0, // invalid hash code
kEmptyHashCode=1, // hash code for empty string
// bit flag values for fFlags
kIsBogus=1, // this string is bogus, i.e., not valid
kUsingStackBuffer=2,// fArray==fStackBuffer
kRefCounted=4, // there is a refCount field before the characters in fArray
kBufferIsReadonly=8,// do not write to this buffer
kOpenGetBuffer=16, // getBuffer(minCapacity) was called (is "open"),
// and releaseBuffer(newLength) must be called
// combined values for convenience
kShortString=kUsingStackBuffer,
kLongString=kRefCounted,
kReadonlyAlias=kBufferIsReadonly,
kWritableAlias=0
};
friend class UnicodeConverter;
friend class StringCharacterIterator;
friend class SearchIterator;
friend class StringSearch;
/*
* The following are all the class fields that are stored
* in each UnicodeString object.
* Note that UnicodeString has virtual functions,
* therefore there is an implicit vtable pointer
* as the first real field.
* The fields should be aligned such that no padding is
* necessary, mostly by having larger types first.
* On 32-bit machines, the size should be 32 bytes,
* on 64-bit machines (8-byte pointers), it should be 40 bytes.
*/
// (implicit) *vtable;
int32_t fLength; // number of characters in fArray
int32_t fCapacity; // sizeof fArray
UChar *fArray; // the Unicode data
uint16_t fFlags; // bit flags: see constants above
#if UTF_SIZE==32
uint16_t fPadding; // padding to align the fStackBuffer for UTF-32
#endif
UChar fStackBuffer [ US_STACKBUF_SIZE ]; // buffer for small strings
};
U_NAMESPACE_END
//========================================
// Array copying
//========================================
// Copy an array of UnicodeString OBJECTS (not pointers).
inline void
uprv_arrayCopy(const U_NAMESPACE_QUALIFIER UnicodeString *src, U_NAMESPACE_QUALIFIER UnicodeString *dst, int32_t count)
{ while(count-- > 0) *dst++ = *src++; }
inline void
uprv_arrayCopy(const U_NAMESPACE_QUALIFIER UnicodeString *src, int32_t srcStart,
U_NAMESPACE_QUALIFIER UnicodeString *dst, int32_t dstStart, int32_t count)
{ uprv_arrayCopy(src+srcStart, dst+dstStart, count); }
U_NAMESPACE_BEGIN
//========================================
// Inline members
//========================================
//========================================
// Read-only alias methods
//========================================
inline UBool
UnicodeString::operator== (const UnicodeString& text) const
{
if(isBogus()) {
return text.isBogus();
} else {
return
!text.isBogus() &&
fLength == text.fLength &&
doCompare(0, fLength, text, 0, text.fLength) == 0;
}
}
inline UBool
UnicodeString::operator!= (const UnicodeString& text) const
{ return (! operator==(text)); }
inline UBool
UnicodeString::operator> (const UnicodeString& text) const
{ return doCompare(0, fLength, text, 0, text.fLength) == 1; }
inline UBool
UnicodeString::operator< (const UnicodeString& text) const
{ return doCompare(0, fLength, text, 0, text.fLength) == -1; }
inline UBool
UnicodeString::operator>= (const UnicodeString& text) const
{ return doCompare(0, fLength, text, 0, text.fLength) != -1; }
inline UBool
UnicodeString::operator<= (const UnicodeString& text) const
{ return doCompare(0, fLength, text, 0, text.fLength) != 1; }
inline int8_t
UnicodeString::compare(const UnicodeString& text) const
{ return doCompare(0, fLength, text, 0, text.fLength); }
inline int8_t
UnicodeString::compare(UTextOffset start,
int32_t length,
const UnicodeString& srcText) const
{ return doCompare(start, length, srcText, 0, srcText.fLength); }
inline int8_t
UnicodeString::compare(const UChar *srcChars,
int32_t srcLength) const
{ return doCompare(0, fLength, srcChars, 0, srcLength); }
inline int8_t
UnicodeString::compare(UTextOffset start,
int32_t length,
const UnicodeString& srcText,
UTextOffset srcStart,
int32_t srcLength) const
{ return doCompare(start, length, srcText, srcStart, srcLength); }
inline int8_t
UnicodeString::compare(UTextOffset start,
int32_t length,
const UChar *srcChars) const
{ return doCompare(start, length, srcChars, 0, length); }
inline int8_t
UnicodeString::compare(UTextOffset start,
int32_t length,
const UChar *srcChars,
UTextOffset srcStart,
int32_t srcLength) const
{ return doCompare(start, length, srcChars, srcStart, srcLength); }
inline int8_t
UnicodeString::compareBetween(UTextOffset start,
UTextOffset limit,
const UnicodeString& srcText,
UTextOffset srcStart,
UTextOffset srcLimit) const
{ return doCompare(start, limit - start,
srcText, srcStart, srcLimit - srcStart); }
inline int8_t
UnicodeString::doCompare(UTextOffset start,
int32_t length,
const UnicodeString& srcText,
UTextOffset srcStart,
int32_t srcLength) const
{
const UChar *srcChars;
if(!srcText.isBogus()) {
srcText.pinIndices(srcStart, srcLength);
srcChars=srcText.getArrayStart();
} else {
srcChars=0;
}
return doCompare(start, length, srcChars, srcStart, srcLength);
}
inline int8_t
UnicodeString::compareCodePointOrder(const UnicodeString& text) const
{ return doCompareCodePointOrder(0, fLength, text, 0, text.fLength); }
inline int8_t
UnicodeString::compareCodePointOrder(UTextOffset start,
int32_t length,
const UnicodeString& srcText) const
{ return doCompareCodePointOrder(start, length, srcText, 0, srcText.fLength); }
inline int8_t
UnicodeString::compareCodePointOrder(const UChar *srcChars,
int32_t srcLength) const
{ return doCompareCodePointOrder(0, fLength, srcChars, 0, srcLength); }
inline int8_t
UnicodeString::compareCodePointOrder(UTextOffset start,
int32_t length,
const UnicodeString& srcText,
UTextOffset srcStart,
int32_t srcLength) const
{ return doCompareCodePointOrder(start, length, srcText, srcStart, srcLength); }
inline int8_t
UnicodeString::compareCodePointOrder(UTextOffset start,
int32_t length,
const UChar *srcChars) const
{ return doCompareCodePointOrder(start, length, srcChars, 0, length); }
inline int8_t
UnicodeString::compareCodePointOrder(UTextOffset start,
int32_t length,
const UChar *srcChars,
UTextOffset srcStart,
int32_t srcLength) const
{ return doCompareCodePointOrder(start, length, srcChars, srcStart, srcLength); }
inline int8_t
UnicodeString::compareCodePointOrderBetween(UTextOffset start,
UTextOffset limit,
const UnicodeString& srcText,
UTextOffset srcStart,
UTextOffset srcLimit) const
{ return doCompareCodePointOrder(start, limit - start,
srcText, srcStart, srcLimit - srcStart); }
inline int8_t
UnicodeString::doCompareCodePointOrder(UTextOffset start,
int32_t length,
const UnicodeString& srcText,
UTextOffset srcStart,
int32_t srcLength) const
{
const UChar *srcChars;
if(!srcText.isBogus()) {
srcText.pinIndices(srcStart, srcLength);
srcChars=srcText.getArrayStart();
} else {
srcChars=0;
}
return doCompareCodePointOrder(start, length, srcChars, srcStart, srcLength);
}
inline int8_t
UnicodeString::caseCompare(const UnicodeString &text, uint32_t options) const {
return doCaseCompare(0, fLength, text, 0, text.fLength, options);
}
inline int8_t
UnicodeString::caseCompare(UTextOffset start,
int32_t length,
const UnicodeString &srcText,
uint32_t options) const {
return doCaseCompare(start, length, srcText, 0, srcText.fLength, options);
}
inline int8_t
UnicodeString::caseCompare(const UChar *srcChars,
int32_t srcLength,
uint32_t options) const {
return doCaseCompare(0, fLength, srcChars, 0, srcLength, options);
}
inline int8_t
UnicodeString::caseCompare(UTextOffset start,
int32_t length,
const UnicodeString &srcText,
UTextOffset srcStart,
int32_t srcLength,
uint32_t options) const {
return doCaseCompare(start, length, srcText, srcStart, srcLength, options);
}
inline int8_t
UnicodeString::caseCompare(UTextOffset start,
int32_t length,
const UChar *srcChars,
uint32_t options) const {
return doCaseCompare(start, length, srcChars, 0, length, options);
}
inline int8_t
UnicodeString::caseCompare(UTextOffset start,
int32_t length,
const UChar *srcChars,
UTextOffset srcStart,
int32_t srcLength,
uint32_t options) const {
return doCaseCompare(start, length, srcChars, srcStart, srcLength, options);
}
inline int8_t
UnicodeString::caseCompareBetween(UTextOffset start,
UTextOffset limit,
const UnicodeString &srcText,
UTextOffset srcStart,
UTextOffset srcLimit,
uint32_t options) const {
return doCaseCompare(start, limit - start, srcText, srcStart, srcLimit - srcStart, options);
}
inline int8_t
UnicodeString::doCaseCompare(UTextOffset start,
int32_t length,
const UnicodeString &srcText,
UTextOffset srcStart,
int32_t srcLength,
uint32_t options) const
{
const UChar *srcChars;
if(!srcText.isBogus()) {
srcText.pinIndices(srcStart, srcLength);
srcChars=srcText.getArrayStart();
} else {
srcChars=0;
}
return doCaseCompare(start, length, srcChars, srcStart, srcLength, options);
}
inline UTextOffset
UnicodeString::indexOf(const UnicodeString& text) const
{ return indexOf(text, 0, text.fLength, 0, fLength); }
inline UTextOffset
UnicodeString::indexOf(const UnicodeString& text,
UTextOffset start) const
{ return indexOf(text, 0, text.fLength, start, fLength - start); }
inline UTextOffset
UnicodeString::indexOf(const UnicodeString& text,
UTextOffset start,
int32_t length) const
{ return indexOf(text, 0, text.fLength, start, length); }
inline UTextOffset
UnicodeString::indexOf(const UnicodeString& srcText,
UTextOffset srcStart,
int32_t srcLength,
UTextOffset start,
int32_t length) const
{
if(!srcText.isBogus()) {
srcText.pinIndices(srcStart, srcLength);
if(srcLength > 0) {
return indexOf(srcText.getArrayStart(), srcStart, srcLength, start, length);
}
}
return -1;
}
inline UTextOffset
UnicodeString::indexOf(const UChar *srcChars,
int32_t srcLength,
UTextOffset start) const
{ return indexOf(srcChars, 0, srcLength, start, fLength - start); }
inline UTextOffset
UnicodeString::indexOf(const UChar *srcChars,
int32_t srcLength,
UTextOffset start,
int32_t length) const
{ return indexOf(srcChars, 0, srcLength, start, length); }
inline UTextOffset
UnicodeString::indexOf(UChar c) const
{ return doIndexOf(c, 0, fLength); }
inline UTextOffset
UnicodeString::indexOf(UChar32 c) const {
if(!UTF_NEED_MULTIPLE_UCHAR(c)) {
return doIndexOf((UChar)c, 0, fLength);
} else {
UChar buffer[UTF_MAX_CHAR_LENGTH];
int32_t length = 0;
UTF_APPEND_CHAR_UNSAFE(buffer, length, c);
return indexOf(buffer, length, 0);
}
}
inline UTextOffset
UnicodeString::indexOf(UChar c,
UTextOffset start) const
{ return doIndexOf(c, start, fLength - start); }
inline UTextOffset
UnicodeString::indexOf(UChar32 c,
UTextOffset start) const {
if(!UTF_NEED_MULTIPLE_UCHAR(c)) {
return doIndexOf((UChar)c, start, fLength - start);
} else {
UChar buffer[UTF_MAX_CHAR_LENGTH];
int32_t length = 0;
UTF_APPEND_CHAR_UNSAFE(buffer, length, c);
return indexOf(buffer, length, start);
}
}
inline UTextOffset
UnicodeString::indexOf(UChar c,
UTextOffset start,
int32_t length) const
{ return doIndexOf(c, start, length); }
inline UTextOffset
UnicodeString::indexOf(UChar32 c,
UTextOffset start,
int32_t length) const {
if(!UTF_NEED_MULTIPLE_UCHAR(c)) {
return doIndexOf((UChar)c, start, length);
} else {
UChar buffer[UTF_MAX_CHAR_LENGTH];
int32_t cLength = 0;
UTF_APPEND_CHAR_UNSAFE(buffer, cLength, c);
return indexOf(buffer, cLength, start, length);
}
}
inline UTextOffset