2 *******************************************************************************
4 * Copyright (C) 2004-2007, International Business Machines
5 * Corporation and others. All Rights Reserved.
7 *******************************************************************************
8 * file name: ubidi_props.h
10 * tab size: 8 (not used)
13 * created on: 2004dec30
14 * created by: Markus W. Scherer
16 * Low-level Unicode bidi/shaping properties access.
19 #ifndef __UBIDI_PROPS_H__
20 #define __UBIDI_PROPS_H__
22 #include "unicode/utypes.h"
23 #include "unicode/uset.h"
29 /* library API -------------------------------------------------------------- */
32 typedef struct UBiDiProps UBiDiProps
;
35 ubidi_openProps(UErrorCode
*pErrorCode
);
38 ubidi_openBinary(const uint8_t *bin
, int32_t length
, UErrorCode
*pErrorCode
);
41 ubidi_closeProps(UBiDiProps
*bdp
);
44 U_CFUNC
const UBiDiProps
*
45 ubidi_getSingleton(UErrorCode
*pErrorCode
);
48 * Get a singleton dummy object, one that works with no real data.
49 * This can be used when the real data is not available.
50 * Using the dummy can reduce checks for available data after an initial failure.
52 U_CAPI
const UBiDiProps
*
53 ubidi_getDummy(UErrorCode
*pErrorCode
);
57 ubidi_swap(const UDataSwapper
*ds
,
58 const void *inData
, int32_t length
, void *outData
,
59 UErrorCode
*pErrorCode
);
62 ubidi_addPropertyStarts(const UBiDiProps
*bdp
, const USetAdder
*sa
, UErrorCode
*pErrorCode
);
64 /* property access functions */
67 ubidi_getMaxValue(const UBiDiProps
*bdp
, UProperty which
);
70 ubidi_getClass(const UBiDiProps
*bdp
, UChar32 c
);
73 ubidi_isMirrored(const UBiDiProps
*bdp
, UChar32 c
);
76 ubidi_getMirror(const UBiDiProps
*bdp
, UChar32 c
);
79 ubidi_isBidiControl(const UBiDiProps
*bdp
, UChar32 c
);
82 ubidi_isJoinControl(const UBiDiProps
*bdp
, UChar32 c
);
85 ubidi_getJoiningType(const UBiDiProps
*bdp
, UChar32 c
);
88 ubidi_getJoiningGroup(const UBiDiProps
*bdp
, UChar32 c
);
90 /* file definitions --------------------------------------------------------- */
92 #define UBIDI_DATA_NAME "ubidi"
93 #define UBIDI_DATA_TYPE "icu"
96 #define UBIDI_FMT_0 0x42
97 #define UBIDI_FMT_1 0x69
98 #define UBIDI_FMT_2 0x44
99 #define UBIDI_FMT_3 0x69
101 /* indexes into indexes[] */
106 UBIDI_IX_MIRROR_LENGTH
,
111 UBIDI_MAX_VALUES_INDEX
=15,
115 /* definitions for 16-bit bidi/shaping properties word ---------------------- */
118 /* UBIDI_CLASS_SHIFT=0, */ /* bidi class: 5 bits (4..0) */
119 UBIDI_JT_SHIFT
=5, /* joining type: 3 bits (7..5) */
121 /* UBIDI__SHIFT=8, reserved: 2 bits (9..8) */
123 UBIDI_JOIN_CONTROL_SHIFT
=10,
124 UBIDI_BIDI_CONTROL_SHIFT
=11,
126 UBIDI_IS_MIRRORED_SHIFT
=12, /* 'is mirrored' */
127 UBIDI_MIRROR_DELTA_SHIFT
=13, /* bidi mirroring delta: 3 bits (15..13) */
129 UBIDI_MAX_JG_SHIFT
=16 /* max JG value in indexes[UBIDI_MAX_VALUES_INDEX] bits 23..16 */
132 #define UBIDI_CLASS_MASK 0x0000001f
133 #define UBIDI_JT_MASK 0x000000e0
135 #define UBIDI_MAX_JG_MASK 0x00ff0000
137 #define UBIDI_GET_CLASS(props) ((props)&UBIDI_CLASS_MASK)
138 #define UBIDI_GET_FLAG(props, shift) (((props)>>(shift))&1)
141 UBIDI_ESC_MIRROR_DELTA
=-4,
142 UBIDI_MIN_MIRROR_DELTA
=-3,
143 UBIDI_MAX_MIRROR_DELTA
=3
146 /* definitions for 32-bit mirror table entry -------------------------------- */
149 /* the source Unicode code point takes 21 bits (20..0) */
150 UBIDI_MIRROR_INDEX_SHIFT
=21,
151 UBIDI_MAX_MIRROR_INDEX
=0x7ff
154 #define UBIDI_GET_MIRROR_CODE_POINT(m) (UChar32)((m)&0x1fffff)
156 #define UBIDI_GET_MIRROR_INDEX(m) ((m)>>UBIDI_MIRROR_INDEX_SHIFT)