unistr.h File Reference

C++ API: Unicode String. More...

#include "unicode/rep.h"

Go to the source code of this file.

Data Structures

class  UnicodeString
 UnicodeString is a string class that stores Unicode characters directly and provides similar functionality as the Java String and StringBuffer classes. More...

Defines

#define U_COMPARE_CODE_POINT_ORDER   0x8000
 Option bit for u_strCaseCompare, u_strcasecmp, unorm_compare, etc: Compare strings in code point order instead of code unit order.
#define US_INV   UnicodeString::kInvariant
 Constant to be used in the UnicodeString(char *, int32_t, EInvariant) constructor which constructs a Unicode string from an invariant-character char * string.
#define UNICODE_STRING(cs, _length)   UnicodeString(TRUE, (const UChar *)L ## cs, _length)
 Unicode String literals in C++.
#define UNICODE_STRING_SIMPLE(cs)   UnicodeString(TRUE, (const UChar *)L ## cs, -1)
 Unicode String literals in C++.

Functions

U_STABLE int32_t U_EXPORT2 u_strlen (const UChar *s)
U_COMMON_API UnicodeString
U_EXPORT2 
operator+ (const UnicodeString &s1, const UnicodeString &s2)
 Create a new UnicodeString with the concatenation of two others.
U_NAMESPACE_END void uprv_arrayCopy (const U_NAMESPACE_QUALIFIER UnicodeString *src, U_NAMESPACE_QUALIFIER UnicodeString *dst, int32_t count)
 Copy an array of UnicodeString OBJECTS (not pointers).
void uprv_arrayCopy (const U_NAMESPACE_QUALIFIER UnicodeString *src, int32_t srcStart, U_NAMESPACE_QUALIFIER UnicodeString *dst, int32_t dstStart, int32_t count)
 Copy an array of UnicodeString OBJECTS (not pointers).


Detailed Description

C++ API: Unicode String.

Definition in file unistr.h.


Define Documentation

#define U_COMPARE_CODE_POINT_ORDER   0x8000
 

Option bit for u_strCaseCompare, u_strcasecmp, unorm_compare, etc: Compare strings in code point order instead of code unit order.

Stable:
ICU 2.2

Definition at line 41 of file unistr.h.

#define UNICODE_STRING cs,
_length   )     UnicodeString(TRUE, (const UChar *)L ## cs, _length)
 

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 NUL, 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.

Stable:
ICU 2.0

Definition at line 88 of file unistr.h.

#define UNICODE_STRING_SIMPLE cs   )     UnicodeString(TRUE, (const UChar *)L ## cs, -1)
 

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 improved 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.

Stable:
ICU 2.0

Definition at line 109 of file unistr.h.

#define US_INV   UnicodeString::kInvariant
 

Constant to be used in the UnicodeString(char *, int32_t, EInvariant) constructor which constructs a Unicode string from an invariant-character char * string.

About invariant characters see utypes.h. This constructor has no runtime dependency on conversion code and is therefore recommended over ones taking a charset name string (where the empty string "" indicates invariant-character conversion).

Draft:
This API may be changed in the future versions and was introduced in ICU 3.2

Definition at line 68 of file unistr.h.


Function Documentation

U_COMMON_API UnicodeString U_EXPORT2 operator+ const UnicodeString s1,
const UnicodeString s2
 

Create a new UnicodeString with the concatenation of two others.

Parameters:
s1 The first string to be copied to the new one.
s2 The second string to be copied to the new one, after s1.
Returns:
UnicodeString(s1).append(s2)
Stable:
ICU 2.8

void uprv_arrayCopy const U_NAMESPACE_QUALIFIER UnicodeString src,
int32_t  srcStart,
U_NAMESPACE_QUALIFIER UnicodeString dst,
int32_t  dstStart,
int32_t  count
[inline]
 

Copy an array of UnicodeString OBJECTS (not pointers).

Internal:
Do not use. This API is for interal use only.

Definition at line 3224 of file unistr.h.

References uprv_arrayCopy().

U_NAMESPACE_END void uprv_arrayCopy const U_NAMESPACE_QUALIFIER UnicodeString src,
U_NAMESPACE_QUALIFIER UnicodeString dst,
int32_t  count
[inline]
 

Copy an array of UnicodeString OBJECTS (not pointers).

Internal:
Do not use. This API is for interal use only.

Definition at line 3216 of file unistr.h.

Referenced by uprv_arrayCopy().


Generated on Sat Feb 11 17:42:29 2006 for ICU 3.4 by  doxygen 1.4.6