Update ICU to 54.1 step 1

source/common/unicode/ucnv.h

 /*
 **********************************************************************
-*   Copyright (C) 1999-2013, International Business Machines
+*   Copyright (C) 1999-2014, International Business Machines
 *   Corporation and others.  All Rights Reserved.
 **********************************************************************
  *  ucnv.h:
  *  External APIs for the ICU's codeset conversion library
  *  Bertrand A. Damiba
  *
  * Modification History:
  *
  *   Date        Name        Description
  *   04/04/99    helena      Fixed internal header inclusion.
  *   05/11/00    helena      Added setFallback and usesFallback APIs.
  *   06/29/2000  helena      Major rewrite of the callback APIs.
  *   12/07/2000  srl         Update of documentation
  */
 
 /**
  * \file
- * \brief C API: Character conversion 
+ * \brief C API: Character conversion
  *
  * <h2>Character Conversion C API</h2>
  *
  * <p>This API is used to convert codepage or character encoded data to and
  * from UTF-16. You can open a converter with {@link ucnv_open() }. With that
  * converter, you can get its properties, set options, convert your data and
  * close the converter.</p>
  *
  * <p>Since many software programs recogize different converter names for
  * different types of converters, there are other functions in this API to
  * iterate over the converter aliases. The functions {@link ucnv_getAvailableName() },
  * {@link ucnv_getAlias() } and {@link ucnv_getStandardName() } are some of the
  * more frequently used alias functions to get this information.</p>
  *
  * <p>When a converter encounters an illegal, irregular, invalid or unmappable character
  * its default behavior is to use a substitution character to replace the
  * bad byte sequence. This behavior can be changed by using {@link ucnv_setFromUCallBack() }
  * or {@link ucnv_setToUCallBack() } on the converter. The header ucnv_err.h defines
  * many other callback actions that can be used instead of a character substitution.</p>
  *
- * <p>More information about this API can be found in our 
+ * <p>More information about this API can be found in our
  * <a href="http://icu-project.org/userguide/conversion.html">User's
  * Guide</a>.</p>
  */
 
 #ifndef UCNV_H
 #define UCNV_H
 
 #include "unicode/ucnv_err.h"
 #include "unicode/uenum.h"
 #include "unicode/localpointer.h"
@@ skipping 56 matching lines @@
     /** @stable ICU 2.0 */
     UCNV_UTF32_LittleEndian = 8,
     /** @stable ICU 2.0 */
     UCNV_EBCDIC_STATEFUL = 9,
     /** @stable ICU 2.0 */
     UCNV_ISO_2022 = 10,
 
     /** @stable ICU 2.0 */
     UCNV_LMBCS_1 = 11,
     /** @stable ICU 2.0 */
-    UCNV_LMBCS_2, 
+    UCNV_LMBCS_2,
     /** @stable ICU 2.0 */
     UCNV_LMBCS_3,
     /** @stable ICU 2.0 */
     UCNV_LMBCS_4,
     /** @stable ICU 2.0 */
     UCNV_LMBCS_5,
     /** @stable ICU 2.0 */
     UCNV_LMBCS_6,
     /** @stable ICU 2.0 */
     UCNV_LMBCS_8,
@@ skipping 100 matching lines @@
 U_CDECL_END
 
 /**
  * Character that separates converter names from options and options from each other.
  * @see ucnv_open
  * @stable ICU 2.0
  */
 #define UCNV_OPTION_SEP_CHAR ','
 
 /**
- * String version of UCNV_OPTION_SEP_CHAR. 
+ * String version of UCNV_OPTION_SEP_CHAR.
  * @see ucnv_open
  * @stable ICU 2.0
  */
 #define UCNV_OPTION_SEP_STRING ","
 
 /**
  * Character that separates a converter option from its value.
  * @see ucnv_open
  * @stable ICU 2.0
  */
 #define UCNV_VALUE_SEP_CHAR '='
 
 /**
- * String version of UCNV_VALUE_SEP_CHAR. 
+ * String version of UCNV_VALUE_SEP_CHAR.
  * @see ucnv_open
  * @stable ICU 2.0
  */
 #define UCNV_VALUE_SEP_STRING "="
 
 /**
  * Converter option for specifying a locale.
  * For example, ucnv_open("SCSU,locale=ja", &errorCode);
  * See convrtrs.txt.
  *
  * @see ucnv_open
  * @stable ICU 2.0
  */
 #define UCNV_LOCALE_OPTION_STRING ",locale="
 
 /**
  * Converter option for specifying a version selector (0..9) for some converters.
- * For example, 
+ * For example,
  * \code
  *   ucnv_open("UTF-7,version=1", &errorCode);
  * \endcode
  * See convrtrs.txt.
  *
  * @see ucnv_open
  * @stable ICU 2.4
  */
 #define UCNV_VERSION_OPTION_STRING ",version="
 
@@ skipping 71 matching lines @@
  * @return the created Unicode converter object, or <TT>NULL</TT> if an error occured
  * @see ucnv_openU
  * @see ucnv_openCCSID
  * @see ucnv_getAvailableName
  * @see ucnv_getAlias
  * @see ucnv_getDefaultName
  * @see ucnv_close
  * @see ucnv_compareNames
  * @stable ICU 2.0
  */
