Main Page   Class Hierarchy   Alphabetical List   Data Structures   File List   Data Fields   Globals   Related Pages  

ucnv_err.h File Reference

C UConverter predefined error callbacks. More...

#include "unicode/ucnv.h"
#include "unicode/utypes.h"

Go to the source code of this file.

Data Structures

struct  UConverterFromUnicodeArgs
 The structure for the fromUnicode callback function parameter. More...

struct  UConverterToUnicodeArgs
 The structure for the toUnicode callback function parameter. More...


Defines

#define UCNV_SUB_STOP_ON_ILLEGAL   "i"
 FROM_U, TO_U options for sub and skip callbacks ICU 1.8.

#define UCNV_SKIP_STOP_ON_ILLEGAL   "i"
#define UCNV_ESCAPE_ICU   NULL
 FROM_U_CALLBACK_ESCAPE options ICU 1.8.

#define UCNV_ESCAPE_JAVA   "J"
#define UCNV_ESCAPE_C   "C"
#define UCNV_ESCAPE_XML_DEC   "D"
#define UCNV_ESCAPE_XML_HEX   "X"
#define UCNV_ESCAPE_UNICODE   "U"

Enumerations

enum  UConverterCallbackReason {
  UCNV_UNASSIGNED = 0, UCNV_ILLEGAL = 1, UCNV_IRREGULAR = 2, UCNV_RESET = 3,
  UCNV_CLOSE = 4
}
 The process condition code to be used with the callbacks. More...


Functions

U_CAPI void U_EXPORT2 UCNV_FROM_U_CALLBACK_STOP (const void *context, UConverterFromUnicodeArgs *fromUArgs, const UChar *codeUnits, int32_t length, UChar32 codePoint, UConverterCallbackReason reason, UErrorCode *err)
 DO NOT CALL THIS FUNCTION DIRECTLY! This From Unicode callback STOPS at the ILLEGAL_SEQUENCE, returning the error code back to the caller immediately.

U_CAPI void U_EXPORT2 UCNV_TO_U_CALLBACK_STOP (const void *context, UConverterToUnicodeArgs *fromUArgs, const char *codeUnits, int32_t length, UConverterCallbackReason reason, UErrorCode *err)
 DO NOT CALL THIS FUNCTION DIRECTLY! This To Unicode callback STOPS at the ILLEGAL_SEQUENCE, returning the error code back to the caller immediately.

U_CAPI void U_EXPORT2 UCNV_FROM_U_CALLBACK_SKIP (const void *context, UConverterFromUnicodeArgs *fromUArgs, const UChar *codeUnits, int32_t length, UChar32 codePoint, UConverterCallbackReason reason, UErrorCode *err)
 DO NOT CALL THIS FUNCTION DIRECTLY! This From Unicode callback skips any ILLEGAL_SEQUENCE, or skips only UNASSINGED_SEQUENCE depending on the context parameter simply ignoring those characters.

U_CAPI void U_EXPORT2 UCNV_FROM_U_CALLBACK_SUBSTITUTE (const void *context, UConverterFromUnicodeArgs *fromUArgs, const UChar *codeUnits, int32_t length, UChar32 codePoint, UConverterCallbackReason reason, UErrorCode *err)
 DO NOT CALL THIS FUNCTION DIRECTLY! This From Unicode callback will Substitute the ILLEGAL SEQUENCE, or UNASSIGNED_SEQUENCE depending on context parameter, with the current substitution string for the converter.

U_CAPI void U_EXPORT2 UCNV_FROM_U_CALLBACK_ESCAPE (const void *context, UConverterFromUnicodeArgs *fromUArgs, const UChar *codeUnits, int32_t length, UChar32 codePoint, UConverterCallbackReason reason, UErrorCode *err)
 DO NOT CALL THIS FUNCTION DIRECTLY! This From Unicode callback will Substitute the ILLEGAL SEQUENCE with the hexadecimal representation of the illegal codepoints.

U_CAPI void U_EXPORT2 UCNV_TO_U_CALLBACK_SKIP (const void *context, UConverterToUnicodeArgs *fromUArgs, const char *codeUnits, int32_t length, UConverterCallbackReason reason, UErrorCode *err)
 DO NOT CALL THIS FUNCTION DIRECTLY! This To Unicode callback skips any ILLEGAL_SEQUENCE, or skips only UNASSINGED_SEQUENCE depending on the context parameter simply ignoring those characters.

U_CAPI void U_EXPORT2 UCNV_TO_U_CALLBACK_SUBSTITUTE (const void *context, UConverterToUnicodeArgs *fromUArgs, const char *codeUnits, int32_t length, UConverterCallbackReason reason, UErrorCode *err)
 DO NOT CALL THIS FUNCTION DIRECTLY! This To Unicode callback will Substitute the ILLEGAL SEQUENCE,or UNASSIGNED_SEQUENCE depending on context parameter, with the Unicode substitution character, U+FFFD.

