18e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project/* 28e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project********************************************************************** 38e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project* Copyright (C) 1999-2004, International Business Machines 48e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project* Corporation and others. All Rights Reserved. 58e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project********************************************************************** 68e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * ucnv.h: 78e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * External APIs for the ICU's codeset conversion library 88e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Bertrand A. Damiba 98e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 108e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Modification History: 118e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 128e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Date Name Description 138e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 04/04/99 helena Fixed internal header inclusion. 148e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 05/11/00 helena Added setFallback and usesFallback APIs. 158e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 06/29/2000 helena Major rewrite of the callback APIs. 168e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 12/07/2000 srl Update of documentation 178e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project */ 188e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 198e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project/** 208e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * \file 218e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * \brief C API: Character conversion 228e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 238e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * <h2>Character Conversion C API</h2> 248e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 258e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * <p>This API is used to convert codepage or character encoded data to and 268e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * from UTF-16. You can open a converter with {@link ucnv_open() }. With that 278e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * converter, you can get its properties, set options, convert your data and 288e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * close the converter.</p> 298e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 308e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * <p>Since many software programs recogize different converter names for 318e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * different types of converters, there are other functions in this API to 328e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * iterate over the converter aliases. The functions {@link ucnv_getAvailableName() }, 338e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * {@link ucnv_getAlias() } and {@link ucnv_getStandardName() } are some of the 348e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * more frequently used alias functions to get this information.</p> 358e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 368e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * <p>When a converter encounters an illegal, irregular, invalid or unmappable character 378e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * its default behavior is to use a substitution character to replace the 388e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * bad byte sequence. This behavior can be changed by using {@link ucnv_getFromUCallBack() } 398e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * or {@link ucnv_getToUCallBack() } on the converter. The header ucnv_err.h defines 408e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * many other callback actions that can be used instead of a character substitution.</p> 418e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 428e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * <p>More information about this API can be found in our 438e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * <a href="http://oss.software.ibm.com/icu/userguide/conversion.html">User's 448e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Guide</a>.</p> 458e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project */ 468e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 478e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project#ifndef UCNV_H 488e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project#define UCNV_H 498e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 508e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project#include "unicode/ucnv_err.h" 518e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project#include "unicode/uenum.h" 528e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 538e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project#ifndef __USET_H__ 548e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 558e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project/** 568e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * USet is the C API type for Unicode sets. 578e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * It is forward-declared here to avoid including the header file if related 588e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * conversion APIs are not used. 598e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * See unicode/uset.h 608e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 618e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_getUnicodeSet 628e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @stable ICU 2.6 638e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project */ 648e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Projectstruct USet; 658e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project/** @stable ICU 2.6 */ 668e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Projecttypedef struct USet USet; 678e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 688e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project#endif 698e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 708e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project#if !UCONFIG_NO_CONVERSION 718e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 728e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source ProjectU_CDECL_BEGIN 738e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 748e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project/** Maximum length of a converter name including the terminating NULL @stable ICU 2.0 */ 758e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project#define UCNV_MAX_CONVERTER_NAME_LENGTH 60 768e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project/** Maximum length of a converter name including path and terminating NULL @stable ICU 2.0 */ 778e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project#define UCNV_MAX_FULL_FILE_NAME_LENGTH (600+UCNV_MAX_CONVERTER_NAME_LENGTH) 788e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 798e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project/** Shift in for EBDCDIC_STATEFUL and iso2022 states @stable ICU 2.0 */ 808e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project#define UCNV_SI 0x0F 818e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project/** Shift out for EBDCDIC_STATEFUL and iso2022 states @stable ICU 2.0 */ 828e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project#define UCNV_SO 0x0E 838e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 848e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project/** 858e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Enum for specifying basic types of converters 868e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_getType 878e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @stable ICU 2.0 888e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project */ 898e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Projecttypedef enum { 908e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UCNV_UNSUPPORTED_CONVERTER = -1, 918e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UCNV_SBCS = 0, 928e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UCNV_DBCS = 1, 938e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UCNV_MBCS = 2, 948e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UCNV_LATIN_1 = 3, 958e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UCNV_UTF8 = 4, 968e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UCNV_UTF16_BigEndian = 5, 978e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UCNV_UTF16_LittleEndian = 6, 988e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UCNV_UTF32_BigEndian = 7, 998e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UCNV_UTF32_LittleEndian = 8, 1008e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UCNV_EBCDIC_STATEFUL = 9, 1018e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UCNV_ISO_2022 = 10, 1028e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 1038e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UCNV_LMBCS_1 = 11, 1048e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UCNV_LMBCS_2, 1058e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UCNV_LMBCS_3, 1068e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UCNV_LMBCS_4, 1078e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UCNV_LMBCS_5, 1088e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UCNV_LMBCS_6, 1098e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UCNV_LMBCS_8, 1108e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UCNV_LMBCS_11, 1118e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UCNV_LMBCS_16, 1128e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UCNV_LMBCS_17, 1138e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UCNV_LMBCS_18, 1148e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UCNV_LMBCS_19, 1158e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UCNV_LMBCS_LAST = UCNV_LMBCS_19, 1168e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UCNV_HZ, 1178e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UCNV_SCSU, 1188e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UCNV_ISCII, 1198e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UCNV_US_ASCII, 1208e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UCNV_UTF7, 1218e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UCNV_BOCU1, 1228e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UCNV_UTF16, 1238e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UCNV_UTF32, 1248e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UCNV_CESU8, 1258e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UCNV_IMAP_MAILBOX, 1268e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 1278e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project /* Number of converter types for which we have conversion routines. */ 1288e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UCNV_NUMBER_OF_SUPPORTED_CONVERTER_TYPES 1298e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 1308e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project} UConverterType; 1318e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 1328e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project/** 1338e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Enum for specifying which platform a converter ID refers to. 1348e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * The use of platform/CCSID is not recommended. See ucnv_openCCSID(). 1358e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 1368e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_getPlatform 1378e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_openCCSID 1388e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_getCCSID 1398e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @stable ICU 2.0 1408e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project */ 1418e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Projecttypedef enum { 1428e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UCNV_UNKNOWN = -1, 1438e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UCNV_IBM = 0 1448e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project} UConverterPlatform; 1458e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 1468e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project/** 1478e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Function pointer for error callback in the codepage to unicode direction. 1488e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Called when an error has occured in conversion to unicode, or on open/close of the callback (see reason). 1498e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param context Pointer to the callback's private data 1508e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param args Information about the conversion in progress 1518e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param codeUnits Points to 'length' bytes of the concerned codepage sequence 1528e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param length Size (in bytes) of the concerned codepage sequence 1538e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param reason Defines the reason the callback was invoked 1548e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_setToUCallBack 1558e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see UConverterToUnicodeArgs 1568e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @stable ICU 2.0 1578e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project */ 1588e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Projecttypedef void (U_EXPORT2 *UConverterToUCallback) ( 1598e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project const void* context, 1608e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UConverterToUnicodeArgs *args, 1618e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project const char *codeUnits, 1628e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project int32_t length, 1638e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UConverterCallbackReason reason, 1648e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UErrorCode *); 1658e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 1668e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project/** 1678e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Function pointer for error callback in the unicode to codepage direction. 1688e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Called when an error has occured in conversion from unicode, or on open/close of the callback (see reason). 1698e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param context Pointer to the callback's private data 1708e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param args Information about the conversion in progress 1718e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param codeUnits Points to 'length' UChars of the concerned Unicode sequence 1728e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param length Size (in bytes) of the concerned codepage sequence 1738e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param codePoint Single UChar32 (UTF-32) containing the concerend Unicode codepoint. 1748e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param reason Defines the reason the callback was invoked 1758e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_setFromUCallBack 1768e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @stable ICU 2.0 1778e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project */ 1788e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Projecttypedef void (U_EXPORT2 *UConverterFromUCallback) ( 1798e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project const void* context, 1808e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UConverterFromUnicodeArgs *args, 1818e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project const UChar* codeUnits, 1828e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project int32_t length, 1838e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UChar32 codePoint, 1848e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UConverterCallbackReason reason, 1858e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UErrorCode *); 1868e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 1878e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source ProjectU_CDECL_END 1888e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 1898e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project/** 1908e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Character that separates converter names from options and options from each other. 1918e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_open 1928e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @stable ICU 2.0 1938e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project */ 1948e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project#define UCNV_OPTION_SEP_CHAR ',' 1958e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 1968e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project/** 1978e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * String version of UCNV_OPTION_SEP_CHAR. 1988e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_open 1998e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @stable ICU 2.0 2008e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project */ 2018e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project#define UCNV_OPTION_SEP_STRING "," 2028e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 2038e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project/** 2048e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Character that separates a converter option from its value. 2058e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_open 2068e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @stable ICU 2.0 2078e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project */ 2088e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project#define UCNV_VALUE_SEP_CHAR '=' 2098e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 2108e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project/** 2118e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * String version of UCNV_VALUE_SEP_CHAR. 2128e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_open 2138e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @stable ICU 2.0 2148e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project */ 2158e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project#define UCNV_VALUE_SEP_STRING "=" 2168e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 2178e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project/** 2188e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Converter option for specifying a locale. 2198e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * For example, ucnv_open("SCSU,locale=ja", &errorCode); 2208e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * See convrtrs.txt. 2218e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 2228e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_open 2238e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @stable ICU 2.0 2248e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project */ 2258e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project#define UCNV_LOCALE_OPTION_STRING ",locale=" 2268e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 2278e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project/** 2288e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Converter option for specifying a version selector (0..9) for some converters. 2298e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * For example, ucnv_open("UTF-7,version=1", &errorCode); 2308e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * See convrtrs.txt. 2318e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 2328e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_open 2338e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @stable ICU 2.4 2348e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project */ 2358e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project#define UCNV_VERSION_OPTION_STRING ",version=" 2368e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 2378e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project/** 2388e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Converter option for EBCDIC SBCS or mixed-SBCS/DBCS (stateful) codepages. 2398e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Swaps Unicode mappings for EBCDIC LF and NL codes, as used on 2408e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * S/390 (z/OS) Unix System Services (Open Edition). 2418e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * For example, ucnv_open("ibm-1047,swaplfnl", &errorCode); 2428e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * See convrtrs.txt. 2438e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 2448e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_open 2458e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @stable ICU 2.4 2468e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project */ 2478e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project#define UCNV_SWAP_LFNL_OPTION_STRING ",swaplfnl" 2488e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 2498e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project/** 2508e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Do a fuzzy compare of a two converter/alias names. The comparison 2518e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * is case-insensitive. It also ignores the characters '-', '_', and 2528e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * ' ' (dash, underscore, and space). Thus the strings "UTF-8", 2538e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * "utf_8", and "Utf 8" are exactly equivalent. 2548e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 2558e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param name1 a converter name or alias, zero-terminated 2568e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param name2 a converter name or alias, zero-terminated 2578e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @return 0 if the names match, or a negative value if the name1 2588e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * lexically precedes name2, or a positive value if the name1 2598e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * lexically follows name2. 2608e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @stable ICU 2.0 2618e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project */ 2628e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source ProjectU_STABLE int U_EXPORT2 2638e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Projectucnv_compareNames(const char *name1, const char *name2); 2648e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 2658e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 2668e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project/** 2678e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Creates a UConverter object with the names specified as a C string. 2688e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * The actual name will be resolved with the alias file 2698e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * using a case-insensitive string comparison that ignores 2708e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * the delimiters '-', '_', and ' ' (dash, underscore, and space). 2718e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * E.g., the names "UTF8", "utf-8", and "Utf 8" are all equivalent. 2728e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * If <code>NULL</code> is passed for the converter name, it will create one with the 2738e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * getDefaultName return value. 2748e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 2758e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * <p>A converter name for ICU 1.5 and above may contain options 2768e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * like a locale specification to control the specific behavior of 2778e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * the newly instantiated converter. 2788e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * The meaning of the options depends on the particular converter. 2798e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * If an option is not defined for or recognized by a given converter, then it is ignored.</p> 2808e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 2818e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * <p>Options are appended to the converter name string, with a 2828e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * <code>UCNV_OPTION_SEP_CHAR</code> between the name and the first option and 2838e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * also between adjacent options.</p> 2848e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 2858e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * <p>If the alias is ambiguous, then the preferred converter is used 2868e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * and the status is set to U_AMBIGUOUS_ALIAS_WARNING.</p> 2878e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 2888e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * <p>The conversion behavior and names can vary between platforms. ICU may 2898e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * convert some characters differently from other platforms. Details on this topic 2908e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * are in the <a href="http://oss.software.ibm.com/icu/userguide/conversion.html">User's 2918e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Guide</a>.</p> 2928e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 2938e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param converterName Name of the uconv table, may have options appended 2948e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param err outgoing error status <TT>U_MEMORY_ALLOCATION_ERROR, U_FILE_ACCESS_ERROR</TT> 2958e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @return the created Unicode converter object, or <TT>NULL</TT> if an error occured 2968e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_openU 2978e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_openCCSID 2988e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_close 2998e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @stable ICU 2.0 3008e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project */ 3018e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source ProjectU_STABLE UConverter* U_EXPORT2 3028e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Projectucnv_open(const char *converterName, UErrorCode *err); 3038e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 3048e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 3058e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project/** 3068e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Creates a Unicode converter with the names specified as unicode string. 3078e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * The name should be limited to the ASCII-7 alphanumerics range. 3088e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * The actual name will be resolved with the alias file 3098e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * using a case-insensitive string comparison that ignores 3108e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * the delimiters '-', '_', and ' ' (dash, underscore, and space). 3118e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * E.g., the names "UTF8", "utf-8", and "Utf 8" are all equivalent. 3128e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * If <TT>NULL</TT> is passed for the converter name, it will create 3138e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * one with the ucnv_getDefaultName() return value. 3148e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * If the alias is ambiguous, then the preferred converter is used 3158e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * and the status is set to U_AMBIGUOUS_ALIAS_WARNING. 3168e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param name : name of the uconv table in a zero terminated 3178e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Unicode string 3188e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param err outgoing error status <TT>U_MEMORY_ALLOCATION_ERROR, 3198e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * U_FILE_ACCESS_ERROR</TT> 3208e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @return the created Unicode converter object, or <TT>NULL</TT> if an 3218e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * error occured 3228e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_open 3238e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_openCCSID 3248e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_close 3258e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_getDefaultName 3268e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @stable ICU 2.0 3278e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project */ 3288e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source ProjectU_STABLE UConverter* U_EXPORT2 3298e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Projectucnv_openU(const UChar *name, 3308e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UErrorCode *err); 3318e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 3328e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project/** 3338e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Creates a UConverter object from a CCSID number and platform pair. 3348e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Note that the usefulness of this function is limited to platforms with numeric 3358e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * encoding IDs. Only IBM and Microsoft platforms use numeric (16-bit) identifiers for 3368e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * encodings. 3378e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 3388e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * In addition, IBM CCSIDs and Unicode conversion tables are not 1:1 related. 3398e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * For many IBM CCSIDs there are multiple (up to six) Unicode conversion tables, and 3408e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * for some Unicode conversion tables there are multiple CCSIDs. 3418e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Some "alternate" Unicode conversion tables are provided by the 3428e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * IBM CDRA conversion table registry. 3438e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * The most prominent example of a systematic modification of conversion tables that is 3448e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * not provided in the form of conversion table files in the repository is 3458e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * that S/390 Unix System Services swaps the codes for Line Feed and New Line in all 3468e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * EBCDIC codepages, which requires such a swap in the Unicode conversion tables as well. 3478e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 3488e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Only IBM default conversion tables are accessible with ucnv_openCCSID(). 3498e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * ucnv_getCCSID() will return the same CCSID for all conversion tables that are associated 3508e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * with that CCSID. 3518e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 3528e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Currently, the only "platform" supported in the ICU converter API is UCNV_IBM. 3538e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 3548e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * In summary, the use of CCSIDs and the associated API functions is not recommended. 3558e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 3568e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * In order to open a converter with the default IBM CDRA Unicode conversion table, 3578e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * you can use this function or use the prefix "ibm-": 3588e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * \code 3598e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * char name[20]; 3608e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * sprintf(name, "ibm-%hu", ccsid); 3618e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * cnv=ucnv_open(name, &errorCode); 3628e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * \endcode 3638e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 3648e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * In order to open a converter with the IBM S/390 Unix System Services variant 3658e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * of a Unicode/EBCDIC conversion table, 3668e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * you can use the prefix "ibm-" together with the option string UCNV_SWAP_LFNL_OPTION_STRING: 3678e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * \code 3688e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * char name[20]; 3698e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * sprintf(name, "ibm-%hu" UCNV_SWAP_LFNL_OPTION_STRING, ccsid); 3708e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * cnv=ucnv_open(name, &errorCode); 3718e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * \endcode 3728e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 3738e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * In order to open a converter from a Microsoft codepage number, use the prefix "cp": 3748e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * \code 3758e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * char name[20]; 3768e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * sprintf(name, "cp%hu", codepageID); 3778e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * cnv=ucnv_open(name, &errorCode); 3788e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * \endcode 3798e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 3808e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * If the alias is ambiguous, then the preferred converter is used 3818e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * and the status is set to U_AMBIGUOUS_ALIAS_WARNING. 3828e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 3838e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param codepage codepage number to create 3848e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param platform the platform in which the codepage number exists 3858e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param err error status <TT>U_MEMORY_ALLOCATION_ERROR, U_FILE_ACCESS_ERROR</TT> 3868e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @return the created Unicode converter object, or <TT>NULL</TT> if an error 3878e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * occured. 3888e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_open 3898e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_openU 3908e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_close 3918e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_getCCSID 3928e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_getPlatform 3938e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see UConverterPlatform 3948e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @stable ICU 2.0 3958e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project */ 3968e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source ProjectU_STABLE UConverter* U_EXPORT2 3978e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Projectucnv_openCCSID(int32_t codepage, 3988e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UConverterPlatform platform, 3998e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UErrorCode * err); 4008e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 4018e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project/** 4028e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * <p>Creates a UConverter object specified from a packageName and a converterName.</p> 4038e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 4048e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * <p>The packageName and converterName must point to an ICU udata object, as defined by 4058e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * <code> udata_open( packageName, "cnv", converterName, err) </code> or equivalent. 4068e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Typically, packageName will refer to a (.dat) file, or to a package registered with 4078e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * udata_setAppData().</p> 4088e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 4098e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * <p>The name will NOT be looked up in the alias mechanism, nor will the converter be 4108e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * stored in the converter cache or the alias table. The only way to open further converters 4118e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * is call this function multiple times, or use the ucnv_safeClone() function to clone a 4128e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 'master' converter.</p> 4138e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 4148e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * <p>A future version of ICU may add alias table lookups and/or caching 4158e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * to this function.</p> 4168e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 4178e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * <p>Example Use: 4188e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * <code>cnv = ucnv_openPackage("myapp", "myconverter", &err);</code> 4198e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * </p> 4208e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 4218e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param packageName name of the package (equivalent to 'path' in udata_open() call) 4228e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param converterName name of the data item to be used, without suffix. 4238e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param err outgoing error status <TT>U_MEMORY_ALLOCATION_ERROR, U_FILE_ACCESS_ERROR</TT> 4248e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @return the created Unicode converter object, or <TT>NULL</TT> if an error occured 4258e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see udata_open 4268e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_open 4278e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_safeClone 4288e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_close 4298e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @stable ICU 2.2 4308e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project */ 4318e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source ProjectU_STABLE UConverter* U_EXPORT2 4328e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Projectucnv_openPackage(const char *packageName, const char *converterName, UErrorCode *err); 4338e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 4348e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project/** 4358e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Thread safe cloning operation 4368e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param cnv converter to be cloned 4378e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param stackBuffer user allocated space for the new clone. If NULL new memory will be allocated. 4388e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * If buffer is not large enough, new memory will be allocated. 4398e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Clients can use the U_CNV_SAFECLONE_BUFFERSIZE. This will probably be enough to avoid memory allocations. 4408e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param pBufferSize pointer to size of allocated space. 4418e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * If *pBufferSize == 0, a sufficient size for use in cloning will 4428e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * be returned ('pre-flighting') 4438e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * If *pBufferSize is not enough for a stack-based safe clone, 4448e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * new memory will be allocated. 4458e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param status to indicate whether the operation went on smoothly or there were errors 4468e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * An informational status value, U_SAFECLONE_ALLOCATED_ERROR, is used if any allocations were necessary. 4478e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @return pointer to the new clone 4488e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @stable ICU 2.0 4498e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project */ 4508e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source ProjectU_STABLE UConverter * U_EXPORT2 4518e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Projectucnv_safeClone(const UConverter *cnv, 4528e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project void *stackBuffer, 4538e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project int32_t *pBufferSize, 4548e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UErrorCode *status); 4558e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 4568e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project/** 4578e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * \def U_CNV_SAFECLONE_BUFFERSIZE 4588e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Definition of a buffer size that is designed to be large enough for 4598e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * converters to be cloned with ucnv_safeClone(). 4608e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @stable ICU 2.0 4618e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project */ 4628e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project#define U_CNV_SAFECLONE_BUFFERSIZE 1024 4638e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 4648e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project/** 4658e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Deletes the unicode converter and releases resources associated 4668e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * with just this instance. 4678e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Does not free up shared converter tables. 4688e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 4698e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param converter the converter object to be deleted 4708e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_open 4718e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_openU 4728e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_openCCSID 4738e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @stable ICU 2.0 4748e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project */ 4758e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source ProjectU_STABLE void U_EXPORT2 4768e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Projectucnv_close(UConverter * converter); 4778e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 4788e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project/** 4798e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Fills in the output parameter, subChars, with the substitution characters 4808e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * as multiple bytes. 4818e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 4828e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param converter the Unicode converter 4838e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param subChars the subsitution characters 4848e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param len on input the capacity of subChars, on output the number 4858e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * of bytes copied to it 4868e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param err the outgoing error status code. 4878e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * If the substitution character array is too small, an 4888e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * <TT>U_INDEX_OUTOFBOUNDS_ERROR</TT> will be returned. 4898e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_setSubstChars 4908e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @stable ICU 2.0 4918e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project */ 4928e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source ProjectU_STABLE void U_EXPORT2 4938e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Projectucnv_getSubstChars(const UConverter *converter, 4948e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project char *subChars, 4958e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project int8_t *len, 4968e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UErrorCode *err); 4978e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 4988e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project/** 4998e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Sets the substitution chars when converting from unicode to a codepage. The 5008e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * substitution is specified as a string of 1-4 bytes, and may contain 5018e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * <TT>NULL</TT> byte. 5028e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param converter the Unicode converter 5038e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param subChars the substitution character byte sequence we want set 5048e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param len the number of bytes in subChars 5058e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param err the error status code. <TT>U_INDEX_OUTOFBOUNDS_ERROR </TT> if 5068e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * len is bigger than the maximum number of bytes allowed in subchars 5078e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_getSubstChars 5088e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @stable ICU 2.0 5098e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project */ 5108e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source ProjectU_STABLE void U_EXPORT2 5118e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Projectucnv_setSubstChars(UConverter *converter, 5128e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project const char *subChars, 5138e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project int8_t len, 5148e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UErrorCode *err); 5158e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 5168e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project/** 5178e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Fills in the output parameter, errBytes, with the error characters from the 5188e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * last failing conversion. 5198e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 5208e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param converter the Unicode converter 5218e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param errBytes the codepage bytes which were in error 5228e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param len on input the capacity of errBytes, on output the number of 5238e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * bytes which were copied to it 5248e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param err the error status code. 5258e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * If the substitution character array is too small, an 5268e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * <TT>U_INDEX_OUTOFBOUNDS_ERROR</TT> will be returned. 5278e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @stable ICU 2.0 5288e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project */ 5298e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source ProjectU_STABLE void U_EXPORT2 5308e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Projectucnv_getInvalidChars(const UConverter *converter, 5318e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project char *errBytes, 5328e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project int8_t *len, 5338e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UErrorCode *err); 5348e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 5358e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project/** 5368e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Fills in the output parameter, errChars, with the error characters from the 5378e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * last failing conversion. 5388e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 5398e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param converter the Unicode converter 5408e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param errUChars the UChars which were in error 5418e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param len on input the capacity of errUChars, on output the number of 5428e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * UChars which were copied to it 5438e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param err the error status code. 5448e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * If the substitution character array is too small, an 5458e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * <TT>U_INDEX_OUTOFBOUNDS_ERROR</TT> will be returned. 5468e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @stable ICU 2.0 5478e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project */ 5488e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source ProjectU_STABLE void U_EXPORT2 5498e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Projectucnv_getInvalidUChars(const UConverter *converter, 5508e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UChar *errUChars, 5518e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project int8_t *len, 5528e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UErrorCode *err); 5538e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 5548e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project/** 5558e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Resets the state of a converter to the default state. This is used 5568e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * in the case of an error, to restart a conversion from a known default state. 5578e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * It will also empty the internal output buffers. 5588e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param converter the Unicode converter 5598e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @stable ICU 2.0 5608e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project */ 5618e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source ProjectU_STABLE void U_EXPORT2 5628e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Projectucnv_reset(UConverter *converter); 5638e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 5648e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project/** 5658e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Resets the to-Unicode part of a converter state to the default state. 5668e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * This is used in the case of an error to restart a conversion to 5678e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Unicode to a known default state. It will also empty the internal 5688e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * output buffers used for the conversion to Unicode codepoints. 5698e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param converter the Unicode converter 5708e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @stable ICU 2.0 5718e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project */ 5728e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source ProjectU_STABLE void U_EXPORT2 5738e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Projectucnv_resetToUnicode(UConverter *converter); 5748e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 5758e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project/** 5768e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Resets the from-Unicode part of a converter state to the default state. 5778e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * This is used in the case of an error to restart a conversion from 5788e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Unicode to a known default state. It will also empty the internal output 5798e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * buffers used for the conversion from Unicode codepoints. 5808e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param converter the Unicode converter 5818e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @stable ICU 2.0 5828e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project */ 5838e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source ProjectU_STABLE void U_EXPORT2 5848e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Projectucnv_resetFromUnicode(UConverter *converter); 5858e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 5868e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project/** 5878e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Returns the maximum number of bytes that are output per UChar in conversion 5888e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * from Unicode using this converter. 5898e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * The returned number can be used with UCNV_GET_MAX_BYTES_FOR_STRING 5908e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * to calculate the size of a target buffer for conversion from Unicode. 5918e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 5928e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Note: Before ICU 2.8, this function did not return reliable numbers for 5938e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * some stateful converters (EBCDIC_STATEFUL, ISO-2022) and LMBCS. 5948e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 5958e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * This number may not be the same as the maximum number of bytes per 5968e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * "conversion unit". In other words, it may not be the intuitively expected 5978e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * number of bytes per character that would be published for a charset, 5988e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * and may not fulfill any other purpose than the allocation of an output 5998e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * buffer of guaranteed sufficient size for a given input length and converter. 6008e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 6018e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Examples for special cases that are taken into account: 6028e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * - Supplementary code points may convert to more bytes than BMP code points. 6038e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * This function returns bytes per UChar (UTF-16 code unit), not per 6048e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Unicode code point, for efficient buffer allocation. 6058e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * - State-shifting output (SI/SO, escapes, etc.) from stateful converters. 6068e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * - When m input UChars are converted to n output bytes, then the maximum m/n 6078e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * is taken into account. 6088e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 6098e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * The number returned here does not take into account 6108e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * (see UCNV_GET_MAX_BYTES_FOR_STRING): 6118e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * - callbacks which output more than one charset character sequence per call, 6128e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * like escape callbacks 6138e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * - initial and final non-character bytes that are output by some converters 6148e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * (automatic BOMs, initial escape sequence, final SI, etc.) 6158e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 6168e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Examples for returned values: 6178e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * - SBCS charsets: 1 6188e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * - Shift-JIS: 2 6198e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * - UTF-16: 2 (2 per BMP, 4 per surrogate _pair_, BOM not counted) 6208e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * - UTF-8: 3 (3 per BMP, 4 per surrogate _pair_) 6218e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * - EBCDIC_STATEFUL (EBCDIC mixed SBCS/DBCS): 3 (SO + DBCS) 6228e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * - ISO-2022: 3 (always outputs UTF-8) 6238e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * - ISO-2022-JP: 6 (4-byte escape sequences + DBCS) 6248e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * - ISO-2022-CN: 8 (4-byte designator sequences + 2-byte SS2/SS3 + DBCS) 6258e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 6268e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param converter The Unicode converter. 6278e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @return The maximum number of bytes per UChar that are output by ucnv_fromUnicode(), 6288e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * to be used together with UCNV_GET_MAX_BYTES_FOR_STRING for buffer allocation. 6298e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 6308e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see UCNV_GET_MAX_BYTES_FOR_STRING 6318e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_getMinCharSize 6328e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @stable ICU 2.0 6338e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project */ 6348e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source ProjectU_STABLE int8_t U_EXPORT2 6358e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Projectucnv_getMaxCharSize(const UConverter *converter); 6368e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 6378e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project#ifndef U_HIDE_DRAFT_API 6388e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 6398e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project/** 6408e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Calculates the size of a buffer for conversion from Unicode to a charset. 6418e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * The calculated size is guaranteed to be sufficient for this conversion. 6428e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 6438e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * It takes into account initial and final non-character bytes that are output 6448e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * by some converters. 6458e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * It does not take into account callbacks which output more than one charset 6468e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * character sequence per call, like escape callbacks. 6478e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * The default (substitution) callback only outputs one charset character sequence. 6488e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 6498e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param length Number of UChars to be converted. 6508e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param maxCharSize Return value from ucnv_getMaxCharSize() for the converter 6518e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * that will be used. 6528e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @return Size of a buffer that will be large enough to hold the output bytes of 6538e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * converting length UChars with the converter that returned the maxCharSize. 6548e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 6558e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_getMaxCharSize 6568e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @draft ICU 2.8 6578e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project */ 6588e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project#define UCNV_GET_MAX_BYTES_FOR_STRING(length, maxCharSize) \ 6598e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project (((int32_t)(length)+10)*(int32_t)(maxCharSize)) 6608e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 6618e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project#endif /*U_HIDE_DRAFT_API*/ 6628e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 6638e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project/** 6648e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Returns the minimum byte length for characters in this codepage. 6658e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * This is usually either 1 or 2. 6668e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param converter the Unicode converter 6678e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @return the minimum number of bytes allowed by this particular converter 6688e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_getMaxCharSize 6698e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @stable ICU 2.0 6708e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project */ 6718e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source ProjectU_STABLE int8_t U_EXPORT2 6728e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Projectucnv_getMinCharSize(const UConverter *converter); 6738e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 6748e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project/** 6758e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Returns the display name of the converter passed in based on the Locale 6768e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * passed in. If the locale contains no display name, the internal ASCII 6778e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * name will be filled in. 6788e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 6798e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param converter the Unicode converter. 6808e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param displayLocale is the specific Locale we want to localised for 6818e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param displayName user provided buffer to be filled in 6828e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param displayNameCapacity size of displayName Buffer 6838e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param err error status code 6848e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @return displayNameLength number of UChar needed in displayName 6858e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_getName 6868e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @stable ICU 2.0 6878e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project */ 6888e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source ProjectU_STABLE int32_t U_EXPORT2 6898e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Projectucnv_getDisplayName(const UConverter *converter, 6908e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project const char *displayLocale, 6918e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UChar *displayName, 6928e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project int32_t displayNameCapacity, 6938e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UErrorCode *err); 6948e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 6958e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project/** 6968e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Gets the internal, canonical name of the converter (zero-terminated). 6978e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * The lifetime of the returned string will be that of the converter 6988e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * passed to this function. 6998e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param converter the Unicode converter 7008e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param err UErrorCode status 7018e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @return the internal name of the converter 7028e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_getDisplayName 7038e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @stable ICU 2.0 7048e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project */ 7058e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source ProjectU_STABLE const char * U_EXPORT2 7068e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Projectucnv_getName(const UConverter *converter, UErrorCode *err); 7078e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 7088e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project/** 7098e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Gets a codepage number associated with the converter. This is not guaranteed 7108e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * to be the one used to create the converter. Some converters do not represent 7118e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * platform registered codepages and return zero for the codepage number. 7128e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * The error code fill-in parameter indicates if the codepage number 7138e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * is available. 7148e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Does not check if the converter is <TT>NULL</TT> or if converter's data 7158e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * table is <TT>NULL</TT>. 7168e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 7178e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Important: The use of CCSIDs is not recommended because it is limited 7188e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * to only two platforms in principle and only one (UCNV_IBM) in the current 7198e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * ICU converter API. 7208e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Also, CCSIDs are insufficient to identify IBM Unicode conversion tables precisely. 7218e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * For more details see ucnv_openCCSID(). 7228e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 7238e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param converter the Unicode converter 7248e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param err the error status code. 7258e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @return If any error occurrs, -1 will be returned otherwise, the codepage number 7268e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * will be returned 7278e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_openCCSID 7288e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_getPlatform 7298e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @stable ICU 2.0 7308e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project */ 7318e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source ProjectU_STABLE int32_t U_EXPORT2 7328e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Projectucnv_getCCSID(const UConverter *converter, 7338e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UErrorCode *err); 7348e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 7358e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project/** 7368e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Gets a codepage platform associated with the converter. Currently, 7378e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * only <TT>UCNV_IBM</TT> will be returned. 7388e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Does not test if the converter is <TT>NULL</TT> or if converter's data 7398e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * table is <TT>NULL</TT>. 7408e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param converter the Unicode converter 7418e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param err the error status code. 7428e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @return The codepage platform 7438e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @stable ICU 2.0 7448e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project */ 7458e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source ProjectU_STABLE UConverterPlatform U_EXPORT2 7468e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Projectucnv_getPlatform(const UConverter *converter, 7478e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UErrorCode *err); 7488e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 7498e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project/** 7508e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Gets the type of the converter 7518e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * e.g. SBCS, MBCS, DBCS, UTF8, UTF16_BE, UTF16_LE, ISO_2022, 7528e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * EBCDIC_STATEFUL, LATIN_1 7538e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param converter a valid, opened converter 7548e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @return the type of the converter 7558e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @stable ICU 2.0 7568e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project */ 7578e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source ProjectU_STABLE UConverterType U_EXPORT2 7588e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Projectucnv_getType(const UConverter * converter); 7598e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 7608e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project/** 7618e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Gets the "starter" (lead) bytes for converters of type MBCS. 7628e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Will fill in an <TT>U_ILLEGAL_ARGUMENT_ERROR</TT> if converter passed in 7638e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * is not MBCS. Fills in an array of type UBool, with the value of the byte 7648e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * as offset to the array. For example, if (starters[0x20] == TRUE) at return, 7658e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * it means that the byte 0x20 is a starter byte in this converter. 7668e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Context pointers are always owned by the caller. 7678e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 7688e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param converter a valid, opened converter of type MBCS 7698e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param starters an array of size 256 to be filled in 7708e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param err error status, <TT>U_ILLEGAL_ARGUMENT_ERROR</TT> if the 7718e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * converter is not a type which can return starters. 7728e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_getType 7738e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @stable ICU 2.0 7748e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project */ 7758e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source ProjectU_STABLE void U_EXPORT2 7768e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Projectucnv_getStarters(const UConverter* converter, 7778e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UBool starters[256], 7788e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UErrorCode* err); 7798e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 7808e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 7818e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project/** 7828e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Selectors for Unicode sets that can be returned by ucnv_getUnicodeSet(). 7838e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_getUnicodeSet 7848e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @stable ICU 2.6 7858e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project */ 7868e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Projecttypedef enum UConverterUnicodeSet { 7878e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project /** Select the set of roundtrippable Unicode code points. @stable ICU 2.6 */ 7888e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UCNV_ROUNDTRIP_SET, 7898e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project /** Number of UConverterUnicodeSet selectors. @stable ICU 2.6 */ 7908e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UCNV_SET_COUNT 7918e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project} UConverterUnicodeSet; 7928e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 7938e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 7948e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project/** 7958e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Returns the set of Unicode code points that can be converted by an ICU converter. 7968e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 7978e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * The current implementation returns only one kind of set (UCNV_ROUNDTRIP_SET): 7988e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * The set of all Unicode code points that can be roundtrip-converted 7998e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * (converted without any data loss) with the converter. 8008e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * This set will not include code points that have fallback mappings 8018e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * or are only the result of reverse fallback mappings. 8028e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * See UTR #22 "Character Mapping Markup Language" 8038e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * at http://www.unicode.org/reports/tr22/ 8048e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 8058e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * This is useful for example for 8068e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * - checking that a string or document can be roundtrip-converted with a converter, 8078e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * without/before actually performing the conversion 8088e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * - testing if a converter can be used for text for typical text for a certain locale, 8098e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * by comparing its roundtrip set with the set of ExemplarCharacters from 8108e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * ICU's locale data or other sources 8118e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 8128e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * In the future, there may be more UConverterUnicodeSet choices to select 8138e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * sets with different properties. 8148e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 8158e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param cnv The converter for which a set is requested. 8168e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param setFillIn A valid USet *. It will be cleared by this function before 8178e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * the converter's specific set is filled into the USet. 8188e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param whichSet A UConverterUnicodeSet selector; 8198e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * currently UCNV_ROUNDTRIP_SET is the only supported value. 8208e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param pErrorCode ICU error code in/out parameter. 8218e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Must fulfill U_SUCCESS before the function call. 8228e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 8238e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see UConverterUnicodeSet 8248e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see uset_open 8258e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see uset_close 8268e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @stable ICU 2.6 8278e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project */ 8288e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source ProjectU_STABLE void U_EXPORT2 8298e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Projectucnv_getUnicodeSet(const UConverter *cnv, 8308e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project USet *setFillIn, 8318e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UConverterUnicodeSet whichSet, 8328e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UErrorCode *pErrorCode); 8338e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 8348e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project/** 8358e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Gets the current calback function used by the converter when an illegal 8368e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * or invalid codepage sequence is found. 8378e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Context pointers are always owned by the caller. 8388e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 8398e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param converter the unicode converter 8408e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param action fillin: returns the callback function pointer 8418e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param context fillin: returns the callback's private void* context 8428e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_setToUCallBack 8438e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @stable ICU 2.0 8448e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project */ 8458e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source ProjectU_STABLE void U_EXPORT2 8468e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Projectucnv_getToUCallBack (const UConverter * converter, 8478e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UConverterToUCallback *action, 8488e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project const void **context); 8498e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 8508e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project/** 8518e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Gets the current callback function used by the converter when illegal 8528e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * or invalid Unicode sequence is found. 8538e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Context pointers are always owned by the caller. 8548e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 8558e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param converter the unicode converter 8568e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param action fillin: returns the callback function pointer 8578e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param context fillin: returns the callback's private void* context 8588e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_setFromUCallBack 8598e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @stable ICU 2.0 8608e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project */ 8618e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source ProjectU_STABLE void U_EXPORT2 8628e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Projectucnv_getFromUCallBack (const UConverter * converter, 8638e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UConverterFromUCallback *action, 8648e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project const void **context); 8658e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 8668e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project/** 8678e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Changes the callback function used by the converter when 8688e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * an illegal or invalid sequence is found. 8698e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Context pointers are always owned by the caller. 8708e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Predefined actions and contexts can be found in the ucnv_err.h header. 8718e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 8728e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param converter the unicode converter 8738e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param newAction the new callback function 8748e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param newContext the new toUnicode callback context pointer. This can be NULL. 8758e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param oldAction fillin: returns the old callback function pointer. This can be NULL. 8768e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param oldContext fillin: returns the old callback's private void* context. This can be NULL. 8778e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param err The error code status 8788e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_getToUCallBack 8798e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @stable ICU 2.0 8808e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project */ 8818e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source ProjectU_STABLE void U_EXPORT2 8828e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Projectucnv_setToUCallBack (UConverter * converter, 8838e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UConverterToUCallback newAction, 8848e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project const void* newContext, 8858e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UConverterToUCallback *oldAction, 8868e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project const void** oldContext, 8878e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UErrorCode * err); 8888e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 8898e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project/** 8908e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Changes the current callback function used by the converter when 8918e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * an illegal or invalid sequence is found. 8928e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Context pointers are always owned by the caller. 8938e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Predefined actions and contexts can be found in the ucnv_err.h header. 8948e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 8958e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param converter the unicode converter 8968e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param newAction the new callback function 8978e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param newContext the new fromUnicode callback context pointer. This can be NULL. 8988e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param oldAction fillin: returns the old callback function pointer. This can be NULL. 8998e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param oldContext fillin: returns the old callback's private void* context. This can be NULL. 9008e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param err The error code status 9018e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_getFromUCallBack 9028e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @stable ICU 2.0 9038e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project */ 9048e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source ProjectU_STABLE void U_EXPORT2 9058e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Projectucnv_setFromUCallBack (UConverter * converter, 9068e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UConverterFromUCallback newAction, 9078e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project const void *newContext, 9088e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UConverterFromUCallback *oldAction, 9098e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project const void **oldContext, 9108e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UErrorCode * err); 9118e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 9128e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project/** 9138e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Converts an array of unicode characters to an array of codepage 9148e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * characters. This function is optimized for converting a continuous 9158e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * stream of data in buffer-sized chunks, where the entire source and 9168e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * target does not fit in available buffers. 9178e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 9188e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * The source pointer is an in/out parameter. It starts out pointing where the 9198e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * conversion is to begin, and ends up pointing after the last UChar consumed. 9208e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 9218e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Target similarly starts out pointer at the first available byte in the output 9228e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * buffer, and ends up pointing after the last byte written to the output. 9238e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 9248e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * The converter always attempts to consume the entire source buffer, unless 9258e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * (1.) the target buffer is full, or (2.) a failing error is returned from the 9268e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * current callback function. When a successful error status has been 9278e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * returned, it means that all of the source buffer has been 9288e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * consumed. At that point, the caller should reset the source and 9298e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * sourceLimit pointers to point to the next chunk. 9308e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 9318e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * At the end of the stream (flush==TRUE), the input is completely consumed 9328e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * when *source==sourceLimit and no error code is set. 9338e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * The converter object is then automatically reset by this function. 9348e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * (This means that a converter need not be reset explicitly between data 9358e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * streams if it finishes the previous stream without errors.) 9368e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 9378e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * This is a <I>stateful</I> conversion. Additionally, even when all source data has 9388e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * been consumed, some data may be in the converters' internal state. 9398e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Call this function repeatedly, updating the target pointers with 9408e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * the next empty chunk of target in case of a 9418e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * <TT>U_BUFFER_OVERFLOW_ERROR</TT>, and updating the source pointers 9428e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * with the next chunk of source when a successful error status is 9438e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * returned, until there are no more chunks of source data. 9448e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param converter the Unicode converter 9458e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param target I/O parameter. Input : Points to the beginning of the buffer to copy 9468e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * codepage characters to. Output : points to after the last codepage character copied 9478e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * to <TT>target</TT>. 9488e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param targetLimit the pointer just after last of the <TT>target</TT> buffer 9498e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param source I/O parameter, pointer to pointer to the source Unicode character buffer. 9508e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param sourceLimit the pointer just after the last of the source buffer 9518e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param offsets if NULL is passed, nothing will happen to it, otherwise it needs to have the same number 9528e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * of allocated cells as <TT>target</TT>. Will fill in offsets from target to source pointer 9538e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * e.g: <TT>offsets[3]</TT> is equal to 6, it means that the <TT>target[3]</TT> was a result of transcoding <TT>source[6]</TT> 9548e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * For output data carried across calls, and other data without a specific source character 9558e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * (such as from escape sequences or callbacks) -1 will be placed for offsets. 9568e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param flush set to <TT>TRUE</TT> if the current source buffer is the last available 9578e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * chunk of the source, <TT>FALSE</TT> otherwise. Note that if a failing status is returned, 9588e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * this function may have to be called multiple times with flush set to <TT>TRUE</TT> until 9598e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * the source buffer is consumed. 9608e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param err the error status. <TT>U_ILLEGAL_ARGUMENT_ERROR</TT> will be set if the 9618e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * converter is <TT>NULL</TT>. 9628e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * <code>U_BUFFER_OVERFLOW_ERROR</code> will be set if the target is full and there is 9638e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * still data to be written to the target. 9648e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_fromUChars 9658e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_convert 9668e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_getMinCharSize 9678e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_setToUCallBack 9688e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @stable ICU 2.0 9698e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project */ 9708e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source ProjectU_STABLE void U_EXPORT2 9718e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Projectucnv_fromUnicode (UConverter * converter, 9728e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project char **target, 9738e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project const char *targetLimit, 9748e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project const UChar ** source, 9758e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project const UChar * sourceLimit, 9768e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project int32_t* offsets, 9778e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UBool flush, 9788e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UErrorCode * err); 9798e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 9808e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project/** 9818e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Converts a buffer of codepage bytes into an array of unicode UChars 9828e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * characters. This function is optimized for converting a continuous 9838e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * stream of data in buffer-sized chunks, where the entire source and 9848e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * target does not fit in available buffers. 9858e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 9868e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * The source pointer is an in/out parameter. It starts out pointing where the 9878e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * conversion is to begin, and ends up pointing after the last byte of source consumed. 9888e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 9898e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Target similarly starts out pointer at the first available UChar in the output 9908e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * buffer, and ends up pointing after the last UChar written to the output. 9918e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * It does NOT necessarily keep UChar sequences together. 9928e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 9938e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * The converter always attempts to consume the entire source buffer, unless 9948e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * (1.) the target buffer is full, or (2.) a failing error is returned from the 9958e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * current callback function. When a successful error status has been 9968e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * returned, it means that all of the source buffer has been 9978e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * consumed. At that point, the caller should reset the source and 9988e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * sourceLimit pointers to point to the next chunk. 9998e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 10008e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * At the end of the stream (flush==TRUE), the input is completely consumed 10018e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * when *source==sourceLimit and no error code is set 10028e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * The converter object is then automatically reset by this function. 10038e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * (This means that a converter need not be reset explicitly between data 10048e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * streams if it finishes the previous stream without errors.) 10058e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 10068e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * This is a <I>stateful</I> conversion. Additionally, even when all source data has 10078e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * been consumed, some data may be in the converters' internal state. 10088e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Call this function repeatedly, updating the target pointers with 10098e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * the next empty chunk of target in case of a 10108e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * <TT>U_BUFFER_OVERFLOW_ERROR</TT>, and updating the source pointers 10118e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * with the next chunk of source when a successful error status is 10128e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * returned, until there are no more chunks of source data. 10138e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param converter the Unicode converter 10148e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param target I/O parameter. Input : Points to the beginning of the buffer to copy 10158e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * UChars into. Output : points to after the last UChar copied. 10168e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param targetLimit the pointer just after the end of the <TT>target</TT> buffer 10178e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param source I/O parameter, pointer to pointer to the source codepage buffer. 10188e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param sourceLimit the pointer to the byte after the end of the source buffer 10198e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param offsets if NULL is passed, nothing will happen to it, otherwise it needs to have the same number 10208e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * of allocated cells as <TT>target</TT>. Will fill in offsets from target to source pointer 10218e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * e.g: <TT>offsets[3]</TT> is equal to 6, it means that the <TT>target[3]</TT> was a result of transcoding <TT>source[6]</TT> 10228e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * For output data carried across calls, and other data without a specific source character 10238e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * (such as from escape sequences or callbacks) -1 will be placed for offsets. 10248e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param flush set to <TT>TRUE</TT> if the current source buffer is the last available 10258e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * chunk of the source, <TT>FALSE</TT> otherwise. Note that if a failing status is returned, 10268e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * this function may have to be called multiple times with flush set to <TT>TRUE</TT> until 10278e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * the source buffer is consumed. 10288e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param err the error status. <TT>U_ILLEGAL_ARGUMENT_ERROR</TT> will be set if the 10298e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * converter is <TT>NULL</TT>. 10308e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * <code>U_BUFFER_OVERFLOW_ERROR</code> will be set if the target is full and there is 10318e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * still data to be written to the target. 10328e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_fromUChars 10338e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_convert 10348e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_getMinCharSize 10358e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_setFromUCallBack 10368e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_getNextUChar 10378e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @stable ICU 2.0 10388e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project */ 10398e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source ProjectU_STABLE void U_EXPORT2 10408e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Projectucnv_toUnicode(UConverter *converter, 10418e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UChar **target, 10428e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project const UChar *targetLimit, 10438e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project const char **source, 10448e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project const char *sourceLimit, 10458e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project int32_t *offsets, 10468e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UBool flush, 10478e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UErrorCode *err); 10488e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 10498e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project/** 10508e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Convert the Unicode string into a codepage string using an existing UConverter. 10518e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * The output string is NUL-terminated if possible. 10528e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 10538e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * This function is a more convenient but less powerful version of ucnv_fromUnicode(). 10548e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * It is only useful for whole strings, not for streaming conversion. 10558e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 10568e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * The maximum output buffer capacity required (barring output from callbacks) will be 10578e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * UCNV_GET_MAX_BYTES_FOR_STRING(srcLength, ucnv_getMaxCharSize(cnv)). 10588e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 10598e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param cnv the converter object to be used (ucnv_resetFromUnicode() will be called) 10608e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param src the input Unicode string 10618e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param srcLength the input string length, or -1 if NUL-terminated 10628e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param dest destination string buffer, can be NULL if destCapacity==0 10638e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param destCapacity the number of chars available at dest 10648e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param pErrorCode normal ICU error code; 10658e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * common error codes that may be set by this function include 10668e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * U_BUFFER_OVERFLOW_ERROR, U_STRING_NOT_TERMINATED_WARNING, 10678e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * U_ILLEGAL_ARGUMENT_ERROR, and conversion errors 10688e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @return the length of the output string, not counting the terminating NUL; 10698e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * if the length is greater than destCapacity, then the string will not fit 10708e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * and a buffer of the indicated length would need to be passed in 10718e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_fromUnicode 10728e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_convert 10738e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see UCNV_GET_MAX_BYTES_FOR_STRING 10748e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @stable ICU 2.0 10758e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project */ 10768e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source ProjectU_STABLE int32_t U_EXPORT2 10778e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Projectucnv_fromUChars(UConverter *cnv, 10788e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project char *dest, int32_t destCapacity, 10798e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project const UChar *src, int32_t srcLength, 10808e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UErrorCode *pErrorCode); 10818e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 10828e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project/** 10838e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Convert the codepage string into a Unicode string using an existing UConverter. 10848e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * The output string is NUL-terminated if possible. 10858e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 10868e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * This function is a more convenient but less powerful version of ucnv_toUnicode(). 10878e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * It is only useful for whole strings, not for streaming conversion. 10888e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 10898e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * The maximum output buffer capacity required (barring output from callbacks) will be 10908e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 2*srcLength (each char may be converted into a surrogate pair). 10918e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 10928e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param cnv the converter object to be used (ucnv_resetToUnicode() will be called) 10938e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param src the input codepage string 10948e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param srcLength the input string length, or -1 if NUL-terminated 10958e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param dest destination string buffer, can be NULL if destCapacity==0 10968e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param destCapacity the number of UChars available at dest 10978e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param pErrorCode normal ICU error code; 10988e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * common error codes that may be set by this function include 10998e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * U_BUFFER_OVERFLOW_ERROR, U_STRING_NOT_TERMINATED_WARNING, 11008e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * U_ILLEGAL_ARGUMENT_ERROR, and conversion errors 11018e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @return the length of the output string, not counting the terminating NUL; 11028e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * if the length is greater than destCapacity, then the string will not fit 11038e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * and a buffer of the indicated length would need to be passed in 11048e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_toUnicode 11058e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_convert 11068e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @stable ICU 2.0 11078e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project */ 11088e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source ProjectU_STABLE int32_t U_EXPORT2 11098e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Projectucnv_toUChars(UConverter *cnv, 11108e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UChar *dest, int32_t destCapacity, 11118e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project const char *src, int32_t srcLength, 11128e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UErrorCode *pErrorCode); 11138e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 11148e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project/** 11158e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Convert a codepage buffer into Unicode one character at a time. 11168e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * The input is completely consumed when the U_INDEX_OUTOFBOUNDS_ERROR is set. 11178e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 11188e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Advantage compared to ucnv_toUnicode() or ucnv_toUChars(): 11198e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * - Faster for small amounts of data, for most converters, e.g., 11208e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * US-ASCII, ISO-8859-1, UTF-8/16/32, and most "normal" charsets. 11218e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * (For complex converters, e.g., SCSU, UTF-7 and ISO 2022 variants, 11228e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * it uses ucnv_toUnicode() internally.) 11238e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * - Convenient. 11248e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 11258e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Limitations compared to ucnv_toUnicode(): 11268e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * - Always assumes flush=TRUE. 11278e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * This makes ucnv_getNextUChar() unsuitable for "streaming" conversion, 11288e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * that is, for where the input is supplied in multiple buffers, 11298e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * because ucnv_getNextUChar() will assume the end of the input at the end 11308e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * of the first buffer. 11318e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * - Does not provide offset output. 11328e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 11338e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * It is possible to "mix" ucnv_getNextUChar() and ucnv_toUnicode() because 11348e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * ucnv_getNextUChar() uses the current state of the converter 11358e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * (unlike ucnv_toUChars() which always resets first). 11368e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * However, if ucnv_getNextUChar() is called after ucnv_toUnicode() 11378e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * stopped in the middle of a character sequence (with flush=FALSE), 11388e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * then ucnv_getNextUChar() will always use the slower ucnv_toUnicode() 11398e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * internally until the next character boundary. 11408e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * (This is new in ICU 2.6. In earlier releases, ucnv_getNextUChar() had to 11418e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * start at a character boundary.) 11428e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 11438e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Instead of using ucnv_getNextUChar(), it is recommended 11448e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * to convert using ucnv_toUnicode() or ucnv_toUChars() 11458e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * and then iterate over the text using U16_NEXT() or a UCharIterator (uiter.h) 11468e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * or a C++ CharacterIterator or similar. 11478e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * This allows streaming conversion and offset output, for example. 11488e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 11498e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * <p>Handling of surrogate pairs and supplementary-plane code points:<br> 11508e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * There are two different kinds of codepages that provide mappings for surrogate characters: 11518e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * <ul> 11528e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * <li>Codepages like UTF-8, UTF-32, and GB 18030 provide direct representations for Unicode 11538e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * code points U+10000-U+10ffff as well as for single surrogates U+d800-U+dfff. 11548e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Each valid sequence will result in exactly one returned code point. 11558e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * If a sequence results in a single surrogate, then that will be returned 11568e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * by itself, even if a neighboring sequence encodes the matching surrogate.</li> 11578e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * <li>Codepages like SCSU and LMBCS (and UTF-16) provide direct representations only for BMP code points 11588e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * including surrogates. Code points in supplementary planes are represented with 11598e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * two sequences, each encoding a surrogate. 11608e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * For these codepages, matching pairs of surrogates will be combined into single 11618e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * code points for returning from this function. 11628e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * (Note that SCSU is actually a mix of these codepage types.)</li> 11638e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * </ul></p> 11648e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 11658e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param converter an open UConverter 11668e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param source the address of a pointer to the codepage buffer, will be 11678e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * updated to point after the bytes consumed in the conversion call. 11688e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param sourceLimit points to the end of the input buffer 11698e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param err fills in error status (see ucnv_toUnicode) 11708e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * <code>U_INDEX_OUTOFBOUNDS_ERROR</code> will be set if the input 11718e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * is empty or does not convert to any output (e.g.: pure state-change 11728e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * codes SI/SO, escape sequences for ISO 2022, 11738e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * or if the callback did not output anything, ...). 11748e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * This function will not set a <code>U_BUFFER_OVERFLOW_ERROR</code> because 11758e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * the "buffer" is the return code. However, there might be subsequent output 11768e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * stored in the converter object 11778e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * that will be returned in following calls to this function. 11788e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @return a UChar32 resulting from the partial conversion of source 11798e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_toUnicode 11808e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_toUChars 11818e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_convert 11828e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @stable ICU 2.0 11838e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project */ 11848e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source ProjectU_STABLE UChar32 U_EXPORT2 11858e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Projectucnv_getNextUChar(UConverter * converter, 11868e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project const char **source, 11878e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project const char * sourceLimit, 11888e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UErrorCode * err); 11898e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 11908e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project/** 11918e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Convert from one external charset to another using two existing UConverters. 11928e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Internally, two conversions - ucnv_toUnicode() and ucnv_fromUnicode() - 11938e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * are used, "pivoting" through 16-bit Unicode. 11948e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 11958e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * There is a similar function, ucnv_convert(), 11968e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * which has the following limitations: 11978e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * - it takes charset names, not converter objects, so that 11988e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * - two converters are opened for each call 11998e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * - only single-string conversion is possible, not streaming operation 12008e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * - it does not provide enough information to find out, 12018e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * in case of failure, whether the toUnicode or 12028e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * the fromUnicode conversion failed 12038e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 12048e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * By contrast, ucnv_convertEx() 12058e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * - takes UConverter parameters instead of charset names 12068e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * - fully exposes the pivot buffer for complete error handling 12078e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 12088e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * ucnv_convertEx() also provides further convenience: 12098e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * - an option to reset the converters at the beginning 12108e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * (if reset==TRUE, see parameters; 12118e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * also sets *pivotTarget=*pivotSource=pivotStart) 12128e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * - allow NUL-terminated input 12138e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * (only a single NUL byte, will not work for charsets with multi-byte NULs) 12148e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * (if sourceLimit==NULL, see parameters) 12158e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * - terminate with a NUL on output 12168e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * (only a single NUL byte, not useful for charsets with multi-byte NULs), 12178e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * or set U_STRING_NOT_TERMINATED_WARNING if the output exactly fills 12188e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * the target buffer 12198e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * - the pivot buffer can be provided internally; 12208e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * in this case, the caller will not be able to get details about where an 12218e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * error occurred 12228e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * (if pivotStart==NULL, see below) 12238e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 12248e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * The function returns when one of the following is true: 12258e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * - the entire source text has been converted successfully to the target buffer 12268e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * - a target buffer overflow occurred (U_BUFFER_OVERFLOW_ERROR) 12278e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * - a conversion error occurred 12288e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * (other U_FAILURE(), see description of pErrorCode) 12298e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 12308e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Limitation compared to the direct use of 12318e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * ucnv_fromUnicode() and ucnv_toUnicode(): 12328e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * ucnv_convertEx() does not provide offset information. 12338e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 12348e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Limitation compared to ucnv_fromUChars() and ucnv_toUChars(): 12358e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * ucnv_convertEx() does not support preflighting directly. 12368e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 12378e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Sample code for converting a single string from 12388e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * one external charset to UTF-8, ignoring the location of errors: 12398e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 12408e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * \code 12418e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * int32_t 12428e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * myToUTF8(UConverter *cnv, 12438e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * const char *s, int32_t length, 12448e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * char *u8, int32_t capacity, 12458e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * UErrorCode *pErrorCode) { 12468e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * UConverter *utf8Cnv; 12478e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * char *target; 12488e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 12498e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * if(U_FAILURE(*pErrorCode)) { 12508e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * return 0; 12518e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * } 12528e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 12538e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * utf8Cnv=myGetCachedUTF8Converter(pErrorCode); 12548e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * if(U_FAILURE(*pErrorCode)) { 12558e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * return 0; 12568e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * } 12578e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 12588e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * target=u8; 12598e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * ucnv_convertEx(cnv, utf8Cnv, 12608e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * &target, u8+capacity, 12618e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * &s, length>=0 ? s+length : NULL, 12628e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * NULL, NULL, NULL, NULL, 12638e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * TRUE, TRUE, 12648e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * pErrorCode); 12658e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 12668e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * myReleaseCachedUTF8Converter(utf8Cnv); 12678e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 12688e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * // return the output string length, but without preflighting 12698e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * return (int32_t)(target-u8); 12708e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * } 12718e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * \endcode 12728e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 12738e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param targetCnv Output converter, used to convert from the UTF-16 pivot 12748e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * to the target using ucnv_fromUnicode(). 12758e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param sourceCnv Input converter, used to convert from the source to 12768e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * the UTF-16 pivot using ucnv_toUnicode(). 12778e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param target I/O parameter, same as for ucnv_fromUChars(). 12788e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Input: *target points to the beginning of the target buffer. 12798e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Output: *target points to the first unit after the last char written. 12808e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param targetLimit Pointer to the first unit after the target buffer. 12818e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param source I/O parameter, same as for ucnv_toUChars(). 12828e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Input: *source points to the beginning of the source buffer. 12838e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Output: *source points to the first unit after the last char read. 12848e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param sourceLimit Pointer to the first unit after the source buffer. 12858e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param pivotStart Pointer to the UTF-16 pivot buffer. If pivotStart==NULL, 12868e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * then an internal buffer is used and the other pivot 12878e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * arguments are ignored and can be NULL as well. 12888e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param pivotSource I/O parameter, same as source in ucnv_fromUChars() for 12898e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * conversion from the pivot buffer to the target buffer. 12908e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param pivotTarget I/O parameter, same as target in ucnv_toUChars() for 12918e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * conversion from the source buffer to the pivot buffer. 12928e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * It must be pivotStart<=*pivotSource<=*pivotTarget<=pivotLimit 12938e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * and pivotStart<pivotLimit (unless pivotStart==NULL). 12948e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param pivotLimit Pointer to the first unit after the pivot buffer. 12958e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param reset If TRUE, then ucnv_resetToUnicode(sourceCnv) and 12968e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * ucnv_resetFromUnicode(targetCnv) are called, and the 12978e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * pivot pointers are reset (*pivotTarget=*pivotSource=pivotStart). 12988e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param flush If true, indicates the end of the input. 12998e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Passed directly to ucnv_toUnicode(), and carried over to 13008e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * ucnv_fromUnicode() when the source is empty as well. 13018e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param pErrorCode ICU error code in/out parameter. 13028e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Must fulfill U_SUCCESS before the function call. 13038e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * U_BUFFER_OVERFLOW_ERROR always refers to the target buffer 13048e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * because overflows into the pivot buffer are handled internally. 13058e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Other conversion errors are from the source-to-pivot 13068e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * conversion if *pivotSource==pivotStart, otherwise from 13078e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * the pivot-to-target conversion. 13088e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 13098e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_convert 13108e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_fromAlgorithmic 13118e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_toAlgorithmic 13128e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_fromUnicode 13138e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_toUnicode 13148e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_fromUChars 13158e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_toUChars 13168e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @stable ICU 2.6 13178e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project */ 13188e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source ProjectU_STABLE void U_EXPORT2 13198e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Projectucnv_convertEx(UConverter *targetCnv, UConverter *sourceCnv, 13208e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project char **target, const char *targetLimit, 13218e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project const char **source, const char *sourceLimit, 13228e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UChar *pivotStart, UChar **pivotSource, 13238e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UChar **pivotTarget, const UChar *pivotLimit, 13248e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UBool reset, UBool flush, 13258e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UErrorCode *pErrorCode); 13268e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 13278e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project/** 13288e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Convert from one external charset to another. 13298e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Internally, two converters are opened according to the name arguments, 13308e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * then the text is converted to and from the 16-bit Unicode "pivot" 13318e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * using ucnv_convertEx(), then the converters are closed again. 13328e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 13338e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * This is a convenience function, not an efficient way to convert a lot of text: 13348e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * ucnv_convert() 13358e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * - takes charset names, not converter objects, so that 13368e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * - two converters are opened for each call 13378e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * - only single-string conversion is possible, not streaming operation 13388e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * - does not provide enough information to find out, 13398e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * in case of failure, whether the toUnicode or 13408e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * the fromUnicode conversion failed 13418e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * - allows NUL-terminated input 13428e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * (only a single NUL byte, will not work for charsets with multi-byte NULs) 13438e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * (if sourceLength==-1, see parameters) 13448e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * - terminate with a NUL on output 13458e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * (only a single NUL byte, not useful for charsets with multi-byte NULs), 13468e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * or set U_STRING_NOT_TERMINATED_WARNING if the output exactly fills 13478e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * the target buffer 13488e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * - a pivot buffer is provided internally 13498e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 13508e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * The function returns when one of the following is true: 13518e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * - the entire source text has been converted successfully to the target buffer 13528e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * and either the target buffer is terminated with a single NUL byte 13538e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * or the error code is set to U_STRING_NOT_TERMINATED_WARNING 13548e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * - a target buffer overflow occurred (U_BUFFER_OVERFLOW_ERROR) 13558e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * and the full output string length is returned ("preflighting") 13568e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * - a conversion error occurred 13578e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * (other U_FAILURE(), see description of pErrorCode) 13588e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 13598e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param toConverterName The name of the converter that is used to convert 13608e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * from the UTF-16 pivot buffer to the target. 13618e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param fromConverterName The name of the converter that is used to convert 13628e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * from the source to the UTF-16 pivot buffer. 13638e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param target Pointer to the output buffer. 13648e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param targetCapacity Capacity of the target, in bytes. 13658e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param source Pointer to the input buffer. 13668e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param sourceLength Length of the input text, in bytes, or -1 for NUL-terminated input. 13678e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param pErrorCode ICU error code in/out parameter. 13688e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Must fulfill U_SUCCESS before the function call. 13698e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @return Length of the complete output text in bytes, even if it exceeds the targetCapacity 13708e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * and a U_BUFFER_OVERFLOW_ERROR is set. 13718e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 13728e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_convertEx 13738e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_fromAlgorithmic 13748e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_toAlgorithmic 13758e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_fromUnicode 13768e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_toUnicode 13778e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_fromUChars 13788e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_toUChars 13798e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_getNextUChar 13808e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @stable ICU 2.0 13818e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project */ 13828e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source ProjectU_STABLE int32_t U_EXPORT2 13838e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Projectucnv_convert(const char *toConverterName, 13848e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project const char *fromConverterName, 13858e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project char *target, 13868e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project int32_t targetCapacity, 13878e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project const char *source, 13888e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project int32_t sourceLength, 13898e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UErrorCode *pErrorCode); 13908e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 13918e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project/** 13928e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Convert from one external charset to another. 13938e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Internally, the text is converted to and from the 16-bit Unicode "pivot" 13948e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * using ucnv_convertEx(). ucnv_toAlgorithmic() works exactly like ucnv_convert() 13958e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * except that the two converters need not be looked up and opened completely. 13968e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 13978e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * The source-to-pivot conversion uses the cnv converter parameter. 13988e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * The pivot-to-target conversion uses a purely algorithmic converter 13998e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * according to the specified type, e.g., UCNV_UTF8 for a UTF-8 converter. 14008e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 14018e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Internally, the algorithmic converter is opened and closed for each 14028e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * function call, which is more efficient than using the public ucnv_open() 14038e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * but somewhat less efficient than only resetting an existing converter 14048e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * and using ucnv_convertEx(). 14058e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 14068e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * This function is more convenient than ucnv_convertEx() for single-string 14078e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * conversions, especially when "preflighting" is desired (returning the length 14088e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * of the complete output even if it does not fit into the target buffer; 14098e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * see the User Guide Strings chapter). See ucnv_convert() for details. 14108e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 14118e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param algorithmicType UConverterType constant identifying the desired target 14128e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * charset as a purely algorithmic converter. 14138e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Those are converters for Unicode charsets like 14148e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * UTF-8, BOCU-1, SCSU, UTF-7, IMAP-mailbox-name, etc., 14158e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * as well as US-ASCII and ISO-8859-1. 14168e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param cnv The converter that is used to convert 14178e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * from the source to the UTF-16 pivot buffer. 14188e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param target Pointer to the output buffer. 14198e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param targetCapacity Capacity of the target, in bytes. 14208e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param source Pointer to the input buffer. 14218e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param sourceLength Length of the input text, in bytes 14228e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param pErrorCode ICU error code in/out parameter. 14238e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Must fulfill U_SUCCESS before the function call. 14248e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @return Length of the complete output text in bytes, even if it exceeds the targetCapacity 14258e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * and a U_BUFFER_OVERFLOW_ERROR is set. 14268e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 14278e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_fromAlgorithmic 14288e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_convert 14298e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_convertEx 14308e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_fromUnicode 14318e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_toUnicode 14328e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_fromUChars 14338e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_toUChars 14348e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @stable ICU 2.6 14358e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project */ 14368e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source ProjectU_STABLE int32_t U_EXPORT2 14378e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Projectucnv_toAlgorithmic(UConverterType algorithmicType, 14388e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UConverter *cnv, 14398e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project char *target, int32_t targetCapacity, 14408e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project const char *source, int32_t sourceLength, 14418e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UErrorCode *pErrorCode); 14428e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 14438e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project/** 14448e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Convert from one external charset to another. 14458e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Internally, the text is converted to and from the 16-bit Unicode "pivot" 14468e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * using ucnv_convertEx(). ucnv_fromAlgorithmic() works exactly like ucnv_convert() 14478e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * except that the two converters need not be looked up and opened completely. 14488e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 14498e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * The source-to-pivot conversion uses a purely algorithmic converter 14508e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * according to the specified type, e.g., UCNV_UTF8 for a UTF-8 converter. 14518e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * The pivot-to-target conversion uses the cnv converter parameter. 14528e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 14538e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Internally, the algorithmic converter is opened and closed for each 14548e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * function call, which is more efficient than using the public ucnv_open() 14558e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * but somewhat less efficient than only resetting an existing converter 14568e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * and using ucnv_convertEx(). 14578e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 14588e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * This function is more convenient than ucnv_convertEx() for single-string 14598e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * conversions, especially when "preflighting" is desired (returning the length 14608e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * of the complete output even if it does not fit into the target buffer; 14618e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * see the User Guide Strings chapter). See ucnv_convert() for details. 14628e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 14638e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param cnv The converter that is used to convert 14648e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * from the UTF-16 pivot buffer to the target. 14658e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param algorithmicType UConverterType constant identifying the desired source 14668e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * charset as a purely algorithmic converter. 14678e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Those are converters for Unicode charsets like 14688e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * UTF-8, BOCU-1, SCSU, UTF-7, IMAP-mailbox-name, etc., 14698e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * as well as US-ASCII and ISO-8859-1. 14708e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param target Pointer to the output buffer. 14718e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param targetCapacity Capacity of the target, in bytes. 14728e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param source Pointer to the input buffer. 14738e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param sourceLength Length of the input text, in bytes 14748e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param pErrorCode ICU error code in/out parameter. 14758e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Must fulfill U_SUCCESS before the function call. 14768e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @return Length of the complete output text in bytes, even if it exceeds the targetCapacity 14778e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * and a U_BUFFER_OVERFLOW_ERROR is set. 14788e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 14798e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_fromAlgorithmic 14808e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_convert 14818e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_convertEx 14828e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_fromUnicode 14838e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_toUnicode 14848e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_fromUChars 14858e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_toUChars 14868e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @stable ICU 2.6 14878e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project */ 14888e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source ProjectU_STABLE int32_t U_EXPORT2 14898e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Projectucnv_fromAlgorithmic(UConverter *cnv, 14908e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UConverterType algorithmicType, 14918e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project char *target, int32_t targetCapacity, 14928e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project const char *source, int32_t sourceLength, 14938e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UErrorCode *pErrorCode); 14948e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 14958e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project/** 14968e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Frees up memory occupied by unused, cached converter shared data. 14978e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 14988e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @return the number of cached converters successfully deleted 14998e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_close 15008e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @stable ICU 2.0 15018e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project */ 15028e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source ProjectU_STABLE int32_t U_EXPORT2 15038e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Projectucnv_flushCache(void); 15048e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 15058e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project/** 15068e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Returns the number of available converters, as per the alias file. 15078e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 15088e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @return the number of available converters 15098e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_getAvailableName 15108e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @stable ICU 2.0 15118e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project */ 15128e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source ProjectU_STABLE int32_t U_EXPORT2 15138e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Projectucnv_countAvailable(void); 15148e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 15158e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project/** 15168e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Gets the canonical converter name of the specified converter from a list of 15178e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * all available converters contaied in the alias file. All converters 15188e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * in this list can be opened. 15198e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 15208e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param n the index to a converter available on the system (in the range <TT>[0..ucnv_countAvaiable()]</TT>) 15218e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @return a pointer a string (library owned), or <TT>NULL</TT> if the index is out of bounds. 15228e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_countAvailable 15238e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @stable ICU 2.0 15248e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project */ 15258e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source ProjectU_STABLE const char* U_EXPORT2 15268e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Projectucnv_getAvailableName(int32_t n); 15278e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 15288e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project/** 15298e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Returns a UEnumeration to enumerate all of the canonical converter 15308e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * names, as per the alias file, regardless of the ability to open each 15318e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * converter. 15328e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 15338e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @return A UEnumeration object for getting all the recognized canonical 15348e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * converter names. 15358e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_getAvailableName 15368e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see uenum_close 15378e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see uenum_next 15388e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @stable ICU 2.4 15398e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project */ 15408e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source ProjectU_STABLE UEnumeration * U_EXPORT2 15418e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Projectucnv_openAllNames(UErrorCode *pErrorCode); 15428e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 15438e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project/** 15448e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Gives the number of aliases for a given converter or alias name. 15458e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * If the alias is ambiguous, then the preferred converter is used 15468e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * and the status is set to U_AMBIGUOUS_ALIAS_WARNING. 15478e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * This method only enumerates the listed entries in the alias file. 15488e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param alias alias name 15498e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param pErrorCode error status 15508e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @return number of names on alias list for given alias 15518e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @stable ICU 2.0 15528e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project */ 15538e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source ProjectU_STABLE uint16_t U_EXPORT2 15548e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Projectucnv_countAliases(const char *alias, UErrorCode *pErrorCode); 15558e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 15568e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project/** 15578e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Gives the name of the alias at given index of alias list. 15588e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * This method only enumerates the listed entries in the alias file. 15598e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * If the alias is ambiguous, then the preferred converter is used 15608e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * and the status is set to U_AMBIGUOUS_ALIAS_WARNING. 15618e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param alias alias name 15628e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param n index in alias list 15638e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param pErrorCode result of operation 15648e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @return returns the name of the alias at given index 15658e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_countAliases 15668e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @stable ICU 2.0 15678e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project */ 15688e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source ProjectU_STABLE const char * U_EXPORT2 15698e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Projectucnv_getAlias(const char *alias, uint16_t n, UErrorCode *pErrorCode); 15708e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 15718e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project/** 15728e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Fill-up the list of alias names for the given alias. 15738e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * This method only enumerates the listed entries in the alias file. 15748e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * If the alias is ambiguous, then the preferred converter is used 15758e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * and the status is set to U_AMBIGUOUS_ALIAS_WARNING. 15768e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param alias alias name 15778e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param aliases fill-in list, aliases is a pointer to an array of 15788e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * <code>ucnv_countAliases()</code> string-pointers 15798e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * (<code>const char *</code>) that will be filled in. 15808e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * The strings themselves are owned by the library. 15818e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param pErrorCode result of operation 15828e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @stable ICU 2.0 15838e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project */ 15848e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source ProjectU_STABLE void U_EXPORT2 15858e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Projectucnv_getAliases(const char *alias, const char **aliases, UErrorCode *pErrorCode); 15868e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 15878e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project/** 15888e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Return a new UEnumeration object for enumerating all the 15898e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * alias names for a given converter that are recognized by a standard. 15908e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * This method only enumerates the listed entries in the alias file. 15918e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * The convrtrs.txt file can be modified to change the results of 15928e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * this function. 15938e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * The first result in this list is the same result given by 15948e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * <code>ucnv_getStandardName</code>, which is the default alias for 15958e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * the specified standard name. The returned object must be closed with 15968e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * <code>uenum_close</code> when you are done with the object. 15978e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 15988e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param convName original converter name 15998e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param standard name of the standard governing the names; MIME and IANA 16008e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * are such standards 16018e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param pErrorCode The error code 16028e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @return A UEnumeration object for getting all aliases that are recognized 16038e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * by a standard. If any of the parameters are invalid, NULL 16048e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * is returned. 16058e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_getStandardName 16068e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see uenum_close 16078e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see uenum_next 16088e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @stable ICU 2.2 16098e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project */ 16108e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source ProjectU_STABLE UEnumeration * U_EXPORT2 16118e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Projectucnv_openStandardNames(const char *convName, 16128e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project const char *standard, 16138e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UErrorCode *pErrorCode); 16148e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 16158e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project/** 16168e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Gives the number of standards associated to converter names. 16178e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @return number of standards 16188e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @stable ICU 2.0 16198e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project */ 16208e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source ProjectU_STABLE uint16_t U_EXPORT2 16218e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Projectucnv_countStandards(void); 16228e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 16238e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project/** 16248e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Gives the name of the standard at given index of standard list. 16258e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param n index in standard list 16268e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param pErrorCode result of operation 16278e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @return returns the name of the standard at given index. Owned by the library. 16288e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @stable ICU 2.0 16298e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project */ 16308e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source ProjectU_STABLE const char * U_EXPORT2 16318e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Projectucnv_getStandard(uint16_t n, UErrorCode *pErrorCode); 16328e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 16338e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project/** 16348e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Returns a standard name for a given converter name. 16358e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * <p> 16368e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Example alias table:<br> 16378e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * conv alias1 { STANDARD1 } alias2 { STANDARD1* } 16388e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * <p> 16398e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Result of ucnv_getStandardName("conv", "STANDARD1") from example 16408e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * alias table:<br> 16418e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * <b>"alias2"</b> 16428e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 16438e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param name original converter name 16448e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param standard name of the standard governing the names; MIME and IANA 16458e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * are such standards 16468e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param pErrorCode result of operation 16478e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @return returns the standard converter name; 16488e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * if a standard converter name cannot be determined, 16498e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * then <code>NULL</code> is returned. Owned by the library. 16508e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @stable ICU 2.0 16518e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project */ 16528e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source ProjectU_STABLE const char * U_EXPORT2 16538e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Projectucnv_getStandardName(const char *name, const char *standard, UErrorCode *pErrorCode); 16548e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 16558e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project/** 16568e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * This function will return the internal canonical converter name of the 16578e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * tagged alias. This is the opposite of ucnv_openStandardNames, which 16588e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * returns the tagged alias given the canonical name. 16598e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * <p> 16608e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Example alias table:<br> 16618e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * conv alias1 { STANDARD1 } alias2 { STANDARD1* } 16628e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * <p> 16638e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Result of ucnv_getStandardName("alias1", "STANDARD1") from example 16648e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * alias table:<br> 16658e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * <b>"conv"</b> 16668e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 16678e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @return returns the canonical converter name; 16688e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * if a standard or alias name cannot be determined, 16698e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * then <code>NULL</code> is returned. The returned string is 16708e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * owned by the library. 16718e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_getStandardName 16728e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @stable ICU 2.4 16738e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project */ 16748e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source ProjectU_STABLE const char * U_EXPORT2 16758e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Projectucnv_getCanonicalName(const char *alias, const char *standard, UErrorCode *pErrorCode); 16768e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 16778e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project/** 16788e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * returns the current default converter name. 16798e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 16808e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @return returns the current default converter name; 16818e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * if a default converter name cannot be determined, 16828e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * then <code>NULL</code> is returned. 16838e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Storage owned by the library 16848e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_setDefaultName 16858e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @stable ICU 2.0 16868e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project */ 16878e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source ProjectU_STABLE const char * U_EXPORT2 16888e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Projectucnv_getDefaultName(void); 16898e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 16908e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project/** 16918e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * sets the current default converter name. Caller must own the storage for 'name' 16928e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * and preserve it indefinitely. 16938e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param name the converter name to be the default (must exist). 16948e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_getDefaultName 16958e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @system SYSTEM API 16968e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @stable ICU 2.0 16978e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project */ 16988e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source ProjectU_STABLE void U_EXPORT2 16998e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Projectucnv_setDefaultName(const char *name); 17008e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 17018e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project/** 17028e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Fixes the backslash character mismapping. For example, in SJIS, the backslash 17038e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * character in the ASCII portion is also used to represent the yen currency sign. 17048e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * When mapping from Unicode character 0x005C, it's unclear whether to map the 17058e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * character back to yen or backslash in SJIS. This function will take the input 17068e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * buffer and replace all the yen sign characters with backslash. This is necessary 17078e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * when the user tries to open a file with the input buffer on Windows. 17088e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * This function will test the converter to see whether such mapping is 17098e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * required. You can sometimes avoid using this function by using the correct version 17108e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * of Shift-JIS. 17118e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 17128e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param cnv The converter representing the target codepage. 17138e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param source the input buffer to be fixed 17148e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param sourceLen the length of the input buffer 17158e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @see ucnv_isAmbiguous 17168e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @stable ICU 2.0 17178e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project */ 17188e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source ProjectU_STABLE void U_EXPORT2 17198e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Projectucnv_fixFileSeparator(const UConverter *cnv, UChar *source, int32_t sourceLen); 17208e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 17218e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project/** 17228e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Determines if the converter contains ambiguous mappings of the same 17238e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * character or not. 17248e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param cnv the converter to be tested 17258e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @return TRUE if the converter contains ambiguous mapping of the same 17268e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * character, FALSE otherwise. 17278e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @stable ICU 2.0 17288e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project */ 17298e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source ProjectU_STABLE UBool U_EXPORT2 17308e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Projectucnv_isAmbiguous(const UConverter *cnv); 17318e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 17328e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project/** 17338e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Sets the converter to use fallback mapping or not. 17348e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param cnv The converter to set the fallback mapping usage on. 17358e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param usesFallback TRUE if the user wants the converter to take advantage of the fallback 17368e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * mapping, FALSE otherwise. 17378e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @stable ICU 2.0 17388e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project */ 17398e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source ProjectU_STABLE void U_EXPORT2 17408e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Projectucnv_setFallback(UConverter *cnv, UBool usesFallback); 17418e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 17428e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project/** 17438e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Determines if the converter uses fallback mappings or not. 17448e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param cnv The converter to be tested 17458e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @return TRUE if the converter uses fallback, FALSE otherwise. 17468e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @stable ICU 2.0 17478e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project */ 17488e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source ProjectU_STABLE UBool U_EXPORT2 17498e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Projectucnv_usesFallback(const UConverter *cnv); 17508e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 17518e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project/** 17528e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Detects Unicode signature byte sequences at the start of the byte stream 17538e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * and returns the charset name of the indicated Unicode charset. 17548e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * NULL is returned when no Unicode signature is recognized. 17558e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * The number of bytes in the signature is output as well. 17568e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 17578e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * The caller can ucnv_open() a converter using the charset name. 17588e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * The first code unit (UChar) from the start of the stream will be U+FEFF 17598e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * (the Unicode BOM/signature character) and can usually be ignored. 17608e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 17618e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * For most Unicode charsets it is also possible to ignore the indicated 17628e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * number of initial stream bytes and start converting after them. 17638e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * However, there are stateful Unicode charsets (UTF-7 and BOCU-1) for which 17648e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * this will not work. Therefore, it is best to ignore the first output UChar 17658e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * instead of the input signature bytes. 17668e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * <p> 17678e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Usage: 17688e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @code 17698e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * UErrorCode err = U_ZERO_ERROR; 17708e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * char input[] = { '\xEF','\xBB', '\xBF','\x41','\x42','\x43' }; 17718e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * int32_t signatureLength = 0; 17728e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * char *encoding = ucnv_detectUnicodeSignatures(input,sizeof(input),&signatureLength,&err); 17738e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * UConverter *conv = NULL; 17748e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * UChar output[100]; 17758e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * UChar *target = output, *out; 17768e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * char *source = input; 17778e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * if(encoding!=NULL && U_SUCCESS(err)){ 17788e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * // should signature be discarded ? 17798e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * conv = ucnv_open(encoding, &err); 17808e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * // do the conversion 17818e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * ucnv_toUnicode(conv, 17828e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * target, output + sizeof(output)/U_SIZEOF_UCHAR, 17838e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * source, input + sizeof(input), 17848e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * NULL, TRUE, &err); 17858e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * out = output; 17868e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * if (discardSignature){ 17878e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * ++out; // ignore initial U+FEFF 17888e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * } 17898e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * while(out != target) { 17908e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * printf("%04x ", *out++); 17918e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * } 17928e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * puts(""); 17938e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * } 17948e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 17958e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @endcode 17968e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * 17978e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param source The source string in which the signature should be detected. 17988e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param sourceLength Length of the input string, or -1 if terminated with a NUL byte. 17998e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param signatureLength A pointer to int32_t to receive the number of bytes that make up the signature 18008e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * of the detected UTF. 0 if not detected. 18018e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Can be a NULL pointer. 18028e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @param pErrorCode A pointer to receive information about any errors that may occur during detection. 18038e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * Must be a valid pointer to an error code value, which must not indicate a failure 18048e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * before the function call. 18058e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @return The name of the encoding detected. NULL if encoding is not detected. 18068e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project * @stable ICU 2.4 18078e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project */ 18088e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source ProjectU_STABLE const char* U_EXPORT2 18098e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Projectucnv_detectUnicodeSignature(const char* source, 18108e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project int32_t sourceLength, 18118e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project int32_t *signatureLength, 18128e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project UErrorCode *pErrorCode); 18138e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 18148e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project#endif 18158e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project 18168e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project#endif 18178e35f3cfc7fba1d1c829dc557ebad6409cbe16a2The Android Open Source Project/*_UCNV*/ 1818