Gecko [ naturenectar.co.uk ]

Name	Size	Permission	Date
alphaindex.h	26.52 KB	-rw-r--r--	2022-12-01 11:12
appendable.h	8.53 KB	-rw-r--r--	2022-12-01 11:12
basictz.h	9.86 KB	-rw-r--r--	2022-12-01 11:12
brkiter.h	27.81 KB	-rw-r--r--	2022-12-01 11:12
bytestream.h	10.75 KB	-rw-r--r--	2022-12-01 11:12
bytestrie.h	20.77 KB	-rw-r--r--	2022-12-01 11:12
bytestriebuilder.h	7.46 KB	-rw-r--r--	2022-12-01 11:12
calendar.h	105.88 KB	-rw-r--r--	2022-12-01 11:12
caniter.h	7.44 KB	-rw-r--r--	2022-12-01 11:12
casemap.h	25.33 KB	-rw-r--r--	2022-12-01 11:12
char16ptr.h	7.22 KB	-rw-r--r--	2022-12-01 11:12
chariter.h	24.06 KB	-rw-r--r--	2022-12-01 11:12
choicfmt.h	23.97 KB	-rw-r--r--	2022-12-01 11:12
coleitr.h	13.77 KB	-rw-r--r--	2022-12-01 11:12
coll.h	56.26 KB	-rw-r--r--	2022-12-01 11:12
compactdecimalformat.h	6.88 KB	-rw-r--r--	2022-12-01 11:12
curramt.h	3.78 KB	-rw-r--r--	2022-12-01 11:12
currpinf.h	7.3 KB	-rw-r--r--	2022-12-01 11:12
currunit.h	4.02 KB	-rw-r--r--	2022-12-01 11:12
datefmt.h	40.71 KB	-rw-r--r--	2022-12-01 11:12
dbbi.h	1.19 KB	-rw-r--r--	2022-12-01 11:12
dcfmtsym.h	20.61 KB	-rw-r--r--	2022-12-01 11:12
decimfmt.h	87.57 KB	-rw-r--r--	2022-12-01 11:12
docmain.h	7.21 KB	-rw-r--r--	2022-12-01 11:12
dtfmtsym.h	38.21 KB	-rw-r--r--	2022-12-01 11:12
dtintrv.h	3.84 KB	-rw-r--r--	2022-12-01 11:12
dtitvfmt.h	49.27 KB	-rw-r--r--	2022-12-01 11:12
dtitvinf.h	18.63 KB	-rw-r--r--	2022-12-01 11:12
dtptngen.h	28.84 KB	-rw-r--r--	2022-12-01 11:12
dtrule.h	8.69 KB	-rw-r--r--	2022-12-01 11:12
edits.h	20.74 KB	-rw-r--r--	2022-12-01 11:12
enumset.h	2.08 KB	-rw-r--r--	2022-12-01 11:12
errorcode.h	4.84 KB	-rw-r--r--	2022-12-01 11:12
fieldpos.h	8.7 KB	-rw-r--r--	2022-12-01 11:12
filteredbrk.h	5.37 KB	-rw-r--r--	2022-12-01 11:12
fmtable.h	24.43 KB	-rw-r--r--	2022-12-01 11:12
format.h	12.5 KB	-rw-r--r--	2022-12-01 11:12
formattedvalue.h	9.75 KB	-rw-r--r--	2022-12-01 11:12
fpositer.h	3.03 KB	-rw-r--r--	2022-12-01 11:12
gender.h	3.33 KB	-rw-r--r--	2022-12-01 11:12
gregocal.h	31.88 KB	-rw-r--r--	2022-12-01 11:12
icudataver.h	1.02 KB	-rw-r--r--	2022-12-01 11:12
icuplug.h	11.83 KB	-rw-r--r--	2022-12-01 11:12
idna.h	12.7 KB	-rw-r--r--	2022-12-01 11:12
listformatter.h	8.79 KB	-rw-r--r--	2022-12-01 11:12
localebuilder.h	11.08 KB	-rw-r--r--	2022-12-01 11:12
localematcher.h	26.84 KB	-rw-r--r--	2022-12-01 11:12
localpointer.h	19.36 KB	-rw-r--r--	2022-12-01 11:12
locdspnm.h	7.12 KB	-rw-r--r--	2022-12-01 11:12
locid.h	47.66 KB	-rw-r--r--	2022-12-01 11:12
measfmt.h	11.42 KB	-rw-r--r--	2022-12-01 11:12
measunit.h	104.97 KB	-rw-r--r--	2022-12-01 11:12
measure.h	4.33 KB	-rw-r--r--	2022-12-01 11:12
messagepattern.h	33.71 KB	-rw-r--r--	2022-12-01 11:12
msgfmt.h	44.22 KB	-rw-r--r--	2022-12-01 11:12
normalizer2.h	33.66 KB	-rw-r--r--	2022-12-01 11:12
normlzr.h	30.95 KB	-rw-r--r--	2022-12-01 11:12
nounit.h	2.25 KB	-rw-r--r--	2022-12-01 11:12
numberformatter.h	94.15 KB	-rw-r--r--	2022-12-01 11:12
numberrangeformatter.h	25.19 KB	-rw-r--r--	2022-12-01 11:12
numfmt.h	49.84 KB	-rw-r--r--	2022-12-01 11:12
numsys.h	7.33 KB	-rw-r--r--	2022-12-01 11:12
parseerr.h	3.08 KB	-rw-r--r--	2022-12-01 11:12
parsepos.h	5.57 KB	-rw-r--r--	2022-12-01 11:12
platform.h	28.09 KB	-rw-r--r--	2022-12-01 11:12
plurfmt.h	25.24 KB	-rw-r--r--	2022-12-01 11:12
plurrule.h	20.82 KB	-rw-r--r--	2022-12-01 11:12
ptypes.h	3.49 KB	-rw-r--r--	2022-12-01 11:12
putil.h	6.32 KB	-rw-r--r--	2022-12-01 11:12
rbbi.h	28.64 KB	-rw-r--r--	2022-12-01 11:12
rbnf.h	48.85 KB	-rw-r--r--	2022-12-01 11:12
rbtz.h	15.77 KB	-rw-r--r--	2022-12-01 11:12
regex.h	84.36 KB	-rw-r--r--	2022-12-01 11:12
region.h	9.18 KB	-rw-r--r--	2022-12-01 11:12
reldatefmt.h	22.22 KB	-rw-r--r--	2022-12-01 11:12
rep.h	9.37 KB	-rw-r--r--	2022-12-01 11:12
resbund.h	18.08 KB	-rw-r--r--	2022-12-01 11:12
schriter.h	6.36 KB	-rw-r--r--	2022-12-01 11:12
scientificnumberformatter.h	6.43 KB	-rw-r--r--	2022-12-01 11:12
search.h	22.22 KB	-rw-r--r--	2022-12-01 11:12
selfmt.h	14.34 KB	-rw-r--r--	2022-12-01 11:12
simpleformatter.h	12.59 KB	-rw-r--r--	2022-12-01 11:12
simpletz.h	45.64 KB	-rw-r--r--	2022-12-01 11:12
smpdtfmt.h	71.07 KB	-rw-r--r--	2022-12-01 11:12
sortkey.h	11.18 KB	-rw-r--r--	2022-12-01 11:12
std_string.h	1.05 KB	-rw-r--r--	2022-12-01 11:12
strenum.h	9.92 KB	-rw-r--r--	2022-12-01 11:12
stringoptions.h	5.79 KB	-rw-r--r--	2022-12-01 11:12
stringpiece.h	10.05 KB	-rw-r--r--	2022-12-01 11:12
stringtriebuilder.h	15.47 KB	-rw-r--r--	2022-12-01 11:12
stsearch.h	21.41 KB	-rw-r--r--	2022-12-01 11:12
symtable.h	4.27 KB	-rw-r--r--	2022-12-01 11:12
tblcoll.h	36.92 KB	-rw-r--r--	2022-12-01 11:12
timezone.h	43.81 KB	-rw-r--r--	2022-12-01 11:12
tmunit.h	3.4 KB	-rw-r--r--	2022-12-01 11:12
tmutamt.h	4.91 KB	-rw-r--r--	2022-12-01 11:12
tmutfmt.h	7.42 KB	-rw-r--r--	2022-12-01 11:12
translit.h	65.82 KB	-rw-r--r--	2022-12-01 11:12
tzfmt.h	42.93 KB	-rw-r--r--	2022-12-01 11:12
tznames.h	16.85 KB	-rw-r--r--	2022-12-01 11:12
tzrule.h	35.6 KB	-rw-r--r--	2022-12-01 11:12
tztrans.h	6.13 KB	-rw-r--r--	2022-12-01 11:12
ubidi.h	89.61 KB	-rw-r--r--	2022-12-01 11:12
ubiditransform.h	12.7 KB	-rw-r--r--	2022-12-01 11:12
ubrk.h	24.43 KB	-rw-r--r--	2022-12-01 11:12
ucal.h	60.68 KB	-rw-r--r--	2022-12-01 11:12
ucasemap.h	15.21 KB	-rw-r--r--	2022-12-01 11:12
ucat.h	5.35 KB	-rw-r--r--	2022-12-01 11:12
uchar.h	144.64 KB	-rw-r--r--	2022-12-01 11:12
ucharstrie.h	22.53 KB	-rw-r--r--	2022-12-01 11:12
ucharstriebuilder.h	7.47 KB	-rw-r--r--	2022-12-01 11:12
uchriter.h	13.42 KB	-rw-r--r--	2022-12-01 11:12
uclean.h	11.2 KB	-rw-r--r--	2022-12-01 11:12
ucnv.h	83.46 KB	-rw-r--r--	2022-12-01 11:12
ucnv_cb.h	6.58 KB	-rw-r--r--	2022-12-01 11:12
ucnv_err.h	20.98 KB	-rw-r--r--	2022-12-01 11:12
ucnvsel.h	6.19 KB	-rw-r--r--	2022-12-01 11:12
ucol.h	61.95 KB	-rw-r--r--	2022-12-01 11:12
ucoleitr.h	9.82 KB	-rw-r--r--	2022-12-01 11:12
uconfig.h	12.07 KB	-rw-r--r--	2022-12-01 11:12
ucpmap.h	5.53 KB	-rw-r--r--	2022-12-01 11:12
ucptrie.h	22.5 KB	-rw-r--r--	2022-12-01 11:12
ucsdet.h	14.69 KB	-rw-r--r--	2022-12-01 11:12
ucurr.h	16.72 KB	-rw-r--r--	2022-12-01 11:12
udat.h	62.4 KB	-rw-r--r--	2022-12-01 11:12
udata.h	15.63 KB	-rw-r--r--	2022-12-01 11:12
udateintervalformat.h	11.93 KB	-rw-r--r--	2022-12-01 11:12
udatpg.h	30.18 KB	-rw-r--r--	2022-12-01 11:12
udisplaycontext.h	5.94 KB	-rw-r--r--	2022-12-01 11:12
uenum.h	7.79 KB	-rw-r--r--	2022-12-01 11:12
ufieldpositer.h	4.41 KB	-rw-r--r--	2022-12-01 11:12
uformattable.h	10.97 KB	-rw-r--r--	2022-12-01 11:12
uformattedvalue.h	12.3 KB	-rw-r--r--	2022-12-01 11:12
ugender.h	2.06 KB	-rw-r--r--	2022-12-01 11:12
uidna.h	33.43 KB	-rw-r--r--	2022-12-01 11:12
uiter.h	22.75 KB	-rw-r--r--	2022-12-01 11:12
uldnames.h	10.48 KB	-rw-r--r--	2022-12-01 11:12
ulistformatter.h	10.78 KB	-rw-r--r--	2022-12-01 11:12
uloc.h	54.63 KB	-rw-r--r--	2022-12-01 11:12
ulocdata.h	11.3 KB	-rw-r--r--	2022-12-01 11:12
umachine.h	16.05 KB	-rw-r--r--	2022-12-01 11:12
umisc.h	1.33 KB	-rw-r--r--	2022-12-01 11:12
umsg.h	24.25 KB	-rw-r--r--	2022-12-01 11:12
umutablecptrie.h	8.29 KB	-rw-r--r--	2022-12-01 11:12
unifilt.h	4 KB	-rw-r--r--	2022-12-01 11:12
unifunct.h	4.05 KB	-rw-r--r--	2022-12-01 11:12
unimatch.h	6.1 KB	-rw-r--r--	2022-12-01 11:12
unirepl.h	3.38 KB	-rw-r--r--	2022-12-01 11:12
uniset.h	66.46 KB	-rw-r--r--	2022-12-01 11:12
unistr.h	170.53 KB	-rw-r--r--	2022-12-01 11:12
unorm.h	20.55 KB	-rw-r--r--	2022-12-01 11:12
unorm2.h	24.68 KB	-rw-r--r--	2022-12-01 11:12
unounclass.h	735 B	-rw-r--r--	2022-12-01 11:12
unum.h	55.31 KB	-rw-r--r--	2022-12-01 11:12
unumberformatter.h	30.28 KB	-rw-r--r--	2022-12-01 11:12
unumberrangeformatter.h	15.37 KB	-rw-r--r--	2022-12-01 11:12
unumsys.h	7.26 KB	-rw-r--r--	2022-12-01 11:12
uobject.h	10.68 KB	-rw-r--r--	2022-12-01 11:12
upluralrules.h	8.79 KB	-rw-r--r--	2022-12-01 11:12
uregex.h	71.99 KB	-rw-r--r--	2022-12-01 11:12
uregion.h	9.81 KB	-rw-r--r--	2022-12-01 11:12
ureldatefmt.h	17.04 KB	-rw-r--r--	2022-12-01 11:12
urename.h	135 KB	-rw-r--r--	2022-12-01 11:12
urep.h	5.38 KB	-rw-r--r--	2022-12-01 11:12
ures.h	36.54 KB	-rw-r--r--	2022-12-01 11:12
uscript.h	27.63 KB	-rw-r--r--	2022-12-01 11:12
usearch.h	39.21 KB	-rw-r--r--	2022-12-01 11:12
uset.h	44.29 KB	-rw-r--r--	2022-12-01 11:12
usetiter.h	9.68 KB	-rw-r--r--	2022-12-01 11:12
ushape.h	18 KB	-rw-r--r--	2022-12-01 11:12
uspoof.h	65.84 KB	-rw-r--r--	2022-12-01 11:12
usprep.h	8.19 KB	-rw-r--r--	2022-12-01 11:12
ustdio.h	38.56 KB	-rw-r--r--	2022-12-01 11:12
ustream.h	1.89 KB	-rw-r--r--	2022-12-01 11:12
ustring.h	72.36 KB	-rw-r--r--	2022-12-01 11:12
ustringtrie.h	3.15 KB	-rw-r--r--	2022-12-01 11:12
utext.h	58.08 KB	-rw-r--r--	2022-12-01 11:12
utf.h	7.87 KB	-rw-r--r--	2022-12-01 11:12
utf16.h	23.35 KB	-rw-r--r--	2022-12-01 11:12
utf32.h	763 B	-rw-r--r--	2022-12-01 11:12
utf8.h	30.83 KB	-rw-r--r--	2022-12-01 11:12
utf_old.h	45.83 KB	-rw-r--r--	2022-12-01 11:12
utmscale.h	13.78 KB	-rw-r--r--	2022-12-01 11:12
utrace.h	17.18 KB	-rw-r--r--	2022-12-01 11:12
utrans.h	25.54 KB	-rw-r--r--	2022-12-01 11:12
utypes.h	31.06 KB	-rw-r--r--	2022-12-01 11:12
uvernum.h	6.68 KB	-rw-r--r--	2022-12-01 11:12
uversion.h	5.99 KB	-rw-r--r--	2022-12-01 11:12
vtzone.h	20.74 KB	-rw-r--r--	2022-12-01 11:12

Rename

/*
******************************************************************************
*
* © 2016 and later: Unicode, Inc. and others.
* License & 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 "unicode/utypes.h"
#include "unicode/ubidi.h"
#include "unicode/uchar.h"

#if U_SHOW_CPLUSPLUS_API
#include "unicode/localpointer.h"
#endif   // U_SHOW_CPLUSPLUS_API

/**
 * \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:
 *
 * - <logical input, visual output>: 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,
 *
 * - <visual input, logical output>: unless the input direction is RTL, this
 * corresponds to an "inverse bidi algorithm" 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,
 *
 * - <logical input, logical output>: 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,
 *
 * - <visual input, visual output>: 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;

/**
 * <code>UBiDiMirroring</code> indicates whether or not characters with the
 * "mirrored" 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 <code>ubidi_writeReordered</code> or
 * <code>ubidi_writeReverse</code> with the
 * <code>UBIDI_DO_MIRRORING</code> option bit set.
 * @stable ICU 58
 */
 UBIDI_MIRRORING_ON
} UBiDiMirroring;

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

/**
 * Deallocates the given <code>UBiDiTransform</code> object.
 * @stable ICU 58
 */
U_CAPI 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