-U_STABLE UConverter* U_EXPORT2 
+U_STABLE UConverter* U_EXPORT2
 ucnv_open(const char *converterName, UErrorCode *err);
 
 
 /**
- * Creates a Unicode converter with the names specified as unicode string. 
+ * Creates a Unicode converter with the names specified as unicode string.
  * The name should be limited to the ASCII-7 alphanumerics range.
  * The actual name will be resolved with the alias file
  * using a case-insensitive string comparison that ignores
  * leading zeroes and all non-alphanumeric characters.
  * E.g., the names "UTF8", "utf-8", "u*T@f08" and "Utf 8" are all equivalent.
  * (See also ucnv_compareNames().)
- * If <TT>NULL</TT> is passed for the converter name, it will create 
+ * If <TT>NULL</TT> is passed for the converter name, it will create
  * one with the ucnv_getDefaultName() return value.
  * If the alias is ambiguous, then the preferred converter is used
  * and the status is set to U_AMBIGUOUS_ALIAS_WARNING.
  *
  * <p>See ucnv_open for the complete details</p>
- * @param name Name of the UConverter table in a zero terminated 
+ * @param name Name of the UConverter table in a zero terminated
  *        Unicode string
- * @param err outgoing error status <TT>U_MEMORY_ALLOCATION_ERROR, 
+ * @param err outgoing error status <TT>U_MEMORY_ALLOCATION_ERROR,
  *        U_FILE_ACCESS_ERROR</TT>
- * @return the created Unicode converter object, or <TT>NULL</TT> if an 
+ * @return the created Unicode converter object, or <TT>NULL</TT> if an
  *        error occured
  * @see ucnv_open
  * @see ucnv_openCCSID
  * @see ucnv_close
  * @see ucnv_compareNames
  * @stable ICU 2.0
  */
-U_STABLE UConverter* U_EXPORT2 
+U_STABLE UConverter* U_EXPORT2
 ucnv_openU(const UChar *name,
            UErrorCode *err);
 
 /**
  * Creates a UConverter object from a CCSID number and platform pair.
  * Note that the usefulness of this function is limited to platforms with numeric
  * encoding IDs. Only IBM and Microsoft platforms use numeric (16-bit) identifiers for
  * encodings.
  *
  * In addition, IBM CCSIDs and Unicode conversion tables are not 1:1 related.
@@ skipping 54 matching lines @@
  * @see UConverterPlatform
  * @stable ICU 2.0
  */
 U_STABLE UConverter* U_EXPORT2
 ucnv_openCCSID(int32_t codepage,
                UConverterPlatform platform,
                UErrorCode * err);
 
 /**
  * <p>Creates a UConverter object specified from a packageName and a converterName.</p>
- * 
+ *
  * <p>The packageName and converterName must point to an ICU udata object, as defined by
  *   <code> udata_open( packageName, "cnv", converterName, err) </code> or equivalent.
  * Typically, packageName will refer to a (.dat) file, or to a package registered with
  * udata_setAppData(). Using a full file or directory pathname for packageName is deprecated.</p>
- * 
+ *
  * <p>The name will NOT be looked up in the alias mechanism, nor will the converter be
  * stored in the converter cache or the alias table. The only way to open further converters
- * is call this function multiple times, or use the ucnv_safeClone() function to clone a 
+ * is call this function multiple times, or use the ucnv_safeClone() function to clone a
  * 'master' converter.</p>
  *
  * <p>A future version of ICU may add alias table lookups and/or caching
  * to this function.</p>
- * 
+ *
  * <p>Example Use:
  *      <code>cnv = ucnv_openPackage("myapp", "myconverter", &err);</code>
  * </p>
  *
  * @param packageName name of the package (equivalent to 'path' in udata_open() call)
  * @param converterName name of the data item to be used, without suffix.
  * @param err outgoing error status <TT>U_MEMORY_ALLOCATION_ERROR, U_FILE_ACCESS_ERROR</TT>
  * @return the created Unicode converter object, or <TT>NULL</TT> if an error occured
  * @see udata_open
  * @see ucnv_open
  * @see ucnv_safeClone
  * @see ucnv_close
  * @stable ICU 2.2
  */
-U_STABLE UConverter* U_EXPORT2 
+U_STABLE UConverter* U_EXPORT2
 ucnv_openPackage(const char *packageName, const char *converterName, UErrorCode *err);
 
 /**
  * Thread safe converter cloning operation.
  * For most efficient operation, pass in a stackBuffer (and a *pBufferSize)
  * with at least U_CNV_SAFECLONE_BUFFERSIZE bytes of space.
  * If the buffer size is sufficient, then the clone will use the stack buffer;
  * otherwise, it will be allocated, and *pBufferSize will indicate
  * the actual size. (This should not occur with U_CNV_SAFECLONE_BUFFERSIZE.)
  *
  * You must ucnv_close() the clone in any case.
  *
  * If *pBufferSize==0, (regardless of whether stackBuffer==NULL or not)
  * then *pBufferSize will be changed to a sufficient size
  * for cloning this converter,
  * without actually cloning the converter ("pure pre-flighting").
  *
  * If *pBufferSize is greater than zero but not large enough for a stack-based
  * clone, then the converter is cloned using newly allocated memory
  * and *pBufferSize is changed to the necessary size.
  *
  * If the converter clone fits into the stack buffer but the stack buffer is not
  * sufficiently aligned for the clone, then the clone will use an
  * adjusted pointer and use an accordingly smaller buffer size.
  *
  * @param cnv converter to be cloned
  * @param stackBuffer <em>Deprecated functionality as of ICU 52, use NULL.</em><br>
- *  user allocated space for the new clone. If NULL new memory will be allocated. 
+ *  user allocated space for the new clone. If NULL new memory will be allocated.
  *  If buffer is not large enough, new memory will be allocated.
  *  Clients can use the U_CNV_SAFECLONE_BUFFERSIZE. This will probably be enough to avoid memory allocations.
  * @param pBufferSize <em>Deprecated functionality as of ICU 52, use NULL or 1.</em><br>
  *  pointer to size of allocated space.
  * @param status to indicate whether the operation went on smoothly or there were errors
  *  An informational status value, U_SAFECLONE_ALLOCATED_WARNING,
  *  is used if any allocations were necessary.
  *  However, it is better to check if *pBufferSize grew for checking for
  *  allocations because warning codes can be overridden by subsequent
  *  function calls.
  * @return pointer to the new clone
  * @stable ICU 2.0
  */
