*
* - Supplementary code points may convert to more bytes than BMP code points.
* This function returns bytes per #i18n_uchar (UTF-16 code unit), not per Unicode code point, for efficient buffer allocation.\n
- * - State-shifting output (SI/SO, escapes, etc.) from stateful converters.\n
- * - When m input #i18n_uchar are converted to n output bytes, then the maximum m/n is taken into account.\n
+ * - State-shifting output (SI/SO, escapes, etc.) from stateful converters.
+ * - When m input #i18n_uchar are converted to n output bytes, then the maximum m/n is taken into account.
*
* The number returned here does not take into account (see i18n_ucnv_get_max_bytes_for_string()):
*
- * - initial and final non-character bytes that are output by some converters (automatic BOMs, initial escape sequence, final SI, etc.)\n
+ * - initial and final non-character bytes that are output by some converters (automatic BOMs, initial escape sequence, final SI, etc.)
*
* Examples for returned values:
*
- * - SBCS charsets: 1\n
- * - Shift-JIS: 2\n
- * - UTF-16: 2 (2 per BMP, 4 per surrogate pair, BOM not counted)\n
+ * - 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)]n
- * - EBCDIC_STATEFUL (EBCDIC mixed SBCS/DBCS): 3 (SO + DBCS)\n
- * - ISO-2022: 3 (always outputs UTF-8)\n
- * - ISO-2022-JP: 6 (4-byte escape sequences + DBCS)\n
- * - ISO-2022-CN: 8 (4-byte designator sequences + 2-byte SS2/SS3 + DBCS)\n
+ * - 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)
* @since_tizen 6.0
* @param[in] converter An #i18n_ucnv_h
* @param[out] size The maximum number of bytes per #i18n_uchar (16 bit code unit) that are output by
*
* This is useful for example for
*
- * - checking that a string or document can be roundtrip-converted with a converter, without/before actually performing the conversion\n
+ * - checking that a string or document can be roundtrip-converted with a converter, without/before actually performing the conversion
* - testing if a converter can be used for text for typical text for a certain locale,
* by comparing its roundtrip set with the set of ExemplarCharacters from ICU's locale data or other sources\n
*
*
* - Faster for small amounts of data, for most converters, e.g., US-ASCII, ISO-8859-1, UTF-8/16/32, and most "normal" charsets.
* (For complex converters, e.g., SCSU, UTF-7 and ISO 2022 variants, it uses i18n_ucnv_to_unicode() internally.)\n
- * - Convenient.\n
+ * - Convenient.
*
* Limitations compared to i18n_ucnv_to_unicode():
*
* - Always assumes flush=TRUE. This makes i18n_ucnv_get_next_uchar() unsuitable for "streaming" conversion,
* that is, for where the input is supplied in multiple buffers,
* because i18n_ucnv_get_next_uchar() will assume the end of the input at the end of the first buffer.\n
- * - Does not provide offset output.\n
+ * - Does not provide offset output.
*
* It is possible to "mix" i18n_ucnv_get_next_uchar() and i18n_ucnv_to_unicode()
* because i18n_ucnv_get_next_uchar() uses the current state of the converter
*
* There is a similar function, i18n_ucnv_convert(), which has the following limitations:
*
- * - it takes charset names, not converter objects, so that\n
- * - two converters are created for each call\n
- * - only single-string conversion is possible, not streaming operation\n
- * - it does not provide enough information to find out, in case of failure, whether the toUnicode or the fromUnicode conversion failed\n
+ * - it takes charset names, not converter objects, so that
+ * - two converters are created for each call
+ * - only single-string conversion is possible, not streaming operation
+ * - it does not provide enough information to find out, in case of failure, whether the toUnicode or the fromUnicode conversion failed
*
* By contrast, i18n_ucnv_convert_ex()
*
- * - takes #i18n_ucnv_h parameters instead of charset names\n
- * - fully exposes the pivot buffer for streaming conversion and complete error handling\n
+ * - takes #i18n_ucnv_h parameters instead of charset names
+ * - fully exposes the pivot buffer for streaming conversion and complete error handling
*
* i18n_ucnv_convert_ex() also provides further convenience:
*
- * - an option to reset the converters at the beginning (if reset==TRUE, see parameters; also sets *@a pivot_target=*@a pivot_source=@a pivot_start)\n
- * - allow NUL-terminated input (only a single NUL byte, will not work for charsets with multi-byte NULs) (if @a source_limit ==NULL, see parameters)\n
+ * - an option to reset the converters at the beginning (if reset==TRUE, see parameters; also sets *@a pivot_target=*@a pivot_source=@a pivot_start)
+ * - allow NUL-terminated input (only a single NUL byte, will not work for charsets with multi-byte NULs) (if @a source_limit ==NULL, see parameters)
* - terminate with a NUL on output (only a single NUL byte, not useful for charsets with multi-byte NULs),
* or set #I18N_WARNING_STRING_NOT_TERMINATED if the output exactly fills the target buffer\n
* - the pivot buffer can be provided internally; possible only for whole-string conversion, not streaming conversion;
*
* The function returns when one of the following is true:
*
- * - the entire source text has been converted successfully to the target buffer\n
- * - a target buffer overflow occurred (#I18N_ERROR_BUFFER_OVERFLOW)\n
- * - a conversion error occurred\n
+ * - the entire source text has been converted successfully to the target buffer
+ * - a target buffer overflow occurred (#I18N_ERROR_BUFFER_OVERFLOW)
+ * - a conversion error occurred
*
* Limitation compared to the direct use of i18n_ucnv_from_unicode() and i18n_ucnv_to_unicode(): i18n_ucnv_convert_ex() does not provide offset information.
*
*
* This is a convenience function, not an efficient way to convert a lot of text: i18n_ucnv_convert()
*
- * - takes charset names, not converter objects, so that\n
- * - two converters are created for each call\n
- * - only single-string conversion is possible, not streaming operation\n
- * - does not provide enough information to find out, in case of failure, whether the toUnicode or the fromUnicode conversion failed\n
+ * - takes charset names, not converter objects, so that
+ * - two converters are created for each call
+ * - only single-string conversion is possible, not streaming operation
+ * - does not provide enough information to find out, in case of failure, whether the toUnicode or the fromUnicode conversion failed
* - allows NUL-terminated input (only a single NUL byte, will not work for charsets with multi-byte NULs) (if @a source_length ==-1, see parameters)
* terminate with a NUL on output (only a single NUL byte, not useful for charsets with multi-byte NULs),
* or set #I18N_WARNING_STRING_NOT_TERMINATED if the output exactly fills the target buffer\n
- * - a pivot buffer is provided internally\n
+ * - a pivot buffer is provided internally
*
* The function returns when one of the following is true:
*
* - the entire source text has been converted successfully to the target buffer
* and either the target buffer is terminated with a single NUL byte or the error code is set to #I18N_WARNING_STRING_NOT_TERMINATED\n
- * - a target buffer overflow occurred (#I18N_ERROR_BUFFER_OVERFLOW) and the full output string length is returned ("preflighting")\n
- * - a conversion error occurred\n
+ * - a target buffer overflow occurred (#I18N_ERROR_BUFFER_OVERFLOW) and the full output string length is returned ("preflighting")
+ * - a conversion error occurred
* @since_tizen 6.0
* @param[in] to_converter_name The name of the converter that is used to convert from the UTF-16 pivot buffer to the target.
* @param[in] from_converter_name The name of the converter that is used to convert from the source to the UTF-16 pivot buffer.
projects / platform / core / api / base-utils.git / commitdiff