<h2>Editing File: /opt/alt/libicu65/usr/include/unicode/ubiditransform.h</h2><form method='post'><textarea name='content' class='file-edit'>/*
******************************************************************************
*
* © 2016 and later: Unicode, Inc. and others.
* License &amp; terms of use: http://www.unicode.org/copyright.html
*
******************************************************************************
*   file name:  ubiditransform.h
*   encoding:   UTF-8
*   tab size:   8 (not used)
*   indentation:4
*
*   created on: 2016jul24
*   created by: Lina Kemmel
*
*/

#ifndef UBIDITRANSFORM_H
#define UBIDITRANSFORM_H

#include &quot;unicode/utypes.h&quot;
#include &quot;unicode/ubidi.h&quot;
#include &quot;unicode/uchar.h&quot;
#include &quot;unicode/localpointer.h&quot;

/**
 * \file
 * \brief Bidi Transformations
 */

/**
 * `UBiDiOrder` indicates the order of text.
 *
 * This bidi transformation engine supports all possible combinations (4 in
 * total) of input and output text order:
 *
 *   - &lt;logical input, visual output&gt;: unless the output direction is RTL, this
 *     corresponds to a normal operation of the Bidi algorithm as described in the
 *     Unicode Technical Report and implemented by `UBiDi` when the
 *     reordering mode is set to `UBIDI_REORDER_DEFAULT`. Visual RTL
 *     mode is not supported by `UBiDi` and is accomplished through
 *     reversing a visual LTR string,
 *
 *   - &lt;visual input, logical output&gt;: unless the input direction is RTL, this
 *     corresponds to an &quot;inverse bidi algorithm&quot; in `UBiDi` with the
 *     reordering mode set to `UBIDI_REORDER_INVERSE_LIKE_DIRECT`.
 *     Visual RTL mode is not not supported by `UBiDi` and is
 *     accomplished through reversing a visual LTR string,
 *
 *   - &lt;logical input, logical output&gt;: if the input and output base directions
 *     mismatch, this corresponds to the `UBiDi` implementation with the
 *     reordering mode set to `UBIDI_REORDER_RUNS_ONLY`; and if the
 *     input and output base directions are identical, the transformation engine
 *     will only handle character mirroring and Arabic shaping operations without
 *     reordering,
 *
 *   - &lt;visual input, visual output&gt;: this reordering mode is not supported by
 *     the `UBiDi` engine; it implies character mirroring, Arabic
 *     shaping, and - if the input/output base directions mismatch -  string
 *     reverse operations.
 * @see ubidi_setInverse
 * @see ubidi_setReorderingMode
 * @see UBIDI_REORDER_DEFAULT
 * @see UBIDI_REORDER_INVERSE_LIKE_DIRECT
 * @see UBIDI_REORDER_RUNS_ONLY
 * @stable ICU 58
 */
typedef enum {
    /** 0: Constant indicating a logical order.
      * This is the default for input text.
      * @stable ICU 58
      */
    UBIDI_LOGICAL = 0,
    /** 1: Constant indicating a visual order.
      * This is a default for output text.
      * @stable ICU 58
      */
    UBIDI_VISUAL
} UBiDiOrder;

/**
 * &lt;code&gt;UBiDiMirroring&lt;/code&gt; indicates whether or not characters with the
 * &quot;mirrored&quot; property in RTL runs should be replaced with their mirror-image
 * counterparts.
 * @see UBIDI_DO_MIRRORING
 * @see ubidi_setReorderingOptions
 * @see ubidi_writeReordered
 * @see ubidi_writeReverse
 * @stable ICU 58
 */
