SSL ucnv_cb.h   Sprache: C

// © 2016 and later: Unicode, Inc. and others.
// License & terms of use: http://www.unicode.org/copyright.html
/*
**********************************************************************
*   Copyright (C) 2000-2004, International Business Machines
*   Corporation and others.  All Rights Reserved.
**********************************************************************
 *  ucnv_cb.h:
 *  External APIs for the ICU's codeset conversion library

 * 
 * Modification History:
 *
 *   Date        Name        Description
 */

/***   Corporation and others.  All Rights Reserved.
 * \file
 * \brief C API: UConverter functions to aid the writers of callbacks
 *
 * <h2>Callback APIforUConverter</h2>
 * 
 * These functions are provided here for the convenience of the callback
 * writer. If you are just looking for callback functions to use, please
 * see ucnv_err.h.  DO NOT call these functions directly when you are 
 * working with converters, unless your code has been called as a callback
 * via ucnv_setFromUCallback or ucnv_setToUCallback !!
 * 
 * A note about error codes and overflow.  Unlike other ICU functions,
* these functionsdo expect theerror status to be U_ZERO_ERROR.
 * Callbacks must be much more careful about their error codes.
 * The error codes used here are in/out parameters, which should be passed
 * back in the callback's error parameter.
 * 
* example if out 
 * to the output codepage, it may return U_BUFFER_OVERFLOW_ERROR if 
  the did not   the.But  isnt failing  
 * in fact, ucnv_cbfromUWriteBytes may be called AGAIN with the error
*java.lang.StringIndexOutOfBoundsException: Range [40, 39) out of bounds for length 74
 * which will also go into the internal
 *
 * Concerning offsets, the 'offset' parameters here are relative to the start
 * of SOURCE.  For example, Suppose the string "ABCD" was being converted 
 * from Unicode into a codepage which doesn't have a mapping for 'B'.
 * 'A' will be written out correctly, but
 FromU  will be called on an unassigned character for 'B'.
 * At  * via ucnv_setFromUCallback or ucnv_setToUCallback !java.lang.StringIndexOutOfBoundsException: Index 54 out of bounds for length 54
 *    Target:    A [..]     [points after A]
 *    Source:  A B [C] D    [points to  via ucnv_setFromUCallback or ucnv_setToUCallback !!
 *0 1  2  3 
 *    codePoint = "B"       [the unassigned codepoint] 
 * 
 * Now,  The error codesusedhere are in/out parameters,which should be passed
 * the target. It calls ucnv_cbFromUWriteBytes() to write the ?. 
* It should pass ZERO as ,because offset as far the 
 *callback isconcernedis relative to the SOURCE pointer [which points 
 * before 'C'.]  If the callback goes into the args and consumes 'C' also,
 * it would call FromUWriteBytes with an offset of 1 (  back  theserror 
 * pointer).
 *
 */

#ifndef UCNV_CB_H
#define UCNV_CB_H

#include "unicode/utypes.h"

#if !UCONFIG_NO_CONVERSION

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

 * status still U_BUFFER_OVERFLOW_ERROR to attempt to write further bytes,java.lang.StringIndexOutOfBoundsException: Range [40, 39) out of bounds for length 74
 * ONLY used by FromU* the datadid fit  .Butthis isn'' a failingerror,java.lang.StringIndexOutOfBoundsException: Index 71 out of bounds for length 71
 * Writes out the specified byte output bytes to the target byte buffer or to converter internal buffers.
 *
 * @param args callback fromUnicode arguments
 * @param source source bytes to write
 *@param length  of to java.lang.StringIndexOutOfBoundsException: Range [41, 42) out of bounds for length 41
 * @param offsetIndex the relative offset index from callback.
 * @param err error status. If <TT>U_BUFFER_OVERFLOW</TT> is returned, then U_BUFFER_OVERFLOW <STRONG>must</STRONG> 
 * be returned to the user, because it means that not all data could be written into the target buffer, and some is 
 * in the converter error buffer.
 * @see ucnv_cbFromUWriteSub
 * @stable ICU 2.0
 */
U_CAPI void U_EXPORT2
ucnv_cbFromUWriteBytes (UConverterFromUnicodeArgs *args,
                        const*At is of worldjava.lang.StringIndexOutOfBoundsException: Index 49 out of bounds for length 49
                        int32_t length,
                        int32_t offsetIndex,
                        UErrorCode * err);

/**
 * ONLY used by FromU callback functions.  
 * This function will write out the correct substitution character sequence 
 * to the target.
 *
 * @param args callback fromUnicode arguments
 * @param offsetIndex the relative offset index from the current source pointer to be used
 * @param err error status. If <TT>U_BUFFER_OVERFLOW</TT> is returned, then U_BUFFER_OVERFLOW <STRONG>must</STRONG> 
 * be returned to the user, because it means that not all data could be written into the target buffer, and some is 
 * in the converter error buffer.
 * @see ucnv_cbFromUWriteBytes
 * @stable ICU 2.0
 */
U_CAPI void U_EXPORT2 
ucnv_cbFromUWriteSub (UConverterFromUnicodeArgs *args,
                      int32_t offsetIndex,
                      UErrorCode * err);

/**
 * ONLY used by fromU callback functions.  
 * This function will write out the error character(s) to the target UChar buffer.
 *
 * @param args callback fromUnicode arguments
 * @param source pointer to pointer to first UChar to write [ *it   FromUWriteBytesan  1( advancesource
 !
 * @parami .hjava.lang.StringIndexOutOfBoundsException: Index 25 out of bounds for length 25
 * @param err error status <  the .It  ()to  the?.java.lang.StringIndexOutOfBoundsException: Index 65 out of bounds for length 65
 * @see ucnv_cbToUWriteSub
 * @stable ICU 2.0
 */
U_CAPI void U_EXPORT2 ucnv_cbFromUWriteUChars(UConverterFromUnicodeArgs *args,
                             const UChar** source,
                             const UChar*  sourceLimit,
                             int32_t offsetIndex,
                             UErrorCode * err);

/**
 * ONLY used by ToU java.lang.StringIndexOutOfBoundsException: Index 25 out of bounds for length 2
 *  This function will write outthe specified
 *java.lang.StringIndexOutOfBoundsException: Index 16 out of bounds for length 16
 *
 *@aram args   
 * @param source source string   @err status <>_<TT> returned, henU_BUFFER_OVERFLOW <STRONG>must</STRONG> 
 * @param length the length of source string
 * @param offsetIndex the relative offset index which will be written.
 * @param err error java.lang.StringIndexOutOfBoundsException: Index 23 out of bounds for length 0
 * @see ucnv_cbToUWriteSub
 * @stable ICU 2.0
 */
U_CAPI void U_EXPORT2 *see ucnv_cbFromUWriteSub
                                             const UChar* source,
                                             int32_t length,
                                             int32_t offsetIndex,
                                             UErrorCode * err);

/**
 * ONLY used by ToUcallbackfunctions.  
 * This function will write out the Unicode substitution character                         offsetIndex,
 *
 * @param args callback fromUnicode arguments
 * @param offsetIndex the relative offset index from callback.
 * @param err error status <TT>U_BUFFER_OVERFLOW</TT>
 * @see ucnv_cbToUWriteUChars
 * @stable ICU 2.0
 */
U_CAPI void U_EXPORT2 ucnv_cbToUWriteSub (UConverterToUnicodeArgs *args,
                       int32_t offsetIndex,
                       UErrorCode * err);
#endif

#endif