/*
*******************************************************************************
*
-* Copyright (C) 1999-2001, International Business Machines
+* Copyright (C) 1999-2009, International Business Machines
* Corporation and others. All Rights Reserved.
*
*******************************************************************************
* and some common definitions.
*
* For more information see utf.h and the ICU User Guide Strings chapter
- * (http://oss.software.ibm.com/icu/userguide/).
+ * (http://icu-project.org/userguide/strings.html).
*
* <em>Usage:</em>
* ICU coding guidelines for if() statements should be followed when using these macros.
* bodies and all macro statements should be terminated with semicolon.
*/
+#ifndef __UTF8_H__
+#define __UTF8_H__
+
/* utf.h must be included first. */
#ifndef __UTF_H__
# include "unicode/utf.h"
#endif
-#ifndef __UTF8_H__
-#define __UTF8_H__
-
/* internal definitions ----------------------------------------------------- */
/**
* \var utf8_countTrailBytes
* Internal array with numbers of trail bytes for any given byte used in
* lead byte position.
+ *
+ * This is internal since it is not meant to be called directly by external clients;
+ * however it is called by public macros in this file and thus must remain stable,
+ * and should not be hidden when other internal functions are hidden (otherwise
+ * public macros would fail to compile).
* @internal
*/
#ifdef U_UTF8_IMPL
-U_CAPI const uint8_t
-utf8_countTrailBytes[256];
+U_EXPORT const uint8_t
+#elif defined(U_STATIC_IMPLEMENTATION) || defined(U_COMMON_IMPLEMENTATION)
+U_CFUNC const uint8_t
#else
U_CFUNC U_IMPORT const uint8_t /* U_IMPORT2? */ /*U_IMPORT*/
-utf8_countTrailBytes[256];
#endif
+utf8_countTrailBytes[256];
/**
* Count the trail bytes for a UTF-8 lead byte.
+ *
+ * This is internal since it is not meant to be called directly by external clients;
+ * however it is called by public macros in this file and thus must remain stable.
* @internal
*/
#define U8_COUNT_TRAIL_BYTES(leadByte) (utf8_countTrailBytes[(uint8_t)leadByte])
/**
* Mask a UTF-8 lead byte, leave only the lower bits that form part of the code point value.
+ *
+ * This is internal since it is not meant to be called directly by external clients;
+ * however it is called by public macros in this file and thus must remain stable.
* @internal
*/
#define U8_MASK_LEAD_BYTE(leadByte, countTrailBytes) ((leadByte)&=(1<<(6-(countTrailBytes)))-1)
/**
* Function for handling "next code point" with error-checking.
+ *
+ * This is internal since it is not meant to be called directly by external clients;
+ * however it is U_STABLE (not U_INTERNAL) since it is called by public macros in this
+ * file and thus must remain stable, and should not be hidden when other internal
+ * functions are hidden (otherwise public macros would fail to compile).
* @internal
*/
-U_CAPI UChar32 U_EXPORT2
+U_STABLE UChar32 U_EXPORT2
utf8_nextCharSafeBody(const uint8_t *s, int32_t *pi, int32_t length, UChar32 c, UBool strict);
/**
* Function for handling "append code point" with error-checking.
+ *
+ * This is internal since it is not meant to be called directly by external clients;
+ * however it is U_STABLE (not U_INTERNAL) since it is called by public macros in this
+ * file and thus must remain stable, and should not be hidden when other internal
+ * functions are hidden (otherwise public macros would fail to compile).
* @internal
*/
-U_CAPI int32_t U_EXPORT2
+U_STABLE int32_t U_EXPORT2
utf8_appendCharSafeBody(uint8_t *s, int32_t i, int32_t length, UChar32 c, UBool *pIsError);
/**
* Function for handling "previous code point" with error-checking.
+ *
+ * This is internal since it is not meant to be called directly by external clients;
+ * however it is U_STABLE (not U_INTERNAL) since it is called by public macros in this
+ * file and thus must remain stable, and should not be hidden when other internal
+ * functions are hidden (otherwise public macros would fail to compile).
* @internal
*/
-U_CAPI UChar32 U_EXPORT2
+U_STABLE UChar32 U_EXPORT2
utf8_prevCharSafeBody(const uint8_t *s, int32_t start, int32_t *pi, UChar32 c, UBool strict);
/**
* Function for handling "skip backward one code point" with error-checking.
+ *
+ * This is internal since it is not meant to be called directly by external clients;
+ * however it is U_STABLE (not U_INTERNAL) since it is called by public macros in this
+ * file and thus must remain stable, and should not be hidden when other internal
+ * functions are hidden (otherwise public macros would fail to compile).
* @internal
*/
-U_CAPI int32_t U_EXPORT2
+U_STABLE int32_t U_EXPORT2
utf8_back1SafeBody(const uint8_t *s, int32_t start, int32_t i);
/* single-code point definitions -------------------------------------------- */
* Does this code unit (byte) encode a code point by itself (US-ASCII 0..0x7f)?
* @param c 8-bit code unit (byte)
* @return TRUE or FALSE
- * @draft ICU 2.4
+ * @stable ICU 2.4
*/
#define U8_IS_SINGLE(c) (((c)&0x80)==0)
* Is this code unit (byte) a UTF-8 lead byte?
* @param c 8-bit code unit (byte)
* @return TRUE or FALSE
- * @draft ICU 2.4
+ * @stable ICU 2.4
*/
#define U8_IS_LEAD(c) ((uint8_t)((c)-0xc0)<0x3e)
* Is this code unit (byte) a UTF-8 trail byte?
* @param c 8-bit code unit (byte)
* @return TRUE or FALSE
- * @draft ICU 2.4
+ * @stable ICU 2.4
*/
#define U8_IS_TRAIL(c) (((c)&0xc0)==0x80)
* of this Unicode code point?
* @param c 32-bit code point
* @return 1..4, or 0 if c is a surrogate or not a Unicode code point
- * @draft ICU 2.4
+ * @stable ICU 2.4
*/
#define U8_LENGTH(c) \
((uint32_t)(c)<=0x7f ? 1 : \
/**
* The maximum number of UTF-8 code units (bytes) per Unicode code point (U+0000..U+10ffff).
* @return 4
- * @draft ICU 2.4
+ * @stable ICU 2.4
*/
#define U8_MAX_LENGTH 4
* byte sequence.
* Iteration through a string is more efficient with U8_NEXT_UNSAFE or U8_NEXT.
*
- * @param s const UChar * string
+ * @param s const uint8_t * string
* @param i string offset
* @param c output UChar32 variable
* @see U8_GET
- * @draft ICU 2.4
+ * @stable ICU 2.4
*/
#define U8_GET_UNSAFE(s, i, c) { \
- int32_t __I=(int32_t)(i); \
- U8_SET_CP_START_UNSAFE(s, __I); \
- U8_NEXT_UNSAFE(s, __I, c); \
+ int32_t _u8_get_unsafe_index=(int32_t)(i); \
+ U8_SET_CP_START_UNSAFE(s, _u8_get_unsafe_index); \
+ U8_NEXT_UNSAFE(s, _u8_get_unsafe_index, c); \
}
/**
* c is set to a negative value.
* Iteration through a string is more efficient with U8_NEXT_UNSAFE or U8_NEXT.
*
- * @param s const UChar * string
+ * @param s const uint8_t * string
* @param start starting string offset
- * @param i string offset, start<=i<length
+ * @param i string offset, must be start<=i<length
* @param length string length
* @param c output UChar32 variable, set to <0 in case of an error
* @see U8_GET_UNSAFE
- * @draft ICU 2.4
+ * @stable ICU 2.4
*/
#define U8_GET(s, start, i, length, c) { \
- int32_t __I=(int32_t)(i); \
- U8_SET_CP_START(s, start, __I); \
- U8_NEXT(s, __I, length, c); \
+ int32_t _u8_get_index=(int32_t)(i); \
+ U8_SET_CP_START(s, start, _u8_get_index); \
+ U8_NEXT(s, _u8_get_index, length, c); \
}
/* definitions with forward iteration --------------------------------------- */
* The result is undefined if the offset points to a trail byte
* or an illegal UTF-8 sequence.
*
- * @param s const UChar * string
+ * @param s const uint8_t * string
* @param i string offset
* @param c output UChar32 variable
* @see U8_NEXT
- * @draft ICU 2.4
+ * @stable ICU 2.4
*/
#define U8_NEXT_UNSAFE(s, i, c) { \
- (c)=(s)[(i)++]; \
+ (c)=(uint8_t)(s)[(i)++]; \
if((uint8_t)((c)-0xc0)<0x35) { \
uint8_t __count=U8_COUNT_TRAIL_BYTES(c); \
U8_MASK_LEAD_BYTE(c, __count); \
* If the offset points to a trail byte or an illegal UTF-8 sequence, then
* c is set to a negative value.
*
- * @param s const UChar * string
- * @param i string offset, i<length
+ * @param s const uint8_t * string
+ * @param i string offset, must be i<length
* @param length string length
* @param c output UChar32 variable, set to <0 in case of an error
* @see U8_NEXT_UNSAFE
- * @draft ICU 2.4
+ * @stable ICU 2.4
*/
#define U8_NEXT(s, i, length, c) { \
- (c)=(s)[(i)++]; \
+ (c)=(uint8_t)(s)[(i)++]; \
if((c)>=0x80) { \
- if(U8_IS_LEAD(c)) { \
- (c)=utf8_nextCharSafeBody(s, &(i), (int32_t)(length), c, -1); \
+ uint8_t __t1, __t2; \
+ if( /* handle U+1000..U+CFFF inline */ \
+ (0xe0<(c) && (c)<=0xec) && \
+ (((i)+1)<(length)) && \
+ (__t1=(uint8_t)((s)[i]-0x80))<=0x3f && \
+ (__t2=(uint8_t)((s)[(i)+1]-0x80))<= 0x3f \
+ ) { \
+ /* no need for (c&0xf) because the upper bits are truncated after <<12 in the cast to (UChar) */ \
+ (c)=(UChar)(((c)<<12)|(__t1<<6)|__t2); \
+ (i)+=2; \
+ } else if( /* handle U+0080..U+07FF inline */ \
+ ((c)<0xe0 && (c)>=0xc2) && \
+ ((i)<(length)) && \
+ (__t1=(uint8_t)((s)[i]-0x80))<=0x3f \
+ ) { \
+ (c)=(UChar)((((c)&0x1f)<<6)|__t1); \
+ ++(i); \
+ } else if(U8_IS_LEAD(c)) { \
+ /* function call for "complicated" and error cases */ \
+ (c)=utf8_nextCharSafeBody((const uint8_t *)s, &(i), (int32_t)(length), c, -1); \
} else { \
(c)=U_SENTINEL; \
} \
* "Unsafe" macro, assumes a valid code point and sufficient space in the string.
* Otherwise, the result is undefined.
*
- * @param s const UChar * string buffer
+ * @param s const uint8_t * string buffer
* @param i string offset
* @param c code point to append
* @see U8_APPEND
- * @draft ICU 2.4
+ * @stable ICU 2.4
*/
#define U8_APPEND_UNSAFE(s, i, c) { \
if((uint32_t)(c)<=0x7f) { \
}
/**
- * Append a code point to a string, overwriting 1 or 2 code units.
+ * Append a code point to a string, overwriting 1 to 4 bytes.
* The offset points to the current end of the string contents
* and is advanced (post-increment).
* "Safe" macro, checks for a valid code point.
* If the code point is not valid or trail bytes do not fit,
* then isError is set to TRUE.
*
- * @param s const UChar * string buffer
- * @param i string offset, i<length
- * @param length size of the string buffer
+ * @param s const uint8_t * string buffer
+ * @param i string offset, must be i<capacity
+ * @param capacity size of the string buffer
* @param c code point to append
* @param isError output UBool set to TRUE if an error occurs, otherwise not modified
* @see U8_APPEND_UNSAFE
- * @draft ICU 2.4
+ * @stable ICU 2.4
*/
-#define U8_APPEND(s, i, length, c, isError) { \
+#define U8_APPEND(s, i, capacity, c, isError) { \
if((uint32_t)(c)<=0x7f) { \
(s)[(i)++]=(uint8_t)(c); \
+ } else if((uint32_t)(c)<=0x7ff && (i)+1<(capacity)) { \
+ (s)[(i)++]=(uint8_t)(((c)>>6)|0xc0); \
+ (s)[(i)++]=(uint8_t)(((c)&0x3f)|0x80); \
+ } else if((uint32_t)(c)<=0xd7ff && (i)+2<(capacity)) { \
+ (s)[(i)++]=(uint8_t)(((c)>>12)|0xe0); \
+ (s)[(i)++]=(uint8_t)((((c)>>6)&0x3f)|0x80); \
+ (s)[(i)++]=(uint8_t)(((c)&0x3f)|0x80); \
} else { \
- (i)=utf8_appendCharSafeBody(s, (int32_t)(i), (int32_t)(length), c, &(isError)); \
+ (i)=utf8_appendCharSafeBody(s, (int32_t)(i), (int32_t)(capacity), c, &(isError)); \
} \
}
* (Post-incrementing iteration.)
* "Unsafe" macro, assumes well-formed UTF-8.
*
- * @param s const UChar * string
+ * @param s const uint8_t * string
* @param i string offset
* @see U8_FWD_1
- * @draft ICU 2.4
+ * @stable ICU 2.4
*/
#define U8_FWD_1_UNSAFE(s, i) { \
(i)+=1+U8_COUNT_TRAIL_BYTES((s)[i]); \
* (Post-incrementing iteration.)
* "Safe" macro, checks for illegal sequences and for string boundaries.
*
- * @param s const UChar * string
- * @param i string offset, i<length
+ * @param s const uint8_t * string
+ * @param i string offset, must be i<length
* @param length string length
* @see U8_FWD_1_UNSAFE
- * @draft ICU 2.4
+ * @stable ICU 2.4
*/
#define U8_FWD_1(s, i, length) { \
- uint8_t __b=(s)[(i)++]; \
+ uint8_t __b=(uint8_t)(s)[(i)++]; \
if(U8_IS_LEAD(__b)) { \
uint8_t __count=U8_COUNT_TRAIL_BYTES(__b); \
if((i)+__count>(length)) { \
* (Post-incrementing iteration.)
* "Unsafe" macro, assumes well-formed UTF-8.
*
- * @param s const UChar * string
+ * @param s const uint8_t * string
* @param i string offset
* @param n number of code points to skip
* @see U8_FWD_N
- * @draft ICU 2.4
+ * @stable ICU 2.4
*/
#define U8_FWD_N_UNSAFE(s, i, n) { \
int32_t __N=(n); \
* (Post-incrementing iteration.)
* "Safe" macro, checks for illegal sequences and for string boundaries.
*
- * @param s const UChar * string
- * @param i string offset, i<length
+ * @param s const uint8_t * string
+ * @param i string offset, must be i<length
* @param length string length
* @param n number of code points to skip
* @see U8_FWD_N_UNSAFE
- * @draft ICU 2.4
+ * @stable ICU 2.4
*/
#define U8_FWD_N(s, i, length, n) { \
int32_t __N=(n); \
* Otherwise, it is not modified.
* "Unsafe" macro, assumes well-formed UTF-8.
*
- * @param s const UChar * string
+ * @param s const uint8_t * string
* @param i string offset
* @see U8_SET_CP_START
- * @draft ICU 2.4
+ * @stable ICU 2.4
*/
#define U8_SET_CP_START_UNSAFE(s, i) { \
while(U8_IS_TRAIL((s)[i])) { --(i); } \
* Otherwise, it is not modified.
* "Safe" macro, checks for illegal sequences and for string boundaries.
*
- * @param s const UChar * string
+ * @param s const uint8_t * string
* @param start starting string offset (usually 0)
- * @param i string offset, start<=i
+ * @param i string offset, must be start<=i
* @see U8_SET_CP_START_UNSAFE
- * @draft ICU 2.4
+ * @stable ICU 2.4
*/
#define U8_SET_CP_START(s, start, i) { \
if(U8_IS_TRAIL((s)[(i)])) { \
* will be returned as the code point.
* The result is undefined if the offset is behind an illegal UTF-8 sequence.
*
- * @param s const UChar * string
+ * @param s const uint8_t * string
* @param i string offset
* @param c output UChar32 variable
* @see U8_PREV
- * @draft ICU 2.4
+ * @stable ICU 2.4
*/
#define U8_PREV_UNSAFE(s, i, c) { \
- (c)=(s)[--(i)]; \
+ (c)=(uint8_t)(s)[--(i)]; \
if(U8_IS_TRAIL(c)) { \
uint8_t __b, __count=1, __shift=6; \
\
/* c is a trail byte */ \
(c)&=0x3f; \
for(;;) { \
- __b=(s)[--(i)]; \
+ __b=(uint8_t)(s)[--(i)]; \
if(__b>=0xc0) { \
U8_MASK_LEAD_BYTE(__b, __count); \
(c)|=(UChar32)__b<<__shift; \
* will be returned as the code point.
* If the offset is behind an illegal UTF-8 sequence, then c is set to a negative value.
*
- * @param s const UChar * string
+ * @param s const uint8_t * string
* @param start starting string offset (usually 0)
- * @param i string offset, start<=i
+ * @param i string offset, must be start<i
* @param c output UChar32 variable, set to <0 in case of an error
* @see U8_PREV_UNSAFE
- * @draft ICU 2.4
+ * @stable ICU 2.4
*/
#define U8_PREV(s, start, i, c) { \
- (c)=(s)[--(i)]; \
+ (c)=(uint8_t)(s)[--(i)]; \
if((c)>=0x80) { \
if((c)<=0xbf) { \
- (c)=utf8_prevCharSafeBody(s, start, &(i), c, -1); \
+ (c)=utf8_prevCharSafeBody((const uint8_t *)s, start, &(i), c, -1); \
} else { \
(c)=U_SENTINEL; \
} \
* The input offset may be the same as the string length.
* "Unsafe" macro, assumes well-formed UTF-8.
*
- * @param s const UChar * string
+ * @param s const uint8_t * string
* @param i string offset
* @see U8_BACK_1
- * @draft ICU 2.4
+ * @stable ICU 2.4
*/
#define U8_BACK_1_UNSAFE(s, i) { \
while(U8_IS_TRAIL((s)[--(i)])) {} \
* The input offset may be the same as the string length.
* "Safe" macro, checks for illegal sequences and for string boundaries.
*
- * @param s const UChar * string
+ * @param s const uint8_t * string
* @param start starting string offset (usually 0)
- * @param i string offset, start<=i
+ * @param i string offset, must be start<i
* @see U8_BACK_1_UNSAFE
- * @draft ICU 2.4
+ * @stable ICU 2.4
*/
#define U8_BACK_1(s, start, i) { \
if(U8_IS_TRAIL((s)[--(i)])) { \
* The input offset may be the same as the string length.
* "Unsafe" macro, assumes well-formed UTF-8.
*
- * @param s const UChar * string
+ * @param s const uint8_t * string
* @param i string offset
* @param n number of code points to skip
* @see U8_BACK_N
- * @draft ICU 2.4
+ * @stable ICU 2.4
*/
#define U8_BACK_N_UNSAFE(s, i, n) { \
int32_t __N=(n); \
* The input offset may be the same as the string length.
* "Safe" macro, checks for illegal sequences and for string boundaries.
*
- * @param s const UChar * string
+ * @param s const uint8_t * string
* @param start index of the start of the string
- * @param i string offset, i<length
+ * @param i string offset, must be start<i
* @param n number of code points to skip
* @see U8_BACK_N_UNSAFE
- * @draft ICU 2.4
+ * @stable ICU 2.4
*/
#define U8_BACK_N(s, start, i, n) { \
int32_t __N=(n); \
* The input offset may be the same as the string length.
* "Unsafe" macro, assumes well-formed UTF-8.
*
- * @param s const UChar * string
+ * @param s const uint8_t * string
* @param i string offset
* @see U8_SET_CP_LIMIT
- * @draft ICU 2.4
+ * @stable ICU 2.4
*/
#define U8_SET_CP_LIMIT_UNSAFE(s, i) { \
U8_BACK_1_UNSAFE(s, i); \
* The input offset may be the same as the string length.
* "Safe" macro, checks for illegal sequences and for string boundaries.
*
- * @param s const UChar * string
+ * @param s const uint8_t * string
* @param start starting string offset (usually 0)
- * @param i string offset, start<=i<=length
+ * @param i string offset, must be start<=i<=length
* @param length string length
* @see U8_SET_CP_LIMIT_UNSAFE
- * @draft ICU 2.4
+ * @stable ICU 2.4
*/
#define U8_SET_CP_LIMIT(s, start, i, length) { \
if((start)<(i) && (i)<(length)) { \
projects / apple / icu.git / blobdiff