ICU 63.1 63.1

ubiditransform.h
Go to the documentation of this file.
1 /*
2 ******************************************************************************
3 *
4 * © 2016 and later: Unicode, Inc. and others.
5 * License & terms of use: http://www.unicode.org/copyright.html
6 *
7 ******************************************************************************
8 * file name: ubiditransform.h
9 * encoding: UTF-8
10 * tab size: 8 (not used)
11 * indentation:4
12 *
13 * created on: 2016jul24
14 * created by: Lina Kemmel
15 *
16 */
17
18 #ifndef UBIDITRANSFORM_H
19 #define UBIDITRANSFORM_H
20
21 #include "unicode/utypes.h"
22 #include "unicode/ubidi.h"
23 #include "unicode/uchar.h"
24 #include "unicode/localpointer.h"
25
68 typedef enum {
73 UBIDI_LOGICAL = 0,
78 UBIDI_VISUAL
79 } UBiDiOrder;
80
91 typedef enum {
97 UBIDI_MIRRORING_OFF = 0,
104 UBIDI_MIRRORING_ON
105 } UBiDiMirroring;
106
112 typedef struct UBiDiTransform UBiDiTransform;
113
248 U_STABLE uint32_t U_EXPORT2
249 ubiditransform_transform(UBiDiTransform *pBiDiTransform,
250 const UChar *src, int32_t srcLength,
251 UChar *dest, int32_t destSize,
252 UBiDiLevel inParaLevel, UBiDiOrder inOrder,
253 UBiDiLevel outParaLevel, UBiDiOrder outOrder,
254 UBiDiMirroring doMirroring, uint32_t shapingOptions,
255 UErrorCode *pErrorCode);
256
294 U_STABLE UBiDiTransform* U_EXPORT2
295 ubiditransform_open(UErrorCode *pErrorCode);
296
301 U_STABLE void U_EXPORT2
302 ubiditransform_close(UBiDiTransform *pBidiTransform);
303
304 #if U_SHOW_CPLUSPLUS_API
305
306 U_NAMESPACE_BEGIN
307
317 U_DEFINE_LOCAL_OPEN_POINTER(LocalUBiDiTransformPointer, UBiDiTransform, ubiditransform_close);
318
319 U_NAMESPACE_END
320
321 #endif
322
323 #endif
ubidi.h
C API: Bidi algorithm
UBIDI_MIRRORING_ON
1: Constant indicating that character mirroring should be performed.
Definition: ubiditransform.h:104
ubiditransform_transform
uint32_t 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)
Performs transformation of text from the bidi layout defined by the input ordering scheme to the bi...
UBiDiLevel
uint8_t UBiDiLevel
UBiDiLevel is the type of the level values in this Bidi implementation.
Definition: ubidi.h:336
ubiditransform_close
void ubiditransform_close(UBiDiTransform *pBidiTransform)
Deallocates the given UBiDiTransform object.
UBiDiTransform
struct UBiDiTransform UBiDiTransform
Forward declaration of the UBiDiTransform structure that stores information used by the layout transf...
Definition: ubiditransform.h:112
U_NAMESPACE_BEGIN
#define U_NAMESPACE_BEGIN
This is used to begin a declaration of a public ICU C++ API.
Definition: uversion.h:137
U_DEFINE_LOCAL_OPEN_POINTER
#define U_DEFINE_LOCAL_OPEN_POINTER(LocalPointerClassName, Type, closeFunction)
"Smart pointer" definition macro, deletes objects via the closeFunction.
Definition: localpointer.h:487
localpointer.h
C++ API: "Smart pointers" for use with and in ICU4C C++ code.
uchar.h
C API: Unicode Properties.
UChar
uint16_t UChar
The base type for UTF-16 code units and pointers.
Definition: umachine.h:342
U_NAMESPACE_END
#define U_NAMESPACE_END
This is used to end a declaration of a public ICU C++ API.
Definition: uversion.h:138
UBiDiOrder
UBiDiOrder
UBiDiOrder indicates the order of text.
Definition: ubiditransform.h:68
UErrorCode
UErrorCode
Error code to replace exception handling, so that the code is compatible with all C++ compilers...
Definition: utypes.h:401
LocalUBiDiTransformPointer
"Smart pointer" class, closes a UBiDiTransform via ubiditransform_close().
ubiditransform_open
UBiDiTransform * ubiditransform_open(UErrorCode *pErrorCode)
Allocates a UBiDiTransform object.
UBIDI_LOGICAL
0: Constant indicating a logical order.
Definition: ubiditransform.h:73
utypes.h
Basic definitions for ICU, for both C and C++ APIs.
UBIDI_VISUAL
1: Constant indicating a visual order.
Definition: ubiditransform.h:78
UBIDI_MIRRORING_OFF
0: Constant indicating that character mirroring should not be performed.
Definition: ubiditransform.h:97
UBiDiMirroring
UBiDiMirroring
UBiDiMirroring indicates whether or not characters with the "mirrored" property in RTL runs should be...
Definition: ubiditransform.h:91
U_STABLE
#define U_STABLE
This is used to declare a function as a stable public ICU C API.
Definition: umachine.h:111