Lines Matching refs:converter
26 * from UTF-16. You can open a converter with {@link ucnv_open() }. With that
27 * converter, you can get its properties, set options, convert your data and
28 * close the converter.</p>
30 * <p>Since many software programs recogize different converter names for
32 * iterate over the converter aliases. The functions {@link ucnv_getAvailableName() },
36 * <p>When a converter encounters an illegal, irregular, invalid or unmappable character
39 * or {@link ucnv_getToUCallBack() } on the converter. The header ucnv_err.h defines
74 /** Maximum length of a converter name including the terminating NULL @stable ICU 2.0 */
76 /** Maximum length of a converter name including path and terminating NULL @stable ICU 2.0 */
127 /* Number of converter types for which we have conversion routines. */
133 * Enum for specifying which platform a converter ID refers to.
190 * Character that separates converter names from options and options from each other.
204 * Character that separates a converter option from its value.
250 * Do a fuzzy compare of a two converter/alias names. The comparison
255 * @param name1 a converter name or alias, zero-terminated
256 * @param name2 a converter name or alias, zero-terminated
272 * If <code>NULL</code> is passed for the converter name, it will create one with the
275 * <p>A converter name for ICU 1.5 and above may contain options
277 * the newly instantiated converter.
278 * The meaning of the options depends on the particular converter.
279 * If an option is not defined for or recognized by a given converter, then it is ignored.</p>
281 * <p>Options are appended to the converter name string, with a
285 * <p>If the alias is ambiguous, then the preferred converter is used
295 * @return the created Unicode converter object, or <TT>NULL</TT> if an error occured
306 * Creates a Unicode converter with the names specified as unicode string.
312 * If <TT>NULL</TT> is passed for the converter name, it will create
314 * If the alias is ambiguous, then the preferred converter is used
320 * @return the created Unicode converter object, or <TT>NULL</TT> if an
352 * Currently, the only "platform" supported in the ICU converter API is UCNV_IBM.
356 * In order to open a converter with the default IBM CDRA Unicode conversion table,
364 * In order to open a converter with the IBM S/390 Unix System Services variant
373 * In order to open a converter from a Microsoft codepage number, use the prefix "cp":
380 * If the alias is ambiguous, then the preferred converter is used
386 * @return the created Unicode converter object, or <TT>NULL</TT> if an error
409 * <p>The name will NOT be looked up in the alias mechanism, nor will the converter be
410 * stored in the converter cache or the alias table. The only way to open further converters
412 * 'master' converter.</p>
424 * @return the created Unicode converter object, or <TT>NULL</TT> if an error occured
436 * @param cnv converter to be cloned
465 * Deletes the unicode converter and releases resources associated
467 * Does not free up shared converter tables.
469 * @param converter the converter object to be deleted
476 ucnv_close(UConverter * converter);
482 * @param converter the Unicode converter
493 ucnv_getSubstChars(const UConverter *converter,
502 * @param converter the Unicode converter
511 ucnv_setSubstChars(UConverter *converter,
520 * @param converter the Unicode converter
530 ucnv_getInvalidChars(const UConverter *converter,
539 * @param converter the Unicode converter
549 ucnv_getInvalidUChars(const UConverter *converter,
555 * Resets the state of a converter to the default state. This is used
558 * @param converter the Unicode converter
562 ucnv_reset(UConverter *converter);
565 * Resets the to-Unicode part of a converter state to the default state.
569 * @param converter the Unicode converter
573 ucnv_resetToUnicode(UConverter *converter);
576 * Resets the from-Unicode part of a converter state to the default state.
580 * @param converter the Unicode converter
584 ucnv_resetFromUnicode(UConverter *converter);
588 * from Unicode using this converter.
599 * buffer of guaranteed sufficient size for a given input length and converter.
626 * @param converter The Unicode converter.
635 ucnv_getMaxCharSize(const UConverter *converter);
650 * @param maxCharSize Return value from ucnv_getMaxCharSize() for the converter
653 * converting length UChars with the converter that returned the maxCharSize.
666 * @param converter the Unicode converter
667 * @return the minimum number of bytes allowed by this particular converter
672 ucnv_getMinCharSize(const UConverter *converter);
675 * Returns the display name of the converter passed in based on the Locale
679 * @param converter the Unicode converter.
689 ucnv_getDisplayName(const UConverter *converter,
696 * Gets the internal, canonical name of the converter (zero-terminated).
697 * The lifetime of the returned string will be that of the converter
699 * @param converter the Unicode converter
701 * @return the internal name of the converter
706 ucnv_getName(const UConverter *converter, UErrorCode *err);
709 * Gets a codepage number associated with the converter. This is not guaranteed
710 * to be the one used to create the converter. Some converters do not represent
714 * Does not check if the converter is <TT>NULL</TT> or if converter's data
719 * ICU converter API.
723 * @param converter the Unicode converter
732 ucnv_getCCSID(const UConverter *converter,
736 * Gets a codepage platform associated with the converter. Currently,
738 * Does not test if the converter is <TT>NULL</TT> or if converter's data
740 * @param converter the Unicode converter
746 ucnv_getPlatform(const UConverter *converter,
750 * Gets the type of the converter
753 * @param converter a valid, opened converter
754 * @return the type of the converter
758 ucnv_getType(const UConverter * converter);
762 * Will fill in an <TT>U_ILLEGAL_ARGUMENT_ERROR</TT> if converter passed in
765 * it means that the byte 0x20 is a starter byte in this converter.
768 * @param converter a valid, opened converter of type MBCS
771 * converter is not a type which can return starters.
776 ucnv_getStarters(const UConverter* converter,
795 * Returns the set of Unicode code points that can be converted by an ICU converter.
799 * (converted without any data loss) with the converter.
806 * - checking that a string or document can be roundtrip-converted with a converter,
808 * - testing if a converter can be used for text for typical text for a certain locale,
815 * @param cnv The converter for which a set is requested.
817 * the converter's specific set is filled into the USet.
835 * Gets the current calback function used by the converter when an illegal
839 * @param converter the unicode converter
846 ucnv_getToUCallBack (const UConverter * converter,
851 * Gets the current callback function used by the converter when illegal
855 * @param converter the unicode converter
862 ucnv_getFromUCallBack (const UConverter * converter,
867 * Changes the callback function used by the converter when
872 * @param converter the unicode converter
882 ucnv_setToUCallBack (UConverter * converter,
890 * Changes the current callback function used by the converter when
895 * @param converter the unicode converter
905 ucnv_setFromUCallBack (UConverter * converter,
924 * The converter always attempts to consume the entire source buffer, unless
933 * The converter object is then automatically reset by this function.
934 * (This means that a converter need not be reset explicitly between data
944 * @param converter the Unicode converter
961 * converter is <TT>NULL</TT>.
971 ucnv_fromUnicode (UConverter * converter,
993 * The converter always attempts to consume the entire source buffer, unless
1002 * The converter object is then automatically reset by this function.
1003 * (This means that a converter need not be reset explicitly between data
1013 * @param converter the Unicode converter
1029 * converter is <TT>NULL</TT>.
1040 ucnv_toUnicode(UConverter *converter,
1059 * @param cnv the converter object to be used (ucnv_resetFromUnicode() will be called)
1092 * @param cnv the converter object to be used (ucnv_resetToUnicode() will be called)
1134 * ucnv_getNextUChar() uses the current state of the converter
1165 * @param converter an open UConverter
1176 * stored in the converter object
1185 ucnv_getNextUChar(UConverter * converter,
1197 * - it takes charset names, not converter objects, so that
1273 * @param targetCnv Output converter, used to convert from the UTF-16 pivot
1275 * @param sourceCnv Input converter, used to convert from the source to
1335 * - takes charset names, not converter objects, so that
1359 * @param toConverterName The name of the converter that is used to convert
1361 * @param fromConverterName The name of the converter that is used to convert
1397 * The source-to-pivot conversion uses the cnv converter parameter.
1398 * The pivot-to-target conversion uses a purely algorithmic converter
1399 * according to the specified type, e.g., UCNV_UTF8 for a UTF-8 converter.
1401 * Internally, the algorithmic converter is opened and closed for each
1403 * but somewhat less efficient than only resetting an existing converter
1412 * charset as a purely algorithmic converter.
1416 * @param cnv The converter that is used to convert
1449 * The source-to-pivot conversion uses a purely algorithmic converter
1450 * according to the specified type, e.g., UCNV_UTF8 for a UTF-8 converter.
1451 * The pivot-to-target conversion uses the cnv converter parameter.
1453 * Internally, the algorithmic converter is opened and closed for each
1455 * but somewhat less efficient than only resetting an existing converter
1463 * @param cnv The converter that is used to convert
1466 * charset as a purely algorithmic converter.
1496 * Frees up memory occupied by unused, cached converter shared data.
1516 * Gets the canonical converter name of the specified converter from a list of
1520 * @param n the index to a converter available on the system (in the range <TT>[0..ucnv_countAvaiable()]</TT>)
1529 * Returns a UEnumeration to enumerate all of the canonical converter
1531 * converter.
1534 * converter names.
1544 * Gives the number of aliases for a given converter or alias name.
1545 * If the alias is ambiguous, then the preferred converter is used
1559 * If the alias is ambiguous, then the preferred converter is used
1574 * If the alias is ambiguous, then the preferred converter is used
1589 * alias names for a given converter that are recognized by a standard.
1598 * @param convName original converter name
1616 * Gives the number of standards associated to converter names.
1634 * Returns a standard name for a given converter name.
1643 * @param name original converter name
1647 * @return returns the standard converter name;
1648 * if a standard converter name cannot be determined,
1656 * This function will return the internal canonical converter name of the
1667 * @return returns the canonical converter name;
1678 * returns the current default converter name.
1680 * @return returns the current default converter name;
1681 * if a default converter name cannot be determined,
1691 * sets the current default converter name. Caller must own the storage for 'name'
1693 * @param name the converter name to be the default (must exist).
1708 * This function will test the converter to see whether such mapping is
1712 * @param cnv The converter representing the target codepage.
1722 * Determines if the converter contains ambiguous mappings of the same
1724 * @param cnv the converter to be tested
1725 * @return TRUE if the converter contains ambiguous mapping of the same
1733 * Sets the converter to use fallback mapping or not.
1734 * @param cnv The converter to set the fallback mapping usage on.
1735 * @param usesFallback TRUE if the user wants the converter to take advantage of the fallback
1743 * Determines if the converter uses fallback mappings or not.
1744 * @param cnv The converter to be tested
1745 * @return TRUE if the converter uses fallback, FALSE otherwise.
1757 * The caller can ucnv_open() a converter using the charset name.