U_CAPI void U_EXPORT2 UCNV_TO_U_CALLBACK_ESCAPE (const void *context, UConverterToUnicodeArgs *fromUArgs, const char *codeUnits, int32_t length, UConverterCallbackReason reason, UErrorCode *err)
 DO NOT CALL THIS FUNCTION DIRECTLY! This To Unicode callback will Substitute the ILLEGAL SEQUENCE with the hexadecimal representation of the illegal bytes (in the format XNN, e.g.

Detailed Description

C UConverter predefined error callbacks.

Error Behaviour Fnctions

Defines some error behaviour functions called by ucnv_{from,to}Unicode These are provided as part of ICU and many are stable, but they can also be considered only as an example of what can be done with callbacks. You may of course write your own.

These Functions, although public, should NEVER be called directly, they should be used as parameters to the ucnv_setFromUCallback and ucnv_setToUCallback functions, to set the behaviour of a converter when it encounters ILLEGAL/UNMAPPED/INVALID sequences.

usage example: 'STOP' doesn't need any context, but newContext could be set to something other than 'NULL' if needed.

    UErrorCode err = U_ZERO_ERROR;
    UConverter* myConverter = ucnv_open("ibm-949", &err);
  const void *newContext = NULL;
  const void *oldContext;
  UConverterFromUCallback oldAction;


    if (U_SUCCESS(err))
    {
  ucnv_setFromUCallBack(myConverter,
                       UCNV_FROM_U_CALLBACK_STOP,
                       newContext,
                       &oldAction,
                       &oldContext,
                      &status);
    }

The code above tells "myConverter" to stop when it encounters a ILLEGAL/TRUNCATED/INVALID sequences when it is used to convert from Unicode -> Codepage. The behavior from Codepage to Unicode is not changed.

Enumeration Type Documentation

enum UConverterCallbackReason
 

The process condition code to be used with the callbacks.

Enumeration values:
UCNV_UNASSIGNED  The code point is unassigned.

The error code U_INVALID_CHAR_FOUND will be set.

UCNV_ILLEGAL  The code point is illegal.

For example, is illegal in SJIS because is not a valid trail byte for the lead byte. Also, starting with Unicode 3.0.1, non-shortest byte sequences in UTF-8 (like instead of for U+0061) are also illegal, not just irregular. The error code U_ILLEGAL_CHAR_FOUND will be set.

UCNV_IRREGULAR  The codepoint is not a regular sequence in the encoding.

For example, .. are irregular UTF-8 byte sequences for single surrogate code points. The error code U_INVALID_CHAR_FOUND will be set.

UCNV_RESET  The callback is called with this reason when a 'reset' has occured.

Callback should reset all state.

UCNV_CLOSE  Called when the converter is closed.

The callback should release any allocated memory.

Function Documentation

U_CAPI void U_EXPORT2 UCNV_FROM_U_CALLBACK_ESCAPE (  const void *    context,
UConverterFromUnicodeArgs *    fromUArgs,
const UChar *    codeUnits,
int32_t    length,
UChar32    codePoint,
UConverterCallbackReason    reason,
UErrorCode *    err
) 
 

DO NOT CALL THIS FUNCTION DIRECTLY! This From Unicode callback will Substitute the ILLEGAL SEQUENCE with the hexadecimal representation of the illegal codepoints.

Parameters:
context: the function currently recognizes the callback options:
UCNV_ESCAPE_ICU: Substitues the ILLEGAL SEQUENCE with the hexadecimal representation in the format UXXXX, e.g. "%uFFFE%u00AC%uC8FE"). In the Event the converter doesn't support the characters {u,}[A-F][0-9], it will substitute the illegal sequence with the substitution characters. Note that codeUnit(32bit int eg: unit of a surrogate pair) is represented as UD84D%UDC56 UCNV_ESCAPE_JAVA: Substitues the ILLEGAL SEQUENCE with the hexadecimal representation in the format , e.g. ""). In the Event the converter doesn't support the characters {u,[A-F][0-9], it will substitute the illegal sequence with the substitution characters. Note that codeUnit(32bit int eg: unit of a surrogate pair) is represented as UCNV_ESCAPE_C: Substitues the ILLEGAL SEQUENCE with the hexadecimal representation in the format , e.g. ""). In the Event the converter doesn't support the characters {u,U,[A-F][0-9], it will substitute the illegal sequence with the substitution characters. Note that codeUnit(32bit int eg: unit of a surrogate pair) is represented as UCNV_ESCAPE_XML_DEC: Substitues the ILLEGAL SEQUENCE with the decimal representation in the format &#DDDDDDDD, e.g. "&#65534&#172&#51454"). In the Event the converter doesn't support the characters {&,#}[0-9], it will substitute the illegal sequence with the substitution characters. Note that codeUnit(32bit int eg: unit of a surrogate pair) is represented as &#144470 and Zero padding is ignored. UCNV_ESCAPE_XML_HEX:Substitues the ILLEGAL SEQUENCE with the decimal representation in the format &#xXXXX, e.g. "&#xFFFE&#x00AC&#xC8FE"). In the Event the converter doesn't support the characters {&,#,x}[0-9], it will substitute the illegal sequence with the substitution characters. Note that codeUnit(32bit int eg: unit of a surrogate pair) is represented as &#x23456

U_CAPI void U_EXPORT2 UCNV_FROM_U_CALLBACK_SKIP (  const void *    context,
UConverterFromUnicodeArgs *    fromUArgs,
const UChar *    codeUnits,
int32_t    length,
UChar32    codePoint,
UConverterCallbackReason    reason,
UErrorCode *    err
) 
 

DO NOT CALL THIS FUNCTION DIRECTLY! This From Unicode callback skips any ILLEGAL_SEQUENCE, or skips only UNASSINGED_SEQUENCE depending on the context parameter simply ignoring those characters.

Parameters:
context: the function currently recognizes the callback options: UCNV_SKIP_STOP_ON_ILLEGAL: STOPS at the ILLEGAL_SEQUENCE, returning the error code back to the caller immediately. NULL: Skips any ILLEGAL_SEQUENCE

U_CAPI void U_EXPORT2 UCNV_FROM_U_CALLBACK_STOP (  const void *    context,
UConverterFromUnicodeArgs *    fromUArgs,
const UChar *    codeUnits,
int32_t    length,
UChar32    codePoint,
UConverterCallbackReason    reason,
UErrorCode *    err
) 
 

DO NOT CALL THIS FUNCTION DIRECTLY! This From Unicode callback STOPS at the ILLEGAL_SEQUENCE, returning the error code back to the caller immediately.

U_CAPI void U_EXPORT2 UCNV_FROM_U_CALLBACK_SUBSTITUTE (  const void *    context,
UConverterFromUnicodeArgs *    fromUArgs,
const UChar *    codeUnits,
int32_t    length,
UChar32    codePoint,
UConverterCallbackReason    reason,
UErrorCode *    err
) 
 

DO NOT CALL THIS FUNCTION DIRECTLY! This From Unicode callback will Substitute the ILLEGAL SEQUENCE, or UNASSIGNED_SEQUENCE depending on context parameter, with the current substitution string for the converter.

This is the default callback.

Parameters:
context: the function currently recognizes the callback options: UCNV_SUB_STOP_ON_ILLEGAL: STOPS at the ILLEGAL_SEQUENCE, returning the error code back to the caller immediately. NULL: Substitutes any ILLEGAL_SEQUENCE
See also:
ucnv_setSubstChars

U_CAPI void U_EXPORT2 UCNV_TO_U_CALLBACK_ESCAPE (  const void *    context,
UConverterToUnicodeArgs *    fromUArgs,
const char *    codeUnits,
int32_t    length,
UConverterCallbackReason    reason,
UErrorCode *    err
) 
 

DO NOT CALL THIS FUNCTION DIRECTLY! This To Unicode callback will Substitute the ILLEGAL SEQUENCE with the hexadecimal representation of the illegal bytes (in the format XNN, e.g.

"%XFF%X0A%XC8%X03").

U_CAPI void U_EXPORT2 UCNV_TO_U_CALLBACK_SKIP (  const void *    context,
UConverterToUnicodeArgs *    fromUArgs,
const char *    codeUnits,
int32_t    length,
UConverterCallbackReason    reason,
UErrorCode *    err
) 
 

DO NOT CALL THIS FUNCTION DIRECTLY! This To Unicode callback skips any ILLEGAL_SEQUENCE, or skips only UNASSINGED_SEQUENCE depending on the context parameter simply ignoring those characters.

Parameters:
context: the function currently recognizes the callback options: UCNV_SKIP_STOP_ON_ILLEGAL: STOPS at the ILLEGAL_SEQUENCE, returning the error code back to the caller immediately. NULL: Skips any ILLEGAL_SEQUENCE

U_CAPI void U_EXPORT2 UCNV_TO_U_CALLBACK_STOP (  const void *    context,
UConverterToUnicodeArgs *    fromUArgs,
const char *    codeUnits,
int32_t    length,
UConverterCallbackReason    reason,
UErrorCode *    err
) 
 

DO NOT CALL THIS FUNCTION DIRECTLY! This To Unicode callback STOPS at the ILLEGAL_SEQUENCE, returning the error code back to the caller immediately.

U_CAPI void U_EXPORT2 UCNV_TO_U_CALLBACK_SUBSTITUTE (  const void *    context,
UConverterToUnicodeArgs *    fromUArgs,
const char *    codeUnits,
int32_t    length,
UConverterCallbackReason    reason,
UErrorCode *    err
) 
 

DO NOT CALL THIS FUNCTION DIRECTLY! This To Unicode callback will Substitute the ILLEGAL SEQUENCE,or UNASSIGNED_SEQUENCE depending on context parameter, with the Unicode substitution character, U+FFFD.

Parameters:
context: the function currently recognizes the callback options: UCNV_SUB_STOP_ON_ILLEGAL: STOPS at the ILLEGAL_SEQUENCE, returning the error code back to the caller immediately. NULL: Substitutes any ILLEGAL_SEQUENCE

Generated on Fri Mar 7 20:02:45 2003 for ICU 2.1 by doxygen1.3-rc3