Lines Matching refs:converter
28 * from UTF-16. You can open a converter with {@link ucnv_open() }. With that
29 * converter, you can get its properties, set options, convert your data and
30 * close the converter.</p>
32 * <p>Since many software programs recogize different converter names for
34 * iterate over the converter aliases. The functions {@link ucnv_getAvailableName() },
38 * <p>When a converter encounters an illegal, irregular, invalid or unmappable character
41 * or {@link ucnv_setToUCallBack() } on the converter. The header ucnv_err.h defines
77 /** Maximum length of a converter name including the terminating NULL @stable ICU 2.0 */
79 /** Maximum length of a converter name including path and terminating NULL @stable ICU 2.0 */
167 /* Number of converter types for which we have conversion routines. */
172 * Enum for specifying which platform a converter ID refers to.
194 * For converter callback functions, set to a conversion error
218 * For converter callback functions, set to a conversion error
235 * Character that separates converter names from options and options from each other.
249 * Character that separates a converter option from its value.
263 * Converter option for specifying a locale.
273 * Converter option for specifying a version selector (0..9) for some converters.
286 * Converter option for EBCDIC SBCS or mixed-SBCS/DBCS (stateful) codepages.
298 * Do a fuzzy compare of two converter/alias names.
305 * @param name1 a converter name or alias, zero-terminated
306 * @param name2 a converter name or alias, zero-terminated
323 * If <code>NULL</code> is passed for the converter name, it will create one with the
326 * <p>A converter name for ICU 1.5 and above may contain options
328 * the newly instantiated converter.
329 * The meaning of the options depends on the particular converter.
330 * If an option is not defined for or recognized by a given converter, then it is ignored.</p>
332 * <p>Options are appended to the converter name string, with a
336 * <p>If the alias is ambiguous, then the preferred converter is used
354 * If this parameter is NULL, the default converter will be used.
356 * @return the created Unicode converter object, or <TT>NULL</TT> if an error occured
371 * Creates a Unicode converter with the names specified as unicode string.
378 * If <TT>NULL</TT> is passed for the converter name, it will create
380 * If the alias is ambiguous, then the preferred converter is used
388 * @return the created Unicode converter object, or <TT>NULL</TT> if an
420 * Currently, the only "platform" supported in the ICU converter API is UCNV_IBM.
424 * In order to open a converter with the default IBM CDRA Unicode conversion table,
432 * In order to open a converter with the IBM S/390 Unix System Services variant
441 * In order to open a converter from a Microsoft codepage number, use the prefix "cp":
448 * If the alias is ambiguous, then the preferred converter is used
454 * @return the created Unicode converter object, or <TT>NULL</TT> if an error
477 * <p>The name will NOT be looked up in the alias mechanism, nor will the converter be
478 * stored in the converter cache or the alias table. The only way to open further converters
480 * 'master' converter.</p>
492 * @return the created Unicode converter object, or <TT>NULL</TT> if an error occured
503 * Thread safe converter cloning operation.
514 * for cloning this converter,
515 * without actually cloning the converter ("pure pre-flighting").
518 * clone, then the converter is cloned using newly allocated memory
521 * If the converter clone fits into the stack buffer but the stack buffer is not
525 * @param cnv converter to be cloned
560 * Deletes the unicode converter and releases resources associated
562 * Does not free up shared converter tables.
564 * @param converter the converter object to be deleted
571 ucnv_close(UConverter * converter);
595 * If ucnv_setSubstString() set a Unicode string because the converter is
598 * @param converter the Unicode converter
610 ucnv_getSubstChars(const UConverter *converter,
620 * byte sequence of a valid character in the converter's charset.
625 * @param converter the Unicode converter
635 ucnv_setSubstChars(UConverter *converter,
677 * @param converter the Unicode converter
687 ucnv_getInvalidChars(const UConverter *converter,
696 * @param converter the Unicode converter
706 ucnv_getInvalidUChars(const UConverter *converter,
712 * Resets the state of a converter to the default state. This is used
715 * @param converter the Unicode converter
719 ucnv_reset(UConverter *converter);
722 * Resets the to-Unicode part of a converter state to the default state.
726 * @param converter the Unicode converter
730 ucnv_resetToUnicode(UConverter *converter);
733 * Resets the from-Unicode part of a converter state to the default state.
737 * @param converter the Unicode converter
741 ucnv_resetFromUnicode(UConverter *converter);
745 * from Unicode using this converter.
756 * buffer of guaranteed sufficient size for a given input length and converter.
783 * @param converter The Unicode converter.
794 ucnv_getMaxCharSize(const UConverter *converter);
807 * @param maxCharSize Return value from ucnv_getMaxCharSize() for the converter
810 * converting length UChars with the converter that returned the maxCharSize.
821 * @param converter the Unicode converter
822 * @return the minimum number of bytes per codepoint allowed by this particular converter
827 ucnv_getMinCharSize(const UConverter *converter);
830 * Returns the display name of the converter passed in based on the Locale
834 * @param converter the Unicode converter.
844 ucnv_getDisplayName(const UConverter *converter,
851 * Gets the internal, canonical name of the converter (zero-terminated).
852 * The lifetime of the returned string will be that of the converter
854 * @param converter the Unicode converter
856 * @return the internal name of the converter
861 ucnv_getName(const UConverter *converter, UErrorCode *err);
864 * Gets a codepage number associated with the converter. This is not guaranteed
865 * to be the one used to create the converter. Some converters do not represent
869 converter is <TT>NULL</TT> or if converter's data
874 * ICU converter API.
878 * @param converter the Unicode converter
887 ucnv_getCCSID(const UConverter *converter,
891 * Gets a codepage platform associated with the converter. Currently,
893 * Does not test if the converter is <TT>NULL</TT> or if converter's data
895 * @param converter the Unicode converter
901 ucnv_getPlatform(const UConverter *converter,
905 * Gets the type of the converter
908 * @param converter a valid, opened converter
909 * @return the type of the converter
913 ucnv_getType(const UConverter * converter);
917 * Will fill in an <TT>U_ILLEGAL_ARGUMENT_ERROR</TT> if converter passed in
920 * it means that the byte 0x20 is a starter byte in this converter.
923 * @param converter a valid, opened converter of type MBCS
926 * converter is not a type which can return starters.
931 ucnv_getStarters(const UConverter* converter,
957 * Returns the set of Unicode code points that can be converted by an ICU converter.
964 * (converted without any data loss) with the converter (ucnv_fromUnicode()).
973 * - checking that a string or document can be roundtrip-converted with a converter,
975 * - testing if a converter can be used for text for typical text for a certain locale,
981 * The set of all Unicode code points that can be converted with the converter (ucnv_fromUnicode())
988 * @param cnv The converter for which a set is requested.
990 * the converter's specific set is filled into the USet.
1008 * Gets the current calback function used by the converter when an illegal
1012 * @param converter the unicode converter
1019 ucnv_getToUCallBack (const UConverter * converter,
1024 * Gets the current callback function used by the converter when illegal
1028 * @param converter the unicode converter
1035 ucnv_getFromUCallBack (const UConverter * converter,
1040 * Changes the callback function used by the converter when
1045 * @param converter the unicode converter
1055 ucnv_setToUCallBack (UConverter * converter,
1063 * Changes the current callback function used by the converter when
1068 * @param converter the unicode converter
1078 ucnv_setFromUCallBack (UConverter * converter,
1097 * The converter always attempts to consume the entire source buffer, unless
1106 * The converter object is then automatically reset by this function.
1107 * (This means that a converter need not be reset explicitly between data
1117 * @param converter the Unicode converter
1134 * converter is <TT>NULL</TT>.
1144 ucnv_fromUnicode (UConverter * converter,
1166 * The converter always attempts to consume the entire source buffer, unless
1175 * The converter object is then automatically reset by this function.
1176 * (This means that a converter need not be reset explicitly between data
1186 * @param converter the Unicode converter
1202 * converter is <TT>NULL</TT>.
1213 ucnv_toUnicode(UConverter *converter,
1232 * @param cnv the converter object to be used (ucnv_resetFromUnicode() will be called)
1265 * @param cnv the converter object to be used (ucnv_resetToUnicode() will be called)
1307 * ucnv_getNextUChar() uses the current state of the converter
1338 * @param converter an open UConverter
1349 * stored in the converter object
1358 ucnv_getNextUChar(UConverter * converter,
1376 * - it takes charset names, not converter objects, so that
1456 * @param targetCnv Output converter, used to convert from the UTF-16 pivot
1458 * @param sourceCnv Input converter, used to convert from the source to
1518 * - takes charset names, not converter objects, so that
1542 * @param toConverterName The name of the converter that is used to convert
1544 * @param fromConverterName The name of the converter that is used to convert
1580 * The source-to-pivot conversion uses the cnv converter parameter.
1581 * The pivot-to-target conversion uses a purely algorithmic converter
1582 * according to the specified type, e.g., UCNV_UTF8 for a UTF-8 converter.
1584 * Internally, the algorithmic converter is opened and closed for each
1586 * but somewhat less efficient than only resetting an existing converter
1595 * charset as a purely algorithmic converter.
1599 * @param cnv The converter that is used to convert
1632 * The source-to-pivot conversion uses a purely algorithmic converter
1633 * according to the specified type, e.g., UCNV_UTF8 for a UTF-8 converter.
1634 * The pivot-to-target conversion uses the cnv converter parameter.
1636 * Internally, the algorithmic converter is opened and closed for each
1638 * but somewhat less efficient than only resetting an existing converter
1646 * @param cnv The converter that is used to convert
1649 * charset as a purely algorithmic converter.
1679 * Frees up memory occupied by unused, cached converter shared data.
1699 * Gets the canonical converter name of the specified converter from a list of
1703 * @param n the index to a converter available on the system (in the range <TT>[0..ucnv_countAvaiable()]</TT>)
1712 * Returns a UEnumeration to enumerate all of the canonical converter
1714 * converter.
1717 * converter names.
1727 * Gives the number of aliases for a given converter or alias name.
1728 * If the alias is ambiguous, then the preferred converter is used
1742 * If the alias is ambiguous, then the preferred converter is used
1757 * If the alias is ambiguous, then the preferred converter is used
1772 * alias names for a given converter that are recognized by a standard.
1781 * @param convName original converter name
1799 * Gives the number of standards associated to converter names.
1817 * Returns a standard name for a given converter name.
1826 * @param name original converter name
1830 * @return returns the standard converter name;
1831 * if a standard converter name cannot be determined,
1839 * This function will return the internal canonical converter name of the
1850 * @return returns the canonical converter name;
1861 * Returns the current default converter name. If you want to open
1862 * a default converter, you do not need to use this function.
1864 * default converter.
1869 * @return returns the current default converter name.
1881 * current default converter name. If this function needs to be called, it
1889 * @param name the converter name to be the default (must be known by ICU).
1905 * This function will test the converter to see whether such mapping is
1909 * @param cnv The converter representing the target codepage.
1919 * Determines if the converter contains ambiguous mappings of the same
1921 * @param cnv the converter to be tested
1922 * @return TRUE if the converter contains ambiguous mapping of the same
1930 * Sets the converter to use fallback mappings or not.
1931 * Regardless of this flag, the converter will always use
1938 * @param cnv The converter to set the fallback mapping usage on.
1939 * @param usesFallback TRUE if the user wants the converter to take advantage of the fallback
1948 * Determines if the converter uses fallback mappings or not.
1951 * @param cnv The converter to be tested
1952 * @return TRUE if the converter uses fallback, FALSE otherwise.
1965 * The caller can ucnv_open() a converter using the charset name.
1995 * Returns the number of UChars held in the converter's internal state
1997 * useful for mapping semantics of ICU's converter interface to those of iconv,
1999 * @param cnv The converter in which the input is held
2009 * Returns the number of chars held in the converter's internal state
2011 * useful for mapping semantics of ICU's converter interface to those of iconv,
2013 * @param cnv The converter in which the input is held as internal state
2023 * Returns whether or not the charset of the converter has a fixed number of bytes
2028 * but a UTF-32 converter encodes each code point with 4 bytes.
2032 * @param cnv The converter to be tested
2034 * @return TRUE if the converter is fixed-width
