ICU 66.1 66.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"
25
68typedef enum {
80
91typedef enum {
106
113
248U_STABLE uint32_t U_EXPORT2
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
294U_STABLE UBiDiTransform* U_EXPORT2
296
301U_STABLE void U_EXPORT2
303
304#if U_SHOW_CPLUSPLUS_API
305
306U_NAMESPACE_BEGIN
307
318
319U_NAMESPACE_END
320
321#endif
322
323#endif
"Smart pointer" class, closes a UBiDiTransform via ubiditransform_close().
C++ API: "Smart pointers" for use with and in ICU4C C++ code.
#define U_DEFINE_LOCAL_OPEN_POINTER(LocalPointerClassName, Type, closeFunction)
"Smart pointer" definition macro, deletes objects via the closeFunction.
Definition: localpointer.h:562
C API: Bidi algorithm.
uint8_t UBiDiLevel
UBiDiLevel is the type of the level values in this Bidi implementation.
Definition: ubidi.h:336
struct UBiDiTransform UBiDiTransform
Forward declaration of the UBiDiTransform structure that stores information used by the layout transf...
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 bidi...
UBiDiOrder
UBiDiOrder indicates the order of text.
@ UBIDI_LOGICAL
0: Constant indicating a logical order.
@ UBIDI_VISUAL
1: Constant indicating a visual order.
UBiDiTransform * ubiditransform_open(UErrorCode *pErrorCode)
Allocates a UBiDiTransform object.
void ubiditransform_close(UBiDiTransform *pBidiTransform)
Deallocates the given UBiDiTransform object.
UBiDiMirroring
UBiDiMirroring indicates whether or not characters with the "mirrored" property in RTL runs should be...
@ UBIDI_MIRRORING_ON
1: Constant indicating that character mirroring should be performed.
@ UBIDI_MIRRORING_OFF
0: Constant indicating that character mirroring should not be performed.
C API: Unicode Properties.
uint16_t UChar
The base type for UTF-16 code units and pointers.
Definition: umachine.h:378
#define U_STABLE
This is used to declare a function as a stable public ICU C API.
Definition: umachine.h:111
Basic definitions for ICU, for both C and C++ APIs.
UErrorCode
Standard ICU4C error code type, a substitute for exceptions.
Definition: utypes.h:415