scuffed-code/icu4c/source/common/unistr.h
Unknown User aa0b0a88e8 Initial revision
X-SVN-Rev: 2
1999-08-16 21:50:52 +00:00

2316 lines
78 KiB
C++

/*
*******************************************************************************
* *
* COPYRIGHT: *
* (C) Copyright International Business Machines Corporation, 1998-1999 *
* Licensed Material - Program-Property of IBM - All Rights Reserved. *
* US Government Users Restricted Rights - Use, duplication, or disclosure *
* restricted by GSA ADP Schedule Contract with IBM Corp. *
* *
*******************************************************************************
*
* 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.
*******************************************************************************
*/
#ifndef UNISTR_H
#define UNISTR_H
#include <limits.h>
#include "utypes.h"
#include "unicode.h"
#include "ucnv.h"
// Size of stack buffer for small strings
#define US_STACKBUF_SIZE 10
class Locale;
class UCharReference;
/**
* UnicodeString is a concrete implementation of the abstract class
* UnicodeText. UnicodeString performs codeset conversion from char*
* data based on the type of data specified.
*/
class U_COMMON_API UnicodeString
{
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.
*/
inline bool_t 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.
*/
inline bool_t 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
*/
inline bool_t 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
*/
inline bool_t 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
*/
inline bool_t 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
*/
inline bool_t 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.
*/
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.
*/
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.
*/
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.
*/
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.
*/
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.
*/
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.
*/
inline int8_t compareBetween(UTextOffset start,
UTextOffset limit,
const UnicodeString& srcText,
UTextOffset srcStart,
UTextOffset srcLimit) 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
*/
inline bool_t 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
*/
inline bool_t 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
*/
inline bool_t 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
*/
inline bool_t 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
*/
inline bool_t 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
*/
inline bool_t 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
*/
inline bool_t 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
*/
inline bool_t 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.
*/
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.
*/
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.
*/
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.
*/
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.
*/
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.
*/
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.
*/
inline UTextOffset indexOf(const UChar *srcChars,
UTextOffset srcStart,
int32_t srcLength,
UTextOffset start,
int32_t length) const;
/**
* Locate in this the first occurrence of the character <TT>c</TT>,
* using bitwise comparison.
* @param c The character to search for.
* @return The offset into this of <TT>c</TT>, or -1 if not found.
*/
inline UTextOffset indexOf(UChar c) const;
/**
* Locate in this the first occurrence of the character <TT>c</TT>
* starting at offset <TT>start</TT>, using bitwise comparison.
* @param c The character 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.
*/
inline UTextOffset indexOf(UChar c,
UTextOffset start) const;
/**
* Locate in this the first occurrence of the character <TT>c</TT>
* in the range [<TT>start</TT>, <TT>start + length</TT>),
* using bitwise comparison.
* @param c The character 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.
*/
inline UTextOffset indexOf(UChar 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.
*/
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.
*/
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.
*/
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.
*/
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.
*/
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.
*/
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.
*/
inline UTextOffset lastIndexOf(const UChar *srcChars,
UTextOffset srcStart,
int32_t srcLength,
UTextOffset start,
int32_t length) const;
/**
* Locate in this the last occurrence of the character <TT>c</TT>,
* using bitwise comparison.
* @param c The character to search for.
* @return The offset into this of <TT>c</TT>, or -1 if not found.
*/
inline UTextOffset lastIndexOf(UChar c) const;
/**
* Locate in this the last occurrence of the character <TT>c</TT>
* starting at offset <TT>start</TT>, using bitwise comparison.
* @param c The character 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.
*/
inline UTextOffset lastIndexOf(UChar c,
UTextOffset start) const;
/**
* Locate in this the last occurrence of the character <TT>c</TT>
* in the range [<TT>start</TT>, <TT>start + length</TT>),
* using bitwise comparison.
* @param c The character 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.
*/
inline UTextOffset lastIndexOf(UChar c,
UTextOffset start,
int32_t length) const;
/* Character access */
/**
* Return the character at offset <tt>offset</tt>.
* @param offset a valid offset into the text
* @returns the character at offset <tt>offset</tt>
*/
inline UChar charAt(UTextOffset offset) const;
/**
* Return the character at offset <tt>offset</tt>.
* @param offset a valid offset into the text
* @returns the character at offset <tt>offset</tt>
*/
inline UChar operator [] (UTextOffset offset) 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>.
* @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
*/
inline void extract(UTextOffset start,
int32_t length,
UChar *dst,
UTextOffset dstStart = 0) 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>
*/
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
*/
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>
*/
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.
* @param start offset of first character which will be copied
* @param length 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
* @return the number of characters written to <TT>dst</TT>
*/
int32_t extract(UTextOffset start,
int32_t length,
char *dst,
const char *codepage = 0) 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
*/
inline int32_t length(void) const;
/**
* Determine if this string is empty.
* @return TRUE if this string contains 0 characters, FALSE otherwise.
*/
inline bool_t empty(void) const;
/* Other operations */
/**
* Generate a hash code for this object.
* @return The hash code of this UnicodeString.
*/
inline int32_t hashCode(void) const;
/**
* Determine if this string is still valid.
* @return TRUE if the string is valid, FALSE otherwise
*/
inline bool_t 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
*/
UnicodeString& operator= (const UnicodeString& srcText);
/**
* Assignment operator. Replace the characters in this UnicodeString
* with the character <TT>ch</TT>.
* @param ch the character to replace
* @return a reference to this
*/
inline UnicodeString& operator= (UChar 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
*/
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
*/
inline UnicodeString& setTo(const UnicodeString& srcText);
/**
* Set the characters in the UnicodeString object to the characters
* in <TT>srcChars</TT> in the range
* [<TT>srcStart</TT>, <TT>srcStart + srcLength</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
* replace string
* @return a reference to this
*/
inline UnicodeString& setTo(const UChar *srcChars,
UTextOffset srcStart,
int32_t srcLength);
/**
* 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
*/
inline UnicodeString& setTo(const UChar *srcChars,
int32_t srcLength);
/**
* Set the characters in the UnicodeString object to the character
* <TT>srcChar</TT>.
* @param srcChar the character which becomes the UnicodeString's character
* content
* @return a reference to this
*/
UnicodeString& setTo(UChar srcChar);
/**
* 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
*/
UnicodeString& setCharAt(UTextOffset offset,
UChar ch);
/* Append operations */
/**
* Append operator. Append the character <TT>ch</TT> to the UnicodeString
* object.
* @param ch the character to be appended
* @return a reference to this
*/
inline UnicodeString& operator+= (UChar 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
*/
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
*/
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
*/
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
*/
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
*/
inline UnicodeString& append(const UChar *srcChars,
int32_t srcLength);
/**
* Append the character <TT>srcChar</TT> to the UnicodeString object.
* @param srcChar the character to append
* @return a reference to this
*/
inline UnicodeString& append(UChar 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
*/
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
*/
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
*/
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
*/
inline UnicodeString& insert(UTextOffset start,
const UChar *srcChars,
int32_t srcLength);
/**
* Insert the character <TT>srcChar</TT> into the UnicodeString object at
* offset <TT>start</TT>.
* @param start the offset at which the insertion occurs
* @param srcChar the character to insert
* @return a reference to this
*/
inline UnicodeString& insert(UTextOffset start,
UChar 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
*/
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
*/
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
*/
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
*/
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 character
* <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 character
* @return a reference to this
*/
inline UnicodeString& replace(UTextOffset start,
int32_t length,
UChar 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
*/
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
*/
inline UnicodeString& replaceBetween(UTextOffset start,
UTextOffset limit,
const UnicodeString& srcText,
UTextOffset srcStart,
UTextOffset srcLimit);
/* 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
*/
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
*/
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
*/
inline 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
*/
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
*/
inline UnicodeString& remove(UTextOffset start,
int32_t length = LONG_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
*/
inline UnicodeString& removeBetween(UTextOffset start,
UTextOffset limit = LONG_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.
*/
inline bool_t 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.
*/
inline bool_t 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
*/
inline bool_t truncate(int32_t targetLength);
/**
* Trims leading and trailing whitespace from this UnicodeString.
* @return a reference to this
*/
inline UnicodeString& trim(void);
/* Miscellaneous operations */
/**
* Reverse this UnicodeString in place.
* @return a reference to this
*/
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
*/
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.
*/
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.
*/
UnicodeString& toUpper(const Locale& locale);
/**
* Convert the characters in this to UPPER CASE following the conventions of
* the default.
* @return A reference to this.
*/
UnicodeString& toLower(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.
*/
UnicodeString& toLower(const Locale& locale);
//========================================
// Constructors
//========================================
/** Construct an empty UnicodeString. */
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
*/
UnicodeString(int32_t capacity);
/**
* Single UChar constructor.
* @param ch the character to place in the UnicodeString
*/
UnicodeString(UChar ch);
/**
* UChar* constructor.
* @param text The characters to place in the UnicodeString. <TT>text</TT>
* must be NULL (U+0000) terminated.
*/
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.
*/
UnicodeString(const UChar *text,
int32_t textLength);
/**
* 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.
*/
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.
*/
UnicodeString(const char *codepageData,
int32_t dataLength,
const char *codepage = 0);
/**
* Copy constructor.
* @param that The UnicodeString object to copy.
*/
inline UnicodeString(const UnicodeString& that);
/** Destructor. */
~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.
*/
int32_t numDisplayCells(UTextOffset start = 0,
int32_t length = LONG_MAX,
bool_t asian = TRUE) const;
UCharReference operator[] (UTextOffset pos);
// {sfb} remove these later?
/* Hack to avoid circular dependencies */
/**
* Convert the characters in this to UPPER CASE following the conventions of
* the default locale.
* @retrurn A reference to this.
*/
// UnicodeString& toUpper();
/**
* Convert the characters in this to lower case following the conventions of
* the default locale.
* @retrurn A reference to this.
*/
// UnicodeString& toLower();
//========================================
// Implementation methods
//========================================
private:
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;
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& doSetCharAt(UTextOffset offset,
UChar c);
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);
// get pointer to start of array
inline UChar* getArrayStart(void);
inline const UChar* getArrayStart(void) const;
// get the "real" capacity of the array, adjusted for ref count
inline int32_t getCapacity(void) const;
// utility method to get around lack of exception handling
void setToBogus(void);
// Pin start and limit to acceptable values.
void pinIndices(UTextOffset& start,
int32_t& length) const;
// Real ctor for converting from codepage data
void doCodepageCreate(const char *codepageData,
int32_t dataLength,
const char *codepage);
// clones array if refCount > 1
void cloneArrayIfNeeded(void);
// ref counting
inline uint16_t addRef(void);
inline uint16_t removeRef(void);
inline uint16_t refCount(void) const;
inline uint16_t setRefCount(uint16_t count);
UChar fStackBuffer [ US_STACKBUF_SIZE ]; // buffer for small strings
UChar *fArray; // the Unicode data
int32_t fLength; // number characters in fArray
int32_t fCapacity; // sizeof fArray
bool_t fRefCounted; // indicates if we own storage
int32_t fHashCode; // the hash code
bool_t fBogus; // indicates if an operation failed
// constants
static const UChar fgInvalidUChar; // invalid UChar index
static const int32_t kGrowSize; // grow size for this buffer
static const int32_t kInvalidHashCode; // invalid hash code
static const int32_t kEmptyHashCode; // hash code for empty string
// statics
inline static int32_t allocation(int32_t minSize); // allocation algorithm
inline static UChar* allocate(int32_t minSize, // allocate buffer >= minSize
int32_t& actualSize);
// default converter cache
static UConverter* getDefaultConverter(UErrorCode& status);
static void releaseDefaultConverter(UConverter *converter);
static UConverter *fgDefaultConverter;
friend class UnicodeStringStreamer;
public:
//========================================
// Deprecated API
//========================================
// size() -> length()
inline int32_t size(void) const;
// parameters reordered for consistency
inline UnicodeString& findAndReplace(const UnicodeString& oldText,
const UnicodeString& newText,
UTextOffset start,
int32_t length);
inline void* operator new(size_t size);
inline void* operator new(size_t size, void *location);
inline void operator delete(void *location);
//========================================
// Non-public API - will be removed!
//========================================
UnicodeString(UChar *buff, int32_t bufLength, int32_t buffCapacity);
const UChar* getUChars(void) const;
inline const UChar* getUniChars(void) const;
UChar* orphanStorage(void);
};
//========================================
// Array copying
//========================================
// Copy an array of UnicodeString OBJECTS (not pointers).
inline void
icu_arrayCopy(const UnicodeString *src, UnicodeString *dst, int32_t count)
{ while(count-- > 0) *dst++ = *src++; }
inline void
icu_arrayCopy(const UnicodeString *src, int32_t srcStart,
UnicodeString *dst, int32_t dstStart, int32_t count)
{ icu_arrayCopy(src+srcStart, dst+dstStart, count); }
//========================================
// Inline members
//========================================
inline
UnicodeString::UnicodeString(const UnicodeString& that)
: fArray(fStackBuffer), fLength(0), fCapacity(US_STACKBUF_SIZE),
fRefCounted(FALSE), fHashCode(kEmptyHashCode), fBogus(FALSE)
{ *this = that; }
//========================================
// Read-only alias methods
//========================================
inline bool_t
UnicodeString::operator== (const UnicodeString& text) const
{ return (fLength == text.fLength
&& doCompare(0, fLength, text, 0, text.fLength) == 0); }
inline bool_t
UnicodeString::operator!= (const UnicodeString& text) const
{ return (! operator==(text)); }
inline bool_t
UnicodeString::operator> (const UnicodeString& text) const
{ return doCompare(0, fLength, text, 0, text.fLength) == 1; }
inline bool_t
UnicodeString::operator< (const UnicodeString& text) const
{ return doCompare(0, fLength, text, 0, text.fLength) == -1; }
inline bool_t
UnicodeString::operator>= (const UnicodeString& text) const
{ return doCompare(0, fLength, text, 0, text.fLength) != -1; }
inline bool_t
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 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
{
UTextOffset pos = 0, myStart = start;
int32_t myLength = length, limit = start + length;
// cache for speed
UChar ch = srcText.charAt(srcStart);
while( (pos = indexOf(ch, myStart, myLength)) != -1 && myLength > 0) {
if(compare(pos, srcLength, srcText, srcStart, srcLength) == 0)
return pos;
myStart = pos + 1;
myLength = limit - myStart;
}
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(const UChar *srcChars,
UTextOffset srcStart,
int32_t srcLength,
UTextOffset start,
int32_t length) const
{
UTextOffset pos = 0, myStart = start;
int32_t myLength = length, limit = start + length;
// cache for speed
UChar ch = srcChars[srcStart];
while( (pos = indexOf(ch, myStart, myLength)) != -1 && myLength > 0) {
if(compare(pos, srcLength, srcChars, srcStart, srcLength) == 0)
return pos;
myStart = pos + 1;
myLength = limit - myStart;
}
return -1;
}
inline UTextOffset
UnicodeString::indexOf(UChar c) const
{ return doIndexOf(c, 0, fLength); }
inline UTextOffset
UnicodeString::indexOf(UChar c,
UTextOffset start) const
{ return doIndexOf(c, start, fLength - start); }
inline UTextOffset
UnicodeString::indexOf(UChar c,
UTextOffset start,
int32_t length) const
{ return doIndexOf(c, start, length); }
inline UTextOffset
UnicodeString::lastIndexOf(const UnicodeString& text) const
{ return lastIndexOf(text, 0, text.fLength, 0, fLength); }
inline UTextOffset
UnicodeString::lastIndexOf(const UnicodeString& text,
UTextOffset start) const
{ return lastIndexOf(text, 0, text.fLength, start, fLength - start); }
inline UTextOffset
UnicodeString::lastIndexOf(const UnicodeString& text,
UTextOffset start,
int32_t length) const
{ return lastIndexOf(text, 0, text.fLength, start, length); }
inline UTextOffset
UnicodeString::lastIndexOf(const UnicodeString& srcText,
UTextOffset srcStart,
int32_t srcLength,
UTextOffset start,
int32_t length) const
{
UTextOffset pos = 0, myStart = start;
int32_t myLength = length, limit = start + length;
// cache for speed
UChar ch = srcText.charAt(srcStart);
while( (pos = lastIndexOf(ch, myStart, myLength)) != -1 && myLength > 0) {
if(compare(pos, srcLength, srcText, srcStart, srcLength) == 0)
return pos;
myLength = pos - myStart - 1;
}
return -1;
}
inline UTextOffset
UnicodeString::lastIndexOf(const UChar *srcChars,
int32_t srcLength,
UTextOffset start) const
{ return lastIndexOf(srcChars, 0, srcLength, start, fLength - start); }
inline UTextOffset
UnicodeString::lastIndexOf(const UChar *srcChars,
int32_t srcLength,
UTextOffset start,
int32_t length) const
{ return lastIndexOf(srcChars, 0, srcLength, start, length); }
inline UTextOffset
UnicodeString::lastIndexOf(const UChar *srcChars,
UTextOffset srcStart,
int32_t srcLength,
UTextOffset start,
int32_t length) const
{
UTextOffset pos = 0, myStart = start;
int32_t myLength = length, limit = start + length;
// cache for speed
UChar ch = srcChars[srcStart];
while( (pos = lastIndexOf(ch, myStart, myLength)) != -1 && myLength > 0) {
if(compare(pos, srcLength, srcChars, srcStart, srcLength) == 0)
return pos;
myLength = pos - myStart - 1;
}
return -1;
}
inline UTextOffset
UnicodeString::lastIndexOf(UChar c) const
{ return doLastIndexOf(c, 0, fLength); }
inline UTextOffset
UnicodeString::lastIndexOf(UChar c,
UTextOffset start) const
{ return doLastIndexOf(c, start, fLength - start); }
inline UTextOffset
UnicodeString::lastIndexOf(UChar c,
UTextOffset start,
int32_t length) const
{ return doLastIndexOf(c, start, length); }
inline bool_t
UnicodeString::startsWith(const UnicodeString& text) const
{ return compare(0, text.fLength, text, 0, text.fLength) == 0; }
inline bool_t
UnicodeString::startsWith(const UnicodeString& srcText,
UTextOffset srcStart,
int32_t srcLength) const
{ return doCompare(0, srcLength, srcText, srcStart, srcLength) == 0; }
inline bool_t
UnicodeString::startsWith(const UChar *srcChars,
int32_t srcLength) const
{ return doCompare(0, srcLength, srcChars, 0, srcLength) == 0; }
inline bool_t
UnicodeString::startsWith(const UChar *srcChars,
UTextOffset srcStart,
int32_t srcLength) const
{ return doCompare(0, srcLength, srcChars, srcStart, srcLength) == 0;}
inline bool_t
UnicodeString::endsWith(const UnicodeString& text) const
{ return doCompare(fLength - text.fLength, text.fLength,
text, 0, text.fLength) == 0; }
inline bool_t
UnicodeString::endsWith(const UnicodeString& srcText,
UTextOffset srcStart,
int32_t srcLength) const
{ return doCompare(fLength - srcLength, srcLength,
srcText, srcStart, srcLength) == 0; }
inline bool_t
UnicodeString::endsWith(const UChar *srcChars,
int32_t srcLength) const
{ return doCompare(fLength - srcLength, srcLength,
srcChars, 0, srcLength) == 0; }
inline bool_t
UnicodeString::endsWith(const UChar *srcChars,
UTextOffset srcStart,
int32_t srcLength) const
{ return doCompare(fLength - srcLength, srcLength,
srcChars, srcStart, srcLength) == 0;}
//========================================
// replace
//========================================
inline UnicodeString&
UnicodeString::replace(UTextOffset start,
int32_t length,
const UnicodeString& srcText)
{ return doReplace(start, length, srcText, 0, srcText.fLength); }
inline UnicodeString&
UnicodeString::replace(UTextOffset start,
int32_t length,
const UnicodeString& srcText,
UTextOffset srcStart,
int32_t srcLength)
{ return doReplace(start, length, srcText, srcStart, srcLength); }
inline UnicodeString&
UnicodeString::replace(UTextOffset start,
int32_t length,
const UChar *srcChars,
int32_t srcLength)
{ return doReplace(start, length, srcChars, 0, srcLength); }
inline UnicodeString&
UnicodeString::replace(UTextOffset start,
int32_t length,
const UChar *srcChars,
UTextOffset srcStart,
int32_t srcLength)
{ return doReplace(start, length, srcChars, srcStart, srcLength); }
inline UnicodeString&
UnicodeString::replace(UTextOffset start,
int32_t length,
UChar srcChar)
{ return doReplace(start, length, &srcChar, 0, 1); }
inline UnicodeString&
UnicodeString::replaceBetween(UTextOffset start,
UTextOffset limit,
const UnicodeString& srcText)
{ return doReplace(start, limit - start, srcText, 0, srcText.fLength); }
inline UnicodeString&
UnicodeString::replaceBetween(UTextOffset start,
UTextOffset limit,
const UnicodeString& srcText,
UTextOffset srcStart,
UTextOffset srcLimit)
{ return doReplace(start, limit - start, srcText, srcStart, srcLimit - srcStart); }
inline UnicodeString&
UnicodeString::findAndReplace(const UnicodeString& oldText,
const UnicodeString& newText)
{ return findAndReplace(0, fLength, oldText, 0, oldText.fLength,
newText, 0, newText.fLength); }
inline UnicodeString&
UnicodeString::findAndReplace(UTextOffset start,
int32_t length,
const UnicodeString& oldText,
const UnicodeString& newText)
{ return findAndReplace(start, length, oldText, 0, oldText.fLength,
newText, 0, newText.fLength); }
inline UnicodeString&
UnicodeString::findAndReplace(UTextOffset start,
int32_t length,
const UnicodeString& oldText,
UTextOffset oldStart,
int32_t oldLength,
const UnicodeString& newText,
UTextOffset newStart,
int32_t newLength)
{
UTextOffset pos;
for(UTextOffset i = start; i < start + length; ++i) {
pos = indexOf(oldText, oldStart, oldLength, i, length - i + start);
if(pos != -1) {
replace(pos, oldLength, newText, newStart, newLength);
i += newLength;
}
}
return *this;
}
// ============================
// extract
// ============================
inline void
UnicodeString::doExtract(UTextOffset start,
int32_t length,
UnicodeString& target) const
{ target.replace(0, target.fLength, *this, start, length); }
inline void
UnicodeString::extract(UTextOffset start,
int32_t length,
UChar *dst,
UTextOffset dstStart) const
{ doExtract(start, length, dst, dstStart); }
inline void
UnicodeString::extract(UTextOffset start,
int32_t length,
UnicodeString& target) const
{ doExtract(start, length, target); }
inline void
UnicodeString::extractBetween(UTextOffset start,
UTextOffset limit,
UChar *dst,
UTextOffset dstStart) const
{ doExtract(start, limit - start, dst, dstStart); }
inline void
UnicodeString::extractBetween(UTextOffset start,
UTextOffset limit,
UnicodeString& target) const
{ doExtract(start, limit - start, target); }
inline UChar
UnicodeString::doCharAt(UTextOffset offset) const
{
if(offset < 0 || offset >= fLength)
return fgInvalidUChar;
// in ref-counted implementation, first char is ref count
return fArray[ fRefCounted ? offset + 1 : offset ];
}
inline UChar
UnicodeString::charAt(UTextOffset offset) const
{ return doCharAt(offset); }
inline UChar
UnicodeString::operator[] (UTextOffset offset) const
{ return doCharAt(offset); }
inline bool_t
UnicodeString::empty() const
{ return fLength == 0; }
//========================================
// Read-only implementation methods
//========================================
inline int32_t
UnicodeString::length() const
{ return fLength; }
inline int32_t
UnicodeString::hashCode() const
{ return (fHashCode == kInvalidHashCode
? ((UnicodeString*)this)->doHashCode() : fHashCode); }
//========================================
// Write alias methods
//========================================
inline UnicodeString&
UnicodeString::operator= (UChar ch)
{ return doReplace(0, fLength, &ch, 0, 1); }
inline UnicodeString&
UnicodeString::setTo(const UnicodeString& srcText,
UTextOffset srcStart,
int32_t srcLength)
{ return doReplace(0, fLength, srcText, srcStart, srcLength); }
inline UnicodeString&
UnicodeString::setTo(const UnicodeString& srcText)
{ return doReplace(0, fLength, srcText, 0, srcText.fLength); }
inline UnicodeString&
UnicodeString::setTo(const UChar *srcChars,
UTextOffset srcStart,
int32_t srcLength)
{ return doReplace(0, fLength, srcChars, srcStart, srcLength); }
inline UnicodeString&
UnicodeString::setTo(const UChar *srcChars,
int32_t srcLength)
{ return doReplace(0, fLength, srcChars, 0, srcLength); }
inline UnicodeString&
UnicodeString::setTo(UChar srcChar)
{ return doReplace(0, fLength, &srcChar, 0, 1); }
inline UnicodeString&
UnicodeString::operator+= (UChar ch)
{ return doReplace(fLength, 0, &ch, 0, 1); }
inline UnicodeString&
UnicodeString::operator+= (const UnicodeString& srcText)
{ return doReplace(fLength, 0, srcText, 0, srcText.fLength); }
inline UnicodeString&
UnicodeString::append(const UnicodeString& srcText,
UTextOffset srcStart,
int32_t srcLength)
{ return doReplace(fLength, 0, srcText, srcStart, srcLength); }
inline UnicodeString&
UnicodeString::append(const UnicodeString& srcText)
{ return doReplace(fLength, 0, srcText, 0, srcText.fLength); }
inline UnicodeString&
UnicodeString::append(const UChar *srcChars,
UTextOffset srcStart,
int32_t srcLength)
{ return doReplace(fLength, 0, srcChars, srcStart, srcLength); }
inline UnicodeString&
UnicodeString::append(const UChar *srcChars,
int32_t srcLength)
{ return doReplace(fLength, 0, srcChars, 0, srcLength); }
inline UnicodeString&
UnicodeString::append(UChar srcChar)
{ return doReplace(fLength, 0, &srcChar, 0, 1); }
inline UnicodeString&
UnicodeString::insert(UTextOffset start,
const UnicodeString& srcText,
UTextOffset srcStart,
int32_t srcLength)
{ return doReplace(start, 0, srcText, srcStart, srcLength); }
inline UnicodeString&
UnicodeString::insert(UTextOffset start,
const UnicodeString& srcText)
{ return doReplace(start, 0, srcText, 0, srcText.fLength); }
inline UnicodeString&
UnicodeString::insert(UTextOffset start,
const UChar *srcChars,
UTextOffset srcStart,
int32_t srcLength)
{ return doReplace(start, 0, srcChars, srcStart, srcLength); }
inline UnicodeString&
UnicodeString::insert(UTextOffset start,
const UChar *srcChars,
int32_t srcLength)
{ return doReplace(start, 0, srcChars, 0, srcLength); }
inline UnicodeString&
UnicodeString::insert(UTextOffset start,
UChar srcChar)
{ return doReplace(start, 0, &srcChar, 0, 1); }
inline UnicodeString&
UnicodeString::remove(UTextOffset start,
int32_t length)
{ return doReplace(start, length, 0, 0, 0); }
inline UnicodeString&
UnicodeString::remove()
{ return doReplace(0, fLength, 0, 0, 0); }
inline UnicodeString&
UnicodeString::removeBetween(UTextOffset start,
UTextOffset limit)
{ return doReplace(start, limit - start, 0, 0, 0); }
inline bool_t
UnicodeString::padLeading(int32_t targetLength,
UChar padChar)
{
if(fLength >= targetLength)
return FALSE;
else {
int32_t len = fLength;
for(int32_t i = 0; i < targetLength - len; ++i)
doReplace(0, 0, &padChar, 0, 1);
return TRUE;
}
}
inline bool_t
UnicodeString::padTrailing(int32_t targetLength,
UChar padChar)
{
if(fLength >= targetLength)
return FALSE;
else {
int32_t len = fLength;
for(int32_t i = 0; i < targetLength - len; ++i)
doReplace(fLength, 0, &padChar, 0, 1);
return TRUE;
}
}
inline bool_t
UnicodeString::truncate(int32_t targetLength)
{
if(fLength < targetLength)
return FALSE;
else {
doReplace(targetLength, fLength - targetLength, 0, 0, 0);
return TRUE;
}
}
inline UnicodeString&
UnicodeString::trim()
{
int32_t wsStart = 0;
int32_t wsEnd = 0;
UTextOffset start = 0;
UTextOffset limit = fLength;
UChar c = doCharAt(start);
while(start < limit &&
(c == 0x0020 || Unicode::getType(c) == Unicode::SPACE_SEPARATOR)) {
++wsStart;
c = doCharAt(++start);
}
c = charAt(--limit);
while(limit > start &&
(c == 0x0020 || Unicode::getType(c) == Unicode::SPACE_SEPARATOR)) {
++wsEnd;
c = doCharAt(--limit);
}
doReplace(0, wsStart, 0, 0, 0);
doReplace(fLength - wsEnd, wsEnd, 0, 0, 0);
return *this;
}
inline UnicodeString&
UnicodeString::reverse()
{ return doReverse(0, fLength); }
inline UnicodeString&
UnicodeString::reverse(UTextOffset start,
int32_t length)
{ return doReverse(start, length); }
//========================================
// Write implementation methods
//========================================
inline bool_t
UnicodeString::isBogus() const
{ return fBogus; }
//========================================
// Privates
//========================================
inline UChar*
UnicodeString::getArrayStart()
{ return (fRefCounted ? fArray + 1 : fArray); }
inline const UChar*
UnicodeString::getArrayStart() const
{ return (fRefCounted ? fArray + 1 : fArray); }
inline int32_t
UnicodeString::getCapacity() const
{ return (fRefCounted ? fCapacity - 1 : fCapacity); }
inline uint16_t
UnicodeString::addRef()
{ return ++(fArray[0]); }
inline uint16_t
UnicodeString::removeRef()
{ return --(fArray[0]); }
inline uint16_t
UnicodeString::refCount() const
{ return fArray[0]; }
inline uint16_t
UnicodeString::setRefCount(uint16_t count)
{ fRefCounted = TRUE; return (fArray[0] = count); }
// deprecated API - remove later
inline int32_t
UnicodeString::size() const
{ return fLength; }
inline const UChar*
UnicodeString::getUniChars() const
{ return getUChars(); }
inline UnicodeString&
UnicodeString::findAndReplace(const UnicodeString& oldText,
const UnicodeString& newText,
UTextOffset start,
int32_t length)
{ return findAndReplace(start, length, oldText, newText); }
inline void*
UnicodeString::operator new(size_t size)
{ return ::operator new(size); }
inline void*
UnicodeString::operator new(size_t size,
void *location)
{ return location; }
inline void
UnicodeString::operator delete(void *location)
{ ::operator delete(location); }
//========================================
// Static members
//========================================
inline int32_t
UnicodeString::allocation(int32_t minSize)
{ return minSize < kGrowSize ? kGrowSize
: (minSize * 2 + kGrowSize) & ~(kGrowSize - 1); }
inline UChar*
UnicodeString::allocate(int32_t minSize, int32_t& actualSize)
{ actualSize = allocation(minSize); return new UChar[ actualSize ]; }
//========================================
// class UCharReference
//========================================
class UCharReference
{
public:
UCharReference();
inline UCharReference(UnicodeString *string,
UTextOffset pos);
inline UCharReference(const UCharReference& that);
~UCharReference();
inline UCharReference& operator= (const UCharReference& that);
inline UCharReference& operator= (UChar c);
inline operator UChar();
private:
UnicodeString *fString;
UTextOffset fPos;
};
//========================================
// Inline members
//========================================
inline
UCharReference::UCharReference(UnicodeString *string,
UTextOffset pos)
: fString(string), fPos(pos)
{}
inline
UCharReference::UCharReference(const UCharReference& that)
{ this->operator=(that); }
inline
UCharReference::~UCharReference()
{}
inline UCharReference&
UCharReference::operator= (const UCharReference& that)
{ fString->setCharAt(fPos, that.fString->charAt(that.fPos)); return *this; }
inline UCharReference&
UCharReference::operator= (UChar c)
{ fString->setCharAt(fPos, c); return *this; }
inline
UCharReference::operator UChar()
{ return fString->charAt(fPos); }
#endif