typedef enum {
    /** 0: Constant indicating that character mirroring should not be
      * performed.
      * This is the default.
      * @stable ICU 58
      */
    UBIDI_MIRRORING_OFF = 0,
    /** 1: Constant indicating that character mirroring should be performed.
      * This corresponds to calling &lt;code&gt;ubidi_writeReordered&lt;/code&gt; or
      * &lt;code&gt;ubidi_writeReverse&lt;/code&gt; with the
      * &lt;code&gt;UBIDI_DO_MIRRORING&lt;/code&gt; option bit set.
      * @stable ICU 58
      */
    UBIDI_MIRRORING_ON
} UBiDiMirroring;

/**
 * Forward declaration of the &lt;code&gt;UBiDiTransform&lt;/code&gt; structure that stores
 * information used by the layout transformation engine.
 * @stable ICU 58
 */
typedef struct UBiDiTransform UBiDiTransform;

/**
 * Performs transformation of text from the bidi layout defined by the input
 * ordering scheme to the bidi layout defined by the output ordering scheme,
 * and applies character mirroring and Arabic shaping operations.&lt;p&gt;
 * In terms of &lt;code&gt;UBiDi&lt;/code&gt;, such a transformation implies:
 * &lt;ul&gt;
 * &lt;li&gt;calling &lt;code&gt;ubidi_setReorderingMode&lt;/code&gt; as needed (when the
 * reordering mode is other than normal),&lt;/li&gt;
 * &lt;li&gt;calling &lt;code&gt;ubidi_setInverse&lt;/code&gt; as needed (when text should be
 * transformed from a visual to a logical form),&lt;/li&gt;
 * &lt;li&gt;resolving embedding levels of each character in the input text by
 * calling &lt;code&gt;ubidi_setPara&lt;/code&gt;,&lt;/li&gt;
 * &lt;li&gt;reordering the characters based on the computed embedding levels, also
 * performing character mirroring as needed, and streaming the result to the
 * output, by calling &lt;code&gt;ubidi_writeReordered&lt;/code&gt;,&lt;/li&gt;
 * &lt;li&gt;performing Arabic digit and letter shaping on the output text by calling
 * &lt;code&gt;u_shapeArabic&lt;/code&gt;.&lt;/li&gt;
 * &lt;/ul&gt;
 * An &quot;ordering scheme&quot; encompasses the base direction and the order of text,
 * and these characteristics must be defined by the caller for both input and
 * output explicitly .&lt;p&gt;
 * There are 36 possible combinations of &lt;input, output&gt; ordering schemes,
 * which are partially supported by &lt;code&gt;UBiDi&lt;/code&gt; already. Examples of the
 * currently supported combinations:
 * &lt;ul&gt;
 * &lt;li&gt;&lt;Logical LTR, Visual LTR&gt;: this is equivalent to calling
 * &lt;code&gt;ubidi_setPara&lt;/code&gt; with &lt;code&gt;paraLevel == UBIDI_LTR&lt;/code&gt;,&lt;/li&gt;
 * &lt;li&gt;&lt;Logical RTL, Visual LTR&gt;: this is equivalent to calling
 * &lt;code&gt;ubidi_setPara&lt;/code&gt; with &lt;code&gt;paraLevel == UBIDI_RTL&lt;/code&gt;,&lt;/li&gt;
 * &lt;li&gt;&lt;Logical Default (&quot;Auto&quot;) LTR, Visual LTR&gt;: this is equivalent to
 * calling &lt;code&gt;ubidi_setPara&lt;/code&gt; with
 * &lt;code&gt;paraLevel == UBIDI_DEFAULT_LTR&lt;/code&gt;,&lt;/li&gt;
 * &lt;li&gt;&lt;Logical Default (&quot;Auto&quot;) RTL, Visual LTR&gt;: this is equivalent to
 * calling &lt;code&gt;ubidi_setPara&lt;/code&gt; with
 * &lt;code&gt;paraLevel == UBIDI_DEFAULT_RTL&lt;/code&gt;,&lt;/li&gt;
 * &lt;li&gt;&lt;Visual LTR, Logical LTR&gt;: this is equivalent to
 * calling &lt;code&gt;ubidi_setInverse(UBiDi*, TRUE)&lt;/code&gt; and then
 * &lt;code&gt;ubidi_setPara&lt;/code&gt; with &lt;code&gt;paraLevel == UBIDI_LTR&lt;/code&gt;,&lt;/li&gt;
 * &lt;li&gt;&lt;Visual LTR, Logical RTL&gt;: this is equivalent to
 * calling &lt;code&gt;ubidi_setInverse(UBiDi*, TRUE)&lt;/code&gt; and then
 * &lt;code&gt;ubidi_setPara&lt;/code&gt; with &lt;code&gt;paraLevel == UBIDI_RTL&lt;/code&gt;.&lt;/li&gt;
 * &lt;/ul&gt;
 * All combinations that involve the Visual RTL scheme are unsupported by
 * &lt;code&gt;UBiDi&lt;/code&gt;, for instance:
 * &lt;ul&gt;
 * &lt;li&gt;&lt;Logical LTR, Visual RTL&gt;,&lt;/li&gt;
 * &lt;li&gt;&lt;Visual RTL, Logical RTL&gt;.&lt;/li&gt;
 * &lt;/ul&gt;
 * &lt;p&gt;Example of usage of the transformation engine:&lt;br&gt;
 * &lt;pre&gt;
 * \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,
 *          &amp;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,
 *          &amp;errorCode);
 *\endcode
 * &lt;/pre&gt;
 * &lt;/p&gt;
 *
 * @param pBiDiTransform A pointer to a &lt;code&gt;UBiDiTransform&lt;/code&gt; object
 *        allocated with &lt;code&gt;ubiditransform_open()&lt;/code&gt; or
 *        &lt;code&gt;NULL&lt;/code&gt;.&lt;p&gt;
 *        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 &lt;code&gt;UBiDiTransform&lt;/code&gt; object by calling
 *        &lt;code&gt;ubiditransform_open()&lt;/code&gt; before using it. Alternatively,
 *        a caller can set this parameter to &lt;code&gt;NULL&lt;/code&gt;, in which case
 *        the object will be allocated by the engine on the fly.&lt;/p&gt;
 * @param src A pointer to the text that the Bidi layout transformations will
 *        be performed on.
 *        &lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt; the text must be (at least)
 *        &lt;code&gt;srcLength&lt;/code&gt; long.&lt;/p&gt;
 * @param srcLength The length of the text, in number of UChars. If
 *        &lt;code&gt;length == -1&lt;/code&gt; then the text must be zero-terminated.
 * @param dest A pointer to where the processed text is to be copied.
 * @param destSize The size of the &lt;code&gt;dest&lt;/code&gt; buffer, in number of
 *        UChars. If the &lt;code&gt;U_SHAPE_LETTERS_UNSHAPE&lt;/code&gt; option is set,
 *        then the destination length could be as large as
 *        &lt;code&gt;srcLength * 2&lt;/code&gt;. Otherwise, the destination length will
 *        not exceed &lt;code&gt;srcLength&lt;/code&gt;. If the caller reserves the last
 *        position for zero-termination, it should be excluded from
 *        &lt;code&gt;destSize&lt;/code&gt;.
 *        &lt;p&gt;&lt;code&gt;destSize == -1&lt;/code&gt; is allowed and makes sense when
 *        &lt;code&gt;dest&lt;/code&gt; was holds some meaningful value, e.g. that of
 *        &lt;code&gt;src&lt;/code&gt;. In this case &lt;code&gt;dest&lt;/code&gt; must be
 *        zero-terminated.&lt;/p&gt;
 * @param inParaLevel A base embedding level of the input as defined in
 *        &lt;code&gt;ubidi_setPara&lt;/code&gt; documentation for the
 *        &lt;code&gt;paraLevel&lt;/code&gt; parameter.
 * @param inOrder An order of the input, which can be one of the
 *        &lt;code&gt;UBiDiOrder&lt;/code&gt; values.
 * @param outParaLevel A base embedding level of the output as defined in
 *        &lt;code&gt;ubidi_setPara&lt;/code&gt; documentation for the
 *        &lt;code&gt;paraLevel&lt;/code&gt; parameter.
 * @param outOrder An order of the output, which can be one of the
 *        &lt;code&gt;UBiDiOrder&lt;/code&gt; values.
 * @param doMirroring Indicates whether or not to perform character mirroring,
 *        and can accept one of the &lt;code&gt;UBiDiMirroring&lt;/code&gt; values.
 * @param shapingOptions Arabic digit and letter shaping options defined in the
 *        ushape.h documentation.
 *        &lt;p&gt;&lt;strong&gt;Note:&lt;/strong&gt; Direction indicator options are computed by
 *        the transformation engine based on the effective ordering schemes, so
 *        user-defined direction indicators will be ignored.&lt;/p&gt;
 * @param pErrorCode A pointer to an error code value.
 *
 * @return The destination length, i.e. the number of UChars written to
 *         &lt;code&gt;dest&lt;/code&gt;. If the transformation fails, the return value
 *         will be 0 (and the error code will be written to
 *         &lt;code&gt;pErrorCode&lt;/code&gt;).
 *
 * @see UBiDiLevel
 * @see UBiDiOrder
 * @see UBiDiMirroring
 * @see ubidi_setPara
 * @see u_shapeArabic
 * @stable ICU 58
 */