-U_STABLE UConverter * U_EXPORT2 
-ucnv_safeClone(const UConverter *cnv, 
+U_STABLE UConverter * U_EXPORT2
+ucnv_safeClone(const UConverter *cnv,
                void             *stackBuffer,
-               int32_t          *pBufferSize, 
+               int32_t          *pBufferSize,
                UErrorCode       *status);
 
 #ifndef U_HIDE_DEPRECATED_API
 
 /**
  * \def U_CNV_SAFECLONE_BUFFERSIZE
  * Definition of a buffer size that is designed to be large enough for
  * converters to be cloned with ucnv_safeClone().
  * @deprecated ICU 52. Do not rely on ucnv_safeClone() cloning into any provided buffer.
  */
@@ skipping 35 matching lines @@
 #endif
 
 /**
  * Fills in the output parameter, subChars, with the substitution characters
  * as multiple bytes.
  * If ucnv_setSubstString() set a Unicode string because the converter is
  * stateful, then subChars will be an empty string.
  *
  * @param converter the Unicode converter
  * @param subChars the subsitution characters
- * @param len on input the capacity of subChars, on output the number 
+ * @param len on input the capacity of subChars, on output the number
  * of bytes copied to it
  * @param  err the outgoing error status code.
  * If the substitution character array is too small, an
  * <TT>U_INDEX_OUTOFBOUNDS_ERROR</TT> will be returned.
  * @see ucnv_setSubstString
  * @see ucnv_setSubstChars
  * @stable ICU 2.0
  */
 U_STABLE void U_EXPORT2
 ucnv_getSubstChars(const UConverter *converter,
@@ skipping 77 matching lines @@
                      char *errBytes,
                      int8_t *len,
                      UErrorCode *err);
 
 /**
  * Fills in the output parameter, errChars, with the error characters from the
  * last failing conversion.
  *
  * @param converter the Unicode converter
  * @param errUChars the UChars which were in error
- * @param len on input the capacity of errUChars, on output the number of 
+ * @param len on input the capacity of errUChars, on output the number of
  *  UChars which were copied to it
  * @param err the error status code.
  * If the substitution character array is too small, an
  * <TT>U_INDEX_OUTOFBOUNDS_ERROR</TT> will be returned.
  * @stable ICU 2.0
  */
 U_STABLE void U_EXPORT2
 ucnv_getInvalidUChars(const UConverter *converter,
                       UChar *errUChars,
                       int8_t *len,
@@ skipping 10 matching lines @@
 ucnv_reset(UConverter *converter);
 
 /**
  * Resets the to-Unicode part of a converter state to the default state.
  * This is used in the case of an error to restart a conversion to
  * Unicode to a known default state. It will also empty the internal
  * output buffers used for the conversion to Unicode codepoints.
  * @param converter the Unicode converter
  * @stable ICU 2.0
  */
-U_STABLE void U_EXPORT2 
+U_STABLE void U_EXPORT2
 ucnv_resetToUnicode(UConverter *converter);
 
 /**
  * Resets the from-Unicode part of a converter state to the default state.
  * This is used in the case of an error to restart a conversion from
  * Unicode to a known default state. It will also empty the internal output
  * buffers used for the conversion from Unicode codepoints.
  * @param converter the Unicode converter
  * @stable ICU 2.0
  */
-U_STABLE void U_EXPORT2 
+U_STABLE void U_EXPORT2
 ucnv_resetFromUnicode(UConverter *converter);
 
 /**
  * Returns the maximum number of bytes that are output per UChar in conversion
  * from Unicode using this converter.
  * The returned number can be used with UCNV_GET_MAX_BYTES_FOR_STRING
  * to calculate the size of a target buffer for conversion from Unicode.
  *
  * Note: Before ICU 2.8, this function did not return reliable numbers for
  * some stateful converters (EBCDIC_STATEFUL, ISO-2022) and LMBCS.
@@ skipping 23 matching lines @@
  * - SBCS charsets: 1
  * - Shift-JIS: 2
  * - UTF-16: 2 (2 per BMP, 4 per surrogate _pair_, BOM not counted)
  * - UTF-8: 3 (3 per BMP, 4 per surrogate _pair_)
  * - EBCDIC_STATEFUL (EBCDIC mixed SBCS/DBCS): 3 (SO + DBCS)
  * - ISO-2022: 3 (always outputs UTF-8)
  * - ISO-2022-JP: 6 (4-byte escape sequences + DBCS)
  * - ISO-2022-CN: 8 (4-byte designator sequences + 2-byte SS2/SS3 + DBCS)
  *
  * @param converter The Unicode converter.
- * @return The maximum number of bytes per UChar that are output by ucnv_fromUnicode(),
- *         to be used together with UCNV_GET_MAX_BYTES_FOR_STRING for buffer allocation.
+ * @return The maximum number of bytes per UChar (16 bit code unit)
+ *    that are output by ucnv_fromUnicode(),
+ *    to be used together with UCNV_GET_MAX_BYTES_FOR_STRING
+ *    for buffer allocation.
  *
  * @see UCNV_GET_MAX_BYTES_FOR_STRING
  * @see ucnv_getMinCharSize
  * @stable ICU 2.0
  */
 U_STABLE int8_t U_EXPORT2
 ucnv_getMaxCharSize(const UConverter *converter);
 
 /**
  * Calculates the size of a buffer for conversion from Unicode to a charset.
@@ skipping 11 matching lines @@
  * @return Size of a buffer that will be large enough to hold the output bytes of
  *         converting length UChars with the converter that returned the maxCharSize.
  *
  * @see ucnv_getMaxCharSize
  * @stable ICU 2.8
  */
 #define UCNV_GET_MAX_BYTES_FOR_STRING(length, maxCharSize) \
      (((int32_t)(length)+10)*(int32_t)(maxCharSize))
 
 /**
- * Returns the minimum byte length for characters in this codepage. 
+ * Returns the minimum byte length (per codepoint) for characters in this codepage.
  * This is usually either 1 or 2.
  * @param converter the Unicode converter
- * @return the minimum number of bytes allowed by this particular converter
+ * @return the minimum number of bytes per codepoint allowed by this particular converter
  * @see ucnv_getMaxCharSize
  * @stable ICU 2.0
  */
 U_STABLE int8_t U_EXPORT2
 ucnv_getMinCharSize(const UConverter *converter);
 
 /**
- * Returns the display name of the converter passed in based on the Locale 
+ * Returns the display name of the converter passed in based on the Locale
  * passed in. If the locale contains no display name, the internal ASCII
  * name will be filled in.
  *
  * @param converter the Unicode converter.
  * @param displayLocale is the specific Locale we want to localised for
  * @param displayName user provided buffer to be filled in
  * @param displayNameCapacity size of displayName Buffer
  * @param err error status code
  * @return displayNameLength number of UChar needed in displayName
  * @see ucnv_getName
  * @stable ICU 2.0
  */
 U_STABLE int32_t U_EXPORT2
 ucnv_getDisplayName(const UConverter *converter,
                     const char *displayLocale,
                     UChar *displayName,
                     int32_t displayNameCapacity,
                     UErrorCode *err);
 
 /**
  * Gets the internal, canonical name of the converter (zero-terminated).
- * The lifetime of the returned string will be that of the converter 
+ * The lifetime of the returned string will be that of the converter
  * passed to this function.
  * @param converter the Unicode converter
  * @param err UErrorCode status
  * @return the internal name of the converter
  * @see ucnv_getDisplayName
  * @stable ICU 2.0
  */
-U_STABLE const char * U_EXPORT2 
+U_STABLE const char * U_EXPORT2
 ucnv_getName(const UConverter *converter, UErrorCode *err);
 
 /**
  * Gets a codepage number associated with the converter. This is not guaranteed
  * to be the one used to create the converter. Some converters do not represent
  * platform registered codepages and return zero for the codepage number.
  * The error code fill-in parameter indicates if the codepage number
  * is available.
  * Does not check if the converter is <TT>NULL</TT> or if converter's data
  * table is <TT>NULL</TT>.
@@ skipping 10 matching lines @@
  * will be returned
  * @see ucnv_openCCSID
  * @see ucnv_getPlatform
  * @stable ICU 2.0
  */
 U_STABLE int32_t U_EXPORT2
 ucnv_getCCSID(const UConverter *converter,
               UErrorCode *err);
 
 /**
- * Gets a codepage platform associated with the converter. Currently, 
+ * Gets a codepage platform associated with the converter. Currently,
  * only <TT>UCNV_IBM</TT> will be returned.
- * Does not test if the converter is <TT>NULL</TT> or if converter's data 
- * table is <TT>NULL</TT>. 
+ * Does not test if the converter is <TT>NULL</TT> or if converter's data
+ * table is <TT>NULL</TT>.
  * @param converter the Unicode converter
  * @param err the error status code.
  * @return The codepage platform
  * @stable ICU 2.0
  */
 U_STABLE UConverterPlatform U_EXPORT2
 ucnv_getPlatform(const UConverter *converter,
                  UErrorCode *err);
 
 /**
  * Gets the type of the converter
- * e.g. SBCS, MBCS, DBCS, UTF8, UTF16_BE, UTF16_LE, ISO_2022, 
+ * e.g. SBCS, MBCS, DBCS, UTF8, UTF16_BE, UTF16_LE, ISO_2022,
  * EBCDIC_STATEFUL, LATIN_1
  * @param converter a valid, opened converter
  * @return the type of the converter
  * @stable ICU 2.0
  */
 U_STABLE UConverterType U_EXPORT2
 ucnv_getType(const UConverter * converter);
 
 /**
  * Gets the "starter" (lead) bytes for converters of type MBCS.
  * Will fill in an <TT>U_ILLEGAL_ARGUMENT_ERROR</TT> if converter passed in
- * is not MBCS. Fills in an array of type UBool, with the value of the byte 
+ * is not MBCS. Fills in an array of type UBool, with the value of the byte
  * as offset to the array. For example, if (starters[0x20] == TRUE) at return,
  * it means that the byte 0x20 is a starter byte in this converter.
  * Context pointers are always owned by the caller.
- * 
+ *
  * @param converter a valid, opened converter of type MBCS
  * @param starters an array of size 256 to be filled in
- * @param err error status, <TT>U_ILLEGAL_ARGUMENT_ERROR</TT> if the 
+ * @param err error status, <TT>U_ILLEGAL_ARGUMENT_ERROR</TT> if the
  * converter is not a type which can return starters.
  * @see ucnv_getType
  * @stable ICU 2.0
  */
 U_STABLE void U_EXPORT2
-ucnv_getStarters(const UConverter* converter, 
+ucnv_getStarters(const UConverter* converter,
                  UBool starters[256],
                  UErrorCode* err);
 
 
 /**
  * Selectors for Unicode sets that can be returned by ucnv_getUnicodeSet().
  * @see ucnv_getUnicodeSet
  * @stable ICU 2.6
  */
 typedef enum UConverterUnicodeSet {
@@ skipping 52 matching lines @@
  * @stable ICU 2.6
  */
 U_STABLE void U_EXPORT2
 ucnv_getUnicodeSet(const UConverter *cnv,
                    USet *setFillIn,
                    UConverterUnicodeSet whichSet,
                    UErrorCode *pErrorCode);
 
 /**
  * Gets the current calback function used by the converter when an illegal
- *  or invalid codepage sequence is found. 
+ *  or invalid codepage sequence is found.
  * Context pointers are always owned by the caller.
  *
  * @param converter the unicode converter
  * @param action fillin: returns the callback function pointer
  * @param context fillin: returns the callback's private void* context
  * @see ucnv_setToUCallBack
  * @stable ICU 2.0
  */
 U_STABLE void U_EXPORT2
 ucnv_getToUCallBack (const UConverter * converter,
                      UConverterToUCallback *action,
                      const void **context);
 
 /**
- * Gets the current callback function used by the converter when illegal 
+ * Gets the current callback function used by the converter when illegal
  * or invalid Unicode sequence is found.
  * Context pointers are always owned by the caller.
  *
  * @param converter the unicode converter
  * @param action fillin: returns the callback function pointer
  * @param context fillin: returns the callback's private void* context
  * @see ucnv_setFromUCallBack
  * @stable ICU 2.0
  */
 U_STABLE void U_EXPORT2
@@ skipping 45 matching lines @@
                        const void *newContext,
                        UConverterFromUCallback *oldAction,
                        const void **oldContext,
                        UErrorCode * err);
 
 /**
  * Converts an array of unicode characters to an array of codepage
  * characters. This function is optimized for converting a continuous
  * stream of data in buffer-sized chunks, where the entire source and
  * target does not fit in available buffers.
- * 
- * The source pointer is an in/out parameter. It starts out pointing where the 
- * conversion is to begin, and ends up pointing after the last UChar consumed. 
- * 
+ *
+ * The source pointer is an in/out parameter. It starts out pointing where the
+ * conversion is to begin, and ends up pointing after the last UChar consumed.
+ *
  * Target similarly starts out pointer at the first available byte in the output
  * buffer, and ends up pointing after the last byte written to the output.
- * 
- * The converter always attempts to consume the entire source buffer, unless 
+ *
+ * The converter always attempts to consume the entire source buffer, unless
  * (1.) the target buffer is full, or (2.) a failing error is returned from the
  * current callback function.  When a successful error status has been
  * returned, it means that all of the source buffer has been
  *  consumed. At that point, the caller should reset the source and
  *  sourceLimit pointers to point to the next chunk.
- * 
+ *
  * At the end of the stream (flush==TRUE), the input is completely consumed
  * when *source==sourceLimit and no error code is set.
  * The converter object is then automatically reset by this function.
  * (This means that a converter need not be reset explicitly between data
  * streams if it finishes the previous stream without errors.)
- * 
+ *
  * This is a <I>stateful</I> conversion. Additionally, even when all source data has
  * been consumed, some data may be in the converters' internal state.
  * Call this function repeatedly, updating the target pointers with
  * the next empty chunk of target in case of a
  * <TT>U_BUFFER_OVERFLOW_ERROR</TT>, and updating the source  pointers
  *  with the next chunk of source when a successful error status is
  * returned, until there are no more chunks of source data.
  * @param converter the Unicode converter
  * @param target I/O parameter. Input : Points to the beginning of the buffer to copy
  *  codepage characters to. Output : points to after the last codepage character copied
  *  to <TT>target</TT>.
  * @param targetLimit the pointer just after last of the <TT>target</TT> buffer
- * @param source I/O parameter, pointer to pointer to the source Unicode character buffer. 
+ * @param source I/O parameter, pointer to pointer to the source Unicode character buffer.
  * @param sourceLimit the pointer just after the last of the source buffer
  * @param offsets if NULL is passed, nothing will happen to it, otherwise it needs to have the same number
  * of allocated cells as <TT>target</TT>. Will fill in offsets from target to source pointer
  * 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>
  * For output data carried across calls, and other data without a specific source character
- * (such as from escape sequences or callbacks)  -1 will be placed for offsets. 
+ * (such as from escape sequences or callbacks)  -1 will be placed for offsets.
  * @param flush set to <TT>TRUE</TT> if the current source buffer is the last available
  * chunk of the source, <TT>FALSE</TT> otherwise. Note that if a failing status is returned,
  * this function may have to be called multiple times with flush set to <TT>TRUE</TT> until
  * the source buffer is consumed.
  * @param err the error status.  <TT>U_ILLEGAL_ARGUMENT_ERROR</TT> will be set if the
  * converter is <TT>NULL</TT>.
- * <code>U_BUFFER_OVERFLOW_ERROR</code> will be set if the target is full and there is 
+ * <code>U_BUFFER_OVERFLOW_ERROR</code> will be set if the target is full and there is
  * still data to be written to the target.
  * @see ucnv_fromUChars
  * @see ucnv_convert
  * @see ucnv_getMinCharSize
  * @see ucnv_setToUCallBack
  * @stable ICU 2.0
  */
-U_STABLE void U_EXPORT2 
+U_STABLE void U_EXPORT2
 ucnv_fromUnicode (UConverter * converter,
                   char **target,
                   const char *targetLimit,
                   const UChar ** source,
                   const UChar * sourceLimit,
                   int32_t* offsets,
                   UBool flush,
                   UErrorCode * err);
 
 /**
  * Converts a buffer of codepage bytes into an array of unicode UChars
  * characters. This function is optimized for converting a continuous
  * stream of data in buffer-sized chunks, where the entire source and
  * target does not fit in available buffers.
- * 
- * The source pointer is an in/out parameter. It starts out pointing where the 
- * conversion is to begin, and ends up pointing after the last byte of source consumed. 
- * 
+ *
+ * The source pointer is an in/out parameter. It starts out pointing where the
+ * conversion is to begin, and ends up pointing after the last byte of source consumed.
+ *
  * Target similarly starts out pointer at the first available UChar in the output
- * buffer, and ends up pointing after the last UChar written to the output. 
+ * buffer, and ends up pointing after the last UChar written to the output.
  * It does NOT necessarily keep UChar sequences together.
- * 
- * The converter always attempts to consume the entire source buffer, unless 
+ *
+ * The converter always attempts to consume the entire source buffer, unless
  * (1.) the target buffer is full, or (2.) a failing error is returned from the
  * current callback function.  When a successful error status has been
  * returned, it means that all of the source buffer has been
  *  consumed. At that point, the caller should reset the source and
  *  sourceLimit pointers to point to the next chunk.
  *
  * At the end of the stream (flush==TRUE), the input is completely consumed
  * when *source==sourceLimit and no error code is set
  * The converter object is then automatically reset by this function.
  * (This means that a converter need not be reset explicitly between data
  * streams if it finishes the previous stream without errors.)
- * 
+ *
  * This is a <I>stateful</I> conversion. Additionally, even when all source data has
  * been consumed, some data may be in the converters' internal state.
  * Call this function repeatedly, updating the target pointers with
  * the next empty chunk of target in case of a
  * <TT>U_BUFFER_OVERFLOW_ERROR</TT>, and updating the source  pointers
  *  with the next chunk of source when a successful error status is
  * returned, until there are no more chunks of source data.
  * @param converter the Unicode converter
  * @param target I/O parameter. Input : Points to the beginning of the buffer to copy
  *  UChars into. Output : points to after the last UChar copied.
  * @param targetLimit the pointer just after the end of the <TT>target</TT> buffer
- * @param source I/O parameter, pointer to pointer to the source codepage buffer. 
+ * @param source I/O parameter, pointer to pointer to the source codepage buffer.
  * @param sourceLimit the pointer to the byte after the end of the source buffer
  * @param offsets if NULL is passed, nothing will happen to it, otherwise it needs to have the same number
  * of allocated cells as <TT>target</TT>. Will fill in offsets from target to source pointer
  * 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>
  * For output data carried across calls, and other data without a specific source character
- * (such as from escape sequences or callbacks)  -1 will be placed for offsets. 
+ * (such as from escape sequences or callbacks)  -1 will be placed for offsets.
  * @param flush set to <TT>TRUE</TT> if the current source buffer is the last available
  * chunk of the source, <TT>FALSE</TT> otherwise. Note that if a failing status is returned,
  * this function may have to be called multiple times with flush set to <TT>TRUE</TT> until
  * the source buffer is consumed.
  * @param err the error status.  <TT>U_ILLEGAL_ARGUMENT_ERROR</TT> will be set if the
  * converter is <TT>NULL</TT>.
- * <code>U_BUFFER_OVERFLOW_ERROR</code> will be set if the target is full and there is 
- * still data to be written to the target. 
+ * <code>U_BUFFER_OVERFLOW_ERROR</code> will be set if the target is full and there is
+ * still data to be written to the target.
  * @see ucnv_fromUChars
  * @see ucnv_convert
  * @see ucnv_getMinCharSize
  * @see ucnv_setFromUCallBack
  * @see ucnv_getNextUChar
  * @stable ICU 2.0
  */
-U_STABLE void U_EXPORT2 
+U_STABLE void U_EXPORT2
 ucnv_toUnicode(UConverter *converter,
                UChar **target,
                const UChar *targetLimit,
                const char **source,
                const char *sourceLimit,
                int32_t *offsets,
                UBool flush,
                UErrorCode *err);
 
 /**
@@ skipping 110 matching lines @@
  *       For these codepages, matching pairs of surrogates will be combined into single
  *       code points for returning from this function.
  *       (Note that SCSU is actually a mix of these codepage types.)</li>
  * </ul></p>
  *
  * @param converter an open UConverter
  * @param source the address of a pointer to the codepage buffer, will be
  *  updated to point after the bytes consumed in the conversion call.
  * @param sourceLimit points to the end of the input buffer
  * @param err fills in error status (see ucnv_toUnicode)
- * <code>U_INDEX_OUTOFBOUNDS_ERROR</code> will be set if the input 
- * is empty or does not convert to any output (e.g.: pure state-change 
+ * <code>U_INDEX_OUTOFBOUNDS_ERROR</code> will be set if the input
+ * is empty or does not convert to any output (e.g.: pure state-change
  * codes SI/SO, escape sequences for ISO 2022,
  * or if the callback did not output anything, ...).
  * This function will not set a <code>U_BUFFER_OVERFLOW_ERROR</code> because
  *  the "buffer" is the return code. However, there might be subsequent output
  *  stored in the converter object
  * that will be returned in following calls to this function.
  * @return a UChar32 resulting from the partial conversion of source
  * @see ucnv_toUnicode
  * @see ucnv_toUChars
  * @see ucnv_convert
@@ skipping 83 matching lines @@
  *     if(length<0) {
  *         length=strlen(s);
  *     }
  *     target=u8;
  *     ucnv_convertEx(utf8Cnv, cnv,
  *                    &target, u8+capacity,
  *                    &s, s+length,
  *                    NULL, NULL, NULL, NULL,
  *                    TRUE, TRUE,
  *                    pErrorCode);
- * 
+ *
  *     myReleaseCachedUTF8Converter(utf8Cnv);
  *
  *     // return the output string length, but without preflighting
  *     return (int32_t)(target-u8);
  * }
  * \endcode
  *
  * @param targetCnv     Output converter, used to convert from the UTF-16 pivot
  *                      to the target using ucnv_fromUnicode().
  * @param sourceCnv     Input converter, used to convert from the source to
@@ skipping 267 matching lines @@
 /**
  * Gives the number of aliases for a given converter or alias name.
  * If the alias is ambiguous, then the preferred converter is used
  * and the status is set to U_AMBIGUOUS_ALIAS_WARNING.
  * This method only enumerates the listed entries in the alias file.
  * @param alias alias name
  * @param pErrorCode error status
  * @return number of names on alias list for given alias
  * @stable ICU 2.0
  */
-U_STABLE uint16_t U_EXPORT2 
+U_STABLE uint16_t U_EXPORT2
 ucnv_countAliases(const char *alias, UErrorCode *pErrorCode);
 
 /**
  * Gives the name of the alias at given index of alias list.
  * This method only enumerates the listed entries in the alias file.
  * If the alias is ambiguous, then the preferred converter is used
  * and the status is set to U_AMBIGUOUS_ALIAS_WARNING.
  * @param alias alias name
  * @param n index in alias list
  * @param pErrorCode result of operation
  * @return returns the name of the alias at given index
  * @see ucnv_countAliases
  * @stable ICU 2.0
  */
-U_STABLE const char * U_EXPORT2 
+U_STABLE const char * U_EXPORT2
 ucnv_getAlias(const char *alias, uint16_t n, UErrorCode *pErrorCode);
 
 /**
  * Fill-up the list of alias names for the given alias.
  * This method only enumerates the listed entries in the alias file.
  * If the alias is ambiguous, then the preferred converter is used
  * and the status is set to U_AMBIGUOUS_ALIAS_WARNING.
  * @param alias alias name
  * @param aliases fill-in list, aliases is a pointer to an array of
  *        <code>ucnv_countAliases()</code> string-pointers
  *        (<code>const char *</code>) that will be filled in.
  *        The strings themselves are owned by the library.
  * @param pErrorCode result of operation
  * @stable ICU 2.0
  */
-U_STABLE void U_EXPORT2 
+U_STABLE void U_EXPORT2
 ucnv_getAliases(const char *alias, const char **aliases, UErrorCode *pErrorCode);
 
 /**
  * Return a new UEnumeration object for enumerating all the
  * alias names for a given converter that are recognized by a standard.
  * This method only enumerates the listed entries in the alias file.
  * The convrtrs.txt file can be modified to change the results of
  * this function.
  * The first result in this list is the same result given by
  * <code>ucnv_getStandardName</code>, which is the default alias for
@@ skipping 111 matching lines @@
  * @param name the converter name to be the default (must be known by ICU).
  * @see ucnv_getDefaultName
  * @system
  * @stable ICU 2.0
  */
 U_STABLE void U_EXPORT2
 ucnv_setDefaultName(const char *name);
 #endif  /* U_HIDE_SYSTEM_API */
 
 /**
- * Fixes the backslash character mismapping.  For example, in SJIS, the backslash 
- * character in the ASCII portion is also used to represent the yen currency sign.  
- * When mapping from Unicode character 0x005C, it's unclear whether to map the 
+ * Fixes the backslash character mismapping.  For example, in SJIS, the backslash
+ * character in the ASCII portion is also used to represent the yen currency sign.
+ * When mapping from Unicode character 0x005C, it's unclear whether to map the
  * character back to yen or backslash in SJIS.  This function will take the input
  * buffer and replace all the yen sign characters with backslash.  This is necessary
  * when the user tries to open a file with the input buffer on Windows.
  * This function will test the converter to see whether such mapping is
  * required.  You can sometimes avoid using this function by using the correct version
  * of Shift-JIS.
  *
  * @param cnv The converter representing the target codepage.
  * @param source the input buffer to be fixed
  * @param sourceLen the length of the input buffer
  * @see ucnv_isAmbiguous
  * @stable ICU 2.0
  */
 U_STABLE void U_EXPORT2
 ucnv_fixFileSeparator(const UConverter *cnv, UChar *source, int32_t sourceLen);
 
 /**
  * Determines if the converter contains ambiguous mappings of the same
  * character or not.
  * @param cnv the converter to be tested
- * @return TRUE if the converter contains ambiguous mapping of the same 
+ * @return TRUE if the converter contains ambiguous mapping of the same
  * character, FALSE otherwise.
  * @stable ICU 2.0
  */
 U_STABLE UBool U_EXPORT2
 ucnv_isAmbiguous(const UConverter *cnv);
 
 /**
  * Sets the converter to use fallback mappings or not.
  * Regardless of this flag, the converter will always use
  * fallbacks from Unicode Private Use code points, as well as
  * reverse fallbacks (to Unicode).
  * For details see ".ucm File Format"
  * in the Conversion Data chapter of the ICU User Guide:
  * http://www.icu-project.org/userguide/conversion-data.html#ucmformat
  *
  * @param cnv The converter to set the fallback mapping usage on.
- * @param usesFallback TRUE if the user wants the converter to take advantage of the fallback 
+ * @param usesFallback TRUE if the user wants the converter to take advantage of the fallback
  * mapping, FALSE otherwise.
  * @stable ICU 2.0
  * @see ucnv_usesFallback
  */
-U_STABLE void U_EXPORT2 
+U_STABLE void U_EXPORT2
 ucnv_setFallback(UConverter *cnv, UBool usesFallback);
 
 /**
  * Determines if the converter uses fallback mappings or not.
  * This flag has restrictions, see ucnv_setFallback().
  *
  * @param cnv The converter to be tested
  * @return TRUE if the converter uses fallback, FALSE otherwise.
  * @stable ICU 2.0
  * @see ucnv_setFallback
  */
-U_STABLE UBool U_EXPORT2 
+U_STABLE UBool U_EXPORT2
 ucnv_usesFallback(const UConverter *cnv);
 
 /**
  * Detects Unicode signature byte sequences at the start of the byte stream
  * and returns the charset name of the indicated Unicode charset.
  * NULL is returned when no Unicode signature is recognized.
  * The number of bytes in the signature is output as well.
  *
  * The caller can ucnv_open() a converter using the charset name.
  * The first code unit (UChar) from the start of the stream will be U+FEFF
  * (the Unicode BOM/signature character) and can usually be ignored.
  *
  * For most Unicode charsets it is also possible to ignore the indicated
  * number of initial stream bytes and start converting after them.
  * However, there are stateful Unicode charsets (UTF-7 and BOCU-1) for which
  * this will not work. Therefore, it is best to ignore the first output UChar
  * instead of the input signature bytes.
  * <p>
  * Usage:
  * \snippet samples/ucnv/convsamp.cpp ucnv_detectUnicodeSignature
  *
  * @param source            The source string in which the signature should be detected.
  * @param sourceLength      Length of the input string, or -1 if terminated with a NUL byte.
- * @param signatureLength   A pointer to int32_t to receive the number of bytes that make up the signature 
+ * @param signatureLength   A pointer to int32_t to receive the number of bytes that make up the signature
  *                          of the detected UTF. 0 if not detected.
  *                          Can be a NULL pointer.
  * @param pErrorCode        ICU error code in/out parameter.
  *                          Must fulfill U_SUCCESS before the function call.
- * @return The name of the encoding detected. NULL if encoding is not detected. 
+ * @return The name of the encoding detected. NULL if encoding is not detected.
  * @stable ICU 2.4
  */
 U_STABLE const char* U_EXPORT2
 ucnv_detectUnicodeSignature(const char* source,
                             int32_t sourceLength,
                             int32_t *signatureLength,
                             UErrorCode *pErrorCode);
 
 /**
- * Returns the number of UChars held in the converter's internal state 
- * because more input is needed for completing the conversion. This function is 
+ * Returns the number of UChars held in the converter's internal state
+ * because more input is needed for completing the conversion. This function is
  * useful for mapping semantics of ICU's converter interface to those of iconv,
  * and this information is not needed for normal conversion.
  * @param cnv       The converter in which the input is held
  * @param status    ICU error code in/out parameter.
  *                  Must fulfill U_SUCCESS before the function call.
  * @return The number of UChars in the state. -1 if an error is encountered.
  * @stable ICU 3.4
  */
 U_STABLE int32_t U_EXPORT2
 ucnv_fromUCountPending(const UConverter* cnv, UErrorCode* status);
 
 /**
  * Returns the number of chars held in the converter's internal state
- * because more input is needed for completing the conversion. This function is 
+ * because more input is needed for completing the conversion. This function is
  * useful for mapping semantics of ICU's converter interface to those of iconv,
  * and this information is not needed for normal conversion.
  * @param cnv       The converter in which the input is held as internal state
  * @param status    ICU error code in/out parameter.
  *                  Must fulfill U_SUCCESS before the function call.
  * @return The number of chars in the state. -1 if an error is encountered.
  * @stable ICU 3.4
  */
 U_STABLE int32_t U_EXPORT2
 ucnv_toUCountPending(const UConverter* cnv, UErrorCode* status);
@@ skipping 13 matching lines @@
  * @return TRUE if the converter is fixed-width
  * @stable ICU 4.8
  */
 U_STABLE UBool U_EXPORT2
 ucnv_isFixedWidth(UConverter *cnv, UErrorCode *status);
 
 #endif
 
 #endif
 /*_UCNV*/