2 ******************************************************************************
4 * Copyright (C) 2000-2012, 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"
29 #define LENGTHOF(array) (int32_t)(sizeof(array)/sizeof((array)[0]))
32 * This implementation is designed for 16-bit Unicode strings.
33 * The main assumption is that the Arabic characters and their
34 * presentation forms each fit into a single UChar.
35 * With UTF-8, they occupy 2 or 3 bytes, and more than the ASCII
40 * ### TODO in general for letter shaping:
41 * - the letter shaping code is UTF-16-unaware; needs update
42 * + especially invertBuffer()?!
43 * - needs to handle the "Arabic Tail" that is used in some legacy codepages
44 * as a glyph fragment of wide-glyph letters
45 * + IBM Unicode conversion tables map it to U+200B (ZWSP)
46 * + IBM Egypt has proposed to encode the tail in Unicode among Arabic Presentation Forms
49 /* definitions for Arabic letter shaping ------------------------------------ */
59 #define COMBINE (SHADDA+CSHADDA)
61 #define HAMZAFE_CHAR 0xfe80
62 #define HAMZA06_CHAR 0x0621
63 #define YEH_HAMZA_CHAR 0x0626
64 #define YEH_HAMZAFE_CHAR 0xFE89
65 #define LAMALEF_SPACE_SUB 0xFFFF
66 #define TASHKEEL_SPACE_SUB 0xFFFE
67 #define NEW_TAIL_CHAR 0xFE73
68 #define OLD_TAIL_CHAR 0x200B
69 #define LAM_CHAR 0x0644
70 #define SPACE_CHAR 0x0020
71 #define SHADDA_CHAR 0xFE7C
72 #define TATWEEL_CHAR 0x0640
73 #define SHADDA_TATWEEL_CHAR 0xFE7D
74 #define SHADDA06_CHAR 0x0651
77 #define DESHAPE_MODE 1
79 struct uShapeVariables
{
81 uint32_t uShapeLamalefBegin
;
82 uint32_t uShapeLamalefEnd
;
83 uint32_t uShapeTashkeelBegin
;
84 uint32_t uShapeTashkeelEnd
;
85 int spacesRelativeToTextBeginEnd
;
88 static const uint8_t tailFamilyIsolatedFinal
[] = {
105 static const uint8_t tashkeelMedial
[] = {
124 static const UChar yehHamzaToYeh
[] =
126 /* isolated*/ 0xFEEF,
130 static const uint8_t IrrelevantPos
[] = {
136 static const UChar convertLamAlef
[] =
148 static const UChar araLink
[178]=
150 1 + 32 + 256 * 0x11,/*0x0622*/
151 1 + 32 + 256 * 0x13,/*0x0623*/
152 1 + 256 * 0x15,/*0x0624*/
153 1 + 32 + 256 * 0x17,/*0x0625*/
154 1 + 2 + 256 * 0x19,/*0x0626*/
155 1 + 32 + 256 * 0x1D,/*0x0627*/
156 1 + 2 + 256 * 0x1F,/*0x0628*/
157 1 + 256 * 0x23,/*0x0629*/
158 1 + 2 + 256 * 0x25,/*0x062A*/
159 1 + 2 + 256 * 0x29,/*0x062B*/
160 1 + 2 + 256 * 0x2D,/*0x062C*/
161 1 + 2 + 256 * 0x31,/*0x062D*/
162 1 + 2 + 256 * 0x35,/*0x062E*/
163 1 + 256 * 0x39,/*0x062F*/
164 1 + 256 * 0x3B,/*0x0630*/
165 1 + 256 * 0x3D,/*0x0631*/
166 1 + 256 * 0x3F,/*0x0632*/
167 1 + 2 + 256 * 0x41,/*0x0633*/
168 1 + 2 + 256 * 0x45,/*0x0634*/
169 1 + 2 + 256 * 0x49,/*0x0635*/
170 1 + 2 + 256 * 0x4D,/*0x0636*/
171 1 + 2 + 256 * 0x51,/*0x0637*/
172 1 + 2 + 256 * 0x55,/*0x0638*/
173 1 + 2 + 256 * 0x59,/*0x0639*/
174 1 + 2 + 256 * 0x5D,/*0x063A*/
175 0, 0, 0, 0, 0, /*0x063B-0x063F*/
177 1 + 2 + 256 * 0x61,/*0x0641*/
178 1 + 2 + 256 * 0x65,/*0x0642*/
179 1 + 2 + 256 * 0x69,/*0x0643*/
180 1 + 2 + 16 + 256 * 0x6D,/*0x0644*/
181 1 + 2 + 256 * 0x71,/*0x0645*/
182 1 + 2 + 256 * 0x75,/*0x0646*/
183 1 + 2 + 256 * 0x79,/*0x0647*/
184 1 + 256 * 0x7D,/*0x0648*/
185 1 + 256 * 0x7F,/*0x0649*/
186 1 + 2 + 256 * 0x81,/*0x064A*/
187 4 + 256 * 1, /*0x064B*/
188 4 + 128 + 256 * 1, /*0x064C*/
189 4 + 128 + 256 * 1, /*0x064D*/
190 4 + 128 + 256 * 1, /*0x064E*/
191 4 + 128 + 256 * 1, /*0x064F*/
192 4 + 128 + 256 * 1, /*0x0650*/
193 4 + 64 + 256 * 3, /*0x0651*/
194 4 + 256 * 1, /*0x0652*/
195 4 + 256 * 7, /*0x0653*/
196 4 + 256 * 8, /*0x0654*/
197 4 + 256 * 8, /*0x0655*/
198 4 + 256 * 1, /*0x0656*/
199 0, 0, 0, 0, 0, /*0x0657-0x065B*/
200 1 + 256 * 0x85,/*0x065C*/
201 1 + 256 * 0x87,/*0x065D*/
202 1 + 256 * 0x89,/*0x065E*/
203 1 + 256 * 0x8B,/*0x065F*/
204 0, 0, 0, 0, 0, /*0x0660-0x0664*/
205 0, 0, 0, 0, 0, /*0x0665-0x0669*/
206 0, 0, 0, 0, 0, 0, /*0x066A-0x066F*/
207 4 + 256 * 6, /*0x0670*/
208 1 + 8 + 256 * 0x00,/*0x0671*/
213 1, 1, /*0x0676-0x0677*/
214 1+2, 1+2, 1+2, 1+2, 1+2, 1+2, /*0x0678-0x067D*/
215 1+2+8+256 * 0x06, 1+2, 1+2, 1+2, 1+2, 1+2, /*0x067E-0x0683*/
216 1+2, 1+2, 1+2+8+256 * 0x2A, 1+2, /*0x0684-0x0687*/
217 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, /*0x0688-0x0691*/
218 1, 1, 1, 1, 1, 1, 1+8+256 * 0x3A, 1, /*0x0692-0x0699*/
219 1+2, 1+2, 1+2, 1+2, 1+2, 1+2, /*0x069A-0x06A3*/
220 1+2, 1+2, 1+2, 1+2, /*0x069A-0x06A3*/
221 1+2, 1+2, 1+2, 1+2, 1+2, 1+2+8+256 * 0x3E, /*0x06A4-0x06AD*/
222 1+2, 1+2, 1+2, 1+2, /*0x06A4-0x06AD*/
223 1+2, 1+2+8+256 * 0x42, 1+2, 1+2, 1+2, 1+2, /*0x06AE-0x06B7*/
224 1+2, 1+2, 1+2, 1+2, /*0x06AE-0x06B7*/
225 1+2, 1+2, 1+2, 1+2, 1+2, 1+2, /*0x06B8-0x06BF*/
226 1+2, 1+2, /*0x06B8-0x06BF*/
229 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, /*0x06C2-0x06CB*/
230 1+2+8+256 * 0xAC, /*0x06CC*/
232 1+2, 1+2, 1+2, 1+2, /*0x06CE-0x06D1*/
233 1, 1 /*0x06D2-0x06D3*/
236 static const uint8_t presALink
[] = {
237 /***********0*****1*****2*****3*****4*****5*****6*****7*****8*****9*****A*****B*****C*****D*****E*****F*/
238 /*FB5*/ 0, 1, 0, 0, 0, 0, 0, 1, 2,1 + 2, 0, 0, 0, 0, 0, 0,
239 /*FB6*/ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
240 /*FB7*/ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 2,1 + 2, 0, 0,
241 /*FB8*/ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 0, 0, 0, 1,
242 /*FB9*/ 2,1 + 2, 0, 1, 2,1 + 2, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
243 /*FBA*/ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
244 /*FBB*/ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
245 /*FBC*/ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
246 /*FBD*/ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
247 /*FBE*/ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
248 /*FBF*/ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 2,1 + 2,
249 /*FC0*/ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
250 /*FC1*/ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
251 /*FC2*/ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
252 /*FC3*/ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
253 /*FC4*/ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
254 /*FC5*/ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 4, 4,
258 static const uint8_t presBLink
[]=
260 /***********0*****1*****2*****3*****4*****5*****6*****7*****8*****9*****A*****B*****C*****D*****E*****F*/
261 /*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,
262 /*FE8*/ 0, 0, 1, 0, 1, 0, 1, 0, 1, 0, 1, 2,1 + 2, 0, 1, 0,
263 /*FE9*/ 1, 2,1 + 2, 0, 1, 0, 1, 2,1 + 2, 0, 1, 2,1 + 2, 0, 1, 2,
264 /*FEA*/1 + 2, 0, 1, 2,1 + 2, 0, 1, 2,1 + 2, 0, 1, 0, 1, 0, 1, 0,
265 /*FEB*/ 1, 0, 1, 2,1 + 2, 0, 1, 2,1 + 2, 0, 1, 2,1 + 2, 0, 1, 2,
266 /*FEC*/1 + 2, 0, 1, 2,1 + 2, 0, 1, 2,1 + 2, 0, 1, 2,1 + 2, 0, 1, 2,
267 /*FED*/1 + 2, 0, 1, 2,1 + 2, 0, 1, 2,1 + 2, 0, 1, 2,1 + 2, 0, 1, 2,
268 /*FEE*/1 + 2, 0, 1, 2,1 + 2, 0, 1, 2,1 + 2, 0, 1, 2,1 + 2, 0, 1, 0,
269 /*FEF*/ 1, 0, 1, 2,1 + 2, 0, 1, 0, 1, 0, 1, 0, 1, 0, 0, 0
272 static const UChar convertFBto06
[] =
274 /***********0******1******2******3******4******5******6******7******8******9******A******B******C******D******E******F***/
275 /*FB5*/ 0x671, 0x671, 0, 0, 0, 0, 0x07E, 0x07E, 0x07E, 0x07E, 0, 0, 0, 0, 0, 0,
276 /*FB6*/ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
277 /*FB7*/ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0x686, 0x686, 0x686, 0x686, 0, 0,
278 /*FB8*/ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0x698, 0x698, 0, 0, 0x6A9, 0x6A9,
279 /*FB9*/ 0x6A9, 0x6A9, 0x6AF, 0x6AF, 0x6AF, 0x6AF, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
280 /*FBA*/ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
281 /*FBB*/ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
282 /*FBC*/ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
283 /*FBD*/ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
284 /*FBE*/ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
285 /*FBF*/ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0x6CC, 0x6CC, 0x6CC, 0x6CC
288 static const UChar convertFEto06
[] =
290 /***********0******1******2******3******4******5******6******7******8******9******A******B******C******D******E******F***/
291 /*FE7*/ 0x64B, 0x64B, 0x64C, 0x64C, 0x64D, 0x64D, 0x64E, 0x64E, 0x64F, 0x64F, 0x650, 0x650, 0x651, 0x651, 0x652, 0x652,
292 /*FE8*/ 0x621, 0x622, 0x622, 0x623, 0x623, 0x624, 0x624, 0x625, 0x625, 0x626, 0x626, 0x626, 0x626, 0x627, 0x627, 0x628,
293 /*FE9*/ 0x628, 0x628, 0x628, 0x629, 0x629, 0x62A, 0x62A, 0x62A, 0x62A, 0x62B, 0x62B, 0x62B, 0x62B, 0x62C, 0x62C, 0x62C,
294 /*FEA*/ 0x62C, 0x62D, 0x62D, 0x62D, 0x62D, 0x62E, 0x62E, 0x62E, 0x62E, 0x62F, 0x62F, 0x630, 0x630, 0x631, 0x631, 0x632,
295 /*FEB*/ 0x632, 0x633, 0x633, 0x633, 0x633, 0x634, 0x634, 0x634, 0x634, 0x635, 0x635, 0x635, 0x635, 0x636, 0x636, 0x636,
296 /*FEC*/ 0x636, 0x637, 0x637, 0x637, 0x637, 0x638, 0x638, 0x638, 0x638, 0x639, 0x639, 0x639, 0x639, 0x63A, 0x63A, 0x63A,
297 /*FED*/ 0x63A, 0x641, 0x641, 0x641, 0x641, 0x642, 0x642, 0x642, 0x642, 0x643, 0x643, 0x643, 0x643, 0x644, 0x644, 0x644,
298 /*FEE*/ 0x644, 0x645, 0x645, 0x645, 0x645, 0x646, 0x646, 0x646, 0x646, 0x647, 0x647, 0x647, 0x647, 0x648, 0x648, 0x649,
299 /*FEF*/ 0x649, 0x64A, 0x64A, 0x64A, 0x64A, 0x65C, 0x65C, 0x65D, 0x65D, 0x65E, 0x65E, 0x65F, 0x65F
302 static const uint8_t shapeTable
[4][4][4]=
304 { {0,0,0,0}, {0,0,0,0}, {0,1,0,3}, {0,1,0,1} },
305 { {0,0,2,2}, {0,0,1,2}, {0,1,1,2}, {0,1,1,3} },
306 { {0,0,0,0}, {0,0,0,0}, {0,1,0,3}, {0,1,0,3} },
307 { {0,0,1,2}, {0,0,1,2}, {0,1,1,2}, {0,1,1,3} }
311 * This function shapes European digits to Arabic-Indic digits
312 * in-place, writing over the input characters.
313 * Since we know that we are only looking for BMP code points,
314 * we can safely just work with code units (again, at least UTF-16).
317 _shapeToArabicDigitsWithContext(UChar
*s
, int32_t length
,
319 UBool isLogical
, UBool lastStrongWasAL
) {
320 const UBiDiProps
*bdp
;
324 bdp
=ubidi_getSingleton();
327 /* the iteration direction depends on the type of input */
329 for(i
=0; i
<length
; ++i
) {
331 switch(ubidi_getClass(bdp
, c
)) {
332 case U_LEFT_TO_RIGHT
: /* L */
333 case U_RIGHT_TO_LEFT
: /* R */
334 lastStrongWasAL
=FALSE
;
336 case U_RIGHT_TO_LEFT_ARABIC
: /* AL */
337 lastStrongWasAL
=TRUE
;
339 case U_EUROPEAN_NUMBER
: /* EN */
340 if(lastStrongWasAL
&& (uint32_t)(c
-0x30)<10) {
341 s
[i
]=(UChar
)(digitBase
+c
); /* digitBase+(c-0x30) - digitBase was modified above */
349 for(i
=length
; i
>0; /* pre-decrement in the body */) {
351 switch(ubidi_getClass(bdp
, c
)) {
352 case U_LEFT_TO_RIGHT
: /* L */
353 case U_RIGHT_TO_LEFT
: /* R */
354 lastStrongWasAL
=FALSE
;
356 case U_RIGHT_TO_LEFT_ARABIC
: /* AL */
357 lastStrongWasAL
=TRUE
;
359 case U_EUROPEAN_NUMBER
: /* EN */
360 if(lastStrongWasAL
&& (uint32_t)(c
-0x30)<10) {
361 s
[i
]=(UChar
)(digitBase
+c
); /* digitBase+(c-0x30) - digitBase was modified above */
373 *Function : This function inverts the buffer, it's used
374 * in case the user specifies the buffer to be
375 * U_SHAPE_TEXT_DIRECTION_LOGICAL
378 invertBuffer(UChar
*buffer
, int32_t size
, uint32_t /*options*/, int32_t lowlimit
, int32_t highlimit
) {
381 for(i
=lowlimit
,j
=size
-highlimit
-1;i
<j
;i
++,j
--) {
383 buffer
[i
] = buffer
[j
];
389 *Name : changeLamAlef
390 *Function : Converts the Alef characters into an equivalent
391 * LamAlef location in the 0x06xx Range, this is an
392 * intermediate stage in the operation of the program
393 * later it'll be converted into the 0xFExx LamAlefs
394 * in the shaping function.
397 changeLamAlef(UChar ch
) {
413 *Function : Resolves the link between the characters as
414 * Arabic characters have four forms :
415 * Isolated, Initial, Middle and Final Form
419 if(ch
>= 0x0622 && ch
<= 0x06D3) {
420 return(araLink
[ch
-0x0622]);
421 } else if(ch
== 0x200D) {
423 } else if(ch
>= 0x206D && ch
<= 0x206F) {
425 }else if(ch
>= 0xFB50 && ch
<= 0xFC62) {
426 return(presALink
[ch
-0xFB50]);
427 } else if(ch
>= 0xFE70 && ch
<= 0xFEFC) {
428 return(presBLink
[ch
-0xFE70]);
436 *Function : Counts the number of spaces
437 * at each end of the logical buffer
440 countSpaces(UChar
*dest
, int32_t size
, uint32_t /*options*/, int32_t *spacesCountl
, int32_t *spacesCountr
) {
442 int32_t countl
= 0,countr
= 0;
443 while((dest
[i
] == SPACE_CHAR
) && (countl
< size
)) {
447 if (countl
< size
) { /* the entire buffer is not all space */
448 while(dest
[size
-1] == SPACE_CHAR
) {
453 *spacesCountl
= countl
;
454 *spacesCountr
= countr
;
458 *Name : isTashkeelChar
459 *Function : Returns 1 for Tashkeel characters in 06 range else return 0
461 static inline int32_t
462 isTashkeelChar(UChar ch
) {
463 return (int32_t)( ch
>=0x064B && ch
<= 0x0652 );
467 *Name : isTashkeelCharFE
468 *Function : Returns 1 for Tashkeel characters in FE range else return 0
470 static inline int32_t
471 isTashkeelCharFE(UChar ch
) {
472 return (int32_t)( ch
>=0xFE70 && ch
<= 0xFE7F );
477 *Function : Returns 1 for Alef characters else return 0
479 static inline int32_t
480 isAlefChar(UChar ch
) {
481 return (int32_t)( (ch
==0x0622)||(ch
==0x0623)||(ch
==0x0625)||(ch
==0x0627) );
485 *Name : isLamAlefChar
486 *Function : Returns 1 for LamAlef characters else return 0
488 static inline int32_t
489 isLamAlefChar(UChar ch
) {
490 return (int32_t)((ch
>=0xFEF5)&&(ch
<=0xFEFC) );
495 *Function : returns 1 if the character matches one of the tail characters (0xfe73 or 0x200b) otherwise returns 0
498 static inline int32_t
499 isTailChar(UChar ch
) {
500 if(ch
== OLD_TAIL_CHAR
|| ch
== NEW_TAIL_CHAR
){
508 *Name : isSeenTailFamilyChar
509 *Function : returns 1 if the character is a seen family isolated character
510 * in the FE range otherwise returns 0
513 static inline int32_t
514 isSeenTailFamilyChar(UChar ch
) {
515 if(ch
>= 0xfeb1 && ch
< 0xfebf){
516 return tailFamilyIsolatedFinal
[ch
- 0xFEB1];
522 /* Name : isSeenFamilyChar
523 * Function : returns 1 if the character is a seen family character in the Unicode
524 * 06 range otherwise returns 0
527 static inline int32_t
528 isSeenFamilyChar(UChar ch
){
529 if(ch
>= 0x633 && ch
<= 0x636){
538 *Name : isAlefMaksouraChar
539 *Function : returns 1 if the character is a Alef Maksoura Final or isolated
540 * otherwise returns 0
542 static inline int32_t
543 isAlefMaksouraChar(UChar ch
) {
544 return (int32_t)( (ch
== 0xFEEF) || ( ch
== 0xFEF0) || (ch
== 0x0649));
548 * Name : isYehHamzaChar
549 * Function : returns 1 if the character is a yehHamza isolated or yehhamza
550 * final is found otherwise returns 0
552 static inline int32_t
553 isYehHamzaChar(UChar ch
) {
554 if((ch
==0xFE89)||(ch
==0xFE8A)){
562 * Name: isTashkeelOnTatweelChar
563 * Function: Checks if the Tashkeel Character is on Tatweel or not,if the
564 * Tashkeel on tatweel (FE range), it returns 1 else if the
565 * Tashkeel with shadda on tatweel (FC range)return 2 otherwise
568 static inline int32_t
569 isTashkeelOnTatweelChar(UChar ch
){
570 if(ch
>= 0xfe70 && ch
<= 0xfe7f && ch
!= NEW_TAIL_CHAR
&& ch
!= 0xFE75 && ch
!= SHADDA_TATWEEL_CHAR
)
572 return tashkeelMedial
[ch
- 0xFE70];
573 }else if( (ch
>= 0xfcf2 && ch
<= 0xfcf4) || (ch
== SHADDA_TATWEEL_CHAR
)) {
581 * Name: isIsolatedTashkeelChar
582 * Function: Checks if the Tashkeel Character is in the isolated form
583 * (i.e. Unicode FE range) returns 1 else if the Tashkeel
584 * with shadda is in the isolated form (i.e. Unicode FC range)
585 * returns 2 otherwise returns 0
587 static inline int32_t
588 isIsolatedTashkeelChar(UChar ch
){
589 if(ch
>= 0xfe70 && ch
<= 0xfe7f && ch
!= NEW_TAIL_CHAR
&& ch
!= 0xFE75){
590 return (1 - tashkeelMedial
[ch
- 0xFE70]);
591 }else if(ch
>= 0xfc5e && ch
<= 0xfc63){
602 *Name : calculateSize
603 *Function : This function calculates the destSize to be used in preflighting
604 * when the destSize is equal to 0
605 * It is used also to calculate the new destsize in case the
606 * destination buffer will be resized.
610 calculateSize(const UChar
*source
, int32_t sourceLength
,
611 int32_t destSize
,uint32_t options
) {
614 int lamAlefOption
= 0;
615 int tashkeelOption
= 0;
617 destSize
= sourceLength
;
619 if (((options
&U_SHAPE_LETTERS_MASK
) == U_SHAPE_LETTERS_SHAPE
||
620 ((options
&U_SHAPE_LETTERS_MASK
) == U_SHAPE_LETTERS_SHAPE_TASHKEEL_ISOLATED
)) &&
621 ((options
&U_SHAPE_LAMALEF_MASK
) == U_SHAPE_LAMALEF_RESIZE
)){
624 if((options
&U_SHAPE_LETTERS_MASK
) == U_SHAPE_LETTERS_SHAPE
&&
625 ((options
&U_SHAPE_TASHKEEL_MASK
) == U_SHAPE_TASHKEEL_RESIZE
) ){
629 if(lamAlefOption
|| tashkeelOption
){
630 if((options
&U_SHAPE_TEXT_DIRECTION_MASK
)==U_SHAPE_TEXT_DIRECTION_VISUAL_LTR
) {
631 for(i
=0;i
<sourceLength
;i
++) {
632 if( ((isAlefChar(source
[i
]))&& (i
<(sourceLength
-1)) &&(source
[i
+1] == LAM_CHAR
)) || (isTashkeelCharFE(source
[i
])) ) {
636 }else if((options
&U_SHAPE_TEXT_DIRECTION_MASK
)==U_SHAPE_TEXT_DIRECTION_LOGICAL
) {
637 for(i
=0;i
<sourceLength
;i
++) {
638 if( ( (source
[i
] == LAM_CHAR
) && (i
<(sourceLength
-1)) && (isAlefChar(source
[i
+1]))) || (isTashkeelCharFE(source
[i
])) ) {
645 if ((options
&U_SHAPE_LETTERS_MASK
) == U_SHAPE_LETTERS_UNSHAPE
){
646 if ( (options
&U_SHAPE_LAMALEF_MASK
) == U_SHAPE_LAMALEF_RESIZE
){
647 for(i
=0;i
<sourceLength
;i
++) {
648 if(isLamAlefChar(source
[i
]))
658 *Name : handleTashkeelWithTatweel
659 *Function : Replaces Tashkeel as following:
660 * Case 1 :if the Tashkeel on tatweel, replace it with Tatweel.
661 * Case 2 :if the Tashkeel aggregated with Shadda on Tatweel, replace
662 * it with Shadda on Tatweel.
663 * Case 3: if the Tashkeel is isolated replace it with Space.
667 handleTashkeelWithTatweel(UChar
*dest
, int32_t sourceLength
,
668 int32_t /*destSize*/, uint32_t /*options*/,
669 UErrorCode
* /*pErrorCode*/) {
671 for(i
= 0; i
< sourceLength
; i
++){
672 if((isTashkeelOnTatweelChar(dest
[i
]) == 1)){
673 dest
[i
] = TATWEEL_CHAR
;
674 }else if((isTashkeelOnTatweelChar(dest
[i
]) == 2)){
675 dest
[i
] = SHADDA_TATWEEL_CHAR
;
676 }else if(isIsolatedTashkeelChar(dest
[i
]) && dest
[i
] != SHADDA_CHAR
){
677 dest
[i
] = SPACE_CHAR
;
686 *Name : handleGeneratedSpaces
687 *Function : The shapeUnicode function converts Lam + Alef into LamAlef + space,
688 * and Tashkeel to space.
689 * handleGeneratedSpaces function puts these generated spaces
690 * according to the options the user specifies. LamAlef and Tashkeel
691 * spaces can be replaced at begin, at end, at near or decrease the
694 * There is also Auto option for LamAlef and tashkeel, which will put
695 * the spaces at end of the buffer (or end of text if the user used
696 * the option U_SHAPE_SPACES_RELATIVE_TO_TEXT_BEGIN_END).
698 * If the text type was visual_LTR and the option
699 * U_SHAPE_SPACES_RELATIVE_TO_TEXT_BEGIN_END was selected the END
700 * option will place the space at the beginning of the buffer and
701 * BEGIN will place the space at the end of the buffer.
705 handleGeneratedSpaces(UChar
*dest
, int32_t sourceLength
,
708 UErrorCode
*pErrorCode
,struct uShapeVariables shapeVars
) {
710 int32_t i
= 0, j
= 0;
712 UChar
*tempbuffer
=NULL
;
714 int lamAlefOption
= 0;
715 int tashkeelOption
= 0;
716 int shapingMode
= SHAPE_MODE
;
718 if (shapingMode
== 0){
719 if ( (options
&U_SHAPE_LAMALEF_MASK
) == U_SHAPE_LAMALEF_RESIZE
){
722 if ( (options
&U_SHAPE_TASHKEEL_MASK
) == U_SHAPE_TASHKEEL_RESIZE
){
727 tempbuffer
= (UChar
*)uprv_malloc((sourceLength
+1)*U_SIZEOF_UCHAR
);
729 if(tempbuffer
== NULL
) {
730 *pErrorCode
= U_MEMORY_ALLOCATION_ERROR
;
735 if (lamAlefOption
|| tashkeelOption
){
736 uprv_memset(tempbuffer
, 0, (sourceLength
+1)*U_SIZEOF_UCHAR
);
738 i
= j
= 0; count
= 0;
739 while(i
< sourceLength
) {
740 if ( (lamAlefOption
&& dest
[i
] == LAMALEF_SPACE_SUB
) ||
741 (tashkeelOption
&& dest
[i
] == TASHKEEL_SPACE_SUB
) ){
745 tempbuffer
[j
] = dest
[i
];
752 tempbuffer
[i
] = 0x0000;
757 uprv_memcpy(dest
, tempbuffer
, sourceLength
*U_SIZEOF_UCHAR
);
758 destSize
= u_strlen(dest
);
763 if (shapingMode
== 0){
764 if ( (options
&U_SHAPE_LAMALEF_MASK
) == U_SHAPE_LAMALEF_NEAR
){
770 /* Lam+Alef is already shaped into LamAlef + FFFF */
772 while(i
< sourceLength
) {
773 if(lamAlefOption
&&dest
[i
] == LAMALEF_SPACE_SUB
){
774 dest
[i
] = SPACE_CHAR
;
778 destSize
= sourceLength
;
783 if (shapingMode
== 0) {
784 if ( ((options
&U_SHAPE_LAMALEF_MASK
) == shapeVars
.uShapeLamalefBegin
) ||
785 (((options
&U_SHAPE_LAMALEF_MASK
) == U_SHAPE_LAMALEF_AUTO
)
786 && (shapeVars
.spacesRelativeToTextBeginEnd
==1)) ) {
789 if ( (options
&U_SHAPE_TASHKEEL_MASK
) == shapeVars
.uShapeTashkeelBegin
) {
794 if(lamAlefOption
|| tashkeelOption
){
795 uprv_memset(tempbuffer
, 0, (sourceLength
+1)*U_SIZEOF_UCHAR
);
797 i
= j
= sourceLength
; count
= 0;
800 if ( (lamAlefOption
&& dest
[i
] == LAMALEF_SPACE_SUB
) ||
801 (tashkeelOption
&& dest
[i
] == TASHKEEL_SPACE_SUB
) ){
805 tempbuffer
[j
] = dest
[i
];
811 for(i
=0 ;i
< count
; i
++){
812 tempbuffer
[i
] = SPACE_CHAR
;
815 uprv_memcpy(dest
, tempbuffer
, sourceLength
*U_SIZEOF_UCHAR
);
816 destSize
= sourceLength
;
824 if (shapingMode
== 0) {
825 if ( ((options
&U_SHAPE_LAMALEF_MASK
) == shapeVars
.uShapeLamalefEnd
) ||
826 (((options
&U_SHAPE_LAMALEF_MASK
) == U_SHAPE_LAMALEF_AUTO
)
827 && (shapeVars
.spacesRelativeToTextBeginEnd
==0)) ) {
830 if ( (options
&U_SHAPE_TASHKEEL_MASK
) == shapeVars
.uShapeTashkeelEnd
){
835 if(lamAlefOption
|| tashkeelOption
){
836 uprv_memset(tempbuffer
, 0, (sourceLength
+1)*U_SIZEOF_UCHAR
);
838 i
= j
= 0; count
= 0;
839 while(i
< sourceLength
) {
840 if ( (lamAlefOption
&& dest
[i
] == LAMALEF_SPACE_SUB
) ||
841 (tashkeelOption
&& dest
[i
] == TASHKEEL_SPACE_SUB
) ){
845 tempbuffer
[j
] = dest
[i
];
852 tempbuffer
[i
] = SPACE_CHAR
;
857 uprv_memcpy(dest
,tempbuffer
, sourceLength
*U_SIZEOF_UCHAR
);
858 destSize
= sourceLength
;
863 uprv_free(tempbuffer
);
870 *Name :expandCompositCharAtBegin
871 *Function :Expands the LamAlef character to Lam and Alef consuming the required
872 * space from beginning of the buffer. If the text type was visual_LTR
873 * and the option U_SHAPE_SPACES_RELATIVE_TO_TEXT_BEGIN_END was selected
874 * the spaces will be located at end of buffer.
875 * If there are no spaces to expand the LamAlef, an error
876 * will be set to U_NO_SPACE_AVAILABLE as defined in utypes.h
880 expandCompositCharAtBegin(UChar
*dest
, int32_t sourceLength
, int32_t destSize
,UErrorCode
*pErrorCode
) {
883 UChar
*tempbuffer
=NULL
;
885 tempbuffer
= (UChar
*)uprv_malloc((sourceLength
+1)*U_SIZEOF_UCHAR
);
888 if(tempbuffer
== NULL
) {
889 *pErrorCode
= U_MEMORY_ALLOCATION_ERROR
;
893 uprv_memset(tempbuffer
, 0, (sourceLength
+1)*U_SIZEOF_UCHAR
);
896 while(dest
[i
] == SPACE_CHAR
) {
901 i
= j
= sourceLength
-1;
903 while(i
>= 0 && j
>= 0) {
904 if( countl
>0 && isLamAlefChar(dest
[i
])) {
905 tempbuffer
[j
] = LAM_CHAR
;
906 /* to ensure the array index is within the range */
907 U_ASSERT(dest
[i
] >= 0xFEF5u
908 && dest
[i
]-0xFEF5u
< sizeof(convertLamAlef
)/sizeof(convertLamAlef
[0]));
909 tempbuffer
[j
-1] = convertLamAlef
[ dest
[i
] - 0xFEF5 ];
913 if( countl
== 0 && isLamAlefChar(dest
[i
]) ) {
914 *pErrorCode
=U_NO_SPACE_AVAILABLE
;
916 tempbuffer
[j
] = dest
[i
];
921 uprv_memcpy(dest
, tempbuffer
, sourceLength
*U_SIZEOF_UCHAR
);
923 uprv_free(tempbuffer
);
925 destSize
= sourceLength
;
930 *Name : expandCompositCharAtEnd
931 *Function : Expands the LamAlef character to Lam and Alef consuming the
932 * required space from end of the buffer. If the text type was
933 * Visual LTR and the option U_SHAPE_SPACES_RELATIVE_TO_TEXT_BEGIN_END
934 * was used, the spaces will be consumed from begin of buffer. If
935 * there are no spaces to expand the LamAlef, an error
936 * will be set to U_NO_SPACE_AVAILABLE as defined in utypes.h
940 expandCompositCharAtEnd(UChar
*dest
, int32_t sourceLength
, int32_t destSize
,UErrorCode
*pErrorCode
) {
944 int32_t inpsize
= sourceLength
;
946 UChar
*tempbuffer
=NULL
;
947 tempbuffer
= (UChar
*)uprv_malloc((sourceLength
+1)*U_SIZEOF_UCHAR
);
950 if(tempbuffer
== NULL
) {
951 *pErrorCode
= U_MEMORY_ALLOCATION_ERROR
;
955 uprv_memset(tempbuffer
, 0, (sourceLength
+1)*U_SIZEOF_UCHAR
);
957 while(dest
[inpsize
-1] == SPACE_CHAR
) {
962 i
= sourceLength
- countr
- 1;
963 j
= sourceLength
- 1;
965 while(i
>= 0 && j
>= 0) {
966 if( countr
>0 && isLamAlefChar(dest
[i
]) ) {
967 tempbuffer
[j
] = LAM_CHAR
;
968 tempbuffer
[j
-1] = convertLamAlef
[ dest
[i
] - 0xFEF5 ];
972 if ((countr
== 0) && isLamAlefChar(dest
[i
]) ) {
973 *pErrorCode
=U_NO_SPACE_AVAILABLE
;
975 tempbuffer
[j
] = dest
[i
];
982 uprv_memmove(tempbuffer
, tempbuffer
+countr
, sourceLength
*U_SIZEOF_UCHAR
);
983 if(u_strlen(tempbuffer
) < sourceLength
) {
984 for(i
=sourceLength
-1;i
>=sourceLength
-countr
;i
--) {
985 tempbuffer
[i
] = SPACE_CHAR
;
989 uprv_memcpy(dest
, tempbuffer
, sourceLength
*U_SIZEOF_UCHAR
);
991 uprv_free(tempbuffer
);
993 destSize
= sourceLength
;
998 *Name : expandCompositCharAtNear
999 *Function : Expands the LamAlef character into Lam + Alef, YehHamza character
1000 * into Yeh + Hamza, SeenFamily character into SeenFamily character
1001 * + Tail, while consuming the space next to the character.
1002 * If there are no spaces next to the character, an error
1003 * will be set to U_NO_SPACE_AVAILABLE as defined in utypes.h
1007 expandCompositCharAtNear(UChar
*dest
, int32_t sourceLength
, int32_t destSize
,UErrorCode
*pErrorCode
,
1008 int yehHamzaOption
, int seenTailOption
, int lamAlefOption
, struct uShapeVariables shapeVars
) {
1012 UChar lamalefChar
, yehhamzaChar
;
1014 for(i
= 0 ;i
<=sourceLength
-1;i
++) {
1015 if (seenTailOption
&& isSeenTailFamilyChar(dest
[i
])) {
1016 if ((i
>0) && (dest
[i
-1] == SPACE_CHAR
) ) {
1017 dest
[i
-1] = shapeVars
.tailChar
;
1019 *pErrorCode
=U_NO_SPACE_AVAILABLE
;
1021 }else if(yehHamzaOption
&& (isYehHamzaChar(dest
[i
])) ) {
1022 if ((i
>0) && (dest
[i
-1] == SPACE_CHAR
) ) {
1023 yehhamzaChar
= dest
[i
];
1024 dest
[i
] = yehHamzaToYeh
[yehhamzaChar
- YEH_HAMZAFE_CHAR
];
1025 dest
[i
-1] = HAMZAFE_CHAR
;
1028 *pErrorCode
=U_NO_SPACE_AVAILABLE
;
1030 }else if(lamAlefOption
&& isLamAlefChar(dest
[i
+1])) {
1031 if(dest
[i
] == SPACE_CHAR
){
1032 lamalefChar
= dest
[i
+1];
1033 dest
[i
+1] = LAM_CHAR
;
1034 dest
[i
] = convertLamAlef
[ lamalefChar
- 0xFEF5 ];
1036 *pErrorCode
=U_NO_SPACE_AVAILABLE
;
1040 destSize
= sourceLength
;
1044 * Name : expandCompositChar
1045 * Function : LamAlef, need special handling, since it expands from one
1046 * character into two characters while shaping or deshaping.
1047 * In order to expand it, near or far spaces according to the
1048 * options user specifies. Also buffer size can be increased.
1050 * For SeenFamily characters and YehHamza only the near option is
1051 * supported, while for LamAlef we can take spaces from begin, end,
1052 * near or even increase the buffer size.
1053 * There is also the Auto option for LamAlef only, which will first
1054 * search for a space at end, begin then near, respectively.
1055 * If there are no spaces to expand these characters, an error will be set to
1056 * U_NO_SPACE_AVAILABLE as defined in utypes.h
1060 expandCompositChar(UChar
*dest
, int32_t sourceLength
,
1061 int32_t destSize
,uint32_t options
,
1062 UErrorCode
*pErrorCode
, int shapingMode
,struct uShapeVariables shapeVars
) {
1064 int32_t i
= 0,j
= 0;
1066 UChar
*tempbuffer
=NULL
;
1067 int yehHamzaOption
= 0;
1068 int seenTailOption
= 0;
1069 int lamAlefOption
= 0;
1071 if (shapingMode
== 1){
1072 if ( (options
&U_SHAPE_LAMALEF_MASK
) == U_SHAPE_LAMALEF_AUTO
){
1074 if(shapeVars
.spacesRelativeToTextBeginEnd
== 0) {
1075 destSize
= expandCompositCharAtEnd(dest
, sourceLength
, destSize
, pErrorCode
);
1077 if(*pErrorCode
== U_NO_SPACE_AVAILABLE
) {
1078 *pErrorCode
= U_ZERO_ERROR
;
1079 destSize
= expandCompositCharAtBegin(dest
, sourceLength
, destSize
, pErrorCode
);
1082 destSize
= expandCompositCharAtBegin(dest
, sourceLength
, destSize
, pErrorCode
);
1084 if(*pErrorCode
== U_NO_SPACE_AVAILABLE
) {
1085 *pErrorCode
= U_ZERO_ERROR
;
1086 destSize
= expandCompositCharAtEnd(dest
, sourceLength
, destSize
, pErrorCode
);
1090 if(*pErrorCode
== U_NO_SPACE_AVAILABLE
) {
1091 *pErrorCode
= U_ZERO_ERROR
;
1092 destSize
= expandCompositCharAtNear(dest
, sourceLength
, destSize
, pErrorCode
, yehHamzaOption
,
1093 seenTailOption
, 1,shapeVars
);
1098 if (shapingMode
== 1){
1099 if ( (options
&U_SHAPE_LAMALEF_MASK
) == shapeVars
.uShapeLamalefEnd
){
1100 destSize
= expandCompositCharAtEnd(dest
, sourceLength
, destSize
, pErrorCode
);
1104 if (shapingMode
== 1){
1105 if ( (options
&U_SHAPE_LAMALEF_MASK
) == shapeVars
.uShapeLamalefBegin
){
1106 destSize
= expandCompositCharAtBegin(dest
, sourceLength
, destSize
, pErrorCode
);
1110 if (shapingMode
== 0){
1111 if ((options
&U_SHAPE_YEHHAMZA_MASK
) == U_SHAPE_YEHHAMZA_TWOCELL_NEAR
){
1114 if ((options
&U_SHAPE_SEEN_MASK
) == U_SHAPE_SEEN_TWOCELL_NEAR
){
1118 if (shapingMode
== 1) {
1119 if ( (options
&U_SHAPE_LAMALEF_MASK
) == U_SHAPE_LAMALEF_NEAR
) {
1125 if (yehHamzaOption
|| seenTailOption
|| lamAlefOption
){
1126 destSize
= expandCompositCharAtNear(dest
, sourceLength
, destSize
, pErrorCode
, yehHamzaOption
,
1127 seenTailOption
,lamAlefOption
,shapeVars
);
1131 if (shapingMode
== 1){
1132 if ( (options
&U_SHAPE_LAMALEF_MASK
) == U_SHAPE_LAMALEF_RESIZE
){
1133 destSize
= calculateSize(dest
,sourceLength
,destSize
,options
);
1134 tempbuffer
= (UChar
*)uprv_malloc((destSize
+1)*U_SIZEOF_UCHAR
);
1137 if(tempbuffer
== NULL
) {
1138 *pErrorCode
= U_MEMORY_ALLOCATION_ERROR
;
1142 uprv_memset(tempbuffer
, 0, (destSize
+1)*U_SIZEOF_UCHAR
);
1145 while(i
< destSize
&& j
< destSize
) {
1146 if(isLamAlefChar(dest
[i
]) ) {
1147 tempbuffer
[j
] = convertLamAlef
[ dest
[i
] - 0xFEF5 ];
1148 tempbuffer
[j
+1] = LAM_CHAR
;
1151 tempbuffer
[j
] = dest
[i
];
1157 uprv_memcpy(dest
, tempbuffer
, destSize
*U_SIZEOF_UCHAR
);
1162 uprv_free(tempbuffer
);
1168 *Name : shapeUnicode
1169 *Function : Converts an Arabic Unicode buffer in 06xx Range into a shaped
1170 * arabic Unicode buffer in FExx Range
1173 shapeUnicode(UChar
*dest
, int32_t sourceLength
,
1174 int32_t destSize
,uint32_t options
,
1175 UErrorCode
*pErrorCode
,
1176 int tashkeelFlag
, struct uShapeVariables shapeVars
) {
1180 int32_t lastPos
,Nx
, Nw
;
1182 int32_t lamalef_found
= 0;
1183 int32_t seenfamFound
= 0, yehhamzaFound
=0, tashkeelFound
= 0;
1184 UChar prevLink
= 0, lastLink
= 0, currLink
, nextLink
= 0;
1188 * Converts the input buffer from FExx Range into 06xx Range
1189 * to make sure that all characters are in the 06xx range
1190 * even the lamalef is converted to the special region in
1193 if ((options
& U_SHAPE_PRESERVE_PRESENTATION_MASK
) == U_SHAPE_PRESERVE_PRESENTATION_NOOP
) {
1194 for (i
= 0; i
< sourceLength
; i
++) {
1195 UChar inputChar
= dest
[i
];
1196 if ( (inputChar
>= 0xFB50) && (inputChar
<= 0xFBFF)) {
1197 UChar c
= convertFBto06
[ (inputChar
- 0xFB50) ];
1200 } else if ( (inputChar
>= 0xFE70) && (inputChar
<= 0xFEFC)) {
1201 dest
[i
] = convertFEto06
[ (inputChar
- 0xFE70) ] ;
1203 dest
[i
] = inputChar
;
1209 /* sets the index to the end of the buffer, together with the step point to -1 */
1210 i
= sourceLength
- 1;
1215 * This function resolves the link between the characters .
1216 * Arabic characters have four forms :
1217 * Isolated Form, Initial Form, Middle Form and Final Form
1219 currLink
= getLink(dest
[i
]);
1225 /* If high byte of currLink > 0 then more than one shape */
1226 if ((currLink
& 0xFF00) > 0 || (getLink(dest
[i
]) & IRRELEVANT
) != 0) {
1228 while (Nx
< 0) { /* we need to know about next char */
1233 nextLink
= getLink(dest
[Nw
]);
1234 if((nextLink
& IRRELEVANT
) == 0) {
1242 if ( ((currLink
& ALEFTYPE
) > 0) && ((lastLink
& LAMTYPE
) > 0) ) {
1244 wLamalef
= changeLamAlef(dest
[i
]); /*get from 0x065C-0x065f */
1245 if ( wLamalef
!= 0) {
1246 dest
[i
] = LAMALEF_SPACE_SUB
; /* The default case is to drop the Alef and replace */
1247 dest
[lastPos
] =wLamalef
; /* it by LAMALEF_SPACE_SUB which is the last character in the */
1248 i
=lastPos
; /* unicode private use area, this is done to make */
1249 } /* sure that removeLamAlefSpaces() handles only the */
1250 lastLink
= prevLink
; /* spaces generated during lamalef generation. */
1251 currLink
= getLink(wLamalef
); /* LAMALEF_SPACE_SUB is added here and is replaced by spaces */
1252 } /* in removeLamAlefSpaces() */
1254 if ((i
> 0) && (dest
[i
-1] == SPACE_CHAR
)){
1255 if ( isSeenFamilyChar(dest
[i
])) {
1257 } else if (dest
[i
] == YEH_HAMZA_CHAR
) {
1262 if ( isSeenFamilyChar(dest
[i
])){
1264 } else if (dest
[i
] == YEH_HAMZA_CHAR
) {
1270 * get the proper shape according to link ability of neighbors
1271 * and of character; depends on the order of the shapes
1272 * (isolated, initial, middle, final) in the compatibility area
1274 Shape
= shapeTable
[nextLink
& (LINKR
+ LINKL
)]
1275 [lastLink
& (LINKR
+ LINKL
)]
1276 [currLink
& (LINKR
+ LINKL
)];
1278 if ((currLink
& (LINKR
+LINKL
)) == 1) {
1280 } else if(isTashkeelChar(dest
[i
])) {
1281 if( (lastLink
& LINKL
) && (nextLink
& LINKR
) && (tashkeelFlag
== 1) &&
1282 dest
[i
] != 0x064C && dest
[i
] != 0x064D )
1285 if( (nextLink
&ALEFTYPE
) == ALEFTYPE
&& (lastLink
&LAMTYPE
) == LAMTYPE
) {
1288 } else if(tashkeelFlag
== 2 && dest
[i
] == SHADDA06_CHAR
){
1294 if ((dest
[i
] ^ 0x0600) < 0x100) {
1295 if ( isTashkeelChar(dest
[i
]) ){
1296 if (tashkeelFlag
== 2 && dest
[i
] != SHADDA06_CHAR
){
1297 dest
[i
] = TASHKEEL_SPACE_SUB
;
1300 /* to ensure the array index is within the range */
1301 U_ASSERT(dest
[i
] >= 0x064Bu
1302 && dest
[i
]-0x064Bu
< sizeof(IrrelevantPos
)/sizeof(IrrelevantPos
[0]));
1303 dest
[i
] = 0xFE70 + IrrelevantPos
[(dest
[i
] - 0x064B)] + Shape
;
1305 }else if ((currLink
& APRESENT
) > 0) {
1306 dest
[i
] = (UChar
)(0xFB50 + (currLink
>> 8) + Shape
);
1307 }else if ((currLink
>> 8) > 0 && (currLink
& IRRELEVANT
) == 0) {
1308 dest
[i
] = (UChar
)(0xFE70 + (currLink
>> 8) + Shape
);
1313 /* move one notch forward */
1314 if ((currLink
& IRRELEVANT
) == 0) {
1315 prevLink
= lastLink
;
1316 lastLink
= currLink
;
1322 currLink
= nextLink
;
1324 } else if(i
!= iend
) {
1325 currLink
= getLink(dest
[i
]);
1328 destSize
= sourceLength
;
1329 if ( (lamalef_found
!= 0 ) || (tashkeelFound
!= 0) ){
1330 destSize
= handleGeneratedSpaces(dest
,sourceLength
,destSize
,options
,pErrorCode
, shapeVars
);
1333 if ( (seenfamFound
!= 0) || (yehhamzaFound
!= 0) ) {
1334 destSize
= expandCompositChar(dest
, sourceLength
,destSize
,options
,pErrorCode
, SHAPE_MODE
,shapeVars
);
1340 *Name : deShapeUnicode
1341 *Function : Converts an Arabic Unicode buffer in FExx Range into unshaped
1342 * arabic Unicode buffer in 06xx Range
1345 deShapeUnicode(UChar
*dest
, int32_t sourceLength
,
1346 int32_t destSize
,uint32_t options
,
1347 UErrorCode
*pErrorCode
, struct uShapeVariables shapeVars
) {
1349 int32_t lamalef_found
= 0;
1350 int32_t yehHamzaComposeEnabled
= 0;
1351 int32_t seenComposeEnabled
= 0;
1353 yehHamzaComposeEnabled
= ((options
&U_SHAPE_YEHHAMZA_MASK
) == U_SHAPE_YEHHAMZA_TWOCELL_NEAR
) ? 1 : 0;
1354 seenComposeEnabled
= ((options
&U_SHAPE_SEEN_MASK
) == U_SHAPE_SEEN_TWOCELL_NEAR
)? 1 : 0;
1357 *This for loop changes the buffer from the Unicode FE range to
1358 *the Unicode 06 range
1361 for(i
= 0; i
< sourceLength
; i
++) {
1362 UChar inputChar
= dest
[i
];
1363 if ( (inputChar
>= 0xFB50) && (inputChar
<= 0xFBFF)) { /* FBxx Arabic range */
1364 UChar c
= convertFBto06
[ (inputChar
- 0xFB50) ];
1367 } else if( (yehHamzaComposeEnabled
== 1) && ((inputChar
== HAMZA06_CHAR
) || (inputChar
== HAMZAFE_CHAR
))
1368 && (i
< (sourceLength
- 1)) && isAlefMaksouraChar(dest
[i
+1] )) {
1369 dest
[i
] = SPACE_CHAR
;
1370 dest
[i
+1] = YEH_HAMZA_CHAR
;
1371 } else if ( (seenComposeEnabled
== 1) && (isTailChar(inputChar
)) && (i
< (sourceLength
- 1))
1372 && (isSeenTailFamilyChar(dest
[i
+1])) ) {
1373 dest
[i
] = SPACE_CHAR
;
1374 } else if (( inputChar
>= 0xFE70) && (inputChar
<= 0xFEF4 )) { /* FExx Arabic range */
1375 dest
[i
] = convertFEto06
[ (inputChar
- 0xFE70) ];
1377 dest
[i
] = inputChar
;
1380 if( isLamAlefChar(dest
[i
]) )
1384 destSize
= sourceLength
;
1385 if (lamalef_found
!= 0){
1386 destSize
= expandCompositChar(dest
,sourceLength
,destSize
,options
,pErrorCode
,DESHAPE_MODE
, shapeVars
);
1392 ****************************************
1394 ****************************************
1397 U_CAPI
int32_t U_EXPORT2
1398 u_shapeArabic(const UChar
*source
, int32_t sourceLength
,
1399 UChar
*dest
, int32_t destCapacity
,
1401 UErrorCode
*pErrorCode
) {
1404 struct uShapeVariables shapeVars
= { OLD_TAIL_CHAR
,U_SHAPE_LAMALEF_BEGIN
,U_SHAPE_LAMALEF_END
,U_SHAPE_TASHKEEL_BEGIN
,U_SHAPE_TASHKEEL_END
,0};
1406 /* usual error checking */
1407 if(pErrorCode
==NULL
|| U_FAILURE(*pErrorCode
)) {
1411 /* make sure that no reserved options values are used; allow dest==NULL only for preflighting */
1412 if( source
==NULL
|| sourceLength
<-1 || (dest
==NULL
&& destCapacity
!=0) || destCapacity
<0 ||
1413 (((options
&U_SHAPE_TASHKEEL_MASK
) > 0) &&
1414 ((options
&U_SHAPE_LETTERS_SHAPE_TASHKEEL_ISOLATED
) == U_SHAPE_LETTERS_SHAPE_TASHKEEL_ISOLATED
) ) ||
1415 (((options
&U_SHAPE_TASHKEEL_MASK
) > 0) &&
1416 ((options
&U_SHAPE_LETTERS_MASK
) == U_SHAPE_LETTERS_UNSHAPE
)) ||
1417 (options
&U_SHAPE_DIGIT_TYPE_RESERVED
)==U_SHAPE_DIGIT_TYPE_RESERVED
||
1418 (options
&U_SHAPE_DIGITS_MASK
)==U_SHAPE_DIGITS_RESERVED
||
1419 ((options
&U_SHAPE_LAMALEF_MASK
) != U_SHAPE_LAMALEF_RESIZE
&&
1420 (options
&U_SHAPE_AGGREGATE_TASHKEEL_MASK
) != 0) ||
1421 ((options
&U_SHAPE_AGGREGATE_TASHKEEL_MASK
) == U_SHAPE_AGGREGATE_TASHKEEL
&&
1422 (options
&U_SHAPE_LETTERS_SHAPE_TASHKEEL_ISOLATED
) != U_SHAPE_LETTERS_SHAPE_TASHKEEL_ISOLATED
)
1425 *pErrorCode
=U_ILLEGAL_ARGUMENT_ERROR
;
1428 /* Validate lamalef options */
1429 if(((options
&U_SHAPE_LAMALEF_MASK
) > 0)&&
1430 !(((options
& U_SHAPE_LAMALEF_MASK
)==U_SHAPE_LAMALEF_BEGIN
) ||
1431 ((options
& U_SHAPE_LAMALEF_MASK
)==U_SHAPE_LAMALEF_END
) ||
1432 ((options
& U_SHAPE_LAMALEF_MASK
)==U_SHAPE_LAMALEF_RESIZE
)||
1433 ((options
& U_SHAPE_LAMALEF_MASK
)==U_SHAPE_LAMALEF_AUTO
) ||
1434 ((options
& U_SHAPE_LAMALEF_MASK
)==U_SHAPE_LAMALEF_NEAR
)))
1436 *pErrorCode
=U_ILLEGAL_ARGUMENT_ERROR
;
1439 /* Validate Tashkeel options */
1440 if(((options
&U_SHAPE_TASHKEEL_MASK
) > 0)&&
1441 !(((options
& U_SHAPE_TASHKEEL_MASK
)==U_SHAPE_TASHKEEL_BEGIN
) ||
1442 ((options
& U_SHAPE_TASHKEEL_MASK
)==U_SHAPE_TASHKEEL_END
)
1443 ||((options
& U_SHAPE_TASHKEEL_MASK
)==U_SHAPE_TASHKEEL_RESIZE
)||
1444 ((options
& U_SHAPE_TASHKEEL_MASK
)==U_SHAPE_TASHKEEL_REPLACE_BY_TATWEEL
)))
1446 *pErrorCode
=U_ILLEGAL_ARGUMENT_ERROR
;
1449 /* determine the source length */
1450 if(sourceLength
==-1) {
1451 sourceLength
=u_strlen(source
);
1453 if(sourceLength
<=0) {
1454 return u_terminateUChars(dest
, destCapacity
, 0, pErrorCode
);
1457 /* check that source and destination do not overlap */
1459 ((source
<=dest
&& dest
<source
+sourceLength
) ||
1460 (dest
<=source
&& source
<dest
+destCapacity
))) {
1461 *pErrorCode
=U_ILLEGAL_ARGUMENT_ERROR
;
1465 /* Does Options contain the new Seen Tail Unicode code point option */
1466 if ( (options
&U_SHAPE_TAIL_TYPE_MASK
) == U_SHAPE_TAIL_NEW_UNICODE
){
1467 shapeVars
.tailChar
= NEW_TAIL_CHAR
;
1469 shapeVars
.tailChar
= OLD_TAIL_CHAR
;
1472 if((options
&U_SHAPE_LETTERS_MASK
)!=U_SHAPE_LETTERS_NOOP
) {
1474 UChar
*tempbuffer
, *tempsource
= NULL
;
1475 int32_t outputSize
, spacesCountl
=0, spacesCountr
=0;
1477 if((options
&U_SHAPE_AGGREGATE_TASHKEEL_MASK
)>0) {
1478 int32_t logical_order
= (options
&U_SHAPE_TEXT_DIRECTION_MASK
) == U_SHAPE_TEXT_DIRECTION_LOGICAL
;
1479 int32_t aggregate_tashkeel
=
1480 (options
&(U_SHAPE_AGGREGATE_TASHKEEL_MASK
+U_SHAPE_LETTERS_SHAPE_TASHKEEL_ISOLATED
)) ==
1481 (U_SHAPE_AGGREGATE_TASHKEEL
+U_SHAPE_LETTERS_SHAPE_TASHKEEL_ISOLATED
);
1482 int step
=logical_order
?1:-1;
1483 int j
=logical_order
?-1:2*sourceLength
;
1484 int i
=logical_order
?-1:sourceLength
;
1485 int end
=logical_order
?sourceLength
:-1;
1486 int aggregation_possible
= 1;
1488 UChar prevLink
, currLink
= 0;
1489 int newSourceLength
= 0;
1490 tempsource
= (UChar
*)uprv_malloc(2*sourceLength
*U_SIZEOF_UCHAR
);
1491 if(tempsource
== NULL
) {
1492 *pErrorCode
= U_MEMORY_ALLOCATION_ERROR
;
1496 while ((i
+=step
) != end
) {
1497 prevLink
= currLink
;
1498 currLink
= getLink(source
[i
]);
1499 if (aggregate_tashkeel
&& ((prevLink
|currLink
)&COMBINE
) == COMBINE
&& aggregation_possible
) {
1500 aggregation_possible
= 0;
1501 tempsource
[j
] = (prev
<source
[i
]?prev
:source
[i
])-0x064C+0xFC5E;
1502 currLink
= getLink(tempsource
[j
]);
1504 aggregation_possible
= 1;
1505 tempsource
[j
+=step
] = source
[i
];
1510 source
= tempsource
+(logical_order
?0:j
);
1511 sourceLength
= newSourceLength
;
1514 /* calculate destination size */
1515 /* TODO: do we ever need to do this pure preflighting? */
1516 if(((options
&U_SHAPE_LAMALEF_MASK
)==U_SHAPE_LAMALEF_RESIZE
) ||
1517 ((options
&U_SHAPE_TASHKEEL_MASK
)==U_SHAPE_TASHKEEL_RESIZE
)) {
1518 outputSize
=calculateSize(source
,sourceLength
,destCapacity
,options
);
1520 outputSize
=sourceLength
;
1523 if(outputSize
>destCapacity
) {
1524 *pErrorCode
=U_BUFFER_OVERFLOW_ERROR
;
1525 if (tempsource
!= NULL
) uprv_free(tempsource
);
1530 * need a temporary buffer of size max(outputSize, sourceLength)
1531 * because at first we copy source->temp
1533 if(sourceLength
>outputSize
) {
1534 outputSize
=sourceLength
;
1537 /* Start of Arabic letter shaping part */
1538 if(outputSize
<=LENGTHOF(buffer
)) {
1539 outputSize
=LENGTHOF(buffer
);
1542 tempbuffer
= (UChar
*)uprv_malloc(outputSize
*U_SIZEOF_UCHAR
);
1545 if(tempbuffer
== NULL
) {
1546 *pErrorCode
= U_MEMORY_ALLOCATION_ERROR
;
1547 if (tempsource
!= NULL
) uprv_free(tempsource
);
1551 uprv_memcpy(tempbuffer
, source
, sourceLength
*U_SIZEOF_UCHAR
);
1552 if (tempsource
!= NULL
){
1553 uprv_free(tempsource
);
1556 if(sourceLength
<outputSize
) {
1557 uprv_memset(tempbuffer
+sourceLength
, 0, (outputSize
-sourceLength
)*U_SIZEOF_UCHAR
);
1560 if((options
&U_SHAPE_TEXT_DIRECTION_MASK
) == U_SHAPE_TEXT_DIRECTION_LOGICAL
) {
1561 countSpaces(tempbuffer
,sourceLength
,options
,&spacesCountl
,&spacesCountr
);
1562 invertBuffer(tempbuffer
,sourceLength
,options
,spacesCountl
,spacesCountr
);
1565 if((options
&U_SHAPE_TEXT_DIRECTION_MASK
) == U_SHAPE_TEXT_DIRECTION_VISUAL_LTR
) {
1566 if((options
&U_SHAPE_SPACES_RELATIVE_TO_TEXT_MASK
) == U_SHAPE_SPACES_RELATIVE_TO_TEXT_BEGIN_END
) {
1567 shapeVars
.spacesRelativeToTextBeginEnd
= 1;
1568 shapeVars
.uShapeLamalefBegin
= U_SHAPE_LAMALEF_END
;
1569 shapeVars
.uShapeLamalefEnd
= U_SHAPE_LAMALEF_BEGIN
;
1570 shapeVars
.uShapeTashkeelBegin
= U_SHAPE_TASHKEEL_END
;
1571 shapeVars
.uShapeTashkeelEnd
= U_SHAPE_TASHKEEL_BEGIN
;
1575 switch(options
&U_SHAPE_LETTERS_MASK
) {
1576 case U_SHAPE_LETTERS_SHAPE
:
1577 if( (options
&U_SHAPE_TASHKEEL_MASK
)> 0
1578 && ((options
&U_SHAPE_TASHKEEL_MASK
) !=U_SHAPE_TASHKEEL_REPLACE_BY_TATWEEL
)) {
1579 /* Call the shaping function with tashkeel flag == 2 for removal of tashkeel */
1580 destLength
= shapeUnicode(tempbuffer
,sourceLength
,destCapacity
,options
,pErrorCode
,2,shapeVars
);
1582 /* default Call the shaping function with tashkeel flag == 1 */
1583 destLength
= shapeUnicode(tempbuffer
,sourceLength
,destCapacity
,options
,pErrorCode
,1,shapeVars
);
1585 /*After shaping text check if user wants to remove tashkeel and replace it with tatweel*/
1586 if( (options
&U_SHAPE_TASHKEEL_MASK
) == U_SHAPE_TASHKEEL_REPLACE_BY_TATWEEL
){
1587 destLength
= handleTashkeelWithTatweel(tempbuffer
,destLength
,destCapacity
,options
,pErrorCode
);
1591 case U_SHAPE_LETTERS_SHAPE_TASHKEEL_ISOLATED
:
1592 /* Call the shaping function with tashkeel flag == 0 */
1593 destLength
= shapeUnicode(tempbuffer
,sourceLength
,destCapacity
,options
,pErrorCode
,0,shapeVars
);
1596 case U_SHAPE_LETTERS_UNSHAPE
:
1597 /* Call the deshaping function */
1598 destLength
= deShapeUnicode(tempbuffer
,sourceLength
,destCapacity
,options
,pErrorCode
,shapeVars
);
1601 /* will never occur because of validity checks above */
1607 * TODO: (markus 2002aug01)
1608 * For as long as we always preflight the outputSize above
1609 * we should U_ASSERT(outputSize==destLength)
1610 * except for the adjustment above before the tempbuffer allocation
1613 if((options
&U_SHAPE_TEXT_DIRECTION_MASK
) == U_SHAPE_TEXT_DIRECTION_LOGICAL
) {
1614 countSpaces(tempbuffer
,destLength
,options
,&spacesCountl
,&spacesCountr
);
1615 invertBuffer(tempbuffer
,destLength
,options
,spacesCountl
,spacesCountr
);
1617 uprv_memcpy(dest
, tempbuffer
, uprv_min(destLength
, destCapacity
)*U_SIZEOF_UCHAR
);
1619 if(tempbuffer
!=buffer
) {
1620 uprv_free(tempbuffer
);
1623 if(destLength
>destCapacity
) {
1624 *pErrorCode
=U_BUFFER_OVERFLOW_ERROR
;
1628 /* End of Arabic letter shaping part */
1631 * No letter shaping:
1632 * just make sure the destination is large enough and copy the string.
1634 if(destCapacity
<sourceLength
) {
1635 /* this catches preflighting, too */
1636 *pErrorCode
=U_BUFFER_OVERFLOW_ERROR
;
1637 return sourceLength
;
1639 uprv_memcpy(dest
, source
, sourceLength
*U_SIZEOF_UCHAR
);
1640 destLength
=sourceLength
;
1644 * Perform number shaping.
1645 * With UTF-16 or UTF-32, the length of the string is constant.
1646 * The easiest way to do this is to operate on the destination and
1647 * "shape" the digits in-place.
1649 if((options
&U_SHAPE_DIGITS_MASK
)!=U_SHAPE_DIGITS_NOOP
) {
1653 /* select the requested digit group */
1654 switch(options
&U_SHAPE_DIGIT_TYPE_MASK
) {
1655 case U_SHAPE_DIGIT_TYPE_AN
:
1656 digitBase
=0x660; /* Unicode: "Arabic-Indic digits" */
1658 case U_SHAPE_DIGIT_TYPE_AN_EXTENDED
:
1659 digitBase
=0x6f0; /* Unicode: "Eastern Arabic-Indic digits (Persian and Urdu)" */
1662 /* will never occur because of validity checks above */
1667 /* perform the requested operation */
1668 switch(options
&U_SHAPE_DIGITS_MASK
) {
1669 case U_SHAPE_DIGITS_EN2AN
:
1670 /* add (digitBase-'0') to each European (ASCII) digit code point */
1672 for(i
=0; i
<destLength
; ++i
) {
1673 if(((uint32_t)dest
[i
]-0x30)<10) {
1678 case U_SHAPE_DIGITS_AN2EN
:
1679 /* subtract (digitBase-'0') from each Arabic digit code point */
1680 for(i
=0; i
<destLength
; ++i
) {
1681 if(((uint32_t)dest
[i
]-(uint32_t)digitBase
)<10) {
1682 dest
[i
]-=digitBase
-0x30;
1686 case U_SHAPE_DIGITS_ALEN2AN_INIT_LR
:
1687 _shapeToArabicDigitsWithContext(dest
, destLength
,
1689 (UBool
)((options
&U_SHAPE_TEXT_DIRECTION_MASK
)==U_SHAPE_TEXT_DIRECTION_LOGICAL
),
1692 case U_SHAPE_DIGITS_ALEN2AN_INIT_AL
:
1693 _shapeToArabicDigitsWithContext(dest
, destLength
,
1695 (UBool
)((options
&U_SHAPE_TEXT_DIRECTION_MASK
)==U_SHAPE_TEXT_DIRECTION_LOGICAL
),
1699 /* will never occur because of validity checks above */
1704 return u_terminateUChars(dest
, destCapacity
, destLength
, pErrorCode
);