* In terms of UBiDi, such a transformation implies: *

*
• calling ubidi_setReorderingMode as needed (when the * reordering mode is other than normal),
*
• calling ubidi_setInverse as needed (when text should be * transformed from a visual to a logical form),
*
• resolving embedding levels of each character in the input text by * calling ubidi_setPara,
*
• reordering the characters based on the computed embedding levels, also * performing character mirroring as needed, and streaming the result to the * output, by calling ubidi_writeReordered,
*
• performing Arabic digit and letter shaping on the output text by calling * u_shapeArabic.
*

* There are 36 possible combinations of ordering schemes, * which are partially supported by UBiDi already. Examples of the * currently supported combinations: *

*
• : this is equivalent to calling * ubidi_setPara with paraLevel == UBIDI_LTR,
*
• : this is equivalent to calling * ubidi_setPara with paraLevel == UBIDI_RTL,
*
• : this is equivalent to * calling ubidi_setPara with * paraLevel == UBIDI_DEFAULT_LTR,
*
• : this is equivalent to * calling ubidi_setPara with * paraLevel == UBIDI_DEFAULT_RTL,
*
• : this is equivalent to * calling ubidi_setInverse(UBiDi*, TRUE) and then * ubidi_setPara with paraLevel == UBIDI_LTR,
*
• : this is equivalent to * calling ubidi_setInverse(UBiDi*, TRUE) and then * ubidi_setPara with paraLevel == UBIDI_RTL.
*

*
• ,
*
• .
*

Example of usage of the transformation engine:
*

 * \code
 * UChar text1[] = {'a', 'b', 'c', 0x0625, '1', 0};
 * UChar text2[] = {'a', 'b', 'c', 0x0625, '1', 0};
 * UErrorCode errorCode = U_ZERO_ERROR;
 * // Run a transformation.
 * ubiditransform_transform(pBidiTransform,
 *          text1, -1, text2, -1,
 *          UBIDI_LTR, UBIDI_VISUAL,
 *          UBIDI_RTL, UBIDI_LOGICAL,
 *          UBIDI_MIRRORING_OFF,
 *          U_SHAPE_DIGITS_AN2EN | U_SHAPE_DIGIT_TYPE_AN_EXTENDED,
 *          &errorCode);
 * // Do something with text2.
 *  text2[4] = '2';
 * // Run a reverse transformation.
 * ubiditransform_transform(pBidiTransform,
 *          text2, -1, text1, -1,
 *          UBIDI_RTL, UBIDI_LOGICAL,
 *          UBIDI_LTR, UBIDI_VISUAL,
 *          UBIDI_MIRRORING_OFF,
 *          U_SHAPE_DIGITS_EN2AN | U_SHAPE_DIGIT_TYPE_AN_EXTENDED,
 *          &errorCode);
 *\endcode
 * 

* This object serves for one-time setup to amortize initialization * overheads. Use of this object is not thread-safe. All other threads * should allocate a new UBiDiTransform object by calling * ubiditransform_open() before using it. Alternatively, * a caller can set this parameter to NULL, in which case * the object will be allocated by the engine on the fly.

Note: the text must be (at least) * srcLength long.

destSize == -1 is allowed and makes sense when * dest was holds some meaningful value, e.g. that of * src. In this case dest must be * zero-terminated.

Note: Direction indicator options are computed by * the transformation engine based on the effective ordering schemes, so * user-defined direction indicators will be ignored.

* Note:The object can only be reused in the same thread. * All other threads should allocate a new UBiDiTransform object * before using it.

* Example of usage:

*

 * \code
 * UErrorCode errorCode = U_ZERO_ERROR;
 * // Open a new UBiDiTransform.
 * UBiDiTransform* transform = ubiditransform_open(&errorCode);
 * // Run a transformation.
 * ubiditransform_transform(transform,
 *          text1, -1, text2, -1,
 *          UBIDI_RTL, UBIDI_LOGICAL,
 *          UBIDI_LTR, UBIDI_VISUAL,
 *          UBIDI_MIRRORING_ON,
 *          U_SHAPE_DIGITS_EN2AN,
 *          &errorCode);
 * // Do something with the output text and invoke another transformation using
 * //   that text as input.
 * ubiditransform_transform(transform,
 *          text2, -1, text3, -1,
 *          UBIDI_LTR, UBIDI_VISUAL,
 *          UBIDI_RTL, UBIDI_VISUAL,
 *          UBIDI_MIRRORING_ON,
 *          0, &errorCode);
 *\endcode
 * 

* The UBiDiTransform object must be deallocated by calling * ubiditransform_close(). * * @return An empty UBiDiTransform object. * @stable ICU 58 */ U_STABLE UBiDiTransform* U_EXPORT2 ubiditransform_open(UErrorCode *pErrorCode); /** * Deallocates the given UBiDiTransform object. * @stable ICU 58 */ U_STABLE void U_EXPORT2 ubiditransform_close(UBiDiTransform *pBidiTransform); #if U_SHOW_CPLUSPLUS_API U_NAMESPACE_BEGIN /** * \class LocalUBiDiTransformPointer * "Smart pointer" class, closes a UBiDiTransform via ubiditransform_close(). * For most methods see the LocalPointerBase base class. * * @see LocalPointerBase * @see LocalPointer * @stable ICU 58 */ U_DEFINE_LOCAL_OPEN_POINTER(LocalUBiDiTransformPointer, UBiDiTransform, ubiditransform_close); U_NAMESPACE_END #endif #endif