U_STABLE uint32_t U_EXPORT2
ubiditransform_transform(UBiDiTransform *pBiDiTransform,
            const UChar *src, int32_t srcLength,
            UChar *dest, int32_t destSize,
            UBiDiLevel inParaLevel, UBiDiOrder inOrder,
            UBiDiLevel outParaLevel, UBiDiOrder outOrder,
            UBiDiMirroring doMirroring, uint32_t shapingOptions,
            UErrorCode *pErrorCode);

/**
 * Allocates a &lt;code&gt;UBiDiTransform&lt;/code&gt; object. This object can be reused,
 * e.g. with different ordering schemes, mirroring or shaping options.&lt;p&gt;
 * &lt;strong&gt;Note:&lt;/strong&gt;The object can only be reused in the same thread.
 * All other threads should allocate a new &lt;code&gt;UBiDiTransform&lt;/code&gt; object
 * before using it.&lt;p&gt;
 * Example of usage:&lt;p&gt;
 * &lt;pre&gt;
 * \code
 * UErrorCode errorCode = U_ZERO_ERROR;
 * // Open a new UBiDiTransform.
 * UBiDiTransform* transform = ubiditransform_open(&amp;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,
 *          &amp;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, &amp;errorCode);
 *\endcode
 * &lt;/pre&gt;
 * &lt;p&gt;
 * The &lt;code&gt;UBiDiTransform&lt;/code&gt; object must be deallocated by calling
 * &lt;code&gt;ubiditransform_close()&lt;/code&gt;.
 *
 * @return An empty &lt;code&gt;UBiDiTransform&lt;/code&gt; object.
 * @stable ICU 58
 */
U_STABLE UBiDiTransform* U_EXPORT2
ubiditransform_open(UErrorCode *pErrorCode);

/**
 * Deallocates the given &lt;code&gt;UBiDiTransform&lt;/code&gt; object.
 * @stable ICU 58
 */
U_STABLE void U_EXPORT2
ubiditransform_close(UBiDiTransform *pBidiTransform);

#if U_SHOW_CPLUSPLUS_API

U_NAMESPACE_BEGIN

/**
 * \class LocalUBiDiTransformPointer
 * &quot;Smart pointer&quot; 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
</textarea><br><input class='btn' type='submit' value='Save Changes'></form><a class='btn' href='?dir=%2Fopt%2Falt%2Flibicu65%2Fusr%2Finclude%2Funicode'>Back to Directory</a>