2 ******************************************************************************
4 * Copyright (C) 2000-2014, International Business Machines
5 * Corporation and others. All Rights Reserved.
7 ******************************************************************************
8 * file name: ushape.cpp
10 * tab size: 8 (not used)
13 * created on: 2000jun29
14 * created by: Markus W. Scherer
16 * Arabic letter shaping implemented by Ayman Roshdy
19 #include "unicode/utypes.h"
20 #include "unicode/uchar.h"
21 #include "unicode/ustring.h"
22 #include "unicode/ushape.h"
26 #include "ubidi_props.h"
30 * This implementation is designed for 16-bit Unicode strings.
31 * The main assumption is that the Arabic characters and their
32 * presentation forms each fit into a single UChar.
33 * With UTF-8, they occupy 2 or 3 bytes, and more than the ASCII
38 * ### TODO in general for letter shaping:
39 * - the letter shaping code is UTF-16-unaware; needs update
40 * + especially invertBuffer()?!
41 * - needs to handle the "Arabic Tail" that is used in some legacy codepages
42 * as a glyph fragment of wide-glyph letters
43 * + IBM Unicode conversion tables map it to U+200B (ZWSP)
44 * + IBM Egypt has proposed to encode the tail in Unicode among Arabic Presentation Forms
45 * + Unicode 3.2 added U+FE73 ARABIC TAIL FRAGMENT
48 /* definitions for Arabic letter shaping ------------------------------------ */
58 #define COMBINE (SHADDA+CSHADDA)
60 #define HAMZAFE_CHAR 0xfe80
61 #define HAMZA06_CHAR 0x0621
62 #define YEH_HAMZA_CHAR 0x0626
63 #define YEH_HAMZAFE_CHAR 0xFE89
64 #define LAMALEF_SPACE_SUB 0xFFFF
65 #define TASHKEEL_SPACE_SUB 0xFFFE
66 #define NEW_TAIL_CHAR 0xFE73
67 #define OLD_TAIL_CHAR 0x200B
68 #define LAM_CHAR 0x0644
69 #define SPACE_CHAR 0x0020
70 #define SHADDA_CHAR 0xFE7C
71 #define TATWEEL_CHAR 0x0640
72 #define SHADDA_TATWEEL_CHAR 0xFE7D
73 #define SHADDA06_CHAR 0x0651
76 #define DESHAPE_MODE 1
78 struct uShapeVariables
{
80 uint32_t uShapeLamalefBegin
;
81 uint32_t uShapeLamalefEnd
;
82 uint32_t uShapeTashkeelBegin
;
83 uint32_t uShapeTashkeelEnd
;
84 int spacesRelativeToTextBeginEnd
;
87 static const uint8_t tailFamilyIsolatedFinal
[] = {
104 static const uint8_t tashkeelMedial
[] = {
123 static const UChar yehHamzaToYeh
[] =
125 /* isolated*/ 0xFEEF,
129 static const uint8_t IrrelevantPos
[] = {
135 static const UChar convertLamAlef
[] =
147 static const UChar araLink
[178]=
149 1 + 32 + 256 * 0x11,/*0x0622*/
150 1 + 32 + 256 * 0x13,/*0x0623*/
151 1 + 256 * 0x15,/*0x0624*/
152 1 + 32 + 256 * 0x17,/*0x0625*/
153 1 + 2 + 256 * 0x19,/*0x0626*/
154 1 + 32 + 256 * 0x1D,/*0x0627*/
155 1 + 2 + 256 * 0x1F,/*0x0628*/
156 1 + 256 * 0x23,/*0x0629*/
157 1 + 2 + 256 * 0x25,/*0x062A*/
158 1 + 2 + 256 * 0x29,/*0x062B*/
159 1 + 2 + 256 * 0x2D,/*0x062C*/
160 1 + 2 + 256 * 0x31,/*0x062D*/
161 1 + 2 + 256 * 0x35,/*0x062E*/
162 1 + 256 * 0x39,/*0x062F*/
163 1 + 256 * 0x3B,/*0x0630*/
164 1 + 256 * 0x3D,/*0x0631*/
165 1 + 256 * 0x3F,/*0x0632*/
166 1 + 2 + 256 * 0x41,/*0x0633*/
167 1 + 2 + 256 * 0x45,/*0x0634*/
168 1 + 2 + 256 * 0x49,/*0x0635*/
169 1 + 2 + 256 * 0x4D,/*0x0636*/
170 1 + 2 + 256 * 0x51,/*0x0637*/
171 1 + 2 + 256 * 0x55,/*0x0638*/
172 1 + 2 + 256 * 0x59,/*0x0639*/
173 1 + 2 + 256 * 0x5D,/*0x063A*/
174 0, 0, 0, 0, 0, /*0x063B-0x063F*/
176 1 + 2 + 256 * 0x61,/*0x0641*/
177 1 + 2 + 256 * 0x65,/*0x0642*/
178 1 + 2 + 256 * 0x69,/*0x0643*/
179 1 + 2 + 16 + 256 * 0x6D,/*0x0644*/
180 1 + 2 + 256 * 0x71,/*0x0645*/
181 1 + 2 + 256 * 0x75,/*0x0646*/
182 1 + 2 + 256 * 0x79,/*0x0647*/
183 1 + 256 * 0x7D,/*0x0648*/
184 1 + 256 * 0x7F,/*0x0649*/
185 1 + 2 + 256 * 0x81,/*0x064A*/
186 4 + 256 * 1, /*0x064B*/
187 4 + 128 + 256 * 1, /*0x064C*/
188 4 + 128 + 256 * 1, /*0x064D*/
189 4 + 128 + 256 * 1, /*0x064E*/
190 4 + 128 + 256 * 1, /*0x064F*/
191 4 + 128 + 256 * 1, /*0x0650*/
192 4 + 64 + 256 * 3, /*0x0651*/
193 4 + 256 * 1, /*0x0652*/
194 4 + 256 * 7, /*0x0653*/
195 4 + 256 * 8, /*0x0654*/
196 4 + 256 * 8, /*0x0655*/
197 4 + 256 * 1, /*0x0656*/
198 0, 0, 0, 0, 0, /*0x0657-0x065B*/
199 1 + 256 * 0x85,/*0x065C*/
200 1 + 256 * 0x87,/*0x065D*/
201 1 + 256 * 0x89,/*0x065E*/
202 1 + 256 * 0x8B,/*0x065F*/
203 0, 0, 0, 0, 0, /*0x0660-0x0664*/
204 0, 0, 0, 0, 0, /*0x0665-0x0669*/
205 0, 0, 0, 0, 0, 0, /*0x066A-0x066F*/
206 4 + 256 * 6, /*0x0670*/
207 1 + 8 + 256 * 0x00,/*0x0671*/
212 1, 1, /*0x0676-0x0677*/
214 1 + 2 + 8 + 256 * 0x16,/*0x0679*/
215 1 + 2 + 8 + 256 * 0x0E,/*0x067A*/
216 1 + 2 + 8 + 256 * 0x02,/*0x067B*/
217 1+2, 1+2, /*0x67C-0x067D*/
218 1+2+8+256 * 0x06, 1+2, 1+2, 1+2, 1+2, 1+2, /*0x067E-0x0683*/
219 1+2, 1+2, 1+2+8+256 * 0x2A, 1+2, /*0x0684-0x0687*/
220 1 + 8 + 256 * 0x38,/*0x0688*/
221 1, 1, 1, /*0x0689-0x068B*/
222 1 + 8 + 256 * 0x34,/*0x068C*/
223 1 + 8 + 256 * 0x32,/*0x068D*/
224 1 + 8 + 256 * 0x36,/*0x068E*/
225 1, 1, /*0x068F-0x0690*/
226 1 + 8 + 256 * 0x3C,/*0x0691*/
227 1, 1, 1, 1, 1, 1, 1+8+256 * 0x3A, 1, /*0x0692-0x0699*/
228 1+2, 1+2, 1+2, 1+2, 1+2, 1+2, /*0x069A-0x06A3*/
229 1+2, 1+2, 1+2, 1+2, /*0x069A-0x06A3*/
230 1+2, 1+2, 1+2, 1+2, 1+2, 1+2+8+256 * 0x3E, /*0x06A4-0x06AD*/
231 1+2, 1+2, 1+2, 1+2, /*0x06A4-0x06AD*/
232 1+2, 1+2+8+256 * 0x42, 1+2, 1+2, 1+2, 1+2, /*0x06AE-0x06B7*/
233 1+2, 1+2, 1+2, 1+2, /*0x06AE-0x06B7*/
234 1+2, 1+2, /*0x06B8-0x06B9*/
235 1 + 8 + 256 * 0x4E,/*0x06BA*/
236 1 + 2 + 8 + 256 * 0x50,/*0x06BB*/
237 1+2, 1+2, /*0x06BC-0x06BD*/
238 1 + 2 + 8 + 256 * 0x5A,/*0x06BE*/
240 1 + 8 + 256 * 0x54,/*0x06C0*/
241 1 + 2 + 8 + 256 * 0x56,/*0x06C1*/
242 1, 1, 1, /*0x06C2-0x06C4*/
243 1 + 8 + 256 * 0x90,/*0x06C5*/
244 1 + 8 + 256 * 0x89,/*0x06C6*/
245 1 + 8 + 256 * 0x87,/*0x06C7*/
246 1 + 8 + 256 * 0x8B,/*0x06C8*/
247 1 + 8 + 256 * 0x92,/*0x06C9*/
249 1 + 8 + 256 * 0x8E,/*0x06CB*/
250 1 + 2 + 8 + 256 * 0xAC,/*0x06CC*/
252 1+2, 1+2, /*0x06CE-0x06CF*/
253 1 + 2 + 8 + 256 * 0x94,/*0x06D0*/
255 1 + 8 + 256 * 0x5E,/*0x06D2*/
256 1 + 8 + 256 * 0x60 /*0x06D3*/
259 static const uint8_t presALink
[] = {
260 /***********0*****1*****2*****3*****4*****5*****6*****7*****8*****9*****A*****B*****C*****D*****E*****F*/
261 /*FB5*/ 0, 1, 0, 0, 0, 0, 0, 1, 2,1 + 2, 0, 0, 0, 0, 0, 0,
262 /*FB6*/ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
263 /*FB7*/ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 2,1 + 2, 0, 0,
264 /*FB8*/ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 0, 0, 0, 1,
265 /*FB9*/ 2,1 + 2, 0, 1, 2,1 + 2, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
266 /*FBA*/ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
267 /*FBB*/ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
268 /*FBC*/ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
269 /*FBD*/ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
270 /*FBE*/ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
271 /*FBF*/ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 2,1 + 2,
272 /*FC0*/ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
273 /*FC1*/ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
274 /*FC2*/ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
275 /*FC3*/ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
276 /*FC4*/ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
277 /*FC5*/ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, 4,
281 static const uint8_t presBLink
[]=
283 /***********0*****1*****2*****3*****4*****5*****6*****7*****8*****9*****A*****B*****C*****D*****E*****F*/
284 /*FE7*/1 + 2,1 + 2,1 + 2, 0,1 + 2, 0,1 + 2,1 + 2,1 + 2,1 + 2,1 + 2,1 + 2,1 + 2,1 + 2,1 + 2,1 + 2,
285 /*FE8*/ 0, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 2,1 + 2, 0, 1, 0,
286 /*FE9*/ 1, 2,1 + 2, 0, 1, 0, 1, 2,1 + 2, 0, 1, 2,1 + 2, 0, 1, 2,
287 /*FEA*/1 + 2, 0, 1, 2,1 + 2, 0, 1, 2,1 + 2, 0, 1, 0, 1, 0, 1, 0,
288 /*FEB*/ 1, 0, 1, 2,1 + 2, 0, 1, 2,1 + 2, 0, 1, 2,1 + 2, 0, 1, 2,
289 /*FEC*/1 + 2, 0, 1, 2,1 + 2, 0, 1, 2,1 + 2, 0, 1, 2,1 + 2, 0, 1, 2,
290 /*FED*/1 + 2, 0, 1, 2,1 + 2, 0, 1, 2,1 + 2, 0, 1, 2,1 + 2, 0, 1, 2,
291 /*FEE*/1 + 2, 0, 1, 2,1 + 2, 0, 1, 2,1 + 2, 0, 1, 2,1 + 2, 0, 1, 0,
292 /*FEF*/ 1, 0, 1, 2,1 + 2, 0, 1, 0, 1, 0, 1, 0, 1, 0, 0, 0
295 static const UChar convertFBto06
[] =
297 /***********0******1******2******3******4******5******6******7******8******9******A******B******C******D******E******F***/
298 /*FB5*/ 0x671, 0x671, 0x67B, 0x67B, 0x67B, 0x67B, 0x67E, 0x67E, 0x67E, 0x67E, 0, 0, 0, 0, 0x67A, 0x67A,
299 /*FB6*/ 0x67A, 0x67A, 0, 0, 0, 0, 0x679, 0x679, 0x679, 0x679, 0, 0, 0, 0, 0, 0,
300 /*FB7*/ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0x686, 0x686, 0x686, 0x686, 0, 0,
301 /*FB8*/ 0, 0, 0x68D, 0x68D, 0x68C, 0x68C, 0x68E, 0x68E, 0x688, 0x688, 0x698, 0x698, 0x691, 0x691, 0x6A9, 0x6A9,
302 /*FB9*/ 0x6A9, 0x6A9, 0x6AF, 0x6AF, 0x6AF, 0x6AF, 0, 0, 0, 0, 0, 0, 0, 0, 0x6BA, 0x6BA,
303 /*FBA*/ 0x6BB, 0x6BB, 0x6BB, 0x6BB, 0x6C0, 0x6C0, 0x6C1, 0x6C1, 0x6C1, 0x6C1, 0x6BE, 0x6BE, 0x6BE, 0x6BE, 0x6d2, 0x6D2,
304 /*FBB*/ 0x6D3, 0x6D3, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
305 /*FBC*/ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
306 /*FBD*/ 0, 0, 0, 0, 0, 0, 0, 0x6C7, 0x6C7, 0x6C6, 0x6C6, 0x6C8, 0x6C8, 0, 0x6CB, 0x6CB,
307 /*FBE*/ 0x6C5, 0x6C5, 0x6C9, 0x6C9, 0x6D0, 0x6D0, 0x6D0, 0x6D0, 0, 0, 0, 0, 0, 0, 0, 0,
308 /*FBF*/ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0x6CC, 0x6CC, 0x6CC, 0x6CC
311 static const UChar convertFEto06
[] =
313 /***********0******1******2******3******4******5******6******7******8******9******A******B******C******D******E******F***/
314 /*FE7*/ 0x64B, 0x64B, 0x64C, 0x64C, 0x64D, 0x64D, 0x64E, 0x64E, 0x64F, 0x64F, 0x650, 0x650, 0x651, 0x651, 0x652, 0x652,
315 /*FE8*/ 0x621, 0x622, 0x622, 0x623, 0x623, 0x624, 0x624, 0x625, 0x625, 0x626, 0x626, 0x626, 0x626, 0x627, 0x627, 0x628,
316 /*FE9*/ 0x628, 0x628, 0x628, 0x629, 0x629, 0x62A, 0x62A, 0x62A, 0x62A, 0x62B, 0x62B, 0x62B, 0x62B, 0x62C, 0x62C, 0x62C,
317 /*FEA*/ 0x62C, 0x62D, 0x62D, 0x62D, 0x62D, 0x62E, 0x62E, 0x62E, 0x62E, 0x62F, 0x62F, 0x630, 0x630, 0x631, 0x631, 0x632,
318 /*FEB*/ 0x632, 0x633, 0x633, 0x633, 0x633, 0x634, 0x634, 0x634, 0x634, 0x635, 0x635, 0x635, 0x635, 0x636, 0x636, 0x636,
319 /*FEC*/ 0x636, 0x637, 0x637, 0x637, 0x637, 0x638, 0x638, 0x638, 0x638, 0x639, 0x639, 0x639, 0x639, 0x63A, 0x63A, 0x63A,
320 /*FED*/ 0x63A, 0x641, 0x641, 0x641, 0x641, 0x642, 0x642, 0x642, 0x642, 0x643, 0x643, 0x643, 0x643, 0x644, 0x644, 0x644,
321 /*FEE*/ 0x644, 0x645, 0x645, 0x645, 0x645, 0x646, 0x646, 0x646, 0x646, 0x647, 0x647, 0x647, 0x647, 0x648, 0x648, 0x649,
322 /*FEF*/ 0x649, 0x64A, 0x64A, 0x64A, 0x64A, 0x65C, 0x65C, 0x65D, 0x65D, 0x65E, 0x65E, 0x65F, 0x65F
325 static const uint8_t shapeTable
[4][4][4]=
327 { {0,0,0,0}, {0,0,0,0}, {0,1,0,3}, {0,1,0,1} },
328 { {0,0,2,2}, {0,0,1,2}, {0,1,1,2}, {0,1,1,3} },
329 { {0,0,0,0}, {0,0,0,0}, {0,1,0,3}, {0,1,0,3} },
330 { {0,0,1,2}, {0,0,1,2}, {0,1,1,2}, {0,1,1,3} }
334 * This function shapes European digits to Arabic-Indic digits
335 * in-place, writing over the input characters.
336 * Since we know that we are only looking for BMP code points,
337 * we can safely just work with code units (again, at least UTF-16).
340 _shapeToArabicDigitsWithContext(UChar
*s
, int32_t length
,
342 UBool isLogical
, UBool lastStrongWasAL
) {
343 const UBiDiProps
*bdp
;
347 bdp
=ubidi_getSingleton();
350 /* the iteration direction depends on the type of input */
352 for(i
=0; i
<length
; ++i
) {
354 switch(ubidi_getClass(bdp
, c
)) {
355 case U_LEFT_TO_RIGHT
: /* L */
356 case U_RIGHT_TO_LEFT
: /* R */
357 lastStrongWasAL
=FALSE
;
359 case U_RIGHT_TO_LEFT_ARABIC
: /* AL */
360 lastStrongWasAL
=TRUE
;
362 case U_EUROPEAN_NUMBER
: /* EN */
363 if(lastStrongWasAL
&& (uint32_t)(c
-0x30)<10) {
364 s
[i
]=(UChar
)(digitBase
+c
); /* digitBase+(c-0x30) - digitBase was modified above */
372 for(i
=length
; i
>0; /* pre-decrement in the body */) {
374 switch(ubidi_getClass(bdp
, c
)) {
375 case U_LEFT_TO_RIGHT
: /* L */
376 case U_RIGHT_TO_LEFT
: /* R */
377 lastStrongWasAL
=FALSE
;
379 case U_RIGHT_TO_LEFT_ARABIC
: /* AL */
380 lastStrongWasAL
=TRUE
;
382 case U_EUROPEAN_NUMBER
: /* EN */
383 if(lastStrongWasAL
&& (uint32_t)(c
-0x30)<10) {
384 s
[i
]=(UChar
)(digitBase
+c
); /* digitBase+(c-0x30) - digitBase was modified above */
396 *Function : This function inverts the buffer, it's used
397 * in case the user specifies the buffer to be
398 * U_SHAPE_TEXT_DIRECTION_LOGICAL
401 invertBuffer(UChar
*buffer
, int32_t size
, uint32_t /*options*/, int32_t lowlimit
, int32_t highlimit
) {
404 for(i
=lowlimit
,j
=size
-highlimit
-1;i
<j
;i
++,j
--) {
406 buffer
[i
] = buffer
[j
];
412 *Name : changeLamAlef
413 *Function : Converts the Alef characters into an equivalent
414 * LamAlef location in the 0x06xx Range, this is an
415 * intermediate stage in the operation of the program
416 * later it'll be converted into the 0xFExx LamAlefs
417 * in the shaping function.
420 changeLamAlef(UChar ch
) {
436 *Function : Resolves the link between the characters as
437 * Arabic characters have four forms :
438 * Isolated, Initial, Middle and Final Form
442 if(ch
>= 0x0622 && ch
<= 0x06D3) {
443 return(araLink
[ch
-0x0622]);
444 } else if(ch
== 0x200D) {
446 } else if(ch
>= 0x206D && ch
<= 0x206F) {
448 }else if(ch
>= 0xFB50 && ch
<= 0xFC62) {
449 return(presALink
[ch
-0xFB50]);
450 } else if(ch
>= 0xFE70 && ch
<= 0xFEFC) {
451 return(presBLink
[ch
-0xFE70]);
459 *Function : Counts the number of spaces
460 * at each end of the logical buffer
463 countSpaces(UChar
*dest
, int32_t size
, uint32_t /*options*/, int32_t *spacesCountl
, int32_t *spacesCountr
) {
465 int32_t countl
= 0,countr
= 0;
466 while((dest
[i
] == SPACE_CHAR
) && (countl
< size
)) {
470 if (countl
< size
) { /* the entire buffer is not all space */
471 while(dest
[size
-1] == SPACE_CHAR
) {
476 *spacesCountl
= countl
;
477 *spacesCountr
= countr
;
481 *Name : isTashkeelChar
482 *Function : Returns 1 for Tashkeel characters in 06 range else return 0
484 static inline int32_t
485 isTashkeelChar(UChar ch
) {
486 return (int32_t)( ch
>=0x064B && ch
<= 0x0652 );
490 *Name : isTashkeelCharFE
491 *Function : Returns 1 for Tashkeel characters in FE range else return 0
493 static inline int32_t
494 isTashkeelCharFE(UChar ch
) {
495 return (int32_t)( ch
>=0xFE70 && ch
<= 0xFE7F );
500 *Function : Returns 1 for Alef characters else return 0
502 static inline int32_t
503 isAlefChar(UChar ch
) {
504 return (int32_t)( (ch
==0x0622)||(ch
==0x0623)||(ch
==0x0625)||(ch
==0x0627) );
508 *Name : isLamAlefChar
509 *Function : Returns 1 for LamAlef characters else return 0
511 static inline int32_t
512 isLamAlefChar(UChar ch
) {
513 return (int32_t)((ch
>=0xFEF5)&&(ch
<=0xFEFC) );
518 *Function : returns 1 if the character matches one of the tail characters (0xfe73 or 0x200b) otherwise returns 0
521 static inline int32_t
522 isTailChar(UChar ch
) {
523 if(ch
== OLD_TAIL_CHAR
|| ch
== NEW_TAIL_CHAR
){
531 *Name : isSeenTailFamilyChar
532 *Function : returns 1 if the character is a seen family isolated character
533 * in the FE range otherwise returns 0
536 static inline int32_t
537 isSeenTailFamilyChar(UChar ch
) {
538 if(ch
>= 0xfeb1 && ch
< 0xfebf){
539 return tailFamilyIsolatedFinal
[ch
- 0xFEB1];
545 /* Name : isSeenFamilyChar
546 * Function : returns 1 if the character is a seen family character in the Unicode
547 * 06 range otherwise returns 0
550 static inline int32_t
551 isSeenFamilyChar(UChar ch
){
552 if(ch
>= 0x633 && ch
<= 0x636){
561 *Name : isAlefMaksouraChar
562 *Function : returns 1 if the character is a Alef Maksoura Final or isolated
563 * otherwise returns 0
565 static inline int32_t
566 isAlefMaksouraChar(UChar ch
) {
567 return (int32_t)( (ch
== 0xFEEF) || ( ch
== 0xFEF0) || (ch
== 0x0649));
571 * Name : isYehHamzaChar
572 * Function : returns 1 if the character is a yehHamza isolated or yehhamza
573 * final is found otherwise returns 0
575 static inline int32_t
576 isYehHamzaChar(UChar ch
) {
577 if((ch
==0xFE89)||(ch
==0xFE8A)){
585 * Name: isTashkeelOnTatweelChar
586 * Function: Checks if the Tashkeel Character is on Tatweel or not,if the
587 * Tashkeel on tatweel (FE range), it returns 1 else if the
588 * Tashkeel with shadda on tatweel (FC range)return 2 otherwise
591 static inline int32_t
592 isTashkeelOnTatweelChar(UChar ch
){
593 if(ch
>= 0xfe70 && ch
<= 0xfe7f && ch
!= NEW_TAIL_CHAR
&& ch
!= 0xFE75 && ch
!= SHADDA_TATWEEL_CHAR
)
595 return tashkeelMedial
[ch
- 0xFE70];
596 }else if( (ch
>= 0xfcf2 && ch
<= 0xfcf4) || (ch
== SHADDA_TATWEEL_CHAR
)) {
604 * Name: isIsolatedTashkeelChar
605 * Function: Checks if the Tashkeel Character is in the isolated form
606 * (i.e. Unicode FE range) returns 1 else if the Tashkeel
607 * with shadda is in the isolated form (i.e. Unicode FC range)
608 * returns 2 otherwise returns 0
610 static inline int32_t
611 isIsolatedTashkeelChar(UChar ch
){
612 if(ch
>= 0xfe70 && ch
<= 0xfe7f && ch
!= NEW_TAIL_CHAR
&& ch
!= 0xFE75){
613 return (1 - tashkeelMedial
[ch
- 0xFE70]);
614 }else if(ch
>= 0xfc5e && ch
<= 0xfc63){
625 *Name : calculateSize
626 *Function : This function calculates the destSize to be used in preflighting
627 * when the destSize is equal to 0
628 * It is used also to calculate the new destsize in case the
629 * destination buffer will be resized.
633 calculateSize(const UChar
*source
, int32_t sourceLength
,
634 int32_t destSize
,uint32_t options
) {
637 int lamAlefOption
= 0;
638 int tashkeelOption
= 0;
640 destSize
= sourceLength
;
642 if (((options
&U_SHAPE_LETTERS_MASK
) == U_SHAPE_LETTERS_SHAPE
||
643 ((options
&U_SHAPE_LETTERS_MASK
) == U_SHAPE_LETTERS_SHAPE_TASHKEEL_ISOLATED
)) &&
644 ((options
&U_SHAPE_LAMALEF_MASK
) == U_SHAPE_LAMALEF_RESIZE
)){
647 if((options
&U_SHAPE_LETTERS_MASK
) == U_SHAPE_LETTERS_SHAPE
&&
648 ((options
&U_SHAPE_TASHKEEL_MASK
) == U_SHAPE_TASHKEEL_RESIZE
) ){
652 if(lamAlefOption
|| tashkeelOption
){
653 if((options
&U_SHAPE_TEXT_DIRECTION_MASK
)==U_SHAPE_TEXT_DIRECTION_VISUAL_LTR
) {
654 for(i
=0;i
<sourceLength
;i
++) {
655 if( ((isAlefChar(source
[i
]))&& (i
<(sourceLength
-1)) &&(source
[i
+1] == LAM_CHAR
)) || (isTashkeelCharFE(source
[i
])) ) {
659 }else if((options
&U_SHAPE_TEXT_DIRECTION_MASK
)==U_SHAPE_TEXT_DIRECTION_LOGICAL
) {
660 for(i
=0;i
<sourceLength
;i
++) {
661 if( ( (source
[i
] == LAM_CHAR
) && (i
<(sourceLength
-1)) && (isAlefChar(source
[i
+1]))) || (isTashkeelCharFE(source
[i
])) ) {
668 if ((options
&U_SHAPE_LETTERS_MASK
) == U_SHAPE_LETTERS_UNSHAPE
){
669 if ( (options
&U_SHAPE_LAMALEF_MASK
) == U_SHAPE_LAMALEF_RESIZE
){
670 for(i
=0;i
<sourceLength
;i
++) {
671 if(isLamAlefChar(source
[i
]))
681 *Name : handleTashkeelWithTatweel
682 *Function : Replaces Tashkeel as following:
683 * Case 1 :if the Tashkeel on tatweel, replace it with Tatweel.
684 * Case 2 :if the Tashkeel aggregated with Shadda on Tatweel, replace
685 * it with Shadda on Tatweel.
686 * Case 3: if the Tashkeel is isolated replace it with Space.
690 handleTashkeelWithTatweel(UChar
*dest
, int32_t sourceLength
,
691 int32_t /*destSize*/, uint32_t /*options*/,
692 UErrorCode
* /*pErrorCode*/) {
694 for(i
= 0; i
< sourceLength
; i
++){
695 if((isTashkeelOnTatweelChar(dest
[i
]) == 1)){
696 dest
[i
] = TATWEEL_CHAR
;
697 }else if((isTashkeelOnTatweelChar(dest
[i
]) == 2)){
698 dest
[i
] = SHADDA_TATWEEL_CHAR
;
699 }else if(isIsolatedTashkeelChar(dest
[i
]) && dest
[i
] != SHADDA_CHAR
){
700 dest
[i
] = SPACE_CHAR
;
709 *Name : handleGeneratedSpaces
710 *Function : The shapeUnicode function converts Lam + Alef into LamAlef + space,
711 * and Tashkeel to space.
712 * handleGeneratedSpaces function puts these generated spaces
713 * according to the options the user specifies. LamAlef and Tashkeel
714 * spaces can be replaced at begin, at end, at near or decrease the
717 * There is also Auto option for LamAlef and tashkeel, which will put
718 * the spaces at end of the buffer (or end of text if the user used
719 * the option U_SHAPE_SPACES_RELATIVE_TO_TEXT_BEGIN_END).
721 * If the text type was visual_LTR and the option
722 * U_SHAPE_SPACES_RELATIVE_TO_TEXT_BEGIN_END was selected the END
723 * option will place the space at the beginning of the buffer and
724 * BEGIN will place the space at the end of the buffer.
728 handleGeneratedSpaces(UChar
*dest
, int32_t sourceLength
,
731 UErrorCode
*pErrorCode
,struct uShapeVariables shapeVars
) {
733 int32_t i
= 0, j
= 0;
735 UChar
*tempbuffer
=NULL
;
737 int lamAlefOption
= 0;
738 int tashkeelOption
= 0;
739 int shapingMode
= SHAPE_MODE
;
741 if (shapingMode
== 0){
742 if ( (options
&U_SHAPE_LAMALEF_MASK
) == U_SHAPE_LAMALEF_RESIZE
){
745 if ( (options
&U_SHAPE_TASHKEEL_MASK
) == U_SHAPE_TASHKEEL_RESIZE
){
750 tempbuffer
= (UChar
*)uprv_malloc((sourceLength
+1)*U_SIZEOF_UCHAR
);
752 if(tempbuffer
== NULL
) {
753 *pErrorCode
= U_MEMORY_ALLOCATION_ERROR
;
758 if (lamAlefOption
|| tashkeelOption
){
759 uprv_memset(tempbuffer
, 0, (sourceLength
+1)*U_SIZEOF_UCHAR
);
761 i
= j
= 0; count
= 0;
762 while(i
< sourceLength
) {
763 if ( (lamAlefOption
&& dest
[i
] == LAMALEF_SPACE_SUB
) ||
764 (tashkeelOption
&& dest
[i
] == TASHKEEL_SPACE_SUB
) ){
768 tempbuffer
[j
] = dest
[i
];
775 tempbuffer
[i
] = 0x0000;
780 uprv_memcpy(dest
, tempbuffer
, sourceLength
*U_SIZEOF_UCHAR
);
781 destSize
= u_strlen(dest
);
786 if (shapingMode
== 0){
787 if ( (options
&U_SHAPE_LAMALEF_MASK
) == U_SHAPE_LAMALEF_NEAR
){
793 /* Lam+Alef is already shaped into LamAlef + FFFF */
795 while(i
< sourceLength
) {
796 if(lamAlefOption
&&dest
[i
] == LAMALEF_SPACE_SUB
){
797 dest
[i
] = SPACE_CHAR
;
801 destSize
= sourceLength
;
806 if (shapingMode
== 0) {
807 if ( ((options
&U_SHAPE_LAMALEF_MASK
) == shapeVars
.uShapeLamalefBegin
) ||
808 (((options
&U_SHAPE_LAMALEF_MASK
) == U_SHAPE_LAMALEF_AUTO
)
809 && (shapeVars
.spacesRelativeToTextBeginEnd
==1)) ) {
812 if ( (options
&U_SHAPE_TASHKEEL_MASK
) == shapeVars
.uShapeTashkeelBegin
) {
817 if(lamAlefOption
|| tashkeelOption
){
818 uprv_memset(tempbuffer
, 0, (sourceLength
+1)*U_SIZEOF_UCHAR
);
820 i
= j
= sourceLength
; count
= 0;
823 if ( (lamAlefOption
&& dest
[i
] == LAMALEF_SPACE_SUB
) ||
824 (tashkeelOption
&& dest
[i
] == TASHKEEL_SPACE_SUB
) ){
828 tempbuffer
[j
] = dest
[i
];
834 for(i
=0 ;i
< count
; i
++){
835 tempbuffer
[i
] = SPACE_CHAR
;
838 uprv_memcpy(dest
, tempbuffer
, sourceLength
*U_SIZEOF_UCHAR
);
839 destSize
= sourceLength
;
847 if (shapingMode
== 0) {
848 if ( ((options
&U_SHAPE_LAMALEF_MASK
) == shapeVars
.uShapeLamalefEnd
) ||
849 (((options
&U_SHAPE_LAMALEF_MASK
) == U_SHAPE_LAMALEF_AUTO
)
850 && (shapeVars
.spacesRelativeToTextBeginEnd
==0)) ) {
853 if ( (options
&U_SHAPE_TASHKEEL_MASK
) == shapeVars
.uShapeTashkeelEnd
){
858 if(lamAlefOption
|| tashkeelOption
){
859 uprv_memset(tempbuffer
, 0, (sourceLength
+1)*U_SIZEOF_UCHAR
);
861 i
= j
= 0; count
= 0;
862 while(i
< sourceLength
) {
863 if ( (lamAlefOption
&& dest
[i
] == LAMALEF_SPACE_SUB
) ||
864 (tashkeelOption
&& dest
[i
] == TASHKEEL_SPACE_SUB
) ){
868 tempbuffer
[j
] = dest
[i
];
875 tempbuffer
[i
] = SPACE_CHAR
;
880 uprv_memcpy(dest
,tempbuffer
, sourceLength
*U_SIZEOF_UCHAR
);
881 destSize
= sourceLength
;
886 uprv_free(tempbuffer
);
893 *Name :expandCompositCharAtBegin
894 *Function :Expands the LamAlef character to Lam and Alef consuming the required
895 * space from beginning of the buffer. If the text type was visual_LTR
896 * and the option U_SHAPE_SPACES_RELATIVE_TO_TEXT_BEGIN_END was selected
897 * the spaces will be located at end of buffer.
898 * If there are no spaces to expand the LamAlef, an error
899 * will be set to U_NO_SPACE_AVAILABLE as defined in utypes.h
903 expandCompositCharAtBegin(UChar
*dest
, int32_t sourceLength
, int32_t destSize
,UErrorCode
*pErrorCode
) {
906 UChar
*tempbuffer
=NULL
;
908 tempbuffer
= (UChar
*)uprv_malloc((sourceLength
+1)*U_SIZEOF_UCHAR
);
911 if(tempbuffer
== NULL
) {
912 *pErrorCode
= U_MEMORY_ALLOCATION_ERROR
;
916 uprv_memset(tempbuffer
, 0, (sourceLength
+1)*U_SIZEOF_UCHAR
);
919 while(dest
[i
] == SPACE_CHAR
) {
924 i
= j
= sourceLength
-1;
926 while(i
>= 0 && j
>= 0) {
927 if( countl
>0 && isLamAlefChar(dest
[i
])) {
928 tempbuffer
[j
] = LAM_CHAR
;
929 /* to ensure the array index is within the range */
930 U_ASSERT(dest
[i
] >= 0xFEF5u
931 && dest
[i
]-0xFEF5u
< sizeof(convertLamAlef
)/sizeof(convertLamAlef
[0]));
932 tempbuffer
[j
-1] = convertLamAlef
[ dest
[i
] - 0xFEF5 ];
936 if( countl
== 0 && isLamAlefChar(dest
[i
]) ) {
937 *pErrorCode
=U_NO_SPACE_AVAILABLE
;
939 tempbuffer
[j
] = dest
[i
];
944 uprv_memcpy(dest
, tempbuffer
, sourceLength
*U_SIZEOF_UCHAR
);
946 uprv_free(tempbuffer
);
948 destSize
= sourceLength
;
953 *Name : expandCompositCharAtEnd
954 *Function : Expands the LamAlef character to Lam and Alef consuming the
955 * required space from end of the buffer. If the text type was
956 * Visual LTR and the option U_SHAPE_SPACES_RELATIVE_TO_TEXT_BEGIN_END
957 * was used, the spaces will be consumed from begin of buffer. If
958 * there are no spaces to expand the LamAlef, an error
959 * will be set to U_NO_SPACE_AVAILABLE as defined in utypes.h
963 expandCompositCharAtEnd(UChar
*dest
, int32_t sourceLength
, int32_t destSize
,UErrorCode
*pErrorCode
) {
967 int32_t inpsize
= sourceLength
;
969 UChar
*tempbuffer
=NULL
;
970 tempbuffer
= (UChar
*)uprv_malloc((sourceLength
+1)*U_SIZEOF_UCHAR
);
973 if(tempbuffer
== NULL
) {
974 *pErrorCode
= U_MEMORY_ALLOCATION_ERROR
;
978 uprv_memset(tempbuffer
, 0, (sourceLength
+1)*U_SIZEOF_UCHAR
);
980 while(dest
[inpsize
-1] == SPACE_CHAR
) {
985 i
= sourceLength
- countr
- 1;
986 j
= sourceLength
- 1;
988 while(i
>= 0 && j
>= 0) {
989 if( countr
>0 && isLamAlefChar(dest
[i
]) ) {
990 tempbuffer
[j
] = LAM_CHAR
;
991 tempbuffer
[j
-1] = convertLamAlef
[ dest
[i
] - 0xFEF5 ];
995 if ((countr
== 0) && isLamAlefChar(dest
[i
]) ) {
996 *pErrorCode
=U_NO_SPACE_AVAILABLE
;
998 tempbuffer
[j
] = dest
[i
];
1005 uprv_memmove(tempbuffer
, tempbuffer
+countr
, sourceLength
*U_SIZEOF_UCHAR
);
1006 if(u_strlen(tempbuffer
) < sourceLength
) {
1007 for(i
=sourceLength
-1;i
>=sourceLength
-countr
;i
--) {
1008 tempbuffer
[i
] = SPACE_CHAR
;
1012 uprv_memcpy(dest
, tempbuffer
, sourceLength
*U_SIZEOF_UCHAR
);
1014 uprv_free(tempbuffer
);
1016 destSize
= sourceLength
;
1021 *Name : expandCompositCharAtNear
1022 *Function : Expands the LamAlef character into Lam + Alef, YehHamza character
1023 * into Yeh + Hamza, SeenFamily character into SeenFamily character
1024 * + Tail, while consuming the space next to the character.
1025 * If there are no spaces next to the character, an error
1026 * will be set to U_NO_SPACE_AVAILABLE as defined in utypes.h
1030 expandCompositCharAtNear(UChar
*dest
, int32_t sourceLength
, int32_t destSize
,UErrorCode
*pErrorCode
,
1031 int yehHamzaOption
, int seenTailOption
, int lamAlefOption
, struct uShapeVariables shapeVars
) {
1035 UChar lamalefChar
, yehhamzaChar
;
1037 for(i
= 0 ;i
<=sourceLength
-1;i
++) {
1038 if (seenTailOption
&& isSeenTailFamilyChar(dest
[i
])) {
1039 if ((i
>0) && (dest
[i
-1] == SPACE_CHAR
) ) {
1040 dest
[i
-1] = shapeVars
.tailChar
;
1042 *pErrorCode
=U_NO_SPACE_AVAILABLE
;
1044 }else if(yehHamzaOption
&& (isYehHamzaChar(dest
[i
])) ) {
1045 if ((i
>0) && (dest
[i
-1] == SPACE_CHAR
) ) {
1046 yehhamzaChar
= dest
[i
];
1047 dest
[i
] = yehHamzaToYeh
[yehhamzaChar
- YEH_HAMZAFE_CHAR
];
1048 dest
[i
-1] = HAMZAFE_CHAR
;
1051 *pErrorCode
=U_NO_SPACE_AVAILABLE
;
1053 }else if(lamAlefOption
&& isLamAlefChar(dest
[i
+1])) {
1054 if(dest
[i
] == SPACE_CHAR
){
1055 lamalefChar
= dest
[i
+1];
1056 dest
[i
+1] = LAM_CHAR
;
1057 dest
[i
] = convertLamAlef
[ lamalefChar
- 0xFEF5 ];
1059 *pErrorCode
=U_NO_SPACE_AVAILABLE
;
1063 destSize
= sourceLength
;
1067 * Name : expandCompositChar
1068 * Function : LamAlef, need special handling, since it expands from one
1069 * character into two characters while shaping or deshaping.
1070 * In order to expand it, near or far spaces according to the
1071 * options user specifies. Also buffer size can be increased.
1073 * For SeenFamily characters and YehHamza only the near option is
1074 * supported, while for LamAlef we can take spaces from begin, end,
1075 * near or even increase the buffer size.
1076 * There is also the Auto option for LamAlef only, which will first
1077 * search for a space at end, begin then near, respectively.
1078 * If there are no spaces to expand these characters, an error will be set to
1079 * U_NO_SPACE_AVAILABLE as defined in utypes.h
1083 expandCompositChar(UChar
*dest
, int32_t sourceLength
,
1084 int32_t destSize
,uint32_t options
,
1085 UErrorCode
*pErrorCode
, int shapingMode
,struct uShapeVariables shapeVars
) {
1087 int32_t i
= 0,j
= 0;
1089 UChar
*tempbuffer
=NULL
;
1090 int yehHamzaOption
= 0;
1091 int seenTailOption
= 0;
1092 int lamAlefOption
= 0;
1094 if (shapingMode
== 1){
1095 if ( (options
&U_SHAPE_LAMALEF_MASK
) == U_SHAPE_LAMALEF_AUTO
){
1097 if(shapeVars
.spacesRelativeToTextBeginEnd
== 0) {
1098 destSize
= expandCompositCharAtEnd(dest
, sourceLength
, destSize
, pErrorCode
);
1100 if(*pErrorCode
== U_NO_SPACE_AVAILABLE
) {
1101 *pErrorCode
= U_ZERO_ERROR
;
1102 destSize
= expandCompositCharAtBegin(dest
, sourceLength
, destSize
, pErrorCode
);
1105 destSize
= expandCompositCharAtBegin(dest
, sourceLength
, destSize
, pErrorCode
);
1107 if(*pErrorCode
== U_NO_SPACE_AVAILABLE
) {
1108 *pErrorCode
= U_ZERO_ERROR
;
1109 destSize
= expandCompositCharAtEnd(dest
, sourceLength
, destSize
, pErrorCode
);
1113 if(*pErrorCode
== U_NO_SPACE_AVAILABLE
) {
1114 *pErrorCode
= U_ZERO_ERROR
;
1115 destSize
= expandCompositCharAtNear(dest
, sourceLength
, destSize
, pErrorCode
, yehHamzaOption
,
1116 seenTailOption
, 1,shapeVars
);
1121 if (shapingMode
== 1){
1122 if ( (options
&U_SHAPE_LAMALEF_MASK
) == shapeVars
.uShapeLamalefEnd
){
1123 destSize
= expandCompositCharAtEnd(dest
, sourceLength
, destSize
, pErrorCode
);
1127 if (shapingMode
== 1){
1128 if ( (options
&U_SHAPE_LAMALEF_MASK
) == shapeVars
.uShapeLamalefBegin
){
1129 destSize
= expandCompositCharAtBegin(dest
, sourceLength
, destSize
, pErrorCode
);
1133 if (shapingMode
== 0){
1134 if ((options
&U_SHAPE_YEHHAMZA_MASK
) == U_SHAPE_YEHHAMZA_TWOCELL_NEAR
){
1137 if ((options
&U_SHAPE_SEEN_MASK
) == U_SHAPE_SEEN_TWOCELL_NEAR
){
1141 if (shapingMode
== 1) {
1142 if ( (options
&U_SHAPE_LAMALEF_MASK
) == U_SHAPE_LAMALEF_NEAR
) {
1148 if (yehHamzaOption
|| seenTailOption
|| lamAlefOption
){
1149 destSize
= expandCompositCharAtNear(dest
, sourceLength
, destSize
, pErrorCode
, yehHamzaOption
,
1150 seenTailOption
,lamAlefOption
,shapeVars
);
1154 if (shapingMode
== 1){
1155 if ( (options
&U_SHAPE_LAMALEF_MASK
) == U_SHAPE_LAMALEF_RESIZE
){
1156 destSize
= calculateSize(dest
,sourceLength
,destSize
,options
);
1157 tempbuffer
= (UChar
*)uprv_malloc((destSize
+1)*U_SIZEOF_UCHAR
);
1160 if(tempbuffer
== NULL
) {
1161 *pErrorCode
= U_MEMORY_ALLOCATION_ERROR
;
1165 uprv_memset(tempbuffer
, 0, (destSize
+1)*U_SIZEOF_UCHAR
);
1168 while(i
< destSize
&& j
< destSize
) {
1169 if(isLamAlefChar(dest
[i
]) ) {
1170 tempbuffer
[j
] = convertLamAlef
[ dest
[i
] - 0xFEF5 ];
1171 tempbuffer
[j
+1] = LAM_CHAR
;
1174 tempbuffer
[j
] = dest
[i
];
1180 uprv_memcpy(dest
, tempbuffer
, destSize
*U_SIZEOF_UCHAR
);
1185 uprv_free(tempbuffer
);
1191 *Name : shapeUnicode
1192 *Function : Converts an Arabic Unicode buffer in 06xx Range into a shaped
1193 * arabic Unicode buffer in FExx Range
1196 shapeUnicode(UChar
*dest
, int32_t sourceLength
,
1197 int32_t destSize
,uint32_t options
,
1198 UErrorCode
*pErrorCode
,
1199 int tashkeelFlag
, struct uShapeVariables shapeVars
) {
1203 int32_t lastPos
,Nx
, Nw
;
1205 int32_t lamalef_found
= 0;
1206 int32_t seenfamFound
= 0, yehhamzaFound
=0, tashkeelFound
= 0;
1207 UChar prevLink
= 0, lastLink
= 0, currLink
, nextLink
= 0;
1211 * Converts the input buffer from FExx Range into 06xx Range
1212 * to make sure that all characters are in the 06xx range
1213 * even the lamalef is converted to the special region in
1216 if ((options
& U_SHAPE_PRESERVE_PRESENTATION_MASK
) == U_SHAPE_PRESERVE_PRESENTATION_NOOP
) {
1217 for (i
= 0; i
< sourceLength
; i
++) {
1218 UChar inputChar
= dest
[i
];
1219 if ( (inputChar
>= 0xFB50) && (inputChar
<= 0xFBFF)) {
1220 UChar c
= convertFBto06
[ (inputChar
- 0xFB50) ];
1223 } else if ( (inputChar
>= 0xFE70) && (inputChar
<= 0xFEFC)) {
1224 dest
[i
] = convertFEto06
[ (inputChar
- 0xFE70) ] ;
1226 dest
[i
] = inputChar
;
1232 /* sets the index to the end of the buffer, together with the step point to -1 */
1233 i
= sourceLength
- 1;
1238 * This function resolves the link between the characters .
1239 * Arabic characters have four forms :
1240 * Isolated Form, Initial Form, Middle Form and Final Form
1242 currLink
= getLink(dest
[i
]);
1248 /* If high byte of currLink > 0 then more than one shape */
1249 if ((currLink
& 0xFF00) > 0 || (getLink(dest
[i
]) & IRRELEVANT
) != 0) {
1251 while (Nx
< 0) { /* we need to know about next char */
1256 nextLink
= getLink(dest
[Nw
]);
1257 if((nextLink
& IRRELEVANT
) == 0) {
1265 if ( ((currLink
& ALEFTYPE
) > 0) && ((lastLink
& LAMTYPE
) > 0) ) {
1267 wLamalef
= changeLamAlef(dest
[i
]); /*get from 0x065C-0x065f */
1268 if ( wLamalef
!= 0) {
1269 dest
[i
] = LAMALEF_SPACE_SUB
; /* The default case is to drop the Alef and replace */
1270 dest
[lastPos
] =wLamalef
; /* it by LAMALEF_SPACE_SUB which is the last character in the */
1271 i
=lastPos
; /* unicode private use area, this is done to make */
1272 } /* sure that removeLamAlefSpaces() handles only the */
1273 lastLink
= prevLink
; /* spaces generated during lamalef generation. */
1274 currLink
= getLink(wLamalef
); /* LAMALEF_SPACE_SUB is added here and is replaced by spaces */
1275 } /* in removeLamAlefSpaces() */
1277 if ((i
> 0) && (dest
[i
-1] == SPACE_CHAR
)){
1278 if ( isSeenFamilyChar(dest
[i
])) {
1280 } else if (dest
[i
] == YEH_HAMZA_CHAR
) {
1285 if ( isSeenFamilyChar(dest
[i
])){
1287 } else if (dest
[i
] == YEH_HAMZA_CHAR
) {
1293 * get the proper shape according to link ability of neighbors
1294 * and of character; depends on the order of the shapes
1295 * (isolated, initial, middle, final) in the compatibility area
1297 Shape
= shapeTable
[nextLink
& (LINKR
+ LINKL
)]
1298 [lastLink
& (LINKR
+ LINKL
)]
1299 [currLink
& (LINKR
+ LINKL
)];
1301 if ((currLink
& (LINKR
+LINKL
)) == 1) {
1303 } else if(isTashkeelChar(dest
[i
])) {
1304 if( (lastLink
& LINKL
) && (nextLink
& LINKR
) && (tashkeelFlag
== 1) &&
1305 dest
[i
] != 0x064C && dest
[i
] != 0x064D )
1308 if( (nextLink
&ALEFTYPE
) == ALEFTYPE
&& (lastLink
&LAMTYPE
) == LAMTYPE
) {
1311 } else if(tashkeelFlag
== 2 && dest
[i
] == SHADDA06_CHAR
){
1317 if ((dest
[i
] ^ 0x0600) < 0x100) {
1318 if ( isTashkeelChar(dest
[i
]) ){
1319 if (tashkeelFlag
== 2 && dest
[i
] != SHADDA06_CHAR
){
1320 dest
[i
] = TASHKEEL_SPACE_SUB
;
1323 /* to ensure the array index is within the range */
1324 U_ASSERT(dest
[i
] >= 0x064Bu
1325 && dest
[i
]-0x064Bu
< sizeof(IrrelevantPos
)/sizeof(IrrelevantPos
[0]));
1326 dest
[i
] = 0xFE70 + IrrelevantPos
[(dest
[i
] - 0x064B)] + Shape
;
1328 }else if ((currLink
& APRESENT
) > 0) {
1329 dest
[i
] = (UChar
)(0xFB50 + (currLink
>> 8) + Shape
);
1330 }else if ((currLink
>> 8) > 0 && (currLink
& IRRELEVANT
) == 0) {
1331 dest
[i
] = (UChar
)(0xFE70 + (currLink
>> 8) + Shape
);
1336 /* move one notch forward */
1337 if ((currLink
& IRRELEVANT
) == 0) {
1338 prevLink
= lastLink
;
1339 lastLink
= currLink
;
1345 currLink
= nextLink
;
1347 } else if(i
!= iend
) {
1348 currLink
= getLink(dest
[i
]);
1351 destSize
= sourceLength
;
1352 if ( (lamalef_found
!= 0 ) || (tashkeelFound
!= 0) ){
1353 destSize
= handleGeneratedSpaces(dest
,sourceLength
,destSize
,options
,pErrorCode
, shapeVars
);
1356 if ( (seenfamFound
!= 0) || (yehhamzaFound
!= 0) ) {
1357 destSize
= expandCompositChar(dest
, sourceLength
,destSize
,options
,pErrorCode
, SHAPE_MODE
,shapeVars
);
1363 *Name : deShapeUnicode
1364 *Function : Converts an Arabic Unicode buffer in FExx Range into unshaped
1365 * arabic Unicode buffer in 06xx Range
1368 deShapeUnicode(UChar
*dest
, int32_t sourceLength
,
1369 int32_t destSize
,uint32_t options
,
1370 UErrorCode
*pErrorCode
, struct uShapeVariables shapeVars
) {
1372 int32_t lamalef_found
= 0;
1373 int32_t yehHamzaComposeEnabled
= 0;
1374 int32_t seenComposeEnabled
= 0;
1376 yehHamzaComposeEnabled
= ((options
&U_SHAPE_YEHHAMZA_MASK
) == U_SHAPE_YEHHAMZA_TWOCELL_NEAR
) ? 1 : 0;
1377 seenComposeEnabled
= ((options
&U_SHAPE_SEEN_MASK
) == U_SHAPE_SEEN_TWOCELL_NEAR
)? 1 : 0;
1380 *This for loop changes the buffer from the Unicode FE range to
1381 *the Unicode 06 range
1384 for(i
= 0; i
< sourceLength
; i
++) {
1385 UChar inputChar
= dest
[i
];
1386 if ( (inputChar
>= 0xFB50) && (inputChar
<= 0xFBFF)) { /* FBxx Arabic range */
1387 UChar c
= convertFBto06
[ (inputChar
- 0xFB50) ];
1390 } else if( (yehHamzaComposeEnabled
== 1) && ((inputChar
== HAMZA06_CHAR
) || (inputChar
== HAMZAFE_CHAR
))
1391 && (i
< (sourceLength
- 1)) && isAlefMaksouraChar(dest
[i
+1] )) {
1392 dest
[i
] = SPACE_CHAR
;
1393 dest
[i
+1] = YEH_HAMZA_CHAR
;
1394 } else if ( (seenComposeEnabled
== 1) && (isTailChar(inputChar
)) && (i
< (sourceLength
- 1))
1395 && (isSeenTailFamilyChar(dest
[i
+1])) ) {
1396 dest
[i
] = SPACE_CHAR
;
1397 } else if (( inputChar
>= 0xFE70) && (inputChar
<= 0xFEF4 )) { /* FExx Arabic range */
1398 dest
[i
] = convertFEto06
[ (inputChar
- 0xFE70) ];
1400 dest
[i
] = inputChar
;
1403 if( isLamAlefChar(dest
[i
]) )
1407 destSize
= sourceLength
;
1408 if (lamalef_found
!= 0){
1409 destSize
= expandCompositChar(dest
,sourceLength
,destSize
,options
,pErrorCode
,DESHAPE_MODE
, shapeVars
);
1415 ****************************************
1417 ****************************************
1420 U_CAPI
int32_t U_EXPORT2
1421 u_shapeArabic(const UChar
*source
, int32_t sourceLength
,
1422 UChar
*dest
, int32_t destCapacity
,
1424 UErrorCode
*pErrorCode
) {
1427 struct uShapeVariables shapeVars
= { OLD_TAIL_CHAR
,U_SHAPE_LAMALEF_BEGIN
,U_SHAPE_LAMALEF_END
,U_SHAPE_TASHKEEL_BEGIN
,U_SHAPE_TASHKEEL_END
,0};
1429 /* usual error checking */
1430 if(pErrorCode
==NULL
|| U_FAILURE(*pErrorCode
)) {
1434 /* make sure that no reserved options values are used; allow dest==NULL only for preflighting */
1435 if( source
==NULL
|| sourceLength
<-1 || (dest
==NULL
&& destCapacity
!=0) || destCapacity
<0 ||
1436 (((options
&U_SHAPE_TASHKEEL_MASK
) > 0) &&
1437 ((options
&U_SHAPE_LETTERS_SHAPE_TASHKEEL_ISOLATED
) == U_SHAPE_LETTERS_SHAPE_TASHKEEL_ISOLATED
) ) ||
1438 (((options
&U_SHAPE_TASHKEEL_MASK
) > 0) &&
1439 ((options
&U_SHAPE_LETTERS_MASK
) == U_SHAPE_LETTERS_UNSHAPE
)) ||
1440 (options
&U_SHAPE_DIGIT_TYPE_RESERVED
)==U_SHAPE_DIGIT_TYPE_RESERVED
||
1441 (options
&U_SHAPE_DIGITS_MASK
)==U_SHAPE_DIGITS_RESERVED
||
1442 ((options
&U_SHAPE_LAMALEF_MASK
) != U_SHAPE_LAMALEF_RESIZE
&&
1443 (options
&U_SHAPE_AGGREGATE_TASHKEEL_MASK
) != 0) ||
1444 ((options
&U_SHAPE_AGGREGATE_TASHKEEL_MASK
) == U_SHAPE_AGGREGATE_TASHKEEL
&&
1445 (options
&U_SHAPE_LETTERS_SHAPE_TASHKEEL_ISOLATED
) != U_SHAPE_LETTERS_SHAPE_TASHKEEL_ISOLATED
)
1448 *pErrorCode
=U_ILLEGAL_ARGUMENT_ERROR
;
1451 /* Validate lamalef options */
1452 if(((options
&U_SHAPE_LAMALEF_MASK
) > 0)&&
1453 !(((options
& U_SHAPE_LAMALEF_MASK
)==U_SHAPE_LAMALEF_BEGIN
) ||
1454 ((options
& U_SHAPE_LAMALEF_MASK
)==U_SHAPE_LAMALEF_END
) ||
1455 ((options
& U_SHAPE_LAMALEF_MASK
)==U_SHAPE_LAMALEF_RESIZE
)||
1456 ((options
& U_SHAPE_LAMALEF_MASK
)==U_SHAPE_LAMALEF_AUTO
) ||
1457 ((options
& U_SHAPE_LAMALEF_MASK
)==U_SHAPE_LAMALEF_NEAR
)))
1459 *pErrorCode
=U_ILLEGAL_ARGUMENT_ERROR
;
1462 /* Validate Tashkeel options */
1463 if(((options
&U_SHAPE_TASHKEEL_MASK
) > 0)&&
1464 !(((options
& U_SHAPE_TASHKEEL_MASK
)==U_SHAPE_TASHKEEL_BEGIN
) ||
1465 ((options
& U_SHAPE_TASHKEEL_MASK
)==U_SHAPE_TASHKEEL_END
)
1466 ||((options
& U_SHAPE_TASHKEEL_MASK
)==U_SHAPE_TASHKEEL_RESIZE
)||
1467 ((options
& U_SHAPE_TASHKEEL_MASK
)==U_SHAPE_TASHKEEL_REPLACE_BY_TATWEEL
)))
1469 *pErrorCode
=U_ILLEGAL_ARGUMENT_ERROR
;
1472 /* determine the source length */
1473 if(sourceLength
==-1) {
1474 sourceLength
=u_strlen(source
);
1476 if(sourceLength
<=0) {
1477 return u_terminateUChars(dest
, destCapacity
, 0, pErrorCode
);
1480 /* check that source and destination do not overlap */
1482 ((source
<=dest
&& dest
<source
+sourceLength
) ||
1483 (dest
<=source
&& source
<dest
+destCapacity
))) {
1484 *pErrorCode
=U_ILLEGAL_ARGUMENT_ERROR
;
1488 /* Does Options contain the new Seen Tail Unicode code point option */
1489 if ( (options
&U_SHAPE_TAIL_TYPE_MASK
) == U_SHAPE_TAIL_NEW_UNICODE
){
1490 shapeVars
.tailChar
= NEW_TAIL_CHAR
;
1492 shapeVars
.tailChar
= OLD_TAIL_CHAR
;
1495 if((options
&U_SHAPE_LETTERS_MASK
)!=U_SHAPE_LETTERS_NOOP
) {
1497 UChar
*tempbuffer
, *tempsource
= NULL
;
1498 int32_t outputSize
, spacesCountl
=0, spacesCountr
=0;
1500 if((options
&U_SHAPE_AGGREGATE_TASHKEEL_MASK
)>0) {
1501 int32_t logical_order
= (options
&U_SHAPE_TEXT_DIRECTION_MASK
) == U_SHAPE_TEXT_DIRECTION_LOGICAL
;
1502 int32_t aggregate_tashkeel
=
1503 (options
&(U_SHAPE_AGGREGATE_TASHKEEL_MASK
+U_SHAPE_LETTERS_SHAPE_TASHKEEL_ISOLATED
)) ==
1504 (U_SHAPE_AGGREGATE_TASHKEEL
+U_SHAPE_LETTERS_SHAPE_TASHKEEL_ISOLATED
);
1505 int step
=logical_order
?1:-1;
1506 int j
=logical_order
?-1:2*sourceLength
;
1507 int i
=logical_order
?-1:sourceLength
;
1508 int end
=logical_order
?sourceLength
:-1;
1509 int aggregation_possible
= 1;
1511 UChar prevLink
, currLink
= 0;
1512 int newSourceLength
= 0;
1513 tempsource
= (UChar
*)uprv_malloc(2*sourceLength
*U_SIZEOF_UCHAR
);
1514 if(tempsource
== NULL
) {
1515 *pErrorCode
= U_MEMORY_ALLOCATION_ERROR
;
1519 while ((i
+=step
) != end
) {
1520 prevLink
= currLink
;
1521 currLink
= getLink(source
[i
]);
1522 if (aggregate_tashkeel
&& ((prevLink
|currLink
)&COMBINE
) == COMBINE
&& aggregation_possible
) {
1523 aggregation_possible
= 0;
1524 tempsource
[j
] = (prev
<source
[i
]?prev
:source
[i
])-0x064C+0xFC5E;
1525 currLink
= getLink(tempsource
[j
]);
1527 aggregation_possible
= 1;
1528 tempsource
[j
+=step
] = source
[i
];
1533 source
= tempsource
+(logical_order
?0:j
);
1534 sourceLength
= newSourceLength
;
1537 /* calculate destination size */
1538 /* TODO: do we ever need to do this pure preflighting? */
1539 if(((options
&U_SHAPE_LAMALEF_MASK
)==U_SHAPE_LAMALEF_RESIZE
) ||
1540 ((options
&U_SHAPE_TASHKEEL_MASK
)==U_SHAPE_TASHKEEL_RESIZE
)) {
1541 outputSize
=calculateSize(source
,sourceLength
,destCapacity
,options
);
1543 outputSize
=sourceLength
;
1546 if(outputSize
>destCapacity
) {
1547 *pErrorCode
=U_BUFFER_OVERFLOW_ERROR
;
1548 if (tempsource
!= NULL
) uprv_free(tempsource
);
1553 * need a temporary buffer of size max(outputSize, sourceLength)
1554 * because at first we copy source->temp
1556 if(sourceLength
>outputSize
) {
1557 outputSize
=sourceLength
;
1560 /* Start of Arabic letter shaping part */
1561 if(outputSize
<=UPRV_LENGTHOF(buffer
)) {
1562 outputSize
=UPRV_LENGTHOF(buffer
);
1565 tempbuffer
= (UChar
*)uprv_malloc(outputSize
*U_SIZEOF_UCHAR
);
1568 if(tempbuffer
== NULL
) {
1569 *pErrorCode
= U_MEMORY_ALLOCATION_ERROR
;
1570 if (tempsource
!= NULL
) uprv_free(tempsource
);
1574 uprv_memcpy(tempbuffer
, source
, sourceLength
*U_SIZEOF_UCHAR
);
1575 if (tempsource
!= NULL
){
1576 uprv_free(tempsource
);
1579 if(sourceLength
<outputSize
) {
1580 uprv_memset(tempbuffer
+sourceLength
, 0, (outputSize
-sourceLength
)*U_SIZEOF_UCHAR
);
1583 if((options
&U_SHAPE_TEXT_DIRECTION_MASK
) == U_SHAPE_TEXT_DIRECTION_LOGICAL
) {
1584 countSpaces(tempbuffer
,sourceLength
,options
,&spacesCountl
,&spacesCountr
);
1585 invertBuffer(tempbuffer
,sourceLength
,options
,spacesCountl
,spacesCountr
);
1588 if((options
&U_SHAPE_TEXT_DIRECTION_MASK
) == U_SHAPE_TEXT_DIRECTION_VISUAL_LTR
) {
1589 if((options
&U_SHAPE_SPACES_RELATIVE_TO_TEXT_MASK
) == U_SHAPE_SPACES_RELATIVE_TO_TEXT_BEGIN_END
) {
1590 shapeVars
.spacesRelativeToTextBeginEnd
= 1;
1591 shapeVars
.uShapeLamalefBegin
= U_SHAPE_LAMALEF_END
;
1592 shapeVars
.uShapeLamalefEnd
= U_SHAPE_LAMALEF_BEGIN
;
1593 shapeVars
.uShapeTashkeelBegin
= U_SHAPE_TASHKEEL_END
;
1594 shapeVars
.uShapeTashkeelEnd
= U_SHAPE_TASHKEEL_BEGIN
;
1598 switch(options
&U_SHAPE_LETTERS_MASK
) {
1599 case U_SHAPE_LETTERS_SHAPE
:
1600 if( (options
&U_SHAPE_TASHKEEL_MASK
)> 0
1601 && ((options
&U_SHAPE_TASHKEEL_MASK
) !=U_SHAPE_TASHKEEL_REPLACE_BY_TATWEEL
)) {
1602 /* Call the shaping function with tashkeel flag == 2 for removal of tashkeel */
1603 destLength
= shapeUnicode(tempbuffer
,sourceLength
,destCapacity
,options
,pErrorCode
,2,shapeVars
);
1605 /* default Call the shaping function with tashkeel flag == 1 */
1606 destLength
= shapeUnicode(tempbuffer
,sourceLength
,destCapacity
,options
,pErrorCode
,1,shapeVars
);
1608 /*After shaping text check if user wants to remove tashkeel and replace it with tatweel*/
1609 if( (options
&U_SHAPE_TASHKEEL_MASK
) == U_SHAPE_TASHKEEL_REPLACE_BY_TATWEEL
){
1610 destLength
= handleTashkeelWithTatweel(tempbuffer
,destLength
,destCapacity
,options
,pErrorCode
);
1614 case U_SHAPE_LETTERS_SHAPE_TASHKEEL_ISOLATED
:
1615 /* Call the shaping function with tashkeel flag == 0 */
1616 destLength
= shapeUnicode(tempbuffer
,sourceLength
,destCapacity
,options
,pErrorCode
,0,shapeVars
);
1619 case U_SHAPE_LETTERS_UNSHAPE
:
1620 /* Call the deshaping function */
1621 destLength
= deShapeUnicode(tempbuffer
,sourceLength
,destCapacity
,options
,pErrorCode
,shapeVars
);
1624 /* will never occur because of validity checks above */
1630 * TODO: (markus 2002aug01)
1631 * For as long as we always preflight the outputSize above
1632 * we should U_ASSERT(outputSize==destLength)
1633 * except for the adjustment above before the tempbuffer allocation
1636 if((options
&U_SHAPE_TEXT_DIRECTION_MASK
) == U_SHAPE_TEXT_DIRECTION_LOGICAL
) {
1637 countSpaces(tempbuffer
,destLength
,options
,&spacesCountl
,&spacesCountr
);
1638 invertBuffer(tempbuffer
,destLength
,options
,spacesCountl
,spacesCountr
);
1640 uprv_memcpy(dest
, tempbuffer
, uprv_min(destLength
, destCapacity
)*U_SIZEOF_UCHAR
);
1642 if(tempbuffer
!=buffer
) {
1643 uprv_free(tempbuffer
);
1646 if(destLength
>destCapacity
) {
1647 *pErrorCode
=U_BUFFER_OVERFLOW_ERROR
;
1651 /* End of Arabic letter shaping part */
1654 * No letter shaping:
1655 * just make sure the destination is large enough and copy the string.
1657 if(destCapacity
<sourceLength
) {
1658 /* this catches preflighting, too */
1659 *pErrorCode
=U_BUFFER_OVERFLOW_ERROR
;
1660 return sourceLength
;
1662 uprv_memcpy(dest
, source
, sourceLength
*U_SIZEOF_UCHAR
);
1663 destLength
=sourceLength
;
1667 * Perform number shaping.
1668 * With UTF-16 or UTF-32, the length of the string is constant.
1669 * The easiest way to do this is to operate on the destination and
1670 * "shape" the digits in-place.
1672 if((options
&U_SHAPE_DIGITS_MASK
)!=U_SHAPE_DIGITS_NOOP
) {
1676 /* select the requested digit group */
1677 switch(options
&U_SHAPE_DIGIT_TYPE_MASK
) {
1678 case U_SHAPE_DIGIT_TYPE_AN
:
1679 digitBase
=0x660; /* Unicode: "Arabic-Indic digits" */
1681 case U_SHAPE_DIGIT_TYPE_AN_EXTENDED
:
1682 digitBase
=0x6f0; /* Unicode: "Eastern Arabic-Indic digits (Persian and Urdu)" */
1685 /* will never occur because of validity checks above */
1690 /* perform the requested operation */
1691 switch(options
&U_SHAPE_DIGITS_MASK
) {
1692 case U_SHAPE_DIGITS_EN2AN
:
1693 /* add (digitBase-'0') to each European (ASCII) digit code point */
1695 for(i
=0; i
<destLength
; ++i
) {
1696 if(((uint32_t)dest
[i
]-0x30)<10) {
1701 case U_SHAPE_DIGITS_AN2EN
:
1702 /* subtract (digitBase-'0') from each Arabic digit code point */
1703 for(i
=0; i
<destLength
; ++i
) {
1704 if(((uint32_t)dest
[i
]-(uint32_t)digitBase
)<10) {
1705 dest
[i
]-=digitBase
-0x30;
1709 case U_SHAPE_DIGITS_ALEN2AN_INIT_LR
:
1710 _shapeToArabicDigitsWithContext(dest
, destLength
,
1712 (UBool
)((options
&U_SHAPE_TEXT_DIRECTION_MASK
)==U_SHAPE_TEXT_DIRECTION_LOGICAL
),
1715 case U_SHAPE_DIGITS_ALEN2AN_INIT_AL
:
1716 _shapeToArabicDigitsWithContext(dest
, destLength
,
1718 (UBool
)((options
&U_SHAPE_TEXT_DIRECTION_MASK
)==U_SHAPE_TEXT_DIRECTION_LOGICAL
),
1722 /* will never occur because of validity checks above */
1727 return u_terminateUChars(dest
, destCapacity
, destLength
, pErrorCode
);